@enfuce/nextgen-sdk 0.0.1

package/dist/esm/threeds/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 3DS API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/esm/threeds/common.js

@@ -0,0 +1,149 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 3DS API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { RequiredError } from "./base";
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com';
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName, paramName, paramValue) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+};
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = function (object, keyParamName, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.apiKey) {
+            const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                ? yield configuration.apiKey(keyParamName)
+                : yield configuration.apiKey;
+            object[keyParamName] = localVarApiKeyValue;
+        }
+    });
+};
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object, configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+};
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = function (object, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.accessToken) {
+            const accessToken = typeof configuration.accessToken === 'function'
+                ? yield configuration.accessToken()
+                : yield configuration.accessToken;
+            object["Authorization"] = "Bearer " + accessToken;
+        }
+    });
+};
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = function (object, name, scopes, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.accessToken) {
+            const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                ? yield configuration.accessToken(name, scopes)
+                : yield configuration.accessToken;
+            object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+        }
+    });
+};
+function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        }
+        else {
+            Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
+        }
+    }
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        }
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url, ...objects) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+};
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+};
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url) {
+    return url.pathname + url.search + url.hash;
+};
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
+    return (axios = globalAxios, basePath = BASE_PATH) => {
+        var _a;
+        const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
+        return axios.request(axiosRequestArgs);
+    };
+};

package/dist/esm/threeds/configuration.d.ts

@@ -0,0 +1,91 @@
+/**
+ * 3DS API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * 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 ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/esm/threeds/configuration.js

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 3DS API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export class Configuration {
+    constructor(param = {}) {
+        var _a;
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
+        this.formDataCtor = param.formDataCtor;
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

package/dist/esm/threeds/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 3DS API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";

package/dist/esm/threeds/index.js

@@ -0,0 +1,15 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 3DS API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";

package/dist/esm/threeds-oob/api.d.ts

@@ -0,0 +1,241 @@
+/**
+ * 3DS OOB Outgoing Webhook API
+ * The 3DS Authentication API supports OOB (out of band) authentication during 3DS payment processing, where the client\'s own cardholder authentication service is used.  All endpoints use HTTP response codes; requests and responses are UTF-8 encoded in JSON format. A client must be able to handle new elements added to either the request or response without breaking.   **Timeout**: The 3rd party authentication system has 150 seconds (default, configurable during 3DS setup) to send a callback with the authentication challenge result. After this, Enfuce responds with a timeout to ACS and end user authentication fails.  **CustomerNumber** in this context is equal to `cardholder.customerNumber` in other parts of the Enfuce API.  ## 3DS OOB Authentication flow  ```   Payment Network          Enfuce 3DS API                            Client System          |                       |                                          |          |-- 3ds auth request -->|                                          |  (1)          |                       |-- POST /v1/3ds/oob/challenge/initiate  ->|  (2)          |                       |<-------------- HTTP 200 OK --------------|  (3)          |                       |                                          |          |                       |                               authenticate cardholder          |                       |                                          |          |                       |<-- POST /v1/3ds/challenge/oob/result  ---|  (4)          |<- 3ds auth response --|                                          |  (5) ```  1. Enfuce receives a 3DS authentication request from the payment network including merchant information. 2. Enfuce calls the client system, requesting a cardholder authentication.    - The request contains both `authenticationId` and `challengeId` (UUIDs) that the client system uses when sending the challenge result back.    - It also contains the customerNumber and other contextual info. 3. The client system must return an HTTP 200 OK response within 2 seconds. 4. Once the client system has a result from the cardholder authentication, it calls the \"Submit authentication challenge result\" endpoint,    which needs to happen within 150 seconds from the start. 5. Enfuce responds to the payment network, and the authorization process can proceed.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+/**
+ *
+ * @export
+ * @interface InitiateAuthenticationChallengeBody
+ */
+export interface InitiateAuthenticationChallengeBody {
+    /**
+     * Unique identifier of the authentication request.
+     * @type {string}
+     * @memberof InitiateAuthenticationChallengeBody
+     */
+    'authenticationId': string;
+    /**
+     * Unique challenge identifier of this authentication step.
+     * @type {any}
+     * @memberof InitiateAuthenticationChallengeBody
+     */
+    'challengeId': any;
+    /**
+     *
+     * @type {InitiateAuthenticationChallengeBodyCardholder}
+     * @memberof InitiateAuthenticationChallengeBody
+     */
+    'cardholder': InitiateAuthenticationChallengeBodyCardholder;
+    /**
+     *
+     * @type {InitiateAuthenticationChallengeBodyCard}
+     * @memberof InitiateAuthenticationChallengeBody
+     */
+    'card': InitiateAuthenticationChallengeBodyCard;
+    /**
+     *
+     * @type {ThreeDsTransaction}
+     * @memberof InitiateAuthenticationChallengeBody
+     */
+    'threeDsTransaction'?: ThreeDsTransaction;
+    /**
+     *
+     * @type {Merchant}
+     * @memberof InitiateAuthenticationChallengeBody
+     */
+    'merchant'?: Merchant;
+}
+/**
+ *
+ * @export
+ * @interface InitiateAuthenticationChallengeBodyCard
+ */
+export interface InitiateAuthenticationChallengeBodyCard {
+    /**
+     * Unique identification number of the card.
+     * @type {string}
+     * @memberof InitiateAuthenticationChallengeBodyCard
+     */
+    'id': string;
+    /**
+     * Truncated card number.
+     * @type {string}
+     * @memberof InitiateAuthenticationChallengeBodyCard
+     */
+    'maskedPan': string;
+}
+/**
+ *
+ * @export
+ * @interface InitiateAuthenticationChallengeBodyCardholder
+ */
+export interface InitiateAuthenticationChallengeBodyCardholder {
+    /**
+     * Unique identification number of the cardholder.
+     * @type {string}
+     * @memberof InitiateAuthenticationChallengeBodyCardholder
+     */
+    'id': string;
+    /**
+     * Unique identifier of the cardholder in other parts of the Enfuce API.
+     * @type {string}
+     * @memberof InitiateAuthenticationChallengeBodyCardholder
+     */
+    'customerNumber': string;
+}
+/**
+ *
+ * @export
+ * @interface Merchant
+ */
+export interface Merchant {
+    /**
+     * Merchant name
+     * @type {string}
+     * @memberof Merchant
+     */
+    'name'?: string;
+    /**
+     * The country where the transaction or withdrawal has occurred, or where the merchant is registered.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'country'?: string;
+    /**
+     * Merchant URL
+     * @type {string}
+     * @memberof Merchant
+     */
+    'url'?: string;
+}
+/**
+ * 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;
+}
+/**
+ *
+ * @export
+ * @interface ThreeDsTransaction
+ */
+export interface ThreeDsTransaction {
+    /**
+     *
+     * @type {Money}
+     * @memberof ThreeDsTransaction
+     */
+    'transactionAmount'?: Money;
+    /**
+     * Transaction category: - `PAYMENT` — Payment authentication - `NON_PAYMENT` — Non-payment authentication
+     * @type {string}
+     * @memberof ThreeDsTransaction
+     */
+    'category'?: ThreeDsTransactionCategoryEnum;
+    /**
+     * Channel where the transaction is initiated: - `APP` — App-based - `BROWSER` — Browser-based - `REQUESTOR_INITIATED` — 3DS Requestor Initiated
+     * @type {string}
+     * @memberof ThreeDsTransaction
+     */
+    'deviceChannel': ThreeDsTransactionDeviceChannelEnum;
+    /**
+     * Time when the transaction is processed by Enfuce.
+     * @type {string}
+     * @memberof ThreeDsTransaction
+     */
+    'processedDateTime': string;
+}
+export declare const ThreeDsTransactionCategoryEnum: {
+    readonly Payment: "PAYMENT";
+    readonly NonPayment: "NON_PAYMENT";
+};
+export type ThreeDsTransactionCategoryEnum = typeof ThreeDsTransactionCategoryEnum[keyof typeof ThreeDsTransactionCategoryEnum];
+export declare const ThreeDsTransactionDeviceChannelEnum: {
+    readonly App: "APP";
+    readonly Browser: "BROWSER";
+    readonly RequestorInitiated: "REQUESTOR_INITIATED";
+};
+export type ThreeDsTransactionDeviceChannelEnum = typeof ThreeDsTransactionDeviceChannelEnum[keyof typeof ThreeDsTransactionDeviceChannelEnum];
+/**
+ * OOBAuthenticationChallengeWebhookNotificationApi - axios parameter creator
+ * @export
+ */
+export declare const OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
+     * @summary Initiate OOB Authentication Challenge
+     * @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    initiateAuthenticationChallenge: (initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * OOBAuthenticationChallengeWebhookNotificationApi - functional programming interface
+ * @export
+ */
+export declare const OOBAuthenticationChallengeWebhookNotificationApiFp: (configuration?: Configuration) => {
+    /**
+     * In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
+     * @summary Initiate OOB Authentication Challenge
+     * @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    initiateAuthenticationChallenge(initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * OOBAuthenticationChallengeWebhookNotificationApi - factory interface
+ * @export
+ */
+export declare const OOBAuthenticationChallengeWebhookNotificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
+     * @summary Initiate OOB Authentication Challenge
+     * @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    initiateAuthenticationChallenge(initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * OOBAuthenticationChallengeWebhookNotificationApi - object-oriented interface
+ * @export
+ * @class OOBAuthenticationChallengeWebhookNotificationApi
+ * @extends {BaseAPI}
+ */
+export declare class OOBAuthenticationChallengeWebhookNotificationApi extends BaseAPI {
+    /**
+     * In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
+     * @summary Initiate OOB Authentication Challenge
+     * @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OOBAuthenticationChallengeWebhookNotificationApi
+     */
+    initiateAuthenticationChallenge(initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}