bkper-js 1.9.3 → 1.11.0

package/lib/index.d.ts

@@ -418,6 +418,12 @@ export declare class Bkper {
      * @returns The retrieved list of Books
      */
     static getBooks(): Promise<Book[]>;
+    /**
+     * Gets all [[Collections]] the user has access to.
+     *
+     * @returns The retrieved list of Collections
+     */
+    static getCollections(): Promise<Collection[]>;
     /**
      * Gets all [[Apps]] available for the user.
      *
@@ -436,6 +442,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.
      *
@@ -813,10 +827,46 @@ export declare class Collection {
      * @returns The name of this Collection
      */
     getName(): string | undefined;
+    /**
+     * Sets the name of the Collection.
+     *
+     * @returns This Collection, for chainning.
+     */
+    setName(name: string): Collection;
+    /**
+     * Gets the username of the owner of this Collection
+     *
+     * @returns The Collection's owner username
+     */
+    getOwnerUsername(): string | undefined;
+    /**
+     * Gets the user permission for this Collection
+     *
+     * @returns The permission for the current user
+     */
+    getPermission(): Permission | undefined;
     /**
      * @returns All Books of this collection.
      */
     getBooks(): Book[];
+    /**
+     * Gets the last update date of this Collection
+     *
+     * @returns The Collection's last update timestamp, in milliseconds
+     */
+    getUpdatedAt(): string | undefined;
+    /**
+     * Performs create new Collection.
+     *
+     * @returns The created Collection object
+     */
+    create(): Promise<Collection>;
+    /**
+     * Performs update Collection, applying pending changes.
+     *
+     * @returns The updated Collection object
+     */
+    update(): Promise<Collection>;
 }
 
 /**
@@ -1261,6 +1311,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.
      *
@@ -1304,6 +1384,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

@@ -11,11 +11,13 @@ import { Book } from "./Book.js";
 import { App } from "./App.js";
 import * as AppService from '../service/app-service.js';
 import * as BookService from '../service/book-service.js';
+import * as CollectionService from '../service/collection-service.js';
 import * as UserService from '../service/user-service.js';
 import * as TemplateService from '../service/template-service.js';
 import { HttpApiRequest } from '../service/http-api-request.js';
 import { User } from "./User.js";
 import { Template } from "./Template.js";
+import { Collection } from "./Collection.js";
 /**
  * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
@@ -75,6 +77,17 @@ export class Bkper {
             return books.map(book => new Book(book));
         });
     }
+    /**
+     * Gets all [[Collections]] the user has access to.
+     *
+     * @returns The retrieved list of Collections
+     */
+    static getCollections() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let collections = yield CollectionService.loadCollections();
+            return collections.map(collection => new Collection(collection));
+        });
+    }
     /**
      * Gets all [[Apps]] available for the user.
      *
@@ -108,6 +121,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/Collection.js

@@ -1,4 +1,14 @@
+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 { Book } from "./Book.js";
+import * as CollectionService from '../service/collection-service.js';
 /**
  * This class defines a Collection of [[Books]].
  *
@@ -26,6 +36,31 @@ export class Collection {
     getName() {
         return this.payload.name;
     }
+    /**
+     * Sets the name of the Collection.
+     *
+     * @returns This Collection, for chainning.
+     */
+    setName(name) {
+        this.payload.name = name;
+        return this;
+    }
+    /**
+     * Gets the username of the owner of this Collection
+     *
+     * @returns The Collection's owner username
+     */
+    getOwnerUsername() {
+        return this.payload.ownerUsername;
+    }
+    /**
+     * Gets the user permission for this Collection
+     *
+     * @returns The permission for the current user
+     */
+    getPermission() {
+        return this.payload.permission ? this.payload.permission : undefined;
+    }
     /**
      * @returns All Books of this collection.
      */
@@ -40,5 +75,35 @@ export class Collection {
         }
         return books;
     }
+    /**
+     * Gets the last update date of this Collection
+     *
+     * @returns The Collection's last update timestamp, in milliseconds
+     */
+    getUpdatedAt() {
+        return this.payload.updatedAt;
+    }
+    /**
+     * Performs create new Collection.
+     *
+     * @returns The created Collection object
+     */
+    create() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.payload = yield CollectionService.createCollection(this.payload);
+            return this;
+        });
+    }
+    /**
+     * Performs update Collection, applying pending changes.
+     *
+     * @returns The updated Collection object
+     */
+    update() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.payload = yield CollectionService.updateCollection(this.payload);
+            return this;
+        });
+    }
 }
 //# sourceMappingURL=Collection.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/collection-service.js

@@ -0,0 +1,30 @@
+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 { HttpApiV5Request } from "./http-api-request.js";
+export function loadCollections() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        let response = yield new HttpApiV5Request('collections').fetch();
+        return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
+export function createCollection(payload) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let response = yield new HttpApiV5Request('collections').setMethod('POST').setPayload(payload).fetch();
+        return response.data;
+    });
+}
+export function updateCollection(payload) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let response = yield new HttpApiV5Request('collections').setMethod('PUT').setPayload(payload).fetch();
+        return response.data;
+    });
+}
+//# sourceMappingURL=collection-service.js.map

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.3",
+  "version": "1.11.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",