fineract_sdk/dist/src/api/clients-address-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 { GetClientClientIdAddressesResponse } from '../models';
import { PostClientClientIdAddressesRequest } from '../models';
import { PostClientClientIdAddressesResponse } from '../models';
import { PutClientClientIdAddressesRequest } from '../models';
import { PutClientClientIdAddressesResponse } from '../models';
/**
 * ClientsAddressApi - axios parameter creator
 * @export
 */
export declare const ClientsAddressApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Mandatory Fields :  type and clientId
     * @summary Create an address for a Client
     * @param {number} clientid clientId
     * @param {PostClientClientIdAddressesRequest} postClientClientIdAddressesRequest
     * @param {number} [type] type
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addClientAddress: (clientid: number, postClientClientIdAddressesRequest: PostClientClientIdAddressesRequest, type?: number, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  client/1/addresses   clients/1/addresses?status=false,true&&type=1,2,3
     * @summary List all addresses for a Client
     * @param {number} clientid clientId
     * @param {string} [status] status
     * @param {number} [type] type
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAddresses1: (clientid: number, status?: string, type?: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAddressesTemplate: (options?: any) => Promise<RequestArgs>;
    /**
     * All the address fields can be updated by using update client address API  Mandatory Fields type and addressId
     * @summary Update an address for a Client
     * @param {number} clientid clientId
     * @param {PutClientClientIdAddressesRequest} putClientClientIdAddressesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateClientAddress: (clientid: number, putClientClientIdAddressesRequest: PutClientClientIdAddressesRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * ClientsAddressApi - functional programming interface
 * @export
 */
export declare const ClientsAddressApiFp: (configuration?: Configuration) => {
    /**
     * Mandatory Fields :  type and clientId
     * @summary Create an address for a Client
     * @param {number} clientid clientId
     * @param {PostClientClientIdAddressesRequest} postClientClientIdAddressesRequest
     * @param {number} [type] type
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addClientAddress(clientid: number, postClientClientIdAddressesRequest: PostClientClientIdAddressesRequest, type?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostClientClientIdAddressesResponse>>;
    /**
     * Example Requests:  client/1/addresses   clients/1/addresses?status=false,true&&type=1,2,3
     * @summary List all addresses for a Client
     * @param {number} clientid clientId
     * @param {string} [status] status
     * @param {number} [type] type
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAddresses1(clientid: number, status?: string, type?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetClientClientIdAddressesResponse>>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAddressesTemplate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * All the address fields can be updated by using update client address API  Mandatory Fields type and addressId
     * @summary Update an address for a Client
     * @param {number} clientid clientId
     * @param {PutClientClientIdAddressesRequest} putClientClientIdAddressesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateClientAddress(clientid: number, putClientClientIdAddressesRequest: PutClientClientIdAddressesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutClientClientIdAddressesResponse>>;
};
/**
 * ClientsAddressApi - factory interface
 * @export
 */
export declare const ClientsAddressApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Mandatory Fields :  type and clientId
     * @summary Create an address for a Client
     * @param {number} clientid clientId
     * @param {PostClientClientIdAddressesRequest} postClientClientIdAddressesRequest
     * @param {number} [type] type
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    addClientAddress(clientid: number, postClientClientIdAddressesRequest: PostClientClientIdAddressesRequest, type?: number, options?: any): AxiosPromise<PostClientClientIdAddressesResponse>;
    /**
     * Example Requests:  client/1/addresses   clients/1/addresses?status=false,true&&type=1,2,3
     * @summary List all addresses for a Client
     * @param {number} clientid clientId
     * @param {string} [status] status
     * @param {number} [type] type
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAddresses1(clientid: number, status?: string, type?: number, options?: any): AxiosPromise<Array<GetClientClientIdAddressesResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAddressesTemplate(options?: any): AxiosPromise<string>;
    /**
     * All the address fields can be updated by using update client address API  Mandatory Fields type and addressId
     * @summary Update an address for a Client
     * @param {number} clientid clientId
     * @param {PutClientClientIdAddressesRequest} putClientClientIdAddressesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateClientAddress(clientid: number, putClientClientIdAddressesRequest: PutClientClientIdAddressesRequest, options?: any): AxiosPromise<PutClientClientIdAddressesResponse>;
};
/**
 * ClientsAddressApi - object-oriented interface
 * @export
 * @class ClientsAddressApi
 * @extends {BaseAPI}
 */
export declare class ClientsAddressApi extends BaseAPI {
    /**
     * Mandatory Fields :  type and clientId
     * @summary Create an address for a Client
     * @param {number} clientid clientId
     * @param {PostClientClientIdAddressesRequest} postClientClientIdAddressesRequest
     * @param {number} [type] type
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientsAddressApi
     */
    addClientAddress(clientid: number, postClientClientIdAddressesRequest: PostClientClientIdAddressesRequest, type?: number, options?: any): Promise<import("axios").AxiosResponse<PostClientClientIdAddressesResponse>>;
    /**
     * Example Requests:  client/1/addresses   clients/1/addresses?status=false,true&&type=1,2,3
     * @summary List all addresses for a Client
     * @param {number} clientid clientId
     * @param {string} [status] status
     * @param {number} [type] type
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientsAddressApi
     */
    getAddresses1(clientid: number, status?: string, type?: number, options?: any): Promise<import("axios").AxiosResponse<GetClientClientIdAddressesResponse[]>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientsAddressApi
     */
    getAddressesTemplate(options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * All the address fields can be updated by using update client address API  Mandatory Fields type and addressId
     * @summary Update an address for a Client
     * @param {number} clientid clientId
     * @param {PutClientClientIdAddressesRequest} putClientClientIdAddressesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientsAddressApi
     */
    updateClientAddress(clientid: number, putClientClientIdAddressesRequest: PutClientClientIdAddressesRequest, options?: any): Promise<import("axios").AxiosResponse<PutClientClientIdAddressesResponse>>;
}