@iblai/iblai-api 4.68.1-core → 4.68.1-test-ai

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

@@ -0,0 +1,472 @@
+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';
+export declare class AiAccountService {
+    /**
+     * @returns ConnectedService Callback for the OAuth flow
+     * @throws ApiError
+     */
+    static aiAccountConnectedServicesCallbackRetrieve(): CancelablePromise<ConnectedService>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @returns OAuthStartResponse Starts the OAuth flow for the given provider and service
+     * @throws ApiError
+     */
+    static aiAccountConnectedServicesOrgsUsersRetrieve({ org, provider, service, userId, }: {
+        org: string;
+        provider: string;
+        service: string;
+    }): CancelablePromise<OAuthStartResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsCredentialRetrieve({ org, name, }: {
+        org: string;
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string;
+    }): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsCredentialCreate({ org, requestBody, }: {
+        org: string;
+        requestBody: LLMCredentialRequest;
+    }): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsCredentialPartialUpdate({ org, requestBody, }: {
+        org: string;
+        requestBody?: PatchedLLMCredentialRequest;
+    }): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsCredentialDestroy({ org, }: {
+        org: string;
+    }): CancelablePromise<void>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsCredentialSchemaRetrieve({ org, name, }: {
+        org: string;
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string;
+    }): CancelablePromise<LLMCredentialSchema>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsIntegrationCredentialRetrieve({ org, name, }: {
+        org: string;
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string;
+    }): CancelablePromise<IntegrationCredential>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsIntegrationCredentialCreate({ org, requestBody, }: {
+        org: string;
+        requestBody: CredentialRequest;
+    }): CancelablePromise<IntegrationCredential>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsIntegrationCredentialPartialUpdate({ org, requestBody, }: {
+        org: string;
+        requestBody?: PatchedCredentialRequest;
+    }): CancelablePromise<IntegrationCredential>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsIntegrationCredentialDestroy({ org, }: {
+        org: string;
+    }): CancelablePromise<void>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsIntegrationCredentialSchemaRetrieve({ org, name, }: {
+        org: string;
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string;
+    }): CancelablePromise<IntegrationCredentialSchema>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsLlmCredentialRetrieve({ org, name, }: {
+        org: string;
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string;
+    }): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsLlmCredentialCreate({ org, requestBody, }: {
+        org: string;
+        requestBody: LLMCredentialRequest;
+    }): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsLlmCredentialPartialUpdate({ org, requestBody, }: {
+        org: string;
+        requestBody?: PatchedLLMCredentialRequest;
+    }): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsLlmCredentialDestroy({ org, }: {
+        org: string;
+    }): CancelablePromise<void>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsMaskedIntegrationCredentialList({ org, name, }: {
+        org: string;
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string;
+    }): CancelablePromise<Array<MaskedIntegrationCredential>>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsMaskedLlmCredentialRetrieve({ org, name, }: {
+        org: string;
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string;
+    }): CancelablePromise<MaskedLLMCredential>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsUseDefaultLlmKeyCreate({ org, requestBody, }: {
+        org: string;
+        requestBody: UseMainCreds;
+    }): CancelablePromise<{
+        message?: string;
+    }>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsUseFreeTrialCreate({ org, }: {
+        org: string;
+    }): CancelablePromise<any>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsUsersDefaultLlmKeyUsageRetrieve({ org, userId, }: {
+        org: string;
+    }): CancelablePromise<any>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsUsersFreeTrialRetrieve({ org, userId, }: {
+        org: string;
+        userId: string;
+    }): CancelablePromise<{
+        is_in_free_trial?: boolean;
+    }>;
+}