stripe 19.4.0 → 19.5.0.pre.alpha.2

data/lib/stripe/params/external_account_delete_params.rb

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ExternalAccountDeleteParams < ::Stripe::RequestParams; end
+end

data/lib/stripe/params/external_account_list_params.rb

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ExternalAccountListParams < ::Stripe::RequestParams
+    # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+    attr_accessor :ending_before
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+    attr_accessor :limit
+    # Filter external accounts according to a particular object type.
+    attr_accessor :object
+    # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+    attr_accessor :starting_after
+
+    def initialize(ending_before: nil, expand: nil, limit: nil, object: nil, starting_after: nil)
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @object = object
+      @starting_after = starting_after
+    end
+  end
+end

data/lib/stripe/params/external_account_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ExternalAccountRetrieveParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/external_account_update_params.rb

@@ -0,0 +1,91 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ExternalAccountUpdateParams < ::Stripe::RequestParams
+    class Documents < ::Stripe::RequestParams
+      class BankAccountOwnershipVerification < ::Stripe::RequestParams
+        # One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`.
+        attr_accessor :files
+
+        def initialize(files: nil)
+          @files = files
+        end
+      end
+      # One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
+      attr_accessor :bank_account_ownership_verification
+
+      def initialize(bank_account_ownership_verification: nil)
+        @bank_account_ownership_verification = bank_account_ownership_verification
+      end
+    end
+    # The name of the person or business that owns the bank account.
+    attr_accessor :account_holder_name
+    # The type of entity that holds the account. This can be either `individual` or `company`.
+    attr_accessor :account_holder_type
+    # The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
+    attr_accessor :account_type
+    # City/District/Suburb/Town/Village.
+    attr_accessor :address_city
+    # Billing address country, if provided when creating card.
+    attr_accessor :address_country
+    # Address line 1 (Street address/PO Box/Company name).
+    attr_accessor :address_line1
+    # Address line 2 (Apartment/Suite/Unit/Building).
+    attr_accessor :address_line2
+    # State/County/Province/Region.
+    attr_accessor :address_state
+    # ZIP or postal code.
+    attr_accessor :address_zip
+    # When set to true, this becomes the default external account for its currency.
+    attr_accessor :default_for_currency
+    # Documents that may be submitted to satisfy various informational requests.
+    attr_accessor :documents
+    # Two digit number representing the card’s expiration month.
+    attr_accessor :exp_month
+    # Four digit number representing the card’s expiration year.
+    attr_accessor :exp_year
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # Cardholder name.
+    attr_accessor :name
+
+    def initialize(
+      account_holder_name: nil,
+      account_holder_type: nil,
+      account_type: nil,
+      address_city: nil,
+      address_country: nil,
+      address_line1: nil,
+      address_line2: nil,
+      address_state: nil,
+      address_zip: nil,
+      default_for_currency: nil,
+      documents: nil,
+      exp_month: nil,
+      exp_year: nil,
+      expand: nil,
+      metadata: nil,
+      name: nil
+    )
+      @account_holder_name = account_holder_name
+      @account_holder_type = account_holder_type
+      @account_type = account_type
+      @address_city = address_city
+      @address_country = address_country
+      @address_line1 = address_line1
+      @address_line2 = address_line2
+      @address_state = address_state
+      @address_zip = address_zip
+      @default_for_currency = default_for_currency
+      @documents = documents
+      @exp_month = exp_month
+      @exp_year = exp_year
+      @expand = expand
+      @metadata = metadata
+      @name = name
+    end
+  end
+end

data/lib/stripe/params/financial_connections/account_inferred_balance_list_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountInferredBalanceListParams < ::Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/financial_connections/authorization_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AuthorizationRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/financial_connections/institution_list_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class InstitutionListParams < ::Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/financial_connections/institution_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class InstitutionRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/financial_connections/session_create_params.rb

@@ -27,20 +27,33 @@ module Stripe
         attr_accessor :account_subcategories
         # List of countries from which to collect accounts.
         attr_accessor :countries
+        # Stripe ID of the institution with which the customer should be directed to log in.
+        attr_accessor :institution
         # Whether the session should require payment method support and successful account number retrieval before completion.
         attr_accessor :require_payment_method_support
 
         def initialize(
           account_subcategories: nil,
           countries: nil,
+          institution: nil,
           require_payment_method_support: nil
         )
           @account_subcategories = account_subcategories
           @countries = countries
+          @institution = institution
           @require_payment_method_support = require_payment_method_support
         end
       end
 
+      class Hosted < ::Stripe::RequestParams
+        # How the user should enter the hosted flow. The values `email` and `url` can only be used if `relink_options` is provided.
+        attr_accessor :delivery_method
+
+        def initialize(delivery_method: nil)
+          @delivery_method = delivery_method
+        end
+      end
+
       class Limits < ::Stripe::RequestParams
         # The number of accounts that can be linked in this Session. Pass an empty value to allow any number of accounts.
         attr_accessor :accounts
@@ -58,12 +71,26 @@ module Stripe
           @mode = mode
         end
       end
+
+      class RelinkOptions < ::Stripe::RequestParams
+        # The account to relink. Must belong to the authorization specified in `authorization`.
+        attr_accessor :account
+        # The authorization to relink.
+        attr_accessor :authorization
+
+        def initialize(account: nil, authorization: nil)
+          @account = account
+          @authorization = authorization
+        end
+      end
       # The account holder to link accounts for.
       attr_accessor :account_holder
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
       # Filters to restrict the kinds of accounts to collect.
       attr_accessor :filters
+      # Settings for hosted Sessions. Required if `ui_mode` is `hosted`.
+      attr_accessor :hosted
       # Settings for configuring Session-specific limits.
       attr_accessor :limits
       # Customize manual entry behavior
@@ -74,27 +101,37 @@ module Stripe
       attr_accessor :permissions
       # List of data features that you would like to retrieve upon account creation.
       attr_accessor :prefetch
+      # Options for specifying a Session targeted to relinking an authorization.
+      attr_accessor :relink_options
       # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
       attr_accessor :return_url
+      # The UI mode of the Session. Defaults to `modal`.
+      attr_accessor :ui_mode
 
       def initialize(
         account_holder: nil,
         expand: nil,
         filters: nil,
+        hosted: nil,
         limits: nil,
         manual_entry: nil,
         permissions: nil,
         prefetch: nil,
-        return_url: nil
+        relink_options: nil,
+        return_url: nil,
+        ui_mode: nil
       )
         @account_holder = account_holder
         @expand = expand
         @filters = filters
+        @hosted = hosted
         @limits = limits
         @manual_entry = manual_entry
         @permissions = permissions
         @prefetch = prefetch
+        @relink_options = relink_options
         @return_url = return_url
+        @ui_mode = ui_mode
       end
     end
   end

data/lib/stripe/params/fx_quote_create_params.rb

@@ -0,0 +1,73 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FxQuoteCreateParams < ::Stripe::RequestParams
+    class Usage < ::Stripe::RequestParams
+      class Payment < ::Stripe::RequestParams
+        # The Stripe account ID that the funds will be transferred to.
+        #
+        # This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.
+        attr_accessor :destination
+        # The Stripe account ID that these funds are intended for.
+        #
+        # This field should match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
+        attr_accessor :on_behalf_of
+
+        def initialize(destination: nil, on_behalf_of: nil)
+          @destination = destination
+          @on_behalf_of = on_behalf_of
+        end
+      end
+
+      class Transfer < ::Stripe::RequestParams
+        # The Stripe account ID that the funds will be transferred to.
+        #
+        # This field should match the account ID that would be used in the Transfer’s destination field.
+        attr_accessor :destination
+
+        def initialize(destination: nil)
+          @destination = destination
+        end
+      end
+      # The payment transaction details that are intended for the FX Quote.
+      attr_accessor :payment
+      # The transfer transaction details that are intended for the FX Quote.
+      attr_accessor :transfer
+      # Which transaction the FX Quote will be used for
+      #
+      # Can be “payment” | “transfer”
+      attr_accessor :type
+
+      def initialize(payment: nil, transfer: nil, type: nil)
+        @payment = payment
+        @transfer = transfer
+        @type = type
+      end
+    end
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).
+    attr_accessor :from_currencies
+    # The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.
+    attr_accessor :lock_duration
+    # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+    attr_accessor :to_currency
+    # The usage specific information for the quote.
+    attr_accessor :usage
+
+    def initialize(
+      expand: nil,
+      from_currencies: nil,
+      lock_duration: nil,
+      to_currency: nil,
+      usage: nil
+    )
+      @expand = expand
+      @from_currencies = from_currencies
+      @lock_duration = lock_duration
+      @to_currency = to_currency
+      @usage = usage
+    end
+  end
+end

data/lib/stripe/params/fx_quote_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FxQuoteListParams < ::Stripe::RequestParams
+    # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+    attr_accessor :ending_before
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+    attr_accessor :limit
+    # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+    attr_accessor :starting_after
+
+    def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @starting_after = starting_after
+    end
+  end
+end

data/lib/stripe/params/fx_quote_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FxQuoteRetrieveParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/gift_card_activate_params.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardActivateParams < ::Stripe::RequestParams
+    class Balance < ::Stripe::RequestParams
+      # The initial balance amount to be loaded when activating the gift card, in the smallest currency unit
+      attr_accessor :amount
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_accessor :currency
+
+      def initialize(amount: nil, currency: nil)
+        @amount = amount
+        @currency = currency
+      end
+    end
+    # The initial balance to set on the gift card.
+    attr_accessor :balance
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # The Stripe account ID to process the gift card operation on behalf of.
+    attr_accessor :on_behalf_of
+
+    def initialize(balance: nil, expand: nil, on_behalf_of: nil)
+      @balance = balance
+      @expand = expand
+      @on_behalf_of = on_behalf_of
+    end
+  end
+end

data/lib/stripe/params/gift_card_cashout_params.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardCashoutParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # The Stripe account ID to process the gift card operation on behalf of.
+    attr_accessor :on_behalf_of
+
+    def initialize(expand: nil, on_behalf_of: nil)
+      @expand = expand
+      @on_behalf_of = on_behalf_of
+    end
+  end
+end

data/lib/stripe/params/gift_card_check_balance_params.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardCheckBalanceParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # The Stripe account ID to process the gift card operation on behalf of.
+    attr_accessor :on_behalf_of
+
+    def initialize(expand: nil, on_behalf_of: nil)
+      @expand = expand
+      @on_behalf_of = on_behalf_of
+    end
+  end
+end

data/lib/stripe/params/gift_card_create_params.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardCreateParams < ::Stripe::RequestParams
+    # The brand of the gift card.
+    attr_accessor :brand
+    # Two-digit number representing the gift card's expiration month.
+    attr_accessor :exp_month
+    # Four-digit number representing the gift card's expiration year.
+    attr_accessor :exp_year
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # The gift card number.
+    attr_accessor :number
+    # The gift card PIN.
+    attr_accessor :pin
+
+    def initialize(brand: nil, exp_month: nil, exp_year: nil, expand: nil, number: nil, pin: nil)
+      @brand = brand
+      @exp_month = exp_month
+      @exp_year = exp_year
+      @expand = expand
+      @number = number
+      @pin = pin
+    end
+  end
+end

data/lib/stripe/params/gift_card_operation_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardOperationRetrieveParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/gift_card_reload_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardReloadParams < ::Stripe::RequestParams
+    # The amount to add to the gift card balance, in the smallest currency unit.
+    attr_accessor :amount
+    # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+    attr_accessor :currency
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # The Stripe account ID to process the gift card operation on behalf of.
+    attr_accessor :on_behalf_of
+
+    def initialize(amount: nil, currency: nil, expand: nil, on_behalf_of: nil)
+      @amount = amount
+      @currency = currency
+      @expand = expand
+      @on_behalf_of = on_behalf_of
+    end
+  end
+end

data/lib/stripe/params/gift_card_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardRetrieveParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/gift_card_void_operation_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardVoidOperationParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # The Stripe account ID to process the gift card operation on behalf of.
+    attr_accessor :on_behalf_of
+    # The ID of the gift card operation to void.
+    attr_accessor :operation
+
+    def initialize(expand: nil, on_behalf_of: nil, operation: nil)
+      @expand = expand
+      @on_behalf_of = on_behalf_of
+      @operation = operation
+    end
+  end
+end

data/lib/stripe/params/identity/blocklist_entry_create_params.rb

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class BlocklistEntryCreateParams < ::Stripe::RequestParams
+      # When true, the created BlocklistEntry will be used to retroactively unverify matching verifications.
+      attr_accessor :check_existing_verifications
+      # The type of blocklist entry to be created.
+      attr_accessor :entry_type
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The identifier of the VerificationReport to create the BlocklistEntry from.
+      attr_accessor :verification_report
+
+      def initialize(
+        check_existing_verifications: nil,
+        entry_type: nil,
+        expand: nil,
+        verification_report: nil
+      )
+        @check_existing_verifications = check_existing_verifications
+        @entry_type = entry_type
+        @expand = expand
+        @verification_report = verification_report
+      end
+    end
+  end
+end

data/lib/stripe/params/identity/blocklist_entry_disable_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class BlocklistEntryDisableParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end