fineract_sdk

/** * 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 { CommandProcessingResult } from '../models'; import { CommandWrapper } from '../models'; import { FormDataBodyPart } from '../models'; import { FormDataContentDisposition } from '../models'; import { SmsCampaignData } from '../models'; /** * DefaultApi - axios parameter creator * @export */ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @param {number} resourceId * @param {string} [command] * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ activate: (resourceId: number, command?: string, body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {number} [creditBureauId] creditBureauId * @param {FormDataContentDisposition} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addCreditReport: (creditBureauId?: number, file?: any, options?: any) => Promise<RequestArgs>; /** * * @param {string} entity * @param {number} entityId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewClientImage1: (entity: string, entityId: number, contentLength?: number, file?: any, options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ create1: (body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign: (body?: string, options?: any) => Promise<RequestArgs>; /** * Mandatory Fields campaignName, campaignType, triggerType, providerId, runReportId, message Mandatory Fields for Cash based on selected report id paramValue in json format * @summary Create a SMS Campaign * @param {CommandWrapper} commandWrapper * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign1: (commandWrapper: CommandWrapper, options?: any) => Promise<RequestArgs>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete1: (resourceId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete2: (resourceId: number, options?: any) => Promise<RequestArgs>; /** * Note: Only closed SMS Campaigns can be deleted * @summary Delete a SMS Campaign * @param {number} campaignId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete3: (campaignId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete8: (transactionId: number, options?: any) => Promise<RequestArgs>; /** * * @param {string} entity * @param {number} entityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientImage: (entity: string, entityId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} creditBureauId creditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCreditReport: (creditBureauId: number, options?: any) => Promise<RequestArgs>; /** * * @param {{ [key: string]: object; }} [requestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchCreditReport: (requestBody?: { [key: string]: object; }, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ get: (options?: any) => Promise<RequestArgs>; /** * * @param {number} creditBureauId creditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSavedCreditReport: (creditBureauId: number, options?: any) => Promise<RequestArgs>; /** * Activates | Deactivates | Reactivates * @summary SMS Campaign * @param {number} campaignId * @param {string} [command] * @param {*} [options] Override http request option. * @throws {RequiredError} */ handleCommands: (campaignId: number, command?: string, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ newOfficeTransactionDetails: (options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview: (body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview1: (body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll5: (options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll9: (options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllCampaign: (options?: any) => Promise<RequestArgs>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {number} [status] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {object} [fromDate] * @param {object} [toDate] * @param {string} [locale] * @param {string} [dateFormat] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmailByStatus: (sqlSearch?: string, offset?: number, limit?: number, status?: number, orderBy?: string, sortOrder?: string, fromDate?: object, toDate?: object, locale?: string, dateFormat?: string, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmails: (options?: any) => Promise<RequestArgs>; /** * Example Requests: smscampaigns * @summary List SMS Campaigns * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmails1: (sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>; /** * Example Requests: smscampaigns/1 * @summary Retrieve a SMS Campaign * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveCampaign: (resourceId: number, options?: any) => Promise<RequestArgs>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveFailedEmail: (sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>; /** * * @param {string} entity * @param {number} entityId * @param {number} [maxWidth] * @param {number} [maxHeight] * @param {string} [output] * @param {string} [accept] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveImage: (entity: string, entityId: number, maxWidth?: number, maxHeight?: number, output?: string, accept?: string, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOfficeTransactions: (options?: any) => Promise<RequestArgs>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne1: (resourceId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOneCampaign: (resourceId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOneTemplate: (resourceId: number, options?: any) => Promise<RequestArgs>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrievePendingEmail: (sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveSentEmail: (sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>; /** * * @param {number} [creditBureauId] creditBureauId * @param {string} [nationalId] nationalId * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveCreditReport: (creditBureauId?: number, nationalId?: string, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ template1: (options?: any) => Promise<RequestArgs>; /** * Example Requests: smscampaigns/1 smscampaigns/1?template=true smscampaigns/template * @summary Retrieve a SMS Campaign * @param {*} [options] Override http request option. * @throws {RequiredError} */ template2: (options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferMoneyFrom: (body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {number} resourceId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ update2: (resourceId: number, body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {number} resourceId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign: (resourceId: number, body?: string, options?: any) => Promise<RequestArgs>; /** * * @summary Update a Campaign * @param {number} campaignId * @param {CommandWrapper} commandWrapper * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign1: (campaignId: number, commandWrapper: CommandWrapper, options?: any) => Promise<RequestArgs>; /** * * @param {string} entity * @param {number} entityId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientImage1: (entity: string, entityId: number, contentLength?: number, file?: any, options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConfiguration: (body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConfiguration3: (body?: string, options?: any) => Promise<RequestArgs>; }; /** * DefaultApi - functional programming interface * @export */ export declare const DefaultApiFp: (configuration?: Configuration) => { /** * * @param {number} resourceId * @param {string} [command] * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ activate(resourceId: number, command?: string, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} [creditBureauId] creditBureauId * @param {FormDataContentDisposition} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addCreditReport(creditBureauId?: number, file?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} entity * @param {number} entityId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewClientImage1(entity: string, entityId: number, contentLength?: number, file?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ create1(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Mandatory Fields campaignName, campaignType, triggerType, providerId, runReportId, message Mandatory Fields for Cash based on selected report id paramValue in json format * @summary Create a SMS Campaign * @param {CommandWrapper} commandWrapper * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign1(commandWrapper: CommandWrapper, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommandProcessingResult>>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete1(resourceId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete2(resourceId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Note: Only closed SMS Campaigns can be deleted * @summary Delete a SMS Campaign * @param {number} campaignId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete3(campaignId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommandProcessingResult>>; /** * * @param {number} transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete8(transactionId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} entity * @param {number} entityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientImage(entity: string, entityId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} creditBureauId creditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCreditReport(creditBureauId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {{ [key: string]: object; }} [requestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchCreditReport(requestBody?: { [key: string]: object; }, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ get(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} creditBureauId creditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSavedCreditReport(creditBureauId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Activates | Deactivates | Reactivates * @summary SMS Campaign * @param {number} campaignId * @param {string} [command] * @param {*} [options] Override http request option. * @throws {RequiredError} */ handleCommands(campaignId: number, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommandProcessingResult>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ newOfficeTransactionDetails(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview1(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll5(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll9(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllCampaign(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {number} [status] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {object} [fromDate] * @param {object} [toDate] * @param {string} [locale] * @param {string} [dateFormat] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmailByStatus(sqlSearch?: string, offset?: number, limit?: number, status?: number, orderBy?: string, sortOrder?: string, fromDate?: object, toDate?: object, locale?: string, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmails(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Example Requests: smscampaigns * @summary List SMS Campaigns * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmails1(sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmsCampaignData>>; /** * Example Requests: smscampaigns/1 * @summary Retrieve a SMS Campaign * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveCampaign(resourceId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmsCampaignData>>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveFailedEmail(sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} entity * @param {number} entityId * @param {number} [maxWidth] * @param {number} [maxHeight] * @param {string} [output] * @param {string} [accept] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveImage(entity: string, entityId: number, maxWidth?: number, maxHeight?: number, output?: string, accept?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOfficeTransactions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne1(resourceId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOneCampaign(resourceId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOneTemplate(resourceId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrievePendingEmail(sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveSentEmail(sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} [creditBureauId] creditBureauId * @param {string} [nationalId] nationalId * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveCreditReport(creditBureauId?: number, nationalId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ template1(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Example Requests: smscampaigns/1 smscampaigns/1?template=true smscampaigns/template * @summary Retrieve a SMS Campaign * @param {*} [options] Override http request option. * @throws {RequiredError} */ template2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmsCampaignData>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferMoneyFrom(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} resourceId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ update2(resourceId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} resourceId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign(resourceId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @summary Update a Campaign * @param {number} campaignId * @param {CommandWrapper} commandWrapper * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign1(campaignId: number, commandWrapper: CommandWrapper, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommandProcessingResult>>; /** * * @param {string} entity * @param {number} entityId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientImage1(entity: string, entityId: number, contentLength?: number, file?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConfiguration(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConfiguration3(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; }; /** * DefaultApi - factory interface * @export */ export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {number} resourceId * @param {string} [command] * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ activate(resourceId: number, command?: string, body?: string, options?: any): AxiosPromise<string>; /** * * @param {number} [creditBureauId] creditBureauId * @param {FormDataContentDisposition} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addCreditReport(creditBureauId?: number, file?: any, options?: any): AxiosPromise<string>; /** * * @param {string} entity * @param {number} entityId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewClientImage1(entity: string, entityId: number, contentLength?: number, file?: any, options?: any): AxiosPromise<string>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ create1(body?: string, options?: any): AxiosPromise<string>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign(body?: string, options?: any): AxiosPromise<string>; /** * Mandatory Fields campaignName, campaignType, triggerType, providerId, runReportId, message Mandatory Fields for Cash based on selected report id paramValue in json format * @summary Create a SMS Campaign * @param {CommandWrapper} commandWrapper * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign1(commandWrapper: CommandWrapper, options?: any): AxiosPromise<CommandProcessingResult>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete1(resourceId: number, options?: any): AxiosPromise<string>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete2(resourceId: number, options?: any): AxiosPromise<string>; /** * Note: Only closed SMS Campaigns can be deleted * @summary Delete a SMS Campaign * @param {number} campaignId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete3(campaignId: number, options?: any): AxiosPromise<CommandProcessingResult>; /** * * @param {number} transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ delete8(transactionId: number, options?: any): AxiosPromise<string>; /** * * @param {string} entity * @param {number} entityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientImage(entity: string, entityId: number, options?: any): AxiosPromise<string>; /** * * @param {number} creditBureauId creditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCreditReport(creditBureauId: number, options?: any): AxiosPromise<string>; /** * * @param {{ [key: string]: object; }} [requestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchCreditReport(requestBody?: { [key: string]: object; }, options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ get(options?: any): AxiosPromise<string>; /** * * @param {number} creditBureauId creditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSavedCreditReport(creditBureauId: number, options?: any): AxiosPromise<string>; /** * Activates | Deactivates | Reactivates * @summary SMS Campaign * @param {number} campaignId * @param {string} [command] * @param {*} [options] Override http request option. * @throws {RequiredError} */ handleCommands(campaignId: number, command?: string, options?: any): AxiosPromise<CommandProcessingResult>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ newOfficeTransactionDetails(options?: any): AxiosPromise<string>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview(body?: string, options?: any): AxiosPromise<string>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ preview1(body?: string, options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll5(options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll9(options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllCampaign(options?: any): AxiosPromise<string>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {number} [status] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {object} [fromDate] * @param {object} [toDate] * @param {string} [locale] * @param {string} [dateFormat] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmailByStatus(sqlSearch?: string, offset?: number, limit?: number, status?: number, orderBy?: string, sortOrder?: string, fromDate?: object, toDate?: object, locale?: string, dateFormat?: string, options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmails(options?: any): AxiosPromise<string>; /** * Example Requests: smscampaigns * @summary List SMS Campaigns * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllEmails1(sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<SmsCampaignData>; /** * Example Requests: smscampaigns/1 * @summary Retrieve a SMS Campaign * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveCampaign(resourceId: number, options?: any): AxiosPromise<SmsCampaignData>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveFailedEmail(sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<string>; /** * * @param {string} entity * @param {number} entityId * @param {number} [maxWidth] * @param {number} [maxHeight] * @param {string} [output] * @param {string} [accept] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveImage(entity: string, entityId: number, maxWidth?: number, maxHeight?: number, output?: string, accept?: string, options?: any): AxiosPromise<void>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOfficeTransactions(options?: any): AxiosPromise<string>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne1(resourceId: number, options?: any): AxiosPromise<string>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOneCampaign(resourceId: number, options?: any): AxiosPromise<string>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOneTemplate(resourceId: number, options?: any): AxiosPromise<string>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrievePendingEmail(sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<string>; /** * * @param {string} [sqlSearch] * @param {number} [offset] * @param {number} [limit] * @param {string} [orderBy] * @param {string} [sortOrder] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveSentEmail(sqlSearch?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<string>; /** * * @param {number} [creditBureauId] creditBureauId * @param {string} [nationalId] nationalId * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveCreditReport(creditBureauId?: number, nationalId?: string, options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ template1(options?: any): AxiosPromise<string>; /** * Example Requests: smscampaigns/1 smscampaigns/1?template=true smscampaigns/template * @summary Retrieve a SMS Campaign * @param {*} [options] Override http request option. * @throws {RequiredError} */ template2(options?: any): AxiosPromise<SmsCampaignData>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferMoneyFrom(body?: string, options?: any): AxiosPromise<string>; /** * * @param {number} resourceId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ update2(resourceId: number, body?: string, options?: any): AxiosPromise<string>; /** * * @param {number} resourceId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign(resourceId: number, body?: string, options?: any): AxiosPromise<string>; /** * * @summary Update a Campaign * @param {number} campaignId * @param {CommandWrapper} commandWrapper * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign1(campaignId: number, commandWrapper: CommandWrapper, options?: any): AxiosPromise<CommandProcessingResult>; /** * * @param {string} entity * @param {number} entityId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClientImage1(entity: string, entityId: number, contentLength?: number, file?: any, options?: any): AxiosPromise<string>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConfiguration(body?: string, options?: any): AxiosPromise<string>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConfiguration3(body?: string, options?: any): AxiosPromise<string>; }; /** * DefaultApi - object-oriented interface * @export * @class DefaultApi * @extends {BaseAPI} */ export declare class DefaultApi extends BaseAPI { /** * * @param {number} resourceId * @param {string} [command] * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ activate(resourceId: number, command?: string, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} [creditBureauId] creditBureauId * @param {FormDataContentDisposition} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ addCreditReport(creditBureauId?: number, file?: FormDataContentDisposition, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {string} entity * @param {number} entityId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ addNewClientImage1(entity: string, entityId: number, contentLength?: number, file?: FormDataBodyPart, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ create1(body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createCampaign(body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * Mandatory Fields campaignName, campaignType, triggerType, providerId, runReportId, message Mandatory Fields for Cash based on selected report id paramValue in json format * @summary Create a SMS Campaign * @param {CommandWrapper} commandWrapper * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createCampaign1(commandWrapper: CommandWrapper, options?: any): Promise<import("axios").AxiosResponse<CommandProcessingResult>>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ delete1(resourceId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ delete2(resourceId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * Note: Only closed SMS Campaigns can be deleted * @summary Delete a SMS Campaign * @param {number} campaignId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ delete3(campaignId: number, options?: any): Promise<import("axios").AxiosResponse<CommandProcessingResult>>; /** * * @param {number} transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ delete8(transactionId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {string} entity * @param {number} entityId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deleteClientImage(entity: string, entityId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} creditBureauId creditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deleteCreditReport(creditBureauId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {{ [key: string]: object; }} [requestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ fetchCreditReport(requestBody?: { [key: string]: object; }, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ get(options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} creditBureauId creditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getSavedCreditReport(creditBureauId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * Activates | Deactivates | Reactivates * @summary SMS Campaign * @param {number} campaignId * @param {string} [command] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ handleCommands(campaignId: number, command?: string, options?: any): Promise<import("axios").AxiosResponse<CommandProcessingResult>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ newOfficeTransactionDetails(options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ preview(body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ preview1(body?: string, options?: any): Promise<import("axios").AxiosResponse<