stripe 18.6.0-alpha.2 → 19.0.0

package/types/Tax/Associations.d.ts

@@ -1,82 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Tax {
-      /**
-       * A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input
-       */
-      interface Association {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'tax.association';
-
-        /**
-         * The [Tax Calculation](https://stripe.com/docs/api/tax/calculations/object) that was included in PaymentIntent.
-         */
-        calculation: string;
-
-        /**
-         * The [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) that this Tax Association is tracking.
-         */
-        payment_intent: string;
-
-        /**
-         * Information about the tax transactions linked to this payment intent
-         */
-        tax_transaction_attempts?: Array<
-          Association.TaxTransactionAttempt
-        > | null;
-      }
-
-      namespace Association {
-        interface TaxTransactionAttempt {
-          committed?: TaxTransactionAttempt.Committed;
-
-          errored?: TaxTransactionAttempt.Errored;
-
-          /**
-           * The source of the tax transaction attempt. This is either a refund or a payment intent.
-           */
-          source: string;
-
-          /**
-           * The status of the transaction attempt. This can be `errored` or `committed`.
-           */
-          status: string;
-        }
-
-        namespace TaxTransactionAttempt {
-          interface Committed {
-            /**
-             * The [Tax Transaction](https://stripe.com/docs/api/tax/transaction/object)
-             */
-            transaction: string;
-          }
-
-          interface Errored {
-            /**
-             * Details on why we couldn't commit the tax transaction.
-             */
-            reason: Errored.Reason;
-          }
-
-          namespace Errored {
-            type Reason =
-              | 'another_payment_associated_with_calculation'
-              | 'calculation_expired'
-              | 'currency_mismatch'
-              | 'original_transaction_voided'
-              | 'unique_reference_violation';
-          }
-        }
-      }
-    }
-  }
-}

package/types/Tax/AssociationsResource.d.ts

@@ -1,29 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Tax {
-      interface AssociationFindParams {
-        /**
-         * Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id
-         */
-        payment_intent: string;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class AssociationsResource {
-        /**
-         * Finds a tax association object by PaymentIntent id.
-         */
-        find(
-          params: AssociationFindParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Tax.Association>>;
-      }
-    }
-  }
-}

package/types/Tax/Forms.d.ts

@@ -1,220 +0,0 @@
-// 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';
-
-        au_serr?: Form.AuSerr;
-
-        ca_mrdp?: Form.CaMrdp;
-
-        /**
-         * 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;
-
-        eu_dac7?: Form.EuDac7;
-
-        /**
-         * 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>;
-
-        gb_mrdp?: Form.GbMrdp;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        nz_mrdp?: Form.NzMrdp;
-
-        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 AuSerr {
-          /**
-           * End date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_end_date: string;
-
-          /**
-           * Start date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_start_date: string;
-        }
-
-        interface CaMrdp {
-          /**
-           * End date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_end_date: string;
-
-          /**
-           * Start date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_start_date: string;
-        }
-
-        interface EuDac7 {
-          /**
-           * End date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_end_date: string;
-
-          /**
-           * Start date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_start_date: string;
-        }
-
-        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)).
-             */
-            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. Null for non-U.S. forms.
-             */
-            state: string | null;
-          }
-
-          namespace Jurisdiction {
-            type Level = 'country' | 'state';
-          }
-
-          type Value = 'accepted' | 'filed' | 'rejected';
-        }
-
-        interface GbMrdp {
-          /**
-           * End date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_end_date: string;
-
-          /**
-           * Start date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_start_date: string;
-        }
-
-        interface NzMrdp {
-          /**
-           * End date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_end_date: string;
-
-          /**
-           * Start date of the period represented by the information reported on the tax form.
-           */
-          reporting_period_start_date: string;
-        }
-
-        interface Payee {
-          /**
-           * The ID of the payee's Stripe account.
-           */
-          account: string | Stripe.Account | null;
-
-          /**
-           * The external reference to this payee.
-           */
-          external_reference: string | null;
-
-          /**
-           * Either `account` or `external_reference`.
-           */
-          type: Payee.Type;
-        }
-
-        namespace Payee {
-          type Type = 'account' | 'external_reference';
-        }
-
-        type Type =
-          | 'au_serr'
-          | 'ca_mrdp'
-          | 'eu_dac7'
-          | 'gb_mrdp'
-          | 'nz_mrdp'
-          | '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

@@ -1,107 +0,0 @@
-// 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;
-
-          /**
-           * The external reference to the payee whose forms will be retrieved.
-           */
-          external_reference?: string;
-
-          /**
-           * Specifies the payee type. Either `account` or `external_reference`.
-           */
-          type?: Payee.Type;
-        }
-
-        namespace Payee {
-          type Type = 'account' | 'external_reference';
-        }
-
-        type Type =
-          | 'au_serr'
-          | 'ca_mrdp'
-          | 'eu_dac7'
-          | 'gb_mrdp'
-          | 'nz_mrdp'
-          | '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/OnboardingLinks.d.ts

@@ -1,57 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Terminal {
-      /**
-       * Returns redirect links used for onboarding onto Tap to Pay on iPhone.
-       */
-      interface OnboardingLink {
-        object: 'terminal.onboarding_link';
-
-        /**
-         * Link type options associated with the current onboarding link object.
-         */
-        link_options: OnboardingLink.LinkOptions;
-
-        /**
-         * The type of link being generated.
-         */
-        link_type: 'apple_terms_and_conditions';
-
-        /**
-         * Stripe account ID to generate the link for.
-         */
-        on_behalf_of: string | null;
-
-        /**
-         * The link passed back to the user for their onboarding.
-         */
-        redirect_url: string;
-      }
-
-      namespace OnboardingLink {
-        interface LinkOptions {
-          /**
-           * The options associated with the Apple Terms and Conditions link type.
-           */
-          apple_terms_and_conditions: LinkOptions.AppleTermsAndConditions | null;
-        }
-
-        namespace LinkOptions {
-          interface AppleTermsAndConditions {
-            /**
-             * Whether the link should also support users relinking their Apple account.
-             */
-            allow_relinking: boolean | null;
-
-            /**
-             * The business name of the merchant accepting Apple's Terms and Conditions.
-             */
-            merchant_display_name: string;
-          }
-        }
-      }
-    }
-  }
-}

package/types/Terminal/OnboardingLinksResource.d.ts

@@ -1,62 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Terminal {
-      interface OnboardingLinkCreateParams {
-        /**
-         * Specific fields needed to generate the desired link type.
-         */
-        link_options: OnboardingLinkCreateParams.LinkOptions;
-
-        /**
-         * The type of link being generated.
-         */
-        link_type: 'apple_terms_and_conditions';
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * Stripe account ID to generate the link for.
-         */
-        on_behalf_of?: string;
-      }
-
-      namespace OnboardingLinkCreateParams {
-        interface LinkOptions {
-          /**
-           * The options associated with the Apple Terms and Conditions link type.
-           */
-          apple_terms_and_conditions?: LinkOptions.AppleTermsAndConditions;
-        }
-
-        namespace LinkOptions {
-          interface AppleTermsAndConditions {
-            /**
-             * Whether the link should also support users relinking their Apple account.
-             */
-            allow_relinking?: boolean;
-
-            /**
-             * The business name of the merchant accepting Apple's Terms and Conditions.
-             */
-            merchant_display_name: string;
-          }
-        }
-      }
-
-      class OnboardingLinksResource {
-        /**
-         * Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
-         */
-        create(
-          params: OnboardingLinkCreateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Terminal.OnboardingLink>>;
-      }
-    }
-  }
-}

package/types/Terminal/ReaderCollectedData.d.ts

@@ -1,51 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Terminal {
-      /**
-       * Returns data collected by Terminal readers. This data is only stored for 24 hours.
-       */
-      interface ReaderCollectedData {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'terminal.reader_collected_data';
-
-        /**
-         * Time at which the object was created. Measured in seconds since the Unix epoch.
-         */
-        created: number;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * The magstripe data collected by the reader.
-         */
-        magstripe: ReaderCollectedData.Magstripe | null;
-
-        /**
-         * The type of data collected by the reader.
-         */
-        type: 'magstripe';
-      }
-
-      namespace ReaderCollectedData {
-        interface Magstripe {
-          /**
-           * The raw magstripe data collected by the reader.
-           */
-          data: string | null;
-        }
-      }
-    }
-  }
-}

package/types/Terminal/ReaderCollectedDataResource.d.ts

@@ -1,29 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Terminal {
-      interface ReaderCollectedDataRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class ReaderCollectedDataResource {
-        /**
-         * Retrieve data collected using Reader hardware.
-         */
-        retrieve(
-          id: string,
-          params?: ReaderCollectedDataRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Terminal.ReaderCollectedData>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Terminal.ReaderCollectedData>>;
-      }
-    }
-  }
-}

package/types/ThinEvent.d.ts

@@ -1,36 +0,0 @@
-// This is a manually maintained file
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Event {
-      /**
-       * Object containing the reference to API resource relevant to the event.
-       */
-      interface RelatedObject {
-        /**
-         * Unique identifier for the object relevant to the event.
-         */
-        id: string;
-
-        /**
-         * Type of the object relevant to the event.
-         */
-        type: string;
-
-        /**
-         * URL to retrieve the resource.
-         */
-        url: string;
-      }
-    }
-    /**
-     * The Event object as recieved from StripeClient.parseThinEvent.
-     */
-    interface ThinEvent extends V2.EventBase {
-      /**
-       * Object containing the reference to API resource relevant to the event.
-       */
-      related_object: Event.RelatedObject | null;
-    }
-  }
-}