@gpt-platform/client 0.6.1 → 0.6.3

package/dist/index.js

@@ -1333,8 +1333,8 @@ function buildUserAgent(sdkVersion, appInfo) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.6.1";
-var DEFAULT_API_VERSION = "2026-03-09";
+var SDK_VERSION = "0.6.3";
+var DEFAULT_API_VERSION = "2026-03-11";
 
 // src/base-client.ts
 function generateUUID() {
@@ -1902,15 +1902,6 @@ var getApplicationsCurrent = (options) => (options.client ?? client).get({
   url: "/applications/current",
   ...options
 });
-var patchWorkspaceMembershipsByWorkspaceIdByUserIdProfile = (options) => (options.client ?? client).patch({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/workspace-memberships/{workspace_id}/{user_id}/profile",
-  ...options,
-  headers: {
-    "Content-Type": "application/vnd.api+json",
-    ...options.headers
-  }
-});
 var postInvitationsAcceptByToken = (options) => (options.client ?? client).post({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/invitations/accept-by-token",
@@ -2811,6 +2802,11 @@ var getSocialMetricsAccountBySocialAccountId = (options) => (options.client ?? c
   url: "/social/metrics/account/{social_account_id}",
   ...options
 });
+var getPermissionsMeta = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/permissions/meta",
+  ...options
+});
 var getEmailMarketingGeneratedEmailsById = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/email-marketing/generated-emails/{id}",
@@ -3197,20 +3193,6 @@ var getSchedulingBookingsById = (options) => (options.client ?? client).get({
   url: "/scheduling/bookings/{id}",
   ...options
 });
-var getTenantMemberships = (options) => (options.client ?? client).get({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/tenant-memberships",
-  ...options
-});
-var postTenantMemberships = (options) => (options.client ?? client).post({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/tenant-memberships",
-  ...options,
-  headers: {
-    "Content-Type": "application/vnd.api+json",
-    ...options.headers
-  }
-});
 var getLlmAnalytics = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/llm-analytics",
@@ -3650,6 +3632,20 @@ var patchVoiceSessionsByIdFinalize = (options) => (options.client ?? client).pat
     ...options.headers
   }
 });
+var getRoles = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/roles",
+  ...options
+});
+var postRoles = (options) => (options.client ?? client).post({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/roles",
+  ...options,
+  headers: {
+    "Content-Type": "application/vnd.api+json",
+    ...options.headers
+  }
+});
 var deleteProcessingActivitiesById = (options) => (options.client ?? client).delete({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/processing-activities/{id}",
@@ -4579,6 +4575,11 @@ var getWalletSeats = (options) => (options.client ?? client).get({
   url: "/wallet/seats",
   ...options
 });
+var getPermissions = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/permissions",
+  ...options
+});
 var patchEmailOutboundEmailsByIdCancelSchedule = (options) => (options.client ?? client).patch({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/email/outbound-emails/{id}/cancel-schedule",
@@ -4851,20 +4852,6 @@ var patchConnectorsById = (options) => (options.client ?? client).patch({
     ...options.headers
   }
 });
-var getWorkspaceMemberships = (options) => (options.client ?? client).get({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/workspace-memberships",
-  ...options
-});
-var postWorkspaceMemberships = (options) => (options.client ?? client).post({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/workspace-memberships",
-  ...options,
-  headers: {
-    "Content-Type": "application/vnd.api+json",
-    ...options.headers
-  }
-});
 var getTenantsByTenantIdDocumentStats = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/tenants/{tenant_id}/document_stats",
@@ -4894,6 +4881,16 @@ var patchVoiceTranscriptionResultsById = (options) => (options.client ?? client)
     ...options.headers
   }
 });
+var getPermissionsPresetsById = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/permissions/presets/{id}",
+  ...options
+});
+var getPermissionsPresets = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/permissions/presets",
+  ...options
+});
 var deleteFieldTemplatesById = (options) => (options.client ?? client).delete({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/field-templates/{id}",
@@ -4979,6 +4976,11 @@ var patchApiKeysByIdSetBudget = (options) => (options.client ?? client).patch({
     ...options.headers
   }
 });
+var getPermissionsById = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/permissions/{id}",
+  ...options
+});
 var getExtractionDocumentsWorkspaceByWorkspaceId = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/extraction/documents/workspace/{workspace_id}",
@@ -5123,20 +5125,6 @@ var patchCrawlerSchedulesByIdEnable = (options) => (options.client ?? client).pa
     ...options.headers
   }
 });
-var deleteTenantMembershipsByTenantIdByUserId = (options) => (options.client ?? client).delete({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/tenant-memberships/{tenant_id}/{user_id}",
-  ...options
-});
-var patchTenantMembershipsByTenantIdByUserId = (options) => (options.client ?? client).patch({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/tenant-memberships/{tenant_id}/{user_id}",
-  ...options,
-  headers: {
-    "Content-Type": "application/vnd.api+json",
-    ...options.headers
-  }
-});
 var getEmailInboundReceivedById = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/email/inbound/received/{id}",
@@ -5213,6 +5201,20 @@ var postAiMessages = (options) => (options.client ?? client).post({
     ...options.headers
   }
 });
+var deleteRolesById = (options) => (options.client ?? client).delete({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/roles/{id}",
+  ...options
+});
+var patchRolesById = (options) => (options.client ?? client).patch({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/roles/{id}",
+  ...options,
+  headers: {
+    "Content-Type": "application/vnd.api+json",
+    ...options.headers
+  }
+});
 var getWatcherEvents = (options) => (options.client ?? client).get({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/watcher/events",
@@ -5681,25 +5683,6 @@ var getAgentVersionRevisions = (options) => (options.client ?? client).get({
   url: "/agent-version-revisions",
   ...options
 });
-var deleteWorkspaceMembershipsByWorkspaceIdByUserId = (options) => (options.client ?? client).delete({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/workspace-memberships/{workspace_id}/{user_id}",
-  ...options
-});
-var getWorkspaceMembershipsByWorkspaceIdByUserId = (options) => (options.client ?? client).get({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/workspace-memberships/{workspace_id}/{user_id}",
-  ...options
-});
-var patchWorkspaceMembershipsByWorkspaceIdByUserId = (options) => (options.client ?? client).patch({
-  security: [{ scheme: "bearer", type: "http" }],
-  url: "/workspace-memberships/{workspace_id}/{user_id}",
-  ...options,
-  headers: {
-    "Content-Type": "application/vnd.api+json",
-    ...options.headers
-  }
-});
 var postTrainingExamplesBulkDelete = (options) => (options.client ?? client).post({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/training-examples/bulk-delete",
@@ -19135,246 +19118,6 @@ function createPlatformNamespace(rb) {
         );
       }
     },
-    /**
-     * Workspace Members — membership management within a workspace.
-     *
-     * Controls which users have access to a workspace and with what role.
-     * Use `create` to grant access, `update` to change role/permissions,
-     * and `remove` to revoke access.
-     */
-    workspaceMembers: {
-      /**
-       * List all members of a workspace.
-       *
-       * Returns `WorkspaceMembership` records for every user who has been
-       * granted access to the specified workspace.
-       *
-       * @param workspaceId - The UUID of the workspace to list members for.
-       * @param options - Optional page number, page size, and request options.
-       * @returns A page of `WorkspaceMembership` records.
-       *
-       * @example
-       * ```typescript
-       * const client = new GptClient({ apiKey: 'sk_app_...' });
-       * const members = await client.platform.workspaceMembers.list('ws_abc123');
-       * members.forEach(m => console.log(m.attributes?.user_id, m.attributes?.role));
-       * ```
-       */
-      list: async (workspaceId, options) => {
-        return rb.execute(
-          getWorkspaceMemberships,
-          {
-            query: {
-              filter: { workspace_id: workspaceId },
-              ...buildPageQuery(options?.page, options?.pageSize)?.query
-            }
-          },
-          options
-        );
-      },
-      /**
-       * List workspace members with user profile data (name, email, avatar) included.
-       *
-       * Equivalent to `list()` with `?include=user,user.profile` appended. Each
-       * membership in the response will have `relationships.user` and nested
-       * `user.relationships.profile` populated in the JSON:API `included` array.
-       *
-       * The `RequestBuilder` flattens included relationships automatically, so
-       * each membership object will have `user` and `user.profile` accessible.
-       *
-       * @param workspaceId - The UUID of the workspace to list members for.
-       * @param options - Optional page number, page size, and request options.
-       * @returns A page of `WorkspaceMembership` records with embedded user + profile.
-       *
-       * @example
-       * ```typescript
-       * const members = await client.platform.workspaceMembers.listWithProfiles('ws_abc123');
-       * members.forEach(m => {
-       *   console.log(m.attributes?.user_id, m.attributes?.role);
-       *   // Profile fields come from included relationships
-       * });
-       * ```
-       */
-      listWithProfiles: async (workspaceId, options) => {
-        return rb.execute(
-          getWorkspaceMemberships,
-          {
-            query: {
-              filter: { workspace_id: workspaceId },
-              include: "user,user.profile",
-              ...buildPageQuery(options?.page, options?.pageSize)?.query
-            }
-          },
-          options
-        );
-      },
-      /**
-       * Retrieve the membership record for a specific user within a workspace.
-       *
-       * @param workspaceId - The UUID of the workspace.
-       * @param memberId - The UUID of the user (member) to look up.
-       * @param options - Optional request options.
-       * @returns The matching `WorkspaceMembership` record.
-       *
-       * @example
-       * ```typescript
-       * const client = new GptClient({ apiKey: 'sk_app_...' });
-       * const membership = await client.platform.workspaceMembers.get(
-       *   'ws_abc123',
-       *   'user_xyz',
-       * );
-       * console.log(membership.attributes?.role);
-       * ```
-       */
-      get: async (workspaceId, memberId, options) => {
-        return rb.execute(
-          getWorkspaceMembershipsByWorkspaceIdByUserId,
-          { path: { workspace_id: workspaceId, user_id: memberId } },
-          options
-        );
-      },
-      /**
-       * Add a user to a workspace.
-       *
-       * Grants the specified user access to the workspace with the given role.
-       * Typical attrs: `user_id`, `role` (e.g., `"member"`, `"admin"`).
-       *
-       * @param workspaceId - The UUID of the workspace to add the user to.
-       * @param attrs - Membership attributes including `user_id` and `role`.
-       * @param options - Optional request options.
-       * @returns The newly created `WorkspaceMembership`.
-       *
-       * @example
-       * ```typescript
-       * const client = new GptClient({ apiKey: 'sk_app_...' });
-       * const membership = await client.platform.workspaceMembers.create(
-       *   'ws_abc123',
-       *   { user_id: 'user_xyz', role: 'member' },
-       * );
-       * console.log('Member added:', membership.id);
-       * ```
-       */
-      create: async (workspaceId, attrs, options) => {
-        return rb.execute(
-          postWorkspaceMemberships,
-          {
-            body: {
-              data: {
-                type: "workspace-membership",
-                attributes: { workspace_id: workspaceId, ...attrs }
-              }
-            }
-          },
-          options
-        );
-      },
-      /**
-       * Update a workspace member's role or permissions.
-       *
-       * Changes the member's role within the workspace (e.g., promote to
-       * `"admin"` or demote to `"member"`). Also used to update any other
-       * membership-level settings.
-       *
-       * @param workspaceId - The UUID of the workspace.
-       * @param memberId - The UUID of the user whose membership to update.
-       * @param attrs - Attribute map of fields to change, typically `{ role }`.
-       * @param options - Optional request options.
-       * @returns The updated `WorkspaceMembership`.
-       *
-       * @example
-       * ```typescript
-       * const client = new GptClient({ apiKey: 'sk_app_...' });
-       * const membership = await client.platform.workspaceMembers.update(
-       *   'ws_abc123',
-       *   'user_xyz',
-       *   { role: 'admin' },
-       * );
-       * ```
-       */
-      update: async (workspaceId, memberId, attrs, options) => {
-        return rb.execute(
-          patchWorkspaceMembershipsByWorkspaceIdByUserId,
-          {
-            path: { workspace_id: workspaceId, user_id: memberId },
-            body: {
-              data: {
-                id: memberId,
-                type: "workspace-membership",
-                attributes: attrs
-              }
-            }
-          },
-          options
-        );
-      },
-      /**
-       * Update a workspace member's profile attributes.
-       *
-       * Sets per-member profile data within the workspace context (e.g.,
-       * display name, avatar URL, specialty, or other ISV-defined profile fields).
-       * Profile attributes are stored in a JSONB column and are distinct from
-       * role/permission settings.
-       *
-       * @param workspaceId - The UUID of the workspace.
-       * @param memberId - The UUID of the user whose profile to update.
-       * @param profileAttrs - Key-value pairs to merge into the member's profile.
-       * @param options - Optional request options.
-       * @returns The updated `WorkspaceMembership` with new profile data.
-       *
-       * @example
-       * ```typescript
-       * const client = new GptClient({ apiKey: 'sk_app_...' });
-       * const membership = await client.platform.workspaceMembers.updateProfile(
-       *   'ws_abc123',
-       *   'user_xyz',
-       *   {
-       *     display_name: 'Dr. Jane Smith',
-       *     specialty: 'Cardiology',
-       *   },
-       * );
-       * ```
-       */
-      updateProfile: async (workspaceId, memberId, profileAttrs, options) => {
-        return rb.execute(
-          patchWorkspaceMembershipsByWorkspaceIdByUserIdProfile,
-          {
-            path: { workspace_id: workspaceId, user_id: memberId },
-            body: {
-              data: {
-                type: "workspace-membership",
-                attributes: { profile_attributes: profileAttrs }
-              }
-            }
-          },
-          options
-        );
-      },
-      /**
-       * Remove a user from a workspace.
-       *
-       * Revokes the user's access to the workspace by deleting their membership
-       * record. The user's data within the workspace is not deleted; only their
-       * access is removed.
-       *
-       * @param workspaceId - The UUID of the workspace.
-       * @param memberId - The UUID of the user to remove from the workspace.
-       * @param options - Optional request options.
-       * @returns `true` on successful removal.
-       *
-       * @example
-       * ```typescript
-       * const client = new GptClient({ apiKey: 'sk_app_...' });
-       * await client.platform.workspaceMembers.remove('ws_abc123', 'user_xyz');
-       * ```
-       */
-      remove: async (workspaceId, memberId, options) => {
-        return rb.executeDelete(
-          deleteWorkspaceMembershipsByWorkspaceIdByUserId,
-          { path: { workspace_id: workspaceId, user_id: memberId } },
-          options
-        );
-      }
-    },
     /**
      * Configs — application-level configuration key-value entries.
      *
@@ -19462,92 +19205,135 @@ function createPlatformNamespace(rb) {
       }
     },
     /**
-     * Tenant Members — manage tenant-level membership (org roles).
+     * Roles — named permission bundles for workspace access control.
      *
-     * TenantMembership records represent a user's role within a tenant.
-     * Roles are either `"admin"` or `"member"`.
+     * Access via `client.platform.roles`.
      */
-    tenantMembers: {
+    roles: {
       /**
-       * List members of a tenant (paginated).
+       * List all roles for the current application.
        *
-       * @param tenantId - The UUID of the tenant.
-       * @param options - Optional page number, page size, and request options.
-       * @returns A page of `TenantMembership` records.
+       * @returns Paginated list of roles
+       * @example
+       * const roles = await client.platform.roles.list();
        */
-      list: async (tenantId, options) => {
-        return rb.execute(
-          getTenantMemberships,
-          {
-            query: {
-              filter: { tenant_id: tenantId },
-              ...buildPageQuery(options?.page, options?.pageSize).query
-            }
-          },
-          options
-        );
+      list: async () => {
+        return rb.execute(getRoles, {});
       },
       /**
-       * Add a user to a tenant with the given role.
+       * Create a new role with a set of permissions.
        *
-       * @param tenantId - The UUID of the tenant.
-       * @param userId - The UUID of the user to add.
-       * @param role - The role to assign (`"admin"` or `"member"`).
-       * @param options - Optional request options.
-       * @returns The created `TenantMembership`.
+       * @param name - Human-readable role name
+       * @param permissions - List of permission strings (e.g. "extract:document:read:all")
+       * @returns The created role
+       * @example
+       * const role = await client.platform.roles.create("Editor", ["extract:document:read:all"]);
        */
-      create: async (tenantId, userId, role, options) => {
-        return rb.execute(
-          postTenantMemberships,
-          {
-            body: {
-              data: {
-                type: "tenant_membership",
-                attributes: { tenant_id: tenantId, user_id: userId, role }
-              }
-            }
-          },
-          options
-        );
+      create: async (name, permissions) => {
+        return rb.execute(postRoles, {
+          body: { data: { type: "role", attributes: { name, permissions } } }
+        });
       },
       /**
-       * Change a member's role within a tenant.
+       * Update an existing role.
        *
-       * @param tenantId - The UUID of the tenant.
-       * @param userId - The UUID of the user.
-       * @param role - The new role (`"admin"` or `"member"`).
-       * @param options - Optional request options.
-       * @returns The updated `TenantMembership`.
+       * @param id - Role UUID
+       * @param attributes - Attributes to update (name, permissions)
+       * @returns The updated role
+       * @example
+       * const updated = await client.platform.roles.update("role-uuid", { name: "Senior Editor" });
        */
-      updateRole: async (tenantId, userId, role, options) => {
-        return rb.execute(
-          patchTenantMembershipsByTenantIdByUserId,
-          {
-            path: { tenant_id: tenantId, user_id: userId },
-            body: {
-              data: {
-                type: "tenant_membership",
-                attributes: { role }
-              }
-            }
-          },
-          options
-        );
+      update: async (id, attributes) => {
+        return rb.execute(patchRolesById, {
+          path: { id },
+          body: { data: { type: "role", id, attributes } }
+        });
       },
       /**
-       * Remove a user from a tenant.
+       * Delete a role.
        *
-       * @param tenantId - The UUID of the tenant.
-       * @param userId - The UUID of the user to remove.
-       * @param options - Optional request options.
-       * @returns `true` on success.
+       * @param id - Role UUID
+       * @example
+       * await client.platform.roles.destroy("role-uuid");
        */
-      remove: async (tenantId, userId, options) => {
-        return rb.executeDelete(
-          deleteTenantMembershipsByTenantIdByUserId,
-          { path: { tenant_id: tenantId, user_id: userId } },
-          options
-        );
+      destroy: async (id) => {
+        return rb.execute(deleteRolesById, { path: { id } });
+      }
+    },
+    /**
+     * Permissions — permission registry, presets, and metadata.
+     *
+     * Access via `client.platform.permissions`.
+     */
+    permissions: {
+      /**
+       * List all available permissions for the current application context.
+       *
+       * @param params - Optional filter parameters (context, app, category)
+       * @returns List of permissions
+       * @example
+       * const perms = await client.platform.permissions.list();
+       */
+      list: async (params) => {
+        return rb.execute(getPermissions, {
+          query: params
+        });
+      },
+      /**
+       * Get a single permission by ID.
+       *
+       * @param id - Permission ID string
+       * @returns The permission record
+       * @example
+       * const perm = await client.platform.permissions.get("extract:document:read:all");
+       */
+      get: async (id) => {
+        return rb.execute(getPermissionsById, {
+          path: { id }
+        });
+      },
+      /**
+       * Get permission metadata (available contexts, apps, and categories).
+       *
+       * @returns Permission metadata
+       * @example
+       * const meta = await client.platform.permissions.meta();
+       */
+      meta: async () => {
+        return rb.execute(getPermissionsMeta, {});
+      },
+      /**
+       * Permission presets — pre-built permission sets per role type.
+       */
+      presets: {
+        /**
+         * List all permission presets, optionally filtered by context or app.
+         *
+         * @param params - Optional filter parameters (context, app)
+         * @returns List of permission presets
+         * @example
+         * const presets = await client.platform.permissions.presets.list({ context: "workspace" });
+         */
+        list: async (params) => {
+          return rb.execute(
+            getPermissionsPresets,
+            { query: params }
+          );
+        },
+        /**
+         * Get a single permission preset by ID.
+         *
+         * @param id - Preset ID string
+         * @returns The permission preset
+         * @example
+         * const preset = await client.platform.permissions.presets.get("workspace_editor");
+         */
+        get: async (id) => {
+          return rb.execute(
+            getPermissionsPresetsById,
+            { path: { id } }
+          );
+        }
       }
     }
   };