@emilgroup/customer-sdk-node 1.63.1-beta.0 → 1.63.1-beta.5

package/.openapi-generator/FILES

@@ -22,6 +22,8 @@ git_push.sh
 index.ts
 models/account-class.ts
 models/account-policy-class.ts
+models/attach-customer-payment-method-request-dto.ts
+models/attach-customer-payment-method-response-class.ts
 models/authentication-result-class.ts
 models/bank-transfer-dto.ts
 models/billing-address-dto.ts
@@ -48,6 +50,8 @@ models/create-policy-request-dto.ts
 models/create-presigned-post-response-class.ts
 models/customer-class.ts
 models/customer-document-class.ts
+models/customer-payment-method-class.ts
+models/customer-policy-payment-method-class.ts
 models/customer-product-class.ts
 models/forgot-password-request-dto.ts
 models/get-customer-claim-response-class.ts
@@ -83,6 +87,7 @@ models/lead-bank-account-class.ts
 models/lead-class.ts
 models/link-lead-partner-request-dto.ts
 models/list-customer-claims-response-class.ts
+models/list-customer-payment-methods-response-class.ts
 models/list-documents-response-class.ts
 models/list-invoices-response-class.ts
 models/list-leads-response-class.ts

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/customer-sdk-node@1.63.1-beta.0 --save
+npm install @emilgroup/customer-sdk-node@1.63.1-beta.5 --save
 ```
 or 
 ```
-yarn add @emilgroup/customer-sdk-node@1.63.1-beta.0
+yarn add @emilgroup/customer-sdk-node@1.63.1-beta.5
 ```
 
 And then you can import `CustomersApi`.

package/api/customer-controller-rest-api.ts

@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
+import { AttachCustomerPaymentMethodRequestDto } from '../models';
+// @ts-ignore
+import { AttachCustomerPaymentMethodResponseClass } from '../models';
+// @ts-ignore
 import { ChangeCustomerEmailRequestDto } from '../models';
 // @ts-ignore
 import { ChangePasswordRequestDto } from '../models';
@@ -61,6 +65,8 @@ import { InviteByTenantRequestDto } from '../models';
 // @ts-ignore
 import { InviteByTenantResponseClass } from '../models';
 // @ts-ignore
+import { ListCustomerPaymentMethodsResponseClass } from '../models';
+// @ts-ignore
 import { ListDocumentsResponseClass } from '../models';
 // @ts-ignore
 import { ListInvoicesResponseClass } from '../models';
@@ -100,6 +106,57 @@ const FormData = require('form-data');
  */
 export const CustomerControllerRestApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Use one of the customer\'s payment methods for future payments of the given policy.
+         * @summary Attach a payment method to a policy
+         * @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
+         * @param {string} paymentMethodCode Code of one of the customer\'s payment methods.
+         * @param {AttachCustomerPaymentMethodRequestDto} attachCustomerPaymentMethodRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        attachPaymentMethod: async (customerCode: string, paymentMethodCode: string, attachCustomerPaymentMethodRequestDto: AttachCustomerPaymentMethodRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'customerCode' is not null or undefined
+            assertParamExists('attachPaymentMethod', 'customerCode', customerCode)
+            // verify required parameter 'paymentMethodCode' is not null or undefined
+            assertParamExists('attachPaymentMethod', 'paymentMethodCode', paymentMethodCode)
+            // verify required parameter 'attachCustomerPaymentMethodRequestDto' is not null or undefined
+            assertParamExists('attachPaymentMethod', 'attachCustomerPaymentMethodRequestDto', attachCustomerPaymentMethodRequestDto)
+            const localVarPath = `/v1/customers/{customerCode}/payment-methods/{paymentMethodCode}/attach`
+                .replace(`{${"customerCode"}}`, encodeURIComponent(String(customerCode)))
+                .replace(`{${"paymentMethodCode"}}`, encodeURIComponent(String(paymentMethodCode)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(attachCustomerPaymentMethodRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Change customer\'s email using the token provided by the request email change endpoint.
          * @summary Change customer email
@@ -795,6 +852,62 @@ export const CustomerControllerRestApiAxiosParamCreator = function (configuratio
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List the payment methods on the customer\'s account, for example to choose one to attach to policies. IBANs are masked to their last four digits.
+         * @summary List payment methods of a customer
+         * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {string} [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 {string} [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 {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPaymentMethods: async (customerCode: string, pageSize?: number, pageToken?: string, order?: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'customerCode' is not null or undefined
+            assertParamExists('listPaymentMethods', 'customerCode', customerCode)
+            const localVarPath = `/v1/customers/{customerCode}/payment-methods`
+                .replace(`{${"customerCode"}}`, encodeURIComponent(String(customerCode)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -1190,6 +1303,20 @@ export const CustomerControllerRestApiAxiosParamCreator = function (configuratio
 export const CustomerControllerRestApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = CustomerControllerRestApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Use one of the customer\'s payment methods for future payments of the given policy.
+         * @summary Attach a payment method to a policy
+         * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+         * @param {string} paymentMethodCode Code of one of the customer\&#39;s payment methods.
+         * @param {AttachCustomerPaymentMethodRequestDto} attachCustomerPaymentMethodRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async attachPaymentMethod(customerCode: string, paymentMethodCode: string, attachCustomerPaymentMethodRequestDto: AttachCustomerPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AttachCustomerPaymentMethodResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.attachPaymentMethod(customerCode, paymentMethodCode, attachCustomerPaymentMethodRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Change customer\'s email using the token provided by the request email change endpoint.
          * @summary Change customer email
@@ -1381,6 +1508,21 @@ export const CustomerControllerRestApiFp = function(configuration?: Configuratio
             const localVarAxiosArgs = await localVarAxiosParamCreator.listInvoices(customerCode, pageSize, pageToken, filter, search, order, expand, filters, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * List the payment methods on the customer\'s account, for example to choose one to attach to policies. IBANs are masked to their last four digits.
+         * @summary List payment methods of a customer
+         * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {string} [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 {string} [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 {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPaymentMethods(customerCode: string, pageSize?: number, pageToken?: string, order?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerPaymentMethodsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentMethods(customerCode, pageSize, pageToken, order, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Get new access token, new refresh token.
          * @summary Refresh token by customer
@@ -1497,6 +1639,19 @@ export const CustomerControllerRestApiFp = function(configuration?: Configuratio
 export const CustomerControllerRestApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = CustomerControllerRestApiFp(configuration)
     return {
+        /**
+         * Use one of the customer\'s payment methods for future payments of the given policy.
+         * @summary Attach a payment method to a policy
+         * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+         * @param {string} paymentMethodCode Code of one of the customer\&#39;s payment methods.
+         * @param {AttachCustomerPaymentMethodRequestDto} attachCustomerPaymentMethodRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        attachPaymentMethod(customerCode: string, paymentMethodCode: string, attachCustomerPaymentMethodRequestDto: AttachCustomerPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<AttachCustomerPaymentMethodResponseClass> {
+            return localVarFp.attachPaymentMethod(customerCode, paymentMethodCode, attachCustomerPaymentMethodRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * Change customer\'s email using the token provided by the request email change endpoint.
          * @summary Change customer email
@@ -1674,6 +1829,20 @@ export const CustomerControllerRestApiFactory = function (configuration?: Config
         listInvoices(customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: any): AxiosPromise<ListInvoicesResponseClass> {
             return localVarFp.listInvoices(customerCode, pageSize, pageToken, filter, search, order, expand, filters, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * List the payment methods on the customer\'s account, for example to choose one to attach to policies. IBANs are masked to their last four digits.
+         * @summary List payment methods of a customer
+         * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @param {string} [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 {string} [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 {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPaymentMethods(customerCode: string, pageSize?: number, pageToken?: string, order?: string, authorization?: string, options?: any): AxiosPromise<ListCustomerPaymentMethodsResponseClass> {
+            return localVarFp.listPaymentMethods(customerCode, pageSize, pageToken, order, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get new access token, new refresh token.
          * @summary Refresh token by customer
@@ -1774,6 +1943,41 @@ export const CustomerControllerRestApiFactory = function (configuration?: Config
     };
 };
 
+/**
+ * Request parameters for attachPaymentMethod operation in CustomerControllerRestApi.
+ * @export
+ * @interface CustomerControllerRestApiAttachPaymentMethodRequest
+ */
+export interface CustomerControllerRestApiAttachPaymentMethodRequest {
+    /**
+     * The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @type {string}
+     * @memberof CustomerControllerRestApiAttachPaymentMethod
+     */
+    readonly customerCode: string
+
+    /**
+     * Code of one of the customer\&#39;s payment methods.
+     * @type {string}
+     * @memberof CustomerControllerRestApiAttachPaymentMethod
+     */
+    readonly paymentMethodCode: string
+
+    /**
+     * 
+     * @type {AttachCustomerPaymentMethodRequestDto}
+     * @memberof CustomerControllerRestApiAttachPaymentMethod
+     */
+    readonly attachCustomerPaymentMethodRequestDto: AttachCustomerPaymentMethodRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CustomerControllerRestApiAttachPaymentMethod
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for changeCustomerEmail operation in CustomerControllerRestApi.
  * @export
@@ -2229,6 +2433,48 @@ export interface CustomerControllerRestApiListInvoicesRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for listPaymentMethods operation in CustomerControllerRestApi.
+ * @export
+ * @interface CustomerControllerRestApiListPaymentMethodsRequest
+ */
+export interface CustomerControllerRestApiListPaymentMethodsRequest {
+    /**
+     * The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @type {string}
+     * @memberof CustomerControllerRestApiListPaymentMethods
+     */
+    readonly customerCode: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof CustomerControllerRestApiListPaymentMethods
+     */
+    readonly pageSize?: number
+
+    /**
+     * 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 {string}
+     * @memberof CustomerControllerRestApiListPaymentMethods
+     */
+    readonly pageToken?: string
+
+    /**
+     * 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 {string}
+     * @memberof CustomerControllerRestApiListPaymentMethods
+     */
+    readonly order?: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CustomerControllerRestApiListPaymentMethods
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for refreshToken operation in CustomerControllerRestApi.
  * @export
@@ -2411,6 +2657,18 @@ export interface CustomerControllerRestApiVerifyResetPasswordTokenRequest {
  * @extends {BaseAPI}
  */
 export class CustomerControllerRestApi extends BaseAPI {
+    /**
+     * Use one of the customer\'s payment methods for future payments of the given policy.
+     * @summary Attach a payment method to a policy
+     * @param {CustomerControllerRestApiAttachPaymentMethodRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerControllerRestApi
+     */
+    public attachPaymentMethod(requestParameters: CustomerControllerRestApiAttachPaymentMethodRequest, options?: AxiosRequestConfig) {
+        return CustomerControllerRestApiFp(this.configuration).attachPaymentMethod(requestParameters.customerCode, requestParameters.paymentMethodCode, requestParameters.attachCustomerPaymentMethodRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Change customer\'s email using the token provided by the request email change endpoint.
      * @summary Change customer email
@@ -2579,6 +2837,18 @@ export class CustomerControllerRestApi extends BaseAPI {
         return CustomerControllerRestApiFp(this.configuration).listInvoices(requestParameters.customerCode, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * List the payment methods on the customer\'s account, for example to choose one to attach to policies. IBANs are masked to their last four digits.
+     * @summary List payment methods of a customer
+     * @param {CustomerControllerRestApiListPaymentMethodsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerControllerRestApi
+     */
+    public listPaymentMethods(requestParameters: CustomerControllerRestApiListPaymentMethodsRequest, options?: AxiosRequestConfig) {
+        return CustomerControllerRestApiFp(this.configuration).listPaymentMethods(requestParameters.customerCode, requestParameters.pageSize, requestParameters.pageToken, requestParameters.order, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get new access token, new refresh token.
      * @summary Refresh token by customer