stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/issuing/card.rb

@@ -14,6 +14,258 @@ module Stripe
         "issuing.card"
       end
 
+      class Shipping < Stripe::StripeObject
+        class Address < Stripe::StripeObject
+          # City, district, suburb, town, or village.
+          attr_reader :city
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_reader :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_reader :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_reader :line2
+          # ZIP or postal code.
+          attr_reader :postal_code
+          # State, county, province, or region.
+          attr_reader :state
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class AddressValidation < Stripe::StripeObject
+          class NormalizedAddress < Stripe::StripeObject
+            # City, district, suburb, town, or village.
+            attr_reader :city
+            # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+            attr_reader :country
+            # Address line 1, such as the street, PO Box, or company name.
+            attr_reader :line1
+            # Address line 2, such as the apartment, suite, unit, or building.
+            attr_reader :line2
+            # ZIP or postal code.
+            attr_reader :postal_code
+            # State, county, province, or region.
+            attr_reader :state
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The address validation capabilities to use.
+          attr_reader :mode
+          # The normalized shipping address.
+          attr_reader :normalized_address
+          # The validation result for the shipping address.
+          attr_reader :result
+
+          def self.inner_class_types
+            @inner_class_types = { normalized_address: NormalizedAddress }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Customs < Stripe::StripeObject
+          # A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU.
+          attr_reader :eori_number
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field address
+        attr_reader :address
+        # Address validation details for the shipment.
+        attr_reader :address_validation
+        # The delivery company that shipped a card.
+        attr_reader :carrier
+        # Additional information that may be required for clearing customs.
+        attr_reader :customs
+        # A unix timestamp representing a best estimate of when the card will be delivered.
+        attr_reader :eta
+        # Recipient name.
+        attr_reader :name
+        # The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.
+        attr_reader :phone_number
+        # Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.
+        attr_reader :require_signature
+        # Shipment service, such as `standard` or `express`.
+        attr_reader :service
+        # The delivery status of the card.
+        attr_reader :status
+        # A tracking number for a card shipment.
+        attr_reader :tracking_number
+        # A link to the shipping carrier's site where you can view detailed information about a card shipment.
+        attr_reader :tracking_url
+        # Packaging options.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            address: Address,
+            address_validation: AddressValidation,
+            customs: Customs,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class SpendingControls < Stripe::StripeObject
+        class SpendingLimit < Stripe::StripeObject
+          # Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+          attr_reader :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_reader :categories
+          # Interval (or event) to which the amount applies.
+          attr_reader :interval
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          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_reader :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_reader :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_reader :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_reader :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_reader :spending_limits
+        # Currency of the amounts within `spending_limits`. Always the same as the currency of the card.
+        attr_reader :spending_limits_currency
+
+        def self.inner_class_types
+          @inner_class_types = { spending_limits: SpendingLimit }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Wallets < Stripe::StripeObject
+        class ApplePay < Stripe::StripeObject
+          # Apple Pay Eligibility
+          attr_reader :eligible
+          # Reason the card is ineligible for Apple Pay
+          attr_reader :ineligible_reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class GooglePay < Stripe::StripeObject
+          # Google Pay Eligibility
+          attr_reader :eligible
+          # Reason the card is ineligible for Google Pay
+          attr_reader :ineligible_reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field apple_pay
+        attr_reader :apple_pay
+        # Attribute for field google_pay
+        attr_reader :google_pay
+        # Unique identifier for a card used with digital wallets
+        attr_reader :primary_account_identifier
+
+        def self.inner_class_types
+          @inner_class_types = { apple_pay: ApplePay, google_pay: GooglePay }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The brand of the card.
+      attr_reader :brand
+      # The reason why the card was canceled.
+      attr_reader :cancellation_reason
+      # An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.
+      #
+      # Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder)
+      attr_reader :cardholder
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.
+      attr_reader :currency
+      # The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
+      attr_reader :cvc
+      # The expiration month of the card.
+      attr_reader :exp_month
+      # The expiration year of the card.
+      attr_reader :exp_year
+      # The financial account this card is attached to.
+      attr_reader :financial_account
+      # Unique identifier for the object.
+      attr_reader :id
+      # The last 4 digits of the card number.
+      attr_reader :last4
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # 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.
+      attr_reader :metadata
+      # The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
+      attr_reader :number
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The personalization design object belonging to this card.
+      attr_reader :personalization_design
+      # The latest card that replaces this card, if any.
+      attr_reader :replaced_by
+      # The card this card replaces, if any.
+      attr_reader :replacement_for
+      # The reason why the previous card needed to be replaced.
+      attr_reader :replacement_reason
+      # Text separate from cardholder name, printed on the card.
+      attr_reader :second_line
+      # Where and how the card will be shipped.
+      attr_reader :shipping
+      # Attribute for field spending_controls
+      attr_reader :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_reader :status
+      # The type of the card.
+      attr_reader :type
+      # Information relating to digital wallets (like Apple Pay and Google Pay).
+      attr_reader :wallets
+
       # Creates an Issuing Card object.
       def self.create(params = {}, opts = {})
         request_stripe_object(method: :post, path: "/v1/issuing/cards", params: params, opts: opts)
@@ -144,6 +396,18 @@ module Stripe
           )
         end
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          shipping: Shipping,
+          spending_controls: SpendingControls,
+          wallets: Wallets,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

data/lib/stripe/resources/issuing/cardholder.rb

@@ -16,6 +16,234 @@ module Stripe
         "issuing.cardholder"
       end
 
+      class Billing < Stripe::StripeObject
+        class Address < Stripe::StripeObject
+          # City, district, suburb, town, or village.
+          attr_reader :city
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_reader :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_reader :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_reader :line2
+          # ZIP or postal code.
+          attr_reader :postal_code
+          # State, county, province, or region.
+          attr_reader :state
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field address
+        attr_reader :address
+
+        def self.inner_class_types
+          @inner_class_types = { address: Address }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Company < Stripe::StripeObject
+        # Whether the company's business ID number was provided.
+        attr_reader :tax_id_provided
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Individual < Stripe::StripeObject
+        class CardIssuing < Stripe::StripeObject
+          class UserTermsAcceptance < Stripe::StripeObject
+            # The Unix timestamp marking when the cardholder accepted the Authorized User Terms.
+            attr_reader :date
+            # The IP address from which the cardholder accepted the Authorized User Terms.
+            attr_reader :ip
+            # The user agent of the browser from which the cardholder accepted the Authorized User Terms.
+            attr_reader :user_agent
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            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_reader :user_terms_acceptance
+
+          def self.inner_class_types
+            @inner_class_types = { user_terms_acceptance: UserTermsAcceptance }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Dob < Stripe::StripeObject
+          # The day of birth, between 1 and 31.
+          attr_reader :day
+          # The month of birth, between 1 and 12.
+          attr_reader :month
+          # The four-digit year of birth.
+          attr_reader :year
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Verification < Stripe::StripeObject
+          class Document < Stripe::StripeObject
+            # The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
+            attr_reader :back
+            # The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
+            attr_reader :front
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # An identifying document, either a passport or local ID card.
+          attr_reader :document
+
+          def self.inner_class_types
+            @inner_class_types = { document: Document }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Information related to the card_issuing program for this cardholder.
+        attr_reader :card_issuing
+        # The date of birth of this cardholder.
+        attr_reader :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_reader :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_reader :last_name
+        # Government-issued ID document for this cardholder.
+        attr_reader :verification
+
+        def self.inner_class_types
+          @inner_class_types = { card_issuing: CardIssuing, dob: Dob, verification: Verification }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Requirements < Stripe::StripeObject
+        # If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason.
+        attr_reader :disabled_reason
+        # Array of fields that need to be collected in order to verify and re-enable the cardholder.
+        attr_reader :past_due
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class SpendingControls < Stripe::StripeObject
+        class SpendingLimit < Stripe::StripeObject
+          # Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+          attr_reader :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_reader :categories
+          # Interval (or event) to which the amount applies.
+          attr_reader :interval
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          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_reader :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_reader :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_reader :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_reader :blocked_merchant_countries
+        # Limit spending with amount-based rules that apply across this cardholder's cards.
+        attr_reader :spending_limits
+        # Currency of the amounts within `spending_limits`.
+        attr_reader :spending_limits_currency
+
+        def self.inner_class_types
+          @inner_class_types = { spending_limits: SpendingLimit }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field billing
+      attr_reader :billing
+      # Additional information about a `company` cardholder.
+      attr_reader :company
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The cardholder's email address.
+      attr_reader :email
+      # Unique identifier for the object.
+      attr_reader :id
+      # Additional information about an `individual` cardholder.
+      attr_reader :individual
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # 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.
+      attr_reader :metadata
+      # The cardholder's name. This will be printed on cards issued to them.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # 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#when-is-3d-secure-applied) for more details.
+      attr_reader :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_reader :preferred_locales
+      # Attribute for field requirements
+      attr_reader :requirements
+      # 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_reader :spending_controls
+      # Specifies whether to permit authorizations on this cardholder's cards.
+      attr_reader :status
+      # One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.
+      attr_reader :type
+
       # Creates a new Issuing Cardholder object that can be issued cards.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -45,6 +273,20 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          billing: Billing,
+          company: Company,
+          individual: Individual,
+          requirements: Requirements,
+          spending_controls: SpendingControls,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end