@iblai/iblai-api 4.284.3-core → 4.285.0-core

package/dist/types/services/EximService.d.ts

@@ -3,6 +3,8 @@ import type { EximTask } from '../models/EximTask';
 import type { ExportTargetEnvironment } from '../models/ExportTargetEnvironment';
 import type { PatchedCourseExportEligibility } from '../models/PatchedCourseExportEligibility';
 import type { PatchedExportTargetEnvironment } from '../models/PatchedExportTargetEnvironment';
+import type { PlatformMigrationRun } from '../models/PlatformMigrationRun';
+import type { PlatformMigrationRunCreate } from '../models/PlatformMigrationRunCreate';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class EximService {
     /**
@@ -156,6 +158,107 @@ export declare class EximService {
          */
         id: number;
     }): CancelablePromise<void>;
+    /**
+     * Start and poll tenant-data migration runs (the platform_migration lane).
+     *
+     * ``POST`` starts a run and returns its ``run_id`` (kicking the Celery task);
+     * ``GET`` list/detail surface status + progress + report. Detail lookup is by
+     * the public ``run_id`` UUID, not the surrogate PK. Gated by the
+     * feature flag — start is rejected with 503 on non-AI deployments.
+     * @returns PlatformMigrationRun
+     * @throws ApiError
+     */
+    static eximManagePlatformMigrationsList({ direction, ordering, sourceKey, status, targetKey, }: {
+        /**
+         * * `export` - Export
+         * * `import` - Import
+         */
+        direction?: 'export' | 'import';
+        /**
+         * Which field to use when ordering the results.
+         */
+        ordering?: string;
+        sourceKey?: string;
+        /**
+         * * `pending` - Pending
+         * * `in_progress` - In Progress
+         * * `completed` - Completed
+         * * `failed` - Failed
+         * * `canceled` - Canceled
+         */
+        status?: 'canceled' | 'completed' | 'failed' | 'in_progress' | 'pending';
+        targetKey?: string;
+    }): CancelablePromise<Array<PlatformMigrationRun>>;
+    /**
+     * Start and poll tenant-data migration runs (the platform_migration lane).
+     *
+     * ``POST`` starts a run and returns its ``run_id`` (kicking the Celery task);
+     * ``GET`` list/detail surface status + progress + report. Detail lookup is by
+     * the public ``run_id`` UUID, not the surrogate PK. Gated by the
+     * feature flag — start is rejected with 503 on non-AI deployments.
+     * @returns PlatformMigrationRunCreate
+     * @throws ApiError
+     */
+    static eximManagePlatformMigrationsCreate({ requestBody, }: {
+        requestBody: PlatformMigrationRunCreate;
+    }): CancelablePromise<PlatformMigrationRunCreate>;
+    /**
+     * Start and poll tenant-data migration runs (the platform_migration lane).
+     *
+     * ``POST`` starts a run and returns its ``run_id`` (kicking the Celery task);
+     * ``GET`` list/detail surface status + progress + report. Detail lookup is by
+     * the public ``run_id`` UUID, not the surrogate PK. Gated by the
+     * feature flag — start is rejected with 503 on non-AI deployments.
+     * @returns PlatformMigrationRun
+     * @throws ApiError
+     */
+    static eximManagePlatformMigrationsRetrieve({ runId, }: {
+        runId: string;
+    }): CancelablePromise<PlatformMigrationRun>;
+    /**
+     * Cancel a still-pending run. No-op for any other status.
+     *
+     * Conditional UPDATE so we don't race the worker: if it has already flipped
+     * the row to ``in_progress`` the UPDATE matches zero rows and we return 409.
+     * A run already executing is not interrupted mid-phase.
+     * @returns PlatformMigrationRun
+     * @throws ApiError
+     */
+    static eximManagePlatformMigrationsCancelCreate({ runId, requestBody, }: {
+        runId: string;
+        requestBody?: PlatformMigrationRun;
+    }): CancelablePromise<PlatformMigrationRun>;
+    /**
+     * Stream a completed export's bundle as a single ``.zip``.
+     *
+     * Token-gated (IsDMAdmin) REST mirror of the admin "Download .zip" link, so
+     * a programmatic caller can pull the bundle down to move it to another
+     * deployment. Only a completed EXPORT with a bundle still on disk is
+     * downloadable; imports and not-yet-finished runs have nothing to stream.
+     * @returns PlatformMigrationRun
+     * @throws ApiError
+     */
+    static eximManagePlatformMigrationsDownloadRetrieve({ runId, }: {
+        runId: string;
+    }): CancelablePromise<PlatformMigrationRun>;
+    /**
+     * Upload a bundle ``.zip`` and start an import run from it (API parity).
+     *
+     * The programmatic mirror of the admin "Import from uploaded ZIP" page, so a
+     * caller that pulled a bundle off one deployment can push it to another over
+     * the API alone. Multipart fields: ``bundle_file`` (the zip, required),
+     * ``target_key`` (required), optional ``selected_components`` (repeatable),
+     * ``admin_user``, ``email``.
+     *
+     * On an S3 deployment the validated bundle is stored to S3 and the import
+     * runs from there (any node can execute it); otherwise it stays on local
+     * disk like the admin flow.
+     * @returns PlatformMigrationRun
+     * @throws ApiError
+     */
+    static eximManagePlatformMigrationsImportUploadCreate({ formData, }: {
+        formData?: PlatformMigrationRun;
+    }): CancelablePromise<PlatformMigrationRun>;
     /**
      * Admin-only read-only access to EximTask records.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/iblai-api",
-  "version": "4.284.3-core",
+  "version": "4.285.0-core",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "type": "module",

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.284.3-core
+  version: 4.285.0-core
   description: API for iblai
 paths:
   /access-check/{item_type}/{item_id}/:
@@ -29851,6 +29851,242 @@ paths:
       responses:
         '204':
           description: No response body
+  /api/exim/manage/platform-migrations/:
+    get:
+      operationId: exim_manage_platform_migrations_list
+      description: |-
+        Start and poll tenant-data migration runs (the platform_migration lane).
+
+        ``POST`` starts a run and returns its ``run_id`` (kicking the Celery task);
+        ``GET`` list/detail surface status + progress + report. Detail lookup is by
+        the public ``run_id`` UUID, not the surrogate PK. Gated by the
+        feature flag — start is rejected with 503 on non-AI deployments.
+      parameters:
+      - in: query
+        name: direction
+        schema:
+          type: string
+          enum:
+          - export
+          - import
+        description: |-
+          * `export` - Export
+          * `import` - Import
+      - name: ordering
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
+      - in: query
+        name: source_key
+        schema:
+          type: string
+      - in: query
+        name: status
+        schema:
+          type: string
+          enum:
+          - canceled
+          - completed
+          - failed
+          - in_progress
+          - pending
+        description: |-
+          * `pending` - Pending
+          * `in_progress` - In Progress
+          * `completed` - Completed
+          * `failed` - Failed
+          * `canceled` - Canceled
+      - in: query
+        name: target_key
+        schema:
+          type: string
+      tags:
+      - exim
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/PlatformMigrationRun'
+          description: ''
+    post:
+      operationId: exim_manage_platform_migrations_create
+      description: |-
+        Start and poll tenant-data migration runs (the platform_migration lane).
+
+        ``POST`` starts a run and returns its ``run_id`` (kicking the Celery task);
+        ``GET`` list/detail surface status + progress + report. Detail lookup is by
+        the public ``run_id`` UUID, not the surrogate PK. Gated by the
+        feature flag — start is rejected with 503 on non-AI deployments.
+      tags:
+      - exim
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRunCreate'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRunCreate'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRunCreate'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRunCreate'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRunCreate'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformMigrationRunCreate'
+          description: ''
+  /api/exim/manage/platform-migrations/{run_id}/:
+    get:
+      operationId: exim_manage_platform_migrations_retrieve
+      description: |-
+        Start and poll tenant-data migration runs (the platform_migration lane).
+
+        ``POST`` starts a run and returns its ``run_id`` (kicking the Celery task);
+        ``GET`` list/detail surface status + progress + report. Detail lookup is by
+        the public ``run_id`` UUID, not the surrogate PK. Gated by the
+        feature flag — start is rejected with 503 on non-AI deployments.
+      parameters:
+      - in: path
+        name: run_id
+        schema:
+          type: string
+          format: uuid
+        required: true
+      tags:
+      - exim
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformMigrationRun'
+          description: ''
+  /api/exim/manage/platform-migrations/{run_id}/cancel/:
+    post:
+      operationId: exim_manage_platform_migrations_cancel_create
+      description: |-
+        Cancel a still-pending run. No-op for any other status.
+
+        Conditional UPDATE so we don't race the worker: if it has already flipped
+        the row to ``in_progress`` the UPDATE matches zero rows and we return 409.
+        A run already executing is not interrupted mid-phase.
+      parameters:
+      - in: path
+        name: run_id
+        schema:
+          type: string
+          format: uuid
+        required: true
+      tags:
+      - exim
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRun'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRun'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRun'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRun'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRun'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformMigrationRun'
+          description: ''
+  /api/exim/manage/platform-migrations/{run_id}/download/:
+    get:
+      operationId: exim_manage_platform_migrations_download_retrieve
+      description: |-
+        Stream a completed export's bundle as a single ``.zip``.
+
+        Token-gated (IsDMAdmin) REST mirror of the admin "Download .zip" link, so
+        a programmatic caller can pull the bundle down to move it to another
+        deployment. Only a completed EXPORT with a bundle still on disk is
+        downloadable; imports and not-yet-finished runs have nothing to stream.
+      parameters:
+      - in: path
+        name: run_id
+        schema:
+          type: string
+          format: uuid
+        required: true
+      tags:
+      - exim
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformMigrationRun'
+          description: ''
+  /api/exim/manage/platform-migrations/import-upload/:
+    post:
+      operationId: exim_manage_platform_migrations_import_upload_create
+      description: |-
+        Upload a bundle ``.zip`` and start an import run from it (API parity).
+
+        The programmatic mirror of the admin "Import from uploaded ZIP" page, so a
+        caller that pulled a bundle off one deployment can push it to another over
+        the API alone. Multipart fields: ``bundle_file`` (the zip, required),
+        ``target_key`` (required), optional ``selected_components`` (repeatable),
+        ``admin_user``, ``email``.
+
+        On an S3 deployment the validated bundle is stored to S3 and the import
+        runs from there (any node can execute it); otherwise it stays on local
+        disk like the admin flow.
+      tags:
+      - exim
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRun'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlatformMigrationRun'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformMigrationRun'
+          description: ''
   /api/exim/manage/tasks/:
     get:
       operationId: exim_manage_tasks_list
@@ -47010,6 +47246,14 @@ components:
       required:
       - display_name
       - id
+    DirectionEnum:
+      enum:
+      - export
+      - import
+      type: string
+      description: |-
+        * `export` - Export
+        * `import` - Import
     DisabilityStatusEnum:
       enum:
       - 'yes'
@@ -47341,7 +47585,7 @@ components:
           readOnly: true
         status:
           allOf:
-          - $ref: '#/components/schemas/EximTaskStatusEnum'
+          - $ref: '#/components/schemas/Status147Enum'
           readOnly: true
         published_at:
           type: string
@@ -47393,20 +47637,6 @@ components:
       - target_environment
       - target_environment_name
       - updated_at
-    EximTaskStatusEnum:
-      enum:
-      - pending
-      - in_progress
-      - completed
-      - failed
-      - canceled
-      type: string
-      description: |-
-        * `pending` - Pending
-        * `in_progress` - In Progress
-        * `completed` - Completed
-        * `failed` - Failed
-        * `canceled` - Canceled
     Experience:
       type: object
       properties:
@@ -54918,6 +55148,135 @@ components:
       - programs
       - resources
       - skills
+    PlatformMigrationRun:
+      type: object
+      description: |-
+        Read-only view of a platform migration run — the status/progress payload.
+
+        ``run_id`` is the public task id callers poll on. ``report`` carries the
+        per-phase summaries, component selection, id-map totals and warnings written
+        by the runner. ``download_url`` is the link to pull the bundle as a ``.zip``
+        once a completed export has one on disk (null otherwise).
+      properties:
+        run_id:
+          type: string
+          format: uuid
+          readOnly: true
+        direction:
+          allOf:
+          - $ref: '#/components/schemas/DirectionEnum'
+          readOnly: true
+        source_key:
+          type: string
+          readOnly: true
+        target_key:
+          type: string
+          readOnly: true
+        bundle_path:
+          type: string
+          readOnly: true
+        bundle_storage_key:
+          type: string
+          readOnly: true
+        status:
+          allOf:
+          - $ref: '#/components/schemas/Status147Enum'
+          readOnly: true
+        phase:
+          type: string
+          readOnly: true
+        cursor:
+          readOnly: true
+        selected_components:
+          readOnly: true
+        admin_user:
+          type: string
+          readOnly: true
+        email:
+          type: string
+          format: email
+          readOnly: true
+        report:
+          readOnly: true
+        error_message:
+          type: string
+          readOnly: true
+        download_url:
+          type: string
+          readOnly: true
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
+        started_at:
+          type: string
+          format: date-time
+          readOnly: true
+          nullable: true
+        finished_at:
+          type: string
+          format: date-time
+          readOnly: true
+          nullable: true
+      required:
+      - admin_user
+      - bundle_path
+      - bundle_storage_key
+      - created_at
+      - cursor
+      - direction
+      - download_url
+      - email
+      - error_message
+      - finished_at
+      - phase
+      - report
+      - run_id
+      - selected_components
+      - source_key
+      - started_at
+      - status
+      - target_key
+      - updated_at
+    PlatformMigrationRunCreate:
+      type: object
+      description: |-
+        Start a migration run. Validates the request; the view kicks the task.
+
+        ``selected_components`` is the OPTIONAL-set selection; mandatory
+        sets always run regardless. An empty/omitted list = full fidelity.
+      properties:
+        run_id:
+          type: string
+          format: uuid
+          readOnly: true
+        direction:
+          $ref: '#/components/schemas/DirectionEnum'
+        source_key:
+          type: string
+          maxLength: 255
+        target_key:
+          type: string
+          maxLength: 255
+        bundle_path:
+          type: string
+        bundle_storage_key:
+          type: string
+        selected_components: {}
+        admin_user:
+          type: string
+          maxLength: 255
+        email:
+          type: string
+          format: email
+          maxLength: 254
+      required:
+      - direction
+      - run_id
     PlatformPublicImageAsset:
       type: object
       properties:
@@ -58125,6 +58484,20 @@ components:
         * `past_due` - Past Due
         * `canceled` - Canceled
         * `incomplete` - Incomplete
+    Status147Enum:
+      enum:
+      - pending
+      - in_progress
+      - completed
+      - failed
+      - canceled
+      type: string
+      description: |-
+        * `pending` - Pending
+        * `in_progress` - In Progress
+        * `completed` - Completed
+        * `failed` - Failed
+        * `canceled` - Canceled
     Status3daEnum:
       enum:
       - READ

package/src/core/OpenAPI.ts

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

package/src/index.ts

@@ -149,6 +149,7 @@ export type { DesiredSkillCreateUpdateRequest } from './models/DesiredSkillCreat
 export type { DetailedGradeSubsection } from './models/DetailedGradeSubsection';
 export type { DetailedGradeView } from './models/DetailedGradeView';
 export type { DetailedGradeViewData } from './models/DetailedGradeViewData';
+export { DirectionEnum } from './models/DirectionEnum';
 export { DisabilityStatusEnum } from './models/DisabilityStatusEnum';
 export type { Education } from './models/Education';
 export type { EdxJwtToken } from './models/EdxJwtToken';
@@ -165,7 +166,6 @@ export type { ErrorResponse } from './models/ErrorResponse';
 export { EthnicityEnum } from './models/EthnicityEnum';
 export { EventsEnum } from './models/EventsEnum';
 export type { EximTask } from './models/EximTask';
-export { EximTaskStatusEnum } from './models/EximTaskStatusEnum';
 export type { Experience } from './models/Experience';
 export type { ExportTargetEnvironment } from './models/ExportTargetEnvironment';
 export type { ExternalCredentialMapping } from './models/ExternalCredentialMapping';
@@ -392,6 +392,8 @@ export type { PlatformMembershipConfig } from './models/PlatformMembershipConfig
 export type { PlatformMembershipConfigPostRequest } from './models/PlatformMembershipConfigPostRequest';
 export type { PlatformMembershipConfigPublicResponse } from './models/PlatformMembershipConfigPublicResponse';
 export type { PlatformMetrics } from './models/PlatformMetrics';
+export type { PlatformMigrationRun } from './models/PlatformMigrationRun';
+export type { PlatformMigrationRunCreate } from './models/PlatformMigrationRunCreate';
 export type { PlatformPublicImageAsset } from './models/PlatformPublicImageAsset';
 export type { PlatformPublicMetadata } from './models/PlatformPublicMetadata';
 export type { PlatformRevenueSummary } from './models/PlatformRevenueSummary';
@@ -495,6 +497,7 @@ export type { SkillThreshold } from './models/SkillThreshold';
 export type { Spa } from './models/Spa';
 export { StateEnum } from './models/StateEnum';
 export { Status0e3Enum } from './models/Status0e3Enum';
+export { Status147Enum } from './models/Status147Enum';
 export { Status3daEnum } from './models/Status3daEnum';
 export type { StripeCheckoutSessionRequest } from './models/StripeCheckoutSessionRequest';
 export type { StripeCheckoutSessionResponse } from './models/StripeCheckoutSessionResponse';

package/src/models/DirectionEnum.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `export` - Export
+ * * `import` - Import
+ */
+export enum DirectionEnum {
+    EXPORT = 'export',
+    IMPORT = 'import',
+}

package/src/models/EximTask.ts

@@ -2,7 +2,7 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { EximTaskStatusEnum } from './EximTaskStatusEnum';
+import type { Status147Enum } from './Status147Enum';
 /**
  * Read-only serializer for EximTask records.
  *
@@ -15,7 +15,7 @@ export type EximTask = {
     readonly course_id: string;
     readonly target_environment: number;
     readonly target_environment_name: string;
-    readonly status: EximTaskStatusEnum;
+    readonly status: Status147Enum;
     /**
      * Time the publish signal was received; used for FIFO ordering
      */

package/src/models/PlatformMigrationRun.ts

@@ -0,0 +1,36 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { DirectionEnum } from './DirectionEnum';
+import type { Status147Enum } from './Status147Enum';
+/**
+ * Read-only view of a platform migration run — the status/progress payload.
+ *
+ * ``run_id`` is the public task id callers poll on. ``report`` carries the
+ * per-phase summaries, component selection, id-map totals and warnings written
+ * by the runner. ``download_url`` is the link to pull the bundle as a ``.zip``
+ * once a completed export has one on disk (null otherwise).
+ */
+export type PlatformMigrationRun = {
+    readonly run_id: string;
+    readonly direction: DirectionEnum;
+    readonly source_key: string;
+    readonly target_key: string;
+    readonly bundle_path: string;
+    readonly bundle_storage_key: string;
+    readonly status: Status147Enum;
+    readonly phase: string;
+    readonly cursor: any;
+    readonly selected_components: any;
+    readonly admin_user: string;
+    readonly email: string;
+    readonly report: any;
+    readonly error_message: string;
+    readonly download_url: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly started_at: string | null;
+    readonly finished_at: string | null;
+};
+