@whop/sdk 0.0.1-canary.0

package/resources/plans.d.ts

@@ -0,0 +1,479 @@
+import { APIResource } from "../core/resource.js";
+import * as Shared from "./shared.js";
+import { APIPromise } from "../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Plans extends APIResource {
+    /**
+     * Create a new Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:create`
+     * - `access_pass:basic:read`
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     *   product_id: 'prod_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body: PlanCreateParams, options?: RequestOptions): APIPromise<Shared.Plan>;
+    /**
+     * Retrieves a plan by ID
+     *
+     * Required permissions:
+     *
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.retrieve(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Plan>;
+    /**
+     * Update an existing Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:update`
+     * - `access_pass:basic:read`
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.update(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    update(id: string, body?: PlanUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Plan>;
+    /**
+     * Lists plans for a company
+     *
+     * Required permissions:
+     *
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListResponse of client.plans.list({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query: PlanListParams, options?: RequestOptions): PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
+    /**
+     * Delete an existing Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:delete`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.delete(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<PlanDeleteResponse>;
+}
+export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
+/**
+ * An object representing a (sanitized) plan of an access pass.
+ */
+export interface PlanListResponse {
+    /**
+     * The internal ID of the plan.
+     */
+    id: string;
+    /**
+     * The interval at which the plan charges (renewal plans).
+     */
+    billing_period: number | null;
+    /**
+     * The company for the plan.
+     */
+    company: PlanListResponse.Company | null;
+    /**
+     * When the plan was created.
+     */
+    created_at: string;
+    /**
+     * The respective currency identifier for the plan.
+     */
+    currency: Shared.Currency;
+    /**
+     * The description of the plan.
+     */
+    description: string | null;
+    /**
+     * The interval at which the plan charges (expiration plans).
+     */
+    expiration_days: number | null;
+    /**
+     * The price a person has to pay for a plan on the initial purchase.
+     */
+    initial_price: number;
+    /**
+     * A personal description or notes section for the business.
+     */
+    internal_notes: string | null;
+    /**
+     * The invoice associated with this plan.
+     */
+    invoice: PlanListResponse.Invoice | null;
+    /**
+     * The number of members for the plan.
+     */
+    member_count: number | null;
+    /**
+     * Indicates if the plan is a one time payment or recurring.
+     */
+    plan_type: Shared.PlanType;
+    /**
+     * The access pass for the plan.
+     */
+    product: PlanListResponse.Product | null;
+    /**
+     * The direct link to purchase the product.
+     */
+    purchase_url: string;
+    /**
+     * This is the release method the business uses to sell this plan.
+     */
+    release_method: Shared.ReleaseMethod;
+    /**
+     * The price a person has to pay for a plan on the renewal purchase.
+     */
+    renewal_price: number;
+    /**
+     * The number of free trial days added before a renewal plan.
+     */
+    trial_period_days: number | null;
+    /**
+     * When the plan was last updated.
+     */
+    updated_at: string;
+    /**
+     * Shows or hides the plan from public/business view.
+     */
+    visibility: Shared.Visibility;
+}
+export declare namespace PlanListResponse {
+    /**
+     * The company for the plan.
+     */
+    interface Company {
+        /**
+         * The ID (tag) of the company.
+         */
+        id: string;
+        /**
+         * The title of the company.
+         */
+        title: string;
+    }
+    /**
+     * The invoice associated with this plan.
+     */
+    interface Invoice {
+        /**
+         * The ID of the invoice.
+         */
+        id: string;
+    }
+    /**
+     * The access pass for the plan.
+     */
+    interface Product {
+        /**
+         * The internal ID of the public product.
+         */
+        id: string;
+        /**
+         * The title of the product. Use for Whop 4.0.
+         */
+        title: string;
+    }
+}
+/**
+ * Represents `true` or `false` values.
+ */
+export type PlanDeleteResponse = boolean;
+export interface PlanCreateParams {
+    /**
+     * The company the plan should be created for.
+     */
+    company_id: string;
+    /**
+     * The product the plan is related to.
+     */
+    product_id: string;
+    /**
+     * The interval at which the plan charges (renewal plans).
+     */
+    billing_period?: number | null;
+    /**
+     * The available currencies on the platform
+     */
+    currency?: Shared.Currency | null;
+    /**
+     * An array of custom field objects.
+     */
+    custom_fields?: Array<PlanCreateParams.CustomField> | null;
+    /**
+     * The description of the plan.
+     */
+    description?: string | null;
+    /**
+     * The interval at which the plan charges (expiration plans).
+     */
+    expiration_days?: number | null;
+    /**
+     * An image for the plan. This will be visible on the product page to customers.
+     */
+    image?: PlanCreateParams.Image | null;
+    /**
+     * An additional amount charged upon first purchase.
+     */
+    initial_price?: number | null;
+    /**
+     * A personal description or notes section for the business.
+     */
+    internal_notes?: string | null;
+    /**
+     * Whether or not the tax is included in a plan's price (or if it hasn't been set
+     * up)
+     */
+    override_tax_type?: Shared.TaxType | null;
+    /**
+     * The type of plan that can be attached to an access pass
+     */
+    plan_type?: Shared.PlanType | null;
+    /**
+     * The methods of how a plan can be released.
+     */
+    release_method?: Shared.ReleaseMethod | null;
+    /**
+     * The amount the customer is charged every billing period.
+     */
+    renewal_price?: number | null;
+    /**
+     * The title of the plan. This will be visible on the product page to customers.
+     */
+    title?: string | null;
+    /**
+     * The number of free trial days added before a renewal plan.
+     */
+    trial_period_days?: number | null;
+    /**
+     * Visibility of a resource
+     */
+    visibility?: Shared.Visibility | null;
+}
+export declare namespace PlanCreateParams {
+    interface CustomField {
+        /**
+         * The type of the custom field.
+         */
+        field_type: 'text';
+        /**
+         * The name of the custom field.
+         */
+        name: string;
+        /**
+         * The ID of the custom field (if being updated)
+         */
+        id?: string | null;
+        /**
+         * The order of the field.
+         */
+        order?: number | null;
+        /**
+         * The placeholder value of the field.
+         */
+        placeholder?: string | null;
+        /**
+         * Whether or not the field is required.
+         */
+        required?: boolean | null;
+    }
+    /**
+     * An image for the plan. This will be visible on the product page to customers.
+     */
+    interface Image {
+        /**
+         * The ID of an existing attachment object. Use this when updating a resource and
+         * keeping a subset of the attachments. Don't use this unless you know what you're
+         * doing.
+         */
+        id?: string | null;
+        /**
+         * This ID should be used the first time you upload an attachment. It is the ID of
+         * the direct upload that was created when uploading the file to S3 via the
+         * mediaDirectUpload mutation.
+         */
+        direct_upload_id?: string | null;
+    }
+}
+export interface PlanUpdateParams {
+    /**
+     * The interval at which the plan charges (renewal plans).
+     */
+    billing_period?: number | null;
+    /**
+     * The available currencies on the platform
+     */
+    currency?: Shared.Currency | null;
+    /**
+     * An array of custom field objects.
+     */
+    custom_fields?: Array<PlanUpdateParams.CustomField> | null;
+    /**
+     * The description of the plan.
+     */
+    description?: string | null;
+    /**
+     * The interval at which the plan charges (expiration plans).
+     */
+    expiration_days?: number | null;
+    /**
+     * An image for the plan. This will be visible on the product page to customers.
+     */
+    image?: PlanUpdateParams.Image | null;
+    /**
+     * An additional amount charged upon first purchase.
+     */
+    initial_price?: number | null;
+    /**
+     * A personal description or notes section for the business.
+     */
+    internal_notes?: string | null;
+    /**
+     * Whether or not to offer a discount to cancel a subscription.
+     */
+    offer_cancel_discount?: boolean | null;
+    /**
+     * Whether or not the tax is included in a plan's price (or if it hasn't been set
+     * up)
+     */
+    override_tax_type?: Shared.TaxType | null;
+    /**
+     * The amount the customer is charged every billing period.
+     */
+    renewal_price?: number | null;
+    /**
+     * The title of the plan. This will be visible on the product page to customers.
+     */
+    title?: string | null;
+    /**
+     * The number of free trial days added before a renewal plan.
+     */
+    trial_period_days?: number | null;
+    /**
+     * Visibility of a resource
+     */
+    visibility?: Shared.Visibility | null;
+}
+export declare namespace PlanUpdateParams {
+    interface CustomField {
+        /**
+         * The type of the custom field.
+         */
+        field_type: 'text';
+        /**
+         * The name of the custom field.
+         */
+        name: string;
+        /**
+         * The ID of the custom field (if being updated)
+         */
+        id?: string | null;
+        /**
+         * The order of the field.
+         */
+        order?: number | null;
+        /**
+         * The placeholder value of the field.
+         */
+        placeholder?: string | null;
+        /**
+         * Whether or not the field is required.
+         */
+        required?: boolean | null;
+    }
+    /**
+     * An image for the plan. This will be visible on the product page to customers.
+     */
+    interface Image {
+        /**
+         * The ID of an existing attachment object. Use this when updating a resource and
+         * keeping a subset of the attachments. Don't use this unless you know what you're
+         * doing.
+         */
+        id?: string | null;
+        /**
+         * This ID should be used the first time you upload an attachment. It is the ID of
+         * the direct upload that was created when uploading the file to S3 via the
+         * mediaDirectUpload mutation.
+         */
+        direct_upload_id?: string | null;
+    }
+}
+export interface PlanListParams extends CursorPageParams {
+    /**
+     * The ID of the company
+     */
+    company_id: string;
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * The direction of the sort.
+     */
+    direction?: Shared.Direction | null;
+    /**
+     * Returns the first _n_ elements from the list.
+     */
+    first?: number | null;
+    /**
+     * Returns the last _n_ elements from the list.
+     */
+    last?: number | null;
+    /**
+     * The ways a relation of Plans can be ordered
+     */
+    order?: 'id' | 'active_members_count' | 'created_at' | 'internal_notes' | 'expires_at' | null;
+    /**
+     * The plan type to filter the plans by
+     */
+    plan_types?: Array<Shared.PlanType> | null;
+    /**
+     * The product IDs to filter the plans by
+     */
+    product_ids?: Array<string> | null;
+    /**
+     * The release method to filter the plans by
+     */
+    release_methods?: Array<Shared.ReleaseMethod> | null;
+    /**
+     * The visibility to filter the plans by
+     */
+    visibilities?: Array<Shared.VisibilityFilter> | null;
+}
+export declare namespace Plans {
+    export { type PlanListResponse as PlanListResponse, type PlanDeleteResponse as PlanDeleteResponse, type PlanListResponsesCursorPage as PlanListResponsesCursorPage, type PlanCreateParams as PlanCreateParams, type PlanUpdateParams as PlanUpdateParams, type PlanListParams as PlanListParams, };
+}
+//# sourceMappingURL=plans.d.ts.map

package/resources/plans.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../src/resources/plans.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC;IAIjF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC;IAIvE;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC;IAI1B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC;IAErC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;CAC/B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAEzC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,WAAW;QAC1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;;;WAIG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,WAAW;QAC1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;;;WAIG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,GAAG,sBAAsB,GAAG,YAAY,GAAG,gBAAgB,GAAG,YAAY,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}

package/resources/plans.js

@@ -0,0 +1,104 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plans = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class Plans extends resource_1.APIResource {
+    /**
+     * Create a new Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:create`
+     * - `access_pass:basic:read`
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     *   product_id: 'prod_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/plans', { body, ...options });
+    }
+    /**
+     * Retrieves a plan by ID
+     *
+     * Required permissions:
+     *
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.retrieve(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/plans/${id}`, options);
+    }
+    /**
+     * Update an existing Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:update`
+     * - `access_pass:basic:read`
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.update(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    update(id, body = {}, options) {
+        return this._client.patch((0, path_1.path) `/plans/${id}`, { body, ...options });
+    }
+    /**
+     * Lists plans for a company
+     *
+     * Required permissions:
+     *
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListResponse of client.plans.list({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query, options) {
+        return this._client.getAPIList('/plans', (pagination_1.CursorPage), { query, ...options });
+    }
+    /**
+     * Delete an existing Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:delete`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.delete(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/plans/${id}`, options);
+    }
+}
+exports.Plans = Plans;
+//# sourceMappingURL=plans.js.map

package/resources/plans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.js","sourceRoot":"","sources":["../src/resources/plans.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,OAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,uBAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AAzGD,sBAyGC"}

package/resources/plans.mjs

@@ -0,0 +1,100 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { CursorPage } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Plans extends APIResource {
+    /**
+     * Create a new Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:create`
+     * - `access_pass:basic:read`
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     *   product_id: 'prod_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/plans', { body, ...options });
+    }
+    /**
+     * Retrieves a plan by ID
+     *
+     * Required permissions:
+     *
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.retrieve(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/plans/${id}`, options);
+    }
+    /**
+     * Update an existing Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:update`
+     * - `access_pass:basic:read`
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.update(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    update(id, body = {}, options) {
+        return this._client.patch(path `/plans/${id}`, { body, ...options });
+    }
+    /**
+     * Lists plans for a company
+     *
+     * Required permissions:
+     *
+     * - `plan:basic:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListResponse of client.plans.list({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query, options) {
+        return this._client.getAPIList('/plans', (CursorPage), { query, ...options });
+    }
+    /**
+     * Delete an existing Plan
+     *
+     * Required permissions:
+     *
+     * - `plan:delete`
+     *
+     * @example
+     * ```ts
+     * const plan = await client.plans.delete(
+     *   'plan_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(path `/plans/${id}`, options);
+    }
+}
+//# sourceMappingURL=plans.mjs.map

package/resources/plans.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.mjs","sourceRoot":"","sources":["../src/resources/plans.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,OAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAA,UAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF"}