wallee
Version:
TypeScript/JavaScript client for wallee
71 lines (70 loc) • 2.9 kB
TypeScript
import http = require("http");
import Promise = require("bluebird");
import { Authentication } from '../auth/Authentication';
import { EntityQuery } from '../models/EntityQuery';
import { EntityQueryFilter } from '../models/EntityQueryFilter';
import { InstallmentPayment } from '../models/InstallmentPayment';
declare class InstallmentPaymentService {
protected _basePath: string;
protected _defaultHeaders: any;
protected _useQuerystring: boolean;
protected _timeout: number;
protected _defaultAuthentication: Authentication;
constructor(configuration: any);
/**
* Set timeout in seconds. Default timeout: 25 seconds
* @param {number} timeout
*/
set timeout(timeout: number);
private setTimeout;
set basePath(basePath: string);
get basePath(): string;
protected setDefaultAuthentication(auth: Authentication): void;
private getVersion;
/**
* Counts the number of items in the database as restricted by the given filter.
* @summary Count
* @param spaceId
* @param filter The filter which restricts the installment payment which are used to calculate the count.
* @param {*} [options] Override http request options.
*/
count(spaceId: number, filter: EntityQueryFilter, options?: any): Promise<{
response: http.IncomingMessage;
body: number;
}>;
/**
* This operation creates based up on the given transaction an installment payment.
* @summary Create Installment Payment
* @param spaceId
* @param transactionId The transaction which should be converted into an installment payment.
* @param installmentPlanConfiguration The installment plan configuration ID which should be applied on the transaction.
* @param {*} [options] Override http request options.
*/
createInstallmentPayment(spaceId: number, transactionId: number, installmentPlanConfiguration: number, options?: any): Promise<{
response: http.IncomingMessage;
body: InstallmentPayment;
}>;
/**
* Reads the entity with the given 'id' and returns it.
* @summary Read
* @param spaceId
* @param id The id of the installment payment which should be returned.
* @param {*} [options] Override http request options.
*/
read(spaceId: number, id: number, options?: any): Promise<{
response: http.IncomingMessage;
body: InstallmentPayment;
}>;
/**
* Searches for the entities as specified by the given query.
* @summary Search
* @param spaceId
* @param query The query restricts the installment payments which are returned by the search.
* @param {*} [options] Override http request options.
*/
search(spaceId: number, query: EntityQuery, options?: any): Promise<{
response: http.IncomingMessage;
body: Array<InstallmentPayment>;
}>;
}
export { InstallmentPaymentService };