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

package/dist/cjs/api/resources/customers/client/requests/CustomerCreate.d.ts

@@ -1,12 +1,22 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../../../../index.js";
+import type * as Paid from "../../../../index.js";
 /**
  * @example
  *     {
  *         name: "Acme, Inc.",
- *         externalId: "acme-inc"
+ *         externalId: "acme-inc",
+ *         contacts: [{
+ *                 salutation: "Mr.",
+ *                 firstName: "John",
+ *                 lastName: "Doe",
+ *                 accountName: "Acme, Inc.",
+ *                 email: "john.doe@acme.com",
+ *                 phone: "+1-555-0100",
+ *                 billingStreet: "123 Main Street",
+ *                 billingCity: "San Francisco",
+ *                 billingStateProvince: "CA",
+ *                 billingCountry: "USA",
+ *                 billingPostalCode: "94102"
+ *             }]
  *     }
  */
 export interface CustomerCreate {
@@ -21,4 +31,6 @@ export interface CustomerCreate {
     billingAddress?: Paid.Address;
     /** Flexible JSON field for storing custom metadata about the customer */
     metadata?: Record<string, unknown>;
+    /** Array of contacts to create for this customer */
+    contacts?: Paid.ContactCreateForCustomer[];
 }

package/dist/cjs/api/resources/customers/client/requests/CustomerCreate.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/customers/client/requests/CustomersCheckEntitlementRequest.d.ts

@@ -0,0 +1,14 @@
+import type * as Paid from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         event_name: "event_name",
+ *         view: "all"
+ *     }
+ */
+export interface CustomersCheckEntitlementRequest {
+    /** The name of the usage event to check entitlement for */
+    event_name: string;
+    /** Filter view - 'all' returns all entitlements regardless of status, 'active_only' returns only currently active entitlements with available credits */
+    view?: Paid.CustomersCheckEntitlementRequestView;
+}

package/dist/cjs/api/resources/customers/client/requests/CustomersCheckEntitlementRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/customers/client/requests/CustomersCreatePaymentMethodRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @example
+ *     {
+ *         confirmationToken: "ctoken_1234567890",
+ *         returnUrl: "https://example.com/payment-method-added",
+ *         metadata: {
+ *             "source": "api"
+ *         }
+ *     }
+ */
+export interface CustomersCreatePaymentMethodRequest {
+    /** Stripe confirmation token for the payment method */
+    confirmationToken: string;
+    /** URL to redirect to after payment method setup */
+    returnUrl: string;
+    /** Optional metadata to attach to the payment method */
+    metadata?: Record<string, unknown>;
+}

package/dist/cjs/api/resources/customers/client/requests/CustomersCreatePaymentMethodRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/customers/client/requests/CustomersGetCostsByExternalIdRequest.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * @example
  *     {
@@ -11,20 +8,12 @@
  *     }
  */
 export interface CustomersGetCostsByExternalIdRequest {
-    /**
-     * Maximum number of traces to return (1-1000)
-     */
+    /** Maximum number of traces to return (1-1000) */
     limit?: number;
-    /**
-     * Number of traces to skip for pagination
-     */
+    /** Number of traces to skip for pagination */
     offset?: number;
-    /**
-     * Filter traces starting from this time (ISO 8601 format)
-     */
+    /** Filter traces starting from this time (ISO 8601 format) */
     startTime?: string;
-    /**
-     * Filter traces up to this time (ISO 8601 format)
-     */
+    /** Filter traces up to this time (ISO 8601 format) */
     endTime?: string;
 }

package/dist/cjs/api/resources/customers/client/requests/CustomersGetCostsByExternalIdRequest.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/customers/client/requests/CustomersGetUsageByExternalIdRequest.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * @example
  *     {
@@ -11,20 +8,12 @@
  *     }
  */
 export interface CustomersGetUsageByExternalIdRequest {
-    /**
-     * Maximum number of usage summaries to return (1-1000)
-     */
+    /** Maximum number of usage summaries to return (1-1000) */
     limit?: number;
-    /**
-     * Number of usage summaries to skip for pagination
-     */
+    /** Number of usage summaries to skip for pagination */
     offset?: number;
-    /**
-     * Filter usage summaries starting from this time (ISO 8601 format). Returns summaries that overlap with the time range.
-     */
+    /** Filter usage summaries starting from this time (ISO 8601 format). Returns summaries that overlap with the time range. */
     startTime?: string;
-    /**
-     * Filter usage summaries up to this time (ISO 8601 format). Returns summaries that overlap with the time range.
-     */
+    /** Filter usage summaries up to this time (ISO 8601 format). Returns summaries that overlap with the time range. */
     endTime?: string;
 }

package/dist/cjs/api/resources/customers/client/requests/CustomersGetUsageByExternalIdRequest.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/customers/client/requests/index.d.ts

@@ -1,3 +1,5 @@
-export { type CustomerCreate } from "./CustomerCreate.js";
-export { type CustomersGetCostsByExternalIdRequest } from "./CustomersGetCostsByExternalIdRequest.js";
-export { type CustomersGetUsageByExternalIdRequest } from "./CustomersGetUsageByExternalIdRequest.js";
+export type { CustomerCreate } from "./CustomerCreate.js";
+export type { CustomersCheckEntitlementRequest } from "./CustomersCheckEntitlementRequest.js";
+export type { CustomersCreatePaymentMethodRequest } from "./CustomersCreatePaymentMethodRequest.js";
+export type { CustomersGetCostsByExternalIdRequest } from "./CustomersGetCostsByExternalIdRequest.js";
+export type { CustomersGetUsageByExternalIdRequest } from "./CustomersGetUsageByExternalIdRequest.js";

package/dist/cjs/api/resources/customers/index.d.ts

@@ -1 +1,2 @@
 export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/cjs/api/resources/customers/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/customers/types/CustomersCheckEntitlementRequestView.d.ts

@@ -0,0 +1,5 @@
+export declare const CustomersCheckEntitlementRequestView: {
+    readonly All: "all";
+    readonly ActiveOnly: "active_only";
+};
+export type CustomersCheckEntitlementRequestView = (typeof CustomersCheckEntitlementRequestView)[keyof typeof CustomersCheckEntitlementRequestView];

package/dist/cjs/api/resources/customers/types/CustomersCheckEntitlementRequestView.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomersCheckEntitlementRequestView = void 0;
+exports.CustomersCheckEntitlementRequestView = {
+    All: "all",
+    ActiveOnly: "active_only",
+};

package/dist/cjs/api/resources/customers/types/CustomersCheckEntitlementResponse.d.ts

@@ -0,0 +1,4 @@
+export interface CustomersCheckEntitlementResponse {
+    /** Whether the customer is entitled to the specified event */
+    entitled: boolean;
+}

package/dist/cjs/api/resources/customers/types/CustomersCheckEntitlementResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/customers/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./CustomersCheckEntitlementRequestView.js";
+export * from "./CustomersCheckEntitlementResponse.js";

package/dist/cjs/api/resources/customers/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CustomersCheckEntitlementRequestView.js"), exports);
+__exportStar(require("./CustomersCheckEntitlementResponse.js"), exports);

package/dist/cjs/api/resources/index.d.ts

@@ -1,17 +1,18 @@
-export * as usage from "./usage/index.js";
-export * from "./usage/types/index.js";
-export * as customers from "./customers/index.js";
+export * from "./agents/client/requests/index.js";
 export * as agents from "./agents/index.js";
-export * as products from "./products/index.js";
+export * from "./contacts/client/requests/index.js";
 export * as contacts from "./contacts/index.js";
-export * as orders from "./orders/index.js";
-export * as plans from "./plans/index.js";
-export * as traces from "./traces/index.js";
 export * from "./customers/client/requests/index.js";
-export * from "./agents/client/requests/index.js";
-export * from "./products/client/requests/index.js";
-export * from "./contacts/client/requests/index.js";
+export * as customers from "./customers/index.js";
+export * from "./customers/types/index.js";
 export * from "./orders/client/requests/index.js";
+export * as orders from "./orders/index.js";
 export * from "./plans/client/requests/index.js";
-export * from "./usage/client/requests/index.js";
+export * as plans from "./plans/index.js";
+export * from "./products/client/requests/index.js";
+export * as products from "./products/index.js";
 export * from "./traces/client/requests/index.js";
+export * as traces from "./traces/index.js";
+export * from "./usage/client/requests/index.js";
+export * as usage from "./usage/index.js";
+export * from "./usage/types/index.js";

package/dist/cjs/api/resources/index.js

@@ -15,6 +15,9 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importStar = (this && this.__importStar) || (function () {
     var ownKeys = function(o) {
         ownKeys = Object.getOwnPropertyNames || function (o) {
@@ -32,25 +35,23 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.traces = exports.plans = exports.orders = exports.contacts = exports.products = exports.agents = exports.customers = exports.usage = void 0;
-exports.usage = __importStar(require("./usage/index.js"));
-__exportStar(require("./usage/types/index.js"), exports);
-exports.customers = __importStar(require("./customers/index.js"));
+exports.usage = exports.traces = exports.products = exports.plans = exports.orders = exports.customers = exports.contacts = exports.agents = void 0;
+__exportStar(require("./agents/client/requests/index.js"), exports);
 exports.agents = __importStar(require("./agents/index.js"));
-exports.products = __importStar(require("./products/index.js"));
+__exportStar(require("./contacts/client/requests/index.js"), exports);
 exports.contacts = __importStar(require("./contacts/index.js"));
-exports.orders = __importStar(require("./orders/index.js"));
-exports.plans = __importStar(require("./plans/index.js"));
-exports.traces = __importStar(require("./traces/index.js"));
 __exportStar(require("./customers/client/requests/index.js"), exports);
-__exportStar(require("./agents/client/requests/index.js"), exports);
-__exportStar(require("./products/client/requests/index.js"), exports);
-__exportStar(require("./contacts/client/requests/index.js"), exports);
+exports.customers = __importStar(require("./customers/index.js"));
+__exportStar(require("./customers/types/index.js"), exports);
 __exportStar(require("./orders/client/requests/index.js"), exports);
+exports.orders = __importStar(require("./orders/index.js"));
 __exportStar(require("./plans/client/requests/index.js"), exports);
-__exportStar(require("./usage/client/requests/index.js"), exports);
+exports.plans = __importStar(require("./plans/index.js"));
+__exportStar(require("./products/client/requests/index.js"), exports);
+exports.products = __importStar(require("./products/index.js"));
 __exportStar(require("./traces/client/requests/index.js"), exports);
+exports.traces = __importStar(require("./traces/index.js"));
+__exportStar(require("./usage/client/requests/index.js"), exports);
+exports.usage = __importStar(require("./usage/index.js"));
+__exportStar(require("./usage/types/index.js"), exports);

package/dist/cjs/api/resources/orders/client/Client.d.ts

@@ -1,28 +1,11 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments.js";
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as Paid from "../../../index.js";
 import { Lines } from "../resources/lines/client/Client.js";
 export declare namespace Orders {
-    interface Options {
-        environment?: core.Supplier<environments.PaidEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    interface Options extends BaseClientOptions {
     }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    interface RequestOptions extends BaseRequestOptions {
     }
 }
 export declare class Orders {
@@ -91,5 +74,84 @@ export declare class Orders {
      */
     activate(orderId: string, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Paid.Order>;
     private __activate;
+    /**
+     * Activates the order and processes the initial payment using the provided Stripe confirmation token.
+     *
+     * @param {string} orderId - The order ID (can be internal ID or display ID)
+     * @param {Paid.OrdersActivateAndPayRequest} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.orders.activateAndPay("orderId", {
+     *         confirmationToken: "ctoken_1234567890",
+     *         returnUrl: "https://example.com/payment-complete"
+     *     })
+     */
+    activateAndPay(orderId: string, request: Paid.OrdersActivateAndPayRequest, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Paid.Order>;
+    private __activateAndPay;
+    /**
+     * Schedules the cancellation of an order's renewal from a specified date. The order will remain active until the cancellation date.
+     *
+     * @param {string} orderId - The order ID (can be internal ID or display ID)
+     * @param {Paid.CancelRenewalRequest} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.orders.cancelRenewal("orderId", {
+     *         orderVersion: 1,
+     *         cancelFromDate: "2025-12-31T00:00:00Z"
+     *     })
+     */
+    cancelRenewal(orderId: string, request: Paid.CancelRenewalRequest, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Paid.CancelRenewalResponse>;
+    private __cancelRenewal;
+    /**
+     * Schedules a plan upgrade or downgrade for an order with automatic proration calculation. Credits are applied for the unused portion of the current billing period.
+     *
+     * @param {string} orderId - The order ID (can be internal ID or display ID)
+     * @param {Paid.ProrationUpgradeRequest} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.orders.schedulePlanChange("orderId", {
+     *         orderVersion: 1,
+     *         effectiveDate: "2025-02-01T00:00:00Z",
+     *         updatedOrderLineAttributes: [{
+     *                 orderLineAttributeId: "a1b2c3d4-5678-90ab-cdef-1234567890ab",
+     *                 newPricing: {
+     *                     "unitPrice": 200,
+     *                     "currency": "USD"
+     *                 },
+     *                 newQuantity: 10
+     *             }]
+     *     })
+     */
+    schedulePlanChange(orderId: string, request: Paid.ProrationUpgradeRequest, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Paid.ProrationUpgradeResponse>;
+    private __schedulePlanChange;
+    /**
+     * Retrieves all invoices associated with a specific order.
+     *
+     * @param {string} orderId - The order ID (can be internal ID or display ID)
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.orders.getInvoices("orderId")
+     */
+    getInvoices(orderId: string, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Paid.Invoice[]>;
+    private __getInvoices;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }