UNPKG

wallee

Version:
81 lines (80 loc) 3.25 kB
import http = require("http"); import Promise = require("bluebird"); import { Authentication } from '../auth/Authentication'; import { EntityQuery } from '../models/EntityQuery'; import { EntityQueryFilter } from '../models/EntityQueryFilter'; import { TransactionVoid } from '../models/TransactionVoid'; declare class TransactionVoidService { 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 entities 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; }>; /** * Reads the entity with the given 'id' and returns it. * @summary Read * @param spaceId * @param id The id of the transaction voids which should be returned. * @param {*} [options] Override http request options. */ read(spaceId: number, id: number, options?: any): Promise<{ response: http.IncomingMessage; body: TransactionVoid; }>; /** * Searches for the entities as specified by the given query. * @summary Search * @param spaceId * @param query The query restricts the transaction voids 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<TransactionVoid>; }>; /** * This operation voids the transaction offline. The void is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state. * @summary voidOffline * @param spaceId * @param id The id of the transaction which should be voided. * @param {*} [options] Override http request options. */ voidOffline(spaceId: number, id: number, options?: any): Promise<{ response: http.IncomingMessage; body: TransactionVoid; }>; /** * This operation voids the transaction online. The void is forwarded to the processor. This implies that the processor may take some actions based on the void. * @summary voidOnline * @param spaceId * @param id The id of the transaction which should be voided. * @param {*} [options] Override http request options. */ voidOnline(spaceId: number, id: number, options?: any): Promise<{ response: http.IncomingMessage; body: TransactionVoid; }>; } export { TransactionVoidService };