@enfuce/nextgen-sdk 0.0.1 → 0.0.3

package/src/threeds-oob/api.ts

@@ -18,178 +18,95 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import globalAxios from 'axios';
 // Some imports not used depending on template conditions
 // @ts-ignore
-import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from './common';
 import type { RequestArgs } from './base';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } 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 const ThreeDsTransactionCategoryEnum = {
     Payment: 'PAYMENT',
-    NonPayment: 'NON_PAYMENT'
+    NonPayment: 'NON_PAYMENT',
 } as const;
 
 export type ThreeDsTransactionCategoryEnum = typeof ThreeDsTransactionCategoryEnum[keyof typeof ThreeDsTransactionCategoryEnum];
 export const ThreeDsTransactionDeviceChannelEnum = {
     App: 'APP',
     Browser: 'BROWSER',
-    RequestorInitiated: 'REQUESTOR_INITIATED'
+    RequestorInitiated: 'REQUESTOR_INITIATED',
 } as const;
 
 export type ThreeDsTransactionDeviceChannelEnum = typeof ThreeDsTransactionDeviceChannelEnum[keyof typeof ThreeDsTransactionDeviceChannelEnum];
@@ -197,7 +114,6 @@ export type ThreeDsTransactionDeviceChannelEnum = typeof ThreeDsTransactionDevic
 
 /**
  * OOBAuthenticationChallengeWebhookNotificationApi - axios parameter creator
- * @export
  */
 export const OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
@@ -227,8 +143,6 @@ export const OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator =
             // http basic authentication required
             setBasicAuthToObject(localVarRequestOptions, configuration)
 
-
-    
             localVarHeaderParameter['Content-Type'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -246,7 +160,6 @@ export const OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator =
 
 /**
  * OOBAuthenticationChallengeWebhookNotificationApi - functional programming interface
- * @export
  */
 export const OOBAuthenticationChallengeWebhookNotificationApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator(configuration)
@@ -269,7 +182,6 @@ export const OOBAuthenticationChallengeWebhookNotificationApiFp = function(confi
 
 /**
  * OOBAuthenticationChallengeWebhookNotificationApi - factory interface
- * @export
  */
 export const OOBAuthenticationChallengeWebhookNotificationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = OOBAuthenticationChallengeWebhookNotificationApiFp(configuration)
@@ -289,9 +201,6 @@ export const OOBAuthenticationChallengeWebhookNotificationApiFactory = function
 
 /**
  * OOBAuthenticationChallengeWebhookNotificationApi - object-oriented interface
- * @export
- * @class OOBAuthenticationChallengeWebhookNotificationApi
- * @extends {BaseAPI}
  */
 export class OOBAuthenticationChallengeWebhookNotificationApi extends BaseAPI {
     /**
@@ -300,7 +209,6 @@ export class OOBAuthenticationChallengeWebhookNotificationApi extends BaseAPI {
      * @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof OOBAuthenticationChallengeWebhookNotificationApi
      */
     public initiateAuthenticationChallenge(initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig) {
         return OOBAuthenticationChallengeWebhookNotificationApiFp(this.configuration).initiateAuthenticationChallenge(initiateAuthenticationChallengeBody, options).then((request) => request(this.axios, this.basePath));

package/src/threeds-oob/base.ts

@@ -21,10 +21,6 @@ import globalAxios from 'axios';
 
 export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
 
-/**
- *
- * @export
- */
 export const COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
@@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = {
     pipes: "|",
 };
 
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
 
-/**
- *
- * @export
- * @class BaseAPI
- */
 export class BaseAPI {
     protected configuration: Configuration | undefined;
 
@@ -58,12 +44,6 @@ export class BaseAPI {
     }
 };
 
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export class RequiredError extends Error {
     constructor(public field: string, msg?: string) {
         super(msg);
@@ -78,9 +58,5 @@ interface ServerMap {
     }[];
 }
 
-/**
- *
- * @export
- */
 export const operationServerMap: ServerMap = {
 }

package/src/threeds-oob/common.ts

@@ -12,22 +12,16 @@
  * Do not edit the class manually.
  */
 
-
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
 import { RequiredError } from "./base";
 
-/**
- *
- * @export
- */
 export const DUMMY_BASE_URL = 'https://example.com'
 
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
     if (paramValue === null || paramValue === undefined) {
@@ -35,10 +29,6 @@ export const assertParamExists = function (functionName: string, paramName: stri
     }
 }
 
-/**
- *
- * @export
- */
 export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -48,20 +38,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri
     }
 }
 
-/**
- *
- * @export
- */
 export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 }
 
-/**
- *
- * @export
- */
 export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -71,10 +53,6 @@ export const setBearerAuthToObject = async function (object: any, configuration?
     }
 }
 
-/**
- *
- * @export
- */
 export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -84,10 +62,11 @@ export const setOAuthToObject = async function (object: any, name: string, scope
     }
 }
 
+
 function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
     if (parameter == null) return;
     if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
             (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
         }
         else {
@@ -106,10 +85,6 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
     }
 }
 
-/**
- *
- * @export
- */
 export const setSearchParams = function (url: URL, ...objects: any[]) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
@@ -117,31 +92,33 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
 }
 
 /**
- *
- * @export
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
  */
+// @ts-ignore
+export const replaceWithSerializableTypeIfNeeded = function(key: string, value: any) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    } else {
+        return value;
+    }
+}
+
 export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: 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 : {})
+        ? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
         : (value || "");
 }
 
-/**
- *
- * @export
- */
 export const toPathString = function (url: URL) {
     return url.pathname + url.search + url.hash
 }
 
-/**
- *
- * @export
- */
 export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
     return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
         const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};

package/src/threeds-oob/configuration.ts

@@ -1,5 +1,4 @@
 /* tslint:disable */
-/* eslint-disable */
 /**
  * 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. 
@@ -12,12 +11,24 @@
  * Do not edit the class manually.
  */
 
+interface AWSv4Configuration {
+  options?: {
+    region?: string
+    service?: string
+  }
+  credentials?: {
+    accessKeyId?: string
+    secretAccessKey?: string,
+    sessionToken?: string
+  }
+}
 
 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>);
+    awsv4?: AWSv4Configuration;
     basePath?: string;
     serverIndex?: number;
     baseOptions?: any;
@@ -28,49 +39,43 @@ export 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}
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
      * @memberof Configuration
      */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**
@@ -87,6 +92,7 @@ export class Configuration {
         this.username = param.username;
         this.password = param.password;
         this.accessToken = param.accessToken;
+        this.awsv4 = param.awsv4;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
         this.baseOptions = {
@@ -109,7 +115,7 @@ export class Configuration {
      * @return True if the given MIME is JSON, false otherwise.
      */
     public isJsonMime(mime: string): boolean {
-        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+        const jsonMime: RegExp = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
+        return mime !== null && jsonMime.test(mime);
     }
 }