/* tslint:disable */
/* eslint-disable */
/**
 * documents
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v2
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import {
  DUMMY_BASE_URL,
  assertParamExists,
  setApiKeyToObject,
  setBasicAuthToObject,
  setBearerAuthToObject,
  setOAuthToObject,
  setSearchParams,
  serializeDataIfNeeded,
  toPathString,
  createRequestFunction,
  replaceWithSerializableTypeIfNeeded,
} from '../common';
// @ts-ignore
import {
  BASE_PATH,
  COLLECTION_FORMATS,
  type RequestArgs,
  BaseAPI,
  RequiredError,
  operationServerMap,
} from '../base';
// @ts-ignore
import type { Document } from '../models';
// @ts-ignore
import type { ErrorResponse } from '../models';
/**
 * DocumentsApi - axios parameter creator
 */
export const DocumentsApiAxiosParamCreator = function (
  configuration?: Configuration,
) {
  return {
    /**
     *
     * @summary Create document
     * @param {File} file The file to be attached for a client.
     * @param {string} [idempotencyKey] Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting.
     * @param {string} [id] The ID or encoded key of the entity that owns the document. The ID or encoded key must belong to the entity indicated by the `entity` parameter. Possible entity types are :`CLIENT`, `GROUP`, `LOAN_PRODUCT`, `SAVINGS_PRODUCT`, `CENTRE`, `BRANCH`, `USER`, `LOAN_ACCOUNT`, `DEPOSIT_ACCOUNT`, `ID_DOCUMENT`, `LINE_OF_CREDIT`, `GL_JOURNAL_ENTRY`. If the entity is `GL_JOURNAL_ENTRY`, the value can also represent the Journal Entry Transaction ID.
     * @param {string} [name] The name (title) of the attached file.
     * @param {string} [notes] The description of the attached file.
     * @param {string} [ownerType] The type of the owner of the document.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createDocument: async (
      file: File,
      idempotencyKey?: string,
      id?: string,
      name?: string,
      notes?: string,
      ownerType?: string,
      options: RawAxiosRequestConfig = {},
    ): Promise<RequestArgs> => {
      // verify required parameter 'file' is not null or undefined
      assertParamExists('createDocument', 'file', file);
      const localVarPath = `/documents`;
      // use dummy base URL string because the URL constructor only accepts absolute URLs.
      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
      let baseOptions;
      if (configuration) {
        baseOptions = configuration.baseOptions;
      }

      const localVarRequestOptions = {
        method: 'POST',
        ...baseOptions,
        ...options,
      };
      const localVarHeaderParameter = {} as any;
      const localVarQueryParameter = {} as any;
      const localVarFormParams = new (
        (configuration && configuration.formDataCtor) ||
        FormData
      )();

      // authentication basic required
      // http basic authentication required
      setBasicAuthToObject(localVarRequestOptions, configuration);

      if (file !== undefined) {
        localVarFormParams.append('file', file as any);
      }

      if (id !== undefined) {
        localVarFormParams.append('id', id as any);
      }

      if (name !== undefined) {
        localVarFormParams.append('name', name as any);
      }

      if (notes !== undefined) {
        localVarFormParams.append('notes', notes as any);
      }

      if (ownerType !== undefined) {
        localVarFormParams.append('ownerType', ownerType as any);
      }
      localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
      localVarHeaderParameter['Accept'] = 'application/vnd.mambu.v2+json';

      if (idempotencyKey != null) {
        localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey);
      }
      setSearchParams(localVarUrlObj, localVarQueryParameter);
      let headersFromBaseOptions =
        baseOptions && baseOptions.headers ? baseOptions.headers : {};
      localVarRequestOptions.headers = {
        ...localVarHeaderParameter,
        ...headersFromBaseOptions,
        ...options.headers,
      };
      localVarRequestOptions.data = localVarFormParams;

      return {
        url: toPathString(localVarUrlObj),
        options: localVarRequestOptions,
      };
    },
    /**
     *
     * @summary Delete document
     * @param {string} documentId The ID or encoded key of the document to be deleted.&lt;br&gt;The ID or encoded key of the document can be found by using the GET /documents/documentsMetadata API.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteDocumentById: async (
      documentId: string,
      options: RawAxiosRequestConfig = {},
    ): Promise<RequestArgs> => {
      // verify required parameter 'documentId' is not null or undefined
      assertParamExists('deleteDocumentById', 'documentId', documentId);
      const localVarPath = `/documents/{documentId}`.replace(
        `{${'documentId'}}`,
        encodeURIComponent(String(documentId)),
      );
      // use dummy base URL string because the URL constructor only accepts absolute URLs.
      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
      let baseOptions;
      if (configuration) {
        baseOptions = configuration.baseOptions;
      }

      const localVarRequestOptions = {
        method: 'DELETE',
        ...baseOptions,
        ...options,
      };
      const localVarHeaderParameter = {} as any;
      const localVarQueryParameter = {} as any;

      // authentication basic required
      // http basic authentication required
      setBasicAuthToObject(localVarRequestOptions, configuration);

      localVarHeaderParameter['Accept'] = 'application/vnd.mambu.v2+json';

      setSearchParams(localVarUrlObj, localVarQueryParameter);
      let headersFromBaseOptions =
        baseOptions && baseOptions.headers ? baseOptions.headers : {};
      localVarRequestOptions.headers = {
        ...localVarHeaderParameter,
        ...headersFromBaseOptions,
        ...options.headers,
      };

      return {
        url: toPathString(localVarUrlObj),
        options: localVarRequestOptions,
      };
    },
    /**
     *
     * @summary Download document
     * @param {string} documentId The ID or encoded key of the document to be returned.&lt;br&gt;The ID or encoded key of the document can be found by using the GET /documents/documentsMetadata API.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocumentById: async (
      documentId: string,
      options: RawAxiosRequestConfig = {},
    ): Promise<RequestArgs> => {
      // verify required parameter 'documentId' is not null or undefined
      assertParamExists('downloadDocumentById', 'documentId', documentId);
      const localVarPath = `/documents/{documentId}`.replace(
        `{${'documentId'}}`,
        encodeURIComponent(String(documentId)),
      );
      // use dummy base URL string because the URL constructor only accepts absolute URLs.
      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
      let baseOptions;
      if (configuration) {
        baseOptions = configuration.baseOptions;
      }

      const localVarRequestOptions = {
        method: 'GET',
        ...baseOptions,
        ...options,
      };
      const localVarHeaderParameter = {} as any;
      const localVarQueryParameter = {} as any;

      // authentication basic required
      // http basic authentication required
      setBasicAuthToObject(localVarRequestOptions, configuration);

      localVarHeaderParameter['Accept'] = 'application/vnd.mambu.v2+file';

      setSearchParams(localVarUrlObj, localVarQueryParameter);
      let headersFromBaseOptions =
        baseOptions && baseOptions.headers ? baseOptions.headers : {};
      localVarRequestOptions.headers = {
        ...localVarHeaderParameter,
        ...headersFromBaseOptions,
        ...options.headers,
      };

      return {
        url: toPathString(localVarUrlObj),
        options: localVarRequestOptions,
      };
    },
    /**
     *
     * @summary Get all documents\' metadata
     * @param {GetDocumentsByEntityIdEntityEnum} entity The type of the owner of the document.
     * @param {string} ownerKey The ID or encoded key of the entity that owns the document. The ID or encoded key must belong to the entity indicated by the &#x60;entity&#x60; parameter. Possible entity types are :&#x60;CLIENT&#x60;, &#x60;GROUP&#x60;, &#x60;LOAN_PRODUCT&#x60;, &#x60;SAVINGS_PRODUCT&#x60;, &#x60;CENTRE&#x60;, &#x60;BRANCH&#x60;, &#x60;USER&#x60;, &#x60;LOAN_ACCOUNT&#x60;, &#x60;DEPOSIT_ACCOUNT&#x60;, &#x60;ID_DOCUMENT&#x60;, &#x60;LINE_OF_CREDIT&#x60;, &#x60;GL_JOURNAL_ENTRY&#x60;. If the entity is &#x60;GL_JOURNAL_ENTRY&#x60;, the value can also represent the Journal Entry Transaction ID.
     * @param {number} [offset] Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results
     * @param {number} [limit] Pagination, the number of elements to retrieve, used in combination with offset to paginate results
     * @param {GetDocumentsByEntityIdPaginationDetailsEnum} [paginationDetails] Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDocumentsByEntityId: async (
      entity: GetDocumentsByEntityIdEntityEnum,
      ownerKey: string,
      offset?: number,
      limit?: number,
      paginationDetails?: GetDocumentsByEntityIdPaginationDetailsEnum,
      options: RawAxiosRequestConfig = {},
    ): Promise<RequestArgs> => {
      // verify required parameter 'entity' is not null or undefined
      assertParamExists('getDocumentsByEntityId', 'entity', entity);
      // verify required parameter 'ownerKey' is not null or undefined
      assertParamExists('getDocumentsByEntityId', 'ownerKey', ownerKey);
      const localVarPath = `/documents/documentsMetadata`;
      // use dummy base URL string because the URL constructor only accepts absolute URLs.
      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
      let baseOptions;
      if (configuration) {
        baseOptions = configuration.baseOptions;
      }

      const localVarRequestOptions = {
        method: 'GET',
        ...baseOptions,
        ...options,
      };
      const localVarHeaderParameter = {} as any;
      const localVarQueryParameter = {} as any;

      // authentication basic required
      // http basic authentication required
      setBasicAuthToObject(localVarRequestOptions, configuration);

      if (offset !== undefined) {
        localVarQueryParameter['offset'] = offset;
      }

      if (limit !== undefined) {
        localVarQueryParameter['limit'] = limit;
      }

      if (paginationDetails !== undefined) {
        localVarQueryParameter['paginationDetails'] = paginationDetails;
      }

      if (entity !== undefined) {
        localVarQueryParameter['entity'] = entity;
      }

      if (ownerKey !== undefined) {
        localVarQueryParameter['ownerKey'] = ownerKey;
      }

      localVarHeaderParameter['Accept'] = 'application/vnd.mambu.v2+json';

      setSearchParams(localVarUrlObj, localVarQueryParameter);
      let headersFromBaseOptions =
        baseOptions && baseOptions.headers ? baseOptions.headers : {};
      localVarRequestOptions.headers = {
        ...localVarHeaderParameter,
        ...headersFromBaseOptions,
        ...options.headers,
      };

      return {
        url: toPathString(localVarUrlObj),
        options: localVarRequestOptions,
      };
    },
  };
};

/**
 * DocumentsApi - functional programming interface
 */
export const DocumentsApiFp = function (configuration?: Configuration) {
  const localVarAxiosParamCreator =
    DocumentsApiAxiosParamCreator(configuration);
  return {
    /**
     *
     * @summary Create document
     * @param {File} file The file to be attached for a client.
     * @param {string} [idempotencyKey] Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting.
     * @param {string} [id] The ID or encoded key of the entity that owns the document. The ID or encoded key must belong to the entity indicated by the &#x60;entity&#x60; parameter. Possible entity types are :&#x60;CLIENT&#x60;, &#x60;GROUP&#x60;, &#x60;LOAN_PRODUCT&#x60;, &#x60;SAVINGS_PRODUCT&#x60;, &#x60;CENTRE&#x60;, &#x60;BRANCH&#x60;, &#x60;USER&#x60;, &#x60;LOAN_ACCOUNT&#x60;, &#x60;DEPOSIT_ACCOUNT&#x60;, &#x60;ID_DOCUMENT&#x60;, &#x60;LINE_OF_CREDIT&#x60;, &#x60;GL_JOURNAL_ENTRY&#x60;. If the entity is &#x60;GL_JOURNAL_ENTRY&#x60;, the value can also represent the Journal Entry Transaction ID.
     * @param {string} [name] The name (title) of the attached file.
     * @param {string} [notes] The description of the attached file.
     * @param {string} [ownerType] The type of the owner of the document.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    async createDocument(
      file: File,
      idempotencyKey?: string,
      id?: string,
      name?: string,
      notes?: string,
      ownerType?: string,
      options?: RawAxiosRequestConfig,
    ): Promise<
      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Document>
    > {
      const localVarAxiosArgs = await localVarAxiosParamCreator.createDocument(
        file,
        idempotencyKey,
        id,
        name,
        notes,
        ownerType,
        options,
      );
      const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
      const localVarOperationServerBasePath =
        operationServerMap['DocumentsApi.createDocument']?.[
          localVarOperationServerIndex
        ]?.url;
      return (axios, basePath) =>
        createRequestFunction(
          localVarAxiosArgs,
          globalAxios,
          BASE_PATH,
          configuration,
        )(axios, localVarOperationServerBasePath || basePath);
    },
    /**
     *
     * @summary Delete document
     * @param {string} documentId The ID or encoded key of the document to be deleted.&lt;br&gt;The ID or encoded key of the document can be found by using the GET /documents/documentsMetadata API.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    async deleteDocumentById(
      documentId: string,
      options?: RawAxiosRequestConfig,
    ): Promise<
      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>
    > {
      const localVarAxiosArgs =
        await localVarAxiosParamCreator.deleteDocumentById(documentId, options);
      const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
      const localVarOperationServerBasePath =
        operationServerMap['DocumentsApi.deleteDocumentById']?.[
          localVarOperationServerIndex
        ]?.url;
      return (axios, basePath) =>
        createRequestFunction(
          localVarAxiosArgs,
          globalAxios,
          BASE_PATH,
          configuration,
        )(axios, localVarOperationServerBasePath || basePath);
    },
    /**
     *
     * @summary Download document
     * @param {string} documentId The ID or encoded key of the document to be returned.&lt;br&gt;The ID or encoded key of the document can be found by using the GET /documents/documentsMetadata API.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    async downloadDocumentById(
      documentId: string,
      options?: RawAxiosRequestConfig,
    ): Promise<
      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>
    > {
      const localVarAxiosArgs =
        await localVarAxiosParamCreator.downloadDocumentById(
          documentId,
          options,
        );
      const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
      const localVarOperationServerBasePath =
        operationServerMap['DocumentsApi.downloadDocumentById']?.[
          localVarOperationServerIndex
        ]?.url;
      return (axios, basePath) =>
        createRequestFunction(
          localVarAxiosArgs,
          globalAxios,
          BASE_PATH,
          configuration,
        )(axios, localVarOperationServerBasePath || basePath);
    },
    /**
     *
     * @summary Get all documents\' metadata
     * @param {GetDocumentsByEntityIdEntityEnum} entity The type of the owner of the document.
     * @param {string} ownerKey The ID or encoded key of the entity that owns the document. The ID or encoded key must belong to the entity indicated by the &#x60;entity&#x60; parameter. Possible entity types are :&#x60;CLIENT&#x60;, &#x60;GROUP&#x60;, &#x60;LOAN_PRODUCT&#x60;, &#x60;SAVINGS_PRODUCT&#x60;, &#x60;CENTRE&#x60;, &#x60;BRANCH&#x60;, &#x60;USER&#x60;, &#x60;LOAN_ACCOUNT&#x60;, &#x60;DEPOSIT_ACCOUNT&#x60;, &#x60;ID_DOCUMENT&#x60;, &#x60;LINE_OF_CREDIT&#x60;, &#x60;GL_JOURNAL_ENTRY&#x60;. If the entity is &#x60;GL_JOURNAL_ENTRY&#x60;, the value can also represent the Journal Entry Transaction ID.
     * @param {number} [offset] Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results
     * @param {number} [limit] Pagination, the number of elements to retrieve, used in combination with offset to paginate results
     * @param {GetDocumentsByEntityIdPaginationDetailsEnum} [paginationDetails] Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    async getDocumentsByEntityId(
      entity: GetDocumentsByEntityIdEntityEnum,
      ownerKey: string,
      offset?: number,
      limit?: number,
      paginationDetails?: GetDocumentsByEntityIdPaginationDetailsEnum,
      options?: RawAxiosRequestConfig,
    ): Promise<
      (
        axios?: AxiosInstance,
        basePath?: string,
      ) => AxiosPromise<Array<Document>>
    > {
      const localVarAxiosArgs =
        await localVarAxiosParamCreator.getDocumentsByEntityId(
          entity,
          ownerKey,
          offset,
          limit,
          paginationDetails,
          options,
        );
      const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
      const localVarOperationServerBasePath =
        operationServerMap['DocumentsApi.getDocumentsByEntityId']?.[
          localVarOperationServerIndex
        ]?.url;
      return (axios, basePath) =>
        createRequestFunction(
          localVarAxiosArgs,
          globalAxios,
          BASE_PATH,
          configuration,
        )(axios, localVarOperationServerBasePath || basePath);
    },
  };
};

/**
 * DocumentsApi - factory interface
 */
export const DocumentsApiFactory = function (
  configuration?: Configuration,
  basePath?: string,
  axios?: AxiosInstance,
) {
  const localVarFp = DocumentsApiFp(configuration);
  return {
    /**
     *
     * @summary Create document
     * @param {File} file The file to be attached for a client.
     * @param {string} [idempotencyKey] Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting.
     * @param {string} [id] The ID or encoded key of the entity that owns the document. The ID or encoded key must belong to the entity indicated by the &#x60;entity&#x60; parameter. Possible entity types are :&#x60;CLIENT&#x60;, &#x60;GROUP&#x60;, &#x60;LOAN_PRODUCT&#x60;, &#x60;SAVINGS_PRODUCT&#x60;, &#x60;CENTRE&#x60;, &#x60;BRANCH&#x60;, &#x60;USER&#x60;, &#x60;LOAN_ACCOUNT&#x60;, &#x60;DEPOSIT_ACCOUNT&#x60;, &#x60;ID_DOCUMENT&#x60;, &#x60;LINE_OF_CREDIT&#x60;, &#x60;GL_JOURNAL_ENTRY&#x60;. If the entity is &#x60;GL_JOURNAL_ENTRY&#x60;, the value can also represent the Journal Entry Transaction ID.
     * @param {string} [name] The name (title) of the attached file.
     * @param {string} [notes] The description of the attached file.
     * @param {string} [ownerType] The type of the owner of the document.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createDocument(
      file: File,
      idempotencyKey?: string,
      id?: string,
      name?: string,
      notes?: string,
      ownerType?: string,
      options?: RawAxiosRequestConfig,
    ): AxiosPromise<Document> {
      return localVarFp
        .createDocument(
          file,
          idempotencyKey,
          id,
          name,
          notes,
          ownerType,
          options,
        )
        .then((request) => request(axios, basePath));
    },
    /**
     *
     * @summary Delete document
     * @param {string} documentId The ID or encoded key of the document to be deleted.&lt;br&gt;The ID or encoded key of the document can be found by using the GET /documents/documentsMetadata API.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteDocumentById(
      documentId: string,
      options?: RawAxiosRequestConfig,
    ): AxiosPromise<void> {
      return localVarFp
        .deleteDocumentById(documentId, options)
        .then((request) => request(axios, basePath));
    },
    /**
     *
     * @summary Download document
     * @param {string} documentId The ID or encoded key of the document to be returned.&lt;br&gt;The ID or encoded key of the document can be found by using the GET /documents/documentsMetadata API.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocumentById(
      documentId: string,
      options?: RawAxiosRequestConfig,
    ): AxiosPromise<File> {
      return localVarFp
        .downloadDocumentById(documentId, options)
        .then((request) => request(axios, basePath));
    },
    /**
     *
     * @summary Get all documents\' metadata
     * @param {GetDocumentsByEntityIdEntityEnum} entity The type of the owner of the document.
     * @param {string} ownerKey The ID or encoded key of the entity that owns the document. The ID or encoded key must belong to the entity indicated by the &#x60;entity&#x60; parameter. Possible entity types are :&#x60;CLIENT&#x60;, &#x60;GROUP&#x60;, &#x60;LOAN_PRODUCT&#x60;, &#x60;SAVINGS_PRODUCT&#x60;, &#x60;CENTRE&#x60;, &#x60;BRANCH&#x60;, &#x60;USER&#x60;, &#x60;LOAN_ACCOUNT&#x60;, &#x60;DEPOSIT_ACCOUNT&#x60;, &#x60;ID_DOCUMENT&#x60;, &#x60;LINE_OF_CREDIT&#x60;, &#x60;GL_JOURNAL_ENTRY&#x60;. If the entity is &#x60;GL_JOURNAL_ENTRY&#x60;, the value can also represent the Journal Entry Transaction ID.
     * @param {number} [offset] Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results
     * @param {number} [limit] Pagination, the number of elements to retrieve, used in combination with offset to paginate results
     * @param {GetDocumentsByEntityIdPaginationDetailsEnum} [paginationDetails] Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDocumentsByEntityId(
      entity: GetDocumentsByEntityIdEntityEnum,
      ownerKey: string,
      offset?: number,
      limit?: number,
      paginationDetails?: GetDocumentsByEntityIdPaginationDetailsEnum,
      options?: RawAxiosRequestConfig,
    ): AxiosPromise<Array<Document>> {
      return localVarFp
        .getDocumentsByEntityId(
          entity,
          ownerKey,
          offset,
          limit,
          paginationDetails,
          options,
        )
        .then((request) => request(axios, basePath));
    },
  };
};

/**
 * DocumentsApi - object-oriented interface
 */
export class DocumentsApi extends BaseAPI {
  /**
   *
   * @summary Create document
   * @param {File} file The file to be attached for a client.
   * @param {string} [idempotencyKey] Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting.
   * @param {string} [id] The ID or encoded key of the entity that owns the document. The ID or encoded key must belong to the entity indicated by the &#x60;entity&#x60; parameter. Possible entity types are :&#x60;CLIENT&#x60;, &#x60;GROUP&#x60;, &#x60;LOAN_PRODUCT&#x60;, &#x60;SAVINGS_PRODUCT&#x60;, &#x60;CENTRE&#x60;, &#x60;BRANCH&#x60;, &#x60;USER&#x60;, &#x60;LOAN_ACCOUNT&#x60;, &#x60;DEPOSIT_ACCOUNT&#x60;, &#x60;ID_DOCUMENT&#x60;, &#x60;LINE_OF_CREDIT&#x60;, &#x60;GL_JOURNAL_ENTRY&#x60;. If the entity is &#x60;GL_JOURNAL_ENTRY&#x60;, the value can also represent the Journal Entry Transaction ID.
   * @param {string} [name] The name (title) of the attached file.
   * @param {string} [notes] The description of the attached file.
   * @param {string} [ownerType] The type of the owner of the document.
   * @param {*} [options] Override http request option.
   * @throws {RequiredError}
   */
  public createDocument(
    file: File,
    idempotencyKey?: string,
    id?: string,
    name?: string,
    notes?: string,
    ownerType?: string,
    options?: RawAxiosRequestConfig,
  ) {
    return DocumentsApiFp(this.configuration)
      .createDocument(file, idempotencyKey, id, name, notes, ownerType, options)
      .then((request) => request(this.axios, this.basePath));
  }

  /**
   *
   * @summary Delete document
   * @param {string} documentId The ID or encoded key of the document to be deleted.&lt;br&gt;The ID or encoded key of the document can be found by using the GET /documents/documentsMetadata API.
   * @param {*} [options] Override http request option.
   * @throws {RequiredError}
   */
  public deleteDocumentById(
    documentId: string,
    options?: RawAxiosRequestConfig,
  ) {
    return DocumentsApiFp(this.configuration)
      .deleteDocumentById(documentId, options)
      .then((request) => request(this.axios, this.basePath));
  }

  /**
   *
   * @summary Download document
   * @param {string} documentId The ID or encoded key of the document to be returned.&lt;br&gt;The ID or encoded key of the document can be found by using the GET /documents/documentsMetadata API.
   * @param {*} [options] Override http request option.
   * @throws {RequiredError}
   */
  public downloadDocumentById(
    documentId: string,
    options?: RawAxiosRequestConfig,
  ) {
    return DocumentsApiFp(this.configuration)
      .downloadDocumentById(documentId, options)
      .then((request) => request(this.axios, this.basePath));
  }

  /**
   *
   * @summary Get all documents\' metadata
   * @param {GetDocumentsByEntityIdEntityEnum} entity The type of the owner of the document.
   * @param {string} ownerKey The ID or encoded key of the entity that owns the document. The ID or encoded key must belong to the entity indicated by the &#x60;entity&#x60; parameter. Possible entity types are :&#x60;CLIENT&#x60;, &#x60;GROUP&#x60;, &#x60;LOAN_PRODUCT&#x60;, &#x60;SAVINGS_PRODUCT&#x60;, &#x60;CENTRE&#x60;, &#x60;BRANCH&#x60;, &#x60;USER&#x60;, &#x60;LOAN_ACCOUNT&#x60;, &#x60;DEPOSIT_ACCOUNT&#x60;, &#x60;ID_DOCUMENT&#x60;, &#x60;LINE_OF_CREDIT&#x60;, &#x60;GL_JOURNAL_ENTRY&#x60;. If the entity is &#x60;GL_JOURNAL_ENTRY&#x60;, the value can also represent the Journal Entry Transaction ID.
   * @param {number} [offset] Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results
   * @param {number} [limit] Pagination, the number of elements to retrieve, used in combination with offset to paginate results
   * @param {GetDocumentsByEntityIdPaginationDetailsEnum} [paginationDetails] Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs
   * @param {*} [options] Override http request option.
   * @throws {RequiredError}
   */
  public getDocumentsByEntityId(
    entity: GetDocumentsByEntityIdEntityEnum,
    ownerKey: string,
    offset?: number,
    limit?: number,
    paginationDetails?: GetDocumentsByEntityIdPaginationDetailsEnum,
    options?: RawAxiosRequestConfig,
  ) {
    return DocumentsApiFp(this.configuration)
      .getDocumentsByEntityId(
        entity,
        ownerKey,
        offset,
        limit,
        paginationDetails,
        options,
      )
      .then((request) => request(this.axios, this.basePath));
  }
}

export const GetDocumentsByEntityIdEntityEnum = {
  Client: 'CLIENT',
  Group: 'GROUP',
  LoanProduct: 'LOAN_PRODUCT',
  SavingsProduct: 'SAVINGS_PRODUCT',
  Centre: 'CENTRE',
  Branch: 'BRANCH',
  User: 'USER',
  LoanAccount: 'LOAN_ACCOUNT',
  DepositAccount: 'DEPOSIT_ACCOUNT',
  IdDocument: 'ID_DOCUMENT',
  LineOfCredit: 'LINE_OF_CREDIT',
  GlJournalEntry: 'GL_JOURNAL_ENTRY',
} as const;
export type GetDocumentsByEntityIdEntityEnum =
  (typeof GetDocumentsByEntityIdEntityEnum)[keyof typeof GetDocumentsByEntityIdEntityEnum];
export const GetDocumentsByEntityIdPaginationDetailsEnum = {
  On: 'ON',
  Off: 'OFF',
} as const;
export type GetDocumentsByEntityIdPaginationDetailsEnum =
  (typeof GetDocumentsByEntityIdPaginationDetailsEnum)[keyof typeof GetDocumentsByEntityIdPaginationDetailsEnum];