bkper-js 1.47.2 → 2.0.0

package/lib/model/App.js

@@ -20,32 +20,37 @@ export class App {
         this.payload = payload || {};
     }
     /**
+     * Gets the wrapped plain JSON object.
+     *
      * @returns The wrapped plain json object
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
-     *
      * Sets the webhook url for development.
      *
-     * @returns This App, for chainning.
+     * @param webhookUrlDev - The webhook URL for development
+     *
+     * @returns This App, for chaining
      */
     setWebhookUrlDev(webhookUrlDev) {
         this.payload.webhookUrlDev = webhookUrlDev;
         return this;
     }
     /**
-     *
      * Sets the conversation url for development.
      *
-     * @returns This App, for chainning.
+     * @param conversationUrlDev - The conversation URL for development
+     *
+     * @returns This App, for chaining
      */
     setConversationUrlDev(conversationUrlDev) {
         this.payload.conversationUrlDev = conversationUrlDev;
         return this;
     }
     /**
+     * Gets the App universal identifier.
      *
      * @returns The App universal identifier
      */
@@ -53,56 +58,74 @@ export class App {
         return this.payload.id;
     }
     /**
-     * @return The name of this App
+     * Gets the name of this App.
+     *
+     * @returns The name of this App
      */
     getName() {
         return this.payload.name;
     }
     /**
-     * @return True if this App has events bound to it
+     * Checks if this App has events bound to it.
+     *
+     * @returns True if this App has events bound to it
      */
     hasEvents() {
         const events = this.getEvents() || [];
         return events.length > 0;
     }
     /**
-     * @return The events bound to this App
+     * Gets the events bound to this App.
+     *
+     * @returns The events bound to this App
      */
     getEvents() {
         return this.payload.events;
     }
     /**
-     * @return True if this App is published
+     * Checks if this App is published.
+     *
+     * @returns True if this App is published
      */
     isPublished() {
         return this.payload.published || false;
     }
     /**
-     * @return True if this App is conversational
+     * Checks if this App is conversational.
+     *
+     * @returns True if this App is conversational
      */
     isConversational() {
         return this.payload.conversational || false;
     }
     /**
-     * @return The logo url of this App
+     * Gets the logo url of this App.
+     *
+     * @returns The logo url of this App
      */
     getLogoUrl() {
         return this.payload.logoUrl;
     }
     /**
-     * @return The logo url of this App in dark mode
+     * Gets the logo url of this App in dark mode.
+     *
+     * @returns The logo url of this App in dark mode
      */
     getLogoUrlDark() {
         return this.payload.logoUrlDark;
     }
     /**
-     * @return The description of this App
+     * Gets the description of this App.
+     *
+     * @returns The description of this App
      */
     getDescription() {
         return this.payload.description;
     }
     /**
-     * Sets the whitelabeled user emails
+     * Sets the whitelabeled user emails.
+     *
+     * @param emails - The user emails to whitelist
      *
      * @returns This App for chaining
      */
@@ -111,55 +134,73 @@ export class App {
         return this;
     }
     /**
-     * @return The name of the owner of this App
+     * Gets the name of the owner of this App.
+     *
+     * @returns The name of the owner of this App
      */
     getOwnerName() {
         return this.payload.ownerName;
     }
     /**
-     * @return The menu url of this App
+     * Gets the menu url of this App.
+     *
+     * @returns The menu url of this App
      */
     getMenuUrl() {
         return this.payload.menuUrl;
     }
     /**
-     * @return The menu development url of this App
+     * Gets the menu development url of this App.
+     *
+     * @returns The menu development url of this App
      */
     getMenuUrlDev() {
         return this.payload.menuUrlDev;
     }
     /**
-     * @return The menu text of this App
+     * Gets the menu text of this App.
+     *
+     * @returns The menu text of this App
      */
     getMenuText() {
         return this.payload.menuText;
     }
     /**
-     * @return The menu popup width of this App
+     * Gets the menu popup width of this App.
+     *
+     * @returns The menu popup width of this App
      */
     getMenuPopupWidth() {
         return this.payload.menuPopupWidth;
     }
     /**
-     * @return The menu popup height of this App
+     * Gets the menu popup height of this App.
+     *
+     * @returns The menu popup height of this App
      */
     getMenuPopupHeight() {
         return this.payload.menuPopupHeight;
     }
     /**
-     * @return The logo url of the owner of this App
+     * Gets the logo url of the owner of this App.
+     *
+     * @returns The logo url of the owner of this App
      */
     getOwnerLogoUrl() {
         return this.payload.ownerLogoUrl;
     }
     /**
-     * @return The file patterns the App handles - E.g *.pdf *.csv
+     * Gets the file patterns the App handles.
+     *
+     * @returns The file patterns the App handles - E.g *.pdf *.csv
      */
     getFilePatterns() {
         return this.payload.filePatterns;
     }
     /**
-     * Sets the developer email
+     * Sets the developer email.
+     *
+     * @param email - The developer email to set
      *
      * @returns This App for chaining
      */
@@ -168,7 +209,9 @@ export class App {
         return this;
     }
     /**
-     * Sets the client secret
+     * Sets the client secret.
+     *
+     * @param clientSecret - The client secret to set
      *
      * @returns This App for chaining
      */
@@ -177,7 +220,9 @@ export class App {
         return this;
     }
     /**
-     * Sets the readme text
+     * Sets the readme text.
+     *
+     * @param readme - The readme text to set
      *
      * @returns This App for chaining
      */
@@ -189,6 +234,8 @@ export class App {
      * Performs the app creation, applying pending changes.
      *
      * The App id MUST be unique. If another app is already existing, an error will be thrown.
+     *
+     * @returns This App after creation
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -197,7 +244,9 @@ export class App {
         });
     }
     /**
-     * Partially update an App, applying pending changes.
+     * Partially updates an App, applying pending changes.
+     *
+     * @returns This App after the partial update
      */
     patch() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -206,7 +255,9 @@ export class App {
         });
     }
     /**
-     * Perform update App, applying pending changes.
+     * Performs a full update of the App, applying pending changes.
+     *
+     * @returns This App after the update
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/model/BalancesReport.js

@@ -12,19 +12,25 @@ export class BalancesReport {
         this.payload = payload;
     }
     /**
-     * @returns The [[Book]] that generated the report.
+     * Gets the [[Book]] that generated the report.
+     *
+     * @returns The [[Book]] that generated the report
      */
     getBook() {
         return this.book;
     }
     /**
-     * @returns The [[Periodicity]] of the query used to generate the report.
+     * Gets the [[Periodicity]] of the query used to generate the report.
+     *
+     * @returns The [[Periodicity]] of the query used to generate the report
      */
     getPeriodicity() {
         return this.payload.periodicity;
     }
     /**
-     * @returns All [[BalancesContainers]] of the report.
+     * Gets all [[BalancesContainers]] of the report.
+     *
+     * @returns All [[BalancesContainers]] of the report
      */
     getBalancesContainers() {
         let containers = [];
@@ -41,9 +47,9 @@ export class BalancesReport {
     /**
      * Gets a specific [[BalancesContainer]].
      *
-     * @param name The [[Account]] or [[Group]] name.
+     * @param name - The [[Account]] or [[Group]] name
      *
-     * @returns The retrieved [[BalancesContainer]].
+     * @returns The retrieved [[BalancesContainer]]
      */
     getBalancesContainer(name) {
         var _a;

package/lib/model/Bkper.js

@@ -29,7 +29,7 @@ import { Agent } from "./Agent.js";
  * Example:
  *
  * ```javascript
- * Bkper.setConfig({
+ * Bkper.get().setConfig({
  *   apiKeyProvider: () => process.env.BKPER_API_KEY,
  *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
  * })
@@ -40,15 +40,23 @@ import { Agent } from "./Agent.js";
  * @public
  */
 export class Bkper {
+    /**
+     * Creates a new Bkper instance with the specified API configuration.
+     *
+     * @param config - The Config object
+     */
+    constructor(config) {
+        HttpApiRequest.config = config;
+    }
     /**
      * Gets the [[Book]] with the specified bookId from url param.
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
      * @param includeAccounts - Optional parameter to include accounts in the retrieved Book
      *
-     * @returns The retrieved Book, for chaining
+     * @returns The retrieved Book
      */
-    static getBook(id, includeAccounts) {
+    getBook(id, includeAccounts) {
         return __awaiter(this, void 0, void 0, function* () {
             let book = yield BookService.loadBook(id, includeAccounts);
             return new Book(book);
@@ -60,7 +68,7 @@ export class Bkper {
      * @param query - Optional search term to filter books
      * @returns The retrieved list of Books
      */
-    static getBooks(query) {
+    getBooks(query) {
         return __awaiter(this, void 0, void 0, function* () {
             let books = yield BookService.loadBooks(query);
             return books.map(book => new Book(book));
@@ -71,7 +79,7 @@ export class Bkper {
      *
      * @returns The retrieved list of Collections
      */
-    static getCollections() {
+    getCollections() {
         return __awaiter(this, void 0, void 0, function* () {
             let collections = yield CollectionService.loadCollections();
             return collections.map(collection => new Collection(collection));
@@ -82,7 +90,7 @@ export class Bkper {
      *
      * @returns The retrieved list of Apps
      */
-    static getApps() {
+    getApps() {
         return __awaiter(this, void 0, void 0, function* () {
             let apps = yield AppService.getApps();
             return apps.map(app => new App(app));
@@ -93,7 +101,7 @@ export class Bkper {
      *
      * @returns The retrieved list of Conversations
      */
-    static getConversations() {
+    getConversations() {
         return __awaiter(this, void 0, void 0, function* () {
             const conversationPayloads = yield ConversationService.getConversations();
             let conversations = [];
@@ -110,7 +118,7 @@ export class Bkper {
      *
      * @returns The retrieved list of Templates
      */
-    static getTemplates() {
+    getTemplates() {
         return __awaiter(this, void 0, void 0, function* () {
             let templates = yield TemplateService.getTemplates();
             return templates.map(template => new Template(template));
@@ -119,9 +127,9 @@ export class Bkper {
     /**
      * Gets the current logged [[User]].
      *
-     * @returns The retrieved User, for chaining
+     * @returns The retrieved User
      */
-    static getUser() {
+    getUser() {
         return __awaiter(this, void 0, void 0, function* () {
             let user = yield UserService.getUser();
             return new User(user);
@@ -134,42 +142,11 @@ export class Bkper {
      *
      * @returns The URL to redirect the User to the billing portal
      */
-    static getBillingPortalUrl(returnUrl) {
+    getBillingPortalUrl(returnUrl) {
         return __awaiter(this, void 0, void 0, function* () {
             let url = yield UserService.getBillingPortalUrl(returnUrl);
             return url.url;
         });
     }
-    /**
-     * Sets the API [[Config]] object.
-     *
-     * @param config - The Config object
-     */
-    static setConfig(config) {
-        HttpApiRequest.config = config;
-    }
-    /**
-     * Sets the API key to identify the agent.
-     *
-     * @param key - The API key
-     *
-     * @returns The defined [[App]] object
-     *
-     * @deprecated Use `setConfig()` instead
-     */
-    static setApiKey(key) {
-        HttpApiRequest.config.apiKeyProvider = () => __awaiter(this, void 0, void 0, function* () { return key; });
-        return new App({});
-    }
-    /**
-     * Sets the provider of the valid OAuth2 access token
-     *
-     * @deprecated Use `setConfig()` instead
-     */
-    static setOAuthTokenProvider(oauthTokenProvider) {
-        return __awaiter(this, void 0, void 0, function* () {
-            HttpApiRequest.config.oauthTokenProvider = oauthTokenProvider;
-        });
-    }
 }
 //# sourceMappingURL=Bkper.js.map