further changes

Author: alishaz-polymath

components/components/schemaTable.tsx

@@ -0,0 +1,95 @@
+import React, { useState } from 'react';
+import { DatatypeTag } from './../uicomp/tag';
+
+const SchemaProperty = ({ name, property }: {name: string, property: any}) => {
+  const [isExpanded, setIsExpanded] = useState(false);
+
+  const toggleExpand = () => setIsExpanded(!isExpanded);
+
+  const getType = (property: any) => {
+    if (property.type === 'array' && property.items) {
+      return `array of ${property.items.type}s`;
+    }
+    return property.type;
+  };
+
+  const renderProperty = () => {
+    if (property.type === 'object' && property.properties) {
+      return (
+        <div className="ml-4">
+          <p><DatatypeTag label={getType(property)} /></p>
+          <p>{property.description}</p>
+          <button
+            className="border border-slate-600 rounded-md px-3 py-2 text-xs"
+            onClick={toggleExpand}
+          >
+            {isExpanded ? 'Hide child attributes' : 'Show child attributes'}
+          </button>
+          {isExpanded && (
+            <SchemaObject schema={property.properties} />
+          )}
+        </div>
+      );
+    } else if (property.type === 'array' && property.items.type === 'object') {
+      return (
+        <div className="ml-4">
+          <p><DatatypeTag label={getType(property)} /></p>
+          <p>{property.description}</p>
+          <button
+            className="border border-slate-600 rounded-md px-3 py-2 text-xs"
+            onClick={toggleExpand}
+          >
+            {isExpanded ? 'Hide child attributes' : 'Show child attributes'}
+          </button>
+          {isExpanded && (
+            <>
+            <SchemaObject schema={property.items.properties} />
+            </>
+          )}
+        </div>
+      );
+    } else {
+      return (
+        <div className="ml-4">
+            <p><DatatypeTag label={getType(property)} /></p>
+            <p>{property.description || ''}</p>
+        </div>
+      );
+    }
+  };
+
+  return (
+    <tr>
+      <td className="border px-4 py-2 font-bold">{name}</td>
+      <td className="border px-4 py-2">{renderProperty()}</td>
+    </tr>
+  );
+};
+
+// Component to render the schema object
+const SchemaObject = ({ schema }: {schema: any}) => {
+  return (
+    <table className="min-w-full border-collapse rounded-md block md:table">
+      <thead className="block md:table-header-group">
+        <tr className="border md:table-row">
+          <th className="block md:table-cell border px-4 py-2">Attribute</th>
+          <th className="block md:table-cell border px-4 py-2">Description</th>
+        </tr>
+      </thead>
+      <tbody className="block md:table-row-group">
+        {Object.keys(schema).map((key) => (
+          <SchemaProperty key={key} name={key} property={schema[key]} />
+        ))}
+      </tbody>
+    </table>
+  );
+};
+
+// Main component to render the JSON schema
+export const JSONSchemaRenderer = ({ schema }: {schema: any}) => {
+  return (
+    <div className="py-4">
+      <SchemaObject schema={schema.properties} />
+    </div>
+  );
+};

components/uicomp/tag.tsx

@@ -9,6 +9,7 @@ export const getColorClass = (color: TagColor) => {
     case TagColor.amber: return "bg-amber-50 text-amber-600"
     case TagColor.rose: return "bg-rose-50 text-rose-600"
     case TagColor.violet: return "bg-violet-50 text-violet-600"
+    case TagColor.slate: return "bg-slate-700 text-slate-100"
     default: return "bg-neutral-50 text-neutral-600"
   }
 }
@@ -19,7 +20,8 @@ export const Tag = ({ label = "", color = TagColor.neutral, size = "sm", round =
     getColorClass(color),
     {
       "rounded": !round,
-      "rounded-full": round,
+      "rounded-full": round && size !== "xs",
+      "rounded-md": round && size === "xs",
       "text-xs": size === "xs",
       "text-sm": size === "sm",
       "px-1": !round,
@@ -30,4 +32,8 @@ export const Tag = ({ label = "", color = TagColor.neutral, size = "sm", round =
 
 export const FileTag = ({ label= "" }) => {
   return <Tag label={label} color={TagColor.fuchsia} />
+}
+
+export const DatatypeTag = ({ label ="" }) => {
+  return <Tag label={label} color={TagColor.slate} round={true} size="xs" />
 }

markdoc.components.js

@@ -30,6 +30,7 @@ import YouTube from '@components/components/youtube'
 import Loom from '@components/components/loom'
 import AtomTable from '@components/components/atomTable'
 import ClassnamesTable from '@components/components/classnamesTable'
+import { JSONSchemaRenderer } from '@components/components/schemaTable'
 
 export default {
   BorderedPanel,
@@ -62,5 +63,6 @@ export default {
   WrappedImage,
   YouTube,
   AtomTable,
-  ClassnamesTable
+  ClassnamesTable,
+  JSONSchemaRenderer
 }

markdoc.config.js

@@ -295,7 +295,14 @@ const config = {
     classnamesTable : {
       render: 'ClassnamesTable',
       attributes: { atom: { type: String } },
-    }
+    },
+    jsonSchemaRenderer: {
+      render: 'JSONSchemaRenderer',
+      description: 'JSON schema renderer',
+      attributes: {
+        schema: { type: Object },
+      },
+    },
   },
   nodes: {
     fence: {

pages/enterprise-features/api/api-reference.mdoc

@@ -21,8 +21,26 @@ Please note that the V1 API will be officially deprecated starting January 2025.
 - **Performance Improvements**: V2 has been optimized for better performance and scalability.
 - **User friendly response objects**: In V2 we have focused heavily on improving the response object for a better User Experience.
 - **Enhanced Security**: V2 includes improved security measures to protect your data.
-- **New Features**: V2 introduces new functionalities that are not present in V1, allowing you more flexibility with Cal.com application and usage.
+
+### Admin access
+
+With V2 we're supporting System Wide Admin access and Organization Admin access. 
+
+#### Key points
+
+- The system wide admin has access to all resources via regular endpoints.
+- The organization admin has dedicated endpoints allowing them organization wide resource access. These endpoints follow the general path of `/organizations/:orgId/<resource>`.
+- The API Key can be created (here)[https://app.cal.com/settings/developer/api-keys] and depending on the role of the user, their API access will be settled. That is, 
+    - for a non-admin user, the API key created here will give them access to their own resources. 
+    - for a system wide admin, the API key created here will give them access to all resources, system-wide.
+    - for an organization owner or admin, the API key created here will give them access to all resources, organization-wide.
 
 We are committed to supporting our community during this transition. If you have any questions or need assistance with migrating to the V2 API, please refer to our [migration guide](#) or contact our support team.
 
-Thank you for your understanding and cooperation.
+Thank you for your understanding and cooperation.
+
+{% pageLink
+    href="/enterprise-features/api/api-reference/v1"
+    heading="Proceed to V1 Endpoints Spec" %}
+    V1 Endpoints
+  {% /pageLink %}

pages/enterprise-features/api/api-reference/v1/index.mdoc

@@ -10,56 +10,56 @@ Hence, this page shows you which API routes are most useful in order to prevent
 
 You'll need only a few of the routes to be able to cover the basic functionality.
 
-{% pageLink href="/enterprise-features/api/api-reference/bookings "%}Bookings{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/bookings "%}Bookings{% /pageLink %}
 
-{% pageLink href="/enterprise-features/api/api-reference/event-types "%}Event types{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/event-types "%}Event types{% /pageLink %}
 
 ## Managing users
 
 The user endpoints can only be used on self-hosted enterprise instances and not on our hosted platform.
 
-{% pageLink href="/enterprise-features/api/api-reference/users "%}Users{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/users "%}Users{% /pageLink %}
 
 ## Managing teams
 
 The teams endpoints allow you to programmatically CRUD team data.
 
-{% pageLink href="/enterprise-features/api/api-reference/teams "%}Teams{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/teams "%}Teams{% /pageLink %}
 
 ## The other stuff
 
 Attendees allows you to CRUD the data related to who is attending a particular booking. Useful if you want to create events where many people are invited.
 
-{% pageLink href="/enterprise-features/api/api-reference/attendees "%}Attendees{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/attendees "%}Attendees{% /pageLink %}
 
 Schedules allows you to set out time blocks when you want to show availability.
 
-{% pageLink href="/enterprise-features/api/api-reference/schedules "%}Schedules{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/schedules "%}Schedules{% /pageLink %}
 
 Availabilities allows you to map schedules to an event type.
 
-{% pageLink href="/enterprise-features/api/api-reference/availabilities "%}Availabilities{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/availabilities "%}Availabilities{% /pageLink %}
 
 Booking references map meeting details to bookings.
 
-{% pageLink href="/enterprise-features/api/api-reference/booking-references "%}Booking References{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/booking-references "%}Booking References{% /pageLink %}
 
 Custom inputs allow you to control which custom inputs are required for your event types.
 
-{% pageLink href="/enterprise-features/api/api-reference/custom-inputs "%}Custom inputs{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/custom-inputs "%}Custom inputs{% /pageLink %}
 
 Destination calendars map bookings for event types to particular calendars.
 
-{% pageLink href="/enterprise-features/api/api-reference/destination-calendars "%}Destination calendars{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/destination-calendars "%}Destination calendars{% /pageLink %}
 
 Memberships control mappings of users to particular roles within teams.
 
-{% pageLink href="/enterprise-features/api/api-reference/memberships "%}Memberships{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/memberships "%}Memberships{% /pageLink %}
 
 Payments track the charges that are required to book certain events.
 
-{% pageLink href="/enterprise-features/api/api-reference/payments "%}Payments{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/payments "%}Payments{% /pageLink %}
 
 Selected calendars keeps track of which calendars should be checked for conflicts.
 
-{% pageLink href="/enterprise-features/api/api-reference/selected-calendars "%}Selected calendars{% /pageLink %}
+{% pageLink href="/enterprise-features/api/api-reference/v1/selected-calendars "%}Selected calendars{% /pageLink %}

pages/enterprise-features/api/api-reference/v1/payments.mdoc

@@ -2,6 +2,43 @@
 title: Payments
 ---
 
+## Payment Object
+
+{% jsonSchemaRenderer schema={
+    properties: {
+        available: {
+            type: "array",
+            description: "Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the source_types property.",
+            items: {
+                type: "object",
+                properties: {
+                    amount: { type: "integer", description: "Balance amount." },
+                    currency: { type: "string", description: "Three-letter ISO currency code, in lowercase. Must be a supported currency."}
+                }
+            }
+        },
+        pending: {
+            type: "array",
+            description: "Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the source_types property.",
+            items: {
+              type: "object",
+              properties: {
+                amount: { type: "integer", description: "Balance amount." },
+                currency: { type: "string", description: "Three-letter ISO currency code, in lowercase. Must be a supported currency." },
+                source_types: {
+                  type: "object",
+                  properties: {
+                    bank_account: { type: "integer", description: "Amount for bank account." },
+                    card: { type: "integer", description: "Amount for card." },
+                    fpx: { type: "integer", description: "Amount for FPX." }
+                  }
+                }
+              }
+            }
+          }
+    }
+} /%}
+
 You can use the payments endpoint in Cal.com's API suite track the charges that are required to book certain events.
 
 ## Find all payments

project-config.ts

@@ -392,67 +392,67 @@ export default {
                   pages: [
                     {
                       title: "Attendees",
-                      href: "/enterprise-features/api/api-reference/attendees",
+                      href: "/enterprise-features/api/api-reference/v1/attendees",
                     },
                     {
                       title: "Availabilities",
-                      href: "/enterprise-features/api/api-reference/availabilities",
+                      href: "/enterprise-features/api/api-reference/v1/availabilities",
                     },
                     {
                       title: "Availability",
-                      href: "/enterprise-features/api/api-reference/availability",
+                      href: "/enterprise-features/api/api-reference/v1/availability",
                     },
                     {
                       title: "Booking References",
-                      href: "/enterprise-features/api/api-reference/booking-references",
+                      href: "/enterprise-features/api/api-reference/v1/booking-references",
                     },
                     {
                       title: "Bookings",
-                      href: "/enterprise-features/api/api-reference/bookings",
+                      href: "/enterprise-features/api/api-reference/v1/bookings",
                     },
                     {
                       title: "Destination calendars",
-                      href: "/enterprise-features/api/api-reference/destination-calendars",
+                      href: "/enterprise-features/api/api-reference/v1/destination-calendars",
                     },
                     {
                       title: "Event types",
-                      href: "/enterprise-features/api/api-reference/event-types",
+                      href: "/enterprise-features/api/api-reference/v1/event-types",
                     },
                     {
                       title: "Me",
-                      href: "/enterprise-features/api/api-reference/me",
+                      href: "/enterprise-features/api/api-reference/v1/me",
                     },
                     {
                       title: "Memberships",
-                      href: "/enterprise-features/api/api-reference/memberships",
+                      href: "/enterprise-features/api/api-reference/v1/memberships",
                     },
                     {
                       title: "Payments",
-                      href: "/enterprise-features/api/api-reference/payments",
+                      href: "/enterprise-features/api/api-reference/v1/payments",
                     },
                     {
                       title: "Schedules",
-                      href: "/enterprise-features/api/api-reference/schedules",
+                      href: "/enterprise-features/api/api-reference/v1/schedules",
                     },
                     {
                       title: "Selected calendars",
-                      href: "/enterprise-features/api/api-reference/selected-calendars",
+                      href: "/enterprise-features/api/api-reference/v1/selected-calendars",
                     },
                     {
                       title: "Slots",
-                      href: "/enterprise-features/api/api-reference/slots",
+                      href: "/enterprise-features/api/api-reference/v1/slots",
                     },
                     {
                       title: "Teams",
-                      href: "/enterprise-features/api/api-reference/teams",
+                      href: "/enterprise-features/api/api-reference/v1/teams",
                     },
                     {
                       title: "Users",
-                      href: "/enterprise-features/api/api-reference/users",
+                      href: "/enterprise-features/api/api-reference/v1/users",
                     },
                     {
                       title: "Webhooks",
-                      href: "/enterprise-features/api/api-reference/webhooks",
+                      href: "/enterprise-features/api/api-reference/v1/webhooks",
                     }
                   ],
                 },

utils/colors.ts

@@ -6,4 +6,5 @@ export enum TagColor {
   rose = "rose",
   violet = "violet",
   neutral = "neutral",
+  slate = "slate",
 }