bkper-js 1.9.2 → 1.10.0

package/lib/index.d.ts

@@ -436,6 +436,14 @@ export declare class Bkper {
      * @returns The retrieved User, for chaining
      */
     static getUser(): Promise<User>;
+    /**
+     * Gets the URL to redirect the User to the billing portal.
+     *
+     * @param returnUrl - The URL to return to after the User has been redirected to the billing portal
+     *
+     * @returns The URL to redirect the User to the billing portal
+     */
+    static getBillingPortalUrl(returnUrl: string): Promise<string | undefined>;
     /**
      * Sets the API [[Config]] object.
      *
@@ -845,6 +853,8 @@ export declare interface Config {
     }>;
     /**
      * Custom request error handler
+     *
+     * @param error - The error object of the failed request.
      */
     requestErrorHandler?: (error: any) => any;
     /**
@@ -854,10 +864,10 @@ export declare interface Config {
      * It provides the HTTP status code, error message, and the number of retry attempts made so far.
      *
      * @param code - The HTTP status code of the failed request.
-     * @param message - The error message associated with the failed request.
+     * @param error - The error object of the failed request.
      * @param attempt - The number of retry attempts made so far.
      */
-    requestRetryHandler?: (status?: number, message?: string, attempt?: number) => Promise<void>;
+    requestRetryHandler?: (status?: number, error?: any, attempt?: number) => Promise<void>;
     /**
      * Sets the base api url. Default to https://app.bkper.com/_ah/api/bkper
      */
@@ -902,6 +912,18 @@ export declare class Connection {
      * @returns The Connection name
      */
     getName(): string | undefined;
+    /**
+     * Gets the logo of the Connection.
+     *
+     * @returns The Connection logo
+     */
+    getLogo(): string | undefined;
+    /**
+     * Gets the date when the Connection was added.
+     *
+     * @returns The Connection add date in milliseconds
+     */
+    getDateAddedMs(): string | undefined;
     /**
      * Gets the email of the owner of the Connection.
      *
@@ -1006,9 +1028,15 @@ export declare class Connection {
     /**
      * Performs create new Connection.
      *
-     * @returns The Connection, for chaining
+     * @returns The created Connection, for chaining
      */
     create(): Promise<Connection>;
+    /**
+     * Performs remove Connection.
+     *
+     * @returns The removed Connection object
+     */
+    remove(): Promise<Connection>;
 }
 
 /**
@@ -1241,6 +1269,36 @@ export declare class Integration {
      * @returns The Integration's name
      */
     getName(): string | undefined;
+    /**
+     * Gets the name of the user who added the Integration.
+     *
+     * @returns The user name of who added the Integration
+     */
+    getAddedBy(): string | undefined;
+    /**
+     * Gets the agent id of the Integration.
+     *
+     * @returns The Integration's agent id
+     */
+    getAgentId(): string | undefined;
+    /**
+     * Gets the logo of the Integration.
+     *
+     * @returns The Integration's logo
+     */
+    getLogo(): string | undefined;
+    /**
+     * Gets the date when the Integration was added.
+     *
+     * @returns The Integration add date in milliseconds
+     */
+    getDateAddedMs(): string | undefined;
+    /**
+     * Gets the date when the Integration was last updated.
+     *
+     * @returns The Integration last update date in milliseconds
+     */
+    getLastUpdateMs(): string | undefined;
     /**
      * Gets the custom properties stored in the Integration.
      *
@@ -1284,6 +1342,12 @@ export declare class Integration {
      * @returns The Integration, for chainning
      */
     deleteProperty(key: string): Integration;
+    /**
+     * Performs remove Integration.
+     *
+     * @returns The removed Integration object
+     */
+    remove(): Promise<Integration>;
 }
 
 /**

package/lib/model/Bkper.js

@@ -108,6 +108,19 @@ export class Bkper {
             return new User(user);
         });
     }
+    /**
+     * Gets the URL to redirect the User to the billing portal.
+     *
+     * @param returnUrl - The URL to return to after the User has been redirected to the billing portal
+     *
+     * @returns The URL to redirect the User to the billing portal
+     */
+    static getBillingPortalUrl(returnUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = yield UserService.getBillingPortalUrl(returnUrl);
+            return url.url;
+        });
+    }
     /**
      * Sets the API [[Config]] object.
      *

package/lib/model/Connection.js

@@ -59,6 +59,22 @@ export class Connection {
     getName() {
         return this.payload.name;
     }
+    /**
+     * Gets the logo of the Connection.
+     *
+     * @returns The Connection logo
+     */
+    getLogo() {
+        return this.payload.logo;
+    }
+    /**
+     * Gets the date when the Connection was added.
+     *
+     * @returns The Connection add date in milliseconds
+     */
+    getDateAddedMs() {
+        return this.payload.dateAddedMs;
+    }
     /**
      * Gets the email of the owner of the Connection.
      *
@@ -223,7 +239,7 @@ export class Connection {
     /**
      * Performs create new Connection.
      *
-     * @returns The Connection, for chaining
+     * @returns The created Connection, for chaining
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -231,5 +247,19 @@ export class Connection {
             return this;
         });
     }
+    /**
+     * Performs remove Connection.
+     *
+     * @returns The removed Connection object
+     */
+    remove() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const connectionId = this.getId();
+            if (connectionId) {
+                this.payload = yield ConnectionService.deleteConnection(connectionId);
+            }
+            return this;
+        });
+    }
 }
 //# sourceMappingURL=Connection.js.map

package/lib/model/Integration.js

@@ -1,3 +1,13 @@
+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 * as IntegrationService from '../service/integration-service.js';
 /**
  * This class defines a Integration from an [[User]] to an external service.
  *
@@ -37,6 +47,46 @@ export class Integration {
     getName() {
         return this.payload.name;
     }
+    /**
+     * Gets the name of the user who added the Integration.
+     *
+     * @returns The user name of who added the Integration
+     */
+    getAddedBy() {
+        return this.payload.addedBy;
+    }
+    /**
+     * Gets the agent id of the Integration.
+     *
+     * @returns The Integration's agent id
+     */
+    getAgentId() {
+        return this.payload.agentId;
+    }
+    /**
+     * Gets the logo of the Integration.
+     *
+     * @returns The Integration's logo
+     */
+    getLogo() {
+        return this.payload.logo;
+    }
+    /**
+     * Gets the date when the Integration was added.
+     *
+     * @returns The Integration add date in milliseconds
+     */
+    getDateAddedMs() {
+        return this.payload.dateAddedMs;
+    }
+    /**
+     * Gets the date when the Integration was last updated.
+     *
+     * @returns The Integration last update date in milliseconds
+     */
+    getLastUpdateMs() {
+        return this.payload.lastUpdateMs;
+    }
     /**
      * Gets the custom properties stored in the Integration.
      *
@@ -105,5 +155,20 @@ export class Integration {
         this.setProperty(key, null);
         return this;
     }
+    /**
+     * Performs remove Integration.
+     *
+     * @returns The removed Integration object
+     */
+    remove() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bookId = this.getBookId();
+            const integrationId = this.getId();
+            if (bookId && integrationId) {
+                this.payload = yield IntegrationService.deleteIntegration(bookId, integrationId);
+            }
+            return this;
+        });
+    }
 }
 //# sourceMappingURL=Integration.js.map

package/lib/service/http-api-request.js

@@ -52,7 +52,7 @@ export class HttpApiRequest extends HttpRequest {
                         }
                         return yield this.fetch();
                     }
-                    throw this.handleError(errorResp);
+                    throw this.handleError(errorResp.data);
                 }
                 else if (error.request) {
                     // The request was made but no response was received

package/lib/service/integration-service.js

@@ -37,9 +37,7 @@ export function updateIntegration(bookId, integration) {
 }
 export function deleteIntegration(bookId, id) {
     return __awaiter(this, void 0, void 0, function* () {
-        const res = yield new HttpBooksApiV5Request(`${bookId}/integrations/${id}`)
-            .setMethod('DELETE')
-            .fetch();
+        const res = yield new HttpBooksApiV5Request(`${bookId}/integrations/${id}`).setMethod('DELETE').fetch();
         return res.data;
     });
 }

package/lib/service/user-service.js

@@ -14,4 +14,10 @@ export function getUser() {
         return res.data;
     });
 }
+export function getBillingPortalUrl(returnUrl) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield new HttpApiV5Request(`user/billing/portal`).addParam('returnUrl', returnUrl).fetch();
+        return res.data;
+    });
+}
 //# sourceMappingURL=user-service.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.9.2",
+  "version": "1.10.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",