@whop/sdk 0.0.3 → 0.0.5

package/resources/invoices.d.ts

@@ -19,11 +19,13 @@ export declare 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>;
     /**
      * Retrieves an invoice by ID or token
      *
@@ -31,13 +33,6 @@ export declare 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>;
     /**
@@ -47,16 +42,6 @@ export declare 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, options?: RequestOptions): PagePromise<InvoiceListItemsCursorPage, Shared.InvoiceListItem>;
     /**
@@ -65,182 +50,580 @@ export declare 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>;
 }
-/**
- * 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;
-    /**
-     * The company ID to create this invoice for.
-     */
-    company_id: string;
-    /**
-     * The date the invoice is due, if applicable.
-     */
-    due_date: string;
-    /**
-     * The properties of the plan to create for this invoice.
-     */
-    plan: InvoiceCreateParams.Plan;
-    /**
-     * 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 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 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;
-    /**
-     * 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 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 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 type InvoiceCreateParams = InvoiceCreateParams.CreateInvoiceInputWithProductAndMemberID | InvoiceCreateParams.CreateInvoiceInputWithProductAndEmailAddress | InvoiceCreateParams.CreateInvoiceInputWithProductIDAndMemberID | InvoiceCreateParams.CreateInvoiceInputWithProductIDAndEmailAddress;
 export declare namespace InvoiceCreateParams {
-    /**
-     * The properties of the plan to create for this invoice.
-     */
-    interface Plan {
+    interface CreateInvoiceInputWithProductAndMemberID {
+        /**
+         * 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 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 properties of the plan to create for this invoice.
+         */
+        plan: CreateInvoiceInputWithProductAndMemberID.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: CreateInvoiceInputWithProductAndMemberID.Product;
+        /**
+         * 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 payment token ID to use for this invoice. If using charge_automatically, you
+         * must provide a payment_token.
+         */
+        payment_token_id?: string | null;
+    }
+    namespace CreateInvoiceInputWithProductAndMemberID {
+        /**
+         * The properties of the plan to create for this invoice.
+         */
+        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;
+        }
+        namespace Plan {
+            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.
+         */
+        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;
+        }
+    }
+    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;
+        /**
+         * Whether or not to charge the customer a buyer fee.
+         */
+        charge_buyer_fee?: boolean | null;
         /**
-         * The interval at which the plan charges (renewal plans).
+         * 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.
          */
-        billing_period?: number | null;
+        customer_name?: string | null;
         /**
-         * An array of custom field objects.
+         * The payment token ID to use for this invoice. If using charge_automatically, you
+         * must provide a payment_token.
          */
-        custom_fields?: Array<Plan.CustomField> | null;
+        payment_token_id?: string | null;
+    }
+    namespace CreateInvoiceInputWithProductAndEmailAddress {
         /**
-         * The description of the plan.
+         * The properties of the plan to create for this invoice.
          */
-        description?: string | null;
+        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;
+        }
+        namespace Plan {
+            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 interval at which the plan charges (expiration plans).
+         * The properties of the product to create for this invoice. Include this if you
+         * want to create an invoice for a new product.
          */
-        expiration_days?: number | null;
+        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;
+        }
+    }
+    interface CreateInvoiceInputWithProductIDAndMemberID {
+        /**
+         * The method of collection for this invoice. If using charge_automatically, you
+         * must provide a payment_token.
+         */
+        collection_method: Shared.CollectionMethod;
         /**
-         * 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 company ID to create this invoice for.
          */
-        initial_price?: number | null;
+        company_id: string;
         /**
-         * A personal description or notes section for the business.
+         * The date the invoice is due, if applicable.
          */
-        internal_notes?: string | null;
+        due_date: string;
         /**
-         * The type of plan that can be attached to an access pass
+         * 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.
          */
-        plan_type?: Shared.PlanType | null;
+        member_id: string;
         /**
-         * The methods of how a plan can be released.
+         * The properties of the plan to create for this invoice.
          */
-        release_method?: Shared.ReleaseMethod | null;
+        plan: CreateInvoiceInputWithProductIDAndMemberID.Plan;
         /**
-         * 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
+         * The product ID to create this invoice for. Include this if you want to create an
+         * invoice for an existing product.
          */
-        renewal_price?: number | null;
+        product_id: string;
         /**
-         * The number of free trial days added before a renewal plan.
+         * Whether or not to charge the customer a buyer fee.
          */
-        trial_period_days?: number | null;
+        charge_buyer_fee?: boolean | null;
         /**
-         * Visibility of a resource
+         * 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.
          */
-        visibility?: Shared.Visibility | null;
+        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;
     }
-    namespace Plan {
-        interface CustomField {
+    namespace CreateInvoiceInputWithProductIDAndMemberID {
+        /**
+         * The properties of the plan to create for this invoice.
+         */
+        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 type of the custom field.
+             * The description of the plan.
              */
-            field_type: 'text';
+            description?: string | null;
             /**
-             * The name of the custom field.
+             * The interval at which the plan charges (expiration plans).
              */
-            name: string;
+            expiration_days?: number | null;
             /**
-             * The ID of the custom field (if being updated)
+             * 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
              */
-            id?: string | null;
+            initial_price?: number | null;
             /**
-             * The order of the field.
+             * A personal description or notes section for the business.
              */
-            order?: number | null;
+            internal_notes?: string | null;
             /**
-             * The placeholder value of the field.
+             * The type of plan that can be attached to a product
              */
-            placeholder?: string | null;
+            plan_type?: Shared.PlanType | null;
             /**
-             * Whether or not the field is required.
+             * The methods of how a plan can be released.
              */
-            required?: boolean | null;
+            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;
+        }
+        namespace Plan {
+            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.
-     */
-    interface Product {
+    interface CreateInvoiceInputWithProductIDAndEmailAddress {
         /**
-         * The title of the product.
+         * The method of collection for this invoice. If using charge_automatically, you
+         * must provide a payment_token.
          */
-        title: string;
+        collection_method: Shared.CollectionMethod;
         /**
-         * The ID of the product tax code to apply to this product.
+         * The company ID to create this invoice for.
          */
-        product_tax_code_id?: string | null;
+        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 payment token ID to use for this invoice. If using charge_automatically, you
+         * must provide a payment_token.
+         */
+        payment_token_id?: string | null;
+    }
+    namespace CreateInvoiceInputWithProductIDAndEmailAddress {
+        /**
+         * The properties of the plan to create for this invoice.
+         */
+        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;
+        }
+        namespace Plan {
+            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;
+            }
+        }
     }
 }
 export interface InvoiceListParams extends CursorPageParams {
@@ -253,13 +636,13 @@ 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.
      */
@@ -272,28 +655,17 @@ export interface InvoiceListParams extends CursorPageParams {
      * Which columns can be used to sort.
      */
     order?: 'id' | 'created_at' | 'due_date' | null;
-}
-export declare namespace InvoiceListParams {
     /**
-     * The filters to apply to the invoices
+     * Return only invoices created for these specific product ids
      */
-    interface Filters {
-        /**
-         * The access pass IDs to filter the invoices by
-         */
-        access_pass_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;
-    }
+    product_ids?: Array<string> | 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, };
+    export { type InvoiceVoidResponse as InvoiceVoidResponse, type InvoiceCreateParams as InvoiceCreateParams, type InvoiceListParams as InvoiceListParams, };
 }
 export { type InvoiceListItemsCursorPage };
 //# sourceMappingURL=invoices.d.ts.map