@iblai/iblai-api 4.297.0-core → 4.298.0-core

package/src/services/CoreService.ts

@@ -363,6 +363,124 @@ export class CoreService {
             mediaType: 'application/json',
         });
     }
+    /**
+     * List your LTI Mentor's
+     * @returns LtiMentor
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiAgentsList({
+        platformKey,
+        mentorId,
+    }: {
+        /**
+         * Platform Key
+         */
+        platformKey: string,
+        /**
+         * The mentor's unique_id to filter for
+         */
+        mentorId?: string,
+    }): CancelablePromise<Array<LtiMentor>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/lti/1p3/provider/lti-agents/',
+            query: {
+                'mentor_id': mentorId,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Create a new LTI Mentor
+     * @returns LtiMentor
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiAgentsCreate({
+        requestBody,
+    }: {
+        requestBody: LtiMentor,
+    }): CancelablePromise<LtiMentor> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/lti/1p3/provider/lti-agents/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get details about a specific LTI Mentor
+     * @returns LtiMentor
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiAgentsRetrieve({
+        id,
+        platformKey,
+    }: {
+        id: string,
+        /**
+         * Platform Key
+         */
+        platformKey: string,
+    }): CancelablePromise<LtiMentor> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/lti/1p3/provider/lti-agents/{id}/',
+            path: {
+                'id': id,
+            },
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Update an LTI Mentor
+     * @returns LtiMentor
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiAgentsUpdate({
+        id,
+        requestBody,
+    }: {
+        id: string,
+        requestBody: LtiMentor,
+    }): CancelablePromise<LtiMentor> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/core/lti/1p3/provider/lti-agents/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete an LTI Mentor
+     * @returns void
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiAgentsDestroy({
+        id,
+        platformKey,
+    }: {
+        id: string,
+        /**
+         * Platform Key
+         */
+        platformKey: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/core/lti/1p3/provider/lti-agents/{id}/',
+            path: {
+                'id': id,
+            },
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
     /**
      * List your LTI Provider Key's
      * @returns LtiKey
@@ -476,6 +594,9 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
+     * **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * List your LTI Mentor's
      * @returns LtiMentor
      * @throws ApiError
@@ -503,6 +624,9 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
+     * **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * Create a new LTI Mentor
      * @returns LtiMentor
      * @throws ApiError
@@ -520,6 +644,9 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
+     * **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/{id}/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/{id}/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * Get details about a specific LTI Mentor
      * @returns LtiMentor
      * @throws ApiError
@@ -546,6 +673,9 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
+     * **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/{id}/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/{id}/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * Update an LTI Mentor
      * @returns LtiMentor
      * @throws ApiError
@@ -568,6 +698,9 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
+     * **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/{id}/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/{id}/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * Delete an LTI Mentor
      * @returns void
      * @throws ApiError
@@ -1832,6 +1965,63 @@ export class CoreService {
             url: '/api/core/rbac/actions/tree/',
         });
     }
+    /**
+     * Get mentor access status
+     * Retrieve current access information for a specific mentor, including all groups and users that have access with their respective roles.
+     * @returns MentorPolicy
+     * @throws ApiError
+     */
+    public static coreRbacAgentAccessList({
+        mentorId,
+        platformKey,
+    }: {
+        /**
+         * ID of the mentor to get access information for
+         */
+        mentorId: number,
+        /**
+         * Platform key where the mentor belongs
+         */
+        platformKey: string,
+    }): CancelablePromise<Array<MentorPolicy>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/rbac/agent-access/',
+            query: {
+                'mentor_id': mentorId,
+                'platform_key': platformKey,
+            },
+            errors: {
+                400: `Missing or invalid query parameters`,
+                403: `Permission denied - ShareMentor permission required`,
+                404: `Platform not found`,
+                500: `Internal server error`,
+            },
+        });
+    }
+    /**
+     * Control which RbacGroups and/or Users have access to a mentor and with what Role
+     * Create or update RBAC policies to manage group and user access to specific mentors. Creates role-specific policies and handles adding/removing groups and users.
+     * @returns MentorPolicy
+     * @throws ApiError
+     */
+    public static coreRbacAgentAccessCreate({
+        requestBody,
+    }: {
+        requestBody: MentorPolicy,
+    }): CancelablePromise<MentorPolicy> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/rbac/agent-access/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Invalid request data or validation errors`,
+                403: `Permission denied - ShareMentor permission required`,
+                404: `Platform or mentor not found`,
+            },
+        });
+    }
     /**
      * List RBAC groups
      * Retrieve a list of RBAC groups. Can be filtered by platform_key, owner, name, username, or email. Use include_users to control response payload.
@@ -2050,7 +2240,10 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
      * Get mentor access status
+     * **Deprecated — use `/api/core/rbac/agent-access/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/rbac/agent-access/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * Retrieve current access information for a specific mentor, including all groups and users that have access with their respective roles.
      * @returns MentorPolicy
      * @throws ApiError
@@ -2084,7 +2277,10 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
      * Control which RbacGroups and/or Users have access to a mentor and with what Role
+     * **Deprecated — use `/api/core/rbac/agent-access/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/rbac/agent-access/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * Create or update RBAC policies to manage group and user access to specific mentors. Creates role-specific policies and handles adding/removing groups and users.
      * @returns MentorPolicy
      * @throws ApiError
@@ -2545,6 +2741,56 @@ export class CoreService {
             },
         });
     }
+    /**
+     * Set student mentor creation permission
+     * Enable or disable the ability for students to create mentors on a platform
+     * @returns StudentMentorCreationPermissionResponse
+     * @throws ApiError
+     */
+    public static coreRbacStudentAgentCreationSetCreate({
+        requestBody,
+    }: {
+        requestBody: SetStudentMentorCreationPermission,
+    }): CancelablePromise<StudentMentorCreationPermissionResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/rbac/student-agent-creation/set/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Invalid request data`,
+                403: `Permission denied - Tenant Admin access required`,
+                404: `Platform, students group, or mentor creators policy not found`,
+            },
+        });
+    }
+    /**
+     * Get student mentor creation permission status
+     * Check whether students are currently allowed to create mentors on a platform
+     * @returns StudentMentorCreationPermissionResponse
+     * @throws ApiError
+     */
+    public static coreRbacStudentAgentCreationStatusRetrieve({
+        platformKey,
+    }: {
+        /**
+         * The platform key to check
+         */
+        platformKey: string,
+    }): CancelablePromise<StudentMentorCreationPermissionResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/rbac/student-agent-creation/status/',
+            query: {
+                'platform_key': platformKey,
+            },
+            errors: {
+                400: `Missing platform_key parameter`,
+                403: `Permission denied - Tenant Admin access required`,
+                404: `Platform not found`,
+            },
+        });
+    }
     /**
      * Set student LLM access permissions
      * Configure which LLM resources students can access on a platform by replacing the LLM Users policy resources
@@ -2596,7 +2842,10 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
      * Set student mentor creation permission
+     * **Deprecated — use `/api/core/rbac/student-agent-creation/set/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/rbac/student-agent-creation/set/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * Enable or disable the ability for students to create mentors on a platform
      * @returns StudentMentorCreationPermissionResponse
      * @throws ApiError
@@ -2619,7 +2868,10 @@ export class CoreService {
         });
     }
     /**
+     * @deprecated
      * Get student mentor creation permission status
+     * **Deprecated — use `/api/core/rbac/student-agent-creation/status/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/rbac/student-agent-creation/status/` (`mentor` → `agent`) and will be removed in a future release.
+     *
      * Check whether students are currently allowed to create mentors on a platform
      * @returns StudentMentorCreationPermissionResponse
      * @throws ApiError