@whop/sdk 0.0.3 → 0.0.5

package/src/resources/invoices.ts

@@ -23,11 +23,13 @@ export class Invoices extends APIResource {
    *   collection_method: 'send_invoice',
    *   company_id: 'biz_xxxxxxxxxxxxxx',
    *   due_date: '2023-12-01T05:00:00.401Z',
+   *   member_id: 'mber_xxxxxxxxxxxxx',
    *   plan: {},
+   *   product: { title: 'title' },
    * });
    * ```
    */
-  create(body: InvoiceCreateParams, options?: RequestOptions): APIPromise<InvoiceCreateResponse> {
+  create(body: InvoiceCreateParams, options?: RequestOptions): APIPromise<Shared.Invoice> {
     return this._client.post('/invoices', { body, ...options });
   }
 
@@ -38,13 +40,6 @@ export class Invoices extends APIResource {
    *
    * - `invoice:basic:read`
    * - `plan:basic:read`
-   *
-   * @example
-   * ```ts
-   * const invoice = await client.invoices.retrieve(
-   *   'inv_xxxxxxxxxxxxxx',
-   * );
-   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Invoice> {
     return this._client.get(path`/invoices/${id}`, options);
@@ -57,16 +52,6 @@ export class Invoices extends APIResource {
    *
    * - `invoice:basic:read`
    * - `plan:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const invoiceListItem of client.invoices.list({
-   *   company_id: 'biz_xxxxxxxxxxxxxx',
-   * })) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     query: InvoiceListParams,
@@ -81,217 +66,704 @@ export class Invoices extends APIResource {
    * Required permissions:
    *
    * - `invoice:update`
-   *
-   * @example
-   * ```ts
-   * const response = await client.invoices.void(
-   *   'inv_xxxxxxxxxxxxxx',
-   * );
-   * ```
    */
   void(id: string, options?: RequestOptions): APIPromise<InvoiceVoidResponse> {
     return this._client.post(path`/invoices/${id}/void`, options);
   }
 }
 
-/**
- * Autogenerated return type of CreateInvoice.
- */
-export interface InvoiceCreateResponse {
-  /**
-   * The ID of the checkout job that was created for this invoice.
-   */
-  checkout_job_id: string | null;
-
-  /**
-   * The invoice that was created for this invoice.
-   */
-  invoice: Shared.Invoice;
-}
-
 /**
  * Represents `true` or `false` values.
  */
 export type InvoiceVoidResponse = boolean;
 
-export interface InvoiceCreateParams {
-  /**
-   * The method of collection for this invoice. If using charge_automatically, you
-   * must provide a payment_token.
-   */
-  collection_method: Shared.CollectionMethod;
+export type InvoiceCreateParams =
+  | InvoiceCreateParams.CreateInvoiceInputWithProductAndMemberID
+  | InvoiceCreateParams.CreateInvoiceInputWithProductAndEmailAddress
+  | InvoiceCreateParams.CreateInvoiceInputWithProductIDAndMemberID
+  | InvoiceCreateParams.CreateInvoiceInputWithProductIDAndEmailAddress;
 
-  /**
-   * The company ID to create this invoice for.
-   */
-  company_id: string;
+export declare namespace InvoiceCreateParams {
+  export interface CreateInvoiceInputWithProductAndMemberID {
+    /**
+     * The method of collection for this invoice. If using charge_automatically, you
+     * must provide a payment_token.
+     */
+    collection_method: Shared.CollectionMethod;
 
-  /**
-   * The date the invoice is due, if applicable.
-   */
-  due_date: string;
+    /**
+     * The company ID to create this invoice for.
+     */
+    company_id: string;
 
-  /**
-   * The properties of the plan to create for this invoice.
-   */
-  plan: InvoiceCreateParams.Plan;
+    /**
+     * The date the invoice is due, if applicable.
+     */
+    due_date: string;
 
-  /**
-   * Whether or not to charge the customer a buyer fee.
-   */
-  charge_buyer_fee?: boolean | null;
+    /**
+     * The member ID to create this invoice for. Include this if you want to create an
+     * invoice for an existing member. If you do not have a member ID, you must provide
+     * an email_address and customer_name.
+     */
+    member_id: string;
 
-  /**
-   * The name of the customer to create this invoice for. This is required if you
-   * want to create an invoice for a customer who does not have a member of your
-   * company yet.
-   */
-  customer_name?: string | null;
+    /**
+     * The properties of the plan to create for this invoice.
+     */
+    plan: CreateInvoiceInputWithProductAndMemberID.Plan;
 
-  /**
-   * The email address to create this invoice for. This is required if you want to
-   * create an invoice for a user who does not have a member of your company yet.
-   */
-  email_address?: string | null;
+    /**
+     * The properties of the product to create for this invoice. Include this if you
+     * want to create an invoice for a new product.
+     */
+    product: CreateInvoiceInputWithProductAndMemberID.Product;
 
-  /**
-   * The member ID to create this invoice for. Include this if you want to create an
-   * invoice for an existing member. If you do not have a member ID, you must provide
-   * an email_address and customer_name.
-   */
-  member_id?: string | null;
+    /**
+     * Whether or not to charge the customer a buyer fee.
+     */
+    charge_buyer_fee?: boolean | null;
 
-  /**
-   * The payment token ID to use for this invoice. If using charge_automatically, you
-   * must provide a payment_token.
-   */
-  payment_token_id?: string | null;
+    /**
+     * The name of the customer to create this invoice for. This is required if you
+     * want to create an invoice for a customer who does not have a member of your
+     * company yet.
+     */
+    customer_name?: string | null;
 
-  /**
-   * The properties of the product to create for this invoice. Include this if you
-   * want to create an invoice for a new product.
-   */
-  product?: InvoiceCreateParams.Product | null;
+    /**
+     * The payment token ID to use for this invoice. If using charge_automatically, you
+     * must provide a payment_token.
+     */
+    payment_token_id?: string | null;
+  }
 
-  /**
-   * The product ID to create this invoice for. Include this if you want to create an
-   * invoice for an existing product.
-   */
-  product_id?: string | null;
-}
+  export namespace CreateInvoiceInputWithProductAndMemberID {
+    /**
+     * The properties of the plan to create for this invoice.
+     */
+    export interface Plan {
+      /**
+       * The interval at which the plan charges (renewal plans).
+       */
+      billing_period?: number | null;
+
+      /**
+       * An array of custom field objects.
+       */
+      custom_fields?: Array<Plan.CustomField> | null;
+
+      /**
+       * The description of the plan.
+       */
+      description?: string | null;
+
+      /**
+       * The interval at which the plan charges (expiration plans).
+       */
+      expiration_days?: number | null;
+
+      /**
+       * An additional amount charged upon first purchase. Use only if a one time payment
+       * OR you want to charge an additional amount on top of the renewal price. Provided
+       * as a number in dollars. Eg: 10.43 for $10.43
+       */
+      initial_price?: number | null;
+
+      /**
+       * A personal description or notes section for the business.
+       */
+      internal_notes?: string | null;
+
+      /**
+       * The type of plan that can be attached to a product
+       */
+      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. Use only if a recurring
+       * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+       */
+      renewal_price?: number | null;
+
+      /**
+       * The number of units available for purchase.
+       */
+      stock?: number | null;
+
+      /**
+       * The number of free trial days added before a renewal plan.
+       */
+      trial_period_days?: number | null;
+
+      /**
+       * Limits/doesn't limit the number of units available for purchase.
+       */
+      unlimited_stock?: boolean | null;
+
+      /**
+       * Visibility of a resource
+       */
+      visibility?: Shared.Visibility | null;
+    }
+
+    export namespace Plan {
+      export 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;
+      }
+    }
+
+    /**
+     * The properties of the product to create for this invoice. Include this if you
+     * want to create an invoice for a new product.
+     */
+    export interface Product {
+      /**
+       * The title of the product.
+       */
+      title: string;
+
+      /**
+       * The ID of the product tax code to apply to this product.
+       */
+      product_tax_code_id?: string | null;
+    }
+  }
+
+  export interface CreateInvoiceInputWithProductAndEmailAddress {
+    /**
+     * The method of collection for this invoice. If using charge_automatically, you
+     * must provide a payment_token.
+     */
+    collection_method: Shared.CollectionMethod;
+
+    /**
+     * The company ID to create this invoice for.
+     */
+    company_id: string;
+
+    /**
+     * The date the invoice is due, if applicable.
+     */
+    due_date: string;
+
+    /**
+     * The email address to create this invoice for. This is required if you want to
+     * create an invoice for a user who does not have a member of your company yet.
+     */
+    email_address: string;
+
+    /**
+     * The properties of the plan to create for this invoice.
+     */
+    plan: CreateInvoiceInputWithProductAndEmailAddress.Plan;
+
+    /**
+     * The properties of the product to create for this invoice. Include this if you
+     * want to create an invoice for a new product.
+     */
+    product: CreateInvoiceInputWithProductAndEmailAddress.Product;
 
-export namespace InvoiceCreateParams {
-  /**
-   * The properties of the plan to create for this invoice.
-   */
-  export interface Plan {
     /**
-     * The interval at which the plan charges (renewal plans).
+     * Whether or not to charge the customer a buyer fee.
      */
-    billing_period?: number | null;
+    charge_buyer_fee?: boolean | null;
+
+    /**
+     * The name of the customer to create this invoice for. This is required if you
+     * want to create an invoice for a customer who does not have a member of your
+     * company yet.
+     */
+    customer_name?: string | null;
+
+    /**
+     * The payment token ID to use for this invoice. If using charge_automatically, you
+     * must provide a payment_token.
+     */
+    payment_token_id?: string | null;
+  }
+
+  export namespace CreateInvoiceInputWithProductAndEmailAddress {
+    /**
+     * The properties of the plan to create for this invoice.
+     */
+    export interface Plan {
+      /**
+       * The interval at which the plan charges (renewal plans).
+       */
+      billing_period?: number | null;
+
+      /**
+       * An array of custom field objects.
+       */
+      custom_fields?: Array<Plan.CustomField> | null;
+
+      /**
+       * The description of the plan.
+       */
+      description?: string | null;
+
+      /**
+       * The interval at which the plan charges (expiration plans).
+       */
+      expiration_days?: number | null;
+
+      /**
+       * An additional amount charged upon first purchase. Use only if a one time payment
+       * OR you want to charge an additional amount on top of the renewal price. Provided
+       * as a number in dollars. Eg: 10.43 for $10.43
+       */
+      initial_price?: number | null;
+
+      /**
+       * A personal description or notes section for the business.
+       */
+      internal_notes?: string | null;
+
+      /**
+       * The type of plan that can be attached to a product
+       */
+      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. Use only if a recurring
+       * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+       */
+      renewal_price?: number | null;
+
+      /**
+       * The number of units available for purchase.
+       */
+      stock?: number | null;
+
+      /**
+       * The number of free trial days added before a renewal plan.
+       */
+      trial_period_days?: number | null;
+
+      /**
+       * Limits/doesn't limit the number of units available for purchase.
+       */
+      unlimited_stock?: boolean | null;
+
+      /**
+       * Visibility of a resource
+       */
+      visibility?: Shared.Visibility | null;
+    }
+
+    export namespace Plan {
+      export 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 array of custom field objects.
+     * The properties of the product to create for this invoice. Include this if you
+     * want to create an invoice for a new product.
      */
-    custom_fields?: Array<Plan.CustomField> | null;
+    export interface Product {
+      /**
+       * The title of the product.
+       */
+      title: string;
+
+      /**
+       * The ID of the product tax code to apply to this product.
+       */
+      product_tax_code_id?: string | null;
+    }
+  }
 
+  export interface CreateInvoiceInputWithProductIDAndMemberID {
     /**
-     * The description of the plan.
+     * The method of collection for this invoice. If using charge_automatically, you
+     * must provide a payment_token.
      */
-    description?: string | null;
+    collection_method: Shared.CollectionMethod;
 
     /**
-     * The interval at which the plan charges (expiration plans).
+     * The company ID to create this invoice for.
      */
-    expiration_days?: number | null;
+    company_id: string;
 
     /**
-     * An additional amount charged upon first purchase. Use only if a one time payment
-     * OR you want to charge an additional amount on top of the renewal price. Provided
-     * as a number in dollars. Eg: 10.43 for $10.43
+     * The date the invoice is due, if applicable.
      */
-    initial_price?: number | null;
+    due_date: string;
 
     /**
-     * A personal description or notes section for the business.
+     * The member ID to create this invoice for. Include this if you want to create an
+     * invoice for an existing member. If you do not have a member ID, you must provide
+     * an email_address and customer_name.
      */
-    internal_notes?: string | null;
+    member_id: string;
 
     /**
-     * The type of plan that can be attached to an access pass
+     * The properties of the plan to create for this invoice.
      */
-    plan_type?: Shared.PlanType | null;
+    plan: CreateInvoiceInputWithProductIDAndMemberID.Plan;
 
     /**
-     * The methods of how a plan can be released.
+     * The product ID to create this invoice for. Include this if you want to create an
+     * invoice for an existing product.
      */
-    release_method?: Shared.ReleaseMethod | null;
+    product_id: string;
 
     /**
-     * The amount the customer is charged every billing period. Use only if a recurring
-     * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+     * Whether or not to charge the customer a buyer fee.
      */
-    renewal_price?: number | null;
+    charge_buyer_fee?: boolean | null;
 
     /**
-     * The number of free trial days added before a renewal plan.
+     * The name of the customer to create this invoice for. This is required if you
+     * want to create an invoice for a customer who does not have a member of your
+     * company yet.
      */
-    trial_period_days?: number | null;
+    customer_name?: string | null;
 
     /**
-     * Visibility of a resource
+     * The payment token ID to use for this invoice. If using charge_automatically, you
+     * must provide a payment_token.
      */
-    visibility?: Shared.Visibility | null;
+    payment_token_id?: string | null;
   }
 
-  export namespace Plan {
-    export interface CustomField {
+  export namespace CreateInvoiceInputWithProductIDAndMemberID {
+    /**
+     * The properties of the plan to create for this invoice.
+     */
+    export interface Plan {
+      /**
+       * The interval at which the plan charges (renewal plans).
+       */
+      billing_period?: number | null;
+
+      /**
+       * An array of custom field objects.
+       */
+      custom_fields?: Array<Plan.CustomField> | null;
+
+      /**
+       * The description of the plan.
+       */
+      description?: string | null;
+
+      /**
+       * The interval at which the plan charges (expiration plans).
+       */
+      expiration_days?: number | null;
+
+      /**
+       * An additional amount charged upon first purchase. Use only if a one time payment
+       * OR you want to charge an additional amount on top of the renewal price. Provided
+       * as a number in dollars. Eg: 10.43 for $10.43
+       */
+      initial_price?: number | null;
+
+      /**
+       * A personal description or notes section for the business.
+       */
+      internal_notes?: string | null;
+
+      /**
+       * The type of plan that can be attached to a product
+       */
+      plan_type?: Shared.PlanType | null;
+
       /**
-       * The type of the custom field.
+       * The methods of how a plan can be released.
        */
-      field_type: 'text';
+      release_method?: Shared.ReleaseMethod | null;
 
       /**
-       * The name of the custom field.
+       * The amount the customer is charged every billing period. Use only if a recurring
+       * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
        */
-      name: string;
+      renewal_price?: number | null;
 
       /**
-       * The ID of the custom field (if being updated)
+       * The number of units available for purchase.
        */
-      id?: string | null;
+      stock?: number | null;
 
       /**
-       * The order of the field.
+       * The number of free trial days added before a renewal plan.
        */
-      order?: number | null;
+      trial_period_days?: number | null;
 
       /**
-       * The placeholder value of the field.
+       * Limits/doesn't limit the number of units available for purchase.
        */
-      placeholder?: string | null;
+      unlimited_stock?: boolean | null;
 
       /**
-       * Whether or not the field is required.
+       * Visibility of a resource
        */
-      required?: boolean | null;
+      visibility?: Shared.Visibility | null;
+    }
+
+    export namespace Plan {
+      export 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;
+      }
     }
   }
 
-  /**
-   * The properties of the product to create for this invoice. Include this if you
-   * want to create an invoice for a new product.
-   */
-  export interface Product {
+  export interface CreateInvoiceInputWithProductIDAndEmailAddress {
+    /**
+     * The method of collection for this invoice. If using charge_automatically, you
+     * must provide a payment_token.
+     */
+    collection_method: Shared.CollectionMethod;
+
+    /**
+     * The company ID to create this invoice for.
+     */
+    company_id: string;
+
+    /**
+     * The date the invoice is due, if applicable.
+     */
+    due_date: string;
+
+    /**
+     * The email address to create this invoice for. This is required if you want to
+     * create an invoice for a user who does not have a member of your company yet.
+     */
+    email_address: string;
+
+    /**
+     * The properties of the plan to create for this invoice.
+     */
+    plan: CreateInvoiceInputWithProductIDAndEmailAddress.Plan;
+
+    /**
+     * The product ID to create this invoice for. Include this if you want to create an
+     * invoice for an existing product.
+     */
+    product_id: string;
+
+    /**
+     * Whether or not to charge the customer a buyer fee.
+     */
+    charge_buyer_fee?: boolean | null;
+
+    /**
+     * The name of the customer to create this invoice for. This is required if you
+     * want to create an invoice for a customer who does not have a member of your
+     * company yet.
+     */
+    customer_name?: string | null;
+
     /**
-     * The title of the product.
+     * The payment token ID to use for this invoice. If using charge_automatically, you
+     * must provide a payment_token.
      */
-    title: string;
+    payment_token_id?: string | null;
+  }
 
+  export namespace CreateInvoiceInputWithProductIDAndEmailAddress {
     /**
-     * The ID of the product tax code to apply to this product.
+     * The properties of the plan to create for this invoice.
      */
-    product_tax_code_id?: string | null;
+    export interface Plan {
+      /**
+       * The interval at which the plan charges (renewal plans).
+       */
+      billing_period?: number | null;
+
+      /**
+       * An array of custom field objects.
+       */
+      custom_fields?: Array<Plan.CustomField> | null;
+
+      /**
+       * The description of the plan.
+       */
+      description?: string | null;
+
+      /**
+       * The interval at which the plan charges (expiration plans).
+       */
+      expiration_days?: number | null;
+
+      /**
+       * An additional amount charged upon first purchase. Use only if a one time payment
+       * OR you want to charge an additional amount on top of the renewal price. Provided
+       * as a number in dollars. Eg: 10.43 for $10.43
+       */
+      initial_price?: number | null;
+
+      /**
+       * A personal description or notes section for the business.
+       */
+      internal_notes?: string | null;
+
+      /**
+       * The type of plan that can be attached to a product
+       */
+      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. Use only if a recurring
+       * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+       */
+      renewal_price?: number | null;
+
+      /**
+       * The number of units available for purchase.
+       */
+      stock?: number | null;
+
+      /**
+       * The number of free trial days added before a renewal plan.
+       */
+      trial_period_days?: number | null;
+
+      /**
+       * Limits/doesn't limit the number of units available for purchase.
+       */
+      unlimited_stock?: boolean | null;
+
+      /**
+       * Visibility of a resource
+       */
+      visibility?: Shared.Visibility | null;
+    }
+
+    export namespace Plan {
+      export 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;
+      }
+    }
   }
 }
 
@@ -307,14 +779,14 @@ export interface InvoiceListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The direction of the sort.
+   * Filter invoices by their collection method
    */
-  direction?: Shared.Direction | null;
+  collection_methods?: Array<Shared.CollectionMethod> | null;
 
   /**
-   * The filters to apply to the invoices
+   * The direction of the sort.
    */
-  filters?: InvoiceListParams.Filters | null;
+  direction?: Shared.Direction | null;
 
   /**
    * Returns the first _n_ elements from the list.
@@ -330,33 +802,20 @@ export interface InvoiceListParams extends CursorPageParams {
    * Which columns can be used to sort.
    */
   order?: 'id' | 'created_at' | 'due_date' | null;
-}
 
-export namespace InvoiceListParams {
   /**
-   * The filters to apply to the invoices
+   * Return only invoices created for these specific product ids
    */
-  export interface Filters {
-    /**
-     * The access pass IDs to filter the invoices by
-     */
-    access_pass_ids?: Array<string> | null;
+  product_ids?: Array<string> | null;
 
-    /**
-     * The collection methods to filter the invoices by
-     */
-    collection_methods?: Array<Shared.CollectionMethod> | null;
-
-    /**
-     * The statuses to filter the invoices by
-     */
-    statuses?: Array<Shared.InvoiceStatus> | null;
-  }
+  /**
+   * The statuses to filter the invoices by
+   */
+  statuses?: Array<Shared.InvoiceStatus> | null;
 }
 
 export declare namespace Invoices {
   export {
-    type InvoiceCreateResponse as InvoiceCreateResponse,
     type InvoiceVoidResponse as InvoiceVoidResponse,
     type InvoiceCreateParams as InvoiceCreateParams,
     type InvoiceListParams as InvoiceListParams,