@vality/swag-payments 0.1.3-e658db3.0 → 0.1.3-fd6802c.0

package/model/contactInfo.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Contact details
+ */
+export interface ContactInfo {
+    /**
+     * Email address
+     */
+    email?: string;
+    /**
+     * Mobile phone number with international prefix according to [E.164](https://en.wikipedia.org/wiki/E.164).
+     */
+    phoneNumber?: string;
+    /**
+     * First name
+     */
+    firstName?: string;
+    /**
+     * Last name
+     */
+    lastName?: string;
+    /**
+     * Alpha-3 country code by standard [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)
+     */
+    country?: string;
+    /**
+     * State
+     */
+    state?: string;
+    /**
+     * City
+     */
+    city?: string;
+    /**
+     * Address
+     */
+    address?: string;
+    /**
+     * Postal code
+     */
+    postalCode?: string;
+    /**
+     * Date of birth
+     */
+    dateOfBirth?: string;
+    /**
+     * Identity document number
+     */
+    documentId?: string;
+}

package/model/contract.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { LegalAgreement } from './legalAgreement';
+import { Contractor } from './contractor';
+import { ReportingPreferences } from './reportingPreferences';
+/**
+ * Contract details
+ */
+export interface Contract {
+    /**
+     * Contract ID
+     */
+    id: string;
+    /**
+     * Date and time of contract creation
+     */
+    createdAt: string;
+    /**
+     * Contract status
+     */
+    status: Contract.StatusEnum;
+    /**
+     * Contract effective date and time
+     */
+    validSince?: string;
+    /**
+     * Contract expiration date and time
+     */
+    validUntil?: string;
+    /**
+     * Contract termination date and time
+     */
+    terminatedAt?: string;
+    contractor: Contractor;
+    legalAgreement?: LegalAgreement;
+    paymentInstitutionID: number;
+    reportingPreferences?: ReportingPreferences;
+}
+export declare namespace Contract {
+    type StatusEnum = 'active' | 'terminated';
+    const StatusEnum: {
+        Active: StatusEnum;
+        Terminated: StatusEnum;
+    };
+}

package/model/contractAdjustment.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Data of contract adjustment
+ */
+export interface ContractAdjustment {
+    /**
+     * Contract adjustment identifier
+     */
+    id: string;
+    /**
+     * Date and time of contract adjustment creation
+     */
+    createdAt: string;
+    /**
+     * Contract adjustment effective date and time
+     */
+    validSince?: string;
+    /**
+     * Contract adjustment expiration date and time
+     */
+    validUntil?: string;
+}

package/model/contractor.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Contractor data
+ */
+export interface Contractor {
+    /**
+     * Contractor type
+     */
+    contractorType: Contractor.ContractorTypeEnum;
+}
+export declare namespace Contractor {
+    type ContractorTypeEnum = 'LegalEntity' | 'PrivateEntity' | 'RegisteredUser';
+    const ContractorTypeEnum: {
+        LegalEntity: ContractorTypeEnum;
+        PrivateEntity: ContractorTypeEnum;
+        RegisteredUser: ContractorTypeEnum;
+    };
+}

package/model/costAmountRange.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CostAmountRange {
+    /**
+     * An upper (inclusive) limit on the value of goods or services.
+     */
+    upperBound: number;
+    /**
+     * A lower (inclusive) limit on the value of goods or services.
+     */
+    lowerBound: number;
+}

package/model/country.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Country
+ */
+export interface Country {
+    /**
+     * Alpha-3 country code by standard [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)
+     */
+    id: string;
+    name: string;
+    tradeBlocs?: Array<string>;
+}

package/model/createBinding400Response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreateBinding400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CreateBinding400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CreateBinding400Response {
+    type CodeEnum = 'invalidPaymentResource' | 'operationNotPermitted' | 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidPaymentToolToken' | 'invalidPaymentSession' | 'invalidRequest' | 'invalidDeadline';
+    const CodeEnum: {
+        InvalidPaymentResource: CodeEnum;
+        OperationNotPermitted: CodeEnum;
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidPaymentToolToken: CodeEnum;
+        InvalidPaymentSession: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+    };
+}

package/model/createCustomer400Response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreateCustomer400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CreateCustomer400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CreateCustomer400Response {
+    type CodeEnum = 'operationNotPermitted' | 'invalidPartyID' | 'invalidShopID' | 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidRequest' | 'invalidDeadline' | 'ambiguousPartyID';
+    const CodeEnum: {
+        OperationNotPermitted: CodeEnum;
+        InvalidPartyId: CodeEnum;
+        InvalidShopId: CodeEnum;
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+        AmbiguousPartyId: CodeEnum;
+    };
+}

package/model/createInvoice400Response.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreateInvoice400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CreateInvoice400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CreateInvoice400Response {
+    type CodeEnum = 'invalidPartyID' | 'invalidShopID' | 'invalidRequest' | 'invalidDeadline' | 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidInvoiceCart' | 'invalidAllocation' | 'allocationNotPermitted' | 'invalidInvoiceCost' | 'invoiceTermsViolated' | 'ambiguousPartyID';
+    const CodeEnum: {
+        InvalidPartyId: CodeEnum;
+        InvalidShopId: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidInvoiceCart: CodeEnum;
+        InvalidAllocation: CodeEnum;
+        AllocationNotPermitted: CodeEnum;
+        InvalidInvoiceCost: CodeEnum;
+        InvoiceTermsViolated: CodeEnum;
+        AmbiguousPartyId: CodeEnum;
+    };
+}

package/model/createInvoiceTemplate400Response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreateInvoiceTemplate400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CreateInvoiceTemplate400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CreateInvoiceTemplate400Response {
+    type CodeEnum = 'invalidPartyID' | 'invalidRequest' | 'invalidDeadline' | 'invalidShopID' | 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidInvoiceCart' | 'ambiguousPartyID';
+    const CodeEnum: {
+        InvalidPartyId: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+        InvalidShopId: CodeEnum;
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidInvoiceCart: CodeEnum;
+        AmbiguousPartyId: CodeEnum;
+    };
+}

package/model/createInvoiceWithTemplate400Response.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreateInvoiceWithTemplate400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CreateInvoiceWithTemplate400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CreateInvoiceWithTemplate400Response {
+    type CodeEnum = 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidRequest' | 'invalidDeadline' | 'invoiceTermsViolated';
+    const CodeEnum: {
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+        InvoiceTermsViolated: CodeEnum;
+    };
+}

package/model/createPayment400Response.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreatePayment400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CreatePayment400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CreatePayment400Response {
+    type CodeEnum = 'invalidInvoiceStatus' | 'invoicePaymentPending' | 'invalidRequest' | 'invalidDeadline' | 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidContractStatus' | 'invalidPaymentToolToken' | 'invalidPaymentSession' | 'invalidProcessingDeadline' | 'invalidRecurrentParent' | 'operationNotPermitted';
+    const CodeEnum: {
+        InvalidInvoiceStatus: CodeEnum;
+        InvoicePaymentPending: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidContractStatus: CodeEnum;
+        InvalidPaymentToolToken: CodeEnum;
+        InvalidPaymentSession: CodeEnum;
+        InvalidProcessingDeadline: CodeEnum;
+        InvalidRecurrentParent: CodeEnum;
+        OperationNotPermitted: CodeEnum;
+    };
+}

package/model/createRefund400Response.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreateRefund400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CreateRefund400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CreateRefund400Response {
+    type CodeEnum = 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidContractStatus' | 'invalidInvoiceCart' | 'invalidAllocation' | 'allocationNotPermitted' | 'operationNotPermitted' | 'invalidPaymentStatus' | 'insufficentAccountBalance' | 'invoicePaymentAmountExceeded' | 'inconsistentRefundCurrency' | 'invalidRequest' | 'invalidDeadline' | 'chargebackInProgress' | 'refundCartConflict';
+    const CodeEnum: {
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidContractStatus: CodeEnum;
+        InvalidInvoiceCart: CodeEnum;
+        InvalidAllocation: CodeEnum;
+        AllocationNotPermitted: CodeEnum;
+        OperationNotPermitted: CodeEnum;
+        InvalidPaymentStatus: CodeEnum;
+        InsufficentAccountBalance: CodeEnum;
+        InvoicePaymentAmountExceeded: CodeEnum;
+        InconsistentRefundCurrency: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+        ChargebackInProgress: CodeEnum;
+        RefundCartConflict: CodeEnum;
+    };
+}

package/model/createWebhook400Response.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreateWebhook400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CreateWebhook400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CreateWebhook400Response {
+    type CodeEnum = 'invalidPartyID' | 'invalidShopID' | 'invalidRequest' | 'invalidDeadline' | 'ambiguousPartyID';
+    const CodeEnum: {
+        InvalidPartyId: CodeEnum;
+        InvalidShopId: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+        AmbiguousPartyId: CodeEnum;
+    };
+}

package/model/createWebhook429Response.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CreateWebhook429Response {
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}

package/model/cryptoCurrencyTransferRequest.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UserInteraction } from './userInteraction';
+export interface CryptoCurrencyTransferRequest extends UserInteraction {
+    /**
+     * Cryptocurrency wallet address
+     */
+    cryptoAddress: string;
+    /**
+     * Cryptocurrency symbolic code
+     */
+    symbolicCode: string;
+    /**
+     * Amount of cash in cryptocurrency
+     */
+    cryptoAmount: string;
+}

package/model/cryptoWallet.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentMethod } from './paymentMethod';
+export interface CryptoWallet extends PaymentMethod {
+    /**
+     * List of cryptocurrencies
+     */
+    cryptoCurrencies: Array<string>;
+}
+export declare namespace CryptoWallet {
+}

package/model/cryptoWalletData.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentTool } from './paymentTool';
+export interface CryptoWalletData extends PaymentTool {
+    /**
+     * Cryptocurrency payment method. The list of cryptocurrencies available for making payments can be found out by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.
+     */
+    cryptoCurrency: string;
+}
+export declare namespace CryptoWalletData {
+}

package/model/cryptoWalletDetails.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface CryptoWalletDetails {
+    /**
+     * Cryptocurrency payment method. The list of cryptocurrencies available for making payments can be found out by calling the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice.
+     */
+    cryptoCurrency: string;
+}

package/model/customer.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ContactInfo } from './contactInfo';
+export interface Customer {
+    /**
+     * Customer ID
+     */
+    readonly id?: string;
+    /**
+     * External customer identifier
+     */
+    externalID?: string;
+    /**
+     * Shop ID
+     */
+    shopID: string;
+    /**
+     * The participant\'s unique identifier within the system.
+     */
+    partyID?: string;
+    contactInfo: ContactInfo;
+    /**
+     * Customer status
+     */
+    readonly status?: Customer.StatusEnum;
+    /**
+     * Customer metadata
+     */
+    metadata: object;
+}
+export declare namespace Customer {
+    type StatusEnum = 'ready' | 'unready';
+    const StatusEnum: {
+        Ready: StatusEnum;
+        Unready: StatusEnum;
+    };
+}

package/model/customerAndToken.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Customer } from './customer';
+import { AccessToken } from './accessToken';
+export interface CustomerAndToken {
+    customer: Customer;
+    customerAccessToken: AccessToken;
+}

package/model/customerBinding.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Vality Payments API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CustomerBindingError } from './customerBindingError';
+import { PaymentResource } from './paymentResource';
+export interface CustomerBinding {
+    /**
+     * Customer binding identifier
+     */
+    id: string;
+    /**
+     * External customer binding identifier
+     */
+    externalID?: string;
+    paymentResource: PaymentResource;
+    /**
+     * Binding status
+     */
+    status: CustomerBinding.StatusEnum;
+    error?: CustomerBindingError;
+}
+export declare namespace CustomerBinding {
+    type StatusEnum = 'pending' | 'succeeded' | 'failed';
+    const StatusEnum: {
+        Pending: StatusEnum;
+        Succeeded: StatusEnum;
+        Failed: StatusEnum;
+    };
+}