stripe 16.2.0 → 16.4.0-beta.1

package/types/Tax/Forms.d.ts

@@ -0,0 +1,133 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Tax {
+      /**
+       * Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
+       *
+       * Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
+       */
+      interface Form {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'tax.form';
+
+        /**
+         * The form that corrects this form, if any.
+         */
+        corrected_by: string | Stripe.Tax.Form | null;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction's tax authority.
+         */
+        filing_statuses: Array<Form.FilingStatus>;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        payee: Form.Payee;
+
+        /**
+         * The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
+         */
+        type: Form.Type;
+
+        us_1099_k?: Form.Us1099K;
+
+        us_1099_misc?: Form.Us1099Misc;
+
+        us_1099_nec?: Form.Us1099Nec;
+      }
+
+      namespace Form {
+        interface FilingStatus {
+          /**
+           * Time when the filing status was updated.
+           */
+          effective_at: number;
+
+          jurisdiction: FilingStatus.Jurisdiction;
+
+          /**
+           * The current status of the filed form.
+           */
+          value: FilingStatus.Value;
+        }
+
+        namespace FilingStatus {
+          interface Jurisdiction {
+            /**
+             * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Always `US`.
+             */
+            country: string;
+
+            /**
+             * Indicates the level of the jurisdiction where the form was filed.
+             */
+            level: Jurisdiction.Level;
+
+            /**
+             * [ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, "NY" for New York, United States.
+             */
+            state: string | null;
+          }
+
+          namespace Jurisdiction {
+            type Level = 'country' | 'state';
+          }
+
+          type Value = 'accepted' | 'filed' | 'rejected';
+        }
+
+        interface Payee {
+          /**
+           * The ID of the payee's Stripe account.
+           */
+          account: string | Stripe.Account | null;
+
+          /**
+           * Always `account`.
+           */
+          type: 'account';
+        }
+
+        type Type = 'us_1099_k' | 'us_1099_misc' | 'us_1099_nec';
+
+        interface Us1099K {
+          /**
+           * Year represented by the information reported on the tax form.
+           */
+          reporting_year: number;
+        }
+
+        interface Us1099Misc {
+          /**
+           * Year represented by the information reported on the tax form.
+           */
+          reporting_year: number;
+        }
+
+        interface Us1099Nec {
+          /**
+           * Year represented by the information reported on the tax form.
+           */
+          reporting_year: number;
+        }
+      }
+    }
+  }
+}

package/types/Tax/FormsResource.d.ts

@@ -0,0 +1,90 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Tax {
+      interface FormRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FormListParams extends PaginationParams {
+        /**
+         * The payee whose volume is represented on the tax form.
+         */
+        payee: FormListParams.Payee;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
+         */
+        type?: FormListParams.Type;
+      }
+
+      namespace FormListParams {
+        interface Payee {
+          /**
+           * The ID of the Stripe account whose forms will be retrieved.
+           */
+          account?: string;
+
+          /**
+           * Specifies the payee type. Always `account`.
+           */
+          type?: 'account';
+        }
+
+        type Type = 'us_1099_k' | 'us_1099_misc' | 'us_1099_nec';
+      }
+
+      interface FormPdfParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class FormsResource {
+        /**
+         * Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
+         */
+        retrieve(
+          id: string,
+          params?: FormRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Form>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Form>>;
+
+        /**
+         * Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+         */
+        list(
+          params: FormListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Tax.Form>;
+
+        /**
+         * Download the PDF for a tax form.
+         */
+        pdf(
+          id: string,
+          params?: FormPdfParams,
+          options?: RequestOptions
+        ): Promise<StripeStreamResponse>;
+        pdf(
+          id: string,
+          options?: RequestOptions
+        ): Promise<StripeStreamResponse>;
+      }
+    }
+  }
+}

package/types/Terminal/Readers.d.ts

@@ -97,6 +97,21 @@ declare module 'stripe' {
 
       namespace Reader {
         interface Action {
+          /**
+           * Represents a reader action to collect customer inputs
+           */
+          collect_inputs?: Action.CollectInputs;
+
+          /**
+           * Represents a reader action to collect a payment method
+           */
+          collect_payment_method?: Action.CollectPaymentMethod;
+
+          /**
+           * Represents a reader action to confirm a payment
+           */
+          confirm_payment_intent?: Action.ConfirmPaymentIntent;
+
           /**
            * Failure code, only set if status is `failed`.
            */
@@ -139,6 +154,262 @@ declare module 'stripe' {
         }
 
         namespace Action {
+          interface CollectInputs {
+            /**
+             * List of inputs to be collected.
+             */
+            inputs: Array<CollectInputs.Input>;
+
+            /**
+             * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+             */
+            metadata: Stripe.Metadata | null;
+          }
+
+          namespace CollectInputs {
+            interface Input {
+              /**
+               * Default text of input being collected.
+               */
+              custom_text: Input.CustomText | null;
+
+              /**
+               * Information about a email being collected using a reader
+               */
+              email?: Input.Email;
+
+              /**
+               * Information about a number being collected using a reader
+               */
+              numeric?: Input.Numeric;
+
+              /**
+               * Information about a phone number being collected using a reader
+               */
+              phone?: Input.Phone;
+
+              /**
+               * Indicate that this input is required, disabling the skip button.
+               */
+              required: boolean | null;
+
+              /**
+               * Information about a selection being collected using a reader
+               */
+              selection?: Input.Selection;
+
+              /**
+               * Information about a signature being collected using a reader
+               */
+              signature?: Input.Signature;
+
+              /**
+               * Indicate that this input was skipped by the user.
+               */
+              skipped?: boolean;
+
+              /**
+               * Information about text being collected using a reader
+               */
+              text?: Input.Text;
+
+              /**
+               * List of toggles being collected. Values are present if collection is complete.
+               */
+              toggles: Array<Input.Toggle> | null;
+
+              /**
+               * Type of input being collected.
+               */
+              type: Input.Type;
+            }
+
+            namespace Input {
+              interface CustomText {
+                /**
+                 * Customize the default description for this input
+                 */
+                description: string | null;
+
+                /**
+                 * Customize the default label for this input's skip button
+                 */
+                skip_button: string | null;
+
+                /**
+                 * Customize the default label for this input's submit button
+                 */
+                submit_button: string | null;
+
+                /**
+                 * Customize the default title for this input
+                 */
+                title: string | null;
+              }
+
+              interface Email {
+                /**
+                 * The collected email address
+                 */
+                value: string | null;
+              }
+
+              interface Numeric {
+                /**
+                 * The collected number
+                 */
+                value: string | null;
+              }
+
+              interface Phone {
+                /**
+                 * The collected phone number
+                 */
+                value: string | null;
+              }
+
+              interface Selection {
+                /**
+                 * List of possible choices to be selected
+                 */
+                choices: Array<Selection.Choice>;
+
+                /**
+                 * The value of the selected choice
+                 */
+                value: string | null;
+              }
+
+              namespace Selection {
+                interface Choice {
+                  /**
+                   * The button style for the choice
+                   */
+                  style: Choice.Style | null;
+
+                  /**
+                   * A value to be selected
+                   */
+                  value: string;
+                }
+
+                namespace Choice {
+                  type Style = 'primary' | 'secondary';
+                }
+              }
+
+              interface Signature {
+                /**
+                 * The File ID of a collected signature image
+                 */
+                value: string | null;
+              }
+
+              interface Text {
+                /**
+                 * The collected text value
+                 */
+                value: string | null;
+              }
+
+              interface Toggle {
+                /**
+                 * The toggle's default value
+                 */
+                default_value: Toggle.DefaultValue | null;
+
+                /**
+                 * The toggle's description text
+                 */
+                description: string | null;
+
+                /**
+                 * The toggle's title text
+                 */
+                title: string | null;
+
+                /**
+                 * The toggle's collected value
+                 */
+                value: Toggle.Value | null;
+              }
+
+              namespace Toggle {
+                type DefaultValue = 'disabled' | 'enabled';
+
+                type Value = 'disabled' | 'enabled';
+              }
+
+              type Type =
+                | 'email'
+                | 'numeric'
+                | 'phone'
+                | 'selection'
+                | 'signature'
+                | 'text';
+            }
+          }
+
+          interface CollectPaymentMethod {
+            /**
+             * Represents a per-transaction override of a reader configuration
+             */
+            collect_config?: CollectPaymentMethod.CollectConfig;
+
+            /**
+             * Most recent PaymentIntent processed by the reader.
+             */
+            payment_intent: string | Stripe.PaymentIntent;
+
+            /**
+             * PaymentMethod objects represent your customer's payment instruments.
+             * You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
+             * Customer objects to store instrument details for future payments.
+             *
+             * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
+             */
+            payment_method?: Stripe.PaymentMethod;
+
+            stripe_account?: string;
+          }
+
+          namespace CollectPaymentMethod {
+            interface CollectConfig {
+              /**
+               * Enable customer initiated cancellation when processing this payment.
+               */
+              enable_customer_cancellation?: boolean;
+
+              /**
+               * Override showing a tipping selection screen on this transaction.
+               */
+              skip_tipping?: boolean;
+
+              /**
+               * Represents a per-transaction tipping configuration
+               */
+              tipping?: CollectConfig.Tipping;
+            }
+
+            namespace CollectConfig {
+              interface Tipping {
+                /**
+                 * Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
+                 */
+                amount_eligible?: number;
+              }
+            }
+          }
+
+          interface ConfirmPaymentIntent {
+            /**
+             * Most recent PaymentIntent processed by the reader.
+             */
+            payment_intent: string | Stripe.PaymentIntent;
+
+            stripe_account?: string;
+          }
+
           interface ProcessPaymentIntent {
             /**
              * Most recent PaymentIntent processed by the reader.
@@ -149,6 +420,8 @@ declare module 'stripe' {
              * Represents a per-transaction override of a reader configuration
              */
             process_config?: ProcessPaymentIntent.ProcessConfig;
+
+            stripe_account?: string;
           }
 
           namespace ProcessPaymentIntent {
@@ -250,6 +523,8 @@ declare module 'stripe' {
              * Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.
              */
             reverse_transfer?: boolean;
+
+            stripe_account?: string;
           }
 
           namespace RefundPayment {
@@ -321,6 +596,9 @@ declare module 'stripe' {
           type Status = 'failed' | 'in_progress' | 'succeeded';
 
           type Type =
+            | 'collect_inputs'
+            | 'collect_payment_method'
+            | 'confirm_payment_intent'
             | 'process_payment_intent'
             | 'process_setup_intent'
             | 'refund_payment'