stripe 15.5.0 → 15.6.0.pre.beta.1

data/lib/stripe/services/financial_connections/session_service.rb

@@ -19,12 +19,15 @@ module Stripe
           attr_accessor :account
           # The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.
           attr_accessor :customer
+          # The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.
+          attr_accessor :customer_account
           # Type of account holder to collect accounts for.
           attr_accessor :type
 
-          def initialize(account: nil, customer: nil, type: nil)
+          def initialize(account: nil, customer: nil, customer_account: nil, type: nil)
             @account = account
             @customer = customer
+            @customer_account = customer_account
             @type = type
           end
         end
@@ -34,10 +37,31 @@ 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
 
-          def initialize(account_subcategories: nil, countries: nil)
+          def initialize(account_subcategories: nil, countries: nil, institution: nil)
             @account_subcategories = account_subcategories
             @countries = countries
+            @institution = institution
+          end
+        end
+
+        class Limits < Stripe::RequestParams
+          # The number of accounts that can be linked in this Session.
+          attr_accessor :accounts
+
+          def initialize(accounts: nil)
+            @accounts = accounts
+          end
+        end
+
+        class ManualEntry < Stripe::RequestParams
+          # Whether manual entry will be handled by Stripe during the Session.
+          attr_accessor :mode
+
+          def initialize(mode: nil)
+            @mode = mode
           end
         end
         # The account holder to link accounts for.
@@ -46,6 +70,10 @@ module Stripe
         attr_accessor :expand
         # Filters to restrict the kinds of accounts to collect.
         attr_accessor :filters
+        # Settings for configuring Session-specific limits.
+        attr_accessor :limits
+        # Customize manual entry behavior
+        attr_accessor :manual_entry
         # List of data features that you would like to request access to.
         #
         # Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
@@ -59,6 +87,8 @@ module Stripe
           account_holder: nil,
           expand: nil,
           filters: nil,
+          limits: nil,
+          manual_entry: nil,
           permissions: nil,
           prefetch: nil,
           return_url: nil
@@ -66,6 +96,8 @@ module Stripe
           @account_holder = account_holder
           @expand = expand
           @filters = filters
+          @limits = limits
+          @manual_entry = manual_entry
           @permissions = permissions
           @prefetch = prefetch
           @return_url = return_url

data/lib/stripe/services/financial_connections_service.rb

@@ -3,11 +3,12 @@
 
 module Stripe
   class FinancialConnectionsService < StripeService
-    attr_reader :accounts, :sessions, :transactions
+    attr_reader :accounts, :institutions, :sessions, :transactions
 
     def initialize(requestor)
       super
       @accounts = Stripe::FinancialConnections::AccountService.new(@requestor)
+      @institutions = Stripe::FinancialConnections::InstitutionService.new(@requestor)
       @sessions = Stripe::FinancialConnections::SessionService.new(@requestor)
       @transactions = Stripe::FinancialConnections::TransactionService.new(@requestor)
     end

data/lib/stripe/services/fx_quote_service.rb

@@ -0,0 +1,123 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FxQuoteService < StripeService
+    class ListParams < 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
+
+    class CreateParams < 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
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    # Creates an FX Quote object
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/fx_quotes", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/fx_quotes", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieve an FX Quote object
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/fx_quotes/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/identity/verification_session_service.rb

@@ -34,6 +34,8 @@ module Stripe
         attr_accessor :limit
         # Attribute for param field related_customer
         attr_accessor :related_customer
+        # Attribute for param field related_customer_account
+        attr_accessor :related_customer_account
         # 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
         # Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
@@ -46,6 +48,7 @@ module Stripe
           expand: nil,
           limit: nil,
           related_customer: nil,
+          related_customer_account: nil,
           starting_after: nil,
           status: nil
         )
@@ -55,6 +58,7 @@ module Stripe
           @expand = expand
           @limit = limit
           @related_customer = related_customer
+          @related_customer_account = related_customer_account
           @starting_after = starting_after
           @status = status
         end
@@ -127,6 +131,8 @@ module Stripe
         attr_accessor :provided_details
         # Customer ID
         attr_accessor :related_customer
+        # Token referencing a Customer Account resource.
+        attr_accessor :related_customer_account
         # Tokens referencing a Person resource and it's associated account.
         attr_accessor :related_person
         # The URL that the user will be redirected to upon completing the verification flow.
@@ -143,6 +149,7 @@ module Stripe
           options: nil,
           provided_details: nil,
           related_customer: nil,
+          related_customer_account: nil,
           related_person: nil,
           return_url: nil,
           type: nil,
@@ -154,6 +161,7 @@ module Stripe
           @options = options
           @provided_details = provided_details
           @related_customer = related_customer
+          @related_customer_account = related_customer_account
           @related_person = related_person
           @return_url = return_url
           @type = type

data/lib/stripe/services/invoice_item_service.rb

@@ -16,16 +16,44 @@ module Stripe
 
     class UpdateParams < Stripe::RequestParams
       class Discount < Stripe::RequestParams
+        class DiscountEnd < Stripe::RequestParams
+          class Duration < Stripe::RequestParams
+            # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+            attr_accessor :interval
+            # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+            attr_accessor :interval_count
+
+            def initialize(interval: nil, interval_count: nil)
+              @interval = interval
+              @interval_count = interval_count
+            end
+          end
+          # Time span for the redeemed discount.
+          attr_accessor :duration
+          # A precise Unix timestamp for the discount to end. Must be in the future.
+          attr_accessor :timestamp
+          # The type of calculation made to determine when the discount ends.
+          attr_accessor :type
+
+          def initialize(duration: nil, timestamp: nil, type: nil)
+            @duration = duration
+            @timestamp = timestamp
+            @type = type
+          end
+        end
         # ID of the coupon to create a new discount for.
         attr_accessor :coupon
         # ID of an existing discount on the object (or one of its ancestors) to reuse.
         attr_accessor :discount
+        # Details to determine how long the discount should be applied for.
+        attr_accessor :discount_end
         # ID of the promotion code to create a new discount for.
         attr_accessor :promotion_code
 
-        def initialize(coupon: nil, discount: nil, promotion_code: nil)
+        def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
           @coupon = coupon
           @discount = discount
+          @discount_end = discount_end
           @promotion_code = promotion_code
         end
       end
@@ -87,6 +115,8 @@ module Stripe
       attr_accessor :discounts
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
+      # The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+      attr_accessor :margins
       # Set of [key-value pairs](https://stripe.com/docs/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
       # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
@@ -112,6 +142,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         expand: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -127,6 +158,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @expand = expand
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data
@@ -161,6 +193,8 @@ module Stripe
       attr_accessor :created
       # The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
       attr_accessor :customer
+      # The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.
+      attr_accessor :customer_account
       # 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.
@@ -177,6 +211,7 @@ module Stripe
       def initialize(
         created: nil,
         customer: nil,
+        customer_account: nil,
         ending_before: nil,
         expand: nil,
         invoice: nil,
@@ -186,6 +221,7 @@ module Stripe
       )
         @created = created
         @customer = customer
+        @customer_account = customer_account
         @ending_before = ending_before
         @expand = expand
         @invoice = invoice
@@ -197,16 +233,44 @@ module Stripe
 
     class CreateParams < Stripe::RequestParams
       class Discount < Stripe::RequestParams
+        class DiscountEnd < Stripe::RequestParams
+          class Duration < Stripe::RequestParams
+            # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+            attr_accessor :interval
+            # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+            attr_accessor :interval_count
+
+            def initialize(interval: nil, interval_count: nil)
+              @interval = interval
+              @interval_count = interval_count
+            end
+          end
+          # Time span for the redeemed discount.
+          attr_accessor :duration
+          # A precise Unix timestamp for the discount to end. Must be in the future.
+          attr_accessor :timestamp
+          # The type of calculation made to determine when the discount ends.
+          attr_accessor :type
+
+          def initialize(duration: nil, timestamp: nil, type: nil)
+            @duration = duration
+            @timestamp = timestamp
+            @type = type
+          end
+        end
         # ID of the coupon to create a new discount for.
         attr_accessor :coupon
         # ID of an existing discount on the object (or one of its ancestors) to reuse.
         attr_accessor :discount
+        # Details to determine how long the discount should be applied for.
+        attr_accessor :discount_end
         # ID of the promotion code to create a new discount for.
         attr_accessor :promotion_code
 
-        def initialize(coupon: nil, discount: nil, promotion_code: nil)
+        def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
           @coupon = coupon
           @discount = discount
+          @discount_end = discount_end
           @promotion_code = promotion_code
         end
       end
@@ -264,6 +328,8 @@ module Stripe
       attr_accessor :currency
       # The ID of the customer who will be billed when this invoice item is billed.
       attr_accessor :customer
+      # The ID of the account who will be billed when this invoice item is billed.
+      attr_accessor :customer_account
       # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
       attr_accessor :description
       # Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
@@ -274,6 +340,8 @@ module Stripe
       attr_accessor :expand
       # The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
       attr_accessor :invoice
+      # The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+      attr_accessor :margins
       # Set of [key-value pairs](https://stripe.com/docs/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
       # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
@@ -299,11 +367,13 @@ module Stripe
         amount: nil,
         currency: nil,
         customer: nil,
+        customer_account: nil,
         description: nil,
         discountable: nil,
         discounts: nil,
         expand: nil,
         invoice: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -318,11 +388,13 @@ module Stripe
         @amount = amount
         @currency = currency
         @customer = customer
+        @customer_account = customer_account
         @description = description
         @discountable = discountable
         @discounts = discounts
         @expand = expand
         @invoice = invoice
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data

data/lib/stripe/services/invoice_line_item_service.rb

@@ -23,16 +23,44 @@ module Stripe
 
     class UpdateParams < Stripe::RequestParams
       class Discount < Stripe::RequestParams
+        class DiscountEnd < Stripe::RequestParams
+          class Duration < Stripe::RequestParams
+            # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+            attr_accessor :interval
+            # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+            attr_accessor :interval_count
+
+            def initialize(interval: nil, interval_count: nil)
+              @interval = interval
+              @interval_count = interval_count
+            end
+          end
+          # Time span for the redeemed discount.
+          attr_accessor :duration
+          # A precise Unix timestamp for the discount to end. Must be in the future.
+          attr_accessor :timestamp
+          # The type of calculation made to determine when the discount ends.
+          attr_accessor :type
+
+          def initialize(duration: nil, timestamp: nil, type: nil)
+            @duration = duration
+            @timestamp = timestamp
+            @type = type
+          end
+        end
         # ID of the coupon to create a new discount for.
         attr_accessor :coupon
         # ID of an existing discount on the object (or one of its ancestors) to reuse.
         attr_accessor :discount
+        # Details to determine how long the discount should be applied for.
+        attr_accessor :discount_end
         # ID of the promotion code to create a new discount for.
         attr_accessor :promotion_code
 
-        def initialize(coupon: nil, discount: nil, promotion_code: nil)
+        def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
           @coupon = coupon
           @discount = discount
+          @discount_end = discount_end
           @promotion_code = promotion_code
         end
       end
@@ -180,6 +208,8 @@ module Stripe
       attr_accessor :discounts
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
+      # The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
+      attr_accessor :margins
       # Set of [key-value pairs](https://stripe.com/docs/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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
       attr_accessor :metadata
       # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
@@ -201,6 +231,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         expand: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -214,6 +245,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @expand = expand
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data

data/lib/stripe/services/invoice_payment_service.rb

@@ -7,11 +7,14 @@ module Stripe
       class Payment < Stripe::RequestParams
         # Only return invoice payments associated by this payment intent ID.
         attr_accessor :payment_intent
+        # Only return invoice payments associated by this payment record ID.
+        attr_accessor :payment_record
         # Only return invoice payments associated by this payment type.
         attr_accessor :type
 
-        def initialize(payment_intent: nil, type: nil)
+        def initialize(payment_intent: nil, payment_record: nil, type: nil)
           @payment_intent = payment_intent
+          @payment_record = payment_record
           @type = type
         end
       end