bkper-js 2.29.2 → 2.29.4

package/README.md

@@ -18,11 +18,15 @@ It provides a set of classes and functions to interact with the Bkper API, inclu
 ```
 npm i -S bkper-js
 ```
+
 or
+
 ```
 yarn add bkper-js
 ```
+
 or
+
 ```
 bun add bkper-js
 ```
@@ -39,7 +43,7 @@ import { getOAuthToken } from 'bkper';
 
 // Configure with CLI authentication
 Bkper.setConfig({
-  oauthTokenProvider: async () => getOAuthToken()
+    oauthTokenProvider: async () => getOAuthToken(),
 });
 
 // Create Bkper instance
@@ -54,7 +58,7 @@ const books = await bkper.getBooks();
 console.log(`You have ${books.length} books`);
 ```
 
-First, login via CLI: `bkper login`
+First, login via CLI: `bkper auth login`
 
 ### Web Applications
 
@@ -66,8 +70,8 @@ import { BkperAuth } from '@bkper/web-auth';
 
 // Initialize authentication
 const auth = new BkperAuth({
-  onLoginSuccess: () => initializeApp(),
-  onLoginRequired: () => showLoginButton()
+    onLoginSuccess: () => initializeApp(),
+    onLoginRequired: () => showLoginButton(),
 });
 
 // Restore session on app load
@@ -75,7 +79,7 @@ await auth.init();
 
 // Configure Bkper with web auth
 Bkper.setConfig({
-  oauthTokenProvider: async () => auth.getAccessToken()
+    oauthTokenProvider: async () => auth.getAccessToken(),
 });
 
 // Create Bkper instance and use it
@@ -91,8 +95,7 @@ API keys are optional and only needed for dedicated quota limits. If not provide
 
 ```typescript
 Bkper.setConfig({
-  oauthTokenProvider: async () => getOAuthToken(),
-  apiKeyProvider: async () => process.env.BKPER_API_KEY // Optional - for dedicated quota
+    oauthTokenProvider: async () => getOAuthToken(),
+    apiKeyProvider: async () => process.env.BKPER_API_KEY, // Optional - for dedicated quota
 });
 ```
-

package/lib/index.d.ts

@@ -13,6 +13,10 @@
  *
  * An Account can be grouped by [[Groups]].
  *
+ * @remarks
+ * `Account` has no `getBalance()` method. To retrieve account balances, use
+ * {@link Book.getBalancesReport} and read the resulting {@link BalancesContainer}.
+ *
  * @public
  */
 export declare class Account extends ResourceProperty<bkper.Account> {
@@ -1340,10 +1344,11 @@ export declare class Billing extends Resource<bkper.Billing> {
      * @param plan - The plan to checkout
      * @param successUrl - The URL to redirect to after the User has successfully checked out
      * @param cancelUrl - The URL to redirect to in case the checkout is cancelled
+     * @param cycle - The billing cycle to checkout - "monthly" (default) or "yearly"
      *
      * @returns The URL to redirect the User to the billing checkout
      */
-    getCheckoutUrl(plan: string, successUrl?: string, cancelUrl?: string): Promise<string | undefined>;
+    getCheckoutUrl(plan: string, successUrl?: string, cancelUrl?: string, cycle?: string): Promise<string | undefined>;
 }
 
 /**

package/lib/model/Account.js

@@ -18,6 +18,10 @@ import { ResourceProperty } from './ResourceProperty.js';
  *
  * An Account can be grouped by [[Groups]].
  *
+ * @remarks
+ * `Account` has no `getBalance()` method. To retrieve account balances, use
+ * {@link Book.getBalancesReport} and read the resulting {@link BalancesContainer}.
+ *
  * @public
  */
 export class Account extends ResourceProperty {

package/lib/model/Billing.js

@@ -7,9 +7,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { Resource } from "./Resource.js";
-import { Bkper } from "./Bkper.js";
-import * as UserService from "../service/user-service.js";
+import { Resource } from './Resource.js';
+import { Bkper } from './Bkper.js';
+import * as UserService from '../service/user-service.js';
 /**
  * This class defines the Billing information for a [[User]].
  *
@@ -136,12 +136,13 @@ export class Billing extends Resource {
      * @param plan - The plan to checkout
      * @param successUrl - The URL to redirect to after the User has successfully checked out
      * @param cancelUrl - The URL to redirect to in case the checkout is cancelled
+     * @param cycle - The billing cycle to checkout - "monthly" (default) or "yearly"
      *
      * @returns The URL to redirect the User to the billing checkout
      */
-    getCheckoutUrl(plan, successUrl, cancelUrl) {
+    getCheckoutUrl(plan, successUrl, cancelUrl, cycle) {
         return __awaiter(this, void 0, void 0, function* () {
-            const urlPayload = yield UserService.getBillingCheckoutUrl(plan, successUrl, cancelUrl, this.getConfig());
+            const urlPayload = yield UserService.getBillingCheckoutUrl(plan, successUrl, cancelUrl, cycle, this.getConfig());
             return urlPayload === null || urlPayload === void 0 ? void 0 : urlPayload.url;
         });
     }

package/lib/service/user-service.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { HttpApiV5Request } from "./http-api-request.js";
+import { HttpApiV5Request } from './http-api-request.js';
 export function getUser(config) {
     return __awaiter(this, void 0, void 0, function* () {
         const res = yield new HttpApiV5Request(`user`, config).setMethod('GET').fetch();
@@ -28,13 +28,18 @@ export function getBillingCounts(config) {
 }
 export function getBillingPortalUrl(returnUrl, config) {
     return __awaiter(this, void 0, void 0, function* () {
-        const res = yield new HttpApiV5Request(`user/billing/portal`, config).addParam('returnUrl', returnUrl).fetch();
+        const res = yield new HttpApiV5Request(`user/billing/portal`, config)
+            .addParam('returnUrl', returnUrl)
+            .fetch();
         return res.data;
     });
 }
-export function getBillingCheckoutUrl(plan, successUrl, cancelUrl, config) {
+export function getBillingCheckoutUrl(plan, successUrl, cancelUrl, cycle, config) {
     return __awaiter(this, void 0, void 0, function* () {
         const request = new HttpApiV5Request(`user/billing/checkout`, config).addParam('plan', plan);
+        if (cycle) {
+            request.addParam('cycle', cycle);
+        }
         if (successUrl) {
             request.addParam('successUrl', successUrl);
         }

package/package.json

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