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

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

@@ -1097,14 +1097,17 @@ export declare class CatalogService {
                  * 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
                  * @returns CourseEnrollmentSearchResponse
                  * @throws ApiError
                  */
-    static catalogEnrollmentCoursesSearchRetrieve({ courseId, courseName, email, includeDefaultPlatform, org, page, pageSize, platformKey, slug, sort, userId, username, }: {
+    static catalogEnrollmentCoursesSearchRetrieve({ courseId, courseName, email, includeDefaultPlatform, key, org, page, pageSize, platformKey, platformOrg, slug, sort, userId, username, }: {
         /**
          * Filter enrollments by course ID
          */
@@ -1121,6 +1124,10 @@ export declare class CatalogService {
          * Include enrollments from default platform
          */
         includeDefaultPlatform?: boolean;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Filter enrollments by organization
          */
@@ -1137,6 +1144,10 @@ export declare class CatalogService {
          * Filter enrollments by platform key
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Filter enrollments by course slug
          */
@@ -1159,7 +1170,7 @@ export declare class CatalogService {
      * @returns PathwayEnrollmentPlus
      * @throws ApiError
      */
-    static catalogEnrollmentPathwaysRetrieve({ active, includeDefaultPlatform, includeMetadata, org, pathwayId, pathwayKey, pathwayUuid, platformKey, slug, userId, username, }: {
+    static catalogEnrollmentPathwaysRetrieve({ active, includeDefaultPlatform, includeMetadata, key, org, pathwayId, pathwayKey, pathwayUuid, platformKey, platformOrg, slug, userId, username, }: {
         /**
          * Whether the enrollment should be active
          */
@@ -1172,6 +1183,10 @@ export declare class CatalogService {
          * Include metadata in the response
          */
         includeMetadata?: boolean;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Organization for the pathway
          */
@@ -1192,6 +1207,10 @@ export declare class CatalogService {
          * Platform key for the pathway
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Pathway slug for enrollment
          */
@@ -1210,7 +1229,7 @@ export declare class CatalogService {
      * @returns PathwayEnrollment
      * @throws ApiError
      */
-    static catalogEnrollmentPathwaysCreate({ active, includeDefaultPlatform, includeMetadata, org, pathwayId, pathwayKey, pathwayUuid, platformKey, slug, userId, username, requestBody, }: {
+    static catalogEnrollmentPathwaysCreate({ active, includeDefaultPlatform, includeMetadata, key, org, pathwayId, pathwayKey, pathwayUuid, platformKey, platformOrg, slug, userId, username, requestBody, }: {
         /**
          * Whether the enrollment should be active
          */
@@ -1223,6 +1242,10 @@ export declare class CatalogService {
          * Include metadata in the response
          */
         includeMetadata?: boolean;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Organization for the pathway
          */
@@ -1243,6 +1266,10 @@ export declare class CatalogService {
          * Platform key for the pathway
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Pathway slug for enrollment
          */
@@ -1262,7 +1289,7 @@ export declare class CatalogService {
      * @returns PathwayEnrollment
      * @throws ApiError
      */
-    static catalogEnrollmentPathwaysDestroy({ active, includeDefaultPlatform, includeMetadata, org, pathwayId, pathwayKey, pathwayUuid, platformKey, slug, userId, username, }: {
+    static catalogEnrollmentPathwaysDestroy({ active, includeDefaultPlatform, includeMetadata, key, org, pathwayId, pathwayKey, pathwayUuid, platformKey, platformOrg, slug, userId, username, }: {
         /**
          * Whether the enrollment should be active
          */
@@ -1275,6 +1302,10 @@ export declare class CatalogService {
          * Include metadata in the response
          */
         includeMetadata?: boolean;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Organization for the pathway
          */
@@ -1295,6 +1326,10 @@ export declare class CatalogService {
          * Platform key for the pathway
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Pathway slug for enrollment
          */
@@ -1398,7 +1433,7 @@ export declare class CatalogService {
      * @returns ProgramEnrollmentPlus
      * @throws ApiError
      */
-    static catalogEnrollmentProgramsRetrieve({ active, expired, ignoreExpiration, includeDefaultPlatform, includeMetadata, org, platformKey, programId, programKey, programType, slug, started, userId, username, }: {
+    static catalogEnrollmentProgramsRetrieve({ active, expired, ignoreExpiration, includeDefaultPlatform, includeMetadata, key, org, platformKey, platformOrg, programId, programKey, programType, slug, started, userId, username, }: {
         /**
          * Whether the enrollment should be active
          */
@@ -1419,6 +1454,10 @@ export declare class CatalogService {
          * Include metadata in the response
          */
         includeMetadata?: boolean;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Organization for the program
          */
@@ -1427,6 +1466,10 @@ export declare class CatalogService {
          * Platform key for the program
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Program ID for enrollment
          */
@@ -1461,7 +1504,7 @@ export declare class CatalogService {
      * @returns ProgramEnrollment
      * @throws ApiError
      */
-    static catalogEnrollmentProgramsCreate({ active, expired, ignoreExpiration, includeDefaultPlatform, includeMetadata, org, platformKey, programId, programKey, programType, slug, started, userId, username, requestBody, }: {
+    static catalogEnrollmentProgramsCreate({ active, expired, ignoreExpiration, includeDefaultPlatform, includeMetadata, key, org, platformKey, platformOrg, programId, programKey, programType, slug, started, userId, username, requestBody, }: {
         /**
          * Whether the enrollment should be active
          */
@@ -1482,6 +1525,10 @@ export declare class CatalogService {
          * Include metadata in the response
          */
         includeMetadata?: boolean;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Organization for the program
          */
@@ -1490,6 +1537,10 @@ export declare class CatalogService {
          * Platform key for the program
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Program ID for enrollment
          */
@@ -1525,7 +1576,7 @@ export declare class CatalogService {
      * @returns ProgramEnrollment
      * @throws ApiError
      */
-    static catalogEnrollmentProgramsDestroy({ active, expired, ignoreExpiration, includeDefaultPlatform, includeMetadata, org, platformKey, programId, programKey, programType, slug, started, userId, username, }: {
+    static catalogEnrollmentProgramsDestroy({ active, expired, ignoreExpiration, includeDefaultPlatform, includeMetadata, key, org, platformKey, platformOrg, programId, programKey, programType, slug, started, userId, username, }: {
         /**
          * Whether the enrollment should be active
          */
@@ -1546,6 +1597,10 @@ export declare class CatalogService {
          * Include metadata in the response
          */
         includeMetadata?: boolean;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Organization for the program
          */
@@ -1554,6 +1609,10 @@ export declare class CatalogService {
          * Platform key for the program
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Program ID for enrollment
          */
@@ -1588,11 +1647,15 @@ export declare class CatalogService {
      * @returns ProgramEnrollmentSearchResponse
      * @throws ApiError
      */
-    static catalogEnrollmentProgramsSearchRetrieve({ includeDefaultPlatform, org, page, pageSize, platformKey, programId, programType, slug, sort, userId, username, }: {
+    static catalogEnrollmentProgramsSearchRetrieve({ includeDefaultPlatform, key, org, page, pageSize, platformKey, platformOrg, programId, programType, slug, sort, userId, username, }: {
         /**
          * Include enrollments from default platform
          */
         includeDefaultPlatform?: boolean;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Filter enrollments by organization
          */
@@ -1609,6 +1672,10 @@ export declare class CatalogService {
          * Filter enrollments by platform key
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Filter enrollments by program ID
          */
@@ -4400,15 +4467,23 @@ export declare class CatalogService {
      * @returns Pathway
      * @throws ApiError
      */
-    static catalogPathwaysList({ itemId, name, pathwayId, pathwayUuid, platformKey, slug, userId, username, visible, }: {
+    static catalogPathwaysList({ itemId, key, name, org, pathwayId, pathwayUuid, platformKey, platformOrg, slug, userId, username, visible, }: {
         /**
          * Item ID associated with the pathway
          */
         itemId?: string;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Pathway name
          */
         name?: string;
+        /**
+         * Platform organization
+         */
+        org?: string;
         /**
          * Pathway ID
          */
@@ -4421,6 +4496,10 @@ export declare class CatalogService {
          * Platform key
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Pathway slug (case-insensitive)
          */
@@ -4443,16 +4522,24 @@ export declare class CatalogService {
      * @returns Pathway
      * @throws ApiError
      */
-    static catalogPathwaysCreate({ requestBody, itemId, name, pathwayId, pathwayUuid, platformKey, slug, userId, username, visible, }: {
+    static catalogPathwaysCreate({ requestBody, itemId, key, name, org, pathwayId, pathwayUuid, platformKey, platformOrg, slug, userId, username, visible, }: {
         requestBody: PathwayCreateUpdateRequest;
         /**
          * Item ID associated with the pathway
          */
         itemId?: string;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Pathway name
          */
         name?: string;
+        /**
+         * Platform organization
+         */
+        org?: string;
         /**
          * Pathway ID
          */
@@ -4465,6 +4552,10 @@ export declare class CatalogService {
          * Platform key
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Pathway slug (case-insensitive)
          */
@@ -4487,7 +4578,7 @@ export declare class CatalogService {
      * @returns PathwayDeleteResponse
      * @throws ApiError
      */
-    static catalogPathwaysDestroy({ pathwayId, userId, itemId, name, pathwayUuid, platformKey, slug, username, visible, }: {
+    static catalogPathwaysDestroy({ pathwayId, userId, itemId, key, name, org, pathwayUuid, platformKey, platformOrg, slug, username, visible, }: {
         /**
          * Pathway ID to delete
          */
@@ -4500,10 +4591,18 @@ export declare class CatalogService {
          * Item ID associated with the pathway
          */
         itemId?: string;
+        /**
+         * Alias of platform_key
+         */
+        key?: string;
         /**
          * Pathway name
          */
         name?: string;
+        /**
+         * Platform organization
+         */
+        org?: string;
         /**
          * Pathway UUID
          */
@@ -4512,6 +4611,10 @@ export declare class CatalogService {
          * Platform key
          */
         platformKey?: string;
+        /**
+         * Alias of org
+         */
+        platformOrg?: string;
         /**
          * Pathway slug (case-insensitive)
          */

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

@@ -77,6 +77,7 @@ import type { UserPlatformSelfLinkResponse } from '../models/UserPlatformSelfLin
 import type { UserPlatformViewPostRequest } from '../models/UserPlatformViewPostRequest';
 import type { UserPolicyUpdate } from '../models/UserPolicyUpdate';
 import type { UserPolicyUpdateResponse } from '../models/UserPolicyUpdateResponse';
+import type { UserProfileSummary } from '../models/UserProfileSummary';
 import type { UserProxyBulkRequest } from '../models/UserProxyBulkRequest';
 import type { UserProxyGetResponse } from '../models/UserProxyGetResponse';
 import type { UserProxyPostRequest } from '../models/UserProxyPostRequest';
@@ -1907,6 +1908,25 @@ export declare class CoreService {
     static coreUsersPlatformsSelfLinkCreate({ requestBody, }: {
         requestBody: UserPlatformSelfLinkRequest;
     }): CancelablePromise<UserPlatformSelfLinkResponse>;
+    /**
+     * 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.
+     * @returns UserProfileSummary
+     * @throws ApiError
+     */
+    static coreUsersProfileSummaryRetrieve({ email, platformKey, userId, username, }: {
+        email?: string;
+        platformKey?: string;
+        username?: string;
+    }): CancelablePromise<UserProfileSummary>;
     /**
      * Retrieve proxy user information by user_id
      * @returns UserProxyGetResponse

package/package.json

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