@iblai/iblai-api 4.328.1-core → 4.329.0-core

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.328.1-core
+  version: 4.329.0-core
   description: API for iblai
 paths:
   /api/analytics/content/:
@@ -13494,6 +13494,434 @@ paths:
           description: ''
         '400':
           description: No response body
+  /api/catalog/placements/assessments/:
+    get:
+      operationId: catalog_placements_assessments_retrieve
+      description: 'A platform''s placement assessments (#2280): list and create.'
+      tags:
+      - catalog
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          description: Assessments for the platform
+    post:
+      operationId: catalog_placements_assessments_create
+      description: 'A platform''s placement assessments (#2280): list and create.'
+      tags:
+      - catalog
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlacementAssessment'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlacementAssessment'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlacementAssessment'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlacementAssessment'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlacementAssessment'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          description: Assessment created
+  /api/catalog/placements/assessments/{assessment_id}/:
+    get:
+      operationId: catalog_placements_assessments_retrieve_2
+      description: 'A single placement assessment: view, edit, or delete.'
+      parameters:
+      - in: path
+        name: assessment_id
+        schema:
+          type: string
+          pattern: ^\d+$
+        required: true
+      tags:
+      - catalog
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          description: Assessment
+    patch:
+      operationId: catalog_placements_assessments_partial_update
+      description: 'A single placement assessment: view, edit, or delete.'
+      parameters:
+      - in: path
+        name: assessment_id
+        schema:
+          type: string
+          pattern: ^\d+$
+        required: true
+      tags:
+      - catalog
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedPlacementAssessmentUpdate'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PatchedPlacementAssessmentUpdate'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PatchedPlacementAssessmentUpdate'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PatchedPlacementAssessmentUpdate'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PatchedPlacementAssessmentUpdate'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          description: Assessment updated
+    delete:
+      operationId: catalog_placements_assessments_destroy
+      description: 'A single placement assessment: view, edit, or delete.'
+      parameters:
+      - in: path
+        name: assessment_id
+        schema:
+          type: string
+          pattern: ^\d+$
+        required: true
+      tags:
+      - catalog
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: Assessment deleted
+  /api/catalog/placements/course-assignments/:
+    get:
+      operationId: catalog_placements_course_assignments_retrieve
+      description: |-
+        Course assignments on a platform (#2280): list (optionally by user), and
+        grant a course to a user. Each grant issues a ``CourseInvitation`` the
+        existing pipeline enrolls.
+      parameters:
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        required: true
+      - in: query
+        name: user_id
+        schema:
+          type: integer
+      tags:
+      - catalog
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          description: Course assignments
+    post:
+      operationId: catalog_placements_course_assignments_create
+      description: |-
+        Course assignments on a platform (#2280): list (optionally by user), and
+        grant a course to a user. Each grant issues a ``CourseInvitation`` the
+        existing pipeline enrolls.
+      parameters:
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        required: true
+      - in: query
+        name: user_id
+        schema:
+          type: integer
+      tags:
+      - catalog
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlacementCourseAssignmentCreate'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlacementCourseAssignmentCreate'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlacementCourseAssignmentCreate'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlacementCourseAssignmentCreate'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlacementCourseAssignmentCreate'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          description: Course assigned
+  /api/catalog/placements/course-assignments/{assignment_id}/:
+    delete:
+      operationId: catalog_placements_course_assignments_destroy
+      description: |-
+        Remove one course assignment: deactivate the record and cancel its
+        invitation when the student has not yet enrolled through it.
+      parameters:
+      - in: path
+        name: assignment_id
+        schema:
+          type: string
+          pattern: ^\d+$
+        required: true
+      tags:
+      - catalog
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: Assignment removed
+  /api/catalog/placements/program-assignments/:
+    get:
+      operationId: catalog_placements_program_assignments_retrieve
+      description: |-
+        Program assignments on a platform (#2280): list (optionally by user), and
+        grant a program to a user. Each grant issues a ``ProgramInvitation``.
+      parameters:
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        required: true
+      - in: query
+        name: user_id
+        schema:
+          type: integer
+      tags:
+      - catalog
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          description: Program assignments
+    post:
+      operationId: catalog_placements_program_assignments_create
+      description: |-
+        Program assignments on a platform (#2280): list (optionally by user), and
+        grant a program to a user. Each grant issues a ``ProgramInvitation``.
+      parameters:
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        required: true
+      - in: query
+        name: user_id
+        schema:
+          type: integer
+      tags:
+      - catalog
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlacementProgramAssignmentCreate'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlacementProgramAssignmentCreate'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlacementProgramAssignmentCreate'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlacementProgramAssignmentCreate'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlacementProgramAssignmentCreate'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          description: Program assigned
+  /api/catalog/placements/program-assignments/{assignment_id}/:
+    delete:
+      operationId: catalog_placements_program_assignments_destroy
+      description: |-
+        Remove one program assignment: deactivate the record and cancel its
+        invitation when the student has not yet enrolled through it.
+      parameters:
+      - in: path
+        name: assignment_id
+        schema:
+          type: string
+          pattern: ^\d+$
+        required: true
+      tags:
+      - catalog
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: Assignment removed
+  /api/catalog/placements/records/:
+    get:
+      operationId: catalog_placements_records_retrieve
+      description: |-
+        Placement records on a platform (#2280): list (filter by user, assessment,
+        or status), and assign a configured assessment to a user.
+      parameters:
+      - in: query
+        name: assessment_id
+        schema:
+          type: integer
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        required: true
+      - in: query
+        name: status
+        schema:
+          enum:
+          - not_assigned
+          - assigned
+          - started
+          - completed
+          - reviewed
+          - confirmed
+          type: string
+          minLength: 1
+        description: |-
+          * `not_assigned` - not_assigned
+          * `assigned` - assigned
+          * `started` - started
+          * `completed` - completed
+          * `reviewed` - reviewed
+          * `confirmed` - confirmed
+      - in: query
+        name: user_id
+        schema:
+          type: integer
+      tags:
+      - catalog
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          description: Placement records
+    post:
+      operationId: catalog_placements_records_create
+      description: |-
+        Placement records on a platform (#2280): list (filter by user, assessment,
+        or status), and assign a configured assessment to a user.
+      parameters:
+      - in: query
+        name: assessment_id
+        schema:
+          type: integer
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        required: true
+      - in: query
+        name: status
+        schema:
+          enum:
+          - not_assigned
+          - assigned
+          - started
+          - completed
+          - reviewed
+          - confirmed
+          type: string
+          minLength: 1
+        description: |-
+          * `not_assigned` - not_assigned
+          * `assigned` - assigned
+          * `started` - started
+          * `completed` - completed
+          * `reviewed` - reviewed
+          * `confirmed` - confirmed
+      - in: query
+        name: user_id
+        schema:
+          type: integer
+      tags:
+      - catalog
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PlacementRecordCreate'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PlacementRecordCreate'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PlacementRecordCreate'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PlacementRecordCreate'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PlacementRecordCreate'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          description: Placement assigned
+  /api/catalog/placements/records/{record_id}/:
+    patch:
+      operationId: catalog_placements_records_partial_update
+      description: |-
+        Advance a single placement record: status, the agent's result, an admin
+        override, or a note.
+      parameters:
+      - in: path
+        name: record_id
+        schema:
+          type: string
+          pattern: ^\d+$
+        required: true
+      tags:
+      - catalog
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApplicationPlacementUpdate'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApplicationPlacementUpdate'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApplicationPlacementUpdate'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApplicationPlacementUpdate'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PatchedPlatformApplicationPlacementUpdate'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          description: Record updated
   /api/catalog/programs/:
     get:
       operationId: catalog_programs_list
@@ -52192,6 +52620,27 @@ components:
           type: string
           format: date-time
           readOnly: true
+    PatchedPlacementAssessmentUpdate:
+      type: object
+      description: 'Update body: every field optional; at least one must be present.'
+      properties:
+        name:
+          type: string
+          maxLength: 255
+        source:
+          $ref: '#/components/schemas/SourceEnum'
+        agent_unique_id:
+          type: string
+          maxLength: 255
+        agent_label:
+          type: string
+          maxLength: 255
+        subject:
+          type: string
+          maxLength: 255
+        config: {}
+        enabled:
+          type: boolean
     PatchedPlatformApiKey:
       type: object
       description: Serializer for PlatformApiKey's
@@ -52296,6 +52745,7 @@ components:
         override: {}
         session_id:
           type: string
+          maxLength: 64
         note:
           type: string
     PatchedPlatformApplicationUpdate:
@@ -53934,6 +54384,83 @@ components:
       - name
       - pipeline
       - updated_at
+    PlacementAssessment:
+      type: object
+      description: Create body for a placement assessment (platform configuration).
+      properties:
+        name:
+          type: string
+          maxLength: 255
+        source:
+          $ref: '#/components/schemas/SourceEnum'
+        agent_unique_id:
+          type: string
+          maxLength: 255
+        agent_label:
+          type: string
+          maxLength: 255
+        subject:
+          type: string
+          maxLength: 255
+        config: {}
+        enabled:
+          type: boolean
+      required:
+      - name
+    PlacementCourseAssignmentCreate:
+      type: object
+      description: Grant one course to a platform user, optionally linked to a placement.
+      properties:
+        user_id:
+          type: integer
+        course_id:
+          type: string
+        started:
+          type: string
+          format: date-time
+        expired:
+          type: string
+          format: date-time
+        placement_id:
+          type: integer
+      required:
+      - course_id
+      - user_id
+    PlacementProgramAssignmentCreate:
+      type: object
+      description: Grant one program to a platform user, optionally linked to a placement.
+      properties:
+        user_id:
+          type: integer
+        program_key:
+          type: string
+        started:
+          type: string
+          format: date-time
+        expired:
+          type: string
+          format: date-time
+        placement_id:
+          type: integer
+      required:
+      - program_key
+      - user_id
+    PlacementRecordCreate:
+      type: object
+      description: Assign a configured assessment to a platform user (no application).
+      properties:
+        user_id:
+          type: integer
+        assessment_id:
+          type: integer
+        session_id:
+          type: string
+          maxLength: 64
+        note:
+          type: string
+      required:
+      - assessment_id
+      - user_id
     Platform:
       type: object
       description: 'Note: Create and update operations deprecated.'
@@ -54912,23 +55439,22 @@ components:
       - placements
     PlatformApplicationPlacementItem:
       type: object
-      description: 'One placement assignment: which candidate, which mentor.'
+      description: |-
+        One placement assignment: which candidate, which configured assessment.
+        The agent and subject come from the assessment, snapshotted onto the record.
       properties:
         candidate_id:
           type: integer
-        mentor_unique_id:
-          type: string
-        mentor_label:
-          type: string
-        label:
-          type: string
+        assessment_id:
+          type: integer
         session_id:
           type: string
+          maxLength: 64
         note:
           type: string
       required:
+      - assessment_id
       - candidate_id
-      - mentor_unique_id
     PlatformApplicationPlacementUpdateStatusEnum:
       enum:
       - not_assigned
@@ -58813,6 +59339,16 @@ components:
       - desired
       - reported
       - total
+    SourceEnum:
+      enum:
+      - agent
+      - manual
+      - external
+      type: string
+      description: |-
+        * `agent` - agent
+        * `manual` - manual
+        * `external` - external
     Spa:
       type: object
       description: Serializer for SPA (Single Page Application)

package/src/core/OpenAPI.ts

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

package/src/index.ts

@@ -315,6 +315,7 @@ export type { PatchedOrganization } from './models/PatchedOrganization';
 export type { PatchedPerson } from './models/PatchedPerson';
 export type { PatchedPipeline } from './models/PatchedPipeline';
 export type { PatchedPipelineStage } from './models/PatchedPipelineStage';
+export type { PatchedPlacementAssessmentUpdate } from './models/PatchedPlacementAssessmentUpdate';
 export type { PatchedPlatformApiKey } from './models/PatchedPlatformApiKey';
 export type { PatchedPlatformApplicationFormUpdate } from './models/PatchedPlatformApplicationFormUpdate';
 export type { PatchedPlatformApplicationNote } from './models/PatchedPlatformApplicationNote';
@@ -382,6 +383,10 @@ export type { PersonMergeRequest } from './models/PersonMergeRequest';
 export type { PersonMergeResponse } from './models/PersonMergeResponse';
 export type { Pipeline } from './models/Pipeline';
 export type { PipelineStage } from './models/PipelineStage';
+export type { PlacementAssessment } from './models/PlacementAssessment';
+export type { PlacementCourseAssignmentCreate } from './models/PlacementCourseAssignmentCreate';
+export type { PlacementProgramAssignmentCreate } from './models/PlacementProgramAssignmentCreate';
+export type { PlacementRecordCreate } from './models/PlacementRecordCreate';
 export type { Platform } from './models/Platform';
 export type { PlatformApiKey } from './models/PlatformApiKey';
 export { PlatformApiKeyModeEnum } from './models/PlatformApiKeyModeEnum';
@@ -529,6 +534,7 @@ export type { SkillInfo } from './models/SkillInfo';
 export type { SkillsDetail } from './models/SkillsDetail';
 export type { SkillsMetric } from './models/SkillsMetric';
 export type { SkillThreshold } from './models/SkillThreshold';
+export { SourceEnum } from './models/SourceEnum';
 export type { Spa } from './models/Spa';
 export { StateEnum } from './models/StateEnum';
 export { Status0e3Enum } from './models/Status0e3Enum';

package/src/models/PatchedPlacementAssessmentUpdate.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { SourceEnum } from './SourceEnum';
+/**
+ * Update body: every field optional; at least one must be present.
+ */
+export type PatchedPlacementAssessmentUpdate = {
+    name?: string;
+    source?: SourceEnum;
+    agent_unique_id?: string;
+    agent_label?: string;
+    subject?: string;
+    config?: any;
+    enabled?: boolean;
+};
+

package/src/models/PlacementAssessment.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { SourceEnum } from './SourceEnum';
+/**
+ * Create body for a placement assessment (platform configuration).
+ */
+export type PlacementAssessment = {
+    name: string;
+    source?: SourceEnum;
+    agent_unique_id?: string;
+    agent_label?: string;
+    subject?: string;
+    config?: any;
+    enabled?: boolean;
+};
+

package/src/models/PlacementCourseAssignmentCreate.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Grant one course to a platform user, optionally linked to a placement.
+ */
+export type PlacementCourseAssignmentCreate = {
+    user_id: number;
+    course_id: string;
+    started?: string;
+    expired?: string;
+    placement_id?: number;
+};
+