stripe 13.3.0 → 13.4.0.pre.beta.1

data/rbi/stripe/resources/issuing/physical_bundle.rbi

@@ -0,0 +1,102 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Issuing
+    # A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
+    class PhysicalBundle < APIResource
+      class Features < Stripe::StripeObject
+        # The policy for how to use card logo images in a card design with this physical bundle.
+        sig { returns(String) }
+        attr_reader :card_logo
+
+        # The policy for how to use carrier letter text in a card design with this physical bundle.
+        sig { returns(String) }
+        attr_reader :carrier_text
+
+        # The policy for how to use a second line on a card with this physical bundle.
+        sig { returns(String) }
+        attr_reader :second_line
+      end
+      # Attribute for field features
+      sig { returns(Features) }
+      attr_reader :features
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_reader :id
+
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+
+      # Friendly display name.
+      sig { returns(String) }
+      attr_reader :name
+
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+
+      # Whether this physical bundle can be used to create cards.
+      sig { returns(String) }
+      attr_reader :status
+
+      # Whether this physical bundle is a standard Stripe offering or custom-made for you.
+      sig { returns(String) }
+      attr_reader :type
+
+      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.
+        sig { returns(String) }
+        attr_accessor :ending_before
+
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        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.
+        sig { returns(Integer) }
+        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.
+        sig { returns(String) }
+        attr_accessor :starting_after
+
+        # Only return physical bundles with the given status.
+        sig { returns(String) }
+        attr_accessor :status
+
+        # Only return physical bundles with the given type.
+        sig { returns(String) }
+        attr_accessor :type
+
+        sig {
+          params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, status: String, type: String).void
+         }
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil,
+          type: nil
+        ); end
+      end
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+      # Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      sig {
+        params(params: T.any(::Stripe::Issuing::PhysicalBundle::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/resources/issuing/settlement.rbi

@@ -0,0 +1,78 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Issuing
+    # When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
+    class Settlement < APIResource
+      # The Bank Identification Number reflecting this settlement record.
+      sig { returns(String) }
+      attr_reader :bin
+
+      # The date that the transactions are cleared and posted to user's accounts.
+      sig { returns(Integer) }
+      attr_reader :clearing_date
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      sig { returns(Integer) }
+      attr_reader :created
+
+      # 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).
+      sig { returns(String) }
+      attr_reader :currency
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_reader :id
+
+      # The total interchange received as reimbursement for the transactions.
+      sig { returns(Integer) }
+      attr_reader :interchange_fees
+
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      sig { returns(T::Boolean) }
+      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.
+      sig { returns(T::Hash[String, String]) }
+      attr_reader :metadata
+
+      # The total net amount required to settle with the network.
+      sig { returns(Integer) }
+      attr_reader :net_total
+
+      # The card network for this settlement report. One of ["visa", "maestro"]
+      sig { returns(String) }
+      attr_reader :network
+
+      # The total amount of fees owed to the network.
+      sig { returns(Integer) }
+      attr_reader :network_fees
+
+      # The Settlement Identification Number assigned by the network.
+      sig { returns(String) }
+      attr_reader :network_settlement_identifier
+
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+
+      # One of `international` or `uk_national_net`.
+      sig { returns(String) }
+      attr_reader :settlement_service
+
+      # The current processing status of this settlement.
+      sig { returns(String) }
+      attr_reader :status
+
+      # The total number of transactions reflected in this settlement.
+      sig { returns(Integer) }
+      attr_reader :transaction_count
+
+      # The total transaction amount reflected in this settlement.
+      sig { returns(Integer) }
+      attr_reader :transaction_volume
+    end
+  end
+end

data/rbi/stripe/resources/issuing/token.rbi

@@ -0,0 +1,282 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Issuing
+    # An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.
+    class Token < APIResource
+      class NetworkData < Stripe::StripeObject
+        class Device < Stripe::StripeObject
+          # An obfuscated ID derived from the device ID.
+          sig { returns(String) }
+          attr_reader :device_fingerprint
+
+          # The IP address of the device at provisioning time.
+          sig { returns(String) }
+          attr_reader :ip_address
+
+          # The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.
+          sig { returns(String) }
+          attr_reader :location
+
+          # The name of the device used for tokenization.
+          sig { returns(String) }
+          attr_reader :name
+
+          # The phone number of the device used for tokenization.
+          sig { returns(String) }
+          attr_reader :phone_number
+
+          # The type of device used for tokenization.
+          sig { returns(String) }
+          attr_reader :type
+        end
+        class Mastercard < Stripe::StripeObject
+          # A unique reference ID from MasterCard to represent the card account number.
+          sig { returns(String) }
+          attr_reader :card_reference_id
+
+          # The network-unique identifier for the token.
+          sig { returns(String) }
+          attr_reader :token_reference_id
+
+          # The ID of the entity requesting tokenization, specific to MasterCard.
+          sig { returns(String) }
+          attr_reader :token_requestor_id
+
+          # The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.
+          sig { returns(String) }
+          attr_reader :token_requestor_name
+        end
+        class Visa < Stripe::StripeObject
+          # A unique reference ID from Visa to represent the card account number.
+          sig { returns(String) }
+          attr_reader :card_reference_id
+
+          # The network-unique identifier for the token.
+          sig { returns(String) }
+          attr_reader :token_reference_id
+
+          # The ID of the entity requesting tokenization, specific to Visa.
+          sig { returns(String) }
+          attr_reader :token_requestor_id
+
+          # Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa.
+          sig { returns(String) }
+          attr_reader :token_risk_score
+        end
+        class WalletProvider < Stripe::StripeObject
+          class CardholderAddress < Stripe::StripeObject
+            # The street address of the cardholder tokenizing the card.
+            sig { returns(String) }
+            attr_reader :line1
+
+            # The postal code of the cardholder tokenizing the card.
+            sig { returns(String) }
+            attr_reader :postal_code
+          end
+          # The wallet provider-given account ID of the digital wallet the token belongs to.
+          sig { returns(String) }
+          attr_reader :account_id
+
+          # An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.
+          sig { returns(Integer) }
+          attr_reader :account_trust_score
+
+          # The method used for tokenizing a card.
+          sig { returns(String) }
+          attr_reader :card_number_source
+
+          # Attribute for field cardholder_address
+          sig { returns(CardholderAddress) }
+          attr_reader :cardholder_address
+
+          # The name of the cardholder tokenizing the card.
+          sig { returns(String) }
+          attr_reader :cardholder_name
+
+          # An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.
+          sig { returns(Integer) }
+          attr_reader :device_trust_score
+
+          # The hashed email address of the cardholder's account with the wallet provider.
+          sig { returns(String) }
+          attr_reader :hashed_account_email_address
+
+          # The reasons for suggested tokenization given by the card network.
+          sig { returns(T::Array[String]) }
+          attr_reader :reason_codes
+
+          # The recommendation on responding to the tokenization request.
+          sig { returns(String) }
+          attr_reader :suggested_decision
+
+          # The version of the standard for mapping reason codes followed by the wallet provider.
+          sig { returns(String) }
+          attr_reader :suggested_decision_version
+        end
+        # Attribute for field device
+        sig { returns(Device) }
+        attr_reader :device
+
+        # Attribute for field mastercard
+        sig { returns(Mastercard) }
+        attr_reader :mastercard
+
+        # The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.
+        sig { returns(String) }
+        attr_reader :type
+
+        # Attribute for field visa
+        sig { returns(Visa) }
+        attr_reader :visa
+
+        # Attribute for field wallet_provider
+        sig { returns(WalletProvider) }
+        attr_reader :wallet_provider
+      end
+      # Card associated with this token.
+      sig { returns(T.any(String, Stripe::Issuing::Card)) }
+      attr_reader :card
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      sig { returns(Integer) }
+      attr_reader :created
+
+      # The hashed ID derived from the device ID from the card network associated with the token.
+      sig { returns(T.nilable(String)) }
+      attr_reader :device_fingerprint
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_reader :id
+
+      # The last four digits of the token.
+      sig { returns(String) }
+      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.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+
+      # The token service provider / card network associated with the token.
+      sig { returns(String) }
+      attr_reader :network
+
+      # Attribute for field network_data
+      sig { returns(NetworkData) }
+      attr_reader :network_data
+
+      # Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.
+      sig { returns(Integer) }
+      attr_reader :network_updated_at
+
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+
+      # The usage state of the token.
+      sig { returns(String) }
+      attr_reader :status
+
+      # The digital wallet for this token, if one was used.
+      sig { returns(String) }
+      attr_reader :wallet_provider
+
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :gt
+
+          # Minimum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :gte
+
+          # Maximum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :lt
+
+          # Maximum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :lte
+
+          sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+        end
+        # The Issuing card identifier to list tokens for.
+        sig { returns(String) }
+        attr_accessor :card
+
+        # Only return Issuing tokens that were created during the given date interval.
+        sig { returns(T.any(::Stripe::Issuing::Token::ListParams::Created, Integer)) }
+        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.
+        sig { returns(String) }
+        attr_accessor :ending_before
+
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        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.
+        sig { returns(Integer) }
+        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.
+        sig { returns(String) }
+        attr_accessor :starting_after
+
+        # Select Issuing tokens with the given status.
+        sig { returns(String) }
+        attr_accessor :status
+
+        sig {
+          params(card: String, created: T.any(::Stripe::Issuing::Token::ListParams::Created, Integer), ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, status: String).void
+         }
+        def initialize(
+          card: nil,
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil
+        ); end
+      end
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+      class UpdateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+
+        # Specifies which status the token should be updated to.
+        sig { returns(String) }
+        attr_accessor :status
+
+        sig { params(expand: T::Array[String], status: String).void }
+        def initialize(expand: nil, status: nil); end
+      end
+      # Lists all Issuing Token objects for a given card.
+      sig {
+        params(params: T.any(::Stripe::Issuing::Token::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+
+      # Attempts to update the specified Issuing Token object to the status specified.
+      sig {
+        params(id: String, params: T.any(::Stripe::Issuing::Token::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Token)
+       }
+      def self.update(id, params = {}, opts = {}); end
+    end
+  end
+end