@iblai/iblai-api 4.295.0-core → 4.296.0-core

package/src/services/CoreService.ts

@@ -15,6 +15,7 @@ import type { LtiKey } from '../models/LtiKey';
 import type { LtiMentor } from '../models/LtiMentor';
 import type { LtiTool } from '../models/LtiTool';
 import type { MentorPolicy } from '../models/MentorPolicy';
+import type { PaginatedPlatformApiKeyList } from '../models/PaginatedPlatformApiKeyList';
 import type { PaginatedRbacGroupList } from '../models/PaginatedRbacGroupList';
 import type { PaginatedRbacPolicyList } from '../models/PaginatedRbacPolicyList';
 import type { PaginatedRbacRoleList } from '../models/PaginatedRbacRoleList';
@@ -23,6 +24,7 @@ import type { PaginatedWatchedGroupListList } from '../models/PaginatedWatchedGr
 import type { PaginatedWatchedUserReadList } from '../models/PaginatedWatchedUserReadList';
 import type { PaginatedWatcherReadList } from '../models/PaginatedWatcherReadList';
 import type { PatchedDemographicsFieldDefinitionWrite } from '../models/PatchedDemographicsFieldDefinitionWrite';
+import type { PatchedPlatformApiKey } from '../models/PatchedPlatformApiKey';
 import type { PatchedPlatformPublicImageAsset } from '../models/PatchedPlatformPublicImageAsset';
 import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
 import type { PatchedRbacGroup } from '../models/PatchedRbacGroup';
@@ -34,6 +36,7 @@ import type { PatchedWatchedGroupUpdate } from '../models/PatchedWatchedGroupUpd
 import type { PatchedWatcherUpdate } from '../models/PatchedWatcherUpdate';
 import type { PermissionCheckRequest } from '../models/PermissionCheckRequest';
 import type { PlatformApiKey } from '../models/PlatformApiKey';
+import type { PlatformApiTokenFieldPermissions } from '../models/PlatformApiTokenFieldPermissions';
 import type { PlatformConfigurationList } from '../models/PlatformConfigurationList';
 import type { PlatformConfigurationSet } from '../models/PlatformConfigurationSet';
 import type { PlatformConfigurationSetResponse } from '../models/PlatformConfigurationSetResponse';
@@ -1059,21 +1062,33 @@ export class CoreService {
     }
     /**
      * List Platform API Key's belonging to the target platform
-     * @returns PlatformApiKey
+     * @returns PaginatedPlatformApiKeyList
      * @throws ApiError
      */
     public static corePlatformApiTokensList({
         platformKey,
+        page,
+        pageSize,
     }: {
         /**
          * Platform key of target platform
          */
         platformKey: string,
-    }): CancelablePromise<Array<PlatformApiKey>> {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number,
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number,
+    }): CancelablePromise<PaginatedPlatformApiKeyList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/core/platform/api-tokens/',
             query: {
+                'page': page,
+                'page_size': pageSize,
                 'platform_key': platformKey,
             },
         });
@@ -1095,6 +1110,62 @@ export class CoreService {
             mediaType: 'application/json',
         });
     }
+    /**
+     * Retrieve a single Platform Api Key by name, including the policies and groups currently associated with it
+     * @returns PlatformApiKey
+     * @throws ApiError
+     */
+    public static corePlatformApiTokensRetrieve({
+        name,
+        platformKey,
+    }: {
+        name: string,
+        /**
+         * Platform key of target platform
+         */
+        platformKey: string,
+    }): CancelablePromise<PlatformApiKey> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/platform/api-tokens/{name}',
+            path: {
+                'name': name,
+            },
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Update a Platform Api Key's mode and associated policies/groups in the target platform
+     * @returns PlatformApiKey
+     * @throws ApiError
+     */
+    public static corePlatformApiTokensPartialUpdate({
+        name,
+        platformKey,
+        requestBody,
+    }: {
+        name: string,
+        /**
+         * Platform key of target platform
+         */
+        platformKey: string,
+        requestBody?: PatchedPlatformApiKey,
+    }): CancelablePromise<PlatformApiKey> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/core/platform/api-tokens/{name}',
+            path: {
+                'name': name,
+            },
+            query: {
+                'platform_key': platformKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
     /**
      * Delete Platform Api Key by name in the target platform
      * @returns void
@@ -1121,6 +1192,27 @@ export class CoreService {
             },
         });
     }
+    /**
+     * Per-field write permissions for the create form, as {field: {"write": bool}}. Gated on create access like the create endpoint.
+     * @returns PlatformApiTokenFieldPermissions
+     * @throws ApiError
+     */
+    public static corePlatformApiTokensFieldPermissionsRetrieve({
+        platformKey,
+    }: {
+        /**
+         * Platform key of target platform
+         */
+        platformKey: string,
+    }): CancelablePromise<PlatformApiTokenFieldPermissions> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/platform/api-tokens/field-permissions/',
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
     /**
      * GET /site
      * Get site settings.