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

package/index.d.ts

@@ -1,5 +1,6 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@vality/swag-payments" />
-export * from './public-api';
+export * from './api/api';
+export * from './model/models';
+export * from './variables';
+export * from './configuration';
+export * from './api.module';
+export * from './param';

package/model/accessToken.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 AccessToken {
+    /**
+     * Access token payload
+     */
+    payload: string;
+}

package/model/allocationFee.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 { AllocationFeeTarget } from './allocationFeeTarget';
+/**
+ * Transaction fee
+ */
+export interface AllocationFee {
+    target?: AllocationFeeTarget;
+    allocationFeeType: AllocationFee.AllocationFeeTypeEnum;
+}
+export declare namespace AllocationFee {
+    type AllocationFeeTypeEnum = 'AllocationFeeFixed' | 'AllocationFeeShare';
+    const AllocationFeeTypeEnum: {
+        AllocationFeeFixed: AllocationFeeTypeEnum;
+        AllocationFeeShare: AllocationFeeTypeEnum;
+    };
+}

package/model/allocationFeeTarget.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.
+ */
+/**
+ * Target of the transaction
+ */
+export interface AllocationFeeTarget {
+    allocationTargetType: AllocationFeeTarget.AllocationTargetTypeEnum;
+}
+export declare namespace AllocationFeeTarget {
+    type AllocationTargetTypeEnum = 'AllocationTargetShop';
+    const AllocationTargetTypeEnum: {
+        AllocationTargetShop: AllocationTargetTypeEnum;
+    };
+}

package/model/allocationTarget.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.
+ */
+/**
+ * Target of the transaction
+ */
+export interface AllocationTarget {
+    allocationTargetType: AllocationTarget.AllocationTargetTypeEnum;
+}
+export declare namespace AllocationTarget {
+    type AllocationTargetTypeEnum = 'AllocationTargetShop';
+    const AllocationTargetTypeEnum: {
+        AllocationTargetShop: AllocationTargetTypeEnum;
+    };
+}

package/model/allocationTargetShop.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 { AllocationTarget } from './allocationTarget';
+/**
+ * The shop as the target of the transaction
+ */
+export interface AllocationTargetShop extends AllocationTarget {
+    /**
+     * Shop ID
+     */
+    shopID: string;
+}
+export declare namespace AllocationTargetShop {
+}

package/model/allocationTransaction.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.
+ */
+import { AllocationTarget } from './allocationTarget';
+import { InvoiceLine } from './invoiceLine';
+/**
+ * Cash allocation transaction
+ */
+export interface AllocationTransaction {
+    target: AllocationTarget;
+    /**
+     * Transaction body
+     */
+    allocationBodyType: AllocationTransaction.AllocationBodyTypeEnum;
+    /**
+     * Products and services cart
+     */
+    cart?: Array<InvoiceLine>;
+}
+export declare namespace AllocationTransaction {
+    type AllocationBodyTypeEnum = 'AllocationBodyAmount' | 'AllocationBodyTotal';
+    const AllocationBodyTypeEnum: {
+        AllocationBodyAmount: AllocationBodyTypeEnum;
+        AllocationBodyTotal: AllocationBodyTypeEnum;
+    };
+}

package/model/apiExtensionRequest.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 { UserInteraction } from './userInteraction';
+export interface ApiExtensionRequest extends UserInteraction {
+    /**
+     * API type to use in subsequent requests
+     */
+    apiType: string;
+}

package/model/applePay.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 ApplePay extends TokenizedCardData {
+    /**
+     * Apple Pay merchant identifier
+     */
+    merchantID: string;
+    /**
+     * Aggregate of open and encrypted payment data
+     */
+    paymentToken: object;
+}
+export declare namespace ApplePay {
+}

package/model/articlesOfAssociation.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 { RepresentativeDocument } from './representativeDocument';
+/**
+ * Articles of association
+ */
+export interface ArticlesOfAssociation extends RepresentativeDocument {
+}
+export declare namespace ArticlesOfAssociation {
+}

package/model/bankAccount.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.
+ */
+/**
+ * Data of a settlement account in a banking organization operating under the jurisdiction of the Russian Federation.
+ */
+export interface BankAccount {
+    /**
+     * Account number
+     */
+    account: string;
+    /**
+     * Name of the legal entity of the banking organization
+     */
+    bankName: string;
+    bankPostAccount: string;
+    /**
+     * BIK of the banking organization
+     */
+    bankBik: string;
+}

package/model/bankCard.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.
+ */
+import { PaymentMethod } from './paymentMethod';
+export interface BankCard extends PaymentMethod {
+    /**
+     * List of payment systems
+     */
+    paymentSystems: Array<string>;
+    /**
+     * List of payment token providers
+     */
+    tokenProviders?: Array<string>;
+    tokenProviderData?: object;
+}
+export declare namespace BankCard {
+}

package/model/bankCardDetails.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 BankCardDetails {
+    /**
+     * Masked card number
+     */
+    cardNumberMask: string;
+    /**
+     * First digits of the card number. Absent for tokenized payment methods.
+     */
+    first6?: string;
+    /**
+     * Card last digits
+     */
+    last4?: 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.
+     */
+    paymentSystem: 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.
+     */
+    tokenProvider?: string;
+    /**
+     * Tokenization method
+     */
+    tokenizationMethod?: BankCardDetails.TokenizationMethodEnum;
+}
+export declare namespace BankCardDetails {
+    type TokenizationMethodEnum = 'dpan' | 'none';
+    const TokenizationMethodEnum: {
+        Dpan: TokenizationMethodEnum;
+        None: TokenizationMethodEnum;
+    };
+}

package/{lib/model → model}/bankCardTokenProviderData.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).

package/model/bankCardTokenizationMethod.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.
+ */
+/**
+ * Tokenization method
+ */
+export type BankCardTokenizationMethod = 'dpan' | 'none';
+export declare const BankCardTokenizationMethod: {
+    Dpan: BankCardTokenizationMethod;
+    None: BankCardTokenizationMethod;
+};

package/model/browserGetRequest.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 { BrowserRequest } from './browserRequest';
+export interface BrowserGetRequest extends BrowserRequest {
+    /**
+     * URL value template for browser navigation The template is represented according to the standard [RFC6570](https://tools.ietf.org/html/rfc6570).
+     */
+    uriTemplate: string;
+}

package/model/browserPostRequest.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 { BrowserRequest } from './browserRequest';
+import { UserInteractionFormInner } from './userInteractionFormInner';
+export interface BrowserPostRequest extends BrowserRequest {
+    /**
+     * URL value template for form submission The template is represented according to the standard [RFC6570](https://tools.ietf.org/html/rfc6570).
+     */
+    uriTemplate: string;
+    /**
+     * Browser submission form
+     */
+    form: Array<UserInteractionFormInner>;
+}

package/model/browserRequest.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 BrowserRequest {
+    /**
+     * Type of browser operation
+     */
+    requestType: string;
+}

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

package/model/captureParams.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { InvoiceLine } from './invoiceLine';
+import { AllocationTransaction } from './allocationTransaction';
+export interface CaptureParams {
+    /**
+     * Operation reason
+     */
+    reason: string;
+    /**
+     * Captured payment amount, in minor monetary units, e.g. cents if US dollars are specified as the currency.
+     */
+    amount?: number;
+    /**
+     * Currency character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
+     */
+    currency?: string;
+    /**
+     * A shopping cart with a list of items of **provided** goods or services
+     */
+    cart?: Array<InvoiceLine>;
+    /**
+     * Final cash allocation
+     */
+    allocation?: Array<AllocationTransaction>;
+}

package/model/capturePayment400Response.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.
+ */
+export interface CapturePayment400Response {
+    /**
+     * [Error code](#tag/Error-Codes)
+     */
+    code: CapturePayment400Response.CodeEnum;
+    /**
+     * Human-readable description of the error
+     */
+    message: string;
+}
+export declare namespace CapturePayment400Response {
+    type CodeEnum = 'invalidPaymentStatus' | 'operationNotPermitted' | 'invalidPartyStatus' | 'invalidShopStatus' | 'invalidRequest' | 'invalidDeadline' | 'invalidInvoiceCart' | 'invalidAllocation' | 'allocationNotPermitted' | 'inconsistentCaptureCurrency' | 'amountExceededCaptureBalance';
+    const CodeEnum: {
+        InvalidPaymentStatus: CodeEnum;
+        OperationNotPermitted: CodeEnum;
+        InvalidPartyStatus: CodeEnum;
+        InvalidShopStatus: CodeEnum;
+        InvalidRequest: CodeEnum;
+        InvalidDeadline: CodeEnum;
+        InvalidInvoiceCart: CodeEnum;
+        InvalidAllocation: CodeEnum;
+        AllocationNotPermitted: CodeEnum;
+        InconsistentCaptureCurrency: CodeEnum;
+        AmountExceededCaptureBalance: CodeEnum;
+    };
+}

package/model/cardData.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.
+ */
+import { PaymentTool } from './paymentTool';
+export interface CardData extends PaymentTool {
+    /**
+     * Bankcard number
+     */
+    cardNumber: string;
+    /**
+     * Bank card expiration date
+     */
+    expDate: string;
+    /**
+     * Verification code
+     */
+    cvv?: string;
+    /**
+     * Cardholder name
+     */
+    cardHolder?: string;
+}
+export declare namespace CardData {
+}

package/model/category.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 Category {
+    name: string;
+    categoryID: number;
+    description?: string;
+}

package/model/chargeback.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.
+ */
+export interface Chargeback {
+    /**
+     * Chargeback ID
+     */
+    id: string;
+    /**
+     * Date and time of creation
+     */
+    createdAt: string;
+    /**
+     * Chargeback amount, in minor monetary units, e.g. cents if US dollars are specified as the currency.
+     */
+    body: number;
+    /**
+     * Chargeback levy amount, in minor monetary units, e.g. cents if US dollars are specified as the currency.
+     */
+    levy: number;
+    /**
+     * Currency character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
+     */
+    currency: string;
+    /**
+     * Chargeback reason code
+     */
+    reasonCode?: string;
+    /**
+     * Chargeback stage
+     */
+    stage: Chargeback.StageEnum;
+    /**
+     * Chargeback status
+     */
+    status: Chargeback.StatusEnum;
+}
+export declare namespace Chargeback {
+    type StageEnum = 'chargeback' | 'pre-arbitration' | 'arbitration';
+    const StageEnum: {
+        Chargeback: StageEnum;
+        PreArbitration: StageEnum;
+        Arbitration: StageEnum;
+    };
+    type StatusEnum = 'pending' | 'rejected' | 'accepted' | 'cancelled';
+    const StatusEnum: {
+        Pending: StatusEnum;
+        Rejected: StatusEnum;
+        Accepted: StatusEnum;
+        Cancelled: StatusEnum;
+    };
+}

package/model/clientInfo.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.
+ */
+/**
+ * Payer\'s client device data
+ */
+export interface ClientInfo {
+    /**
+     * Payer\'s user agent unique fingerprint
+     */
+    fingerprint: string;
+    /**
+     * Payer IP-address
+     */
+    ip?: string;
+    /**
+     * URL from which the payment form was received by the client
+     */
+    url?: string;
+}