@vality/swag-payments 0.1.0

package/lib/api/payouts.service.d.ts

@@ -0,0 +1,209 @@
+import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { Payout } from '../model/payout';
+import { PayoutParams } from '../model/payout-params';
+import { PayoutTool } from '../model/payout-tool';
+import { Schedule } from '../model/schedule';
+import { Configuration } from '../configuration';
+import * as i0 from "@angular/core";
+export interface CreatePayoutRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    payoutParams: PayoutParams;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+}
+export interface GetPayoutRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Withdrawal ID */
+    payoutID: string;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+}
+export interface GetPayoutToolByIDRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Contract ID */
+    contractID: string;
+    /** Payout tool ID */
+    payoutToolID: string;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+}
+export interface GetPayoutToolByIDForPartyRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Contract ID */
+    contractID: string;
+    /** Payout tool ID */
+    payoutToolID: string;
+    /** The participant\'s unique identifier within the system. */
+    partyID: string;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+}
+export interface GetPayoutToolsRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Contract ID */
+    contractID: string;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+}
+export interface GetPayoutToolsForPartyRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Contract ID */
+    contractID: string;
+    /** The participant\'s unique identifier within the system. */
+    partyID: string;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+}
+export interface GetScheduleByRefRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Schedule reference */
+    scheduleID: number;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+}
+export declare class PayoutsService {
+    protected httpClient: HttpClient;
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
+    private addToHttpParams;
+    private addToHttpParamsRecursive;
+    /**
+     * Create a new payout and send it to pre-moderation.
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    createPayout(requestParameters: CreatePayoutRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset=utf-8';
+        context?: HttpContext;
+    }): Observable<Payout>;
+    createPayout(requestParameters: CreatePayoutRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<Payout>>;
+    createPayout(requestParameters: CreatePayoutRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<Payout>>;
+    /**
+     * Get payout data
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    getPayout(requestParameters: GetPayoutRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<Payout>;
+    getPayout(requestParameters: GetPayoutRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<Payout>>;
+    getPayout(requestParameters: GetPayoutRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<Payout>>;
+    /**
+     * Get a payout tool data by identifier
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    getPayoutToolByID(requestParameters: GetPayoutToolByIDRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<PayoutTool>;
+    getPayoutToolByID(requestParameters: GetPayoutToolByIDRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<PayoutTool>>;
+    getPayoutToolByID(requestParameters: GetPayoutToolByIDRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<PayoutTool>>;
+    /**
+     * Get a payout tool data by identifier
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    getPayoutToolByIDForParty(requestParameters: GetPayoutToolByIDForPartyRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<PayoutTool>;
+    getPayoutToolByIDForParty(requestParameters: GetPayoutToolByIDForPartyRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<PayoutTool>>;
+    getPayoutToolByIDForParty(requestParameters: GetPayoutToolByIDForPartyRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<PayoutTool>>;
+    /**
+     * Get all payout tools to the specified contract
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    getPayoutTools(requestParameters: GetPayoutToolsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<Array<PayoutTool>>;
+    getPayoutTools(requestParameters: GetPayoutToolsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<Array<PayoutTool>>>;
+    getPayoutTools(requestParameters: GetPayoutToolsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<Array<PayoutTool>>>;
+    /**
+     * Get all payout tools to the specified contract
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    getPayoutToolsForParty(requestParameters: GetPayoutToolsForPartyRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<Array<PayoutTool>>;
+    getPayoutToolsForParty(requestParameters: GetPayoutToolsForPartyRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<Array<PayoutTool>>>;
+    getPayoutToolsForParty(requestParameters: GetPayoutToolsForPartyRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<Array<PayoutTool>>>;
+    /**
+     * Get payout schedule data by identifier
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    getScheduleByRef(requestParameters: GetScheduleByRefRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<Schedule>;
+    getScheduleByRef(requestParameters: GetScheduleByRefRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<Schedule>>;
+    getScheduleByRef(requestParameters: GetScheduleByRefRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<Schedule>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PayoutsService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PayoutsService>;
+}

package/lib/api/search.service.d.ts

@@ -0,0 +1,242 @@
+import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { SearchInvoices200Response } from '../model/search-invoices200-response';
+import { SearchPayments200Response } from '../model/search-payments200-response';
+import { SearchPayouts200Response } from '../model/search-payouts200-response';
+import { SearchRefunds200Response } from '../model/search-refunds200-response';
+import { Configuration } from '../configuration';
+import * as i0 from "@angular/core";
+export interface SearchInvoicesRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Shop ID */
+    shopID: string;
+    /** Start of the time period */
+    fromTime: string;
+    /** End of the time period */
+    toTime: string;
+    /** Selection limit */
+    limit: number;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+    /** Invoice status for search */
+    invoiceStatus?: 'unpaid' | 'cancelled' | 'paid' | 'fulfilled';
+    /** Payment status for search */
+    paymentStatus?: 'pending' | 'processed' | 'captured' | 'cancelled' | 'refunded' | 'failed';
+    /** Payment flow */
+    paymentFlow?: 'instant' | 'hold';
+    /** Payment method */
+    paymentMethod?: 'bankCard' | 'paymentTerminal';
+    /** Payment terminal provider */
+    paymentTerminalProvider?: string;
+    /** Invoice ID */
+    invoiceID?: string;
+    /** Payment ID */
+    paymentID?: string;
+    /** Payer\'s e-mail */
+    payerEmail?: string;
+    /** Payer IP-address */
+    payerIP?: string;
+    /** Payer\'s user agent unique fingerprint */
+    payerFingerprint?: string;
+    /** Customer ID */
+    customerID?: string;
+    /** Payment token provider. The list of providers available for making payments can be found by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.  */
+    bankCardTokenProvider?: string;
+    /** Payment system. The list of systems available for making payments can be found by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.  */
+    bankCardPaymentSystem?: string;
+    /** First 6 digits of the card number */
+    first6?: string;
+    /** Card last digits */
+    last4?: string;
+    /** Retrieval Reference Number */
+    rrn?: string;
+    /** Amount */
+    paymentAmount?: number;
+    /** Invoice amount */
+    invoiceAmount?: number;
+    /** A token signaling that only a part of the data has been transmitted in the response. To receive the next part of the data, it is necessary to reapply to the service, specifying the same list of conditions and the received token. If there is no token, the last part of data is received.  */
+    continuationToken?: string;
+}
+export interface SearchPaymentsRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Shop ID */
+    shopID: string;
+    /** Start of the time period */
+    fromTime: string;
+    /** End of the time period */
+    toTime: string;
+    /** Selection limit */
+    limit: number;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+    /** Payment status for search */
+    paymentStatus?: 'pending' | 'processed' | 'captured' | 'cancelled' | 'refunded' | 'failed';
+    /** Payment flow */
+    paymentFlow?: 'instant' | 'hold';
+    /** Payment method */
+    paymentMethod?: 'bankCard' | 'paymentTerminal';
+    /** Payment terminal provider */
+    paymentTerminalProvider?: string;
+    /** Invoice ID */
+    invoiceID?: string;
+    /** Payment ID */
+    paymentID?: string;
+    /** Payer\'s e-mail */
+    payerEmail?: string;
+    /** Payer IP-address */
+    payerIP?: string;
+    /** Payer\'s user agent unique fingerprint */
+    payerFingerprint?: string;
+    /** Customer ID */
+    customerID?: string;
+    /** First 6 digits of the card number */
+    first6?: string;
+    /** Card last digits */
+    last4?: string;
+    /** Retrieval Reference Number */
+    rrn?: string;
+    /** Authorization Approval Code */
+    approvalCode?: string;
+    /** Payment token provider. The list of providers available for making payments can be found by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.  */
+    bankCardTokenProvider?: string;
+    /** Payment system. The list of systems available for making payments can be found by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.  */
+    bankCardPaymentSystem?: string;
+    /** Amount */
+    paymentAmount?: number;
+    /** A token signaling that only a part of the data has been transmitted in the response. To receive the next part of the data, it is necessary to reapply to the service, specifying the same list of conditions and the received token. If there is no token, the last part of data is received.  */
+    continuationToken?: string;
+}
+export interface SearchPayoutsRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Shop ID */
+    shopID: string;
+    /** Start of the time period */
+    fromTime: string;
+    /** End of the time period */
+    toTime: string;
+    /** Selection limit */
+    limit: number;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+    /** Query offset */
+    offset?: number;
+    /** Payout ID */
+    payoutID?: string;
+    /** Type of payout to search * PayoutAccount - payout to bank account * Wallet - payout to wallet * PaymentInstitutionAccount - payout to payment institution account  */
+    payoutToolType?: 'PayoutAccount' | 'Wallet' | 'PaymentInstitutionAccount';
+}
+export interface SearchRefundsRequestParams {
+    /** Unique identifier of the request to the system */
+    xRequestID: string;
+    /** Shop ID */
+    shopID: string;
+    /** Start of the time period */
+    fromTime: string;
+    /** End of the time period */
+    toTime: string;
+    /** Selection limit */
+    limit: number;
+    /** Maximum request processing time */
+    xRequestDeadline?: string;
+    /** Query offset */
+    offset?: number;
+    /** Invoice ID */
+    invoiceID?: string;
+    /** Payment ID */
+    paymentID?: string;
+    /** Refund ID */
+    refundID?: string;
+    /** Retrieval Reference Number */
+    rrn?: string;
+    /** Authorization Approval Code */
+    approvalCode?: string;
+    /** Refund status */
+    refundStatus?: 'pending' | 'succeeded' | 'failed';
+}
+export declare class SearchService {
+    protected httpClient: HttpClient;
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
+    private addToHttpParams;
+    private addToHttpParamsRecursive;
+    /**
+     * Search of invoices
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    searchInvoices(requestParameters: SearchInvoicesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset=utf-8';
+        context?: HttpContext;
+    }): Observable<SearchInvoices200Response>;
+    searchInvoices(requestParameters: SearchInvoicesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<SearchInvoices200Response>>;
+    searchInvoices(requestParameters: SearchInvoicesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<SearchInvoices200Response>>;
+    /**
+     * Search for payments
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    searchPayments(requestParameters: SearchPaymentsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<SearchPayments200Response>;
+    searchPayments(requestParameters: SearchPaymentsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<SearchPayments200Response>>;
+    searchPayments(requestParameters: SearchPaymentsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<SearchPayments200Response>>;
+    /**
+     * Search for payouts
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    searchPayouts(requestParameters: SearchPayoutsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<SearchPayouts200Response>;
+    searchPayouts(requestParameters: SearchPayoutsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<SearchPayouts200Response>>;
+    searchPayouts(requestParameters: SearchPayoutsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<SearchPayouts200Response>>;
+    /**
+     * Search for refunds
+     * @param requestParameters
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    searchRefunds(requestParameters: SearchRefundsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<SearchRefunds200Response>;
+    searchRefunds(requestParameters: SearchRefundsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpResponse<SearchRefunds200Response>>;
+    searchRefunds(requestParameters: SearchRefundsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json; charset&#x3D;utf-8';
+        context?: HttpContext;
+    }): Observable<HttpEvent<SearchRefunds200Response>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SearchService, [null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SearchService>;
+}