stripe 18.6.0-alpha.2 → 19.0.0

package/types/V2/Core/Vault/GbBankAccounts.d.ts

@@ -1,160 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Core {
-        namespace Vault {
-          /**
-           * Use the GBBankAccounts API to create and manage GB bank account objects
-           */
-          interface GbBankAccount {
-            /**
-             * The ID of the GBBankAccount object.
-             */
-            id: string;
-
-            /**
-             * String representing the object's type. Objects of the same type share the same value of the object field.
-             */
-            object: 'v2.core.vault.gb_bank_account';
-
-            /**
-             * Whether this bank account object was archived. Bank account objects can be archived through
-             * the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects
-             * cannot be used as outbound destinations and will not appear in the outbound destination list.
-             */
-            archived: boolean;
-
-            /**
-             * Closed Enum. The type of the bank account (checking or savings).
-             */
-            bank_account_type: GbBankAccount.BankAccountType;
-
-            /**
-             * The name of the bank.
-             */
-            bank_name: string;
-
-            /**
-             * Information around the status of Confirmation of Payee matching done on this bank account.
-             * Confirmation of Payee is a name matching service that must be done before making OutboundPayments in the UK.
-             */
-            confirmation_of_payee: GbBankAccount.ConfirmationOfPayee;
-
-            /**
-             * Creation time.
-             */
-            created: string;
-
-            /**
-             * The last 4 digits of the account number or IBAN.
-             */
-            last4: 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 Sort Code of the bank account.
-             */
-            sort_code: string;
-          }
-
-          namespace GbBankAccount {
-            type BankAccountType = 'checking' | 'savings';
-
-            interface ConfirmationOfPayee {
-              /**
-               * The result of the Confirmation of Payee check, once the check has been initiated. Closed enum.
-               */
-              result: ConfirmationOfPayee.Result;
-
-              /**
-               * The current state of Confirmation of Payee on this bank account. Closed enum.
-               */
-              status: ConfirmationOfPayee.Status;
-            }
-
-            namespace ConfirmationOfPayee {
-              interface Result {
-                /**
-                 * When the CoP result was created.
-                 */
-                created: string;
-
-                /**
-                 * Whether or not the information of the bank account matches what you have provided. Closed enum.
-                 */
-                match_result: Result.MatchResult;
-
-                /**
-                 * The fields that CoP service matched against. Only has value if MATCH or PARTIAL_MATCH, empty otherwise.
-                 */
-                matched: Result.Matched;
-
-                /**
-                 * Human-readable message describing the match result.
-                 */
-                message: string;
-
-                /**
-                 * The fields that are matched against what the network has on file.
-                 */
-                provided: Result.Provided;
-              }
-
-              namespace Result {
-                interface Matched {
-                  /**
-                   * The business type given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
-                   * Closed enum.
-                   */
-                  business_type: Matched.BusinessType | null;
-
-                  /**
-                   * The name given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
-                   */
-                  name: string | null;
-                }
-
-                namespace Matched {
-                  type BusinessType = 'business' | 'personal';
-                }
-
-                type MatchResult =
-                  | 'match'
-                  | 'mismatch'
-                  | 'partial_match'
-                  | 'unavailable';
-
-                interface Provided {
-                  /**
-                   * The provided or Legal Entity business type to match against the CoP service. Closed enum.
-                   */
-                  business_type: Provided.BusinessType;
-
-                  /**
-                   * The provided or Legal Entity name to match against the CoP service.
-                   */
-                  name: string;
-                }
-
-                namespace Provided {
-                  type BusinessType = 'business' | 'personal';
-                }
-              }
-
-              type Status =
-                | 'awaiting_acknowledgement'
-                | 'confirmed'
-                | 'uninitiated';
-            }
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/Core/Vault/GbBankAccountsResource.d.ts

@@ -1,172 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Core {
-        namespace Vault {
-          interface GbBankAccountCreateParams {
-            /**
-             * The Account Number of the bank account.
-             */
-            account_number: string;
-
-            /**
-             * The Sort Code of the bank account.
-             */
-            sort_code: string;
-
-            /**
-             * Closed Enum. The type of the bank account (checking or savings).
-             */
-            bank_account_type?: GbBankAccountCreateParams.BankAccountType;
-
-            /**
-             * Whether or not to automatically perform Confirmation of Payee to verify the users information
-             * against what was provided by the bank. Doing so is required for all bank accounts not owned
-             * by you before making domestic UK OutboundPayments.
-             */
-            confirmation_of_payee?: GbBankAccountCreateParams.ConfirmationOfPayee;
-          }
-
-          namespace GbBankAccountCreateParams {
-            type BankAccountType = 'checking' | 'savings';
-
-            interface ConfirmationOfPayee {
-              /**
-               * The business type to be checked against. Legal entity information will be used if unspecified.
-               * Closed enum.
-               */
-              business_type?: ConfirmationOfPayee.BusinessType;
-
-              /**
-               * User specifies whether Confirmation of Payee is automatically initiated when creating the bank account.
-               */
-              initiate: boolean;
-
-              /**
-               * The name to be checked against. Legal entity information will be used if unspecified.
-               */
-              name?: string;
-            }
-
-            namespace ConfirmationOfPayee {
-              type BusinessType = 'business' | 'personal';
-            }
-          }
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface GbBankAccountRetrieveParams {}
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface GbBankAccountAcknowledgeConfirmationOfPayeeParams {}
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface GbBankAccountArchiveParams {}
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface GbBankAccountInitiateConfirmationOfPayeeParams {
-            /**
-             * The business type to be checked against. Legal entity information will be used if unspecified.
-             */
-            business_type?: GbBankAccountInitiateConfirmationOfPayeeParams.BusinessType;
-
-            /**
-             * The name of the user to be checked against. Legal entity information will be used if unspecified.
-             */
-            name?: string;
-          }
-
-          namespace GbBankAccountInitiateConfirmationOfPayeeParams {
-            type BusinessType = 'business' | 'personal';
-          }
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          class GbBankAccountsResource {
-            /**
-             * Create a GB bank account.
-             */
-            create(
-              params: GbBankAccountCreateParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-
-            /**
-             * Retrieve a GB bank account.
-             */
-            retrieve(
-              id: string,
-              params?: GbBankAccountRetrieveParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-            retrieve(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-
-            /**
-             * Confirm that you have received the result of the Confirmation of Payee request, and that you are okay with
-             * proceeding to pay out to this bank account despite the account not matching, partially matching, or the service
-             * being unavailable. Once you confirm this, you will be able to send OutboundPayments, but this may lead to
-             * funds being sent to the wrong account, which we might not be able to recover.
-             */
-            acknowledgeConfirmationOfPayee(
-              id: string,
-              params?: GbBankAccountAcknowledgeConfirmationOfPayeeParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-            acknowledgeConfirmationOfPayee(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-
-            /**
-             * Archive a GBBankAccount object. Archived GBBankAccount objects cannot be used as outbound destinations
-             * and will not appear in the outbound destination list.
-             */
-            archive(
-              id: string,
-              params?: GbBankAccountArchiveParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-            archive(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-
-            /**
-             * Initiate Confirmation of Payee (CoP) in order to verify that the owner of a UK bank account matches
-             * who you expect. This must be done on all UK bank accounts before sending domestic OutboundPayments. If
-             * the result is a partial match or a non match, explicit acknowledgement using AcknowledgeConfirmationOfPayee
-             * is required before sending funds.
-             */
-            initiateConfirmationOfPayee(
-              id: string,
-              params?: GbBankAccountInitiateConfirmationOfPayeeParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-            initiateConfirmationOfPayee(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/Core/Vault/UsBankAccounts.d.ts

@@ -1,70 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Core {
-        namespace Vault {
-          /**
-           * Use the USBankAccounts API to create and manage US bank accounts objects that you can use to receive funds. Note that these are not interchangeable with v1 Tokens.
-           */
-          interface UsBankAccount {
-            /**
-             * The ID of the USBankAccount object.
-             */
-            id: string;
-
-            /**
-             * String representing the object's type. Objects of the same type share the same value of the object field.
-             */
-            object: 'v2.core.vault.us_bank_account';
-
-            /**
-             * Whether this USBankAccount object was archived.
-             */
-            archived: boolean;
-
-            /**
-             * Closed Enum. The type of bank account (checking or savings).
-             */
-            bank_account_type: UsBankAccount.BankAccountType;
-
-            /**
-             * The name of the bank this bank account belongs to. This field is populated automatically by Stripe based on the routing number.
-             */
-            bank_name: string;
-
-            /**
-             * Creation time of the object.
-             */
-            created: string;
-
-            /**
-             * The fedwire routing number of the bank account.
-             */
-            fedwire_routing_number: string | null;
-
-            /**
-             * The last 4 digits of the account number.
-             */
-            last4: 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 ACH routing number of the bank account.
-             */
-            routing_number: string | null;
-          }
-
-          namespace UsBankAccount {
-            type BankAccountType = 'checking' | 'savings';
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/Core/Vault/UsBankAccountsResource.d.ts

@@ -1,123 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountCreateParams {
-            /**
-             * The account number of the bank account.
-             */
-            account_number: string;
-
-            /**
-             * Closed Enum. The type of the bank account (checking or savings).
-             */
-            bank_account_type?: UsBankAccountCreateParams.BankAccountType;
-
-            /**
-             * The fedwire routing number of the bank account. Note that certain banks have the same ACH and wire routing number.
-             */
-            fedwire_routing_number?: string;
-
-            /**
-             * The ACH routing number of the bank account. Note that certain banks have the same ACH and wire routing number.
-             */
-            routing_number?: string;
-          }
-
-          namespace UsBankAccountCreateParams {
-            type BankAccountType = 'checking' | 'savings';
-          }
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountRetrieveParams {}
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountUpdateParams {
-            /**
-             * The bank account's fedwire routing number can be provided for update it was were empty previously.
-             */
-            fedwire_routing_number?: string;
-
-            /**
-             * The bank account's ACH routing number can be provided for update if it was empty previously.
-             */
-            routing_number?: string;
-          }
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountArchiveParams {}
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          class UsBankAccountsResource {
-            /**
-             * Create a USBankAccount object.
-             * @throws Stripe.BlockedByStripeError
-             * @throws Stripe.InvalidPaymentMethodError
-             * @throws Stripe.QuotaExceededError
-             */
-            create(
-              params: UsBankAccountCreateParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-
-            /**
-             * Retrieve a USBankAccount object.
-             */
-            retrieve(
-              id: string,
-              params?: UsBankAccountRetrieveParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-            retrieve(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-
-            /**
-             * Update a USBankAccount object. This is limited to supplying a previously empty routing_number field.
-             * @throws Stripe.BlockedByStripeError
-             * @throws Stripe.InvalidPaymentMethodError
-             * @throws Stripe.QuotaExceededError
-             */
-            update(
-              id: string,
-              params?: UsBankAccountUpdateParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-
-            /**
-             * Archive a USBankAccount object. USBankAccount objects will not be automatically archived by Stripe.
-             * Archived USBankAccount objects cannot be used as outbound destinations
-             * and will not appear in the outbound destination list.
-             * @throws Stripe.ControlledByDashboardError
-             */
-            archive(
-              id: string,
-              params?: UsBankAccountArchiveParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-            archive(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/EventDestinations.d.ts

@@ -1,164 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      /**
-       * Set up an event destination to receive events from Stripe across multiple destination types, including [webhook endpoints](https://docs.stripe.com/webhooks) and [Amazon EventBridge](https://docs.stripe.com/event-destinations/eventbridge). Event destinations support receiving [thin events](https://docs.stripe.com/api/v2/events) and [snapshot events](https://docs.stripe.com/api/events).
-       */
-      interface EventDestination {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value of the object field.
-         */
-        object: 'v2.core.event_destination';
-
-        /**
-         * Amazon EventBridge configuration.
-         */
-        amazon_eventbridge: EventDestination.AmazonEventbridge | null;
-
-        /**
-         * Time at which the object was created.
-         */
-        created: string;
-
-        /**
-         * An optional description of what the event destination is used for.
-         */
-        description: string;
-
-        /**
-         * The list of events to enable for this endpoint.
-         */
-        enabled_events: Array<string>;
-
-        /**
-         * Payload type of events being subscribed to.
-         */
-        event_payload: EventDestination.EventPayload;
-
-        /**
-         * Where events should be routed from.
-         */
-        events_from: Array<EventDestination.EventsFrom> | null;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * Metadata.
-         */
-        metadata: Stripe.Metadata | null;
-
-        /**
-         * Event destination name.
-         */
-        name: string;
-
-        /**
-         * If using the snapshot event payload, the API version events are rendered as.
-         */
-        snapshot_api_version: string | null;
-
-        /**
-         * Status. It can be set to either enabled or disabled.
-         */
-        status: EventDestination.Status;
-
-        /**
-         * Additional information about event destination status.
-         */
-        status_details: EventDestination.StatusDetails | null;
-
-        /**
-         * Event destination type.
-         */
-        type: EventDestination.Type;
-
-        /**
-         * Time at which the object was last updated.
-         */
-        updated: string;
-
-        /**
-         * Webhook endpoint configuration.
-         */
-        webhook_endpoint: EventDestination.WebhookEndpoint | null;
-      }
-
-      namespace EventDestination {
-        interface AmazonEventbridge {
-          /**
-           * The AWS account ID.
-           */
-          aws_account_id: string;
-
-          /**
-           * The ARN of the AWS event source.
-           */
-          aws_event_source_arn: string;
-
-          /**
-           * The state of the AWS event source.
-           */
-          aws_event_source_status: AmazonEventbridge.AwsEventSourceStatus;
-        }
-
-        namespace AmazonEventbridge {
-          type AwsEventSourceStatus =
-            | 'active'
-            | 'deleted'
-            | 'pending'
-            | 'unknown';
-        }
-
-        type EventPayload = 'snapshot' | 'thin';
-
-        type EventsFrom = 'other_accounts' | 'self';
-
-        type Status = 'disabled' | 'enabled';
-
-        interface StatusDetails {
-          /**
-           * Details about why the event destination has been disabled.
-           */
-          disabled: StatusDetails.Disabled | null;
-        }
-
-        namespace StatusDetails {
-          interface Disabled {
-            /**
-             * Reason event destination has been disabled.
-             */
-            reason: Disabled.Reason;
-          }
-
-          namespace Disabled {
-            type Reason = 'no_aws_event_source_exists' | 'user';
-          }
-        }
-
-        type Type = 'amazon_eventbridge' | 'webhook_endpoint';
-
-        interface WebhookEndpoint {
-          /**
-           * The signing secret of the webhook endpoint, only includable on creation.
-           */
-          signing_secret: string | null;
-
-          /**
-           * The URL of the webhook endpoint, includable.
-           */
-          url: string | null;
-        }
-      }
-    }
-  }
-}