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

package/model/customerBindingError.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+/**
+ * Description of the error that occurred during the binding process
+ */
+export interface CustomerBindingError {
+    code: string;
+    message: string;
+}

package/model/customerBindingInteractionCompleted.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.
+ */
+import { UserInteraction } from './userInteraction';
+import { CustomerChange } from './customerChange';
+export interface CustomerBindingInteractionCompleted extends CustomerChange {
+    /**
+     * Customer binding identifier
+     */
+    customerBindingID: string;
+    userInteraction?: UserInteraction;
+}
+export declare namespace CustomerBindingInteractionCompleted {
+}

package/model/customerBindingInteractionRequested.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.
+ */
+import { UserInteraction } from './userInteraction';
+import { CustomerChange } from './customerChange';
+export interface CustomerBindingInteractionRequested extends CustomerChange {
+    /**
+     * Customer binding identifier
+     */
+    customerBindingID: string;
+    userInteraction: UserInteraction;
+}
+export declare namespace CustomerBindingInteractionRequested {
+}

package/model/customerBindingParams.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { PaymentResource } from './paymentResource';
+export interface CustomerBindingParams {
+    /**
+     * External customer binding identifier
+     */
+    externalID?: string;
+    paymentResource: PaymentResource;
+}

package/model/customerBindingStarted.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 { CustomerBinding } from './customerBinding';
+import { CustomerChange } from './customerChange';
+export interface CustomerBindingStarted extends CustomerChange {
+    customerBinding: CustomerBinding;
+}
+export declare namespace CustomerBindingStarted {
+}

package/model/customerBindingStatus.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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';
+export interface CustomerBindingStatus {
+    /**
+     * Binding status
+     */
+    status: CustomerBindingStatus.StatusEnum;
+    error?: CustomerBindingError;
+}
+export declare namespace CustomerBindingStatus {
+    type StatusEnum = 'pending' | 'succeeded' | 'failed';
+    const StatusEnum: {
+        Pending: StatusEnum;
+        Succeeded: StatusEnum;
+        Failed: StatusEnum;
+    };
+}

package/model/customerBindingStatusChanged.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { CustomerChange } from './customerChange';
+export interface CustomerBindingStatusChanged extends CustomerChange {
+    /**
+     * Binding status
+     */
+    status: CustomerBindingStatusChanged.StatusEnum;
+    error?: CustomerBindingError;
+    customerBindingID: string;
+}
+export declare namespace CustomerBindingStatusChanged {
+    type StatusEnum = 'pending' | 'succeeded' | 'failed';
+    const StatusEnum: {
+        Pending: StatusEnum;
+        Succeeded: StatusEnum;
+        Failed: StatusEnum;
+    };
+}

package/model/customerChange.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 CustomerChange {
+    changeType: CustomerChange.ChangeTypeEnum;
+}
+export declare namespace CustomerChange {
+    type ChangeTypeEnum = 'CustomerBindingStarted' | 'CustomerBindingStatusChanged' | 'CustomerBindingInteractionRequested' | 'CustomerBindingInteractionCompleted';
+    const ChangeTypeEnum: {
+        CustomerBindingStarted: ChangeTypeEnum;
+        CustomerBindingStatusChanged: ChangeTypeEnum;
+        CustomerBindingInteractionRequested: ChangeTypeEnum;
+        CustomerBindingInteractionCompleted: ChangeTypeEnum;
+    };
+}

package/model/customerEvent.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 { CustomerChange } from './customerChange';
+export interface CustomerEvent {
+    id: number;
+    createdAt: string;
+    changes: Array<CustomerChange>;
+}

package/model/customerParams.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.
+ */
+import { ContactInfo } from './contactInfo';
+export interface CustomerParams {
+    /**
+     * External customer identifier
+     */
+    externalID?: string;
+    /**
+     * Shop ID
+     */
+    shopID: string;
+    /**
+     * The participant\'s unique identifier within the system.
+     */
+    partyID?: string;
+    contactInfo: ContactInfo;
+    /**
+     * Customer metadata
+     */
+    metadata: object;
+}

package/model/customerPayer.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { Payer } from './payer';
+import { PaymentToolDetails } from './paymentToolDetails';
+/**
+ * Reusable payment tool
+ */
+export interface CustomerPayer extends Payer {
+    /**
+     * Customer ID
+     */
+    customerID: string;
+    paymentToolDetails?: PaymentToolDetails;
+}

package/model/customersTopic.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { WebhookScope } from './webhookScope';
+/**
+ * Scope that includes customer events within a specific shop
+ */
+export interface CustomersTopic extends WebhookScope {
+    /**
+     * Shop ID
+     */
+    shopID: string;
+    /**
+     * List of customer event types to be notified about
+     */
+    eventTypes: Array<CustomersTopic.EventTypesEnum>;
+}
+export declare namespace CustomersTopic {
+    type EventTypesEnum = 'CustomerCreated' | 'CustomerDeleted' | 'CustomerReady' | 'CustomerBindingStarted' | 'CustomerBindingSucceeded' | 'CustomerBindingFailed';
+    const EventTypesEnum: {
+        CustomerCreated: EventTypesEnum;
+        CustomerDeleted: EventTypesEnum;
+        CustomerReady: EventTypesEnum;
+        CustomerBindingStarted: EventTypesEnum;
+        CustomerBindingSucceeded: EventTypesEnum;
+        CustomerBindingFailed: EventTypesEnum;
+    };
+}

package/model/decimal.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+/**
+ * Fractional decimal number of arbitrary precision
+ */
+export interface Decimal {
+    /**
+     * Mantissa.
+     */
+    m: number;
+    /**
+     * Exponent.
+     */
+    exp: number;
+}

package/model/defaultLogicError.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.
+ */
+export interface DefaultLogicError {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: DefaultLogicError.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace DefaultLogicError {
+    type CodeEnum = 'invalidRequest' | 'invalidDeadline';
+    const CodeEnum: {
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+    };
+}

package/model/deleteCustomer400Response.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 DeleteCustomer400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: DeleteCustomer400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace DeleteCustomer400Response {
+    type CodeEnum = 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidRequest' | 'invalidDeadline';
+    const CodeEnum: {
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+    };
+}

package/model/digitalWallet.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 DigitalWallet extends PaymentMethod {
+    /**
+     * List of E-wallet providers
+     */
+    providers: Array<string>;
+}
+export declare namespace DigitalWallet {
+}

package/model/digitalWalletData.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.
+ */
+import { PaymentTool } from './paymentTool';
+export interface DigitalWalletData extends PaymentTool {
+    /**
+     * E-wallet identifier
+     */
+    id: string;
+    /**
+     * E-wallet provider. The list of providers available for making payments can be found by calling the the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice. Additional provider details can be found out by calling [reference operation](#operation/getServiceProviderByID).
+     */
+    provider: string;
+    /**
+     * Token
+     */
+    token?: string;
+}
+export declare namespace DigitalWalletData {
+}

package/model/digitalWalletDetails.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 DigitalWalletDetails {
+    /**
+     * E-wallet provider. The list of providers available for making payments can be found by calling the the corresponding [operation](#operation/getInvoicePaymentMethods) after creating an invoice. Additional provider details can be found out by calling [reference operation](#operation/getServiceProviderByID).
+     */
+    provider: string;
+}

package/model/externalIDConflictError.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 ExternalIDConflictError {
+    /**
+     * The passed value of `externalID` for which a request parameter conflict was detected
+     */
+    externalID: string;
+    /**
+     * Identifier of the content, created by a previous query with the specified `externalID\'
+     */
+    id?: string;
+    /**
+     * Human-readable description of the error
+     */
+    message?: string;
+}

package/model/fulfillInvoice400Response.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 FulfillInvoice400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: FulfillInvoice400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace FulfillInvoice400Response {
+    type CodeEnum = 'invalidInvoiceStatus' | 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidRequest' | 'invalidDeadline';
+    const CodeEnum: {
+        InvalidInvoiceStatus: CodeEnum;
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+    };
+}

package/model/generalError.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 GeneralError {
+    message: string;
+}

package/model/googlePay.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { TokenizedCardData } from './tokenizedCardData';
+export interface GooglePay extends TokenizedCardData {
+    /**
+     * Merchant identifier in the system
+     */
+    gatewayMerchantID: string;
+    /**
+     * Aggregate of open and encrypted payment data
+     */
+    paymentToken: object;
+}
+export declare namespace GooglePay {
+}

package/model/internationalBankAccount.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.
+ */
+import { InternationalCorrespondentBankAccount } from './internationalCorrespondentBankAccount';
+import { InternationalBankDetails } from './internationalBankDetails';
+/**
+ * International bank account data
+ */
+export interface InternationalBankAccount {
+    /**
+     * Account number
+     */
+    number?: string;
+    /**
+     * International Bank Account Number [ISO 13616](https://en.wikipedia.org/wiki/International_Bank_Account_Number) _* If `iban` is specified, `bankDetails` is not required._
+     */
+    iban?: string;
+    bankDetails?: InternationalBankDetails;
+    correspondentBankAccount?: InternationalCorrespondentBankAccount;
+}

package/model/internationalBankDetails.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ */
+/**
+ * International banking organization data
+ */
+export interface InternationalBankDetails {
+    /**
+     * Business Identifier Code [ISO 9362](https://en.wikipedia.org/wiki/ISO_9362). _* If `bic` is specified, other data is optional._
+     */
+    bic?: string;
+    /**
+     * [ABA Routing Transit Number](https://en.wikipedia.org/wiki/ABA_routing_transit_number) banking organization specific to the USA banking system. _* If `abartn` is specified, other data is optional._
+     */
+    abartn?: string;
+    /**
+     * Name of the legal entity of the banking organization
+     */
+    name?: string;
+    /**
+     * Country code of residence of the banking organization, alpha-3 code according to [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)
+     */
+    countryCode?: string;
+    /**
+     * Address of the legal entity of the banking organization
+     */
+    address?: string;
+}

package/model/internationalCorrespondentBankAccount.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { InternationalBankDetails } from './internationalBankDetails';
+export interface InternationalCorrespondentBankAccount {
+    /**
+     * Account number
+     */
+    number?: string;
+    /**
+     * International Bank Account Number [ISO 13616](https://en.wikipedia.org/wiki/International_Bank_Account_Number) _* If `iban` is specified, `bankDetails` is not required._
+     */
+    iban?: string;
+    bankDetails?: InternationalBankDetails;
+    correspondentBankAccount?: InternationalCorrespondentBankAccount;
+}

package/model/internationalLegalEntity.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 { LegalEntity } from './legalEntity';
+/**
+ * International legal entity
+ */
+export interface InternationalLegalEntity extends LegalEntity {
+    /**
+     * Name
+     */
+    legalName: string;
+    /**
+     * Trade name (if applicable)
+     */
+    tradingName?: string;
+    /**
+     * Registration postal address
+     */
+    registeredOffice: string;
+    /**
+     * Location address (if different from the address of registration)
+     */
+    principalPlaceOfBusiness?: string;
+    /**
+     * Registration number
+     */
+    registeredNumber?: string;
+    /**
+     * Alpha-3 country code by standard [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)
+     */
+    country?: string;
+}
+export declare namespace InternationalLegalEntity {
+}

package/{lib/model → model}/invoice.d.ts

@@ -1,8 +1,6 @@
 /**
  * Vality Payments API
- * ## Description API is designed for the merchants who accept payments via user interface such as a website or a mobile app and it is the only interaction point with the system for goods and services payment transactions. ## Interaction details Whenever an API is accessed, its unique ID must be passed in the header X-Request-ID of the corresponding request: ```  X-Request-ID: 37d735d4-0f42-4f05-89fa-eaa478fb5aa9 ``` ### Content type and coding The system accepts and returns data in JSON format and UTF-8 coding: ```   Content-Type: application/json; charset=utf-8 ``` ### Date formats The system accepts and returns timestamp values in the format date-time, described in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339): ```   2017-01-01T00:00:00Z   2017-01-01T00:00:01+00:00 ``` ### Maximum request processing time Whenever an API is accessed, the time cutoff parameters, that define maximum request processing time of the transaction completion, can be passed in the header `X-Request-Deadline` of the corresponding request: ```  X-Request-Deadline: 10s ``` The system stops processing the request upon the specified time. It is recommended to specify a value that is not more than one minute and not less than three seconds. `X-Request-Deadline` can be:  * specified in the format `date-time` according to [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339); * specified in relative values: in milliseconds (`150000ms`), in seconds (`540s`) or in minutes (`3.5m`).
  *
- * The version of the OpenAPI document: 2.0.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,6 +9,7 @@
  */
 import { InvoiceLine } from './invoiceLine';
 import { AllocationTransaction } from './allocationTransaction';
+import { InvoiceAmountRandomized } from './invoiceAmountRandomized';
 import { InvoiceClientInfo } from './invoiceClientInfo';
 import { InvoiceBankAccount } from './invoiceBankAccount';
 export interface Invoice {
@@ -68,6 +67,7 @@ export interface Invoice {
      */
     metadata: object;
     clientInfo?: InvoiceClientInfo;
+    amountRandomized?: InvoiceAmountRandomized;
     /**
      * Invoice status
      */