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

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.243.2-core
+  version: 4.245.0-core
   description: API for iblai
 paths:
   /access-check/{item_type}/{item_id}/:
@@ -17802,6 +17802,352 @@ paths:
               schema:
                 $ref: '#/components/schemas/UserPolicyUpdateForbidden'
           description: ''
+  /api/core/platforms/{platform_key}/{username}/demographics/:
+    get:
+      operationId: core_platforms_demographics_retrieve
+      description: Retrieve demographics for a user. Self-access or platform admin
+        required.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserDemographicsResponse'
+          description: ''
+    put:
+      operationId: core_platforms_demographics_update
+      description: Create or update demographics for a user. Self-access or platform
+        admin required.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserDemographicsWrite'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/UserDemographicsWrite'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/UserDemographicsWrite'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/UserDemographicsWrite'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/UserDemographicsWrite'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserDemographicsResponse'
+          description: ''
+    delete:
+      operationId: core_platforms_demographics_destroy
+      description: Delete demographics for a user. Self-access or platform admin required.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: No response body
+  /api/core/platforms/{platform_key}/demographics/fields/:
+    get:
+      operationId: core_platforms_demographics_fields_list
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/DemographicsFieldDefinition'
+          description: ''
+    post:
+      operationId: core_platforms_demographics_fields_create
+      description: Create a custom demographics field definition for the platform.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DemographicsFieldDefinition'
+          description: ''
+  /api/core/platforms/{platform_key}/demographics/fields/{slug}/:
+    get:
+      operationId: core_platforms_demographics_fields_retrieve
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: slug
+        schema:
+          type: string
+          description: URL-safe identifier used as the key in custom_fields payloads.
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DemographicsFieldDefinition'
+          description: ''
+    put:
+      operationId: core_platforms_demographics_fields_update
+      description: Update a custom demographics field definition.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: slug
+        schema:
+          type: string
+          description: URL-safe identifier used as the key in custom_fields payloads.
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/DemographicsFieldDefinitionWrite'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DemographicsFieldDefinition'
+          description: ''
+    patch:
+      operationId: core_platforms_demographics_fields_partial_update
+      description: Partially update a custom demographics field definition.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: slug
+        schema:
+          type: string
+          description: URL-safe identifier used as the key in custom_fields payloads.
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedDemographicsFieldDefinitionWrite'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PatchedDemographicsFieldDefinitionWrite'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PatchedDemographicsFieldDefinitionWrite'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PatchedDemographicsFieldDefinitionWrite'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PatchedDemographicsFieldDefinitionWrite'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DemographicsFieldDefinition'
+          description: ''
+    delete:
+      operationId: core_platforms_demographics_fields_destroy
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: slug
+        schema:
+          type: string
+          description: URL-safe identifier used as the key in custom_fields payloads.
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: No response body
+  /api/core/platforms/{platform_key}/demographics/fields/export/:
+    get:
+      operationId: core_platforms_demographics_fields_export_list
+      description: Export all field definitions for the platform as JSON or CSV.
+      parameters:
+      - in: query
+        name: export_format
+        schema:
+          type: string
+          enum:
+          - csv
+          - json
+          default: json
+        description: 'Export format: json or csv'
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/DemographicsFieldDefinition'
+          description: ''
+  /api/core/platforms/{platform_key}/demographics/fields/import/:
+    post:
+      operationId: core_platforms_demographics_fields_import_create
+      description: Import field definitions from JSON or CSV file. Returns 207 on
+        partial success.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/FieldDefinitionImport'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/FieldDefinitionImport'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/FieldDefinitionImport'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          description: No response body
   /api/core/platforms/{platform_key}/public-image-assets/:
     get:
       operationId: core_platforms_public_image_assets_list
@@ -38866,6 +39212,108 @@ components:
         * `completed` - Completed
         * `failed` - Failed
         * `cancelled` - Cancelled
+    DemographicsFieldDefinition:
+      type: object
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        name:
+          type: string
+          description: Human-readable field label displayed in forms.
+          maxLength: 255
+        slug:
+          type: string
+          description: URL-safe identifier used as the key in custom_fields payloads.
+          maxLength: 255
+          pattern: ^[-a-zA-Z0-9_]+$
+        field_type:
+          allOf:
+          - $ref: '#/components/schemas/FieldTypeEnum'
+          description: |-
+            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
+        required:
+          type: boolean
+          description: Whether this field must be filled in by the user.
+        choices:
+          description: List of valid options for select/multi_select fields. Must
+            be empty for other types.
+        display_order:
+          type: integer
+          description: Sort order for rendering fields in the UI. Lower values appear
+            first.
+        active:
+          type: boolean
+          description: Inactive fields are hidden from forms and excluded from responses.
+        description:
+          type: string
+          description: Optional description or instructions shown alongside the field.
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - created_at
+      - field_type
+      - id
+      - name
+      - slug
+      - updated_at
+    DemographicsFieldDefinitionWrite:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Human-readable field label displayed in forms.
+          maxLength: 255
+        slug:
+          type: string
+          description: URL-safe identifier used as the key in custom_fields payloads.
+          maxLength: 255
+          pattern: ^[-a-zA-Z0-9_]+$
+        field_type:
+          allOf:
+          - $ref: '#/components/schemas/FieldTypeEnum'
+          description: |-
+            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
+        required:
+          type: boolean
+          description: Whether this field must be filled in by the user.
+        choices:
+          description: List of valid options for select/multi_select fields. Must
+            be empty for other types.
+        display_order:
+          type: integer
+          description: Sort order for rendering fields in the UI. Lower values appear
+            first.
+        active:
+          type: boolean
+          description: Inactive fields are hidden from forms and excluded from responses.
+        description:
+          type: string
+          description: Optional description or instructions shown alongside the field.
+      required:
+      - field_type
+      - name
+      - slug
     DesiredRole:
       type: object
       properties:
@@ -38989,6 +39437,16 @@ components:
       required:
       - display_name
       - id
+    DisabilityStatusEnum:
+      enum:
+      - 'yes'
+      - 'no'
+      - prefer_not_to_say
+      type: string
+      description: |-
+        * `yes` - Yes
+        * `no` - No
+        * `prefer_not_to_say` - Prefer not to say
     Education:
       type: object
       properties:
@@ -39215,6 +39673,28 @@ components:
       required:
       - message
       - status
+    EthnicityEnum:
+      enum:
+      - american_indian_alaska_native
+      - asian
+      - black_african_american
+      - hispanic_latino
+      - native_hawaiian_pacific_islander
+      - white
+      - two_or_more
+      - prefer_not_to_say
+      - other
+      type: string
+      description: |-
+        * `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
     Experience:
       type: object
       properties:
@@ -39352,6 +39832,33 @@ components:
       - provider_name
       - provider_name_display
       - updated
+    FieldDefinitionImport:
+      type: object
+      properties:
+        definitions:
+          type: array
+          items:
+            type: object
+            additionalProperties: {}
+        file:
+          type: string
+          format: uri
+    FieldTypeEnum:
+      enum:
+      - text
+      - number
+      - date
+      - boolean
+      - select
+      - multi_select
+      type: string
+      description: |-
+        * `text` - Text
+        * `number` - Number
+        * `date` - Date
+        * `boolean` - Boolean
+        * `select` - Select
+        * `multi_select` - Multi-select
     FlowTypeEnum:
       enum:
       - payment_method_update
@@ -39405,6 +39912,20 @@ components:
       - name
       - username
       - x_gcp_marketplace_token
+    GenderEnum:
+      enum:
+      - male
+      - female
+      - non_binary
+      - prefer_not_to_say
+      - other
+      type: string
+      description: |-
+        * `male` - Male
+        * `female` - Female
+        * `non_binary` - Non-binary
+        * `prefer_not_to_say` - Prefer not to say
+        * `other` - Other
     GlobalCatalogSearchResponse:
       type: object
       description: Response serializer for GlobalCatalogSearchView
@@ -42749,6 +43270,46 @@ components:
           readOnly: true
           description: The platform key to update settings for (read-only in update
             context).
+    PatchedDemographicsFieldDefinitionWrite:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Human-readable field label displayed in forms.
+          maxLength: 255
+        slug:
+          type: string
+          description: URL-safe identifier used as the key in custom_fields payloads.
+          maxLength: 255
+          pattern: ^[-a-zA-Z0-9_]+$
+        field_type:
+          allOf:
+          - $ref: '#/components/schemas/FieldTypeEnum'
+          description: |-
+            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
+        required:
+          type: boolean
+          description: Whether this field must be filled in by the user.
+        choices:
+          description: List of valid options for select/multi_select fields. Must
+            be empty for other types.
+        display_order:
+          type: integer
+          description: Sort order for rendering fields in the UI. Lower values appear
+            first.
+        active:
+          type: boolean
+          description: Inactive fields are hidden from forms and excluded from responses.
+        description:
+          type: string
+          description: Optional description or instructions shown alongside the field.
     PatchedMediaResource:
       type: object
       properties:
@@ -49241,6 +49802,152 @@ components:
           type: string
       required:
       - message
+    UserDemographicsResponse:
+      type: object
+      properties:
+        username:
+          type: string
+          readOnly: true
+        gender:
+          description: |-
+            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
+          oneOf:
+          - $ref: '#/components/schemas/GenderEnum'
+          - $ref: '#/components/schemas/BlankEnum'
+        ethnicity:
+          description: |-
+            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
+          oneOf:
+          - $ref: '#/components/schemas/EthnicityEnum'
+          - $ref: '#/components/schemas/BlankEnum'
+        date_of_birth:
+          type: string
+          format: date
+          nullable: true
+          description: Date of birth in YYYY-MM-DD format.
+        primary_language:
+          type: string
+          description: Primary language as ISO 639-1 code, e.g. 'en', 'es'.
+          maxLength: 10
+        country_of_birth:
+          type: string
+          description: Country of birth as ISO 3166-1 alpha-3 code, e.g. 'USA', 'MEX'.
+          maxLength: 3
+        nationality:
+          type: string
+          description: Nationality as ISO 3166-1 alpha-3 code, e.g. 'USA', 'MEX'.
+          maxLength: 3
+        disability_status:
+          description: |-
+            Disability status. One of: yes, no, prefer_not_to_say.
+
+            * `yes` - Yes
+            * `no` - No
+            * `prefer_not_to_say` - Prefer not to say
+          oneOf:
+          - $ref: '#/components/schemas/DisabilityStatusEnum'
+          - $ref: '#/components/schemas/BlankEnum'
+        custom_fields:
+          type: string
+          readOnly: true
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - created_at
+      - custom_fields
+      - updated_at
+      - username
+    UserDemographicsWrite:
+      type: object
+      properties:
+        gender:
+          default: ''
+          description: |-
+            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
+          oneOf:
+          - $ref: '#/components/schemas/GenderEnum'
+          - $ref: '#/components/schemas/BlankEnum'
+        ethnicity:
+          default: ''
+          description: |-
+            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
+          oneOf:
+          - $ref: '#/components/schemas/EthnicityEnum'
+          - $ref: '#/components/schemas/BlankEnum'
+        date_of_birth:
+          type: string
+          format: date
+          nullable: true
+          description: Date of birth in YYYY-MM-DD format.
+        primary_language:
+          type: string
+          default: ''
+          description: Primary language as ISO 639-1 code, e.g. 'en', 'es'.
+          maxLength: 10
+        country_of_birth:
+          type: string
+          default: ''
+          description: Country of birth as ISO 3166-1 alpha-3 code, e.g. 'USA', 'MEX'.
+          maxLength: 3
+        nationality:
+          type: string
+          default: ''
+          description: Nationality as ISO 3166-1 alpha-3 code, e.g. 'USA', 'MEX'.
+          maxLength: 3
+        disability_status:
+          default: ''
+          description: |-
+            Disability status. One of: yes, no, prefer_not_to_say.
+
+            * `yes` - Yes
+            * `no` - No
+            * `prefer_not_to_say` - Prefer not to say
+          oneOf:
+          - $ref: '#/components/schemas/DisabilityStatusEnum'
+          - $ref: '#/components/schemas/BlankEnum'
+        custom_fields:
+          type: object
+          additionalProperties: {}
+          description: 'Custom field values as {slug: value} pairs. Slugs must match
+            active field definitions.'
     UserGroup:
       type: object
       description: Serializer for UserGroups.