@iblai/iblai-api 3.48.3-ai-plus → 3.48.4-ai

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

@@ -32,13 +32,13 @@ export declare class AiIndexService {
      *
      * Raises:
      * NotFound: If the specified document embedding does not exist.
-     * @param documentId
-     * @param org
-     * @param userId
      * @returns RetrieverDocumentEmbedding
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsRetrieve(documentId: string, org: string, userId: string): CancelablePromise<RetrieverDocumentEmbedding>;
+    static aiIndexOrgsUsersDocumentsRetrieve({ documentId, org, userId, }: {
+        documentId: string;
+        org: string;
+    }): CancelablePromise<RetrieverDocumentEmbedding>;
     /**
      * Update a specific document embedding.
      *
@@ -56,14 +56,14 @@ export declare class AiIndexService {
      * Raises:
      * BadRequest: If the provided data is invalid.
      * NotFound: If the specified document embedding does not exist.
-     * @param documentId
-     * @param org
-     * @param userId
-     * @param formData
      * @returns RetrieverDocumentEmbedding
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsUpdate(documentId: string, org: string, userId: string, formData: RetrieverDocumentEmbeddingRequest): CancelablePromise<RetrieverDocumentEmbedding>;
+    static aiIndexOrgsUsersDocumentsUpdate({ documentId, org, userId, formData, }: {
+        documentId: string;
+        org: string;
+        formData: RetrieverDocumentEmbeddingRequest;
+    }): CancelablePromise<RetrieverDocumentEmbedding>;
     /**
      * Delete a specific document embedding.
      *
@@ -80,32 +80,32 @@ export declare class AiIndexService {
      *
      * Raises:
      * NotFound: If the specified document embedding does not exist.
-     * @param documentId
-     * @param org
-     * @param userId
      * @returns void
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsDestroy(documentId: string, org: string, userId: string): CancelablePromise<void>;
+    static aiIndexOrgsUsersDocumentsDestroy({ documentId, org, userId, }: {
+        documentId: string;
+        org: string;
+    }): CancelablePromise<void>;
     /**
      * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @param documentId
-     * @param org
-     * @param userId
      * @returns DocumentSettingsResponse
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsSettingsRetrieve(documentId: string, org: string, userId: string): CancelablePromise<DocumentSettingsResponse>;
+    static aiIndexOrgsUsersDocumentsSettingsRetrieve({ documentId, org, userId, }: {
+        documentId: string;
+        org: string;
+    }): CancelablePromise<DocumentSettingsResponse>;
     /**
      * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @param documentId
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns DocumentSettingsResponse
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsSettingsCreate(documentId: string, org: string, userId: string, requestBody?: DocumentSettingsResponse): CancelablePromise<DocumentSettingsResponse>;
+    static aiIndexOrgsUsersDocumentsSettingsCreate({ documentId, org, userId, requestBody, }: {
+        documentId: string;
+        org: string;
+        requestBody?: DocumentSettingsResponse;
+    }): CancelablePromise<DocumentSettingsResponse>;
     /**
      * Train a graph-based document through a worker process.
      *
@@ -123,13 +123,13 @@ export declare class AiIndexService {
      * Raises:
      * ValidationError: If the request data is invalid.
      * BadRequest: If there was an error processing the document.
-     * @param org
-     * @param userId
-     * @param formData
      * @returns TrainDocumentViewResponse
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsGraphTrainCreate(org: string, userId: string, formData: TrainDocumentViewRequest): CancelablePromise<TrainDocumentViewResponse>;
+    static aiIndexOrgsUsersDocumentsGraphTrainCreate({ org, userId, formData, }: {
+        org: string;
+        formData: TrainDocumentViewRequest;
+    }): CancelablePromise<TrainDocumentViewResponse>;
     /**
      * Description:
      * Retrieves a list of document embeddings for a specific pathway with optional search and pagination.
@@ -160,16 +160,22 @@ export declare class AiIndexService {
                  * Error Responses:
                  * - 400 Bad Request: Invalid query parameters.
                  * - 404 Not Found: No document embeddings found for the specified criteria.
-                 * @param org
-                 * @param pathway
-                 * @param userId
-                 * @param limit limit number
-                 * @param offset Offset number
-                 * @param search Search query
                  * @returns RetrieverDocumentEmbedding
                  * @throws ApiError
                  */
-    static aiIndexOrgsUsersDocumentsPathwaysList(org: string, pathway: string, userId: string, limit?: number, offset?: number, search?: string): CancelablePromise<Array<RetrieverDocumentEmbedding>>;
+    static aiIndexOrgsUsersDocumentsPathwaysList({ org, pathway, userId, limit, offset, search, }: {
+        org: string;
+        pathway: string; /**
+         * limit number
+         */
+        limit?: number; /**
+         * Offset number
+         */
+        offset?: number; /**
+         * Search query
+         */
+        search?: string;
+    }): CancelablePromise<Array<RetrieverDocumentEmbedding>>;
     /**
      * Retrieve resource documents similar to the given query.
      *
@@ -185,13 +191,13 @@ export declare class AiIndexService {
      *
      * Raises:
      * ValidationError: If the request data is invalid.
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns RetrieverResponseSearch
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsSearchCreate(org: string, userId: string, requestBody: RetrieverRequestSearch): CancelablePromise<RetrieverResponseSearch>;
+    static aiIndexOrgsUsersDocumentsSearchCreate({ org, userId, requestBody, }: {
+        org: string;
+        requestBody: RetrieverRequestSearch;
+    }): CancelablePromise<RetrieverResponseSearch>;
     /**
      * Retrieve document sources related to a given query.
      *
@@ -208,13 +214,13 @@ export declare class AiIndexService {
      *
      * Raises:
      * ValidationError: If the request data is invalid.
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns RetrieverRequestSearchDocument
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsSourcesCreate(org: string, userId: string, requestBody: RetrieverRequestSearch): CancelablePromise<Array<RetrieverRequestSearchDocument>>;
+    static aiIndexOrgsUsersDocumentsSourcesCreate({ org, userId, requestBody, }: {
+        org: string;
+        requestBody: RetrieverRequestSearch;
+    }): CancelablePromise<Array<RetrieverRequestSearchDocument>>;
     /**
      * Check the status of a document training task.
      *
@@ -229,13 +235,13 @@ export declare class AiIndexService {
      * Returns:
      * Response: The current status of the document training task,
      * which can be "pending", "completed", or "failed".
-     * @param org
-     * @param taskId
-     * @param userId
      * @returns CheckDocumentTrainingStatus
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsTasksRetrieve(org: string, taskId: string, userId: string): CancelablePromise<CheckDocumentTrainingStatus>;
+    static aiIndexOrgsUsersDocumentsTasksRetrieve({ org, taskId, userId, }: {
+        org: string;
+        taskId: string;
+    }): CancelablePromise<CheckDocumentTrainingStatus>;
     /**
      * Train a document through a worker process.
      *
@@ -254,13 +260,13 @@ export declare class AiIndexService {
      * Raises:
      * ValidationError: If the request data is invalid.
      * BadRequest: If there was an error processing the document.
-     * @param org
-     * @param userId
-     * @param formData
      * @returns TrainDocumentViewResponse
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsTrainCreate(org: string, userId: string, formData: TrainDocumentViewRequest): CancelablePromise<TrainDocumentViewResponse>;
+    static aiIndexOrgsUsersDocumentsTrainCreate({ org, userId, formData, }: {
+        org: string;
+        formData: TrainDocumentViewRequest;
+    }): CancelablePromise<TrainDocumentViewResponse>;
     /**
      * Train a document directly without using a worker.
      *
@@ -278,13 +284,13 @@ export declare class AiIndexService {
      * Raises:
      * ValidationError: If the request data is invalid.
      * BadRequest: If the document training failed.
-     * @param org
-     * @param userId
-     * @param formData
      * @returns RetreiverTrainViewResponse
      * @throws ApiError
      */
-    static aiIndexOrgsUsersDocumentsTrainRetrieverCreate(org: string, userId: string, formData: RetreiverTrainViewRequest): CancelablePromise<RetreiverTrainViewResponse>;
+    static aiIndexOrgsUsersDocumentsTrainRetrieverCreate({ org, userId, formData, }: {
+        org: string;
+        formData: RetreiverTrainViewRequest;
+    }): CancelablePromise<RetreiverTrainViewResponse>;
     /**
      * Description:
      * Submit a document file  in a chat session. Checks file type, size, and ensures the session exists, then processes the file.
@@ -319,14 +325,14 @@ export declare class AiIndexService {
          *
          * Access Control:
          * Requires authentication with a Bearer token in the Authorization header. The user associated with the session must exist and be authorized for the request.
-         * @param org
-         * @param sessionId
-         * @param userId
-         * @param formData
          * @returns TrainChatSessionDocumentView
          * @throws ApiError
          */
-    static aiIndexOrgsUsersDocumentsTrainSessionsCreate(org: string, sessionId: string, userId: string, formData: TrainChatSessionDocumentViewRequest): CancelablePromise<TrainChatSessionDocumentView>;
+    static aiIndexOrgsUsersDocumentsTrainSessionsCreate({ org, sessionId, userId, formData, }: {
+        org: string;
+        sessionId: string;
+        formData: TrainChatSessionDocumentViewRequest;
+    }): CancelablePromise<TrainChatSessionDocumentView>;
     /**
      * Retrieve detailed information about a specific scraped resource.
      *
@@ -344,13 +350,13 @@ export declare class AiIndexService {
      *
      * Raises:
      * NotFound: If the specified resource data does not exist.
-     * @param org
-     * @param resourceId
-     * @param userId
      * @returns ResourceScrappedData
      * @throws ApiError
      */
-    static aiIndexOrgsUsersResourceDataScrappedRetrieve(org: string, resourceId: string, userId: string): CancelablePromise<ResourceScrappedData>;
+    static aiIndexOrgsUsersResourceDataScrappedRetrieve({ org, resourceId, userId, }: {
+        org: string;
+        resourceId: string;
+    }): CancelablePromise<ResourceScrappedData>;
     /**
      * Retrieve and filter scraped data from resources.
      *
@@ -367,16 +373,16 @@ export declare class AiIndexService {
      *
      * Raises:
      * BadRequest: If the username is invalid or query parameters are incorrect.
-     * @param org
-     * @param userId
-     * @param isArchive
-     * @param isLike
-     * @param isVideo
-     * @param searchKey
      * @returns ResourceScrappedData
      * @throws ApiError
      */
-    static aiIndexOrgsUsersResourceDataScrappedList(org: string, userId: string, isArchive?: boolean | null, isLike?: boolean | null, isVideo?: boolean | null, searchKey?: string): CancelablePromise<Array<ResourceScrappedData>>;
+    static aiIndexOrgsUsersResourceDataScrappedList({ org, userId, isArchive, isLike, isVideo, searchKey, }: {
+        org: string;
+        isArchive?: boolean | null;
+        isLike?: boolean | null;
+        isVideo?: boolean | null;
+        searchKey?: string;
+    }): CancelablePromise<Array<ResourceScrappedData>>;
     /**
      * Receive and process file scan status from external security scanning services.
      *
@@ -392,9 +398,10 @@ export declare class AiIndexService {
      *
      * Raises:
      * BadRequest: If the provided scan result data is invalid.
-     * @param requestBody
      * @returns ScanWebhookResponse
      * @throws ApiError
      */
-    static aiIndexWebhookScanCreate(requestBody: ScanWebhookRequest): CancelablePromise<ScanWebhookResponse>;
+    static aiIndexWebhookScanCreate({ requestBody, }: {
+        requestBody: ScanWebhookRequest;
+    }): CancelablePromise<ScanWebhookResponse>;
 }

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

@@ -5,30 +5,34 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class AiMarketingService {
     /**
      * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @param org
-     * @param userId
-     * @param page A page number within the paginated result set.
-     * @param pageSize Number of results to return per page.
      * @returns PaginatedHeygenMarketingVideoListList
      * @throws ApiError
      */
-    static aiMarketingOrgsUsersHeygenVideosList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedHeygenMarketingVideoListList>;
+    static aiMarketingOrgsUsersHeygenVideosList({ org, userId, page, pageSize, }: {
+        org: string; /**
+         * A page number within the paginated result set.
+         */
+        page?: number; /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<PaginatedHeygenMarketingVideoListList>;
     /**
      * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns HeygenMarketingVideoList
      * @throws ApiError
      */
-    static aiMarketingOrgsUsersHeygenVideosCreate(org: string, userId: string, requestBody?: HeygenMarketingVideoList): CancelablePromise<HeygenMarketingVideoList>;
+    static aiMarketingOrgsUsersHeygenVideosCreate({ org, userId, requestBody, }: {
+        org: string;
+        requestBody?: HeygenMarketingVideoList;
+    }): CancelablePromise<HeygenMarketingVideoList>;
     /**
      * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @param name
-     * @param org
-     * @param userId
      * @returns HeygenMarketingVideoDetail
      * @throws ApiError
      */
-    static aiMarketingOrgsUsersHeygenVideosRetrieve(name: string, org: string, userId: string): CancelablePromise<HeygenMarketingVideoDetail>;
+    static aiMarketingOrgsUsersHeygenVideosRetrieve({ name, org, userId, }: {
+        name: string;
+        org: string;
+    }): CancelablePromise<HeygenMarketingVideoDetail>;
 }

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

@@ -9,24 +9,26 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class AiMediaService {
     /**
      * API view to list or append Heygen template ids for a tenant.
-     * @param org
-     * @param userId
-     * @param page A page number within the paginated result set.
      * @returns PaginatedHeygenTemplateResponseSingleList
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenTemplatesList(org: string, userId: string, page?: number): CancelablePromise<PaginatedHeygenTemplateResponseSingleList>;
+    static aiMediaOrgsUsersHeygenTemplatesList({ org, userId, page, }: {
+        org: string; /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+    }): CancelablePromise<PaginatedHeygenTemplateResponseSingleList>;
     /**
      * Endpoint to add a Heygen template id to an org.
      *
      * Only platform admins have access to this endpoint.
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns HeygenTemplateResponseSingle
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenTemplatesCreate(org: string, userId: string, requestBody: HeygenTemplateRequest): CancelablePromise<HeygenTemplateResponseSingle>;
+    static aiMediaOrgsUsersHeygenTemplatesCreate({ org, userId, requestBody, }: {
+        org: string;
+        requestBody: HeygenTemplateRequest;
+    }): CancelablePromise<HeygenTemplateResponseSingle>;
     /**
      * Endpoint to delete a Heygen template id for an org.
      *
@@ -35,84 +37,86 @@ export declare class AiMediaService {
      *
      *
      * Only platform admins have access to this endpoint.
-     * @param org
-     * @param templateName
-     * @param userId
      * @returns void
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenTemplatesDestroy(org: string, templateName: string, userId: string): CancelablePromise<void>;
+    static aiMediaOrgsUsersHeygenTemplatesDestroy({ org, templateName, userId, }: {
+        org: string;
+        templateName: string;
+    }): CancelablePromise<void>;
     /**
      * Endpoint to download caption for a video.
-     * @param heygenMarketingVideoId
-     * @param org
-     * @param userId
      * @returns any No response body
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenVideoCaptionsRetrieve(heygenMarketingVideoId: string, org: string, userId: string): CancelablePromise<any>;
+    static aiMediaOrgsUsersHeygenVideoCaptionsRetrieve({ heygenMarketingVideoId, org, userId, }: {
+        heygenMarketingVideoId: string;
+        org: string;
+    }): CancelablePromise<any>;
     /**
      * Endpoint to upload a new caption for a generated video.
      *
      * Only platform admins have access to this endpoint.
-     * @param heygenMarketingVideoId
-     * @param org
-     * @param userId
-     * @param formData
      * @returns HeygenVideoDetail
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenVideoCaptionsCreate(heygenMarketingVideoId: string, org: string, userId: string, formData: VideoCaption): CancelablePromise<HeygenVideoDetail>;
+    static aiMediaOrgsUsersHeygenVideoCaptionsCreate({ heygenMarketingVideoId, org, userId, formData, }: {
+        heygenMarketingVideoId: string;
+        org: string;
+        formData: VideoCaption;
+    }): CancelablePromise<HeygenVideoDetail>;
     /**
      * Endpoint used to download a heygen video.
      *
      *
      * Only platform admins have access to this endpoint.
-     * @param heygenMarketingVideoId
-     * @param org
-     * @param userId
      * @returns any No response body
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenVideoDownloadRetrieve(heygenMarketingVideoId: string, org: string, userId: string): CancelablePromise<any>;
+    static aiMediaOrgsUsersHeygenVideoDownloadRetrieve({ heygenMarketingVideoId, org, userId, }: {
+        heygenMarketingVideoId: string;
+        org: string;
+    }): CancelablePromise<any>;
     /**
      * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @param org
-     * @param userId
-     * @param page A page number within the paginated result set.
      * @returns PaginatedHeygenMarketingVideoListList
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenVideosList(org: string, userId: string, page?: number): CancelablePromise<PaginatedHeygenMarketingVideoListList>;
+    static aiMediaOrgsUsersHeygenVideosList({ org, userId, page, }: {
+        org: string; /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+    }): CancelablePromise<PaginatedHeygenMarketingVideoListList>;
     /**
      * Endpoint to create a Heygen video
      *
      * Only platform admins have access to this endpoint.
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns HeygenVideoDetail
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenVideosCreate(org: string, userId: string, requestBody: HeygenVideoRequest): CancelablePromise<HeygenVideoDetail>;
+    static aiMediaOrgsUsersHeygenVideosCreate({ org, userId, requestBody, }: {
+        org: string;
+        requestBody: HeygenVideoRequest;
+    }): CancelablePromise<HeygenVideoDetail>;
     /**
      * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @param heygenMarketingVideoId
-     * @param org
-     * @param userId
      * @returns HeygenVideoDetail
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenVideosRetrieve(heygenMarketingVideoId: string, org: string, userId: string): CancelablePromise<HeygenVideoDetail>;
+    static aiMediaOrgsUsersHeygenVideosRetrieve({ heygenMarketingVideoId, org, userId, }: {
+        heygenMarketingVideoId: string;
+        org: string;
+    }): CancelablePromise<HeygenVideoDetail>;
     /**
      * Endpoint used to delete a heygen video.
      *
      * Only platform admins have access to this endpoint.
-     * @param heygenMarketingVideoId
-     * @param org
-     * @param userId
      * @returns void
      * @throws ApiError
      */
-    static aiMediaOrgsUsersHeygenVideosDestroy(heygenMarketingVideoId: string, org: string, userId: string): CancelablePromise<void>;
+    static aiMediaOrgsUsersHeygenVideosDestroy({ heygenMarketingVideoId, org, userId, }: {
+        heygenMarketingVideoId: string;
+        org: string;
+    }): CancelablePromise<void>;
 }