stripe 19.3.0-beta.1 → 19.3.1

package/types/V2/Billing/Profiles.d.ts

@@ -1,70 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        /**
-         * The Profile object.
-         */
-        interface Profile {
-          /**
-           * The ID of the billing profile object.
-           */
-          id: string;
-
-          /**
-           * String representing the object's type. Objects of the same type share the same value of the object field.
-           */
-          object: 'v2.billing.profile';
-
-          /**
-           * Timestamp of when the object was created.
-           */
-          created: string;
-
-          /**
-           * The ID of the customer object.
-           */
-          customer?: string;
-
-          /**
-           * The ID of the payment method object.
-           */
-          default_payment_method?: string;
-
-          /**
-           * A customer-facing name for the billing profile.
-           * Maximum length of 250 characters.
-           */
-          display_name?: string;
-
-          /**
-           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-           */
-          livemode: boolean;
-
-          /**
-           * An internal key you can use to search for a particular billing profile.
-           * Maximum length of 200 characters.
-           */
-          lookup_key?: string;
-
-          /**
-           * Set of key-value pairs 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;
-
-          /**
-           * The current status of the billing profile.
-           */
-          status: Profile.Status;
-        }
-
-        namespace Profile {
-          type Status = 'active' | 'inactive';
-        }
-      }
-    }
-  }
-}

package/types/V2/Billing/ProfilesResource.d.ts

@@ -1,150 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Billing {
-        interface ProfileCreateParams {
-          /**
-           * The ID of the customer object.
-           */
-          customer: string;
-
-          /**
-           * The ID of the payment method object.
-           */
-          default_payment_method?: string;
-
-          /**
-           * A customer-facing name for the billing profile.
-           * Maximum length of 250 characters.
-           */
-          display_name?: string;
-
-          /**
-           * An internal key you can use to search for a particular billing profile. It must be unique among billing profiles for a given customer.
-           * Maximum length of 200 characters.
-           */
-          lookup_key?: string;
-
-          /**
-           * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-           */
-          metadata?: Stripe.MetadataParam;
-        }
-      }
-
-      namespace Billing {
-        interface ProfileRetrieveParams {}
-      }
-
-      namespace Billing {
-        interface ProfileUpdateParams {
-          /**
-           * The ID of the payment method object.
-           */
-          default_payment_method?: string;
-
-          /**
-           * A customer-facing name for the billing profile.
-           * Maximum length of 250 characters.
-           * To remove the display_name from the object, set it to null in the request.
-           */
-          display_name?: string;
-
-          /**
-           * An internal key you can use to search for a particular billing profile. It must be unique among billing profiles for a given customer.
-           * Maximum length of 200 characters.
-           * To remove the lookup_key from the object, set it to null in the request.
-           */
-          lookup_key?: string;
-
-          /**
-           * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-           */
-          metadata?: Stripe.MetadataParam;
-        }
-      }
-
-      namespace Billing {
-        interface ProfileListParams {
-          /**
-           * Filter billing profiles by lookup keys. Mutually exclusive
-           * with `customer` and `default_payment_method`.
-           * You can specify up to 10 lookup_keys.
-           */
-          lookup_keys: Array<string>;
-
-          /**
-           * Filter billing profiles by a customer. Mutually exclusive
-           * with `lookup_keys` and `default_payment_method`.
-           */
-          customer?: string;
-
-          /**
-           * Filter billing profiles by a default payment method. Mutually exclusive
-           * with `customer` and `lookup_keys`.
-           */
-          default_payment_method?: string;
-
-          /**
-           * Optionally set the maximum number of results per page. Defaults to 10.
-           */
-          limit?: number;
-
-          /**
-           * Filter billing profiles by status. Can be combined
-           * with all other filters. If not provided, all billing profiles will be returned.
-           */
-          status?: ProfileListParams.Status;
-        }
-
-        namespace ProfileListParams {
-          type Status = 'active' | 'inactive';
-        }
-      }
-
-      namespace Billing {
-        class ProfilesResource {
-          /**
-           * Create a BillingProfile object.
-           */
-          create(
-            params: ProfileCreateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.Profile>>;
-
-          /**
-           * Retrieve a BillingProfile object.
-           */
-          retrieve(
-            id: string,
-            params?: ProfileRetrieveParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.Profile>>;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.Profile>>;
-
-          /**
-           * Update a BillingProfile object.
-           */
-          update(
-            id: string,
-            params?: ProfileUpdateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Billing.Profile>>;
-
-          /**
-           * List Billing Profiles.
-           */
-          list(
-            params: ProfileListParams,
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Billing.Profile>;
-        }
-      }
-    }
-  }
-}

package/types/V2/Core/AccountLinks.d.ts

@@ -1,168 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Core {
-        /**
-         * AccountLinks are the means by which a Merchant grants an Account permission to access Stripe-hosted applications, such as Recipient Onboarding. This API is only available for users enrolled in the public preview for Accounts v2.
-         */
-        interface AccountLink {
-          /**
-           * String representing the object's type. Objects of the same type share the same value of the object field.
-           */
-          object: 'v2.core.account_link';
-
-          /**
-           * The ID of the Account the link was created for.
-           */
-          account: string;
-
-          /**
-           * The timestamp at which this AccountLink was created.
-           */
-          created: string;
-
-          /**
-           * The timestamp at which this AccountLink will expire.
-           */
-          expires_at: string;
-
-          /**
-           * 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 URL for the AccountLink.
-           */
-          url: string;
-
-          /**
-           * The use case of AccountLink the user is requesting.
-           */
-          use_case: AccountLink.UseCase;
-        }
-
-        namespace AccountLink {
-          interface UseCase {
-            /**
-             * Open Enum. The type of AccountLink the user is requesting.
-             */
-            type: UseCase.Type;
-
-            /**
-             * Indicates that the AccountLink provided should onboard an account.
-             */
-            account_onboarding?: UseCase.AccountOnboarding;
-
-            /**
-             * Indicates that the AccountLink provided should update a previously onboarded account.
-             */
-            account_update?: UseCase.AccountUpdate;
-          }
-
-          namespace UseCase {
-            interface AccountOnboarding {
-              /**
-               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
-               */
-              collection_options?: AccountOnboarding.CollectionOptions;
-
-              /**
-               * Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
-               */
-              configurations: Array<AccountOnboarding.Configuration>;
-
-              /**
-               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
-               */
-              refresh_url: string;
-
-              /**
-               * The URL that the user will be redirected to upon completing the linked flow.
-               */
-              return_url?: string;
-            }
-
-            namespace AccountOnboarding {
-              interface CollectionOptions {
-                /**
-                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
-                 */
-                fields?: CollectionOptions.Fields;
-
-                /**
-                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
-                 */
-                future_requirements?: CollectionOptions.FutureRequirements;
-              }
-
-              namespace CollectionOptions {
-                type Fields = 'currently_due' | 'eventually_due';
-
-                type FutureRequirements = 'include' | 'omit';
-              }
-
-              type Configuration =
-                | 'customer'
-                | 'merchant'
-                | 'recipient'
-                | 'storer';
-            }
-
-            interface AccountUpdate {
-              /**
-               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
-               */
-              collection_options?: AccountUpdate.CollectionOptions;
-
-              /**
-               * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
-               */
-              configurations: Array<AccountUpdate.Configuration>;
-
-              /**
-               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
-               */
-              refresh_url: string;
-
-              /**
-               * The URL that the user will be redirected to upon completing the linked flow.
-               */
-              return_url?: string;
-            }
-
-            namespace AccountUpdate {
-              interface CollectionOptions {
-                /**
-                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
-                 */
-                fields?: CollectionOptions.Fields;
-
-                /**
-                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
-                 */
-                future_requirements?: CollectionOptions.FutureRequirements;
-              }
-
-              namespace CollectionOptions {
-                type Fields = 'currently_due' | 'eventually_due';
-
-                type FutureRequirements = 'include' | 'omit';
-              }
-
-              type Configuration =
-                | 'customer'
-                | 'merchant'
-                | 'recipient'
-                | 'storer';
-            }
-
-            type Type = 'account_onboarding' | 'account_update';
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/Core/AccountLinksResource.d.ts

@@ -1,152 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Core {
-        interface AccountLinkCreateParams {
-          /**
-           * The ID of the Account to create link for.
-           */
-          account: string;
-
-          /**
-           * The use case of the AccountLink.
-           */
-          use_case: AccountLinkCreateParams.UseCase;
-        }
-
-        namespace AccountLinkCreateParams {
-          interface UseCase {
-            /**
-             * Open Enum. The type of AccountLink the user is requesting.
-             */
-            type: UseCase.Type;
-
-            /**
-             * Indicates that the AccountLink provided should onboard an account.
-             */
-            account_onboarding?: UseCase.AccountOnboarding;
-
-            /**
-             * Indicates that the AccountLink provided should update a previously onboarded account.
-             */
-            account_update?: UseCase.AccountUpdate;
-          }
-
-          namespace UseCase {
-            interface AccountOnboarding {
-              /**
-               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
-               */
-              collection_options?: AccountOnboarding.CollectionOptions;
-
-              /**
-               * Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
-               */
-              configurations: Array<AccountOnboarding.Configuration>;
-
-              /**
-               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
-               */
-              refresh_url: string;
-
-              /**
-               * The URL that the user will be redirected to upon completing the linked flow.
-               */
-              return_url?: string;
-            }
-
-            namespace AccountOnboarding {
-              interface CollectionOptions {
-                /**
-                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
-                 */
-                fields?: CollectionOptions.Fields;
-
-                /**
-                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
-                 */
-                future_requirements?: CollectionOptions.FutureRequirements;
-              }
-
-              namespace CollectionOptions {
-                type Fields = 'currently_due' | 'eventually_due';
-
-                type FutureRequirements = 'include' | 'omit';
-              }
-
-              type Configuration =
-                | 'customer'
-                | 'merchant'
-                | 'recipient'
-                | 'storer';
-            }
-
-            interface AccountUpdate {
-              /**
-               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
-               */
-              collection_options?: AccountUpdate.CollectionOptions;
-
-              /**
-               * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
-               */
-              configurations: Array<AccountUpdate.Configuration>;
-
-              /**
-               * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
-               */
-              refresh_url: string;
-
-              /**
-               * The URL that the user will be redirected to upon completing the linked flow.
-               */
-              return_url?: string;
-            }
-
-            namespace AccountUpdate {
-              interface CollectionOptions {
-                /**
-                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
-                 */
-                fields?: CollectionOptions.Fields;
-
-                /**
-                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
-                 */
-                future_requirements?: CollectionOptions.FutureRequirements;
-              }
-
-              namespace CollectionOptions {
-                type Fields = 'currently_due' | 'eventually_due';
-
-                type FutureRequirements = 'include' | 'omit';
-              }
-
-              type Configuration =
-                | 'customer'
-                | 'merchant'
-                | 'recipient'
-                | 'storer';
-            }
-
-            type Type = 'account_onboarding' | 'account_update';
-          }
-        }
-      }
-
-      namespace Core {
-        class AccountLinksResource {
-          /**
-           * Creates an AccountLink object that includes a single-use Stripe URL that the merchant can redirect their user to in order to take them to a Stripe-hosted application such as Recipient Onboarding.
-           */
-          create(
-            params: AccountLinkCreateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Core.AccountLink>>;
-        }
-      }
-    }
-  }
-}