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

package/dist/types/models/PatchedDemographicsFieldDefinitionWrite.d.ts

@@ -0,0 +1,42 @@
+import type { FieldTypeEnum } from './FieldTypeEnum';
+export type PatchedDemographicsFieldDefinitionWrite = {
+    /**
+     * Human-readable field label displayed in forms.
+     */
+    name?: string;
+    /**
+     * URL-safe identifier used as the key in custom_fields payloads.
+     */
+    slug?: string;
+    /**
+     * Data type for this field. One of: text, number, date, boolean, select, multi_select.
+     *
+     * * `text` - Text
+     * * `number` - Number
+     * * `date` - Date
+     * * `boolean` - Boolean
+     * * `select` - Select
+     * * `multi_select` - Multi-select
+     */
+    field_type?: FieldTypeEnum;
+    /**
+     * Whether this field must be filled in by the user.
+     */
+    required?: boolean;
+    /**
+     * List of valid options for select/multi_select fields. Must be empty for other types.
+     */
+    choices?: any;
+    /**
+     * Sort order for rendering fields in the UI. Lower values appear first.
+     */
+    display_order?: number;
+    /**
+     * Inactive fields are hidden from forms and excluded from responses.
+     */
+    active?: boolean;
+    /**
+     * Optional description or instructions shown alongside the field.
+     */
+    description?: string;
+};

package/dist/types/models/UserDemographicsResponse.d.ts

@@ -0,0 +1,58 @@
+import type { BlankEnum } from './BlankEnum';
+import type { DisabilityStatusEnum } from './DisabilityStatusEnum';
+import type { EthnicityEnum } from './EthnicityEnum';
+import type { GenderEnum } from './GenderEnum';
+export type UserDemographicsResponse = {
+    readonly username: string;
+    /**
+     * Gender identity. One of: male, female, non_binary, prefer_not_to_say, other.
+     *
+     * * `male` - Male
+     * * `female` - Female
+     * * `non_binary` - Non-binary
+     * * `prefer_not_to_say` - Prefer not to say
+     * * `other` - Other
+     */
+    gender?: (GenderEnum | BlankEnum);
+    /**
+     * Ethnic background. See Ethnicity enum for valid values.
+     *
+     * * `american_indian_alaska_native` - American Indian or Alaska Native
+     * * `asian` - Asian
+     * * `black_african_american` - Black or African American
+     * * `hispanic_latino` - Hispanic or Latino
+     * * `native_hawaiian_pacific_islander` - Native Hawaiian or Other Pacific Islander
+     * * `white` - White
+     * * `two_or_more` - Two or more races
+     * * `prefer_not_to_say` - Prefer not to say
+     * * `other` - Other
+     */
+    ethnicity?: (EthnicityEnum | BlankEnum);
+    /**
+     * Date of birth in YYYY-MM-DD format.
+     */
+    date_of_birth?: string | null;
+    /**
+     * Primary language as ISO 639-1 code, e.g. 'en', 'es'.
+     */
+    primary_language?: string;
+    /**
+     * Country of birth as ISO 3166-1 alpha-3 code, e.g. 'USA', 'MEX'.
+     */
+    country_of_birth?: string;
+    /**
+     * Nationality as ISO 3166-1 alpha-3 code, e.g. 'USA', 'MEX'.
+     */
+    nationality?: string;
+    /**
+     * Disability status. One of: yes, no, prefer_not_to_say.
+     *
+     * * `yes` - Yes
+     * * `no` - No
+     * * `prefer_not_to_say` - Prefer not to say
+     */
+    disability_status?: (DisabilityStatusEnum | BlankEnum);
+    readonly custom_fields: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

package/dist/types/models/UserDemographicsWrite.d.ts

@@ -0,0 +1,58 @@
+import type { BlankEnum } from './BlankEnum';
+import type { DisabilityStatusEnum } from './DisabilityStatusEnum';
+import type { EthnicityEnum } from './EthnicityEnum';
+import type { GenderEnum } from './GenderEnum';
+export type UserDemographicsWrite = {
+    /**
+     * Gender identity. One of: male, female, non_binary, prefer_not_to_say, other.
+     *
+     * * `male` - Male
+     * * `female` - Female
+     * * `non_binary` - Non-binary
+     * * `prefer_not_to_say` - Prefer not to say
+     * * `other` - Other
+     */
+    gender?: (GenderEnum | BlankEnum);
+    /**
+     * Ethnic background. See Ethnicity enum for valid values.
+     *
+     * * `american_indian_alaska_native` - American Indian or Alaska Native
+     * * `asian` - Asian
+     * * `black_african_american` - Black or African American
+     * * `hispanic_latino` - Hispanic or Latino
+     * * `native_hawaiian_pacific_islander` - Native Hawaiian or Other Pacific Islander
+     * * `white` - White
+     * * `two_or_more` - Two or more races
+     * * `prefer_not_to_say` - Prefer not to say
+     * * `other` - Other
+     */
+    ethnicity?: (EthnicityEnum | BlankEnum);
+    /**
+     * Date of birth in YYYY-MM-DD format.
+     */
+    date_of_birth?: string | null;
+    /**
+     * Primary language as ISO 639-1 code, e.g. 'en', 'es'.
+     */
+    primary_language?: string;
+    /**
+     * Country of birth as ISO 3166-1 alpha-3 code, e.g. 'USA', 'MEX'.
+     */
+    country_of_birth?: string;
+    /**
+     * Nationality as ISO 3166-1 alpha-3 code, e.g. 'USA', 'MEX'.
+     */
+    nationality?: string;
+    /**
+     * Disability status. One of: yes, no, prefer_not_to_say.
+     *
+     * * `yes` - Yes
+     * * `no` - No
+     * * `prefer_not_to_say` - Prefer not to say
+     */
+    disability_status?: (DisabilityStatusEnum | BlankEnum);
+    /**
+     * Custom field values as {slug: value} pairs. Slugs must match active field definitions.
+     */
+    custom_fields?: Record<string, any>;
+};

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

@@ -1,6 +1,9 @@
 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';
@@ -12,6 +15,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';
@@ -44,6 +48,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';
@@ -667,6 +673,107 @@ export declare class CoreService {
     static corePlatformUsersPoliciesUpdate({ requestBody, }: {
         requestBody: Array<UserPolicyUpdate>;
     }): CancelablePromise<UserPolicyUpdateResponse>;
+    /**
+     * Retrieve demographics for a user. Self-access or platform admin required.
+     * @returns UserDemographicsResponse
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsRetrieve({ platformKey, username, }: {
+        platformKey: string;
+        username: string;
+    }): CancelablePromise<UserDemographicsResponse>;
+    /**
+     * Create or update demographics for a user. Self-access or platform admin required.
+     * @returns UserDemographicsResponse
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsUpdate({ platformKey, username, requestBody, }: {
+        platformKey: string;
+        username: string;
+        requestBody?: UserDemographicsWrite;
+    }): CancelablePromise<UserDemographicsResponse>;
+    /**
+     * Delete demographics for a user. Self-access or platform admin required.
+     * @returns void
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsDestroy({ platformKey, username, }: {
+        platformKey: string;
+        username: string;
+    }): CancelablePromise<void>;
+    /**
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsFieldsList({ platformKey, }: {
+        platformKey: string;
+    }): CancelablePromise<Array<DemographicsFieldDefinition>>;
+    /**
+     * Create a custom demographics field definition for the platform.
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsFieldsCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody: DemographicsFieldDefinitionWrite;
+    }): CancelablePromise<DemographicsFieldDefinition>;
+    /**
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsFieldsRetrieve({ platformKey, slug, }: {
+        platformKey: string;
+        slug: string;
+    }): CancelablePromise<DemographicsFieldDefinition>;
+    /**
+     * Update a custom demographics field definition.
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsFieldsUpdate({ platformKey, slug, requestBody, }: {
+        platformKey: string;
+        slug: string;
+        requestBody: DemographicsFieldDefinitionWrite;
+    }): CancelablePromise<DemographicsFieldDefinition>;
+    /**
+     * Partially update a custom demographics field definition.
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsFieldsPartialUpdate({ platformKey, slug, requestBody, }: {
+        platformKey: string;
+        slug: string;
+        requestBody?: PatchedDemographicsFieldDefinitionWrite;
+    }): CancelablePromise<DemographicsFieldDefinition>;
+    /**
+     * @returns void
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsFieldsDestroy({ platformKey, slug, }: {
+        platformKey: string;
+        slug: string;
+    }): CancelablePromise<void>;
+    /**
+     * Export all field definitions for the platform as JSON or CSV.
+     * @returns DemographicsFieldDefinition
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsFieldsExportList({ platformKey, exportFormat, }: {
+        platformKey: string;
+        /**
+         * Export format: json or csv
+         */
+        exportFormat?: 'csv' | 'json';
+    }): CancelablePromise<Array<DemographicsFieldDefinition>>;
+    /**
+     * Import field definitions from JSON or CSV file. Returns 207 on partial success.
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static corePlatformsDemographicsFieldsImportCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody?: FieldDefinitionImport;
+    }): CancelablePromise<any>;
     /**
      * Shared functionality for platform public image asset views.
      * @returns PlatformPublicImageAsset

package/package.json

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