stripe 15.0.0 → 15.1.0.pre.beta.1

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(requestor)
       @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/gift_cards/card_service.rb

@@ -0,0 +1,170 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    class CardService < 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 CreatedBy < Stripe::RequestParams
+          class Payment < Stripe::RequestParams
+            # The PaymentIntent used to collect payment for this object.
+            attr_accessor :payment_intent
+
+            def initialize(payment_intent: nil)
+              @payment_intent = payment_intent
+            end
+          end
+          # The details for the payment that created this object.
+          attr_accessor :payment
+          # The type of event that created this object.
+          attr_accessor :type
+
+          def initialize(payment: nil, type: nil)
+            @payment = payment
+            @type = type
+          end
+        end
+        # The active state for the new gift card, defaults to false. The active state can be updated after creation.
+        attr_accessor :active
+        # Related objects which created this gift card.
+        attr_accessor :created_by
+        # 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 initial amount to load onto the new gift card, defaults to 0.
+        attr_accessor :initial_amount
+        # 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
+
+        def initialize(
+          active: nil,
+          created_by: nil,
+          currency: nil,
+          expand: nil,
+          initial_amount: nil,
+          metadata: nil
+        )
+          @active = active
+          @created_by = created_by
+          @currency = currency
+          @expand = expand
+          @initial_amount = initial_amount
+          @metadata = metadata
+        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
+
+      class UpdateParams < Stripe::RequestParams
+        # The new active state for the gift card.
+        attr_accessor :active
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # 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
+
+        def initialize(active: nil, expand: nil, metadata: nil)
+          @active = active
+          @expand = expand
+          @metadata = metadata
+        end
+      end
+
+      class ValidateParams < Stripe::RequestParams
+        # The gift card code to be validated.
+        attr_accessor :code
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The pin associated with the gift card. Not all gift cards have pins.
+        attr_accessor :giftcard_pin
+
+        def initialize(code: nil, expand: nil, giftcard_pin: nil)
+          @code = code
+          @expand = expand
+          @giftcard_pin = giftcard_pin
+        end
+      end
+
+      # Creates a new gift card object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List gift cards for an account
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a gift card by id
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a gift card
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Validates a gift card code, returning the matching gift card object if it exists.
+      def validate(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/cards/validate",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/gift_cards/transaction_service.rb

@@ -0,0 +1,209 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    class TransactionService < 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
+        # The gift card to list transactions for.
+        attr_accessor :gift_card
+        # 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
+        # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
+        attr_accessor :transfer_group
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          gift_card: nil,
+          limit: nil,
+          starting_after: nil,
+          transfer_group: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @gift_card = gift_card
+          @limit = limit
+          @starting_after = starting_after
+          @transfer_group = transfer_group
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class CreatedBy < Stripe::RequestParams
+          class Payment < Stripe::RequestParams
+            # The PaymentIntent used to collect payment for this object.
+            attr_accessor :payment_intent
+
+            def initialize(payment_intent: nil)
+              @payment_intent = payment_intent
+            end
+          end
+          # The details for the payment that created this object.
+          attr_accessor :payment
+          # The type of event that created this object.
+          attr_accessor :type
+
+          def initialize(payment: nil, type: nil)
+            @payment = payment
+            @type = type
+          end
+        end
+        # The amount of the transaction. A negative amount deducts funds, and a positive amount adds funds.
+        attr_accessor :amount
+        # Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the `amount_available` on the gift card. Otherwise, it creates a held transaction that increments the `amount_held` on the gift card.
+        attr_accessor :confirm
+        # Related objects which created this transaction.
+        attr_accessor :created_by
+        # The currency of the transaction. This must match the currency of the gift card.
+        attr_accessor :currency
+        # An arbitrary string attached to the object. Often useful for displaying to users.
+        attr_accessor :description
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The gift card to create a new transaction on.
+        attr_accessor :gift_card
+        # 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
+        # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
+        attr_accessor :transfer_group
+
+        def initialize(
+          amount: nil,
+          confirm: nil,
+          created_by: nil,
+          currency: nil,
+          description: nil,
+          expand: nil,
+          gift_card: nil,
+          metadata: nil,
+          transfer_group: nil
+        )
+          @amount = amount
+          @confirm = confirm
+          @created_by = created_by
+          @currency = currency
+          @description = description
+          @expand = expand
+          @gift_card = gift_card
+          @metadata = metadata
+          @transfer_group = transfer_group
+        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
+
+      class UpdateParams < Stripe::RequestParams
+        # An arbitrary string attached to the object. Often useful for displaying to users.
+        attr_accessor :description
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # 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
+
+        def initialize(description: nil, expand: nil, metadata: nil)
+          @description = description
+          @expand = expand
+          @metadata = metadata
+        end
+      end
+
+      class CancelParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ConfirmParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Cancel a gift card transaction
+      def cancel(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Confirm a gift card transaction
+      def confirm(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Create a gift card transaction
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List gift card transactions for a gift card
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the gift card transaction.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a gift card transaction
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/gift_cards_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardsService < StripeService
+    attr_reader :cards, :transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @cards = Stripe::GiftCards::CardService.new(@requestor)
+      @transactions = Stripe::GiftCards::TransactionService.new(@requestor)
+    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
@@ -115,6 +119,8 @@ module Stripe
         attr_accessor :provided_details
         # Customer ID
         attr_accessor :related_customer
+        # Token referencing a Customer Account resource.
+        attr_accessor :related_customer_account
         # The URL that the user will be redirected to upon completing the verification flow.
         attr_accessor :return_url
         # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
@@ -129,6 +135,7 @@ module Stripe
           options: nil,
           provided_details: nil,
           related_customer: nil,
+          related_customer_account: nil,
           return_url: nil,
           type: nil,
           verification_flow: nil
@@ -139,6 +146,7 @@ module Stripe
           @options = options
           @provided_details = provided_details
           @related_customer = related_customer
+          @related_customer_account = related_customer_account
           @return_url = return_url
           @type = type
           @verification_flow = verification_flow

data/lib/stripe/services/invoice_item_service.rb

@@ -17,16 +17,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
@@ -88,6 +116,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.
@@ -113,6 +143,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         expand: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -128,6 +159,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @expand = expand
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data
@@ -162,6 +194,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.
@@ -178,6 +212,7 @@ module Stripe
       def initialize(
         created: nil,
         customer: nil,
+        customer_account: nil,
         ending_before: nil,
         expand: nil,
         invoice: nil,
@@ -187,6 +222,7 @@ module Stripe
       )
         @created = created
         @customer = customer
+        @customer_account = customer_account
         @ending_before = ending_before
         @expand = expand
         @invoice = invoice
@@ -198,16 +234,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
@@ -265,6 +329,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.
@@ -275,6 +341,8 @@ module Stripe
       attr_accessor :expand
       # The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled 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.
@@ -300,11 +368,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,
@@ -319,11 +389,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