@depup/stripe 21.0.0-depup.0

package/types/Capabilities.d.ts

@@ -0,0 +1,422 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * This is an object representing a capability for a Stripe account.
+     *
+     * Related guide: [Account capabilities](https://docs.stripe.com/connect/account-capabilities)
+     */
+    interface Capability {
+      /**
+       * The identifier for the capability.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'capability';
+
+      /**
+       * The account for which the capability enables functionality.
+       */
+      account: string | Stripe.Account;
+
+      future_requirements?: Capability.FutureRequirements;
+
+      /**
+       * Whether the capability has been requested.
+       */
+      requested: boolean;
+
+      /**
+       * Time at which the capability was requested. Measured in seconds since the Unix epoch.
+       */
+      requested_at: number | null;
+
+      requirements?: Capability.Requirements;
+
+      /**
+       * The status of the capability.
+       */
+      status: Capability.Status;
+    }
+
+    namespace Capability {
+      interface FutureRequirements {
+        /**
+         * Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.
+         */
+        alternatives: Array<FutureRequirements.Alternative> | null;
+
+        /**
+         * Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
+         */
+        current_deadline: number | null;
+
+        /**
+         * Fields that need to be resolved to keep the capability enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
+         */
+        currently_due: Array<string>;
+
+        /**
+         * This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
+         */
+        disabled_reason: FutureRequirements.DisabledReason | null;
+
+        /**
+         * Details about validation and verification failures for `due` requirements that must be resolved.
+         */
+        errors: Array<FutureRequirements.Error>;
+
+        /**
+         * Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
+         */
+        eventually_due: Array<string>;
+
+        /**
+         * Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`.
+         */
+        past_due: Array<string>;
+
+        /**
+         * Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
+         */
+        pending_verification: Array<string>;
+      }
+
+      namespace FutureRequirements {
+        interface Alternative {
+          /**
+           * Fields that can be provided to resolve all fields in `original_fields_due`.
+           */
+          alternative_fields_due: Array<string>;
+
+          /**
+           * Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
+           */
+          original_fields_due: Array<string>;
+        }
+
+        type DisabledReason =
+          | 'other'
+          | 'paused.inactivity'
+          | 'pending.onboarding'
+          | 'pending.review'
+          | 'platform_disabled'
+          | 'platform_paused'
+          | 'rejected.inactivity'
+          | 'rejected.other'
+          | 'rejected.unsupported_business'
+          | 'requirements.fields_needed';
+
+        interface Error {
+          /**
+           * The code for the type of error.
+           */
+          code: Error.Code;
+
+          /**
+           * An informative message that indicates the error type and provides additional details about the error.
+           */
+          reason: string;
+
+          /**
+           * The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+           */
+          requirement: string;
+        }
+
+        namespace Error {
+          type Code =
+            | 'external_request'
+            | 'information_missing'
+            | 'invalid_address_city_state_postal_code'
+            | 'invalid_address_highway_contract_box'
+            | 'invalid_address_private_mailbox'
+            | 'invalid_business_profile_name'
+            | 'invalid_business_profile_name_denylisted'
+            | 'invalid_company_name_denylisted'
+            | 'invalid_dob_age_over_maximum'
+            | 'invalid_dob_age_under_18'
+            | 'invalid_dob_age_under_minimum'
+            | 'invalid_product_description_length'
+            | 'invalid_product_description_url_match'
+            | 'invalid_representative_country'
+            | 'invalid_signator'
+            | 'invalid_statement_descriptor_business_mismatch'
+            | 'invalid_statement_descriptor_denylisted'
+            | 'invalid_statement_descriptor_length'
+            | 'invalid_statement_descriptor_prefix_denylisted'
+            | 'invalid_statement_descriptor_prefix_mismatch'
+            | 'invalid_street_address'
+            | 'invalid_tax_id'
+            | 'invalid_tax_id_format'
+            | 'invalid_tos_acceptance'
+            | 'invalid_url_denylisted'
+            | 'invalid_url_format'
+            | 'invalid_url_length'
+            | 'invalid_url_web_presence_detected'
+            | 'invalid_url_website_business_information_mismatch'
+            | 'invalid_url_website_empty'
+            | 'invalid_url_website_inaccessible'
+            | 'invalid_url_website_inaccessible_geoblocked'
+            | 'invalid_url_website_inaccessible_password_protected'
+            | 'invalid_url_website_incomplete'
+            | 'invalid_url_website_incomplete_cancellation_policy'
+            | 'invalid_url_website_incomplete_customer_service_details'
+            | 'invalid_url_website_incomplete_legal_restrictions'
+            | 'invalid_url_website_incomplete_refund_policy'
+            | 'invalid_url_website_incomplete_return_policy'
+            | 'invalid_url_website_incomplete_terms_and_conditions'
+            | 'invalid_url_website_incomplete_under_construction'
+            | 'invalid_url_website_other'
+            | 'invalid_value_other'
+            | 'unsupported_business_type'
+            | 'verification_directors_mismatch'
+            | 'verification_document_address_mismatch'
+            | 'verification_document_address_missing'
+            | 'verification_document_corrupt'
+            | 'verification_document_country_not_supported'
+            | 'verification_document_directors_mismatch'
+            | 'verification_document_dob_mismatch'
+            | 'verification_document_duplicate_type'
+            | 'verification_document_expired'
+            | 'verification_document_failed_copy'
+            | 'verification_document_failed_greyscale'
+            | 'verification_document_failed_other'
+            | 'verification_document_failed_test_mode'
+            | 'verification_document_fraudulent'
+            | 'verification_document_id_number_mismatch'
+            | 'verification_document_id_number_missing'
+            | 'verification_document_incomplete'
+            | 'verification_document_invalid'
+            | 'verification_document_issue_or_expiry_date_missing'
+            | 'verification_document_manipulated'
+            | 'verification_document_missing_back'
+            | 'verification_document_missing_front'
+            | 'verification_document_name_mismatch'
+            | 'verification_document_name_missing'
+            | 'verification_document_nationality_mismatch'
+            | 'verification_document_not_readable'
+            | 'verification_document_not_signed'
+            | 'verification_document_not_uploaded'
+            | 'verification_document_photo_mismatch'
+            | 'verification_document_too_large'
+            | 'verification_document_type_not_supported'
+            | 'verification_extraneous_directors'
+            | 'verification_failed_address_match'
+            | 'verification_failed_authorizer_authority'
+            | 'verification_failed_business_iec_number'
+            | 'verification_failed_document_match'
+            | 'verification_failed_id_number_match'
+            | 'verification_failed_keyed_identity'
+            | 'verification_failed_keyed_match'
+            | 'verification_failed_name_match'
+            | 'verification_failed_other'
+            | 'verification_failed_representative_authority'
+            | 'verification_failed_residential_address'
+            | 'verification_failed_tax_id_match'
+            | 'verification_failed_tax_id_not_issued'
+            | 'verification_legal_entity_structure_mismatch'
+            | 'verification_missing_directors'
+            | 'verification_missing_executives'
+            | 'verification_missing_owners'
+            | 'verification_rejected_ownership_exemption_reason'
+            | 'verification_requires_additional_memorandum_of_associations'
+            | 'verification_requires_additional_proof_of_registration'
+            | 'verification_supportability';
+        }
+      }
+
+      interface Requirements {
+        /**
+         * Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.
+         */
+        alternatives: Array<Requirements.Alternative> | null;
+
+        /**
+         * The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.
+         */
+        current_deadline: number | null;
+
+        /**
+         * Fields that need to be resolved to keep the capability enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled.
+         */
+        currently_due: Array<string>;
+
+        /**
+         * Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).
+         */
+        disabled_reason: Requirements.DisabledReason | null;
+
+        /**
+         * Details about validation and verification failures for `due` requirements that must be resolved.
+         */
+        errors: Array<Requirements.Error>;
+
+        /**
+         * Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
+         */
+        eventually_due: Array<string>;
+
+        /**
+         * Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account.
+         */
+        past_due: Array<string>;
+
+        /**
+         * Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
+         */
+        pending_verification: Array<string>;
+      }
+
+      namespace Requirements {
+        interface Alternative {
+          /**
+           * Fields that can be provided to resolve all fields in `original_fields_due`.
+           */
+          alternative_fields_due: Array<string>;
+
+          /**
+           * Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
+           */
+          original_fields_due: Array<string>;
+        }
+
+        type DisabledReason =
+          | 'other'
+          | 'paused.inactivity'
+          | 'pending.onboarding'
+          | 'pending.review'
+          | 'platform_disabled'
+          | 'platform_paused'
+          | 'rejected.inactivity'
+          | 'rejected.other'
+          | 'rejected.unsupported_business'
+          | 'requirements.fields_needed';
+
+        interface Error {
+          /**
+           * The code for the type of error.
+           */
+          code: Error.Code;
+
+          /**
+           * An informative message that indicates the error type and provides additional details about the error.
+           */
+          reason: string;
+
+          /**
+           * The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+           */
+          requirement: string;
+        }
+
+        namespace Error {
+          type Code =
+            | 'external_request'
+            | 'information_missing'
+            | 'invalid_address_city_state_postal_code'
+            | 'invalid_address_highway_contract_box'
+            | 'invalid_address_private_mailbox'
+            | 'invalid_business_profile_name'
+            | 'invalid_business_profile_name_denylisted'
+            | 'invalid_company_name_denylisted'
+            | 'invalid_dob_age_over_maximum'
+            | 'invalid_dob_age_under_18'
+            | 'invalid_dob_age_under_minimum'
+            | 'invalid_product_description_length'
+            | 'invalid_product_description_url_match'
+            | 'invalid_representative_country'
+            | 'invalid_signator'
+            | 'invalid_statement_descriptor_business_mismatch'
+            | 'invalid_statement_descriptor_denylisted'
+            | 'invalid_statement_descriptor_length'
+            | 'invalid_statement_descriptor_prefix_denylisted'
+            | 'invalid_statement_descriptor_prefix_mismatch'
+            | 'invalid_street_address'
+            | 'invalid_tax_id'
+            | 'invalid_tax_id_format'
+            | 'invalid_tos_acceptance'
+            | 'invalid_url_denylisted'
+            | 'invalid_url_format'
+            | 'invalid_url_length'
+            | 'invalid_url_web_presence_detected'
+            | 'invalid_url_website_business_information_mismatch'
+            | 'invalid_url_website_empty'
+            | 'invalid_url_website_inaccessible'
+            | 'invalid_url_website_inaccessible_geoblocked'
+            | 'invalid_url_website_inaccessible_password_protected'
+            | 'invalid_url_website_incomplete'
+            | 'invalid_url_website_incomplete_cancellation_policy'
+            | 'invalid_url_website_incomplete_customer_service_details'
+            | 'invalid_url_website_incomplete_legal_restrictions'
+            | 'invalid_url_website_incomplete_refund_policy'
+            | 'invalid_url_website_incomplete_return_policy'
+            | 'invalid_url_website_incomplete_terms_and_conditions'
+            | 'invalid_url_website_incomplete_under_construction'
+            | 'invalid_url_website_other'
+            | 'invalid_value_other'
+            | 'unsupported_business_type'
+            | 'verification_directors_mismatch'
+            | 'verification_document_address_mismatch'
+            | 'verification_document_address_missing'
+            | 'verification_document_corrupt'
+            | 'verification_document_country_not_supported'
+            | 'verification_document_directors_mismatch'
+            | 'verification_document_dob_mismatch'
+            | 'verification_document_duplicate_type'
+            | 'verification_document_expired'
+            | 'verification_document_failed_copy'
+            | 'verification_document_failed_greyscale'
+            | 'verification_document_failed_other'
+            | 'verification_document_failed_test_mode'
+            | 'verification_document_fraudulent'
+            | 'verification_document_id_number_mismatch'
+            | 'verification_document_id_number_missing'
+            | 'verification_document_incomplete'
+            | 'verification_document_invalid'
+            | 'verification_document_issue_or_expiry_date_missing'
+            | 'verification_document_manipulated'
+            | 'verification_document_missing_back'
+            | 'verification_document_missing_front'
+            | 'verification_document_name_mismatch'
+            | 'verification_document_name_missing'
+            | 'verification_document_nationality_mismatch'
+            | 'verification_document_not_readable'
+            | 'verification_document_not_signed'
+            | 'verification_document_not_uploaded'
+            | 'verification_document_photo_mismatch'
+            | 'verification_document_too_large'
+            | 'verification_document_type_not_supported'
+            | 'verification_extraneous_directors'
+            | 'verification_failed_address_match'
+            | 'verification_failed_authorizer_authority'
+            | 'verification_failed_business_iec_number'
+            | 'verification_failed_document_match'
+            | 'verification_failed_id_number_match'
+            | 'verification_failed_keyed_identity'
+            | 'verification_failed_keyed_match'
+            | 'verification_failed_name_match'
+            | 'verification_failed_other'
+            | 'verification_failed_representative_authority'
+            | 'verification_failed_residential_address'
+            | 'verification_failed_tax_id_match'
+            | 'verification_failed_tax_id_not_issued'
+            | 'verification_legal_entity_structure_mismatch'
+            | 'verification_missing_directors'
+            | 'verification_missing_executives'
+            | 'verification_missing_owners'
+            | 'verification_rejected_ownership_exemption_reason'
+            | 'verification_requires_additional_memorandum_of_associations'
+            | 'verification_requires_additional_proof_of_registration'
+            | 'verification_supportability';
+        }
+      }
+
+      type Status = 'active' | 'inactive' | 'pending' | 'unrequested';
+    }
+  }
+}

package/types/Cards.d.ts

@@ -0,0 +1,225 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * You can store multiple cards on a customer in order to charge the customer
+     * later. You can also store multiple debit cards on a recipient in order to
+     * transfer to those cards later.
+     *
+     * Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards)
+     */
+    interface Card {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'card';
+
+      account?: string | Stripe.Account | null;
+
+      /**
+       * City/District/Suburb/Town/Village.
+       */
+      address_city: string | null;
+
+      /**
+       * Billing address country, if provided when creating card.
+       */
+      address_country: string | null;
+
+      /**
+       * Address line 1 (Street address/PO Box/Company name).
+       */
+      address_line1: string | null;
+
+      /**
+       * If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+       */
+      address_line1_check: string | null;
+
+      /**
+       * Address line 2 (Apartment/Suite/Unit/Building).
+       */
+      address_line2: string | null;
+
+      /**
+       * State/County/Province/Region.
+       */
+      address_state: string | null;
+
+      /**
+       * ZIP or postal code.
+       */
+      address_zip: string | null;
+
+      /**
+       * If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+       */
+      address_zip_check: string | null;
+
+      /**
+       * This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
+       */
+      allow_redisplay?: Card.AllowRedisplay | null;
+
+      /**
+       * A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
+       */
+      available_payout_methods?: Array<Card.AvailablePayoutMethod> | null;
+
+      /**
+       * Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
+       */
+      brand: string;
+
+      /**
+       * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
+       */
+      country: string | null;
+
+      /**
+       * Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](https://docs.stripe.com/api/external_account_cards/object) where [controller.is_controller](https://docs.stripe.com/api/accounts/object#account_object-controller-is_controller) is `true`.
+       */
+      currency?: string | null;
+
+      /**
+       * The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
+       */
+      customer?: string | Stripe.Customer | Stripe.DeletedCustomer | null;
+
+      /**
+       * If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).
+       */
+      cvc_check: string | null;
+
+      /**
+       * Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+       */
+      default_for_currency?: boolean | null;
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted?: void;
+
+      /**
+       * A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
+       */
+      description?: string;
+
+      /**
+       * (For tokenized numbers only.) The last four digits of the device account number.
+       */
+      dynamic_last4: string | null;
+
+      /**
+       * Two-digit number representing the card's expiration month.
+       */
+      exp_month: number;
+
+      /**
+       * Four-digit number representing the card's expiration year.
+       */
+      exp_year: number;
+
+      /**
+       * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
+       *
+       * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
+       */
+      fingerprint?: string | null;
+
+      /**
+       * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
+       */
+      funding: string;
+
+      /**
+       * Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
+       */
+      iin?: string;
+
+      /**
+       * The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
+       */
+      issuer?: string;
+
+      /**
+       * The last four digits of the card.
+       */
+      last4: string;
+
+      /**
+       * Set of [key-value pairs](https://docs.stripe.com/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;
+
+      /**
+       * Cardholder name.
+       */
+      name: string | null;
+
+      networks?: Card.Networks;
+
+      /**
+       * Status of a card based on the card issuer.
+       */
+      regulated_status: Card.RegulatedStatus | null;
+
+      /**
+       * For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.
+       */
+      status?: string | null;
+
+      /**
+       * If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.
+       */
+      tokenization_method: string | null;
+    }
+
+    namespace Card {
+      type AllowRedisplay = 'always' | 'limited' | 'unspecified';
+
+      type AvailablePayoutMethod = 'instant' | 'standard';
+
+      interface Networks {
+        /**
+         * The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
+         */
+        preferred: string | null;
+      }
+
+      type RegulatedStatus = 'regulated' | 'unregulated';
+    }
+
+    /**
+     * The DeletedCard object.
+     */
+    interface DeletedCard {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'card';
+
+      /**
+       * Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
+       */
+      currency?: string | null;
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted: true;
+    }
+  }
+}