@iblai/iblai-api 4.378.2-core → 4.378.3-core

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.378.2-core
+  version: 4.378.3-core
   description: API for iblai
 paths:
   /api/analytics/content/:
@@ -6897,9 +6897,12 @@ paths:
             500 Internal Server Error: If an unexpected error occurs
 
         Access Control:
-            - Requires IsDMAdmin, IsEdxUserReadOnly, or IsPlatformAdminOfUserReadOnly permission
+            - Requires IsDMAdmin, IsEdxUserReadOnly, IsPlatformAdminOfUserReadOnly,
+              or IsWatcherOfUserReadOnly permission
             - Users can view their own enrollments
             - Platform admins can view enrollments for users in their platform
+            - Watchers can view enrollments for a user they watch, scoped to the
+              queried user and platform
             - DM admins can view all enrollments
       parameters:
       - in: query
@@ -6925,6 +6928,12 @@ paths:
         schema:
           type: boolean
         description: Include enrollments from default platform
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: org
         schema:
@@ -6947,6 +6956,12 @@ paths:
           type: string
           minLength: 1
         description: Filter enrollments by platform key
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: slug
         schema:
@@ -7006,6 +7021,12 @@ paths:
           type: boolean
           default: true
         description: Include metadata in the response
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: org
         schema:
@@ -7036,6 +7057,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key for the pathway
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: slug
         schema:
@@ -7086,6 +7113,12 @@ paths:
           type: boolean
           default: true
         description: Include metadata in the response
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: org
         schema:
@@ -7116,6 +7149,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key for the pathway
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: slug
         schema:
@@ -7183,6 +7222,12 @@ paths:
           type: boolean
           default: true
         description: Include metadata in the response
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: org
         schema:
@@ -7213,6 +7258,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key for the pathway
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: slug
         schema:
@@ -7437,6 +7488,12 @@ paths:
           type: boolean
           default: true
         description: Include metadata in the response
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: org
         schema:
@@ -7449,6 +7506,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key for the program
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: program_id
         schema:
@@ -7535,6 +7598,12 @@ paths:
           type: boolean
           default: true
         description: Include metadata in the response
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: org
         schema:
@@ -7547,6 +7616,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key for the program
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: program_id
         schema:
@@ -7650,6 +7725,12 @@ paths:
           type: boolean
           default: true
         description: Include metadata in the response
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: org
         schema:
@@ -7662,6 +7743,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key for the program
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: program_id
         schema:
@@ -7726,6 +7813,12 @@ paths:
         schema:
           type: boolean
         description: Include enrollments from default platform
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: org
         schema:
@@ -7748,6 +7841,12 @@ paths:
           type: string
           minLength: 1
         description: Filter enrollments by platform key
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: program_id
         schema:
@@ -13314,12 +13413,24 @@ paths:
           type: string
           minLength: 1
         description: Item ID associated with the pathway
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: name
         schema:
           type: string
           minLength: 1
         description: Pathway name
+      - in: query
+        name: org
+        schema:
+          type: string
+          minLength: 1
+        description: Platform organization
       - in: query
         name: pathway_id
         schema:
@@ -13338,6 +13449,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: slug
         schema:
@@ -13383,12 +13500,24 @@ paths:
           type: string
           minLength: 1
         description: Item ID associated with the pathway
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: name
         schema:
           type: string
           minLength: 1
         description: Pathway name
+      - in: query
+        name: org
+        schema:
+          type: string
+          minLength: 1
+        description: Platform organization
       - in: query
         name: pathway_id
         schema:
@@ -13407,6 +13536,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: slug
         schema:
@@ -13476,12 +13611,24 @@ paths:
           type: string
           minLength: 1
         description: Item ID associated with the pathway
+      - in: query
+        name: key
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of platform_key
       - in: query
         name: name
         schema:
           type: string
           minLength: 1
         description: Pathway name
+      - in: query
+        name: org
+        schema:
+          type: string
+          minLength: 1
+        description: Platform organization
       - in: query
         name: pathway_id
         schema:
@@ -13501,6 +13648,12 @@ paths:
           type: string
           minLength: 1
         description: Platform key
+      - in: query
+        name: platform_org
+        schema:
+          type: string
+          minLength: 1
+        description: Alias of org
       - in: query
         name: slug
         schema:
@@ -24058,6 +24211,52 @@ paths:
               schema:
                 $ref: '#/components/schemas/UserPlatformSelfLinkForbidden'
           description: ''
+  /api/core/users/profile/summary/:
+    get:
+      operationId: core_users_profile_summary_retrieve
+      description: |-
+        Read a user's profile fields, for a viewer authorized to see them.
+
+        This is not a public endpoint: access is controlled by the permission set
+        (the user themselves, a platform admin over them, a DM admin, or a watcher
+        of the user). It returns only the allowlist (see
+        UserProfileSummarySerializer): profile-card fields plus email, and no other
+        account PII. It does not reach edX. Profile
+        metadata is a single global record per user, so no platform scopes the
+        returned fields; the platform is used only to resolve the watcher
+        relationship. Read only.
+      parameters:
+      - in: query
+        name: email
+        schema:
+          type: string
+          format: email
+          minLength: 1
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+      - in: query
+        name: user_id
+        schema:
+          type: integer
+      - in: query
+        name: username
+        schema:
+          type: string
+          minLength: 1
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserProfileSummary'
+          description: ''
   /api/core/users/proxy/:
     get:
       operationId: core_users_proxy_retrieve
@@ -53743,6 +53942,12 @@ components:
         platform_key:
           type: string
           description: Platform key for the pathway
+        key:
+          type: string
+          description: Alias of platform_key
+        platform_org:
+          type: string
+          description: Alias of org
         include_default_platform:
           type: boolean
           description: Include enrollments from default platform
@@ -63088,6 +63293,57 @@ components:
           description: List of policies for the user
       required:
       - user_id
+    UserProfileSummary:
+      type: object
+      description: |-
+        Profile-card fields returned to a viewer authorized to see a user.
+
+        Explicit allowlist. It carries the fields the profile preview needs plus
+        `email`, which the current metadata endpoint already returns for authorized
+        callers (parity for that field). It does not carry the other account fields
+        the full metadata endpoint holds (phone, mailing address, demographics) or
+        private keys from the DM data bag. This describes the field set, not the
+        access level: who may read it is decided by the view's permissions, not by
+        any of these fields being "public".
+      properties:
+        username:
+          type: string
+          readOnly: true
+        email:
+          type: string
+          format: email
+          readOnly: true
+        name:
+          type: string
+          readOnly: true
+        date_joined:
+          type: string
+          readOnly: true
+        profile_image:
+          type: string
+          readOnly: true
+        bio:
+          type: string
+          readOnly: true
+        about:
+          type: string
+          readOnly: true
+        social_links:
+          type: string
+          readOnly: true
+        public_metadata:
+          type: string
+          readOnly: true
+      required:
+      - about
+      - bio
+      - date_joined
+      - email
+      - name
+      - profile_image
+      - public_metadata
+      - social_links
+      - username
     UserProxyBulkRequest:
       type: object
       properties:

package/src/core/OpenAPI.ts

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

package/src/index.ts

@@ -624,6 +624,7 @@ export type { UserPolicyUpdate } from './models/UserPolicyUpdate';
 export type { UserPolicyUpdateError } from './models/UserPolicyUpdateError';
 export type { UserPolicyUpdateForbidden } from './models/UserPolicyUpdateForbidden';
 export type { UserPolicyUpdateResponse } from './models/UserPolicyUpdateResponse';
+export type { UserProfileSummary } from './models/UserProfileSummary';
 export type { UserProxyBulkRequest } from './models/UserProxyBulkRequest';
 export type { UserProxyGetResponse } from './models/UserProxyGetResponse';
 export type { UserProxyPostRequest } from './models/UserProxyPostRequest';

package/src/models/PathwayEnrollmentRequest.ts

@@ -38,6 +38,14 @@ export type PathwayEnrollmentRequest = {
      * Platform key for the pathway
      */
     platform_key?: string;
+    /**
+     * Alias of platform_key
+     */
+    key?: string;
+    /**
+     * Alias of org
+     */
+    platform_org?: string;
     /**
      * Include enrollments from default platform
      */

package/src/models/UserProfileSummary.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Profile-card fields returned to a viewer authorized to see a user.
+ *
+ * Explicit allowlist. It carries the fields the profile preview needs plus
+ * `email`, which the current metadata endpoint already returns for authorized
+ * callers (parity for that field). It does not carry the other account fields
+ * the full metadata endpoint holds (phone, mailing address, demographics) or
+ * private keys from the DM data bag. This describes the field set, not the
+ * access level: who may read it is decided by the view's permissions, not by
+ * any of these fields being "public".
+ */
+export type UserProfileSummary = {
+    readonly username: string;
+    readonly email: string;
+    readonly name: string;
+    readonly date_joined: string;
+    readonly profile_image: string;
+    readonly bio: string;
+    readonly about: string;
+    readonly social_links: string;
+    readonly public_metadata: string;
+};
+