@iblai/iblai-api 3.47.2-core → 3.48.0-ai

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

@@ -1,18 +1,31 @@
 import type { CeleryHeartbeat } from '../models/CeleryHeartbeat';
-import type { CheckPermissionRequest } from '../models/CheckPermissionRequest';
 import type { EdxSignalReceiverRequest } from '../models/EdxSignalReceiverRequest';
 import type { ImageUpload } from '../models/ImageUpload';
 import type { LauncherViewPostRequest } from '../models/LauncherViewPostRequest';
 import type { LtiKey } from '../models/LtiKey';
 import type { LtiTool } from '../models/LtiTool';
+import type { PaginatedRbacGroupList } from '../models/PaginatedRbacGroupList';
+import type { PaginatedRbacGroupRoleList } from '../models/PaginatedRbacGroupRoleList';
+import type { PaginatedRbacPolicyList } from '../models/PaginatedRbacPolicyList';
+import type { PaginatedRbacRoleList } from '../models/PaginatedRbacRoleList';
+import type { PaginatedRbacUserRoleList } from '../models/PaginatedRbacUserRoleList';
 import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
+import type { PatchedRbacGroup } from '../models/PatchedRbacGroup';
+import type { PatchedRbacGroupRole } from '../models/PatchedRbacGroupRole';
+import type { PatchedRbacPolicy } from '../models/PatchedRbacPolicy';
+import type { PatchedRbacRole } from '../models/PatchedRbacRole';
+import type { PatchedRbacUserRole } from '../models/PatchedRbacUserRole';
 import type { PlatformApiKey } from '../models/PlatformApiKey';
 import type { PlatformList } from '../models/PlatformList';
 import type { PlatformPublicMetadata } from '../models/PlatformPublicMetadata';
 import type { PlatformUpdatePostRequest } from '../models/PlatformUpdatePostRequest';
+import type { RbacGroup } from '../models/RbacGroup';
+import type { RbacGroupRole } from '../models/RbacGroupRole';
+import type { RbacPolicy } from '../models/RbacPolicy';
+import type { RbacRole } from '../models/RbacRole';
+import type { RbacUserRole } from '../models/RbacUserRole';
 import type { RedirectTokenRequest } from '../models/RedirectTokenRequest';
 import type { RedirectTokenResponse } from '../models/RedirectTokenResponse';
-import type { RolePermissions } from '../models/RolePermissions';
 import type { TokenProxyInput } from '../models/TokenProxyInput';
 import type { TokenProxyOutput } from '../models/TokenProxyOutput';
 import type { UserDeleteAPIRequest } from '../models/UserDeleteAPIRequest';
@@ -24,7 +37,6 @@ import type { UserProxyBulkRequest } from '../models/UserProxyBulkRequest';
 import type { UserProxyGetResponse } from '../models/UserProxyGetResponse';
 import type { UserProxyPostRequest } from '../models/UserProxyPostRequest';
 import type { UserProxyPostResponse } from '../models/UserProxyPostResponse';
-import type { UserRole } from '../models/UserRole';
 import type { UserSearchViewGetResponse } from '../models/UserSearchViewGetResponse';
 import type { WhitelistedDomain } from '../models/WhitelistedDomain';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -467,92 +479,269 @@ export declare class CoreService {
      */
     static corePlatformUsersRetrieve(page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, query?: string, sort?: string): CancelablePromise<UserPlatformManagementListViewGetResponse>;
     /**
-     * Check if a user has permission to perform an action on a resource.
+     * List group role assignments
+     * Retrieve a list of group role assignments. Can be filtered by platform_key, group_id, or role_id.
+     * @param groupId Filter group roles by group ID
+     * @param page A page number within the paginated result set.
+     * @param pageSize Number of results to return per page.
+     * @param platformKey Filter group roles by platform key
+     * @param roleId Filter group roles by role ID
+     * @returns PaginatedRbacGroupRoleList
+     * @throws ApiError
+     */
+    static coreRbacGroupRolesList(groupId?: number, page?: number, pageSize?: number, platformKey?: string, roleId?: number): CancelablePromise<PaginatedRbacGroupRoleList>;
+    /**
+     * Create group role assignment
+     * Assign a role to a group. The group and role must belong to the same platform.
      * @param requestBody
-     * @returns any User has permission to perform the action on the resource.
+     * @returns RbacGroupRole
      * @throws ApiError
      */
-    static coreRbacCheckPermissionsCreate(requestBody: CheckPermissionRequest): CancelablePromise<any>;
+    static coreRbacGroupRolesCreate(requestBody: RbacGroupRole): CancelablePromise<RbacGroupRole>;
     /**
-     * Get all associations for a resource.
-     * @returns any No response body
+     * Retrieve group role assignment
+     * Retrieve details of a specific group role assignment.
+     * @param id A unique integer value identifying this RBAC Group Role.
+     * @returns RbacGroupRole
      * @throws ApiError
      */
-    static coreRbacResourceAssociationRetrieve(): CancelablePromise<any>;
+    static coreRbacGroupRolesRetrieve(id: number): CancelablePromise<RbacGroupRole>;
     /**
-     * Associate a resource with a resource.
-     * @returns any No response body
+     * Update group role assignment
+     * Update an existing group role assignment. Platform validation applies.
+     * @param id A unique integer value identifying this RBAC Group Role.
+     * @param requestBody
+     * @returns RbacGroupRole
      * @throws ApiError
      */
-    static coreRbacResourceAssociationCreate(): CancelablePromise<any>;
+    static coreRbacGroupRolesUpdate(id: number, requestBody: RbacGroupRole): CancelablePromise<RbacGroupRole>;
     /**
-     * Disassociate a resource from a resource.
+     * Partially update group role assignment
+     * Partially update an existing group role assignment. Platform validation applies.
+     * @param id A unique integer value identifying this RBAC Group Role.
+     * @param requestBody
+     * @returns RbacGroupRole
+     * @throws ApiError
+     */
+    static coreRbacGroupRolesPartialUpdate(id: number, requestBody?: PatchedRbacGroupRole): CancelablePromise<RbacGroupRole>;
+    /**
+     * Delete group role assignment
+     * Remove a role assignment from a group.
+     * @param id A unique integer value identifying this RBAC Group Role.
      * @returns void
      * @throws ApiError
      */
-    static coreRbacResourceAssociationDestroy(): CancelablePromise<void>;
+    static coreRbacGroupRolesDestroy(id: number): CancelablePromise<void>;
     /**
-     * Get all permissions for a role.
-     * @returns any List of permissions for the role.
+     * List RBAC groups
+     * Retrieve a list of RBAC groups. Can be filtered by platform_key.
+     * @param page A page number within the paginated result set.
+     * @param pageSize Number of results to return per page.
+     * @param platformKey Filter groups by platform key
+     * @returns PaginatedRbacGroupList
      * @throws ApiError
      */
-    static coreRbacRolePermissionsRetrieve(): CancelablePromise<any>;
+    static coreRbacGroupsList(page?: number, pageSize?: number, platformKey?: string): CancelablePromise<PaginatedRbacGroupList>;
     /**
-     * Add a permission to a role.
+     * Create RBAC group
+     * Create a new RBAC group for a platform. Users can be assigned during creation.
      * @param requestBody
-     * @returns any Permission already exists for this role.
+     * @returns RbacGroup
      * @throws ApiError
      */
-    static coreRbacRolePermissionsCreate(requestBody: RolePermissions): CancelablePromise<any>;
+    static coreRbacGroupsCreate(requestBody: RbacGroup): CancelablePromise<RbacGroup>;
     /**
-     * Remove a permission from a role.
-     * @returns any Permission does not exist for this role.
+     * Retrieve RBAC group
+     * Retrieve details of a specific RBAC group including assigned users.
+     * @param id A unique integer value identifying this RBAC Group.
+     * @returns RbacGroup
      * @throws ApiError
      */
-    static coreRbacRolePermissionsDestroy(): CancelablePromise<any>;
+    static coreRbacGroupsRetrieve(id: number): CancelablePromise<RbacGroup>;
     /**
-     * Get all users in a role.
-     * @returns any List of users in the role.
+     * Update RBAC group
+     * Update an existing RBAC group. Platform validation applies for user assignments.
+     * @param id A unique integer value identifying this RBAC Group.
+     * @param requestBody
+     * @returns RbacGroup
      * @throws ApiError
      */
-    static coreRbacRoleUsersRetrieve(): CancelablePromise<any>;
+    static coreRbacGroupsUpdate(id: number, requestBody: RbacGroup): CancelablePromise<RbacGroup>;
     /**
-     * Get all roles for a platform.
-     * @returns any List of roles for the platform.
+     * Partially update RBAC group
+     * Partially update an existing RBAC group. Platform validation applies for user assignments.
+     * @param id A unique integer value identifying this RBAC Group.
+     * @param requestBody
+     * @returns RbacGroup
      * @throws ApiError
      */
-    static coreRbacRolesRetrieve(): CancelablePromise<any>;
+    static coreRbacGroupsPartialUpdate(id: number, requestBody?: PatchedRbacGroup): CancelablePromise<RbacGroup>;
     /**
-     * Create a new role.
-     * @returns any No response body
+     * Delete RBAC group
+     * Delete an RBAC group and all associated group role assignments.
+     * @param id A unique integer value identifying this RBAC Group.
+     * @returns void
+     * @throws ApiError
+     */
+    static coreRbacGroupsDestroy(id: number): CancelablePromise<void>;
+    /**
+     * List RBAC policies
+     * Retrieve a list of RBAC policies. Can be filtered by platform_key or role_id.
+     * @param page A page number within the paginated result set.
+     * @param pageSize Number of results to return per page.
+     * @param platformKey Filter policies by platform key
+     * @param roleId Filter policies by role ID
+     * @returns PaginatedRbacPolicyList
+     * @throws ApiError
+     */
+    static coreRbacPoliciesList(page?: number, pageSize?: number, platformKey?: string, roleId?: number): CancelablePromise<PaginatedRbacPolicyList>;
+    /**
+     * Create RBAC policy
+     * Create a new RBAC policy that defines resource access for a role.
+     * @param requestBody
+     * @returns RbacPolicy
+     * @throws ApiError
+     */
+    static coreRbacPoliciesCreate(requestBody: RbacPolicy): CancelablePromise<RbacPolicy>;
+    /**
+     * Retrieve RBAC policy
+     * Retrieve details of a specific RBAC policy.
+     * @param id A unique integer value identifying this RBAC Policy.
+     * @returns RbacPolicy
+     * @throws ApiError
+     */
+    static coreRbacPoliciesRetrieve(id: number): CancelablePromise<RbacPolicy>;
+    /**
+     * Update RBAC policy
+     * Update an existing RBAC policy.
+     * @param id A unique integer value identifying this RBAC Policy.
+     * @param requestBody
+     * @returns RbacPolicy
+     * @throws ApiError
+     */
+    static coreRbacPoliciesUpdate(id: number, requestBody: RbacPolicy): CancelablePromise<RbacPolicy>;
+    /**
+     * Partially update RBAC policy
+     * Partially update an existing RBAC policy.
+     * @param id A unique integer value identifying this RBAC Policy.
+     * @param requestBody
+     * @returns RbacPolicy
+     * @throws ApiError
+     */
+    static coreRbacPoliciesPartialUpdate(id: number, requestBody?: PatchedRbacPolicy): CancelablePromise<RbacPolicy>;
+    /**
+     * Delete RBAC policy
+     * Delete an RBAC policy.
+     * @param id A unique integer value identifying this RBAC Policy.
+     * @returns void
+     * @throws ApiError
+     */
+    static coreRbacPoliciesDestroy(id: number): CancelablePromise<void>;
+    /**
+     * List RBAC roles
+     * Retrieve a list of RBAC roles. Can be filtered by platform_key.
+     * @param page A page number within the paginated result set.
+     * @param pageSize Number of results to return per page.
+     * @param platformKey Filter roles by platform key
+     * @returns PaginatedRbacRoleList
+     * @throws ApiError
+     */
+    static coreRbacRolesList(page?: number, pageSize?: number, platformKey?: string): CancelablePromise<PaginatedRbacRoleList>;
+    /**
+     * Create RBAC role
+     * Create a new RBAC role for a platform.
+     * @param requestBody
+     * @returns RbacRole
+     * @throws ApiError
+     */
+    static coreRbacRolesCreate(requestBody: RbacRole): CancelablePromise<RbacRole>;
+    /**
+     * Retrieve RBAC role
+     * Retrieve details of a specific RBAC role.
+     * @param id A unique integer value identifying this RBAC Role.
+     * @returns RbacRole
+     * @throws ApiError
+     */
+    static coreRbacRolesRetrieve(id: number): CancelablePromise<RbacRole>;
+    /**
+     * Update RBAC role
+     * Update an existing RBAC role.
+     * @param id A unique integer value identifying this RBAC Role.
+     * @param requestBody
+     * @returns RbacRole
      * @throws ApiError
      */
-    static coreRbacRolesCreate(): CancelablePromise<any>;
+    static coreRbacRolesUpdate(id: number, requestBody: RbacRole): CancelablePromise<RbacRole>;
     /**
-     * Delete a role.
+     * Partially update RBAC role
+     * Partially update an existing RBAC role.
+     * @param id A unique integer value identifying this RBAC Role.
+     * @param requestBody
+     * @returns RbacRole
+     * @throws ApiError
+     */
+    static coreRbacRolesPartialUpdate(id: number, requestBody?: PatchedRbacRole): CancelablePromise<RbacRole>;
+    /**
+     * Delete RBAC role
+     * Delete an RBAC role.
+     * @param id A unique integer value identifying this RBAC Role.
      * @returns void
      * @throws ApiError
      */
-    static coreRbacRolesDestroy(): CancelablePromise<void>;
+    static coreRbacRolesDestroy(id: number): CancelablePromise<void>;
+    /**
+     * List user role assignments
+     * Retrieve a list of user role assignments. Can be filtered by platform_key or user_id.
+     * @param page A page number within the paginated result set.
+     * @param pageSize Number of results to return per page.
+     * @param platformKey Filter user roles by platform key
+     * @param userId Filter user roles by user ID
+     * @returns PaginatedRbacUserRoleList
+     * @throws ApiError
+     */
+    static coreRbacUserRolesList(page?: number, pageSize?: number, platformKey?: string, userId?: number): CancelablePromise<PaginatedRbacUserRoleList>;
+    /**
+     * Create user role assignment
+     * Assign a role to a user. The user must belong to the same platform as the role.
+     * @param requestBody
+     * @returns RbacUserRole
+     * @throws ApiError
+     */
+    static coreRbacUserRolesCreate(requestBody: RbacUserRole): CancelablePromise<RbacUserRole>;
+    /**
+     * Retrieve user role assignment
+     * Retrieve details of a specific user role assignment.
+     * @param id A unique integer value identifying this RBAC User Role.
+     * @returns RbacUserRole
+     * @throws ApiError
+     */
+    static coreRbacUserRolesRetrieve(id: number): CancelablePromise<RbacUserRole>;
     /**
-     * Get all roles for a user.
-     * @returns any List of roles for the user.
+     * Update user role assignment
+     * Update an existing user role assignment. Platform validation applies.
+     * @param id A unique integer value identifying this RBAC User Role.
+     * @param requestBody
+     * @returns RbacUserRole
      * @throws ApiError
      */
-    static coreRbacUserRolesRetrieve(): CancelablePromise<any>;
+    static coreRbacUserRolesUpdate(id: number, requestBody: RbacUserRole): CancelablePromise<RbacUserRole>;
     /**
-     * Add a user to a role.
+     * Partially update user role assignment
+     * Partially update an existing user role assignment. Platform validation applies.
+     * @param id A unique integer value identifying this RBAC User Role.
      * @param requestBody
-     * @returns any Role already exists for this user.
+     * @returns RbacUserRole
      * @throws ApiError
      */
-    static coreRbacUserRolesCreate(requestBody: UserRole): CancelablePromise<any>;
+    static coreRbacUserRolesPartialUpdate(id: number, requestBody?: PatchedRbacUserRole): CancelablePromise<RbacUserRole>;
     /**
-     * Remove a user from a role.
-     * @returns any Role does not exist for this user.
+     * Delete user role assignment
+     * Remove a role assignment from a user.
+     * @param id A unique integer value identifying this RBAC User Role.
+     * @returns void
      * @throws ApiError
      */
-    static coreRbacUserRolesDestroy(): CancelablePromise<any>;
+    static coreRbacUserRolesDestroy(id: number): CancelablePromise<void>;
     /**
      * Invalidate all tokens for the authenticated user
      * @returns any No response body