stripe 13.4.1 → 17.0.1

data/lib/stripe/params/issuing/cardholder_update_params.rb

@@ -0,0 +1,230 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class CardholderUpdateParams < Stripe::RequestParams
+      class Billing < Stripe::RequestParams
+        class Address < Stripe::RequestParams
+          # City, district, suburb, town, or village.
+          attr_accessor :city
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_accessor :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_accessor :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_accessor :line2
+          # ZIP or postal code.
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          attr_accessor :state
+
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          )
+            @city = city
+            @country = country
+            @line1 = line1
+            @line2 = line2
+            @postal_code = postal_code
+            @state = state
+          end
+        end
+        # The cardholder’s billing address.
+        attr_accessor :address
+
+        def initialize(address: nil)
+          @address = address
+        end
+      end
+
+      class Company < Stripe::RequestParams
+        # The entity's business ID number.
+        attr_accessor :tax_id
+
+        def initialize(tax_id: nil)
+          @tax_id = tax_id
+        end
+      end
+
+      class Individual < Stripe::RequestParams
+        class CardIssuing < Stripe::RequestParams
+          class UserTermsAcceptance < Stripe::RequestParams
+            # The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
+            attr_accessor :date
+            # The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.
+            attr_accessor :ip
+            # The user agent of the browser from which the cardholder accepted the Authorized User Terms.
+            attr_accessor :user_agent
+
+            def initialize(date: nil, ip: nil, user_agent: nil)
+              @date = date
+              @ip = ip
+              @user_agent = user_agent
+            end
+          end
+          # Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.
+          attr_accessor :user_terms_acceptance
+
+          def initialize(user_terms_acceptance: nil)
+            @user_terms_acceptance = user_terms_acceptance
+          end
+        end
+
+        class Dob < Stripe::RequestParams
+          # The day of birth, between 1 and 31.
+          attr_accessor :day
+          # The month of birth, between 1 and 12.
+          attr_accessor :month
+          # The four-digit year of birth.
+          attr_accessor :year
+
+          def initialize(day: nil, month: nil, year: nil)
+            @day = day
+            @month = month
+            @year = year
+          end
+        end
+
+        class Verification < Stripe::RequestParams
+          class Document < Stripe::RequestParams
+            # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
+            attr_accessor :back
+            # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
+            attr_accessor :front
+
+            def initialize(back: nil, front: nil)
+              @back = back
+              @front = front
+            end
+          end
+          # An identifying document, either a passport or local ID card.
+          attr_accessor :document
+
+          def initialize(document: nil)
+            @document = document
+          end
+        end
+        # Information related to the card_issuing program for this cardholder.
+        attr_accessor :card_issuing
+        # The date of birth of this cardholder. Cardholders must be older than 13 years old.
+        attr_accessor :dob
+        # The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
+        attr_accessor :first_name
+        # The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
+        attr_accessor :last_name
+        # Government-issued ID document for this cardholder.
+        attr_accessor :verification
+
+        def initialize(
+          card_issuing: nil,
+          dob: nil,
+          first_name: nil,
+          last_name: nil,
+          verification: nil
+        )
+          @card_issuing = card_issuing
+          @dob = dob
+          @first_name = first_name
+          @last_name = last_name
+          @verification = verification
+        end
+      end
+
+      class SpendingControls < Stripe::RequestParams
+        class SpendingLimit < Stripe::RequestParams
+          # Maximum amount allowed to spend per interval.
+          attr_accessor :amount
+          # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
+          attr_accessor :categories
+          # Interval (or event) to which the amount applies.
+          attr_accessor :interval
+
+          def initialize(amount: nil, categories: nil, interval: nil)
+            @amount = amount
+            @categories = categories
+            @interval = interval
+          end
+        end
+        # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
+        attr_accessor :allowed_categories
+        # Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
+        attr_accessor :allowed_merchant_countries
+        # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
+        attr_accessor :blocked_categories
+        # Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
+        attr_accessor :blocked_merchant_countries
+        # Limit spending with amount-based rules that apply across this cardholder's cards.
+        attr_accessor :spending_limits
+        # Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.
+        attr_accessor :spending_limits_currency
+
+        def initialize(
+          allowed_categories: nil,
+          allowed_merchant_countries: nil,
+          blocked_categories: nil,
+          blocked_merchant_countries: nil,
+          spending_limits: nil,
+          spending_limits_currency: nil
+        )
+          @allowed_categories = allowed_categories
+          @allowed_merchant_countries = allowed_merchant_countries
+          @blocked_categories = blocked_categories
+          @blocked_merchant_countries = blocked_merchant_countries
+          @spending_limits = spending_limits
+          @spending_limits_currency = spending_limits_currency
+        end
+      end
+      # The cardholder's billing address.
+      attr_accessor :billing
+      # Additional information about a `company` cardholder.
+      attr_accessor :company
+      # The cardholder's email address.
+      attr_accessor :email
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Additional information about an `individual` cardholder.
+      attr_accessor :individual
+      # 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 cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.
+      attr_accessor :phone_number
+      # The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
+      #  This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.
+      attr_accessor :preferred_locales
+      # Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
+      attr_accessor :spending_controls
+      # Specifies whether to permit authorizations on this cardholder's cards.
+      attr_accessor :status
+
+      def initialize(
+        billing: nil,
+        company: nil,
+        email: nil,
+        expand: nil,
+        individual: nil,
+        metadata: nil,
+        phone_number: nil,
+        preferred_locales: nil,
+        spending_controls: nil,
+        status: nil
+      )
+        @billing = billing
+        @company = company
+        @email = email
+        @expand = expand
+        @individual = individual
+        @metadata = metadata
+        @phone_number = phone_number
+        @preferred_locales = preferred_locales
+        @spending_controls = spending_controls
+        @status = status
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/dispute_create_params.rb

@@ -0,0 +1,297 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class DisputeCreateParams < Stripe::RequestParams
+      class Evidence < Stripe::RequestParams
+        class Canceled < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Date when order was canceled.
+          attr_accessor :canceled_at
+          # Whether the cardholder was provided with a cancellation policy.
+          attr_accessor :cancellation_policy_provided
+          # Reason for canceling the order.
+          attr_accessor :cancellation_reason
+          # Date when the cardholder expected to receive the product.
+          attr_accessor :expected_at
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_accessor :product_description
+          # Whether the product was a merchandise or service.
+          attr_accessor :product_type
+          # Result of cardholder's attempt to return the product.
+          attr_accessor :return_status
+          # Date when the product was returned or attempted to be returned.
+          attr_accessor :returned_at
+
+          def initialize(
+            additional_documentation: nil,
+            canceled_at: nil,
+            cancellation_policy_provided: nil,
+            cancellation_reason: nil,
+            expected_at: nil,
+            explanation: nil,
+            product_description: nil,
+            product_type: nil,
+            return_status: nil,
+            returned_at: nil
+          )
+            @additional_documentation = additional_documentation
+            @canceled_at = canceled_at
+            @cancellation_policy_provided = cancellation_policy_provided
+            @cancellation_reason = cancellation_reason
+            @expected_at = expected_at
+            @explanation = explanation
+            @product_description = product_description
+            @product_type = product_type
+            @return_status = return_status
+            @returned_at = returned_at
+          end
+        end
+
+        class Duplicate < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
+          attr_accessor :card_statement
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
+          attr_accessor :cash_receipt
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
+          attr_accessor :check_image
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
+          attr_accessor :original_transaction
+
+          def initialize(
+            additional_documentation: nil,
+            card_statement: nil,
+            cash_receipt: nil,
+            check_image: nil,
+            explanation: nil,
+            original_transaction: nil
+          )
+            @additional_documentation = additional_documentation
+            @card_statement = card_statement
+            @cash_receipt = cash_receipt
+            @check_image = check_image
+            @explanation = explanation
+            @original_transaction = original_transaction
+          end
+        end
+
+        class Fraudulent < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+
+          def initialize(additional_documentation: nil, explanation: nil)
+            @additional_documentation = additional_documentation
+            @explanation = explanation
+          end
+        end
+
+        class MerchandiseNotAsDescribed < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Date when the product was received.
+          attr_accessor :received_at
+          # Description of the cardholder's attempt to return the product.
+          attr_accessor :return_description
+          # Result of cardholder's attempt to return the product.
+          attr_accessor :return_status
+          # Date when the product was returned or attempted to be returned.
+          attr_accessor :returned_at
+
+          def initialize(
+            additional_documentation: nil,
+            explanation: nil,
+            received_at: nil,
+            return_description: nil,
+            return_status: nil,
+            returned_at: nil
+          )
+            @additional_documentation = additional_documentation
+            @explanation = explanation
+            @received_at = received_at
+            @return_description = return_description
+            @return_status = return_status
+            @returned_at = returned_at
+          end
+        end
+
+        class NoValidAuthorization < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+
+          def initialize(additional_documentation: nil, explanation: nil)
+            @additional_documentation = additional_documentation
+            @explanation = explanation
+          end
+        end
+
+        class NotReceived < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Date when the cardholder expected to receive the product.
+          attr_accessor :expected_at
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_accessor :product_description
+          # Whether the product was a merchandise or service.
+          attr_accessor :product_type
+
+          def initialize(
+            additional_documentation: nil,
+            expected_at: nil,
+            explanation: nil,
+            product_description: nil,
+            product_type: nil
+          )
+            @additional_documentation = additional_documentation
+            @expected_at = expected_at
+            @explanation = explanation
+            @product_description = product_description
+            @product_type = product_type
+          end
+        end
+
+        class Other < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_accessor :product_description
+          # Whether the product was a merchandise or service.
+          attr_accessor :product_type
+
+          def initialize(
+            additional_documentation: nil,
+            explanation: nil,
+            product_description: nil,
+            product_type: nil
+          )
+            @additional_documentation = additional_documentation
+            @explanation = explanation
+            @product_description = product_description
+            @product_type = product_type
+          end
+        end
+
+        class ServiceNotAsDescribed < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Date when order was canceled.
+          attr_accessor :canceled_at
+          # Reason for canceling the order.
+          attr_accessor :cancellation_reason
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Date when the product was received.
+          attr_accessor :received_at
+
+          def initialize(
+            additional_documentation: nil,
+            canceled_at: nil,
+            cancellation_reason: nil,
+            explanation: nil,
+            received_at: nil
+          )
+            @additional_documentation = additional_documentation
+            @canceled_at = canceled_at
+            @cancellation_reason = cancellation_reason
+            @explanation = explanation
+            @received_at = received_at
+          end
+        end
+        # Evidence provided when `reason` is 'canceled'.
+        attr_accessor :canceled
+        # Evidence provided when `reason` is 'duplicate'.
+        attr_accessor :duplicate
+        # Evidence provided when `reason` is 'fraudulent'.
+        attr_accessor :fraudulent
+        # Evidence provided when `reason` is 'merchandise_not_as_described'.
+        attr_accessor :merchandise_not_as_described
+        # Evidence provided when `reason` is 'no_valid_authorization'.
+        attr_accessor :no_valid_authorization
+        # Evidence provided when `reason` is 'not_received'.
+        attr_accessor :not_received
+        # Evidence provided when `reason` is 'other'.
+        attr_accessor :other
+        # The reason for filing the dispute. The evidence should be submitted in the field of the same name.
+        attr_accessor :reason
+        # Evidence provided when `reason` is 'service_not_as_described'.
+        attr_accessor :service_not_as_described
+
+        def initialize(
+          canceled: nil,
+          duplicate: nil,
+          fraudulent: nil,
+          merchandise_not_as_described: nil,
+          no_valid_authorization: nil,
+          not_received: nil,
+          other: nil,
+          reason: nil,
+          service_not_as_described: nil
+        )
+          @canceled = canceled
+          @duplicate = duplicate
+          @fraudulent = fraudulent
+          @merchandise_not_as_described = merchandise_not_as_described
+          @no_valid_authorization = no_valid_authorization
+          @not_received = not_received
+          @other = other
+          @reason = reason
+          @service_not_as_described = service_not_as_described
+        end
+      end
+
+      class Treasury < Stripe::RequestParams
+        # The ID of the ReceivedDebit to initiate an Issuings dispute for.
+        attr_accessor :received_debit
+
+        def initialize(received_debit: nil)
+          @received_debit = received_debit
+        end
+      end
+      # The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount.
+      attr_accessor :amount
+      # Evidence provided for the dispute.
+      attr_accessor :evidence
+      # 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 ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.
+      attr_accessor :transaction
+      # Params for disputes related to Treasury FinancialAccounts
+      attr_accessor :treasury
+
+      def initialize(
+        amount: nil,
+        evidence: nil,
+        expand: nil,
+        metadata: nil,
+        transaction: nil,
+        treasury: nil
+      )
+        @amount = amount
+        @evidence = evidence
+        @expand = expand
+        @metadata = metadata
+        @transaction = transaction
+        @treasury = treasury
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/dispute_list_params.rb

@@ -0,0 +1,58 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class DisputeListParams < Stripe::RequestParams
+      class Created < 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
+      # Only return Issuing disputes that were created during the given date interval.
+      attr_accessor :created
+      # 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
+      # Select Issuing disputes with the given status.
+      attr_accessor :status
+      # Select the Issuing dispute for the given transaction.
+      attr_accessor :transaction
+
+      def initialize(
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        status: nil,
+        transaction: nil
+      )
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @status = status
+        @transaction = transaction
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/dispute_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class DisputeRetrieveParams < 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/issuing/dispute_submit_params.rb

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class DisputeSubmitParams < Stripe::RequestParams
+      # 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(expand: nil, metadata: nil)
+        @expand = expand
+        @metadata = metadata
+      end
+    end
+  end
+end