Release 3.2.0

Author: wallee-deployment-user

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 wallee AG
+   Copyright 2023 wallee AG
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -94,6 +94,32 @@ transactionService.create(spaceId, transaction).then((response) => {
 
 ```
 
+### Configure connection timeout
+Connection timeout determines how long the request can take, before cutting off the connection. Same value applies both to inner 'Read timeout' and 'Connection timeout' of a [NPM request module](https://www.npmjs.com/package/request).
+
+Default connection timeout is 25s.
+
+
+Connection timeout can be set 2 ways:
+
+1. Via configuration property 'timeout' providing value in seconds.
+```
+let config = {
+    ... other properties ...
+    timeout: 15
+}
+let transactionService: PostFinanceCheckout.api.TransactionService = new PostFinanceCheckout.api.TransactionService(config);
+```
+
+2. Via service property 'timeout' providing value in seconds
+```
+let config = {
+    ... properties ...
+}
+let transactionService: PostFinanceCheckout.api.TransactionService = new PostFinanceCheckout.api.TransactionService(config);
+transactionService.timeout = 15;
+```
+
 ## License
 
 Please see the [license file](https://github.com/pfpayments/typescript-sdk/blob/master/LICENSE) for more information.

index.ts

@@ -243,6 +243,7 @@ import { User as UserModelImport } from "./src/models/User";
 import { UserAccountRole as UserAccountRoleModelImport } from "./src/models/UserAccountRole";
 import { UserSpaceRole as UserSpaceRoleModelImport } from "./src/models/UserSpaceRole";
 import { UserType as UserTypeModelImport } from "./src/models/UserType";
+import { WalletType as WalletTypeModelImport } from "./src/models/WalletType";
 import { WebhookIdentity as WebhookIdentityModelImport } from "./src/models/WebhookIdentity";
 import { WebhookListener as WebhookListenerModelImport } from "./src/models/WebhookListener";
 import { WebhookListenerEntity as WebhookListenerEntityModelImport } from "./src/models/WebhookListenerEntity";
@@ -869,6 +870,8 @@ export namespace PostFinanceCheckout {
         export const UserSpaceRole = UserSpaceRoleModelImport;
         export type UserType = UserTypeModelImport;
         export const UserType = UserTypeModelImport;
+        export type WalletType = WalletTypeModelImport;
+        export const WalletType = WalletTypeModelImport;
         export type WebhookIdentity = WebhookIdentityModelImport;
         export const WebhookIdentity = WebhookIdentityModelImport;
         export type WebhookListener = WebhookListenerModelImport;

package.json

@@ -1,7 +1,7 @@
 {
     "name": "postfinancecheckout",
     "title": "PostFinance Checkout",
-    "version": "3.1.2",
+    "version": "3.2.0",
     "description": "TypeScript/JavaScript client for PostFinance Checkout",
     "homepage": "http://github.com/pfpayments/typescript-sdk",
     "repository": {

src/api/AccountService.ts

@@ -20,6 +20,7 @@ class AccountService {
     protected _basePath = 'https://checkout.postfinance.ch:443/api';
     protected defaultHeaders : any = {};
     protected _useQuerystring : boolean = false;
+    protected _timeout : number = 25;
 
     protected authentications = {
         'default': <Authentication>new VoidAuth({})
@@ -28,6 +29,28 @@ class AccountService {
     constructor(configuration: any) {
         this.setDefaultAuthentication(new VoidAuth(configuration));
         this.defaultHeaders = configuration.default_headers;
+        this.setTimeout(configuration.timeout);
+    }
+
+    /**
+    * Set timeout in seconds. Default timeout: 25 seconds
+    * @param {number} timeout
+    */
+    set timeout(timeout: number) {
+        this.setTimeout(timeout)
+    }
+
+    private setTimeout(timeout: number) {
+        if (timeout !== undefined) {
+            if (!Number.isInteger(timeout)) {
+                throw new Error('Timeout value has to be integer');
+            }
+            if (timeout) {
+                this._timeout = timeout;
+            } else {
+                throw new Error('Timeout value has to be greater than 0');
+            }
+        }
     }
 
     set useQuerystring(value: boolean) {
@@ -61,7 +84,7 @@ class AccountService {
     * @param {*} [options] Override http request options.
     */
     public _delete (id: number, options: any = {}) : Promise<{ response: http.IncomingMessage; body?: any;  }> {
-        const localVarPath = this.basePath + '/account/delete';
+        const localVarPath = '/account/delete';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
         let localVarFormParams: any = {};
@@ -74,7 +97,7 @@ class AccountService {
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let defaultHeaderParams = {
-            "x-meta-sdk-version": "3.1.2",
+            "x-meta-sdk-version": "3.2.0",
             "x-meta-sdk-language": "typescript",
             "x-meta-sdk-provider": "PostFinance Checkout",
             "x-meta-sdk-language-version": this.getVersion(),
@@ -85,13 +108,15 @@ class AccountService {
         let localVarUseFormData = false;
 
         let localVarRequestOptions: localVarRequest.Options = {
+            baseUrl: this._basePath,
             method: 'POST',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
             body: ObjectSerializer.serialize(id, "number"),
+            timeout: this._timeout * 1000
         };
 
         this.authentications.default.applyToRequest(localVarRequestOptions);
@@ -151,15 +176,15 @@ class AccountService {
     * @param {*} [options] Override http request options.
     */
     public count (filter?: EntityQueryFilter, options: any = {}) : Promise<{ response: http.IncomingMessage; body: number;  }> {
-        const localVarPath = this.basePath + '/account/count';
+        const localVarPath = '/account/count';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
         let localVarFormParams: any = {};
 
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let defaultHeaderParams = {
-            "x-meta-sdk-version": "3.1.2",
+            "x-meta-sdk-version": "3.2.0",
             "x-meta-sdk-language": "typescript",
             "x-meta-sdk-provider": "PostFinance Checkout",
             "x-meta-sdk-language-version": this.getVersion(),
@@ -170,13 +195,15 @@ class AccountService {
         let localVarUseFormData = false;
 
         let localVarRequestOptions: localVarRequest.Options = {
+            baseUrl: this._basePath,
             method: 'POST',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
             body: ObjectSerializer.serialize(filter, "EntityQueryFilter"),
+            timeout: this._timeout * 1000
         };
 
         this.authentications.default.applyToRequest(localVarRequestOptions);
@@ -236,7 +263,7 @@ class AccountService {
     * @param {*} [options] Override http request options.
     */
     public create (entity: AccountCreate, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Account;  }> {
-        const localVarPath = this.basePath + '/account/create';
+        const localVarPath = '/account/create';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
         let localVarFormParams: any = {};
@@ -249,7 +276,7 @@ class AccountService {
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let defaultHeaderParams = {
-            "x-meta-sdk-version": "3.1.2",
+            "x-meta-sdk-version": "3.2.0",
             "x-meta-sdk-language": "typescript",
             "x-meta-sdk-provider": "PostFinance Checkout",
             "x-meta-sdk-language-version": this.getVersion(),
@@ -260,13 +287,15 @@ class AccountService {
         let localVarUseFormData = false;
 
         let localVarRequestOptions: localVarRequest.Options = {
+            baseUrl: this._basePath,
             method: 'POST',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
             body: ObjectSerializer.serialize(entity, "AccountCreate"),
+            timeout: this._timeout * 1000
         };
 
         this.authentications.default.applyToRequest(localVarRequestOptions);
@@ -326,7 +355,7 @@ class AccountService {
     * @param {*} [options] Override http request options.
     */
     public read (id: number, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Account;  }> {
-        const localVarPath = this.basePath + '/account/read';
+        const localVarPath = '/account/read';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
         let localVarFormParams: any = {};
@@ -343,7 +372,7 @@ class AccountService {
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let defaultHeaderParams = {
-            "x-meta-sdk-version": "3.1.2",
+            "x-meta-sdk-version": "3.2.0",
             "x-meta-sdk-language": "typescript",
             "x-meta-sdk-provider": "PostFinance Checkout",
             "x-meta-sdk-language-version": this.getVersion(),
@@ -354,12 +383,14 @@ class AccountService {
         let localVarUseFormData = false;
 
         let localVarRequestOptions: localVarRequest.Options = {
+            baseUrl: this._basePath,
             method: 'GET',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
+            timeout: this._timeout * 1000
         };
 
         this.authentications.default.applyToRequest(localVarRequestOptions);
@@ -419,7 +450,7 @@ class AccountService {
     * @param {*} [options] Override http request options.
     */
     public search (query: EntityQuery, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Array<Account>;  }> {
-        const localVarPath = this.basePath + '/account/search';
+        const localVarPath = '/account/search';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
         let localVarFormParams: any = {};
@@ -432,7 +463,7 @@ class AccountService {
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let defaultHeaderParams = {
-            "x-meta-sdk-version": "3.1.2",
+            "x-meta-sdk-version": "3.2.0",
             "x-meta-sdk-language": "typescript",
             "x-meta-sdk-provider": "PostFinance Checkout",
             "x-meta-sdk-language-version": this.getVersion(),
@@ -443,13 +474,15 @@ class AccountService {
         let localVarUseFormData = false;
 
         let localVarRequestOptions: localVarRequest.Options = {
+            baseUrl: this._basePath,
             method: 'POST',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
             body: ObjectSerializer.serialize(query, "EntityQuery"),
+            timeout: this._timeout * 1000
         };
 
         this.authentications.default.applyToRequest(localVarRequestOptions);
@@ -509,7 +542,7 @@ class AccountService {
     * @param {*} [options] Override http request options.
     */
     public update (entity: AccountUpdate, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Account;  }> {
-        const localVarPath = this.basePath + '/account/update';
+        const localVarPath = '/account/update';
         let localVarQueryParameters: any = {};
         let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
         let localVarFormParams: any = {};
@@ -522,7 +555,7 @@ class AccountService {
         (<any>Object).assign(localVarHeaderParams, options.headers);
 
         let defaultHeaderParams = {
-            "x-meta-sdk-version": "3.1.2",
+            "x-meta-sdk-version": "3.2.0",
             "x-meta-sdk-language": "typescript",
             "x-meta-sdk-provider": "PostFinance Checkout",
             "x-meta-sdk-language-version": this.getVersion(),
@@ -533,13 +566,15 @@ class AccountService {
         let localVarUseFormData = false;
 
         let localVarRequestOptions: localVarRequest.Options = {
+            baseUrl: this._basePath,
             method: 'POST',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
             body: ObjectSerializer.serialize(entity, "AccountUpdate"),
+            timeout: this._timeout * 1000
         };
 
         this.authentications.default.applyToRequest(localVarRequestOptions);