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

package/src/core/OpenAPI.ts

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

package/src/index.ts

@@ -130,6 +130,8 @@ export type { CreditAccountAutoRechargeUpdate } from './models/CreditAccountAuto
 export type { CreditAccountInfo } from './models/CreditAccountInfo';
 export type { CreditTransactionHistory } from './models/CreditTransactionHistory';
 export { CreditTransactionHistoryStatusEnum } from './models/CreditTransactionHistoryStatusEnum';
+export type { DemographicsFieldDefinition } from './models/DemographicsFieldDefinition';
+export type { DemographicsFieldDefinitionWrite } from './models/DemographicsFieldDefinitionWrite';
 export type { DesiredRole } from './models/DesiredRole';
 export type { DesiredRoleCreateUpdateRequest } from './models/DesiredRoleCreateUpdateRequest';
 export type { DesiredSkill } from './models/DesiredSkill';
@@ -137,6 +139,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 { DisabilityStatusEnum } from './models/DisabilityStatusEnum';
 export type { Education } from './models/Education';
 export type { EdxSignalReceiverRequest } from './models/EdxSignalReceiverRequest';
 export type { EngagementPerCourse } from './models/EngagementPerCourse';
@@ -148,10 +151,14 @@ export type { EnrollmentsPerUser } from './models/EnrollmentsPerUser';
 export type { EnrollmentsPerUserData } from './models/EnrollmentsPerUserData';
 export type { ErrorDetail } from './models/ErrorDetail';
 export type { ErrorResponse } from './models/ErrorResponse';
+export { EthnicityEnum } from './models/EthnicityEnum';
 export type { Experience } from './models/Experience';
 export type { ExternalCredentialMapping } from './models/ExternalCredentialMapping';
+export type { FieldDefinitionImport } from './models/FieldDefinitionImport';
+export { FieldTypeEnum } from './models/FieldTypeEnum';
 export { FlowTypeEnum } from './models/FlowTypeEnum';
 export type { GCPTenantLaunchRequest } from './models/GCPTenantLaunchRequest';
+export { GenderEnum } from './models/GenderEnum';
 export type { GlobalCatalogSearchResponse } from './models/GlobalCatalogSearchResponse';
 export type { GooglePayAccountResponse } from './models/GooglePayAccountResponse';
 export { GooglePayAccountResponseStatusEnum } from './models/GooglePayAccountResponseStatusEnum';
@@ -257,6 +264,7 @@ export type { PaginatedUserLicenseAssignment } from './models/PaginatedUserLicen
 export type { PaginatedUserLicenseGroupAssignment } from './models/PaginatedUserLicenseGroupAssignment';
 export type { Pagination } from './models/Pagination';
 export type { PatchedCreditAccountAutoRechargeUpdate } from './models/PatchedCreditAccountAutoRechargeUpdate';
+export type { PatchedDemographicsFieldDefinitionWrite } from './models/PatchedDemographicsFieldDefinitionWrite';
 export type { PatchedMediaResource } from './models/PatchedMediaResource';
 export type { PatchedNotification } from './models/PatchedNotification';
 export type { PatchedNotificationTemplateDetail } from './models/PatchedNotificationTemplateDetail';
@@ -478,6 +486,8 @@ export type { UserApp } from './models/UserApp';
 export type { UserDeleteAPIError } from './models/UserDeleteAPIError';
 export type { UserDeleteAPIRequest } from './models/UserDeleteAPIRequest';
 export type { UserDeleteAPIResponse } from './models/UserDeleteAPIResponse';
+export type { UserDemographicsResponse } from './models/UserDemographicsResponse';
+export type { UserDemographicsWrite } from './models/UserDemographicsWrite';
 export type { UserGroup } from './models/UserGroup';
 export type { UserGroupAccess } from './models/UserGroupAccess';
 export type { UserGroupAccessInfo } from './models/UserGroupAccessInfo';

package/src/models/DemographicsFieldDefinition.ts

@@ -0,0 +1,50 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { FieldTypeEnum } from './FieldTypeEnum';
+export type DemographicsFieldDefinition = {
+    readonly id: number;
+    /**
+     * 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;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+

package/src/models/DemographicsFieldDefinitionWrite.ts

@@ -0,0 +1,47 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { FieldTypeEnum } from './FieldTypeEnum';
+export type DemographicsFieldDefinitionWrite = {
+    /**
+     * 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/src/models/DisabilityStatusEnum.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `yes` - Yes
+ * * `no` - No
+ * * `prefer_not_to_say` - Prefer not to say
+ */
+export enum DisabilityStatusEnum {
+    YES = 'yes',
+    NO = 'no',
+    PREFER_NOT_TO_SAY = 'prefer_not_to_say',
+}

package/src/models/EthnicityEnum.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `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
+ */
+export enum EthnicityEnum {
+    AMERICAN_INDIAN_ALASKA_NATIVE = 'american_indian_alaska_native',
+    ASIAN = 'asian',
+    BLACK_AFRICAN_AMERICAN = 'black_african_american',
+    HISPANIC_LATINO = 'hispanic_latino',
+    NATIVE_HAWAIIAN_PACIFIC_ISLANDER = 'native_hawaiian_pacific_islander',
+    WHITE = 'white',
+    TWO_OR_MORE = 'two_or_more',
+    PREFER_NOT_TO_SAY = 'prefer_not_to_say',
+    OTHER = 'other',
+}

package/src/models/FieldDefinitionImport.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type FieldDefinitionImport = {
+    definitions?: Array<Record<string, any>>;
+    file?: string;
+};
+

package/src/models/FieldTypeEnum.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `text` - Text
+ * * `number` - Number
+ * * `date` - Date
+ * * `boolean` - Boolean
+ * * `select` - Select
+ * * `multi_select` - Multi-select
+ */
+export enum FieldTypeEnum {
+    TEXT = 'text',
+    NUMBER = 'number',
+    DATE = 'date',
+    BOOLEAN = 'boolean',
+    SELECT = 'select',
+    MULTI_SELECT = 'multi_select',
+}

package/src/models/GenderEnum.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `male` - Male
+ * * `female` - Female
+ * * `non_binary` - Non-binary
+ * * `prefer_not_to_say` - Prefer not to say
+ * * `other` - Other
+ */
+export enum GenderEnum {
+    MALE = 'male',
+    FEMALE = 'female',
+    NON_BINARY = 'non_binary',
+    PREFER_NOT_TO_SAY = 'prefer_not_to_say',
+    OTHER = 'other',
+}

package/src/models/PatchedDemographicsFieldDefinitionWrite.ts

@@ -0,0 +1,47 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/UserDemographicsResponse.ts

@@ -0,0 +1,63 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/UserDemographicsWrite.ts

@@ -0,0 +1,63 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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>;
+};
+