@iblai/iblai-api 4.295.0-core → 4.296.0-core

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.295.0-core
+  version: 4.296.0-core
   description: API for iblai
 paths:
   /api/analytics/content/:
@@ -18003,6 +18003,18 @@ paths:
       operationId: core_platform_api_tokens_list
       description: List Platform API Key's belonging to the target platform
       parameters:
+      - name: page
+        required: false
+        in: query
+        description: A page number within the paginated result set.
+        schema:
+          type: integer
+      - name: page_size
+        required: false
+        in: query
+        description: Number of results to return per page.
+        schema:
+          type: integer
       - in: query
         name: platform_key
         schema:
@@ -18017,9 +18029,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/PlatformApiKey'
+                $ref: '#/components/schemas/PaginatedPlatformApiKeyList'
           description: ''
     post:
       operationId: core_platform_api_tokens_create
@@ -18052,6 +18062,75 @@ paths:
                 $ref: '#/components/schemas/PlatformApiKey'
           description: ''
   /api/core/platform/api-tokens/{name}:
+    get:
+      operationId: core_platform_api_tokens_retrieve
+      description: Retrieve a single Platform Api Key by name, including the policies
+        and groups currently associated with it
+      parameters:
+      - in: path
+        name: name
+        schema:
+          type: string
+        required: true
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        description: Platform key of target platform
+        required: true
+      tags:
+      - core
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformApiKey'
+          description: ''
+    patch:
+      operationId: core_platform_api_tokens_partial_update
+      description: Update a Platform Api Key's mode and associated policies/groups
+        in the target platform
+      parameters:
+      - in: path
+        name: name
+        schema:
+          type: string
+        required: true
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        description: Platform key of target platform
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApiKey'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApiKey'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApiKey'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApiKey'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApiKey'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformApiKey'
+          description: ''
     delete:
       operationId: core_platform_api_tokens_destroy
       description: Delete Platform Api Key by name in the target platform
@@ -18073,6 +18152,28 @@ paths:
       responses:
         '204':
           description: No response body
+  /api/core/platform/api-tokens/field-permissions/:
+    get:
+      operationId: core_platform_api_tokens_field_permissions_retrieve
+      description: 'Per-field write permissions for the create form, as {field: {"write":
+        bool}}. Gated on create access like the create endpoint.'
+      parameters:
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        description: Platform key of target platform
+        required: true
+      tags:
+      - core
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformApiTokenFieldPermissions'
+          description: ''
   /api/core/platform/config/site/:
     get:
       operationId: core_platform_config_site_retrieve
@@ -46349,16 +46450,6 @@ components:
             additionalProperties: {}
       required:
       - total
-    ModeEnum:
-      enum:
-      - subscription
-      - payment
-      - setup
-      type: string
-      description: |-
-        * `subscription` - subscription
-        * `payment` - payment
-        * `setup` - setup
     NewPerLearnerList:
       type: object
       properties:
@@ -47874,6 +47965,29 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/PipelineStage'
+    PaginatedPlatformApiKeyList:
+      type: object
+      required:
+      - count
+      - results
+      properties:
+        count:
+          type: integer
+          example: 123
+        next:
+          type: string
+          nullable: true
+          format: uri
+          example: http://api.example.org/accounts/?page=4
+        previous:
+          type: string
+          nullable: true
+          format: uri
+          example: http://api.example.org/accounts/?page=2
+        results:
+          type: array
+          items:
+            $ref: '#/components/schemas/PlatformApiKey'
     PaginatedPlatformInvitation:
       type: object
       description: Response serializer for paginated platform invitation list
@@ -49662,6 +49776,74 @@ components:
           type: string
           format: date-time
           readOnly: true
+    PatchedPlatformApiKey:
+      type: object
+      description: Serializer for PlatformApiKey's
+      properties:
+        username:
+          type: string
+          readOnly: true
+          description: Username that created token
+        name:
+          type: string
+          description: Name of the token. Used by the user to identify the token.
+          maxLength: 255
+          pattern: ^[-a-zA-Z0-9_]+$
+        key:
+          type: string
+          readOnly: true
+        platform_key:
+          type: string
+          description: The platform key
+          writeOnly: true
+        expires:
+          type: string
+          format: date-time
+          readOnly: true
+          description: When token expires
+        expires_in:
+          type: string
+          writeOnly: true
+          nullable: true
+          description: 'Optional duration until key expires. Format: [DD] [HH:[MM:]]ss[.uuuuuu]'
+        created:
+          type: string
+          format: date-time
+          readOnly: true
+          description: When token was created
+        mode:
+          allOf:
+          - $ref: '#/components/schemas/PlatformApiKeyModeEnum'
+          default: owner
+          description: |-
+            How permissions resolve: 'owner' (default) uses the owner's RBAC permissions; 'token_policies' uses the policies/groups this token is associated with
+
+            * `owner` - Owner permissions
+            * `token_policies` - Token policies
+        policies_to_add:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: RbacPolicy IDs to associate with this token (mode=token_policies)
+        policies_to_remove:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: RbacPolicy IDs to disassociate from this token (mode=token_policies)
+        groups_to_add:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: RbacGroup IDs to associate with this token (mode=token_policies)
+        groups_to_remove:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: RbacGroup IDs to disassociate from this token (mode=token_policies)
     PatchedPlatformPublicImageAsset:
       type: object
       properties:
@@ -51384,13 +51566,107 @@ components:
           format: date-time
           readOnly: true
           description: When token was created
+        mode:
+          allOf:
+          - $ref: '#/components/schemas/PlatformApiKeyModeEnum'
+          default: owner
+          description: |-
+            How permissions resolve: 'owner' (default) uses the owner's RBAC permissions; 'token_policies' uses the policies/groups this token is associated with
+
+            * `owner` - Owner permissions
+            * `token_policies` - Token policies
+        policies_to_add:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: RbacPolicy IDs to associate with this token (mode=token_policies)
+        policies_to_remove:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: RbacPolicy IDs to disassociate from this token (mode=token_policies)
+        groups_to_add:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: RbacGroup IDs to associate with this token (mode=token_policies)
+        groups_to_remove:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: RbacGroup IDs to disassociate from this token (mode=token_policies)
       required:
       - created
       - expires
       - key
       - name
-      - platform_key
       - username
+    PlatformApiKeyModeEnum:
+      enum:
+      - owner
+      - token_policies
+      type: string
+      description: |-
+        * `owner` - Owner permissions
+        * `token_policies` - Token policies
+    PlatformApiTokenFieldPermissions:
+      type: object
+      properties:
+        mode:
+          $ref: '#/components/schemas/PlatformApiToken_mode_Permission'
+        policies_to_add:
+          $ref: '#/components/schemas/PlatformApiToken_policies_to_add_Permission'
+        policies_to_remove:
+          $ref: '#/components/schemas/PlatformApiToken_policies_to_remove_Permission'
+        groups_to_add:
+          $ref: '#/components/schemas/PlatformApiToken_groups_to_add_Permission'
+        groups_to_remove:
+          $ref: '#/components/schemas/PlatformApiToken_groups_to_remove_Permission'
+      required:
+      - groups_to_add
+      - groups_to_remove
+      - mode
+      - policies_to_add
+      - policies_to_remove
+    PlatformApiToken_groups_to_add_Permission:
+      type: object
+      properties:
+        write:
+          type: boolean
+      required:
+      - write
+    PlatformApiToken_groups_to_remove_Permission:
+      type: object
+      properties:
+        write:
+          type: boolean
+      required:
+      - write
+    PlatformApiToken_mode_Permission:
+      type: object
+      properties:
+        write:
+          type: boolean
+      required:
+      - write
+    PlatformApiToken_policies_to_add_Permission:
+      type: object
+      properties:
+        write:
+          type: boolean
+      required:
+      - write
+    PlatformApiToken_policies_to_remove_Permission:
+      type: object
+      properties:
+        write:
+          type: boolean
+      required:
+      - write
     PlatformConfigurationList:
       type: object
       description: Serializer for listing platform configurations
@@ -55308,7 +55584,7 @@ components:
           description: URL to redirect if checkout cancelled
         mode:
           allOf:
-          - $ref: '#/components/schemas/ModeEnum'
+          - $ref: '#/components/schemas/StripeCheckoutSessionRequestModeEnum'
           default: subscription
           description: |-
             Checkout mode
@@ -55353,6 +55629,16 @@ components:
       - cancel_url
       - success_url
       - tenant
+    StripeCheckoutSessionRequestModeEnum:
+      enum:
+      - subscription
+      - payment
+      - setup
+      type: string
+      description: |-
+        * `subscription` - subscription
+        * `payment` - payment
+        * `setup` - setup
     StripeCheckoutSessionResponse:
       type: object
       description: Stripe checkout session serialized response

package/src/core/OpenAPI.ts

@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: 'https://base.manager.iblai.app',
-    VERSION: '4.295.0-core',
+    VERSION: '4.296.0-core',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -228,7 +228,6 @@ export type { MentorDetail } from './models/MentorDetail';
 export type { MentorInteractions } from './models/MentorInteractions';
 export type { MentorPolicy } from './models/MentorPolicy';
 export type { MetricDetail } from './models/MetricDetail';
-export { ModeEnum } from './models/ModeEnum';
 export type { NewPerLearnerList } from './models/NewPerLearnerList';
 export type { NewPerLearnerListData } from './models/NewPerLearnerListData';
 export type { Notification } from './models/Notification';
@@ -273,6 +272,7 @@ export type { PaginatedPathwaySuggestion } from './models/PaginatedPathwaySugges
 export type { PaginatedPersonList } from './models/PaginatedPersonList';
 export type { PaginatedPipelineList } from './models/PaginatedPipelineList';
 export type { PaginatedPipelineStageList } from './models/PaginatedPipelineStageList';
+export type { PaginatedPlatformApiKeyList } from './models/PaginatedPlatformApiKeyList';
 export type { PaginatedPlatformInvitation } from './models/PaginatedPlatformInvitation';
 export type { PaginatedPlatformLicense } from './models/PaginatedPlatformLicense';
 export type { PaginatedProgramGroupSuggestion } from './models/PaginatedProgramGroupSuggestion';
@@ -312,6 +312,7 @@ export type { PatchedOrganization } from './models/PatchedOrganization';
 export type { PatchedPerson } from './models/PatchedPerson';
 export type { PatchedPipeline } from './models/PatchedPipeline';
 export type { PatchedPipelineStage } from './models/PatchedPipelineStage';
+export type { PatchedPlatformApiKey } from './models/PatchedPlatformApiKey';
 export type { PatchedPlatformPublicImageAsset } from './models/PatchedPlatformPublicImageAsset';
 export type { PatchedPlatformPublicMetadata } from './models/PatchedPlatformPublicMetadata';
 export type { PatchedRbacGroup } from './models/PatchedRbacGroup';
@@ -376,6 +377,13 @@ export type { Pipeline } from './models/Pipeline';
 export type { PipelineStage } from './models/PipelineStage';
 export type { Platform } from './models/Platform';
 export type { PlatformApiKey } from './models/PlatformApiKey';
+export { PlatformApiKeyModeEnum } from './models/PlatformApiKeyModeEnum';
+export type { PlatformApiToken_groups_to_add_Permission } from './models/PlatformApiToken_groups_to_add_Permission';
+export type { PlatformApiToken_groups_to_remove_Permission } from './models/PlatformApiToken_groups_to_remove_Permission';
+export type { PlatformApiToken_mode_Permission } from './models/PlatformApiToken_mode_Permission';
+export type { PlatformApiToken_policies_to_add_Permission } from './models/PlatformApiToken_policies_to_add_Permission';
+export type { PlatformApiToken_policies_to_remove_Permission } from './models/PlatformApiToken_policies_to_remove_Permission';
+export type { PlatformApiTokenFieldPermissions } from './models/PlatformApiTokenFieldPermissions';
 export type { PlatformConfigurationList } from './models/PlatformConfigurationList';
 export type { PlatformConfigurationSet } from './models/PlatformConfigurationSet';
 export type { PlatformConfigurationSetResponse } from './models/PlatformConfigurationSetResponse';
@@ -501,6 +509,7 @@ export { Status0e3Enum } from './models/Status0e3Enum';
 export { Status147Enum } from './models/Status147Enum';
 export { Status3daEnum } from './models/Status3daEnum';
 export type { StripeCheckoutSessionRequest } from './models/StripeCheckoutSessionRequest';
+export { StripeCheckoutSessionRequestModeEnum } from './models/StripeCheckoutSessionRequestModeEnum';
 export type { StripeCheckoutSessionResponse } from './models/StripeCheckoutSessionResponse';
 export type { StripeConnectDashboardLink } from './models/StripeConnectDashboardLink';
 export type { StripeConnectOnboard } from './models/StripeConnectOnboard';

package/src/models/PaginatedPlatformApiKeyList.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PlatformApiKey } from './PlatformApiKey';
+export type PaginatedPlatformApiKeyList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<PlatformApiKey>;
+};
+

package/src/models/PatchedPlatformApiKey.ts

@@ -0,0 +1,59 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PlatformApiKeyModeEnum } from './PlatformApiKeyModeEnum';
+/**
+ * Serializer for PlatformApiKey's
+ */
+export type PatchedPlatformApiKey = {
+    /**
+     * Username that created token
+     */
+    readonly username?: string;
+    /**
+     * Name of the token. Used by the user to identify the token.
+     */
+    name?: string;
+    readonly key?: string;
+    /**
+     * The platform key
+     */
+    platform_key?: string;
+    /**
+     * When token expires
+     */
+    readonly expires?: string;
+    /**
+     * Optional duration until key expires. Format: [DD] [HH:[MM:]]ss[.uuuuuu]
+     */
+    expires_in?: string | null;
+    /**
+     * When token was created
+     */
+    readonly created?: string;
+    /**
+     * How permissions resolve: 'owner' (default) uses the owner's RBAC permissions; 'token_policies' uses the policies/groups this token is associated with
+     *
+     * * `owner` - Owner permissions
+     * * `token_policies` - Token policies
+     */
+    mode?: PlatformApiKeyModeEnum;
+    /**
+     * RbacPolicy IDs to associate with this token (mode=token_policies)
+     */
+    policies_to_add?: Array<number>;
+    /**
+     * RbacPolicy IDs to disassociate from this token (mode=token_policies)
+     */
+    policies_to_remove?: Array<number>;
+    /**
+     * RbacGroup IDs to associate with this token (mode=token_policies)
+     */
+    groups_to_add?: Array<number>;
+    /**
+     * RbacGroup IDs to disassociate from this token (mode=token_policies)
+     */
+    groups_to_remove?: Array<number>;
+};
+

package/src/models/PlatformApiKey.ts

@@ -2,6 +2,7 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+import type { PlatformApiKeyModeEnum } from './PlatformApiKeyModeEnum';
 /**
  * Serializer for PlatformApiKey's
  */
@@ -18,7 +19,7 @@ export type PlatformApiKey = {
     /**
      * The platform key
      */
-    platform_key: string;
+    platform_key?: string;
     /**
      * When token expires
      */
@@ -31,5 +32,28 @@ export type PlatformApiKey = {
      * When token was created
      */
     readonly created: string;
+    /**
+     * How permissions resolve: 'owner' (default) uses the owner's RBAC permissions; 'token_policies' uses the policies/groups this token is associated with
+     *
+     * * `owner` - Owner permissions
+     * * `token_policies` - Token policies
+     */
+    mode?: PlatformApiKeyModeEnum;
+    /**
+     * RbacPolicy IDs to associate with this token (mode=token_policies)
+     */
+    policies_to_add?: Array<number>;
+    /**
+     * RbacPolicy IDs to disassociate from this token (mode=token_policies)
+     */
+    policies_to_remove?: Array<number>;
+    /**
+     * RbacGroup IDs to associate with this token (mode=token_policies)
+     */
+    groups_to_add?: Array<number>;
+    /**
+     * RbacGroup IDs to disassociate from this token (mode=token_policies)
+     */
+    groups_to_remove?: Array<number>;
 };
 

package/src/models/PlatformApiKeyModeEnum.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `owner` - Owner permissions
+ * * `token_policies` - Token policies
+ */
+export enum PlatformApiKeyModeEnum {
+    OWNER = 'owner',
+    TOKEN_POLICIES = 'token_policies',
+}

package/src/models/PlatformApiTokenFieldPermissions.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PlatformApiToken_groups_to_add_Permission } from './PlatformApiToken_groups_to_add_Permission';
+import type { PlatformApiToken_groups_to_remove_Permission } from './PlatformApiToken_groups_to_remove_Permission';
+import type { PlatformApiToken_mode_Permission } from './PlatformApiToken_mode_Permission';
+import type { PlatformApiToken_policies_to_add_Permission } from './PlatformApiToken_policies_to_add_Permission';
+import type { PlatformApiToken_policies_to_remove_Permission } from './PlatformApiToken_policies_to_remove_Permission';
+export type PlatformApiTokenFieldPermissions = {
+    mode: PlatformApiToken_mode_Permission;
+    policies_to_add: PlatformApiToken_policies_to_add_Permission;
+    policies_to_remove: PlatformApiToken_policies_to_remove_Permission;
+    groups_to_add: PlatformApiToken_groups_to_add_Permission;
+    groups_to_remove: PlatformApiToken_groups_to_remove_Permission;
+};
+

package/src/models/PlatformApiToken_groups_to_add_Permission.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PlatformApiToken_groups_to_add_Permission = {
+    write: boolean;
+};
+

package/src/models/PlatformApiToken_groups_to_remove_Permission.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PlatformApiToken_groups_to_remove_Permission = {
+    write: boolean;
+};
+

package/src/models/PlatformApiToken_mode_Permission.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PlatformApiToken_mode_Permission = {
+    write: boolean;
+};
+

package/src/models/PlatformApiToken_policies_to_add_Permission.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PlatformApiToken_policies_to_add_Permission = {
+    write: boolean;
+};
+

package/src/models/PlatformApiToken_policies_to_remove_Permission.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PlatformApiToken_policies_to_remove_Permission = {
+    write: boolean;
+};
+

package/src/models/StripeCheckoutSessionRequest.ts

@@ -2,8 +2,8 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { ModeEnum } from './ModeEnum';
 import type { PeriodEnum } from './PeriodEnum';
+import type { StripeCheckoutSessionRequestModeEnum } from './StripeCheckoutSessionRequestModeEnum';
 /**
  * Serializer for Stripe checkout session creation requests.
  */
@@ -35,7 +35,7 @@ export type StripeCheckoutSessionRequest = {
      * * `payment` - payment
      * * `setup` - setup
      */
-    mode?: ModeEnum;
+    mode?: StripeCheckoutSessionRequestModeEnum;
     /**
      * Billing period
      *

package/src/models/{ModeEnum.ts → StripeCheckoutSessionRequestModeEnum.ts}

@@ -7,7 +7,7 @@
  * * `payment` - payment
  * * `setup` - setup
  */
-export enum ModeEnum {
+export enum StripeCheckoutSessionRequestModeEnum {
     SUBSCRIPTION = 'subscription',
     PAYMENT = 'payment',
     SETUP = 'setup',