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

package/src/models/PlatformMigrationRunCreate.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { DirectionEnum } from './DirectionEnum';
+/**
+ * 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.
+ */
+export type PlatformMigrationRunCreate = {
+    readonly run_id: string;
+    direction: DirectionEnum;
+    source_key?: string;
+    target_key?: string;
+    bundle_path?: string;
+    bundle_storage_key?: string;
+    selected_components?: any;
+    admin_user?: string;
+    email?: string;
+};
+

package/src/models/{EximTaskStatusEnum.ts → Status147Enum.ts}

@@ -9,7 +9,7 @@
  * * `failed` - Failed
  * * `canceled` - Canceled
  */
-export enum EximTaskStatusEnum {
+export enum Status147Enum {
     PENDING = 'pending',
     IN_PROGRESS = 'in_progress',
     COMPLETED = 'completed',

package/src/services/EximService.ts

@@ -7,6 +7,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';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
@@ -298,6 +300,176 @@ export class EximService {
             },
         });
     }
+    /**
+     * 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
+     */
+    public 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>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/exim/manage/platform-migrations/',
+            query: {
+                'direction': direction,
+                'ordering': ordering,
+                'source_key': sourceKey,
+                'status': status,
+                'target_key': targetKey,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static eximManagePlatformMigrationsCreate({
+        requestBody,
+    }: {
+        requestBody: PlatformMigrationRunCreate,
+    }): CancelablePromise<PlatformMigrationRunCreate> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/exim/manage/platform-migrations/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * 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
+     */
+    public static eximManagePlatformMigrationsRetrieve({
+        runId,
+    }: {
+        runId: string,
+    }): CancelablePromise<PlatformMigrationRun> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/exim/manage/platform-migrations/{run_id}/',
+            path: {
+                'run_id': runId,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static eximManagePlatformMigrationsCancelCreate({
+        runId,
+        requestBody,
+    }: {
+        runId: string,
+        requestBody?: PlatformMigrationRun,
+    }): CancelablePromise<PlatformMigrationRun> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/exim/manage/platform-migrations/{run_id}/cancel/',
+            path: {
+                'run_id': runId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * 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
+     */
+    public static eximManagePlatformMigrationsDownloadRetrieve({
+        runId,
+    }: {
+        runId: string,
+    }): CancelablePromise<PlatformMigrationRun> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/exim/manage/platform-migrations/{run_id}/download/',
+            path: {
+                'run_id': runId,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static eximManagePlatformMigrationsImportUploadCreate({
+        formData,
+    }: {
+        formData?: PlatformMigrationRun,
+    }): CancelablePromise<PlatformMigrationRun> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/exim/manage/platform-migrations/import-upload/',
+            formData: formData,
+            mediaType: 'multipart/form-data',
+        });
+    }
     /**
      * Admin-only read-only access to EximTask records.
      *