wallee/build/src/api/RefundCommentService.d.ts

TypeScript/JavaScript client for wallee

import http = require("http");
import Promise = require("bluebird");
import { Authentication } from '../auth/Authentication';
import { RefundComment } from '../models/RefundComment';
import { RefundCommentActive } from '../models/RefundCommentActive';
import { RefundCommentCreate } from '../models/RefundCommentCreate';
declare class RefundCommentService {
    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;
    /**
    * Deletes the comment with the given id.
    * @summary Delete
    * @param spaceId
    * @param id
    * @param {*} [options] Override http request options.
    */
    _delete(spaceId: number, id: number, options?: any): Promise<{
        response: http.IncomingMessage;
        body?: any;
    }>;
    /**
    * Returns all comments of the given refund.
    * @summary Find by refund
    * @param spaceId
    * @param refundId
    * @param {*} [options] Override http request options.
    */
    all(spaceId: number, refundId: number, options?: any): Promise<{
        response: http.IncomingMessage;
        body: Array<RefundComment>;
    }>;
    /**
    * Creates the comment with the given properties.
    * @summary Create
    * @param spaceId
    * @param entity The comment object which should be created.
    * @param {*} [options] Override http request options.
    */
    create(spaceId: number, entity: RefundCommentCreate, options?: any): Promise<{
        response: http.IncomingMessage;
        body: RefundComment;
    }>;
    /**
    * Pins the comment to the top.
    * @summary Pin
    * @param spaceId
    * @param id The id of the comment to pin to the top.
    * @param {*} [options] Override http request options.
    */
    pin(spaceId: number, id: number, options?: any): Promise<{
        response: http.IncomingMessage;
        body?: any;
    }>;
    /**
    * Reads the comment with the given 'id' and returns it.
    * @summary Read
    * @param spaceId
    * @param id The id of the comment which should be returned.
    * @param {*} [options] Override http request options.
    */
    read(spaceId: number, id: number, options?: any): Promise<{
        response: http.IncomingMessage;
        body: RefundComment;
    }>;
    /**
    * Unpins the comment from the top.
    * @summary Unpin
    * @param spaceId
    * @param id The id of the comment to unpin.
    * @param {*} [options] Override http request options.
    */
    unpin(spaceId: number, id: number, options?: any): Promise<{
        response: http.IncomingMessage;
        body?: any;
    }>;
    /**
    * This updates the comment with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the comment.
    * @summary Update
    * @param spaceId
    * @param entity The comment object with the properties which should be updated.
    * @param {*} [options] Override http request options.
    */
    update(spaceId: number, entity: RefundCommentActive, options?: any): Promise<{
        response: http.IncomingMessage;
        body: RefundComment;
    }>;
}
export { RefundCommentService };