@paid-ai/paid-node 1.0.1-alpha0 → 1.0.1-alpha2

package/dist/cjs/integrations/controllers/plans.d.ts

@@ -0,0 +1,208 @@
+import { PaidClient } from "../../Client.js";
+import type { PlanGroup } from "../../api/types/PlanGroup.js";
+import type { Plan } from "../../api/types/Plan.js";
+import type { PlanWithFeatures } from "../../api/types/PlanWithFeatures.js";
+import type { Order } from "../../api/types/Order.js";
+import type { CancelRenewalResponse } from "../../api/types/CancelRenewalResponse.js";
+import type { ProrationUpgradeResponse } from "../../api/types/ProrationUpgradeResponse.js";
+import type { PlansSubscribeRequest } from "../../api/resources/plans/client/requests/PlansSubscribeRequest.js";
+import type { PlansUnsubscribeRequest } from "../../api/resources/plans/client/requests/PlansUnsubscribeRequest.js";
+import type { PlansUpgradeRequest } from "../../api/resources/plans/client/requests/PlansUpgradeRequest.js";
+/**
+ * Get a plan by ID
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @returns Plan data
+ *
+ * @example
+ * ```typescript
+ * const plan = await getPlanById(client, 'plan-123');
+ * console.log(plan.name, plan.id);
+ * ```
+ */
+export declare function getPlanById(client: PaidClient, planId: string): Promise<Plan>;
+/**
+ * Get a plan group by ID
+ *
+ * @param client - PaidClient instance
+ * @param planGroupId - Plan group's ID
+ * @returns Plan group data
+ *
+ * @example
+ * ```typescript
+ * const planGroup = await getPlanGroupById(client, 'plan-group-123');
+ * console.log(planGroup.name, planGroup.id);
+ * ```
+ */
+export declare function getPlanGroupById(client: PaidClient, planGroupId: string): Promise<PlanGroup>;
+/**
+ * Create a framework-agnostic handler for fetching a plan group by ID
+ *
+ * This handler can be used with any framework adapter.
+ * The plan group ID should be provided either in params or query string.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planGroupId]/route.ts
+ * import { createGetPlanGroupByIdHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createGetPlanGroupByIdHandler();
+ * export const GET = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createGetPlanGroupByIdHandler(): (request: any, response: any, config?: any) => Promise<any>;
+/**
+ * Get all plans in a plan group
+ *
+ * @param client - PaidClient instance
+ * @param planGroupId - Plan group's ID
+ * @returns Array of plans with features
+ *
+ * @example
+ * ```typescript
+ * const plans = await getGroupPlans(client, 'plan-group-123');
+ * console.log(plans.length);
+ * ```
+ */
+export declare function getGroupPlans(client: PaidClient, planGroupId: string): Promise<PlanWithFeatures[]>;
+/**
+ * Create a framework-agnostic handler for fetching plans in a plan group
+ *
+ * This handler can be used with any framework adapter.
+ * The plan group ID should be provided either in params or query string.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planGroupId]/plans/route.ts
+ * import { createGetGroupPlansHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createGetGroupPlansHandler();
+ * export const GET = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createGetGroupPlansHandler(): (request: any, response: any, config?: any) => Promise<any>;
+/**
+ * Subscribe a customer to a plan
+ *
+ * Creates a new order for a customer based on the specified plan, automatically converting plan products to order lines.
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @param request - Subscribe request with customer external ID and currency
+ * @returns Created order
+ *
+ * @example
+ * ```typescript
+ * const order = await subscribe(client, 'plan-123', {
+ *   customerExternalId: 'customer-123',
+ *   currency: 'USD'
+ * });
+ * console.log(order.id);
+ * ```
+ */
+export declare function subscribe(client: PaidClient, planId: string, request: PlansSubscribeRequest): Promise<Order>;
+/**
+ * Create a framework-agnostic handler for subscribing a customer to a plan
+ *
+ * This handler can be used with any framework adapter.
+ * The plan ID should be provided either in params or query string.
+ * The request body should contain customerExternalId and currency.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planId]/subscribe/route.ts
+ * import { createSubscribeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createSubscribeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createSubscribeHandler(): (request: any, response: any, config?: any) => Promise<any>;
+/**
+ * Unsubscribe a customer from a plan
+ *
+ * Cancels the renewal of an order associated with the specified plan. The order will remain active until the cancellation date.
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @param request - Unsubscribe request with customer external ID
+ * @returns Cancel renewal response
+ *
+ * @example
+ * ```typescript
+ * const response = await unsubscribe(client, 'plan-123', {
+ *   customerExternalId: 'customer-123'
+ * });
+ * console.log(response.message);
+ * ```
+ */
+export declare function unsubscribe(client: PaidClient, planId: string, request: PlansUnsubscribeRequest): Promise<CancelRenewalResponse>;
+/**
+ * Create a framework-agnostic handler for unsubscribing a customer from a plan
+ *
+ * This handler can be used with any framework adapter.
+ * The plan ID should be provided either in params or query string.
+ * The request body should contain customerExternalId.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planId]/unsubscribe/route.ts
+ * import { createUnsubscribeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createUnsubscribeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createUnsubscribeHandler(): (request: any, response: any, config?: any) => Promise<any>;
+/**
+ * Upgrade a customer from their current plan to a new plan
+ *
+ * Upgrades a customer from their current plan to a new plan with automatic proration calculation. This schedules a plan change and applies credits for the unused portion of the current billing period.
+ *
+ * @param client - PaidClient instance
+ * @param request - Upgrade request with customer external ID, old plan ID, and new plan ID
+ * @returns Proration upgrade response
+ *
+ * @example
+ * ```typescript
+ * const response = await upgrade(client, {
+ *   customerExternalId: 'customer-123',
+ *   oldPlanId: 'plan-123',
+ *   newPlanId: 'plan-456'
+ * });
+ * console.log(response.order.id);
+ * ```
+ */
+export declare function upgrade(client: PaidClient, request: PlansUpgradeRequest): Promise<ProrationUpgradeResponse>;
+/**
+ * Create a framework-agnostic handler for upgrading a customer's plan
+ *
+ * This handler can be used with any framework adapter.
+ * The request body should contain customerExternalId, oldPlanId, and newPlanId.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/upgrade/route.ts
+ * import { createUpgradeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createUpgradeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createUpgradeHandler(): (request: any, response: any, config?: any) => Promise<any>;

package/dist/cjs/integrations/controllers/plans.js

@@ -0,0 +1,365 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPlanById = getPlanById;
+exports.getPlanGroupById = getPlanGroupById;
+exports.createGetPlanGroupByIdHandler = createGetPlanGroupByIdHandler;
+exports.getGroupPlans = getGroupPlans;
+exports.createGetGroupPlansHandler = createGetGroupPlansHandler;
+exports.subscribe = subscribe;
+exports.createSubscribeHandler = createSubscribeHandler;
+exports.unsubscribe = unsubscribe;
+exports.createUnsubscribeHandler = createUnsubscribeHandler;
+exports.upgrade = upgrade;
+exports.createUpgradeHandler = createUpgradeHandler;
+const base_handler_js_1 = require("../utils/base-handler.js");
+/**
+ * Get a plan by ID
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @returns Plan data
+ *
+ * @example
+ * ```typescript
+ * const plan = await getPlanById(client, 'plan-123');
+ * console.log(plan.name, plan.id);
+ * ```
+ */
+function getPlanById(client, planId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const plan = yield client.plans.getById(planId);
+        return plan;
+    });
+}
+/**
+ * Get a plan group by ID
+ *
+ * @param client - PaidClient instance
+ * @param planGroupId - Plan group's ID
+ * @returns Plan group data
+ *
+ * @example
+ * ```typescript
+ * const planGroup = await getPlanGroupById(client, 'plan-group-123');
+ * console.log(planGroup.name, planGroup.id);
+ * ```
+ */
+function getPlanGroupById(client, planGroupId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const planGroup = yield client.plans.getGroupById(planGroupId);
+        return planGroup;
+    });
+}
+/**
+ * Create a framework-agnostic handler for fetching a plan group by ID
+ *
+ * This handler can be used with any framework adapter.
+ * The plan group ID should be provided either in params or query string.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planGroupId]/route.ts
+ * import { createGetPlanGroupByIdHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createGetPlanGroupByIdHandler();
+ * export const GET = nextjsAdapter(handler);
+ * ```
+ */
+function createGetPlanGroupByIdHandler() {
+    return (0, base_handler_js_1.createHandler)((client, _body, params) => __awaiter(this, void 0, void 0, function* () {
+        const planGroupId = params === null || params === void 0 ? void 0 : params.planGroupId;
+        if (!planGroupId) {
+            return {
+                success: false,
+                error: "planGroupId is required",
+                status: 400,
+            };
+        }
+        const planGroup = yield getPlanGroupById(client, planGroupId);
+        return { success: true, data: planGroup };
+    }), {
+        allowedMethods: ['GET'],
+        requireOrganizationId: false,
+    });
+}
+/**
+ * Get all plans in a plan group
+ *
+ * @param client - PaidClient instance
+ * @param planGroupId - Plan group's ID
+ * @returns Array of plans with features
+ *
+ * @example
+ * ```typescript
+ * const plans = await getGroupPlans(client, 'plan-group-123');
+ * console.log(plans.length);
+ * ```
+ */
+function getGroupPlans(client, planGroupId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const plans = yield client.plans.getGroupPlans(planGroupId);
+        return plans;
+    });
+}
+/**
+ * Create a framework-agnostic handler for fetching plans in a plan group
+ *
+ * This handler can be used with any framework adapter.
+ * The plan group ID should be provided either in params or query string.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planGroupId]/plans/route.ts
+ * import { createGetGroupPlansHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createGetGroupPlansHandler();
+ * export const GET = nextjsAdapter(handler);
+ * ```
+ */
+function createGetGroupPlansHandler() {
+    return (0, base_handler_js_1.createHandler)((client, _body, params) => __awaiter(this, void 0, void 0, function* () {
+        const planGroupId = params === null || params === void 0 ? void 0 : params.planGroupId;
+        if (!planGroupId) {
+            return {
+                success: false,
+                error: "planGroupId is required",
+                status: 400,
+            };
+        }
+        const plans = yield getGroupPlans(client, planGroupId);
+        return { success: true, data: plans };
+    }), {
+        allowedMethods: ['GET'],
+        requireOrganizationId: false,
+    });
+}
+/**
+ * Subscribe a customer to a plan
+ *
+ * Creates a new order for a customer based on the specified plan, automatically converting plan products to order lines.
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @param request - Subscribe request with customer external ID and currency
+ * @returns Created order
+ *
+ * @example
+ * ```typescript
+ * const order = await subscribe(client, 'plan-123', {
+ *   customerExternalId: 'customer-123',
+ *   currency: 'USD'
+ * });
+ * console.log(order.id);
+ * ```
+ */
+function subscribe(client, planId, request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const order = yield client.plans.subscribe(planId, request);
+        return order;
+    });
+}
+/**
+ * Create a framework-agnostic handler for subscribing a customer to a plan
+ *
+ * This handler can be used with any framework adapter.
+ * The plan ID should be provided either in params or query string.
+ * The request body should contain customerExternalId and currency.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planId]/subscribe/route.ts
+ * import { createSubscribeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createSubscribeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+function createSubscribeHandler() {
+    return (0, base_handler_js_1.createHandler)((client, body, params) => __awaiter(this, void 0, void 0, function* () {
+        const planId = params === null || params === void 0 ? void 0 : params.planId;
+        if (!planId) {
+            return {
+                success: false,
+                error: "planId is required",
+                status: 400,
+            };
+        }
+        if (!body.customerExternalId) {
+            return {
+                success: false,
+                error: "customerExternalId is required",
+                status: 400,
+            };
+        }
+        if (!body.currency) {
+            return {
+                success: false,
+                error: "currency is required",
+                status: 400,
+            };
+        }
+        const order = yield subscribe(client, planId, body);
+        return { success: true, data: order };
+    }), {
+        allowedMethods: ['POST'],
+        requireOrganizationId: false,
+    });
+}
+/**
+ * Unsubscribe a customer from a plan
+ *
+ * Cancels the renewal of an order associated with the specified plan. The order will remain active until the cancellation date.
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @param request - Unsubscribe request with customer external ID
+ * @returns Cancel renewal response
+ *
+ * @example
+ * ```typescript
+ * const response = await unsubscribe(client, 'plan-123', {
+ *   customerExternalId: 'customer-123'
+ * });
+ * console.log(response.message);
+ * ```
+ */
+function unsubscribe(client, planId, request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield client.plans.unsubscribe(planId, request);
+        return response;
+    });
+}
+/**
+ * Create a framework-agnostic handler for unsubscribing a customer from a plan
+ *
+ * This handler can be used with any framework adapter.
+ * The plan ID should be provided either in params or query string.
+ * The request body should contain customerExternalId.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planId]/unsubscribe/route.ts
+ * import { createUnsubscribeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createUnsubscribeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+function createUnsubscribeHandler() {
+    return (0, base_handler_js_1.createHandler)((client, body, params) => __awaiter(this, void 0, void 0, function* () {
+        const planId = params === null || params === void 0 ? void 0 : params.planId;
+        if (!planId) {
+            return {
+                success: false,
+                error: "planId is required",
+                status: 400,
+            };
+        }
+        if (!body.customerExternalId) {
+            return {
+                success: false,
+                error: "customerExternalId is required",
+                status: 400,
+            };
+        }
+        const response = yield unsubscribe(client, planId, body);
+        return { success: true, data: response };
+    }), {
+        allowedMethods: ['POST'],
+        requireOrganizationId: false,
+    });
+}
+/**
+ * Upgrade a customer from their current plan to a new plan
+ *
+ * Upgrades a customer from their current plan to a new plan with automatic proration calculation. This schedules a plan change and applies credits for the unused portion of the current billing period.
+ *
+ * @param client - PaidClient instance
+ * @param request - Upgrade request with customer external ID, old plan ID, and new plan ID
+ * @returns Proration upgrade response
+ *
+ * @example
+ * ```typescript
+ * const response = await upgrade(client, {
+ *   customerExternalId: 'customer-123',
+ *   oldPlanId: 'plan-123',
+ *   newPlanId: 'plan-456'
+ * });
+ * console.log(response.order.id);
+ * ```
+ */
+function upgrade(client, request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield client.plans.upgrade(request);
+        return response;
+    });
+}
+/**
+ * Create a framework-agnostic handler for upgrading a customer's plan
+ *
+ * This handler can be used with any framework adapter.
+ * The request body should contain customerExternalId, oldPlanId, and newPlanId.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/upgrade/route.ts
+ * import { createUpgradeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createUpgradeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+function createUpgradeHandler() {
+    return (0, base_handler_js_1.createHandler)((client, body) => __awaiter(this, void 0, void 0, function* () {
+        if (!body.customerExternalId) {
+            return {
+                success: false,
+                error: "customerExternalId is required",
+                status: 400,
+            };
+        }
+        if (!body.oldPlanId) {
+            return {
+                success: false,
+                error: "oldPlanId is required",
+                status: 400,
+            };
+        }
+        if (!body.newPlanId) {
+            return {
+                success: false,
+                error: "newPlanId is required",
+                status: 400,
+            };
+        }
+        const response = yield upgrade(client, body);
+        return { success: true, data: response };
+    }), {
+        allowedMethods: ['POST'],
+        requireOrganizationId: false,
+    });
+}

package/dist/cjs/integrations/types.d.ts

@@ -41,18 +41,20 @@ export interface OrderConfig {
     customerId: string;
     customerExternalId: string;
     billingContactId?: string;
-    agentExternalId: string;
+    agentExternalId?: string;
     name?: string;
     description?: string;
     startDate?: string;
     endDate?: string;
     currency?: string;
     orderLines?: OrderLineConfig[];
+    planId?: string;
 }
 export interface OrderLineConfig {
     agentExternalId: string;
     name?: string;
     description?: string;
+    planProductId?: string;
 }
 /**
  * Note: orderLines is not required because if agentExternalId is provided,
@@ -62,13 +64,14 @@ export interface CompleteOrderConfig {
     customerId: string;
     customerExternalId: string;
     billingContactId?: string;
-    agentExternalId: string;
+    agentExternalId?: string;
     name: string;
     description: string;
     startDate: string;
     endDate: string;
     currency: string;
     orderLines: OrderLineConfig[];
+    planId?: string;
 }
 export interface OrderOptions {
     /**

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.1-alpha0";
+export declare const SDK_VERSION = "1.0.1-alpha2";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.0.1-alpha0";
+exports.SDK_VERSION = "1.0.1-alpha2";

package/dist/esm/Client.mjs

@@ -14,8 +14,8 @@ export class PaidClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@paid-ai/paid-node",
-                "X-Fern-SDK-Version": "1.0.1-alpha0",
-                "User-Agent": "@paid-ai/paid-node/1.0.1-alpha0",
+                "X-Fern-SDK-Version": "1.0.1-alpha2",
+                "User-Agent": "@paid-ai/paid-node/1.0.1-alpha2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });