fineract_sdk/dist/src/api/client-identifier-api.d.ts

Wrapper around fineract api.

/**
 * Apache Fineract
 * Apache Fineract is a secure, multi-tenanted microfinance platform  The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform<br>The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation  - The API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) - Find out more about Apache Fineract [here](/fineract-provider/api-docs/apiLive.htm#top) - You can [Try The API From Your Browser](/fineract-provider/api-docs/apiLive.htm#interact) - The Generic Options are available [here](/fineract-provider/api-docs/apiLive.htm#genopts) - Find out more about [Updating Dates and Numbers](/fineract-provider/api-docs/apiLive.htm#dates_and_numbers) - For the Authentication and the Basic of HTTP and HTTPS refer [here](/fineract-provider/api-docs/apiLive.htm#authentication_overview) - Check about ERROR codes [here](/fineract-provider/api-docs/apiLive.htm#errors)  Please refer to the [old documentation](/fineract-provider/api-docs/apiLive.htm) for any documentation queries
 *
 * The version of the OpenAPI document: 1.5.0-66-gffae7d4-dirty
 * Contact: dev@fineract.apache.org
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { DeleteClientsClientIdIdentifiersIdentifierIdResponse } from '../models';
import { GetClientsClientIdIdentifiersResponse } from '../models';
import { GetClientsClientIdIdentifiersTemplateResponse } from '../models';
import { PostClientsClientIdIdentifiersRequest } from '../models';
import { PostClientsClientIdIdentifiersResponse } from '../models';
import { PutClientsClientIdIdentifiersIdentifierIdRequest } from '../models';
import { PutClientsClientIdIdentifiersIdentifierIdResponse } from '../models';
/**
 * ClientIdentifierApi - axios parameter creator
 * @export
 */
export declare const ClientIdentifierApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Mandatory Fields documentKey, documentTypeId
     * @summary Create an Identifier for a Client
     * @param {number} clientId clientId
     * @param {PostClientsClientIdIdentifiersRequest} postClientsClientIdIdentifiersRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createClientIdentifier: (clientId: number, postClientsClientIdIdentifiersRequest: PostClientsClientIdIdentifiersRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Deletes a Client Identifier
     * @summary Delete a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteClientIdentifier: (clientId: number, identifierId: number, options?: any) => Promise<RequestArgs>;
    /**
     * This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of:   Field Defaults  Allowed description Lists   Example Request: clients/1/identifiers/template
     * @summary Retrieve Client Identifier Details Template
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    newClientIdentifierDetails: (clientId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests: clients/1/identifiers   clients/1/identifiers?fields=documentKey,documentType,description
     * @summary List all Identifiers for a Client
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllClientIdentifiers: (clientId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests: clients/1/identifier/2   clients/1/identifier/2?template=true  clients/1/identifiers/2?fields=documentKey,documentType,description
     * @summary Retrieve a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveClientIdentifiers: (clientId: number, identifierId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Updates a Client Identifier
     * @summary Update a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {PutClientsClientIdIdentifiersIdentifierIdRequest} putClientsClientIdIdentifiersIdentifierIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateClientIdentifer: (clientId: number, identifierId: number, putClientsClientIdIdentifiersIdentifierIdRequest: PutClientsClientIdIdentifiersIdentifierIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * ClientIdentifierApi - functional programming interface
 * @export
 */
export declare const ClientIdentifierApiFp: (configuration?: Configuration) => {
    /**
     * Mandatory Fields documentKey, documentTypeId
     * @summary Create an Identifier for a Client
     * @param {number} clientId clientId
     * @param {PostClientsClientIdIdentifiersRequest} postClientsClientIdIdentifiersRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createClientIdentifier(clientId: number, postClientsClientIdIdentifiersRequest: PostClientsClientIdIdentifiersRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostClientsClientIdIdentifiersResponse>>;
    /**
     * Deletes a Client Identifier
     * @summary Delete a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteClientIdentifier(clientId: number, identifierId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteClientsClientIdIdentifiersIdentifierIdResponse>>;
    /**
     * This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of:   Field Defaults  Allowed description Lists   Example Request: clients/1/identifiers/template
     * @summary Retrieve Client Identifier Details Template
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    newClientIdentifierDetails(clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClientsClientIdIdentifiersTemplateResponse>>;
    /**
     * Example Requests: clients/1/identifiers   clients/1/identifiers?fields=documentKey,documentType,description
     * @summary List all Identifiers for a Client
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllClientIdentifiers(clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetClientsClientIdIdentifiersResponse>>>;
    /**
     * Example Requests: clients/1/identifier/2   clients/1/identifier/2?template=true  clients/1/identifiers/2?fields=documentKey,documentType,description
     * @summary Retrieve a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveClientIdentifiers(clientId: number, identifierId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClientsClientIdIdentifiersResponse>>;
    /**
     * Updates a Client Identifier
     * @summary Update a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {PutClientsClientIdIdentifiersIdentifierIdRequest} putClientsClientIdIdentifiersIdentifierIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateClientIdentifer(clientId: number, identifierId: number, putClientsClientIdIdentifiersIdentifierIdRequest: PutClientsClientIdIdentifiersIdentifierIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutClientsClientIdIdentifiersIdentifierIdResponse>>;
};
/**
 * ClientIdentifierApi - factory interface
 * @export
 */
export declare const ClientIdentifierApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Mandatory Fields documentKey, documentTypeId
     * @summary Create an Identifier for a Client
     * @param {number} clientId clientId
     * @param {PostClientsClientIdIdentifiersRequest} postClientsClientIdIdentifiersRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createClientIdentifier(clientId: number, postClientsClientIdIdentifiersRequest: PostClientsClientIdIdentifiersRequest, options?: any): AxiosPromise<PostClientsClientIdIdentifiersResponse>;
    /**
     * Deletes a Client Identifier
     * @summary Delete a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteClientIdentifier(clientId: number, identifierId: number, options?: any): AxiosPromise<DeleteClientsClientIdIdentifiersIdentifierIdResponse>;
    /**
     * This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of:   Field Defaults  Allowed description Lists   Example Request: clients/1/identifiers/template
     * @summary Retrieve Client Identifier Details Template
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    newClientIdentifierDetails(clientId: number, options?: any): AxiosPromise<GetClientsClientIdIdentifiersTemplateResponse>;
    /**
     * Example Requests: clients/1/identifiers   clients/1/identifiers?fields=documentKey,documentType,description
     * @summary List all Identifiers for a Client
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllClientIdentifiers(clientId: number, options?: any): AxiosPromise<Array<GetClientsClientIdIdentifiersResponse>>;
    /**
     * Example Requests: clients/1/identifier/2   clients/1/identifier/2?template=true  clients/1/identifiers/2?fields=documentKey,documentType,description
     * @summary Retrieve a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveClientIdentifiers(clientId: number, identifierId: number, options?: any): AxiosPromise<GetClientsClientIdIdentifiersResponse>;
    /**
     * Updates a Client Identifier
     * @summary Update a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {PutClientsClientIdIdentifiersIdentifierIdRequest} putClientsClientIdIdentifiersIdentifierIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateClientIdentifer(clientId: number, identifierId: number, putClientsClientIdIdentifiersIdentifierIdRequest: PutClientsClientIdIdentifiersIdentifierIdRequest, options?: any): AxiosPromise<PutClientsClientIdIdentifiersIdentifierIdResponse>;
};
/**
 * ClientIdentifierApi - object-oriented interface
 * @export
 * @class ClientIdentifierApi
 * @extends {BaseAPI}
 */
export declare class ClientIdentifierApi extends BaseAPI {
    /**
     * Mandatory Fields documentKey, documentTypeId
     * @summary Create an Identifier for a Client
     * @param {number} clientId clientId
     * @param {PostClientsClientIdIdentifiersRequest} postClientsClientIdIdentifiersRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientIdentifierApi
     */
    createClientIdentifier(clientId: number, postClientsClientIdIdentifiersRequest: PostClientsClientIdIdentifiersRequest, options?: any): Promise<import("axios").AxiosResponse<PostClientsClientIdIdentifiersResponse>>;
    /**
     * Deletes a Client Identifier
     * @summary Delete a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientIdentifierApi
     */
    deleteClientIdentifier(clientId: number, identifierId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteClientsClientIdIdentifiersIdentifierIdResponse>>;
    /**
     * This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of:   Field Defaults  Allowed description Lists   Example Request: clients/1/identifiers/template
     * @summary Retrieve Client Identifier Details Template
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientIdentifierApi
     */
    newClientIdentifierDetails(clientId: number, options?: any): Promise<import("axios").AxiosResponse<GetClientsClientIdIdentifiersTemplateResponse>>;
    /**
     * Example Requests: clients/1/identifiers   clients/1/identifiers?fields=documentKey,documentType,description
     * @summary List all Identifiers for a Client
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientIdentifierApi
     */
    retrieveAllClientIdentifiers(clientId: number, options?: any): Promise<import("axios").AxiosResponse<GetClientsClientIdIdentifiersResponse[]>>;
    /**
     * Example Requests: clients/1/identifier/2   clients/1/identifier/2?template=true  clients/1/identifiers/2?fields=documentKey,documentType,description
     * @summary Retrieve a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientIdentifierApi
     */
    retrieveClientIdentifiers(clientId: number, identifierId: number, options?: any): Promise<import("axios").AxiosResponse<GetClientsClientIdIdentifiersResponse>>;
    /**
     * Updates a Client Identifier
     * @summary Update a Client Identifier
     * @param {number} clientId clientId
     * @param {number} identifierId identifierId
     * @param {PutClientsClientIdIdentifiersIdentifierIdRequest} putClientsClientIdIdentifiersIdentifierIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientIdentifierApi
     */
    updateClientIdentifer(clientId: number, identifierId: number, putClientsClientIdIdentifiersIdentifierIdRequest: PutClientsClientIdIdentifiersIdentifierIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutClientsClientIdIdentifiersIdentifierIdResponse>>;
}