@paid-ai/paid-node 0.5.0 → 1.0.0

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

@@ -1,65 +1,61 @@
-/**
- * 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 { type NormalizedClientOptions } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as Paid from "../../../index.js";
-export declare namespace Customers {
-    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 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>;
+export declare namespace CustomersClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Customers {
-    protected readonly _options: Customers.Options;
-    constructor(_options?: Customers.Options);
+export declare class CustomersClient {
+    protected readonly _options: NormalizedClientOptions<CustomersClient.Options>;
+    constructor(options?: CustomersClient.Options);
     /**
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.customers.list()
      */
-    list(requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer[]>;
+    list(requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.Customer[]>;
     private __list;
     /**
      * @param {Paid.CustomerCreate} request
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.customers.create({
      *         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"
+     *             }]
      *     })
      */
-    create(request: Paid.CustomerCreate, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
+    create(request: Paid.CustomerCreate, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
     private __create;
     /**
      * @param {string} customerId
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.customers.get("customerId")
      */
-    get(customerId: string, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
+    get(customerId: string, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
     private __get;
     /**
      * @param {string} customerId
      * @param {Paid.CustomerUpdate} request
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.customers.update("customerId", {
@@ -69,60 +65,76 @@ export declare class Customers {
      *         annualRevenue: 1000001
      *     })
      */
-    update(customerId: string, request: Paid.CustomerUpdate, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
+    update(customerId: string, request: Paid.CustomerUpdate, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
     private __update;
     /**
      * @param {string} customerId
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.customers.delete("customerId")
      */
-    delete(customerId: string, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<void>;
+    delete(customerId: string, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
      * @param {string} customerId - The customer ID
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Paid.CustomersCheckEntitlementRequest} request
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.customers.checkEntitlement("customerId", {
+     *         event_name: "event_name",
+     *         view: "all"
+     *     })
+     */
+    checkEntitlement(customerId: string, request: Paid.CustomersCheckEntitlementRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.CustomersCheckEntitlementResponse>;
+    private __checkEntitlement;
+    /**
+     * @param {string} customerId - The customer ID
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Paid.ForbiddenError}
      *
      * @example
      *     await client.customers.getEntitlements("customerId")
      */
-    getEntitlements(customerId: string, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.EntitlementUsage[]>;
+    getEntitlements(customerId: string, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.EntitlementUsage[]>;
     private __getEntitlements;
     /**
      * @param {string} externalId
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.customers.getByExternalId("externalId")
      */
-    getByExternalId(externalId: string, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
+    getByExternalId(externalId: string, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
     private __getByExternalId;
     /**
      * @param {string} externalId
      * @param {Paid.CustomerUpdate} request
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.customers.updateByExternalId("externalId", {})
      */
-    updateByExternalId(externalId: string, request: Paid.CustomerUpdate, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
+    updateByExternalId(externalId: string, request: Paid.CustomerUpdate, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
     private __updateByExternalId;
     /**
      * @param {string} externalId
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.customers.deleteByExternalId("externalId")
      */
-    deleteByExternalId(externalId: string, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<void>;
+    deleteByExternalId(externalId: string, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteByExternalId;
     /**
      * @param {string} externalId - The external ID of the customer
      * @param {Paid.CustomersGetCostsByExternalIdRequest} request
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Paid.BadRequestError}
      * @throws {@link Paid.ForbiddenError}
@@ -136,12 +148,12 @@ export declare class Customers {
      *         endTime: "2024-01-15T09:30:00Z"
      *     })
      */
-    getCostsByExternalId(externalId: string, request?: Paid.CustomersGetCostsByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CostTracesResponse>;
+    getCostsByExternalId(externalId: string, request?: Paid.CustomersGetCostsByExternalIdRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.CostTracesResponse>;
     private __getCostsByExternalId;
     /**
      * @param {string} externalId - The external ID of the customer
      * @param {Paid.CustomersGetUsageByExternalIdRequest} request
-     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Paid.BadRequestError}
      * @throws {@link Paid.ForbiddenError}
@@ -155,7 +167,57 @@ export declare class Customers {
      *         endTime: "2024-01-15T09:30:00Z"
      *     })
      */
-    getUsageByExternalId(externalId: string, request?: Paid.CustomersGetUsageByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.UsageSummariesResponse>;
+    getUsageByExternalId(externalId: string, request?: Paid.CustomersGetUsageByExternalIdRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.UsageSummariesResponse>;
     private __getUsageByExternalId;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    /**
+     * Retrieves all payment methods associated with a customer identified by their external ID.
+     *
+     * @param {string} externalId - The external ID of the customer
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.customers.listPaymentMethods("externalId")
+     */
+    listPaymentMethods(externalId: string, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.PaymentMethod[]>;
+    private __listPaymentMethods;
+    /**
+     * Creates a new payment method for a customer using a Stripe confirmation token.
+     *
+     * @param {string} externalId - The external ID of the customer
+     * @param {Paid.CustomersCreatePaymentMethodRequest} request
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.customers.createPaymentMethod("externalId", {
+     *         confirmationToken: "ctoken_1234567890",
+     *         returnUrl: "https://example.com/payment-method-added",
+     *         metadata: {
+     *             "source": "api"
+     *         }
+     *     })
+     */
+    createPaymentMethod(externalId: string, request: Paid.CustomersCreatePaymentMethodRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Paid.PaymentMethod>;
+    private __createPaymentMethod;
+    /**
+     * Deletes a specific payment method from a customer's account.
+     *
+     * @param {string} externalId - The external ID of the customer
+     * @param {string} paymentMethodId - The ID of the payment method to delete
+     * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.customers.deletePaymentMethod("externalId", "paymentMethodId")
+     */
+    deletePaymentMethod(externalId: string, paymentMethodId: string, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deletePaymentMethod;
 }