fineract_sdk/dist/src/api/self-share-accounts-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 { GetShareAccountsClientIdProductIdResponse } from '../models';
import { PostNewShareApplicationResponse } from '../models';
/**
 * SelfShareAccountsApi - axios parameter creator
 * @export
 */
export declare const SelfShareAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Mandatory fields:  clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate   Optional Fields  accountNo, externalId   Inherited from Product (if not provided)  minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
     * @summary Submit new share application
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAccount1: (body?: string, options?: any) => Promise<RequestArgs>;
    /**
     *    Example Requests:  self/shareaccounts/12
     * @summary Retrieve a share application/account
     * @param {number} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveShareAccount: (accountId: number, options?: any) => Promise<RequestArgs>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults  Allowed Value Lists   Arguments  clientId:Integer mandatory productId:Integer optionalIf entered, productId, productName and selectedProduct fields are returned. Example Requests:  self/shareaccounts/template?clientId=14  self/shareaccounts/template?clientId=14&productId=3
     * @summary Retrieve Share Account Template
     * @param {number} [clientId]
     * @param {number} [productId]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template19: (clientId?: number, productId?: number, options?: any) => Promise<RequestArgs>;
};
/**
 * SelfShareAccountsApi - functional programming interface
 * @export
 */
export declare const SelfShareAccountsApiFp: (configuration?: Configuration) => {
    /**
     * Mandatory fields:  clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate   Optional Fields  accountNo, externalId   Inherited from Product (if not provided)  minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
     * @summary Submit new share application
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAccount1(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PostNewShareApplicationResponse>>>;
    /**
     *    Example Requests:  self/shareaccounts/12
     * @summary Retrieve a share application/account
     * @param {number} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveShareAccount(accountId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults  Allowed Value Lists   Arguments  clientId:Integer mandatory productId:Integer optionalIf entered, productId, productName and selectedProduct fields are returned. Example Requests:  self/shareaccounts/template?clientId=14  self/shareaccounts/template?clientId=14&productId=3
     * @summary Retrieve Share Account Template
     * @param {number} [clientId]
     * @param {number} [productId]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template19(clientId?: number, productId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetShareAccountsClientIdProductIdResponse>>>;
};
/**
 * SelfShareAccountsApi - factory interface
 * @export
 */
export declare const SelfShareAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Mandatory fields:  clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate   Optional Fields  accountNo, externalId   Inherited from Product (if not provided)  minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
     * @summary Submit new share application
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAccount1(body?: string, options?: any): AxiosPromise<Array<PostNewShareApplicationResponse>>;
    /**
     *    Example Requests:  self/shareaccounts/12
     * @summary Retrieve a share application/account
     * @param {number} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveShareAccount(accountId: number, options?: any): AxiosPromise<string>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults  Allowed Value Lists   Arguments  clientId:Integer mandatory productId:Integer optionalIf entered, productId, productName and selectedProduct fields are returned. Example Requests:  self/shareaccounts/template?clientId=14  self/shareaccounts/template?clientId=14&productId=3
     * @summary Retrieve Share Account Template
     * @param {number} [clientId]
     * @param {number} [productId]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template19(clientId?: number, productId?: number, options?: any): AxiosPromise<Array<GetShareAccountsClientIdProductIdResponse>>;
};
/**
 * SelfShareAccountsApi - object-oriented interface
 * @export
 * @class SelfShareAccountsApi
 * @extends {BaseAPI}
 */
export declare class SelfShareAccountsApi extends BaseAPI {
    /**
     * Mandatory fields:  clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate   Optional Fields  accountNo, externalId   Inherited from Product (if not provided)  minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.
     * @summary Submit new share application
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SelfShareAccountsApi
     */
    createAccount1(body?: string, options?: any): Promise<import("axios").AxiosResponse<PostNewShareApplicationResponse[]>>;
    /**
     *    Example Requests:  self/shareaccounts/12
     * @summary Retrieve a share application/account
     * @param {number} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SelfShareAccountsApi
     */
    retrieveShareAccount(accountId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults  Allowed Value Lists   Arguments  clientId:Integer mandatory productId:Integer optionalIf entered, productId, productName and selectedProduct fields are returned. Example Requests:  self/shareaccounts/template?clientId=14  self/shareaccounts/template?clientId=14&productId=3
     * @summary Retrieve Share Account Template
     * @param {number} [clientId]
     * @param {number} [productId]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SelfShareAccountsApi
     */
    template19(clientId?: number, productId?: number, options?: any): Promise<import("axios").AxiosResponse<GetShareAccountsClientIdProductIdResponse[]>>;
}