stripe 13.3.0 → 13.4.0.pre.beta.2

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

@@ -4,6 +4,103 @@
 module Stripe
   module FinancialConnections
     class SessionService < StripeService
+      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 CreateParams < Stripe::RequestParams
+        class AccountHolder < Stripe::RequestParams
+          # The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`.
+          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
+          # Type of account holder to collect accounts for.
+          attr_accessor :type
+
+          def initialize(account: nil, customer: nil, type: nil)
+            @account = account
+            @customer = customer
+            @type = type
+          end
+        end
+
+        class Filters < Stripe::RequestParams
+          # Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
+          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, 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.
+        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 configuring Session-specific limits.
+        attr_accessor :limits
+        # Settings for configuring manual entry of account details for this Session.
+        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`.
+        attr_accessor :permissions
+        # List of data features that you would like to retrieve upon account creation.
+        attr_accessor :prefetch
+        # 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
+
+        def initialize(
+          account_holder: nil,
+          expand: nil,
+          filters: nil,
+          limits: nil,
+          manual_entry: nil,
+          permissions: nil,
+          prefetch: nil,
+          return_url: nil
+        )
+          @account_holder = account_holder
+          @expand = expand
+          @filters = filters
+          @limits = limits
+          @manual_entry = manual_entry
+          @permissions = permissions
+          @prefetch = prefetch
+          @return_url = return_url
+        end
+      end
+
       # To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
       def create(params = {}, opts = {})
         request(

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

@@ -4,6 +4,76 @@
 module Stripe
   module FinancialConnections
     class TransactionService < StripeService
+      class ListParams < Stripe::RequestParams
+        class TransactedAt < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+
+        class TransactionRefresh < Stripe::RequestParams
+          # Return results where the transactions were created or updated by a refresh that took place after this refresh (non-inclusive).
+          attr_accessor :after
+
+          def initialize(after: nil)
+            @after = after
+          end
+        end
+        # The ID of the Stripe account whose transactions will be retrieved.
+        attr_accessor :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.
+        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
+        # A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
+        attr_accessor :transacted_at
+        # A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:
+        attr_accessor :transaction_refresh
+
+        def initialize(
+          account: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          transacted_at: nil,
+          transaction_refresh: nil
+        )
+          @account = account
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @transacted_at = transacted_at
+          @transaction_refresh = transaction_refresh
+        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
+
       # Returns a list of Financial Connections Transaction objects.
       def list(params = {}, opts = {})
         request(

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/forwarding/request_service.rb

@@ -4,6 +4,112 @@
 module Stripe
   module Forwarding
     class RequestService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Return results where the `created` field is greater than this value.
+          attr_accessor :gt
+          # Return results where the `created` field is greater than or equal to this value.
+          attr_accessor :gte
+          # Return results where the `created` field is less than this value.
+          attr_accessor :lt
+          # Return results where the `created` field is less than or equal to this value.
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+        # Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
+        attr_accessor :created
+        # A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
+        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 pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
+        attr_accessor :starting_after
+
+        def initialize(
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        )
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class Request < Stripe::RequestParams
+          class Header < Stripe::RequestParams
+            # The header name.
+            attr_accessor :name
+            # The header value.
+            attr_accessor :value
+
+            def initialize(name: nil, value: nil)
+              @name = name
+              @value = value
+            end
+          end
+          # The body payload to send to the destination endpoint.
+          attr_accessor :body
+          # The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
+          attr_accessor :headers
+
+          def initialize(body: nil, headers: nil)
+            @body = body
+            @headers = headers
+          end
+        end
+        # 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
+        # The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
+        attr_accessor :payment_method
+        # The field kinds to be replaced in the forwarded request.
+        attr_accessor :replacements
+        # The request body and headers to be sent to the destination endpoint.
+        attr_accessor :request
+        # The destination URL for the forwarded request. Must be supported by the config.
+        attr_accessor :url
+
+        def initialize(
+          expand: nil,
+          metadata: nil,
+          payment_method: nil,
+          replacements: nil,
+          request: nil,
+          url: nil
+        )
+          @expand = expand
+          @metadata = metadata
+          @payment_method = payment_method
+          @replacements = replacements
+          @request = request
+          @url = url
+        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 a ForwardingRequest object.
       def create(params = {}, opts = {})
         request(

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