fineract_sdk
Version:
Wrapper around fineract api.
654 lines (580 loc) • 38.2 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* 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 globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
import { Configuration } from '../configuration';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
// @ts-ignore
import { GetStandingInstructionsResponse } from '../models';
// @ts-ignore
import { GetStandingInstructionsStandingInstructionIdResponse } from '../models';
// @ts-ignore
import { GetStandingInstructionsTemplateResponse } from '../models';
// @ts-ignore
import { PostStandingInstructionsRequest } from '../models';
// @ts-ignore
import { PostStandingInstructionsResponse } from '../models';
// @ts-ignore
import { PutStandingInstructionsStandingInstructionIdRequest } from '../models';
// @ts-ignore
import { PutStandingInstructionsStandingInstructionIdResponse } from '../models';
/**
* StandingInstructionsApi - axios parameter creator
* @export
*/
export const StandingInstructionsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Ability to create new instruction for transfer of monetary funds from one account to another
* @summary Create new Standing Instruction
* @param {PostStandingInstructionsRequest} postStandingInstructionsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create5: async (postStandingInstructionsRequest: PostStandingInstructionsRequest, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'postStandingInstructionsRequest' is not null or undefined
assertParamExists('create5', 'postStandingInstructionsRequest', postStandingInstructionsRequest)
const localVarPath = `/standinginstructions`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tenantid required
await setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(postStandingInstructionsRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Example Requests: standinginstructions
* @summary List Standing Instructions
* @param {string} [sqlSearch] sqlSearch
* @param {string} [externalId] externalId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {number} [transferType] transferType
* @param {string} [clientName] clientName
* @param {number} [clientId] clientId
* @param {number} [fromAccountId] fromAccountId
* @param {number} [fromAccountType] fromAccountType
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll19: async (sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, options: any = {}): Promise<RequestArgs> => {
const localVarPath = `/standinginstructions`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tenantid required
await setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)
if (sqlSearch !== undefined) {
localVarQueryParameter['sqlSearch'] = sqlSearch;
}
if (externalId !== undefined) {
localVarQueryParameter['externalId'] = externalId;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (orderBy !== undefined) {
localVarQueryParameter['orderBy'] = orderBy;
}
if (sortOrder !== undefined) {
localVarQueryParameter['sortOrder'] = sortOrder;
}
if (transferType !== undefined) {
localVarQueryParameter['transferType'] = transferType;
}
if (clientName !== undefined) {
localVarQueryParameter['clientName'] = clientName;
}
if (clientId !== undefined) {
localVarQueryParameter['clientId'] = clientId;
}
if (fromAccountId !== undefined) {
localVarQueryParameter['fromAccountId'] = fromAccountId;
}
if (fromAccountType !== undefined) {
localVarQueryParameter['fromAccountType'] = fromAccountType;
}
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Example Requests : standinginstructions/1
* @summary Retrieve Standing Instruction
* @param {number} standingInstructionId standingInstructionId
* @param {string} [sqlSearch] sqlSearch
* @param {string} [externalId] externalId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne10: async (standingInstructionId: number, sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'standingInstructionId' is not null or undefined
assertParamExists('retrieveOne10', 'standingInstructionId', standingInstructionId)
const localVarPath = `/standinginstructions/{standingInstructionId}`
.replace(`{${"standingInstructionId"}}`, encodeURIComponent(String(standingInstructionId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tenantid required
await setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)
if (sqlSearch !== undefined) {
localVarQueryParameter['sqlSearch'] = sqlSearch;
}
if (externalId !== undefined) {
localVarQueryParameter['externalId'] = externalId;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (orderBy !== undefined) {
localVarQueryParameter['orderBy'] = orderBy;
}
if (sortOrder !== undefined) {
localVarQueryParameter['sortOrder'] = sortOrder;
}
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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 Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1
* @summary Retrieve Standing Instruction Template
* @param {number} [fromOfficeId] fromOfficeId
* @param {number} [fromClientId] fromClientId
* @param {number} [fromAccountId] fromAccountId
* @param {number} [fromAccountType] fromAccountType
* @param {number} [toOfficeId] toOfficeId
* @param {number} [toClientId] toClientId
* @param {number} [toAccountId] toAccountId
* @param {number} [toAccountType] toAccountType
* @param {number} [transferType] transferType
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template6: async (fromOfficeId?: number, fromClientId?: number, fromAccountId?: number, fromAccountType?: number, toOfficeId?: number, toClientId?: number, toAccountId?: number, toAccountType?: number, transferType?: number, options: any = {}): Promise<RequestArgs> => {
const localVarPath = `/standinginstructions/template`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tenantid required
await setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)
if (fromOfficeId !== undefined) {
localVarQueryParameter['fromOfficeId'] = fromOfficeId;
}
if (fromClientId !== undefined) {
localVarQueryParameter['fromClientId'] = fromClientId;
}
if (fromAccountId !== undefined) {
localVarQueryParameter['fromAccountId'] = fromAccountId;
}
if (fromAccountType !== undefined) {
localVarQueryParameter['fromAccountType'] = fromAccountType;
}
if (toOfficeId !== undefined) {
localVarQueryParameter['toOfficeId'] = toOfficeId;
}
if (toClientId !== undefined) {
localVarQueryParameter['toClientId'] = toClientId;
}
if (toAccountId !== undefined) {
localVarQueryParameter['toAccountId'] = toAccountId;
}
if (toAccountType !== undefined) {
localVarQueryParameter['toAccountType'] = toAccountType;
}
if (transferType !== undefined) {
localVarQueryParameter['transferType'] = transferType;
}
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete
* @summary Update Standing Instruction | Delete Standing Instruction
* @param {number} standingInstructionId standingInstructionId
* @param {string} [command] command
* @param {PutStandingInstructionsStandingInstructionIdRequest} [putStandingInstructionsStandingInstructionIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update9: async (standingInstructionId: number, command?: string, putStandingInstructionsStandingInstructionIdRequest?: PutStandingInstructionsStandingInstructionIdRequest, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'standingInstructionId' is not null or undefined
assertParamExists('update9', 'standingInstructionId', standingInstructionId)
const localVarPath = `/standinginstructions/{standingInstructionId}`
.replace(`{${"standingInstructionId"}}`, encodeURIComponent(String(standingInstructionId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tenantid required
await setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)
if (command !== undefined) {
localVarQueryParameter['command'] = command;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(putStandingInstructionsStandingInstructionIdRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* StandingInstructionsApi - functional programming interface
* @export
*/
export const StandingInstructionsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = StandingInstructionsApiAxiosParamCreator(configuration)
return {
/**
* Ability to create new instruction for transfer of monetary funds from one account to another
* @summary Create new Standing Instruction
* @param {PostStandingInstructionsRequest} postStandingInstructionsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async create5(postStandingInstructionsRequest: PostStandingInstructionsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostStandingInstructionsResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.create5(postStandingInstructionsRequest, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Example Requests: standinginstructions
* @summary List Standing Instructions
* @param {string} [sqlSearch] sqlSearch
* @param {string} [externalId] externalId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {number} [transferType] transferType
* @param {string} [clientName] clientName
* @param {number} [clientId] clientId
* @param {number} [fromAccountId] fromAccountId
* @param {number} [fromAccountType] fromAccountType
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async retrieveAll19(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStandingInstructionsResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveAll19(sqlSearch, externalId, offset, limit, orderBy, sortOrder, transferType, clientName, clientId, fromAccountId, fromAccountType, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Example Requests : standinginstructions/1
* @summary Retrieve Standing Instruction
* @param {number} standingInstructionId standingInstructionId
* @param {string} [sqlSearch] sqlSearch
* @param {string} [externalId] externalId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async retrieveOne10(standingInstructionId: number, sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStandingInstructionsStandingInstructionIdResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveOne10(standingInstructionId, sqlSearch, externalId, offset, limit, orderBy, sortOrder, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* 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 Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1
* @summary Retrieve Standing Instruction Template
* @param {number} [fromOfficeId] fromOfficeId
* @param {number} [fromClientId] fromClientId
* @param {number} [fromAccountId] fromAccountId
* @param {number} [fromAccountType] fromAccountType
* @param {number} [toOfficeId] toOfficeId
* @param {number} [toClientId] toClientId
* @param {number} [toAccountId] toAccountId
* @param {number} [toAccountType] toAccountType
* @param {number} [transferType] transferType
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async template6(fromOfficeId?: number, fromClientId?: number, fromAccountId?: number, fromAccountType?: number, toOfficeId?: number, toClientId?: number, toAccountId?: number, toAccountType?: number, transferType?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStandingInstructionsTemplateResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.template6(fromOfficeId, fromClientId, fromAccountId, fromAccountType, toOfficeId, toClientId, toAccountId, toAccountType, transferType, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete
* @summary Update Standing Instruction | Delete Standing Instruction
* @param {number} standingInstructionId standingInstructionId
* @param {string} [command] command
* @param {PutStandingInstructionsStandingInstructionIdRequest} [putStandingInstructionsStandingInstructionIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async update9(standingInstructionId: number, command?: string, putStandingInstructionsStandingInstructionIdRequest?: PutStandingInstructionsStandingInstructionIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutStandingInstructionsStandingInstructionIdResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.update9(standingInstructionId, command, putStandingInstructionsStandingInstructionIdRequest, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
};
/**
* StandingInstructionsApi - factory interface
* @export
*/
export const StandingInstructionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = StandingInstructionsApiFp(configuration)
return {
/**
* Ability to create new instruction for transfer of monetary funds from one account to another
* @summary Create new Standing Instruction
* @param {PostStandingInstructionsRequest} postStandingInstructionsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create5(postStandingInstructionsRequest: PostStandingInstructionsRequest, options?: any): AxiosPromise<PostStandingInstructionsResponse> {
return localVarFp.create5(postStandingInstructionsRequest, options).then((request) => request(axios, basePath));
},
/**
* Example Requests: standinginstructions
* @summary List Standing Instructions
* @param {string} [sqlSearch] sqlSearch
* @param {string} [externalId] externalId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {number} [transferType] transferType
* @param {string} [clientName] clientName
* @param {number} [clientId] clientId
* @param {number} [fromAccountId] fromAccountId
* @param {number} [fromAccountType] fromAccountType
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll19(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, options?: any): AxiosPromise<GetStandingInstructionsResponse> {
return localVarFp.retrieveAll19(sqlSearch, externalId, offset, limit, orderBy, sortOrder, transferType, clientName, clientId, fromAccountId, fromAccountType, options).then((request) => request(axios, basePath));
},
/**
* Example Requests : standinginstructions/1
* @summary Retrieve Standing Instruction
* @param {number} standingInstructionId standingInstructionId
* @param {string} [sqlSearch] sqlSearch
* @param {string} [externalId] externalId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne10(standingInstructionId: number, sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<GetStandingInstructionsStandingInstructionIdResponse> {
return localVarFp.retrieveOne10(standingInstructionId, sqlSearch, externalId, offset, limit, orderBy, sortOrder, options).then((request) => request(axios, basePath));
},
/**
* 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 Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1
* @summary Retrieve Standing Instruction Template
* @param {number} [fromOfficeId] fromOfficeId
* @param {number} [fromClientId] fromClientId
* @param {number} [fromAccountId] fromAccountId
* @param {number} [fromAccountType] fromAccountType
* @param {number} [toOfficeId] toOfficeId
* @param {number} [toClientId] toClientId
* @param {number} [toAccountId] toAccountId
* @param {number} [toAccountType] toAccountType
* @param {number} [transferType] transferType
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template6(fromOfficeId?: number, fromClientId?: number, fromAccountId?: number, fromAccountType?: number, toOfficeId?: number, toClientId?: number, toAccountId?: number, toAccountType?: number, transferType?: number, options?: any): AxiosPromise<GetStandingInstructionsTemplateResponse> {
return localVarFp.template6(fromOfficeId, fromClientId, fromAccountId, fromAccountType, toOfficeId, toClientId, toAccountId, toAccountType, transferType, options).then((request) => request(axios, basePath));
},
/**
* Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete
* @summary Update Standing Instruction | Delete Standing Instruction
* @param {number} standingInstructionId standingInstructionId
* @param {string} [command] command
* @param {PutStandingInstructionsStandingInstructionIdRequest} [putStandingInstructionsStandingInstructionIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update9(standingInstructionId: number, command?: string, putStandingInstructionsStandingInstructionIdRequest?: PutStandingInstructionsStandingInstructionIdRequest, options?: any): AxiosPromise<PutStandingInstructionsStandingInstructionIdResponse> {
return localVarFp.update9(standingInstructionId, command, putStandingInstructionsStandingInstructionIdRequest, options).then((request) => request(axios, basePath));
},
};
};
/**
* StandingInstructionsApi - object-oriented interface
* @export
* @class StandingInstructionsApi
* @extends {BaseAPI}
*/
export class StandingInstructionsApi extends BaseAPI {
/**
* Ability to create new instruction for transfer of monetary funds from one account to another
* @summary Create new Standing Instruction
* @param {PostStandingInstructionsRequest} postStandingInstructionsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StandingInstructionsApi
*/
public create5(postStandingInstructionsRequest: PostStandingInstructionsRequest, options?: any) {
return StandingInstructionsApiFp(this.configuration).create5(postStandingInstructionsRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
* Example Requests: standinginstructions
* @summary List Standing Instructions
* @param {string} [sqlSearch] sqlSearch
* @param {string} [externalId] externalId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {number} [transferType] transferType
* @param {string} [clientName] clientName
* @param {number} [clientId] clientId
* @param {number} [fromAccountId] fromAccountId
* @param {number} [fromAccountType] fromAccountType
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StandingInstructionsApi
*/
public retrieveAll19(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, options?: any) {
return StandingInstructionsApiFp(this.configuration).retrieveAll19(sqlSearch, externalId, offset, limit, orderBy, sortOrder, transferType, clientName, clientId, fromAccountId, fromAccountType, options).then((request) => request(this.axios, this.basePath));
}
/**
* Example Requests : standinginstructions/1
* @summary Retrieve Standing Instruction
* @param {number} standingInstructionId standingInstructionId
* @param {string} [sqlSearch] sqlSearch
* @param {string} [externalId] externalId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StandingInstructionsApi
*/
public retrieveOne10(standingInstructionId: number, sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) {
return StandingInstructionsApiFp(this.configuration).retrieveOne10(standingInstructionId, sqlSearch, externalId, offset, limit, orderBy, sortOrder, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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 Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1
* @summary Retrieve Standing Instruction Template
* @param {number} [fromOfficeId] fromOfficeId
* @param {number} [fromClientId] fromClientId
* @param {number} [fromAccountId] fromAccountId
* @param {number} [fromAccountType] fromAccountType
* @param {number} [toOfficeId] toOfficeId
* @param {number} [toClientId] toClientId
* @param {number} [toAccountId] toAccountId
* @param {number} [toAccountType] toAccountType
* @param {number} [transferType] transferType
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StandingInstructionsApi
*/
public template6(fromOfficeId?: number, fromClientId?: number, fromAccountId?: number, fromAccountType?: number, toOfficeId?: number, toClientId?: number, toAccountId?: number, toAccountType?: number, transferType?: number, options?: any) {
return StandingInstructionsApiFp(this.configuration).template6(fromOfficeId, fromClientId, fromAccountId, fromAccountType, toOfficeId, toClientId, toAccountId, toAccountType, transferType, options).then((request) => request(this.axios, this.basePath));
}
/**
* Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete
* @summary Update Standing Instruction | Delete Standing Instruction
* @param {number} standingInstructionId standingInstructionId
* @param {string} [command] command
* @param {PutStandingInstructionsStandingInstructionIdRequest} [putStandingInstructionsStandingInstructionIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StandingInstructionsApi
*/
public update9(standingInstructionId: number, command?: string, putStandingInstructionsStandingInstructionIdRequest?: PutStandingInstructionsStandingInstructionIdRequest, options?: any) {
return StandingInstructionsApiFp(this.configuration).update9(standingInstructionId, command, putStandingInstructionsStandingInstructionIdRequest, options).then((request) => request(this.axios, this.basePath));
}
}