@emilgroup/payment-sdk-node 1.6.0 → 1.8.0

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/payment-sdk-node@1.6.0 --save
+npm install @emilgroup/payment-sdk-node@1.8.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/payment-sdk-node@1.6.0
+yarn add @emilgroup/payment-sdk-node@1.8.0
 ```
 
 And then you can import `PaymentsApi`.

package/api/payments-api.ts

@@ -41,13 +41,15 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
         /**
          * Creates a payment for a specified account. This function is idempotent.
          * @summary Create a payment
+         * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {CreatePaymentRequestDto} createPaymentRequestDto 
          * @param {string} [authorization] Bearer Token
-         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createPayment: async (createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, idempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        createPayment: async (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'idempotencyKey' is not null or undefined
+            assertParamExists('createPayment', 'idempotencyKey', idempotencyKey)
             // verify required parameter 'createPaymentRequestDto' is not null or undefined
             assertParamExists('createPayment', 'createPaymentRequestDto', createPaymentRequestDto)
             const localVarPath = `/paymentservice/v1/payments`;
@@ -232,14 +234,14 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
         /**
          * Creates a payment for a specified account. This function is idempotent.
          * @summary Create a payment
+         * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {CreatePaymentRequestDto} createPaymentRequestDto 
          * @param {string} [authorization] Bearer Token
-         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createPayment(createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.createPayment(createPaymentRequestDto, authorization, idempotencyKey, options);
+        async createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -286,14 +288,14 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
         /**
          * Creates a payment for a specified account. This function is idempotent.
          * @summary Create a payment
+         * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {CreatePaymentRequestDto} createPaymentRequestDto 
          * @param {string} [authorization] Bearer Token
-         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createPayment(createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, idempotencyKey?: string, options?: any): AxiosPromise<CreatePaymentResponseClass> {
-            return localVarFp.createPayment(createPaymentRequestDto, authorization, idempotencyKey, options).then((request) => request(axios, basePath));
+        createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass> {
+            return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieves the details of a payment that was previously created. Supply the unique payment      code that was returned when you created the payment and Emil Api will return the corresponding payment      information.
@@ -333,6 +335,13 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
  * @interface PaymentsApiCreatePaymentRequest
  */
 export interface PaymentsApiCreatePaymentRequest {
+    /**
+     * Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
+     * @type {string}
+     * @memberof PaymentsApiCreatePayment
+     */
+    readonly idempotencyKey: string
+
     /**
      * 
      * @type {CreatePaymentRequestDto}
@@ -346,13 +355,6 @@ export interface PaymentsApiCreatePaymentRequest {
      * @memberof PaymentsApiCreatePayment
      */
     readonly authorization?: string
-
-    /**
-     * Idempotency Key used to make the request idempotent. The key should be unique.      Usually, a generated v4 UUID is enough.
-     * @type {string}
-     * @memberof PaymentsApiCreatePayment
-     */
-    readonly idempotencyKey?: string
 }
 
 /**
@@ -462,7 +464,7 @@ export class PaymentsApi extends BaseAPI {
      * @memberof PaymentsApi
      */
     public createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig) {
-        return PaymentsApiFp(this.configuration).createPayment(requestParameters.createPaymentRequestDto, requestParameters.authorization, requestParameters.idempotencyKey, options).then((request) => request(this.axios, this.basePath));
+        return PaymentsApiFp(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/models/create-payment-request-dto.ts

@@ -56,5 +56,23 @@ export interface CreatePaymentRequestDto {
      * @memberof CreatePaymentRequestDto
      */
     'productSlug'?: string;
+    /**
+     * Optional payment date.
+     * @type {string}
+     * @memberof CreatePaymentRequestDto
+     */
+    'receivedDate'?: string;
+    /**
+     * Optional reference number.
+     * @type {string}
+     * @memberof CreatePaymentRequestDto
+     */
+    'referenceNumber'?: string;
+    /**
+     * Optional comment.
+     * @type {string}
+     * @memberof CreatePaymentRequestDto
+     */
+    'comment'?: string;
 }
 

package/models/initiate-payment-setup-request-dto.ts

@@ -40,5 +40,11 @@ export interface InitiatePaymentSetupRequestDto {
      * @memberof InitiatePaymentSetupRequestDto
      */
     'b4u'?: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof InitiatePaymentSetupRequestDto
+     */
+    'eis'?: object;
 }
 

package/models/payment-class.ts

@@ -63,18 +63,12 @@ export interface PaymentClass {
      * @memberof PaymentClass
      */
     'createdAt': string;
-    /**
-     * Time at which the object was updated.
-     * @type {string}
-     * @memberof PaymentClass
-     */
-    'updatedAt': string;
     /**
      * Transactions referenced by this payment.
      * @type {Array<TransactionClass>}
      * @memberof PaymentClass
      */
-    'transactions': Array<TransactionClass>;
+    'transactions'?: Array<TransactionClass>;
     /**
      * Optional field contain extra information.
      * @type {object}
@@ -87,5 +81,29 @@ export interface PaymentClass {
      * @memberof PaymentClass
      */
     'productSlug'?: string;
+    /**
+     * User who created the payment.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'createdBy': string;
+    /**
+     * Time at which the payment was actually received.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'receivedDate': string;
+    /**
+     * Reference number of the payment.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'referenceNumber'?: string;
+    /**
+     * Comment on this payment
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'comment'?: string;
 }
 

package/models/validate-pspconfig-request-dto.ts

@@ -43,7 +43,8 @@ export interface ValidatePSPConfigRequestDto {
 export const ValidatePSPConfigRequestDtoTypeEnum = {
     Braintree: 'braintree',
     Stripe: 'stripe',
-    B4u: 'b4u'
+    B4u: 'b4u',
+    Eis: 'eis'
 } as const;
 
 export type ValidatePSPConfigRequestDtoTypeEnum = typeof ValidatePSPConfigRequestDtoTypeEnum[keyof typeof ValidatePSPConfigRequestDtoTypeEnum];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/payment-sdk-node",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "OpenAPI client for @emilgroup/payment-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -23,7 +23,7 @@
     "url": "^0.11.0"
   },
   "devDependencies": {
-   "@types/node": "^12.11.5",
+    "@types/node": "^12.11.5",
     "typescript": "^4.0"
   }
 }

package/dist/api/bank-accounts-api.d.ts

@@ -1,197 +0,0 @@
-/**
- * Emil Payment Service
- * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
- *
- * The version of the OpenAPI document: 1.0
- * Contact: kontakt@emil.de
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
-import { RequestArgs, BaseAPI } from '../base';
-import { CreateBankAccountRequestDto } from '../models';
-import { ListBankAccountsResponseClass } from '../models';
-/**
- * BankAccountsApi - axios parameter creator
- * @export
- */
-export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Creates a bank account for a specified account.
-     * @summary Create a bank account
-     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createBankAccount: (createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Returns a list of bank accounts you’ve previously created.        The bank accounts are returned in sorted order,        with the oldest payment appearing first. For more information about pagination, read the Pagination        documentation.
-     * @summary List bank accounts
-     * @param {string} [authorization] Bearer Token
-     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
-     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
-     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listBankAccounts: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * BankAccountsApi - functional programming interface
- * @export
- */
-export declare const BankAccountsApiFp: (configuration?: Configuration) => {
-    /**
-     * Creates a bank account for a specified account.
-     * @summary Create a bank account
-     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
-    /**
-     * Returns a list of bank accounts you’ve previously created.        The bank accounts are returned in sorted order,        with the oldest payment appearing first. For more information about pagination, read the Pagination        documentation.
-     * @summary List bank accounts
-     * @param {string} [authorization] Bearer Token
-     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
-     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
-     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankAccountsResponseClass>>;
-};
-/**
- * BankAccountsApi - factory interface
- * @export
- */
-export declare const BankAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Creates a bank account for a specified account.
-     * @summary Create a bank account
-     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
-    /**
-     * Returns a list of bank accounts you’ve previously created.        The bank accounts are returned in sorted order,        with the oldest payment appearing first. For more information about pagination, read the Pagination        documentation.
-     * @summary List bank accounts
-     * @param {string} [authorization] Bearer Token
-     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
-     * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
-     * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-     * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListBankAccountsResponseClass>;
-};
-/**
- * Request parameters for createBankAccount operation in BankAccountsApi.
- * @export
- * @interface BankAccountsApiCreateBankAccountRequest
- */
-export interface BankAccountsApiCreateBankAccountRequest {
-    /**
-     *
-     * @type {CreateBankAccountRequestDto}
-     * @memberof BankAccountsApiCreateBankAccount
-     */
-    readonly createBankAccountRequestDto: CreateBankAccountRequestDto;
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof BankAccountsApiCreateBankAccount
-     */
-    readonly authorization?: string;
-}
-/**
- * Request parameters for listBankAccounts operation in BankAccountsApi.
- * @export
- * @interface BankAccountsApiListBankAccountsRequest
- */
-export interface BankAccountsApiListBankAccountsRequest {
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof BankAccountsApiListBankAccounts
-     */
-    readonly authorization?: string;
-    /**
-     * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
-     * @type {any}
-     * @memberof BankAccountsApiListBankAccounts
-     */
-    readonly pageSize?: any;
-    /**
-     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-     * @type {any}
-     * @memberof BankAccountsApiListBankAccounts
-     */
-    readonly pageToken?: any;
-    /**
-     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @type {any}
-     * @memberof BankAccountsApiListBankAccounts
-     */
-    readonly filter?: any;
-    /**
-     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
-     * @type {any}
-     * @memberof BankAccountsApiListBankAccounts
-     */
-    readonly search?: any;
-    /**
-     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-     * @type {any}
-     * @memberof BankAccountsApiListBankAccounts
-     */
-    readonly order?: any;
-    /**
-     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @type {any}
-     * @memberof BankAccountsApiListBankAccounts
-     */
-    readonly expand?: any;
-}
-/**
- * BankAccountsApi - object-oriented interface
- * @export
- * @class BankAccountsApi
- * @extends {BaseAPI}
- */
-export declare class BankAccountsApi extends BaseAPI {
-    /**
-     * Creates a bank account for a specified account.
-     * @summary Create a bank account
-     * @param {BankAccountsApiCreateBankAccountRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof BankAccountsApi
-     */
-    createBankAccount(requestParameters: BankAccountsApiCreateBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
-    /**
-     * Returns a list of bank accounts you’ve previously created.        The bank accounts are returned in sorted order,        with the oldest payment appearing first. For more information about pagination, read the Pagination        documentation.
-     * @summary List bank accounts
-     * @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof BankAccountsApi
-     */
-    listBankAccounts(requestParameters?: BankAccountsApiListBankAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankAccountsResponseClass, any>>;
-}