wallee/dist/services/RefundsService.d.ts

TypeScript/JavaScript client for wallee

/**
 * Wallee AG TypeScript SDK
 *
 * This library allows to interact with the Wallee AG payment service.
 *
 * Copyright owner: Wallee AG
 * Website: https://en.wallee.com
 * Developer email: ecosystem-team@wallee.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import * as runtime from '../runtime';
import type { Refund, RefundCreate, RefundListResponse, RefundSearchResponse, RenderedDocument, SortingOrder } from '../models/index';
export interface GetPaymentRefundsRequest {
    space: number;
    after?: number;
    before?: number;
    expand?: Set<string>;
    limit?: number;
    order?: SortingOrder;
}
export interface GetPaymentRefundsIdRequest {
    id: number;
    space: number;
    expand?: Set<string>;
}
export interface GetPaymentRefundsIdDocumentRequest {
    id: number;
    space: number;
}
export interface GetPaymentRefundsSearchRequest {
    space: number;
    expand?: Set<string>;
    limit?: number;
    offset?: number;
    order?: string;
    query?: string;
}
export interface PostPaymentRefundsRequest {
    space: number;
    refundCreate: RefundCreate;
    expand?: Set<string>;
}
export interface PostPaymentRefundsIdMarkFailedRequest {
    id: number;
    space: number;
    expand?: Set<string>;
}
export interface PostPaymentRefundsIdMarkSucceededRequest {
    id: number;
    space: number;
    expand?: Set<string>;
}
/**
 *
 */
export declare class RefundsService extends runtime.BaseAPI {
    constructor(configuration: runtime.Configuration);
    /**
     * List all refunds
     
     */
    getPaymentRefundsRaw(requestParameters: GetPaymentRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RefundListResponse>>;
    /**
     * List all refunds
     
     */
    getPaymentRefunds(requestParameters: GetPaymentRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RefundListResponse>;
    /**
     * Retrieve a refund
     
     */
    getPaymentRefundsIdRaw(requestParameters: GetPaymentRefundsIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Refund>>;
    /**
     * Retrieve a refund
     
     */
    getPaymentRefundsId(requestParameters: GetPaymentRefundsIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Refund>;
    /**
     * Retrieve a refund document
     
     */
    getPaymentRefundsIdDocumentRaw(requestParameters: GetPaymentRefundsIdDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderedDocument>>;
    /**
     * Retrieve a refund document
     
     */
    getPaymentRefundsIdDocument(requestParameters: GetPaymentRefundsIdDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderedDocument>;
    /**
     * Search refunds
     
     */
    getPaymentRefundsSearchRaw(requestParameters: GetPaymentRefundsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RefundSearchResponse>>;
    /**
     * Search refunds
     
     */
    getPaymentRefundsSearch(requestParameters: GetPaymentRefundsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RefundSearchResponse>;
    /**
     * Create a refund
     
     */
    postPaymentRefundsRaw(requestParameters: PostPaymentRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Refund>>;
    /**
     * Create a refund
     
     */
    postPaymentRefunds(requestParameters: PostPaymentRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Refund>;
    /**
     * Mark a refund as failed
     
     */
    postPaymentRefundsIdMarkFailedRaw(requestParameters: PostPaymentRefundsIdMarkFailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Refund>>;
    /**
     * Mark a refund as failed
     
     */
    postPaymentRefundsIdMarkFailed(requestParameters: PostPaymentRefundsIdMarkFailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Refund>;
    /**
     * Mark a refund as successful
     
     */
    postPaymentRefundsIdMarkSucceededRaw(requestParameters: PostPaymentRefundsIdMarkSucceededRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Refund>>;
    /**
     * Mark a refund as successful
     
     */
    postPaymentRefundsIdMarkSucceeded(requestParameters: PostPaymentRefundsIdMarkSucceededRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Refund>;
}