@iblai/iblai-api 4.243.2-core → 4.245.0-core

package/src/services/CoreService.ts

@@ -3,8 +3,11 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { CeleryHeartbeat } from '../models/CeleryHeartbeat';
+import type { DemographicsFieldDefinition } from '../models/DemographicsFieldDefinition';
+import type { DemographicsFieldDefinitionWrite } from '../models/DemographicsFieldDefinitionWrite';
 import type { DesiredRole } from '../models/DesiredRole';
 import type { EdxSignalReceiverRequest } from '../models/EdxSignalReceiverRequest';
+import type { FieldDefinitionImport } from '../models/FieldDefinitionImport';
 import type { GroupList } from '../models/GroupList';
 import type { ImageUpload } from '../models/ImageUpload';
 import type { LauncherViewPostRequest } from '../models/LauncherViewPostRequest';
@@ -16,6 +19,7 @@ import type { PaginatedRbacGroupList } from '../models/PaginatedRbacGroupList';
 import type { PaginatedRbacPolicyList } from '../models/PaginatedRbacPolicyList';
 import type { PaginatedRbacRoleList } from '../models/PaginatedRbacRoleList';
 import type { PaginatedUserGroupList } from '../models/PaginatedUserGroupList';
+import type { PatchedDemographicsFieldDefinitionWrite } from '../models/PatchedDemographicsFieldDefinitionWrite';
 import type { PatchedPlatformPublicImageAsset } from '../models/PatchedPlatformPublicImageAsset';
 import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
 import type { PatchedRbacGroup } from '../models/PatchedRbacGroup';
@@ -48,6 +52,8 @@ import type { TokenProxyInput } from '../models/TokenProxyInput';
 import type { TokenProxyOutput } from '../models/TokenProxyOutput';
 import type { UserDeleteAPIRequest } from '../models/UserDeleteAPIRequest';
 import type { UserDeleteAPIResponse } from '../models/UserDeleteAPIResponse';
+import type { UserDemographicsResponse } from '../models/UserDemographicsResponse';
+import type { UserDemographicsWrite } from '../models/UserDemographicsWrite';
 import type { UserGroup } from '../models/UserGroup';
 import type { UserGroupAccess } from '../models/UserGroupAccess';
 import type { UserGroupPolicy } from '../models/UserGroupPolicy';
@@ -1266,6 +1272,250 @@ export class CoreService {
             mediaType: 'application/json',
         });
     }
+    /**
+     * Retrieve demographics for a user. Self-access or platform admin required.
+     * @returns UserDemographicsResponse
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsRetrieve({
+        platformKey,
+        username,
+    }: {
+        platformKey: string,
+        username: string,
+    }): CancelablePromise<UserDemographicsResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/platforms/{platform_key}/{username}/demographics/',
+            path: {
+                'platform_key': platformKey,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * Create or update demographics for a user. Self-access or platform admin required.
+     * @returns UserDemographicsResponse
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsUpdate({
+        platformKey,
+        username,
+        requestBody,
+    }: {
+        platformKey: string,
+        username: string,
+        requestBody?: UserDemographicsWrite,
+    }): CancelablePromise<UserDemographicsResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/core/platforms/{platform_key}/{username}/demographics/',
+            path: {
+                'platform_key': platformKey,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete demographics for a user. Self-access or platform admin required.
+     * @returns void
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsDestroy({
+        platformKey,
+        username,
+    }: {
+        platformKey: string,
+        username: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/core/platforms/{platform_key}/{username}/demographics/',
+            path: {
+                'platform_key': platformKey,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsFieldsList({
+        platformKey,
+    }: {
+        platformKey: string,
+    }): CancelablePromise<Array<DemographicsFieldDefinition>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/platforms/{platform_key}/demographics/fields/',
+            path: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Create a custom demographics field definition for the platform.
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsFieldsCreate({
+        platformKey,
+        requestBody,
+    }: {
+        platformKey: string,
+        requestBody: DemographicsFieldDefinitionWrite,
+    }): CancelablePromise<DemographicsFieldDefinition> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/platforms/{platform_key}/demographics/fields/',
+            path: {
+                'platform_key': platformKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsFieldsRetrieve({
+        platformKey,
+        slug,
+    }: {
+        platformKey: string,
+        slug: string,
+    }): CancelablePromise<DemographicsFieldDefinition> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/platforms/{platform_key}/demographics/fields/{slug}/',
+            path: {
+                'platform_key': platformKey,
+                'slug': slug,
+            },
+        });
+    }
+    /**
+     * Update a custom demographics field definition.
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsFieldsUpdate({
+        platformKey,
+        slug,
+        requestBody,
+    }: {
+        platformKey: string,
+        slug: string,
+        requestBody: DemographicsFieldDefinitionWrite,
+    }): CancelablePromise<DemographicsFieldDefinition> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/core/platforms/{platform_key}/demographics/fields/{slug}/',
+            path: {
+                'platform_key': platformKey,
+                'slug': slug,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Partially update a custom demographics field definition.
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsFieldsPartialUpdate({
+        platformKey,
+        slug,
+        requestBody,
+    }: {
+        platformKey: string,
+        slug: string,
+        requestBody?: PatchedDemographicsFieldDefinitionWrite,
+    }): CancelablePromise<DemographicsFieldDefinition> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/core/platforms/{platform_key}/demographics/fields/{slug}/',
+            path: {
+                'platform_key': platformKey,
+                'slug': slug,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * @returns void
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsFieldsDestroy({
+        platformKey,
+        slug,
+    }: {
+        platformKey: string,
+        slug: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/core/platforms/{platform_key}/demographics/fields/{slug}/',
+            path: {
+                'platform_key': platformKey,
+                'slug': slug,
+            },
+        });
+    }
+    /**
+     * Export all field definitions for the platform as JSON or CSV.
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsFieldsExportList({
+        platformKey,
+        exportFormat = 'json',
+    }: {
+        platformKey: string,
+        /**
+         * Export format: json or csv
+         */
+        exportFormat?: 'csv' | 'json',
+    }): CancelablePromise<Array<DemographicsFieldDefinition>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/platforms/{platform_key}/demographics/fields/export/',
+            path: {
+                'platform_key': platformKey,
+            },
+            query: {
+                'export_format': exportFormat,
+            },
+        });
+    }
+    /**
+     * Import field definitions from JSON or CSV file. Returns 207 on partial success.
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static corePlatformsDemographicsFieldsImportCreate({
+        platformKey,
+        requestBody,
+    }: {
+        platformKey: string,
+        requestBody?: FieldDefinitionImport,
+    }): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/platforms/{platform_key}/demographics/fields/import/',
+            path: {
+                'platform_key': platformKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
     /**
      * Shared functionality for platform public image asset views.
      * @returns PlatformPublicImageAsset