fineract_sdk/dist/api/user-generated-documents-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 { DeleteTemplatesTemplateIdResponse } from '../models';
import { GetTemplatesResponse } from '../models';
import { GetTemplatesTemplateIdResponse } from '../models';
import { GetTemplatesTemplateResponse } from '../models';
import { PostTemplatesRequest } from '../models';
import { PostTemplatesResponse } from '../models';
import { PutTemplatesTemplateIdRequest } from '../models';
import { PutTemplatesTemplateIdResponse } from '../models';
/**
 * UserGeneratedDocumentsApi - axios parameter creator
 * @export
 */
export declare const UserGeneratedDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Adds a new UGD.  Mandatory Fields name    Example Requests:  templates/1
     * @summary Add a UGD
     * @param {PostTemplatesRequest} postTemplatesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createTemplate: (postTemplatesRequest: PostTemplatesRequest, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete a UGD
     * @param {number} templateId templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteTemplate: (templateId: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplateByTemplate: (templateId: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} templateId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mergeTemplate: (templateId: number, body?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  templates  It is also possible to get specific UGDs by entity and type:  templates?type=0&entity=0 [Entity: Id]      client: 0, loan: 1  [Type: Id]    Document: 0, E-Mail (not yet): 1,  SMS: 2
     * @summary Retrieve all UGDs
     * @param {number} [typeId] typeId
     * @param {number} [entityId] entityId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll40: (typeId?: number, entityId?: number, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  templates/1
     * @summary Retrieve a UGD
     * @param {number} templateId templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne28: (templateId: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Update a UGD
     * @param {number} templateId templateId
     * @param {PutTemplatesTemplateIdRequest} putTemplatesTemplateIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    saveTemplate: (templateId: number, putTemplatesTemplateIdRequest: PutTemplatesTemplateIdRequest, options?: any) => Promise<RequestArgs>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of:  ARGUMENTS name String entity String type String text String optional mappers Mapper optional Example Request:  templates/template
     * @summary Retrieve UGD Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template20: (options?: any) => Promise<RequestArgs>;
};
/**
 * UserGeneratedDocumentsApi - functional programming interface
 * @export
 */
export declare const UserGeneratedDocumentsApiFp: (configuration?: Configuration) => {
    /**
     * Adds a new UGD.  Mandatory Fields name    Example Requests:  templates/1
     * @summary Add a UGD
     * @param {PostTemplatesRequest} postTemplatesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createTemplate(postTemplatesRequest: PostTemplatesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostTemplatesResponse>>;
    /**
     *
     * @summary Delete a UGD
     * @param {number} templateId templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteTemplate(templateId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteTemplatesTemplateIdResponse>>;
    /**
     *
     * @param {number} templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplateByTemplate(templateId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     *
     * @param {number} templateId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mergeTemplate(templateId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Example Requests:  templates  It is also possible to get specific UGDs by entity and type:  templates?type=0&entity=0 [Entity: Id]      client: 0, loan: 1  [Type: Id]    Document: 0, E-Mail (not yet): 1,  SMS: 2
     * @summary Retrieve all UGDs
     * @param {number} [typeId] typeId
     * @param {number} [entityId] entityId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll40(typeId?: number, entityId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTemplatesResponse>>;
    /**
     * Example Requests:  templates/1
     * @summary Retrieve a UGD
     * @param {number} templateId templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne28(templateId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTemplatesTemplateIdResponse>>;
    /**
     *
     * @summary Update a UGD
     * @param {number} templateId templateId
     * @param {PutTemplatesTemplateIdRequest} putTemplatesTemplateIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    saveTemplate(templateId: number, putTemplatesTemplateIdRequest: PutTemplatesTemplateIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutTemplatesTemplateIdResponse>>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of:  ARGUMENTS name String entity String type String text String optional mappers Mapper optional Example Request:  templates/template
     * @summary Retrieve UGD Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template20(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTemplatesTemplateResponse>>;
};
/**
 * UserGeneratedDocumentsApi - factory interface
 * @export
 */
export declare const UserGeneratedDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Adds a new UGD.  Mandatory Fields name    Example Requests:  templates/1
     * @summary Add a UGD
     * @param {PostTemplatesRequest} postTemplatesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createTemplate(postTemplatesRequest: PostTemplatesRequest, options?: any): AxiosPromise<PostTemplatesResponse>;
    /**
     *
     * @summary Delete a UGD
     * @param {number} templateId templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteTemplate(templateId: number, options?: any): AxiosPromise<DeleteTemplatesTemplateIdResponse>;
    /**
     *
     * @param {number} templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplateByTemplate(templateId: number, options?: any): AxiosPromise<string>;
    /**
     *
     * @param {number} templateId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mergeTemplate(templateId: number, body?: string, options?: any): AxiosPromise<string>;
    /**
     * Example Requests:  templates  It is also possible to get specific UGDs by entity and type:  templates?type=0&entity=0 [Entity: Id]      client: 0, loan: 1  [Type: Id]    Document: 0, E-Mail (not yet): 1,  SMS: 2
     * @summary Retrieve all UGDs
     * @param {number} [typeId] typeId
     * @param {number} [entityId] entityId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll40(typeId?: number, entityId?: number, options?: any): AxiosPromise<GetTemplatesResponse>;
    /**
     * Example Requests:  templates/1
     * @summary Retrieve a UGD
     * @param {number} templateId templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne28(templateId: number, options?: any): AxiosPromise<GetTemplatesTemplateIdResponse>;
    /**
     *
     * @summary Update a UGD
     * @param {number} templateId templateId
     * @param {PutTemplatesTemplateIdRequest} putTemplatesTemplateIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    saveTemplate(templateId: number, putTemplatesTemplateIdRequest: PutTemplatesTemplateIdRequest, options?: any): AxiosPromise<PutTemplatesTemplateIdResponse>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of:  ARGUMENTS name String entity String type String text String optional mappers Mapper optional Example Request:  templates/template
     * @summary Retrieve UGD Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template20(options?: any): AxiosPromise<GetTemplatesTemplateResponse>;
};
/**
 * UserGeneratedDocumentsApi - object-oriented interface
 * @export
 * @class UserGeneratedDocumentsApi
 * @extends {BaseAPI}
 */
export declare class UserGeneratedDocumentsApi extends BaseAPI {
    /**
     * Adds a new UGD.  Mandatory Fields name    Example Requests:  templates/1
     * @summary Add a UGD
     * @param {PostTemplatesRequest} postTemplatesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserGeneratedDocumentsApi
     */
    createTemplate(postTemplatesRequest: PostTemplatesRequest, options?: any): Promise<import("axios").AxiosResponse<PostTemplatesResponse>>;
    /**
     *
     * @summary Delete a UGD
     * @param {number} templateId templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserGeneratedDocumentsApi
     */
    deleteTemplate(templateId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteTemplatesTemplateIdResponse>>;
    /**
     *
     * @param {number} templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserGeneratedDocumentsApi
     */
    getTemplateByTemplate(templateId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     *
     * @param {number} templateId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserGeneratedDocumentsApi
     */
    mergeTemplate(templateId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * Example Requests:  templates  It is also possible to get specific UGDs by entity and type:  templates?type=0&entity=0 [Entity: Id]      client: 0, loan: 1  [Type: Id]    Document: 0, E-Mail (not yet): 1,  SMS: 2
     * @summary Retrieve all UGDs
     * @param {number} [typeId] typeId
     * @param {number} [entityId] entityId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserGeneratedDocumentsApi
     */
    retrieveAll40(typeId?: number, entityId?: number, options?: any): Promise<import("axios").AxiosResponse<GetTemplatesResponse>>;
    /**
     * Example Requests:  templates/1
     * @summary Retrieve a UGD
     * @param {number} templateId templateId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserGeneratedDocumentsApi
     */
    retrieveOne28(templateId: number, options?: any): Promise<import("axios").AxiosResponse<GetTemplatesTemplateIdResponse>>;
    /**
     *
     * @summary Update a UGD
     * @param {number} templateId templateId
     * @param {PutTemplatesTemplateIdRequest} putTemplatesTemplateIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserGeneratedDocumentsApi
     */
    saveTemplate(templateId: number, putTemplatesTemplateIdRequest: PutTemplatesTemplateIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutTemplatesTemplateIdResponse>>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of:  ARGUMENTS name String entity String type String text String optional mappers Mapper optional Example Request:  templates/template
     * @summary Retrieve UGD Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserGeneratedDocumentsApi
     */
    template20(options?: any): Promise<import("axios").AxiosResponse<GetTemplatesTemplateResponse>>;
}