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

package/src/services/CatalogService.ts

@@ -1862,9 +1862,12 @@ export 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
@@ -1874,10 +1877,12 @@ export class CatalogService {
                     courseName,
                     email,
                     includeDefaultPlatform,
+                    key,
                     org,
                     page,
                     pageSize,
                     platformKey,
+                    platformOrg,
                     slug,
                     sort = '-id',
                     userId,
@@ -1899,6 +1904,10 @@ export class CatalogService {
                      * Include enrollments from default platform
                      */
                     includeDefaultPlatform?: boolean,
+                    /**
+                     * Alias of platform_key
+                     */
+                    key?: string,
                     /**
                      * Filter enrollments by organization
                      */
@@ -1915,6 +1924,10 @@ export class CatalogService {
                      * Filter enrollments by platform key
                      */
                     platformKey?: string,
+                    /**
+                     * Alias of org
+                     */
+                    platformOrg?: string,
                     /**
                      * Filter enrollments by course slug
                      */
@@ -1940,10 +1953,12 @@ export class CatalogService {
                             'course_name': courseName,
                             'email': email,
                             'include_default_platform': includeDefaultPlatform,
+                            'key': key,
                             'org': org,
                             'page': page,
                             'page_size': pageSize,
                             'platform_key': platformKey,
+                            'platform_org': platformOrg,
                             'slug': slug,
                             'sort': sort,
                             'user_id': userId,
@@ -1960,11 +1975,13 @@ export class CatalogService {
                     active = true,
                     includeDefaultPlatform,
                     includeMetadata = true,
+                    key,
                     org,
                     pathwayId,
                     pathwayKey,
                     pathwayUuid,
                     platformKey,
+                    platformOrg,
                     slug,
                     userId,
                     username,
@@ -1981,6 +1998,10 @@ export class CatalogService {
                      * Include metadata in the response
                      */
                     includeMetadata?: boolean,
+                    /**
+                     * Alias of platform_key
+                     */
+                    key?: string,
                     /**
                      * Organization for the pathway
                      */
@@ -2001,6 +2022,10 @@ export class CatalogService {
                      * Platform key for the pathway
                      */
                     platformKey?: string,
+                    /**
+                     * Alias of org
+                     */
+                    platformOrg?: string,
                     /**
                      * Pathway slug for enrollment
                      */
@@ -2021,11 +2046,13 @@ export class CatalogService {
                             'active': active,
                             'include_default_platform': includeDefaultPlatform,
                             'include_metadata': includeMetadata,
+                            'key': key,
                             'org': org,
                             'pathway_id': pathwayId,
                             'pathway_key': pathwayKey,
                             'pathway_uuid': pathwayUuid,
                             'platform_key': platformKey,
+                            'platform_org': platformOrg,
                             'slug': slug,
                             'user_id': userId,
                             'username': username,
@@ -2041,11 +2068,13 @@ export class CatalogService {
                     active = true,
                     includeDefaultPlatform,
                     includeMetadata = true,
+                    key,
                     org,
                     pathwayId,
                     pathwayKey,
                     pathwayUuid,
                     platformKey,
+                    platformOrg,
                     slug,
                     userId,
                     username,
@@ -2063,6 +2092,10 @@ export class CatalogService {
                      * Include metadata in the response
                      */
                     includeMetadata?: boolean,
+                    /**
+                     * Alias of platform_key
+                     */
+                    key?: string,
                     /**
                      * Organization for the pathway
                      */
@@ -2083,6 +2116,10 @@ export class CatalogService {
                      * Platform key for the pathway
                      */
                     platformKey?: string,
+                    /**
+                     * Alias of org
+                     */
+                    platformOrg?: string,
                     /**
                      * Pathway slug for enrollment
                      */
@@ -2104,11 +2141,13 @@ export class CatalogService {
                             'active': active,
                             'include_default_platform': includeDefaultPlatform,
                             'include_metadata': includeMetadata,
+                            'key': key,
                             'org': org,
                             'pathway_id': pathwayId,
                             'pathway_key': pathwayKey,
                             'pathway_uuid': pathwayUuid,
                             'platform_key': platformKey,
+                            'platform_org': platformOrg,
                             'slug': slug,
                             'user_id': userId,
                             'username': username,
@@ -2126,11 +2165,13 @@ export class CatalogService {
                     active = true,
                     includeDefaultPlatform,
                     includeMetadata = true,
+                    key,
                     org,
                     pathwayId,
                     pathwayKey,
                     pathwayUuid,
                     platformKey,
+                    platformOrg,
                     slug,
                     userId,
                     username,
@@ -2147,6 +2188,10 @@ export class CatalogService {
                      * Include metadata in the response
                      */
                     includeMetadata?: boolean,
+                    /**
+                     * Alias of platform_key
+                     */
+                    key?: string,
                     /**
                      * Organization for the pathway
                      */
@@ -2167,6 +2212,10 @@ export class CatalogService {
                      * Platform key for the pathway
                      */
                     platformKey?: string,
+                    /**
+                     * Alias of org
+                     */
+                    platformOrg?: string,
                     /**
                      * Pathway slug for enrollment
                      */
@@ -2187,11 +2236,13 @@ export class CatalogService {
                             'active': active,
                             'include_default_platform': includeDefaultPlatform,
                             'include_metadata': includeMetadata,
+                            'key': key,
                             'org': org,
                             'pathway_id': pathwayId,
                             'pathway_key': pathwayKey,
                             'pathway_uuid': pathwayUuid,
                             'platform_key': platformKey,
+                            'platform_org': platformOrg,
                             'slug': slug,
                             'user_id': userId,
                             'username': username,
@@ -2350,8 +2401,10 @@ export class CatalogService {
                     ignoreExpiration = false,
                     includeDefaultPlatform,
                     includeMetadata = true,
+                    key,
                     org,
                     platformKey,
+                    platformOrg,
                     programId,
                     programKey,
                     programType,
@@ -2380,6 +2433,10 @@ export class CatalogService {
                      * Include metadata in the response
                      */
                     includeMetadata?: boolean,
+                    /**
+                     * Alias of platform_key
+                     */
+                    key?: string,
                     /**
                      * Organization for the program
                      */
@@ -2388,6 +2445,10 @@ export class CatalogService {
                      * Platform key for the program
                      */
                     platformKey?: string,
+                    /**
+                     * Alias of org
+                     */
+                    platformOrg?: string,
                     /**
                      * Program ID for enrollment
                      */
@@ -2426,8 +2487,10 @@ export class CatalogService {
                             'ignore_expiration': ignoreExpiration,
                             'include_default_platform': includeDefaultPlatform,
                             'include_metadata': includeMetadata,
+                            'key': key,
                             'org': org,
                             'platform_key': platformKey,
+                            'platform_org': platformOrg,
                             'program_id': programId,
                             'program_key': programKey,
                             'program_type': programType,
@@ -2449,8 +2512,10 @@ export class CatalogService {
                     ignoreExpiration = false,
                     includeDefaultPlatform,
                     includeMetadata = true,
+                    key,
                     org,
                     platformKey,
+                    platformOrg,
                     programId,
                     programKey,
                     programType,
@@ -2480,6 +2545,10 @@ export class CatalogService {
                      * Include metadata in the response
                      */
                     includeMetadata?: boolean,
+                    /**
+                     * Alias of platform_key
+                     */
+                    key?: string,
                     /**
                      * Organization for the program
                      */
@@ -2488,6 +2557,10 @@ export class CatalogService {
                      * Platform key for the program
                      */
                     platformKey?: string,
+                    /**
+                     * Alias of org
+                     */
+                    platformOrg?: string,
                     /**
                      * Program ID for enrollment
                      */
@@ -2527,8 +2600,10 @@ export class CatalogService {
                             'ignore_expiration': ignoreExpiration,
                             'include_default_platform': includeDefaultPlatform,
                             'include_metadata': includeMetadata,
+                            'key': key,
                             'org': org,
                             'platform_key': platformKey,
+                            'platform_org': platformOrg,
                             'program_id': programId,
                             'program_key': programKey,
                             'program_type': programType,
@@ -2552,8 +2627,10 @@ export class CatalogService {
                     ignoreExpiration = false,
                     includeDefaultPlatform,
                     includeMetadata = true,
+                    key,
                     org,
                     platformKey,
+                    platformOrg,
                     programId,
                     programKey,
                     programType,
@@ -2582,6 +2659,10 @@ export class CatalogService {
                      * Include metadata in the response
                      */
                     includeMetadata?: boolean,
+                    /**
+                     * Alias of platform_key
+                     */
+                    key?: string,
                     /**
                      * Organization for the program
                      */
@@ -2590,6 +2671,10 @@ export class CatalogService {
                      * Platform key for the program
                      */
                     platformKey?: string,
+                    /**
+                     * Alias of org
+                     */
+                    platformOrg?: string,
                     /**
                      * Program ID for enrollment
                      */
@@ -2628,8 +2713,10 @@ export class CatalogService {
                             'ignore_expiration': ignoreExpiration,
                             'include_default_platform': includeDefaultPlatform,
                             'include_metadata': includeMetadata,
+                            'key': key,
                             'org': org,
                             'platform_key': platformKey,
+                            'platform_org': platformOrg,
                             'program_id': programId,
                             'program_key': programKey,
                             'program_type': programType,
@@ -2647,10 +2734,12 @@ export class CatalogService {
                  */
                 public static catalogEnrollmentProgramsSearchRetrieve({
                     includeDefaultPlatform,
+                    key,
                     org,
                     page,
                     pageSize,
                     platformKey,
+                    platformOrg,
                     programId,
                     programType,
                     slug,
@@ -2662,6 +2751,10 @@ export class CatalogService {
                      * Include enrollments from default platform
                      */
                     includeDefaultPlatform?: boolean,
+                    /**
+                     * Alias of platform_key
+                     */
+                    key?: string,
                     /**
                      * Filter enrollments by organization
                      */
@@ -2678,6 +2771,10 @@ export class CatalogService {
                      * Filter enrollments by platform key
                      */
                     platformKey?: string,
+                    /**
+                     * Alias of org
+                     */
+                    platformOrg?: string,
                     /**
                      * Filter enrollments by program ID
                      */
@@ -2708,10 +2805,12 @@ export class CatalogService {
                         url: '/api/catalog/enrollment/programs/search/',
                         query: {
                             'include_default_platform': includeDefaultPlatform,
+                            'key': key,
                             'org': org,
                             'page': page,
                             'page_size': pageSize,
                             'platform_key': platformKey,
+                            'platform_org': platformOrg,
                             'program_id': programId,
                             'program_type': programType,
                             'slug': slug,
@@ -7530,10 +7629,13 @@ export class CatalogService {
                                                                                                              */
                                                                                                             public static catalogPathwaysList({
                                                                                                                 itemId,
+                                                                                                                key,
                                                                                                                 name,
+                                                                                                                org,
                                                                                                                 pathwayId,
                                                                                                                 pathwayUuid,
                                                                                                                 platformKey,
+                                                                                                                platformOrg,
                                                                                                                 slug,
                                                                                                                 userId,
                                                                                                                 username,
@@ -7543,10 +7645,18 @@ export 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 ID
                                                                                                                  */
@@ -7559,6 +7669,10 @@ export class CatalogService {
                                                                                                                  * Platform key
                                                                                                                  */
                                                                                                                 platformKey?: string,
+                                                                                                                /**
+                                                                                                                 * Alias of org
+                                                                                                                 */
+                                                                                                                platformOrg?: string,
                                                                                                                 /**
                                                                                                                  * Pathway slug (case-insensitive)
                                                                                                                  */
@@ -7581,10 +7695,13 @@ export class CatalogService {
                                                                                                                     url: '/api/catalog/pathways/',
                                                                                                                     query: {
                                                                                                                         'item_id': itemId,
+                                                                                                                        'key': key,
                                                                                                                         'name': name,
+                                                                                                                        'org': org,
                                                                                                                         'pathway_id': pathwayId,
                                                                                                                         'pathway_uuid': pathwayUuid,
                                                                                                                         'platform_key': platformKey,
+                                                                                                                        'platform_org': platformOrg,
                                                                                                                         'slug': slug,
                                                                                                                         'user_id': userId,
                                                                                                                         'username': username,
@@ -7600,10 +7717,13 @@ export class CatalogService {
                                                                                                             public static catalogPathwaysCreate({
                                                                                                                 requestBody,
                                                                                                                 itemId,
+                                                                                                                key,
                                                                                                                 name,
+                                                                                                                org,
                                                                                                                 pathwayId,
                                                                                                                 pathwayUuid,
                                                                                                                 platformKey,
+                                                                                                                platformOrg,
                                                                                                                 slug,
                                                                                                                 userId,
                                                                                                                 username,
@@ -7614,10 +7734,18 @@ export 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 ID
                                                                                                                  */
@@ -7630,6 +7758,10 @@ export class CatalogService {
                                                                                                                  * Platform key
                                                                                                                  */
                                                                                                                 platformKey?: string,
+                                                                                                                /**
+                                                                                                                 * Alias of org
+                                                                                                                 */
+                                                                                                                platformOrg?: string,
                                                                                                                 /**
                                                                                                                  * Pathway slug (case-insensitive)
                                                                                                                  */
@@ -7652,10 +7784,13 @@ export class CatalogService {
                                                                                                                     url: '/api/catalog/pathways/',
                                                                                                                     query: {
                                                                                                                         'item_id': itemId,
+                                                                                                                        'key': key,
                                                                                                                         'name': name,
+                                                                                                                        'org': org,
                                                                                                                         'pathway_id': pathwayId,
                                                                                                                         'pathway_uuid': pathwayUuid,
                                                                                                                         'platform_key': platformKey,
+                                                                                                                        'platform_org': platformOrg,
                                                                                                                         'slug': slug,
                                                                                                                         'user_id': userId,
                                                                                                                         'username': username,
@@ -7677,9 +7812,12 @@ export class CatalogService {
                                                                                                                 pathwayId,
                                                                                                                 userId,
                                                                                                                 itemId,
+                                                                                                                key,
                                                                                                                 name,
+                                                                                                                org,
                                                                                                                 pathwayUuid,
                                                                                                                 platformKey,
+                                                                                                                platformOrg,
                                                                                                                 slug,
                                                                                                                 username,
                                                                                                                 visible,
@@ -7696,10 +7834,18 @@ export 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
                                                                                                                  */
@@ -7708,6 +7854,10 @@ export class CatalogService {
                                                                                                                  * Platform key
                                                                                                                  */
                                                                                                                 platformKey?: string,
+                                                                                                                /**
+                                                                                                                 * Alias of org
+                                                                                                                 */
+                                                                                                                platformOrg?: string,
                                                                                                                 /**
                                                                                                                  * Pathway slug (case-insensitive)
                                                                                                                  */
@@ -7726,10 +7876,13 @@ export class CatalogService {
                                                                                                                     url: '/api/catalog/pathways/',
                                                                                                                     query: {
                                                                                                                         'item_id': itemId,
+                                                                                                                        'key': key,
                                                                                                                         'name': name,
+                                                                                                                        'org': org,
                                                                                                                         'pathway_id': pathwayId,
                                                                                                                         'pathway_uuid': pathwayUuid,
                                                                                                                         'platform_key': platformKey,
+                                                                                                                        'platform_org': platformOrg,
                                                                                                                         'slug': slug,
                                                                                                                         'user_id': userId,
                                                                                                                         'username': username,

package/src/services/CoreService.ts

@@ -81,6 +81,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';
@@ -3811,6 +3812,42 @@ export class CoreService {
             mediaType: 'application/json',
         });
     }
+    /**
+     * 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
+     */
+    public static coreUsersProfileSummaryRetrieve({
+        email,
+        platformKey,
+        userId,
+        username,
+    }: {
+        email?: string,
+        platformKey?: string,
+        userId?: number,
+        username?: string,
+    }): CancelablePromise<UserProfileSummary> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/users/profile/summary/',
+            query: {
+                'email': email,
+                'platform_key': platformKey,
+                'user_id': userId,
+                'username': username,
+            },
+        });
+    }
     /**
      * Retrieve proxy user information by user_id
      * @returns UserProxyGetResponse

package/src/services/IntegrationCredentialsService.ts

@@ -0,0 +1,52 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { IntegrationCredentialSchemaV2 } from '../models/IntegrationCredentialSchemaV2';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class IntegrationCredentialsService {
+    /**
+     * Retrieve V2 integration credentials schema with sensitivity metadata.
+     *
+     * Query Parameters:
+     * name (optional): Filter results by integration service name
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of integration credentials schema with is_sensitive metadata.
+     * @returns IntegrationCredentialSchemaV2
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialSchemaV2List({
+        org,
+        name,
+        unmaskSensitiveFields = false,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+        /**
+         * If true and the requester is a platform admin for the org, returns full unmasked credential values. Restricted to credentials owned by the requested tenant (no main-platform fallback when unmasking). Ignored for non-admins.
+         */
+        unmaskSensitiveFields?: boolean,
+    }): CancelablePromise<Array<IntegrationCredentialSchemaV2>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/integration-credential/schema/v2/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+                'unmask_sensitive_fields': unmaskSensitiveFields,
+            },
+        });
+    }
+}