bkper-js 2.29.1 → 2.29.3

package/lib/index.d.ts

@@ -1340,10 +1340,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/App.js

@@ -261,7 +261,7 @@ export class App extends Resource {
      * @returns The readme text
      */
     getReadme() {
-        return this.payload.readme;
+        return this.payload.readmeMd || this.payload.readme;
     }
     /**
      * Sets the readme.md file as text.
@@ -271,7 +271,7 @@ export class App extends Resource {
      * @returns This App, for chaining
      */
     setReadme(readme) {
-        this.payload.readme = readme;
+        this.payload.readmeMd = readme;
         return this;
     }
     /**

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.1",
+  "version": "2.29.3",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -35,7 +35,7 @@
     "postversion": "git push --tags && yarn publish --new-version $npm_package_version && git push && echo \"Successfully released version $npm_package_version!\""
   },
   "dependencies": {
-    "@bkper/bkper-api-types": "^5.35.0",
+    "@bkper/bkper-api-types": "^5.36.0",
     "big.js": "^6.0.3",
     "dayjs": "^1.10.3",
     "luxon": "^1.25.0",