stripe 13.4.0 → 13.5.0.pre.beta.1

data/lib/stripe/services/issuing/authorization_service.rb

@@ -4,6 +4,110 @@
 module Stripe
   module Issuing
     class AuthorizationService < StripeService
+      class ListParams < 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 authorizations that belong to the given card.
+        attr_accessor :card
+        # Only return authorizations that belong to the given cardholder.
+        attr_accessor :cardholder
+        # Only return authorizations 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
+        # Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.
+        attr_accessor :status
+
+        def initialize(
+          card: nil,
+          cardholder: nil,
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @card = card
+          @cardholder = cardholder
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @status = status
+        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
+        # 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
+
+      class ApproveParams < Stripe::RequestParams
+        # If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).
+        attr_accessor :amount
+        # 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(amount: nil, expand: nil, metadata: nil)
+          @amount = amount
+          @expand = expand
+          @metadata = metadata
+        end
+      end
+
+      class DeclineParams < 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
+
       # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
       # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
       def approve(authorization, params = {}, opts = {})

data/lib/stripe/services/issuing/card_service.rb

@@ -4,6 +4,461 @@
 module Stripe
   module Issuing
     class CardService < StripeService
+      class ListParams < 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 cards belonging to the Cardholder with the provided ID.
+        attr_accessor :cardholder
+        # Only return cards that were issued 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
+        # Only return cards that have the given expiration month.
+        attr_accessor :exp_month
+        # Only return cards that have the given expiration year.
+        attr_accessor :exp_year
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Only return cards that have the given last four digits.
+        attr_accessor :last4
+        # 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
+        # Attribute for param field personalization_design
+        attr_accessor :personalization_design
+        # 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 cards that have the given status. One of `active`, `inactive`, or `canceled`.
+        attr_accessor :status
+        # Only return cards that have the given type. One of `virtual` or `physical`.
+        attr_accessor :type
+
+        def initialize(
+          cardholder: nil,
+          created: nil,
+          ending_before: nil,
+          exp_month: nil,
+          exp_year: nil,
+          expand: nil,
+          last4: nil,
+          limit: nil,
+          personalization_design: nil,
+          starting_after: nil,
+          status: nil,
+          type: nil
+        )
+          @cardholder = cardholder
+          @created = created
+          @ending_before = ending_before
+          @exp_month = exp_month
+          @exp_year = exp_year
+          @expand = expand
+          @last4 = last4
+          @limit = limit
+          @personalization_design = personalization_design
+          @starting_after = starting_after
+          @status = status
+          @type = type
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class Pin < Stripe::RequestParams
+          # The card's desired new PIN, encrypted under Stripe's public key.
+          attr_accessor :encrypted_number
+
+          def initialize(encrypted_number: nil)
+            @encrypted_number = encrypted_number
+          end
+        end
+
+        class Shipping < 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 (e.g., street, PO Box, or company name).
+            attr_accessor :line1
+            # Address line 2 (e.g., 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
+
+          class AddressValidation < Stripe::RequestParams
+            # The address validation capabilities to use.
+            attr_accessor :mode
+
+            def initialize(mode: nil)
+              @mode = mode
+            end
+          end
+
+          class Customs < Stripe::RequestParams
+            # The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
+            attr_accessor :eori_number
+
+            def initialize(eori_number: nil)
+              @eori_number = eori_number
+            end
+          end
+          # The address that the card is shipped to.
+          attr_accessor :address
+          # Address validation settings.
+          attr_accessor :address_validation
+          # Customs information for the shipment.
+          attr_accessor :customs
+          # The name printed on the shipping label when shipping the card.
+          attr_accessor :name
+          # Phone number of the recipient of the shipment.
+          attr_accessor :phone_number
+          # Whether a signature is required for card delivery.
+          attr_accessor :require_signature
+          # Shipment service.
+          attr_accessor :service
+          # Packaging options.
+          attr_accessor :type
+
+          def initialize(
+            address: nil,
+            address_validation: nil,
+            customs: nil,
+            name: nil,
+            phone_number: nil,
+            require_signature: nil,
+            service: nil,
+            type: nil
+          )
+            @address = address
+            @address_validation = address_validation
+            @customs = customs
+            @name = name
+            @phone_number = phone_number
+            @require_signature = require_signature
+            @service = service
+            @type = type
+          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 any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).
+          attr_accessor :spending_limits
+
+          def initialize(
+            allowed_categories: nil,
+            allowed_merchant_countries: nil,
+            blocked_categories: nil,
+            blocked_merchant_countries: nil,
+            spending_limits: 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
+          end
+        end
+        # The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated.
+        attr_accessor :cardholder
+        # The currency for the card.
+        attr_accessor :currency
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Attribute for param field financial_account
+        attr_accessor :financial_account
+        # 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 personalization design object belonging to this card.
+        attr_accessor :personalization_design
+        # The desired PIN for this card.
+        attr_accessor :pin
+        # The card this is meant to be a replacement for (if any).
+        attr_accessor :replacement_for
+        # If `replacement_for` is specified, this should indicate why that card is being replaced.
+        attr_accessor :replacement_reason
+        # The second line to print on the card. Max length: 24 characters.
+        attr_accessor :second_line
+        # The address where the card will be shipped.
+        attr_accessor :shipping
+        # Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
+        attr_accessor :spending_controls
+        # Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.
+        attr_accessor :status
+        # The type of card to issue. Possible values are `physical` or `virtual`.
+        attr_accessor :type
+
+        def initialize(
+          cardholder: nil,
+          currency: nil,
+          expand: nil,
+          financial_account: nil,
+          metadata: nil,
+          personalization_design: nil,
+          pin: nil,
+          replacement_for: nil,
+          replacement_reason: nil,
+          second_line: nil,
+          shipping: nil,
+          spending_controls: nil,
+          status: nil,
+          type: nil
+        )
+          @cardholder = cardholder
+          @currency = currency
+          @expand = expand
+          @financial_account = financial_account
+          @metadata = metadata
+          @personalization_design = personalization_design
+          @pin = pin
+          @replacement_for = replacement_for
+          @replacement_reason = replacement_reason
+          @second_line = second_line
+          @shipping = shipping
+          @spending_controls = spending_controls
+          @status = status
+          @type = type
+        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
+        class Pin < Stripe::RequestParams
+          # The card's desired new PIN, encrypted under Stripe's public key.
+          attr_accessor :encrypted_number
+
+          def initialize(encrypted_number: nil)
+            @encrypted_number = encrypted_number
+          end
+        end
+
+        class Shipping < 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 (e.g., street, PO Box, or company name).
+            attr_accessor :line1
+            # Address line 2 (e.g., 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
+
+          class AddressValidation < Stripe::RequestParams
+            # The address validation capabilities to use.
+            attr_accessor :mode
+
+            def initialize(mode: nil)
+              @mode = mode
+            end
+          end
+
+          class Customs < Stripe::RequestParams
+            # The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
+            attr_accessor :eori_number
+
+            def initialize(eori_number: nil)
+              @eori_number = eori_number
+            end
+          end
+          # The address that the card is shipped to.
+          attr_accessor :address
+          # Address validation settings.
+          attr_accessor :address_validation
+          # Customs information for the shipment.
+          attr_accessor :customs
+          # The name printed on the shipping label when shipping the card.
+          attr_accessor :name
+          # Phone number of the recipient of the shipment.
+          attr_accessor :phone_number
+          # Whether a signature is required for card delivery.
+          attr_accessor :require_signature
+          # Shipment service.
+          attr_accessor :service
+          # Packaging options.
+          attr_accessor :type
+
+          def initialize(
+            address: nil,
+            address_validation: nil,
+            customs: nil,
+            name: nil,
+            phone_number: nil,
+            require_signature: nil,
+            service: nil,
+            type: nil
+          )
+            @address = address
+            @address_validation = address_validation
+            @customs = customs
+            @name = name
+            @phone_number = phone_number
+            @require_signature = require_signature
+            @service = service
+            @type = type
+          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 any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).
+          attr_accessor :spending_limits
+
+          def initialize(
+            allowed_categories: nil,
+            allowed_merchant_countries: nil,
+            blocked_categories: nil,
+            blocked_merchant_countries: nil,
+            spending_limits: 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
+          end
+        end
+        # Reason why the `status` of this card is `canceled`.
+        attr_accessor :cancellation_reason
+        # 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
+        # Attribute for param field personalization_design
+        attr_accessor :personalization_design
+        # The desired new PIN for this card.
+        attr_accessor :pin
+        # Updated shipping information for the card.
+        attr_accessor :shipping
+        # Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
+        attr_accessor :spending_controls
+        # Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.
+        attr_accessor :status
+
+        def initialize(
+          cancellation_reason: nil,
+          expand: nil,
+          metadata: nil,
+          personalization_design: nil,
+          pin: nil,
+          shipping: nil,
+          spending_controls: nil,
+          status: nil
+        )
+          @cancellation_reason = cancellation_reason
+          @expand = expand
+          @metadata = metadata
+          @personalization_design = personalization_design
+          @pin = pin
+          @shipping = shipping
+          @spending_controls = spending_controls
+          @status = status
+        end
+      end
+
       # Creates an Issuing Card object.
       def create(params = {}, opts = {})
         request(