@enfuce/nextgen-sdk 0.0.2 → 0.0.4

package/dist/authorisation-control/api.d.ts

@@ -13,218 +13,100 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
-/**
- *
- * @export
- * @interface Account
- */
 export interface Account {
     /**
      * Available amount before this transaction has been processed.
-     * @type {Money}
-     * @memberof Account
      */
     'availableAmount': Money;
 }
-/**
- *
- * @export
- * @interface ApprovedTransaction
- */
 export interface ApprovedTransaction {
     /**
      * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved.  In case of scheme advices, this is generated and transmitted by the scheme.
-     * @type {string}
-     * @memberof ApprovedTransaction
      */
     'authCode'?: string;
     /**
      * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
-     * @type {number}
-     * @memberof ApprovedTransaction
      */
     'authValidity'?: number;
     /**
      * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
-     * @type {Money}
-     * @memberof ApprovedTransaction
      */
     'billingAmount'?: Money;
     /**
      * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
-     * @type {Money}
-     * @memberof ApprovedTransaction
      */
     'transactionAmount'?: Money;
     /**
      * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
-     * @type {Money}
-     * @memberof ApprovedTransaction
      */
     'settlementAmount'?: Money;
     /**
      * Fee charged (for example, by the acquirer) for transaction activity.
-     * @type {Money}
-     * @memberof ApprovedTransaction
      */
     'acquirerTransactionFeeAmount'?: Money;
-    /**
-     *
-     * @type {Array<TransactionFee>}
-     * @memberof ApprovedTransaction
-     */
     'issuerTransactionFees'?: Array<TransactionFee>;
-    /**
-     *
-     * @type {Array<CardholderVerificationMethod>}
-     * @memberof ApprovedTransaction
-     */
     'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
     /**
      * Merchant/acquirer generated transaction reference number.
-     * @type {string}
-     * @memberof ApprovedTransaction
      */
     'retrievalReferenceNumber'?: string;
-    /**
-     *
-     * @type {CardEntryMode}
-     * @memberof ApprovedTransaction
-     */
     'cardEntryMode'?: CardEntryMode;
     /**
      * Indicates whether the cardholder is physically present during transaction.
-     * @type {boolean}
-     * @memberof ApprovedTransaction
      */
     'cardholderPresent'?: boolean;
     /**
      * Indicates whether the card is present at the point of service.
-     * @type {boolean}
-     * @memberof ApprovedTransaction
      */
     'cardPresent'?: boolean;
     /**
      * Indicates whether the transaction is a recurring payment or merchant initiated.  This implies whether the cardholder has approved the merchant initiated transaction.
-     * @type {boolean}
-     * @memberof ApprovedTransaction
      */
     'merchantInitiated'?: boolean;
     /**
      * Date and time in the time zone where the transaction occurred.
-     * @type {string}
-     * @memberof ApprovedTransaction
      */
     'transactionDateTime'?: string;
     /**
      * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
-     * @type {string}
-     * @memberof ApprovedTransaction
      */
     'originalTransactionId'?: string;
-    /**
-     *
-     * @type {TransactionType}
-     * @memberof ApprovedTransaction
-     */
     'transactionType'?: TransactionType;
     /**
      * Amount approved at the current payment processing stage; the amount might be further reduced in the subsequent stages, when the Ledger performs additional validations. If any issuer transaction fee is applied (see the issuerTransactionFees field), the approvedAmount also includes those fees.
-     * @type {Money}
-     * @memberof ApprovedTransaction
      */
     'approvedAmount'?: Money;
     /**
      * Time when processed by Enfuce.
-     * @type {string}
-     * @memberof ApprovedTransaction
      */
     'processedDateTime'?: string;
 }
-/**
- *
- * @export
- * @interface AuthRequestBody
- */
 export interface AuthRequestBody {
     /**
      * Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
-     * @type {string}
-     * @memberof AuthRequestBody
      */
     'id'?: string;
     /**
      * Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same `transactionId`.  For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same `transactionID`.
-     * @type {string}
-     * @memberof AuthRequestBody
      */
     'transactionId'?: string;
-    /**
-     *
-     * @type {MessageCategoryAuthorization}
-     * @memberof AuthRequestBody
-     */
     'messageCategory'?: MessageCategoryAuthorization;
-    /**
-     *
-     * @type {MessageFunctionAuthorization}
-     * @memberof AuthRequestBody
-     */
     'messageFunction'?: MessageFunctionAuthorization;
-    /**
-     *
-     * @type {Token}
-     * @memberof AuthRequestBody
-     */
     'token'?: Token;
-    /**
-     *
-     * @type {Card}
-     * @memberof AuthRequestBody
-     */
     'card': Card;
-    /**
-     *
-     * @type {Merchant}
-     * @memberof AuthRequestBody
-     */
     'merchant': Merchant;
-    /**
-     *
-     * @type {ApprovedTransaction}
-     * @memberof AuthRequestBody
-     */
     'transaction': ApprovedTransaction;
 }
-/**
- *
- * @export
- * @interface AuthResponseBody
- */
 export interface AuthResponseBody {
-    /**
-     *
-     * @type {AuthResponseCode}
-     * @memberof AuthResponseBody
-     */
     'authResponseCode': AuthResponseCode;
-    /**
-     *
-     * @type {Account}
-     * @memberof AuthResponseBody
-     */
     'account'?: Account;
     /**
      * Return when there is a partial approval. When the balance is less than the transaction amount, return the available amount that you authorise. Return this attribute only when in the request `merchant.partialApprovalCapable` is true (i.e. the merchant  approves that a smaller amount than the full transaction amount is authorised), and `authResponseCode`  should be `PARTIALLY_APPROVED`.
-     * @type {Money}
-     * @memberof AuthResponseBody
      */
     'partialApprovalAmount'?: Money;
 }
 /**
  * Indicates whether the authorisation request is approved or declined.  Possible enums:   * `APPROVED` - Approved   * `PARTIALLY_APPROVED` - Approved for partial amount   * `DO_NOT_HONOR` - Do not honor (**Note**: Card schemes recommend to use this only when other options do not apply)   * `NOT_SUFFICIENT_FUNDS` - Inadequate funds   * `NOT_PERMITTED` - Transaction not permitted to cardholder   * `EXCEEDS_AMOUNT_LIMIT` - Exceeds approval amount limit   * `RESTRICTED_CARD` - Restricted card (card invalid in region or country)   * `EXCEEDS_WITHDRAWAL_FREQUENCY_LIMIT` - Exceeds withdrawal frequency limit   * `SYSTEM_ERROR` - System malfunction
- * @export
- * @enum {string}
  */
 export declare const AuthResponseCode: {
     readonly Approved: "APPROVED";
@@ -238,83 +120,48 @@ export declare const AuthResponseCode: {
     readonly SystemError: "SYSTEM_ERROR";
 };
 export type AuthResponseCode = typeof AuthResponseCode[keyof typeof AuthResponseCode];
-/**
- *
- * @export
- * @interface AuthorizationMetadata
- */
 export interface AuthorizationMetadata {
     /**
      * Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
-     * @type {string}
-     * @memberof AuthorizationMetadata
      */
     'id'?: string;
     /**
      * Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same `transactionId`.  For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same `transactionID`.
-     * @type {string}
-     * @memberof AuthorizationMetadata
      */
     'transactionId'?: string;
-    /**
-     *
-     * @type {MessageCategoryAuthorization}
-     * @memberof AuthorizationMetadata
-     */
     'messageCategory'?: MessageCategoryAuthorization;
-    /**
-     *
-     * @type {MessageFunctionAuthorization}
-     * @memberof AuthorizationMetadata
-     */
     'messageFunction'?: MessageFunctionAuthorization;
 }
 /**
  * Information about the card used for the payment.
- * @export
- * @interface Card
  */
 export interface Card {
     /**
      * Enfuce generated unique ID assigned to each card used — enables you to identify the card that you must authorise.
-     * @type {string}
-     * @memberof Card
      */
     'id'?: string;
     /**
      * Card expiration date as received in the scheme message.
-     * @type {Expiration}
-     * @memberof Card
      */
     'expirationDate'?: Expiration;
     /**
      * Card sequence number as received in the scheme message.
-     * @type {number}
-     * @memberof Card
      */
     'sequenceNumber'?: number;
     /**
      * Ledger provided account ID associated with the card.
-     * @type {string}
-     * @memberof Card
      */
     'accountId'?: string;
     /**
      * Unique ID of the cardholder associated with the card.
-     * @type {string}
-     * @memberof Card
      */
     'cardholderId'?: string;
     /**
      * Information about any parent card group associated with the card.
-     * @type {Array<CardGroupsInner>}
-     * @memberof Card
      */
     'groups'?: Array<CardGroupsInner>;
     /**
      * The type of card application used for the transaction.
-     * @type {string}
-     * @memberof Card
      */
     'applicationSelection'?: CardApplicationSelectionEnum;
 }
@@ -325,8 +172,6 @@ export declare const CardApplicationSelectionEnum: {
 export type CardApplicationSelectionEnum = typeof CardApplicationSelectionEnum[keyof typeof CardApplicationSelectionEnum];
 /**
  * Describes how the card credentials were captured.
- * @export
- * @enum {string}
  */
 export declare const CardEntryMode: {
     readonly Chip: "CHIP";
@@ -340,23 +185,14 @@ export declare const CardEntryMode: {
     readonly Unknown: "UNKNOWN";
 };
 export type CardEntryMode = typeof CardEntryMode[keyof typeof CardEntryMode];
-/**
- *
- * @export
- * @interface CardGroupsInner
- */
 export interface CardGroupsInner {
     /**
      * Unique ID assigned to the parent card group.
-     * @type {string}
-     * @memberof CardGroupsInner
      */
     'groupId': string;
 }
 /**
  * The method used for verifying the cardholder: - PIN_VERIFIED_BY_CARD: The card\'s PIN is verified. - PIN_VERIFIED_BY_ISSUER: The card\'s PIN is verified by issuer. - WALLET: The cardholder is verified by the digital wallet. - THREE_DS: The cardholder is 3DS authenticated. - BIOMETRIC: The cardholder is verified by biometrics data. - SIGNATURE: The cardholder\'s signature verified. - NO_VERIFICATION: No verification is performed.
- * @export
- * @enum {string}
  */
 export declare const CardholderVerificationMethod: {
     readonly PinVerifiedByCard: "PIN_VERIFIED_BY_CARD";
@@ -368,139 +204,83 @@ export declare const CardholderVerificationMethod: {
     readonly NoVerification: "NO_VERIFICATION";
 };
 export type CardholderVerificationMethod = typeof CardholderVerificationMethod[keyof typeof CardholderVerificationMethod];
-/**
- *
- * @export
- * @interface Expiration
- */
 export interface Expiration {
     /**
      * Expiration year in YYYY format.
-     * @type {number}
-     * @memberof Expiration
      */
     'year': number;
     /**
      * Expiration month in MM format.
-     * @type {number}
-     * @memberof Expiration
      */
     'month': number;
 }
-/**
- *
- * @export
- * @interface Merchant
- */
 export interface Merchant {
     /**
      * ID assigned code each card acceptor, i.e. a merchant or a bank.
-     * @type {string}
-     * @memberof Merchant
      */
     'id'?: string;
     /**
      * Merchant name as received from the card scheme. For ATMs, this can be a street address or a bank branch number.
-     * @type {string}
-     * @memberof Merchant
      */
     'name'?: string;
     /**
      * The city where the transaction/withdrawal has occurred or where the merchant is registered.
-     * @type {string}
-     * @memberof Merchant
      */
     'city'?: string;
     /**
      * The country where the transaction/withdrawal has occurred or where the merchant is registered.
-     * @type {string}
-     * @memberof Merchant
      */
     'country'?: string;
     /**
      * The merchant\'s postal code.
-     * @type {string}
-     * @memberof Merchant
      */
     'zipCode'?: string;
     /**
      * Contains the merchant\'s street address.
-     * @type {string}
-     * @memberof Merchant
      */
     'address'?: string;
-    /**
-     *
-     * @type {MerchantCategory}
-     * @memberof Merchant
-     */
     'category'?: MerchantCategory;
     /**
      * Uniquely ID assigned to each terminal used by the merchant.
-     * @type {string}
-     * @memberof Merchant
      */
     'terminalId'?: string;
     /**
      * The sub-merchant ID is used when merchant ID is not adequate to identify the merchant.  Used when a merchant uses a payment facilitator.
-     * @type {string}
-     * @memberof Merchant
      */
     'subMerchantId'?: string;
     /**
      * Indicates whether the merchant is capable of accepting partial approval of an amount:   - TRUE: Specifies `TRUE` if the merchant accepts partial approval.   - FALSE: Specifies `FALSE` if the merchant does not accept partial approval.
-     * @type {boolean}
-     * @memberof Merchant
      */
     'partialApprovalCapable'?: boolean;
     /**
      * Unique ID assigned to the financial institution acting as the merchant\'s acquirer.
-     * @type {string}
-     * @memberof Merchant
      */
     'acquirerId'?: string;
     /**
      * The country of the merchant\'s acquirer — mention the ISO-3166-1 alpha-3 country code.
-     * @type {string}
-     * @memberof Merchant
      */
     'acquirerCountry'?: string;
     /**
      * Data an acquirer supplies in an acquirer-originated message, might be required for the issuer  to return to the acquirer in a subsequent message.
-     * @type {string}
-     * @memberof Merchant
      */
     'acquirerReferenceData'?: string;
 }
-/**
- *
- * @export
- * @interface MerchantCategory
- */
 export interface MerchantCategory {
     /**
      * Merchant category code as per the card scheme classification. Categorisation is done based on the type of business or service the merchant provides.
-     * @type {string}
-     * @memberof MerchantCategory
      */
     'code'?: string;
     /**
      * Description of the Merchant Category Code (MCC).
-     * @type {string}
-     * @memberof MerchantCategory
      */
     'description'?: string;
     /**
      * Merchant Category Code (MCC) group as received from the scheme.
-     * @type {string}
-     * @memberof MerchantCategory
      */
     'group'?: string;
 }
 /**
  * Message category sent in the authorisation control webhook. Possible enums:   - INITIAL_AUTHORIZATION: Initial authorisation of the card payment.   - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction.   - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application.   - PIN_MANAGEMENT: Request to change the card PIN.
- * @export
- * @enum {string}
  */
 export declare const MessageCategoryAuthorization: {
     readonly InitialAuthorization: "INITIAL_AUTHORIZATION";
@@ -511,8 +291,6 @@ export declare const MessageCategoryAuthorization: {
 export type MessageCategoryAuthorization = typeof MessageCategoryAuthorization[keyof typeof MessageCategoryAuthorization];
 /**
  * Identifies the message function of the authorisation request.
- * @export
- * @enum {string}
  */
 export declare const MessageFunctionAuthorization: {
     readonly Request: "REQUEST";
@@ -520,39 +298,21 @@ export declare const MessageFunctionAuthorization: {
 export type MessageFunctionAuthorization = typeof MessageFunctionAuthorization[keyof typeof MessageFunctionAuthorization];
 /**
  * Amount including currency.
- * @export
- * @interface Money
  */
 export interface Money {
-    /**
-     *
-     * @type {number}
-     * @memberof Money
-     */
     'amount': number;
     /**
      * A valid ISO 4217 currency code
-     * @type {string}
-     * @memberof Money
      */
     'currency': string;
 }
 /**
  * Information about the token associated with the card.
- * @export
- * @interface Token
  */
 export interface Token {
-    /**
-     *
-     * @type {string}
-     * @memberof Token
-     */
     'id'?: string;
     /**
      * Identifies the specific digital wallet.
-     * @type {string}
-     * @memberof Token
      */
     'walletIdentifier'?: TokenWalletIdentifierEnum;
 }
@@ -564,119 +324,66 @@ export declare const TokenWalletIdentifierEnum: {
     readonly RemoteCommercePrograms: "REMOTE_COMMERCE_PROGRAMS";
 };
 export type TokenWalletIdentifierEnum = typeof TokenWalletIdentifierEnum[keyof typeof TokenWalletIdentifierEnum];
-/**
- *
- * @export
- * @interface Transaction
- */
 export interface Transaction {
     /**
      * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved.  In case of scheme advices, this is generated and transmitted by the scheme.
-     * @type {string}
-     * @memberof Transaction
      */
     'authCode'?: string;
     /**
      * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
-     * @type {number}
-     * @memberof Transaction
      */
     'authValidity'?: number;
     /**
      * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
-     * @type {Money}
-     * @memberof Transaction
      */
     'billingAmount'?: Money;
     /**
      * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
-     * @type {Money}
-     * @memberof Transaction
      */
     'transactionAmount'?: Money;
     /**
      * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
-     * @type {Money}
-     * @memberof Transaction
      */
     'settlementAmount'?: Money;
     /**
      * Fee charged (for example, by the acquirer) for transaction activity.
-     * @type {Money}
-     * @memberof Transaction
      */
     'acquirerTransactionFeeAmount'?: Money;
-    /**
-     *
-     * @type {Array<TransactionFee>}
-     * @memberof Transaction
-     */
     'issuerTransactionFees'?: Array<TransactionFee>;
-    /**
-     *
-     * @type {Array<CardholderVerificationMethod>}
-     * @memberof Transaction
-     */
     'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
     /**
      * Merchant/acquirer generated transaction reference number.
-     * @type {string}
-     * @memberof Transaction
      */
     'retrievalReferenceNumber'?: string;
-    /**
-     *
-     * @type {CardEntryMode}
-     * @memberof Transaction
-     */
     'cardEntryMode'?: CardEntryMode;
     /**
      * Indicates whether the cardholder is physically present during transaction.
-     * @type {boolean}
-     * @memberof Transaction
      */
     'cardholderPresent'?: boolean;
     /**
      * Indicates whether the card is present at the point of service.
-     * @type {boolean}
-     * @memberof Transaction
      */
     'cardPresent'?: boolean;
     /**
      * Indicates whether the transaction is a recurring payment or merchant initiated.  This implies whether the cardholder has approved the merchant initiated transaction.
-     * @type {boolean}
-     * @memberof Transaction
      */
     'merchantInitiated'?: boolean;
     /**
      * Date and time in the time zone where the transaction occurred.
-     * @type {string}
-     * @memberof Transaction
      */
     'transactionDateTime'?: string;
     /**
      * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
-     * @type {string}
-     * @memberof Transaction
      */
     'originalTransactionId'?: string;
 }
-/**
- *
- * @export
- * @interface TransactionFee
- */
 export interface TransactionFee {
     /**
      * Type of Issuer generated transaction fee in cardholder billing currency.  Transaction based fees that are additional fees charged on top of the transaction.
-     * @type {string}
-     * @memberof TransactionFee
      */
     'type'?: TransactionFeeTypeEnum;
     /**
      * Transaction fee amount in cardholder billing currency.
-     * @type {Money}
-     * @memberof TransactionFee
      */
     'amount'?: Money;
 }
@@ -688,8 +395,6 @@ export declare const TransactionFeeTypeEnum: {
 export type TransactionFeeTypeEnum = typeof TransactionFeeTypeEnum[keyof typeof TransactionFeeTypeEnum];
 /**
  * The transaction Type
- * @export
- * @enum {string}
  */
 export declare const TransactionType: {
     readonly Retail: "RETAIL";
@@ -712,7 +417,6 @@ export declare const TransactionType: {
 export type TransactionType = typeof TransactionType[keyof typeof TransactionType];
 /**
  * AuthorisationRequestAPIApi - axios parameter creator
- * @export
  */
 export declare const AuthorisationRequestAPIApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -726,7 +430,6 @@ export declare const AuthorisationRequestAPIApiAxiosParamCreator: (configuration
 };
 /**
  * AuthorisationRequestAPIApi - functional programming interface
- * @export
  */
 export declare const AuthorisationRequestAPIApiFp: (configuration?: Configuration) => {
     /**
@@ -740,7 +443,6 @@ export declare const AuthorisationRequestAPIApiFp: (configuration?: Configuratio
 };
 /**
  * AuthorisationRequestAPIApi - factory interface
- * @export
  */
 export declare const AuthorisationRequestAPIApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -754,9 +456,6 @@ export declare const AuthorisationRequestAPIApiFactory: (configuration?: Configu
 };
 /**
  * AuthorisationRequestAPIApi - object-oriented interface
- * @export
- * @class AuthorisationRequestAPIApi
- * @extends {BaseAPI}
  */
 export declare class AuthorisationRequestAPIApi extends BaseAPI {
     /**
@@ -765,7 +464,6 @@ export declare class AuthorisationRequestAPIApi extends BaseAPI {
      * @param {AuthRequestBody} authRequestBody
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof AuthorisationRequestAPIApi
      */
     authPost(authRequestBody: AuthRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthResponseBody, any, {}>>;
 }