@iblai/iblai-api 4.14.2-loadtest-core → 4.14.2-loadtest-ai

package/src/services/AiAccountService.ts

@@ -0,0 +1,755 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ConnectedService } from '../models/ConnectedService';
+import type { CredentialRequest } from '../models/CredentialRequest';
+import type { IntegrationCredential } from '../models/IntegrationCredential';
+import type { IntegrationCredentialSchema } from '../models/IntegrationCredentialSchema';
+import type { LLMCredentialRequest } from '../models/LLMCredentialRequest';
+import type { LLMCredentialResponse } from '../models/LLMCredentialResponse';
+import type { LLMCredentialSchema } from '../models/LLMCredentialSchema';
+import type { MaskedIntegrationCredential } from '../models/MaskedIntegrationCredential';
+import type { MaskedLLMCredential } from '../models/MaskedLLMCredential';
+import type { OAuthStartResponse } from '../models/OAuthStartResponse';
+import type { PatchedCredentialRequest } from '../models/PatchedCredentialRequest';
+import type { PatchedLLMCredentialRequest } from '../models/PatchedLLMCredentialRequest';
+import type { UseMainCreds } from '../models/UseMainCreds';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AiAccountService {
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @returns ConnectedService Callback for the OAuth flow
+     * @throws ApiError
+     */
+    public static aiAccountConnectedServicesCallbackRetrieve(): CancelablePromise<ConnectedService> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/connected-services/callback/',
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @returns OAuthStartResponse Starts the OAuth flow for the given provider and service
+     * @throws ApiError
+     */
+    public static aiAccountConnectedServicesOrgsUsersRetrieve({
+        org,
+        provider,
+        service,
+        userId,
+    }: {
+        org: string,
+        provider: string,
+        service: string,
+        userId: string,
+    }): CancelablePromise<OAuthStartResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/connected-services/orgs/{org}/users/{user_id}/{provider}/{service}/',
+            path: {
+                'org': org,
+                'provider': provider,
+                'service': service,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * Retrieve LLM credentials for an organization.
+     *
+     * Query Parameters:
+     * name (optional): Filter results by LLM provider name
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of LLM credentials for the organization
+     *
+     * Raises:
+     * NotFound: When organization is not found or when no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialRetrieve({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/credential/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Create a new LLM credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Created LLM credential
+     *
+     * Raises:
+     * NotFound: When organization is not found
+     * ValidationError: When request data is invalid
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialCreate({
+        org,
+        requestBody,
+    }: {
+        org: string,
+        requestBody: LLMCredentialRequest,
+    }): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update an existing LLM credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing updated credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Updated LLM credential
+     *
+     * Raises:
+     * NotFound: When organization or credential is not found
+     * ValidationError: When request data is invalid
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialPartialUpdate({
+        org,
+        requestBody,
+    }: {
+        org: string,
+        requestBody?: PatchedLLMCredentialRequest,
+    }): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/ai-account/orgs/{org}/credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete an existing LLM credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing credential information (must include 'name')
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: 204
+     *
+     * Raises:
+     * NotFound: When organization or credential is not found
+     * ValidationError: When request data is invalid
+     * @returns void
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialDestroy({
+        org,
+    }: {
+        org: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/ai-account/orgs/{org}/credential/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Retrieve LLM credentials schemas.
+     *
+     * Query Parameters:
+     * name (optional): Filter results by LLM service name
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of integration credentials schema available.
+     *
+     * Raises:
+     * NotFound: When  no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns LLMCredentialSchema
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialSchemaRetrieve({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<LLMCredentialSchema> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/credential/schema/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Retrieve integration credentials for an organization.
+     *
+     * 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 for the organization
+     *
+     * Raises:
+     * NotFound: When organization is not found or when no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns IntegrationCredential
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialRetrieve({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<IntegrationCredential> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/integration-credential/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Create a new integration credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Created integration credential
+     *
+     * Raises:
+     * NotFound: When organization is not found
+     * ValidationError: When request data is invalid
+     * @returns IntegrationCredential
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialCreate({
+        org,
+        requestBody,
+    }: {
+        org: string,
+        requestBody: CredentialRequest,
+    }): CancelablePromise<IntegrationCredential> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/integration-credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update an existing integration credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing updated credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Updated integration credential
+     *
+     * Raises:
+     * NotFound: When organization or credential is not found
+     * ValidationError: When request data is invalid
+     * @returns IntegrationCredential
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialPartialUpdate({
+        org,
+        requestBody,
+    }: {
+        org: string,
+        requestBody?: PatchedCredentialRequest,
+    }): CancelablePromise<IntegrationCredential> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/ai-account/orgs/{org}/integration-credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete an existing integration credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing credential information (must include 'name')
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: 204
+     *
+     * Raises:
+     * NotFound: When organization or credential is not found
+     * ValidationError: When request data is invalid
+     * @returns void
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialDestroy({
+        org,
+    }: {
+        org: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/ai-account/orgs/{org}/integration-credential/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Retrieve integration credentials schema for.
+     *
+     * 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 available.
+     *
+     * Raises:
+     * NotFound: When  no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns IntegrationCredentialSchema
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialSchemaRetrieve({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<IntegrationCredentialSchema> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/integration-credential/schema/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Retrieve LLM credentials for an organization.
+     *
+     * Query Parameters:
+     * name (optional): Filter results by LLM provider name
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of LLM credentials for the organization
+     *
+     * Raises:
+     * NotFound: When organization is not found or when no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsLlmCredentialRetrieve({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/llm-credential/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Create a new LLM credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Created LLM credential
+     *
+     * Raises:
+     * NotFound: When organization is not found
+     * ValidationError: When request data is invalid
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsLlmCredentialCreate({
+        org,
+        requestBody,
+    }: {
+        org: string,
+        requestBody: LLMCredentialRequest,
+    }): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/llm-credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update an existing LLM credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing updated credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Updated LLM credential
+     *
+     * Raises:
+     * NotFound: When organization or credential is not found
+     * ValidationError: When request data is invalid
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsLlmCredentialPartialUpdate({
+        org,
+        requestBody,
+    }: {
+        org: string,
+        requestBody?: PatchedLLMCredentialRequest,
+    }): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/ai-account/orgs/{org}/llm-credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete an existing LLM credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing credential information (must include 'name')
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: 204
+     *
+     * Raises:
+     * NotFound: When organization or credential is not found
+     * ValidationError: When request data is invalid
+     * @returns void
+     * @throws ApiError
+     */
+    public static aiAccountOrgsLlmCredentialDestroy({
+        org,
+    }: {
+        org: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/ai-account/orgs/{org}/llm-credential/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Retrieve masked integration credentials for an organization.
+     *
+     * 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 for the organization
+     *
+     * Raises:
+     * NotFound: When organization is not found or when no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns MaskedIntegrationCredential
+     * @throws ApiError
+     */
+    public static aiAccountOrgsMaskedIntegrationCredentialList({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<Array<MaskedIntegrationCredential>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/masked-integration-credential/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Retrieve LLM credentials for an organization with the value entries masked.
+     *
+     * Query Parameters:
+     * name (optional): Filter results by LLM provider name
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of LLM credentials for the organization
+     *
+     * Raises:
+     * NotFound: When organization is not found or when no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns MaskedLLMCredential
+     * @throws ApiError
+     */
+    public static aiAccountOrgsMaskedLlmCredentialRetrieve({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<MaskedLLMCredential> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/masked-llm-credential/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Enable or disable the use of main LLM credentials for an organization.
+     *
+     * Request Body:
+     * enable (boolean): Set to true to enable main credentials
+     * disable (boolean): Set to true to disable main credentials
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Confirmation message
+     *
+     * Raises:
+     * ValidationError: When neither enable nor disable is specified
+     * @returns any
+     * @throws ApiError
+     */
+    public static aiAccountOrgsUseDefaultLlmKeyCreate({
+        org,
+        requestBody,
+    }: {
+        org: string,
+        requestBody: UseMainCreds,
+    }): CancelablePromise<{
+        message?: string;
+    }> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/use-default-llm-key/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Enable, disable, or update free trial settings for an organization.
+     *
+     * Request Body:
+     * enable (boolean): Set to true to enable free trial
+     * disable (boolean): Set to true to disable free trial
+     * metadata (object, optional): Additional metadata for the free trial
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Confirmation message
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static aiAccountOrgsUseFreeTrialCreate({
+        org,
+    }: {
+        org: string,
+    }): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/use-free-trial/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Retrieve the status of main LLM credential usage for an organization.
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     * user_id: User identifier
+     *
+     * Returns:
+     * Response: Status of main LLM credential usage
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static aiAccountOrgsUsersDefaultLlmKeyUsageRetrieve({
+        org,
+        userId,
+    }: {
+        org: string,
+        userId: string,
+    }): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/users/{user_id}/default-llm-key-usage',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * Retrieve the free trial status for an organization.
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Free trial status (boolean)
+     *
+     * Raises:
+     * NotFound: When organization is not found
+     * @returns any
+     * @throws ApiError
+     */
+    public static aiAccountOrgsUsersFreeTrialRetrieve({
+        org,
+        userId,
+    }: {
+        org: string,
+        userId: string,
+    }): CancelablePromise<{
+        is_in_free_trial?: boolean;
+    }> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/users/{user_id}/free-trial',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+        });
+    }
+}