washday-sdk 1.6.63 → 1.6.64

package/dist/api/companies/get.js

@@ -69,3 +69,23 @@ export const getCFDIAddonStatus = function (data) {
         }
     });
 };
+export const getAvailableSubscriptionPlans = function () {
+    return __awaiter(this, arguments, void 0, function* (data = {}) {
+        try {
+            const config = {
+                headers: { Authorization: `Bearer ${this.apiToken}` }
+            };
+            const params = new URLSearchParams();
+            if (data.companyId) {
+                params.set("companyId", data.companyId);
+            }
+            const query = params.toString();
+            const response = yield this.axiosInstance.get(`${GET_SET_BILLING}/subscription/available-plans${query ? `?${query}` : ""}`, config);
+            return response;
+        }
+        catch (error) {
+            console.error('Error fetching getAvailableSubscriptionPlans:', error);
+            throw error;
+        }
+    });
+};

package/dist/api/companies/post.js

@@ -99,3 +99,33 @@ export const disableCFDIAddon = function (data) {
         }
     });
 };
+export const previewSubscriptionPlanChange = function (data) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const config = {
+                headers: { Authorization: `Bearer ${this.apiToken}` }
+            };
+            const response = yield this.axiosInstance.post(`${GET_SET_BILLING}/subscription/change-plan/preview`, data, config);
+            return response;
+        }
+        catch (error) {
+            console.error('Error fetching previewSubscriptionPlanChange:', error);
+            throw error;
+        }
+    });
+};
+export const changeSubscriptionPlan = function (data) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const config = {
+                headers: { Authorization: `Bearer ${this.apiToken}` }
+            };
+            const response = yield this.axiosInstance.post(`${GET_SET_BILLING}/subscription/change-plan`, data, config);
+            return response;
+        }
+        catch (error) {
+            console.error('Error fetching changeSubscriptionPlan:', error);
+            throw error;
+        }
+    });
+};

package/dist/api/index.js

@@ -2,8 +2,8 @@ import { deleteCashierBoxById, deleteCashierBoxMovementById } from "./cashierbox
 import { getCashierBoxMovementsHistory, getCashierboxesById, getCashierboxesByStoreId } from "./cashierbox/get";
 import { addCashierBoxMovement, createCashierBox } from "./cashierbox/post";
 import { updateCashierBoxById, updateCashierBoxMovementById } from "./cashierbox/put";
-import { getCFDIAddonStatus, getCompanyById, getCompanyOrdersMetrics, getGarmentAttributeCatalogs } from "./companies/get";
-import { disableBillingOverage, disableCFDIAddon, enableBillingOverage, enableCFDIAddon, updateCFDIOrgLogo, updateCompanyTaxInfoCertificates } from "./companies/post";
+import { getAvailableSubscriptionPlans, getCFDIAddonStatus, getCompanyById, getCompanyOrdersMetrics, getGarmentAttributeCatalogs } from "./companies/get";
+import { changeSubscriptionPlan, disableBillingOverage, disableCFDIAddon, enableBillingOverage, enableCFDIAddon, previewSubscriptionPlanChange, updateCFDIOrgLogo, updateCompanyTaxInfoCertificates } from "./companies/post";
 import { updateCompanyById, updateCompanyLogoById, updateCompanySubscriptionBillingInfoById, updateCompanyTaxInfoById, updateGarmentAttributeCatalogsById } from "./companies/put";
 import { getCountries } from "./countries/get";
 import * as configEndpoints from "./config";
@@ -288,6 +288,9 @@ const WashdayClient = function WashdayClient(apiToken, env = 'PROD', clientId, c
         enableCFDIAddon: enableCFDIAddon,
         disableCFDIAddon: disableCFDIAddon,
         getCFDIAddonStatus: getCFDIAddonStatus,
+        getAvailableSubscriptionPlans: getAvailableSubscriptionPlans,
+        previewSubscriptionPlanChange: previewSubscriptionPlanChange,
+        changeSubscriptionPlan: changeSubscriptionPlan,
     });
     this.stripe = bindMethods(this, {
         createCreateSuscriptionCheckoutSession: createCreateSuscriptionCheckoutSession,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "washday-sdk",
-  "version": "1.6.63",
+  "version": "1.6.64",
   "description": "Washday utilities functions and API",
   "main": "dist/index.js",
   "type": "module",

package/src/api/companies/get.ts

@@ -1,5 +1,8 @@
 import { WashdayClientInstance } from "../../interfaces/Api";
-import { GetCFDIAddonStatusRequest } from "../../interfaces/Company";
+import {
+  GetAvailableSubscriptionPlansRequest,
+  GetCFDIAddonStatusRequest,
+} from "../../interfaces/Company";
 
 const GET_SET_COMPANIES = 'api/company';
 const GET_SET_BILLING = 'api/billing';
@@ -58,3 +61,27 @@ export const getCFDIAddonStatus = async function (
     throw error;
   }
 };
+
+export const getAvailableSubscriptionPlans = async function (
+  this: WashdayClientInstance,
+  data: GetAvailableSubscriptionPlansRequest = {},
+): Promise<any> {
+  try {
+    const config = {
+      headers: { Authorization: `Bearer ${this.apiToken}` }
+    };
+    const params = new URLSearchParams();
+    if (data.companyId) {
+      params.set("companyId", data.companyId);
+    }
+    const query = params.toString();
+    const response = await this.axiosInstance.get(
+      `${GET_SET_BILLING}/subscription/available-plans${query ? `?${query}` : ""}`,
+      config,
+    );
+    return response;
+  } catch (error) {
+    console.error('Error fetching getAvailableSubscriptionPlans:', error);
+    throw error;
+  }
+};

package/src/api/companies/post.ts

@@ -1,5 +1,9 @@
 import { WashdayClientInstance } from "../../interfaces/Api";
-import { CFDIAddonToggleRequest } from "../../interfaces/Company";
+import {
+    ApplySubscriptionPlanChangeRequest,
+    CFDIAddonToggleRequest,
+    PreviewSubscriptionPlanChangeRequest,
+} from "../../interfaces/Company";
 import axiosInstance from "../axiosInstance";
 const GET_SET_COMPANIES = 'api/company';
 const GET_SET_BILLING = 'api/billing';
@@ -91,3 +95,35 @@ export const disableCFDIAddon = async function (
         throw error;
     }
 }
+
+export const previewSubscriptionPlanChange = async function (
+    this: WashdayClientInstance,
+    data: PreviewSubscriptionPlanChangeRequest
+): Promise<any> {
+    try {
+        const config = {
+            headers: { Authorization: `Bearer ${this.apiToken}` }
+        };
+        const response = await this.axiosInstance.post(`${GET_SET_BILLING}/subscription/change-plan/preview`, data, config);
+        return response;
+    } catch (error) {
+        console.error('Error fetching previewSubscriptionPlanChange:', error);
+        throw error;
+    }
+}
+
+export const changeSubscriptionPlan = async function (
+    this: WashdayClientInstance,
+    data: ApplySubscriptionPlanChangeRequest
+): Promise<any> {
+    try {
+        const config = {
+            headers: { Authorization: `Bearer ${this.apiToken}` }
+        };
+        const response = await this.axiosInstance.post(`${GET_SET_BILLING}/subscription/change-plan`, data, config);
+        return response;
+    } catch (error) {
+        console.error('Error fetching changeSubscriptionPlan:', error);
+        throw error;
+    }
+}

package/src/api/index.ts

@@ -3,8 +3,8 @@ import { deleteCashierBoxById, deleteCashierBoxMovementById } from "./cashierbox
 import { getCashierBoxMovementsHistory, getCashierboxesById, getCashierboxesByStoreId } from "./cashierbox/get";
 import { addCashierBoxMovement, createCashierBox } from "./cashierbox/post";
 import { updateCashierBoxById, updateCashierBoxMovementById } from "./cashierbox/put";
-import { getCFDIAddonStatus, getCompanyById, getCompanyOrdersMetrics, getGarmentAttributeCatalogs } from "./companies/get";
-import { disableBillingOverage, disableCFDIAddon, enableBillingOverage, enableCFDIAddon, updateCFDIOrgLogo, updateCompanyTaxInfoCertificates } from "./companies/post";
+import { getAvailableSubscriptionPlans, getCFDIAddonStatus, getCompanyById, getCompanyOrdersMetrics, getGarmentAttributeCatalogs } from "./companies/get";
+import { changeSubscriptionPlan, disableBillingOverage, disableCFDIAddon, enableBillingOverage, enableCFDIAddon, previewSubscriptionPlanChange, updateCFDIOrgLogo, updateCompanyTaxInfoCertificates } from "./companies/post";
 import { updateCompanyById, updateCompanyLogoById, updateCompanySubscriptionBillingInfoById, updateCompanyTaxInfoById, updateGarmentAttributeCatalogsById } from "./companies/put";
 import { getCountries } from "./countries/get";
 import * as configEndpoints from "./config";
@@ -295,6 +295,9 @@ const WashdayClient: WashdayClientConstructor = function WashdayClient(this: Was
         enableCFDIAddon: enableCFDIAddon,
         disableCFDIAddon: disableCFDIAddon,
         getCFDIAddonStatus: getCFDIAddonStatus,
+        getAvailableSubscriptionPlans: getAvailableSubscriptionPlans,
+        previewSubscriptionPlanChange: previewSubscriptionPlanChange,
+        changeSubscriptionPlan: changeSubscriptionPlan,
     });
     this.stripe = bindMethods(this, {
         createCreateSuscriptionCheckoutSession: createCreateSuscriptionCheckoutSession,

package/src/interfaces/Api.ts

@@ -2,8 +2,8 @@ import { deleteCashierBoxById, deleteCashierBoxMovementById } from "../api/cashi
 import { getCashierBoxMovementsHistory, getCashierboxesById, getCashierboxesByStoreId } from "../api/cashierbox/get";
 import { addCashierBoxMovement, createCashierBox } from "../api/cashierbox/post";
 import { updateCashierBoxById, updateCashierBoxMovementById } from "../api/cashierbox/put";
-import { getCFDIAddonStatus, getCompanyById, getCompanyOrdersMetrics, getGarmentAttributeCatalogs } from "../api/companies/get";
-import { disableBillingOverage, disableCFDIAddon, enableBillingOverage, enableCFDIAddon, updateCFDIOrgLogo, updateCompanyTaxInfoCertificates } from "../api/companies/post";
+import { getAvailableSubscriptionPlans, getCFDIAddonStatus, getCompanyById, getCompanyOrdersMetrics, getGarmentAttributeCatalogs } from "../api/companies/get";
+import { changeSubscriptionPlan, disableBillingOverage, disableCFDIAddon, enableBillingOverage, enableCFDIAddon, previewSubscriptionPlanChange, updateCFDIOrgLogo, updateCompanyTaxInfoCertificates } from "../api/companies/post";
 import { updateCompanyById, updateCompanyLogoById, updateCompanySubscriptionBillingInfoById, updateCompanyTaxInfoById, updateGarmentAttributeCatalogsById } from "../api/companies/put";
 import { getCountries } from "../api/countries/get";
 import * as configEndpoints from "../api/config";
@@ -280,6 +280,9 @@ export interface WashdayClientInstance {
         enableCFDIAddon: typeof enableCFDIAddon;
         disableCFDIAddon: typeof disableCFDIAddon;
         getCFDIAddonStatus: typeof getCFDIAddonStatus;
+        getAvailableSubscriptionPlans: typeof getAvailableSubscriptionPlans;
+        previewSubscriptionPlanChange: typeof previewSubscriptionPlanChange;
+        changeSubscriptionPlan: typeof changeSubscriptionPlan;
     };
     stripe: {
         createCreateSuscriptionCheckoutSession: typeof createCreateSuscriptionCheckoutSession;

package/src/interfaces/Company.ts

@@ -54,7 +54,98 @@ export interface GetCFDIAddonStatusRequest {
     companyId: string;
 }
 
+export type SubscriptionPlanChangePlan = "basic" | "standard" | "premium";
+export type SubscriptionPlanChangeDirection = "upgrade" | "downgrade" | "same_plan";
+export type SubscriptionPlanChangeBehavior =
+    | "immediate_prorated_charge"
+    | "contact_support"
+    | "no_change";
+export type SubscriptionPlanChangeAddon = "cfdi" | "orders_overage";
+
+export interface GetAvailableSubscriptionPlansRequest {
+    companyId?: string;
+}
+
+export interface AvailableSubscriptionPlan {
+    plan: SubscriptionPlanChangePlan;
+    priceId: string;
+    amount: number;
+    currency: string;
+    interval: string | null;
+    displayPrice: string;
+}
+
+export interface AvailableSubscriptionPlansResponse {
+    currentPlan: SubscriptionPlanChangePlan;
+    currentPlanPriceId: string;
+    country: string;
+    currency: string;
+    plans: AvailableSubscriptionPlan[];
+}
+
+export interface PreviewSubscriptionPlanChangeRequest {
+    companyId?: string;
+    targetPlan: SubscriptionPlanChangePlan;
+}
+
+export interface PlanChangePreviewLine {
+    description: string;
+    amount: number;
+    currency: string;
+    amountFormatted?: string;
+    proration?: boolean;
+    priceId?: string;
+    type?: "credit" | "charge" | "tax" | "addon" | "plan";
+}
+
+export interface PlanChangePreviewResponse {
+    status: "preview_ready" | "downgrade_not_supported" | "no_change";
+    currentPlan: SubscriptionPlanChangePlan;
+    targetPlan: SubscriptionPlanChangePlan;
+    direction: SubscriptionPlanChangeDirection;
+    behavior: SubscriptionPlanChangeBehavior;
+    prorationDate?: number;
+    currency: string;
+    amountDueNow: number;
+    amountDueNowFormatted?: string;
+    subtotal?: number;
+    tax?: number | null;
+    total?: number;
+    currentPeriodEnd?: string;
+    nextBillingDate?: string;
+    currentPlanPriceId?: string;
+    targetPlanPriceId: string;
+    preservedAddons: SubscriptionPlanChangeAddon[];
+    lines: PlanChangePreviewLine[];
+    message: string;
+}
+
+export interface ApplySubscriptionPlanChangeRequest {
+    companyId?: string;
+    targetPlan: SubscriptionPlanChangePlan;
+    expectedCurrentPlanPriceId: string;
+    expectedTargetPlanPriceId: string;
+    expectedProrationDate: number;
+    previewIdempotencyKey?: string;
+    idempotencyKey?: string;
+}
+
+export interface ApplySubscriptionPlanChangeResponse {
+    status: "applied" | "requires_payment_action" | "payment_failed" | "pending_update" | "no_change";
+    currentPlan: SubscriptionPlanChangePlan;
+    targetPlan: SubscriptionPlanChangePlan;
+    subscriptionId: string;
+    invoiceId?: string;
+    hostedInvoiceUrl?: string;
+    paymentIntentClientSecret?: string;
+    amountDueNow?: number;
+    currency?: string;
+    currentPeriodEnd?: string;
+    message: string;
+}
+
 export interface IStripeSettings {
+    planPriceId?: string | null;
     stripeCFDISubID: string | null;
     stripeCFDISubItemID: string | null;
     cfdiBillingMode?: CFDIBillingMode;

package/test/companies.subscriptionPlanChange.test.ts

@@ -0,0 +1,92 @@
+import { getAvailableSubscriptionPlans } from "../src/api/companies/get";
+import {
+  changeSubscriptionPlan,
+  previewSubscriptionPlanChange,
+} from "../src/api/companies/post";
+import type {
+  ApplySubscriptionPlanChangeRequest,
+  PlanChangePreviewResponse,
+} from "../src/interfaces/Company";
+
+describe("subscription plan change company endpoints", () => {
+  it("fetches available plans through the billing endpoint", async () => {
+    const get = jest.fn().mockResolvedValue({ data: { data: { plans: [] } } });
+    const client = {
+      apiToken: "token-1",
+      axiosInstance: { get },
+    } as any;
+
+    await getAvailableSubscriptionPlans.call(client, { companyId: "company-1" });
+
+    expect(get).toHaveBeenCalledWith(
+      "api/billing/subscription/available-plans?companyId=company-1",
+      { headers: { Authorization: "Bearer token-1" } },
+    );
+  });
+
+  it("fetches available plans without sending an undefined companyId", async () => {
+    const get = jest.fn().mockResolvedValue({ data: { data: { plans: [] } } });
+    const client = {
+      apiToken: "token-1",
+      axiosInstance: { get },
+    } as any;
+
+    await getAvailableSubscriptionPlans.call(client, {});
+
+    expect(get).toHaveBeenCalledWith(
+      "api/billing/subscription/available-plans",
+      { headers: { Authorization: "Bearer token-1" } },
+    );
+  });
+
+  it("previews a subscription plan change through the billing endpoint", async () => {
+    const post = jest.fn().mockResolvedValue({
+      data: {
+        data: {
+          status: "preview_ready",
+          prorationDate: 1770000000,
+        } satisfies Partial<PlanChangePreviewResponse>,
+      },
+    });
+    const client = {
+      apiToken: "token-1",
+      axiosInstance: { post },
+    } as any;
+
+    await previewSubscriptionPlanChange.call(client, {
+      companyId: "company-1",
+      targetPlan: "premium",
+    });
+
+    expect(post).toHaveBeenCalledWith(
+      "api/billing/subscription/change-plan/preview",
+      { companyId: "company-1", targetPlan: "premium" },
+      { headers: { Authorization: "Bearer token-1" } },
+    );
+  });
+
+  it("applies a subscription plan change with expected preview fields", async () => {
+    const post = jest.fn().mockResolvedValue({ data: { data: { status: "applied" } } });
+    const client = {
+      apiToken: "token-1",
+      axiosInstance: { post },
+    } as any;
+    const payload: ApplySubscriptionPlanChangeRequest = {
+      companyId: "company-1",
+      targetPlan: "premium",
+      expectedCurrentPlanPriceId: "price_standard",
+      expectedTargetPlanPriceId: "price_premium",
+      expectedProrationDate: 1770000000,
+      previewIdempotencyKey: "preview-1",
+      idempotencyKey: "apply-1",
+    };
+
+    await changeSubscriptionPlan.call(client, payload);
+
+    expect(post).toHaveBeenCalledWith(
+      "api/billing/subscription/change-plan",
+      payload,
+      { headers: { Authorization: "Bearer token-1" } },
+    );
+  });
+});