@nestbox-ai/documents 1.0.49 → 1.0.60

package/common.ts

@@ -12,22 +12,16 @@
  * Do not edit the class manually.
  */
 
-
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
 import { RequiredError } from "./base";
 
-/**
- *
- * @export
- */
 export const DUMMY_BASE_URL = 'https://example.com'
 
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
     if (paramValue === null || paramValue === undefined) {
@@ -35,10 +29,6 @@ export const assertParamExists = function (functionName: string, paramName: stri
     }
 }
 
-/**
- *
- * @export
- */
 export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -48,20 +38,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri
     }
 }
 
-/**
- *
- * @export
- */
 export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 }
 
-/**
- *
- * @export
- */
 export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -71,10 +53,6 @@ export const setBearerAuthToObject = async function (object: any, configuration?
     }
 }
 
-/**
- *
- * @export
- */
 export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -84,10 +62,11 @@ export const setOAuthToObject = async function (object: any, name: string, scope
     }
 }
 
+
 function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
     if (parameter == null) return;
     if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
             (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
         }
         else {
@@ -106,10 +85,6 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
     }
 }
 
-/**
- *
- * @export
- */
 export const setSearchParams = function (url: URL, ...objects: any[]) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
@@ -117,31 +92,32 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
 }
 
 /**
- *
- * @export
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
  */
+export const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    } else {
+        return value;
+    }
+}
+
 export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
         ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
         : nonString;
     return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {})
+        ? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
         : (value || "");
 }
 
-/**
- *
- * @export
- */
 export const toPathString = function (url: URL) {
     return url.pathname + url.search + url.hash
 }
 
-/**
- *
- * @export
- */
 export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
     return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
         const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};

package/configuration.ts

@@ -1,5 +1,4 @@
 /* tslint:disable */
-/* eslint-disable */
 /**
  * Nestbox API Documents API
  * API for Nestbox Documents, control your documents
@@ -12,12 +11,24 @@
  * Do not edit the class manually.
  */
 
+interface AWSv4Configuration {
+  options?: {
+    region?: string
+    service?: string
+  }
+  credentials?: {
+    accessKeyId?: string
+    secretAccessKey?: string,
+    sessionToken?: string
+  }
+}
 
 export interface ConfigurationParameters {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
     basePath?: string;
     serverIndex?: number;
     baseOptions?: any;
@@ -28,49 +39,43 @@ export class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
-     * override base path
-     *
-     * @type {string}
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
      * @memberof Configuration
      */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**
@@ -87,6 +92,7 @@ export class Configuration {
         this.username = param.username;
         this.password = param.password;
         this.accessToken = param.accessToken;
+        this.awsv4 = param.awsv4;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
         this.baseOptions = {

package/dist/api.d.ts

@@ -13,212 +13,51 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
-/**
- *
- * @export
- * @interface BadRequestExceptionResponse
- */
 export interface BadRequestExceptionResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof BadRequestExceptionResponse
-     */
     'message': string;
-    /**
-     *
-     * @type {object}
-     * @memberof BadRequestExceptionResponse
-     */
     'errors': object | null;
 }
-/**
- *
- * @export
- * @interface ChunkFileRequestDTO
- */
 export interface ChunkFileRequestDTO {
-    /**
-     *
-     * @type {string}
-     * @memberof ChunkFileRequestDTO
-     */
     'type': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ChunkFileRequestDTO
-     */
     'url': string;
-    /**
-     *
-     * @type {object}
-     * @memberof ChunkFileRequestDTO
-     */
     'options': object;
 }
-/**
- *
- * @export
- * @interface CreateCollectionRequestDTO
- */
 export interface CreateCollectionRequestDTO {
-    /**
-     *
-     * @type {string}
-     * @memberof CreateCollectionRequestDTO
-     */
     'name': string;
-    /**
-     *
-     * @type {object}
-     * @memberof CreateCollectionRequestDTO
-     */
     'metadata': object;
 }
-/**
- *
- * @export
- * @interface CreateDocumentRequestDTO
- */
 export interface CreateDocumentRequestDTO {
-    /**
-     *
-     * @type {string}
-     * @memberof CreateDocumentRequestDTO
-     */
     'id': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CreateDocumentRequestDTO
-     */
     'document': string;
-    /**
-     *
-     * @type {object}
-     * @memberof CreateDocumentRequestDTO
-     */
     'metadata': object;
 }
-/**
- *
- * @export
- * @interface FatalErrorExceptionResponse
- */
 export interface FatalErrorExceptionResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof FatalErrorExceptionResponse
-     */
     'message': string;
 }
-/**
- *
- * @export
- * @interface ForbiddenExceptionResponse
- */
 export interface ForbiddenExceptionResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof ForbiddenExceptionResponse
-     */
     'message': string;
 }
-/**
- *
- * @export
- * @interface MessageResponseDTO
- */
 export interface MessageResponseDTO {
-    /**
-     *
-     * @type {string}
-     * @memberof MessageResponseDTO
-     */
     'message': string;
 }
-/**
- *
- * @export
- * @interface NotFoundExceptionResponse
- */
 export interface NotFoundExceptionResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof NotFoundExceptionResponse
-     */
     'message': string;
 }
-/**
- *
- * @export
- * @interface SimilaritySearchQueryDTO
- */
 export interface SimilaritySearchQueryDTO {
-    /**
-     *
-     * @type {string}
-     * @memberof SimilaritySearchQueryDTO
-     */
     'query': string;
-    /**
-     *
-     * @type {object}
-     * @memberof SimilaritySearchQueryDTO
-     */
     'params': object;
-    /**
-     *
-     * @type {object}
-     * @memberof SimilaritySearchQueryDTO
-     */
     'filter': object;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof SimilaritySearchQueryDTO
-     */
     'include': Array<string>;
 }
-/**
- *
- * @export
- * @interface UnauthorizedExceptionResponse
- */
 export interface UnauthorizedExceptionResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof UnauthorizedExceptionResponse
-     */
     'message': string;
 }
-/**
- *
- * @export
- * @interface UpdateDocumentRequestDTO
- */
 export interface UpdateDocumentRequestDTO {
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateDocumentRequestDTO
-     */
     'document': string;
-    /**
-     *
-     * @type {object}
-     * @memberof UpdateDocumentRequestDTO
-     */
     'metadata': object;
 }
 /**
  * AppApi - axios parameter creator
- * @export
  */
 export declare const AppApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -230,7 +69,6 @@ export declare const AppApiAxiosParamCreator: (configuration?: Configuration) =>
 };
 /**
  * AppApi - functional programming interface
- * @export
  */
 export declare const AppApiFp: (configuration?: Configuration) => {
     /**
@@ -242,7 +80,6 @@ export declare const AppApiFp: (configuration?: Configuration) => {
 };
 /**
  * AppApi - factory interface
- * @export
  */
 export declare const AppApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -254,22 +91,17 @@ export declare const AppApiFactory: (configuration?: Configuration, basePath?: s
 };
 /**
  * AppApi - object-oriented interface
- * @export
- * @class AppApi
- * @extends {BaseAPI}
  */
 export declare class AppApi extends BaseAPI {
     /**
      *
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof AppApi
      */
-    appControllerGetHello(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    appControllerGetHello(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
 }
 /**
  * CollectionApi - axios parameter creator
- * @export
  */
 export declare const CollectionApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -379,7 +211,6 @@ export declare const CollectionApiAxiosParamCreator: (configuration?: Configurat
 };
 /**
  * CollectionApi - functional programming interface
- * @export
  */
 export declare const CollectionApiFp: (configuration?: Configuration) => {
     /**
@@ -489,7 +320,6 @@ export declare const CollectionApiFp: (configuration?: Configuration) => {
 };
 /**
  * CollectionApi - factory interface
- * @export
  */
 export declare const CollectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -599,9 +429,6 @@ export declare const CollectionApiFactory: (configuration?: Configuration, baseP
 };
 /**
  * CollectionApi - object-oriented interface
- * @export
- * @class CollectionApi
- * @extends {BaseAPI}
  */
 export declare class CollectionApi extends BaseAPI {
     /**
@@ -611,9 +438,8 @@ export declare class CollectionApi extends BaseAPI {
      * @param {CreateDocumentRequestDTO} createDocumentRequestDTO
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerAddDocToCollection(collectionId: string, createDocumentRequestDTO: CreateDocumentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerAddDocToCollection(collectionId: string, createDocumentRequestDTO: CreateDocumentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Use a file to chunk and add to collection
@@ -621,27 +447,24 @@ export declare class CollectionApi extends BaseAPI {
      * @param {ChunkFileRequestDTO} chunkFileRequestDTO
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerChunkFileToCollection(collectionId: string, chunkFileRequestDTO: ChunkFileRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerChunkFileToCollection(collectionId: string, chunkFileRequestDTO: ChunkFileRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Create a new collection
      * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerCreateCollection(createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerCreateCollection(createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Delete a collection
      * @param {string} collectionId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerDeleteCollection(collectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerDeleteCollection(collectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Delete doc by ID
@@ -649,9 +472,8 @@ export declare class CollectionApi extends BaseAPI {
      * @param {string} docId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerDeleteDoc(collectionId: string, docId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerDeleteDoc(collectionId: string, docId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Delete docs based on metadata filter
@@ -659,26 +481,23 @@ export declare class CollectionApi extends BaseAPI {
      * @param {string} filter
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerDeleteDocsByMetadata(collectionId: string, filter: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerDeleteDocsByMetadata(collectionId: string, filter: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Get a collection info
      * @param {string} collectionId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerGetCollection(collectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerGetCollection(collectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary List all collections
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerGetCollections(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerGetCollections(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Retrieve doc by ID
@@ -686,9 +505,8 @@ export declare class CollectionApi extends BaseAPI {
      * @param {string} docId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerGetDocById(collectionId: string, docId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerGetDocById(collectionId: string, docId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Similarity search query
@@ -696,9 +514,8 @@ export declare class CollectionApi extends BaseAPI {
      * @param {SimilaritySearchQueryDTO} similaritySearchQueryDTO
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerSimilaritySearch(collectionId: string, similaritySearchQueryDTO: SimilaritySearchQueryDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerSimilaritySearch(collectionId: string, similaritySearchQueryDTO: SimilaritySearchQueryDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Updates a collection
@@ -706,9 +523,8 @@ export declare class CollectionApi extends BaseAPI {
      * @param {CreateCollectionRequestDTO} createCollectionRequestDTO
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerUpdateCollection(collectionId: string, createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerUpdateCollection(collectionId: string, createCollectionRequestDTO: CreateCollectionRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
     /**
      *
      * @summary Update or upsert doc
@@ -717,7 +533,6 @@ export declare class CollectionApi extends BaseAPI {
      * @param {UpdateDocumentRequestDTO} updateDocumentRequestDTO
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof CollectionApi
      */
-    collectionControllerUpdateDoc(collectionId: string, docId: string, updateDocumentRequestDTO: UpdateDocumentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any>>;
+    collectionControllerUpdateDoc(collectionId: string, docId: string, updateDocumentRequestDTO: UpdateDocumentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponseDTO, any, {}>>;
 }