stripe 13.4.0 → 13.5.0.pre.beta.1

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

@@ -0,0 +1,84 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
+    class DisputeSettlementDetail < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.dispute_settlement_detail"
+      def self.object_name
+        "issuing.dispute_settlement_detail"
+      end
+
+      class ListParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # Select the Issuing dispute settlement details for the given settlement.
+        attr_accessor :settlement
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          settlement: nil,
+          starting_after: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @settlement = settlement
+          @starting_after = starting_after
+        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
+      # Disputed amount in the card’s currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
+      attr_reader :amount
+      # The card used to make the original transaction.
+      attr_reader :card
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The currency the original transaction was made in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+      # The ID of the linked dispute.
+      attr_reader :dispute
+      # The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
+      attr_reader :event_type
+      # Unique identifier for the object.
+      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.
+      attr_reader :livemode
+      # The card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ID of the linked card network settlement.
+      attr_reader :settlement
+
+      # Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/issuing/dispute_settlement_details",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on Issuing transactions.
+    class FraudLiabilityDebit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.fraud_liability_debit"
+      def self.object_name
+        "issuing.fraud_liability_debit"
+      end
+
+      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 Issuing Fraud Liability Debits 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
+
+        def initialize(
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        )
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+      # Debited amount. This is equal to the disputed amount and is given in the card’s currency and in the smallest currency unit.
+      attr_reader :amount
+      # ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this debit.
+      attr_reader :balance_transaction
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The currency of the debit. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+      # The ID of the linked dispute.
+      attr_reader :dispute
+      # Unique identifier for the object.
+      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.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
+      # Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/issuing/fraud_liability_debits",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -14,6 +14,291 @@ module Stripe
         "issuing.personalization_design"
       end
 
+      class CarrierText < Stripe::StripeObject
+        # The footer body text of the carrier letter.
+        attr_reader :footer_body
+        # The footer title text of the carrier letter.
+        attr_reader :footer_title
+        # The header body text of the carrier letter.
+        attr_reader :header_body
+        # The header title text of the carrier letter.
+        attr_reader :header_title
+      end
+
+      class Preferences < Stripe::StripeObject
+        # Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
+        attr_reader :is_default
+        # Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.
+        attr_reader :is_platform_default
+      end
+
+      class RejectionReasons < Stripe::StripeObject
+        # The reason(s) the card logo was rejected.
+        attr_reader :card_logo
+        # The reason(s) the carrier text was rejected.
+        attr_reader :carrier_text
+      end
+
+      class ListParams < Stripe::RequestParams
+        class Preferences < Stripe::RequestParams
+          # Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.
+          attr_accessor :is_default
+          # Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.
+          attr_accessor :is_platform_default
+
+          def initialize(is_default: nil, is_platform_default: nil)
+            @is_default = is_default
+            @is_platform_default = is_platform_default
+          end
+        end
+        # 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
+        # Only return personalization designs with the given lookup keys.
+        attr_accessor :lookup_keys
+        # Only return personalization designs with the given preferences.
+        attr_accessor :preferences
+        # 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 personalization designs with the given status.
+        attr_accessor :status
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          lookup_keys: nil,
+          preferences: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @lookup_keys = lookup_keys
+          @preferences = preferences
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class CarrierText < Stripe::RequestParams
+          # The footer body text of the carrier letter.
+          attr_accessor :footer_body
+          # The footer title text of the carrier letter.
+          attr_accessor :footer_title
+          # The header body text of the carrier letter.
+          attr_accessor :header_body
+          # The header title text of the carrier letter.
+          attr_accessor :header_title
+
+          def initialize(footer_body: nil, footer_title: nil, header_body: nil, header_title: nil)
+            @footer_body = footer_body
+            @footer_title = footer_title
+            @header_body = header_body
+            @header_title = header_title
+          end
+        end
+
+        class Preferences < Stripe::RequestParams
+          # Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
+          attr_accessor :is_default
+
+          def initialize(is_default: nil)
+            @is_default = is_default
+          end
+        end
+        # The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
+        attr_accessor :card_logo
+        # Hash containing carrier text, for use with physical bundles that support carrier text.
+        attr_accessor :carrier_text
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
+        attr_accessor :lookup_key
+        # 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
+        # Friendly display name.
+        attr_accessor :name
+        # The physical bundle object belonging to this personalization design.
+        attr_accessor :physical_bundle
+        # Information on whether this personalization design is used to create cards when one is not specified.
+        attr_accessor :preferences
+        # If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
+        attr_accessor :transfer_lookup_key
+
+        def initialize(
+          card_logo: nil,
+          carrier_text: nil,
+          expand: nil,
+          lookup_key: nil,
+          metadata: nil,
+          name: nil,
+          physical_bundle: nil,
+          preferences: nil,
+          transfer_lookup_key: nil
+        )
+          @card_logo = card_logo
+          @carrier_text = carrier_text
+          @expand = expand
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @name = name
+          @physical_bundle = physical_bundle
+          @preferences = preferences
+          @transfer_lookup_key = transfer_lookup_key
+        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 CarrierText < Stripe::RequestParams
+          # The footer body text of the carrier letter.
+          attr_accessor :footer_body
+          # The footer title text of the carrier letter.
+          attr_accessor :footer_title
+          # The header body text of the carrier letter.
+          attr_accessor :header_body
+          # The header title text of the carrier letter.
+          attr_accessor :header_title
+
+          def initialize(footer_body: nil, footer_title: nil, header_body: nil, header_title: nil)
+            @footer_body = footer_body
+            @footer_title = footer_title
+            @header_body = header_body
+            @header_title = header_title
+          end
+        end
+
+        class Preferences < Stripe::RequestParams
+          # Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
+          attr_accessor :is_default
+
+          def initialize(is_default: nil)
+            @is_default = is_default
+          end
+        end
+        # The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
+        attr_accessor :card_logo
+        # Hash containing carrier text, for use with physical bundles that support carrier text.
+        attr_accessor :carrier_text
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
+        attr_accessor :lookup_key
+        # 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
+        # Friendly display name. Providing an empty string will set the field to null.
+        attr_accessor :name
+        # The physical bundle object belonging to this personalization design.
+        attr_accessor :physical_bundle
+        # Information on whether this personalization design is used to create cards when one is not specified.
+        attr_accessor :preferences
+        # If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
+        attr_accessor :transfer_lookup_key
+
+        def initialize(
+          card_logo: nil,
+          carrier_text: nil,
+          expand: nil,
+          lookup_key: nil,
+          metadata: nil,
+          name: nil,
+          physical_bundle: nil,
+          preferences: nil,
+          transfer_lookup_key: nil
+        )
+          @card_logo = card_logo
+          @carrier_text = carrier_text
+          @expand = expand
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @name = name
+          @physical_bundle = physical_bundle
+          @preferences = preferences
+          @transfer_lookup_key = transfer_lookup_key
+        end
+      end
+
+      class ActivateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class DeactivateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class RejectParams < Stripe::RequestParams
+        class RejectionReasons < Stripe::RequestParams
+          # The reason(s) the card logo was rejected.
+          attr_accessor :card_logo
+          # The reason(s) the carrier text was rejected.
+          attr_accessor :carrier_text
+
+          def initialize(card_logo: nil, carrier_text: nil)
+            @card_logo = card_logo
+            @carrier_text = carrier_text
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The reason(s) the personalization design was rejected.
+        attr_accessor :rejection_reasons
+
+        def initialize(expand: nil, rejection_reasons: nil)
+          @expand = expand
+          @rejection_reasons = rejection_reasons
+        end
+      end
+      # The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
+      attr_reader :card_logo
+      # Hash containing carrier text, for use with physical bundles that support carrier text.
+      attr_reader :carrier_text
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Unique identifier for the object.
+      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.
+      attr_reader :livemode
+      # A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
+      attr_reader :lookup_key
+      # 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
+      # Friendly display name.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The physical bundle object belonging to this personalization design.
+      attr_reader :physical_bundle
+      # Attribute for field preferences
+      attr_reader :preferences
+      # Attribute for field rejection_reasons
+      attr_reader :rejection_reasons
+      # Whether this personalization design can be used to create cards.
+      attr_reader :status
+
       # Creates a personalization design object.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -35,10 +320,10 @@ module Stripe
       end
 
       # Updates a card personalization object.
-      def self.update(id, params = {}, opts = {})
+      def self.update(personalization_design, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/issuing/personalization_designs/%<id>s", { id: CGI.escape(id) }),
+          path: format("/v1/issuing/personalization_designs/%<personalization_design>s", { personalization_design: CGI.escape(personalization_design) }),
           params: params,
           opts: opts
         )

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

@@ -12,6 +12,69 @@ module Stripe
         "issuing.physical_bundle"
       end
 
+      class Features < Stripe::StripeObject
+        # The policy for how to use card logo images in a card design with this physical bundle.
+        attr_reader :card_logo
+        # The policy for how to use carrier letter text in a card design with this physical bundle.
+        attr_reader :carrier_text
+        # The policy for how to use a second line on a card with this physical bundle.
+        attr_reader :second_line
+      end
+
+      class ListParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+        # Only return physical bundles with the given status.
+        attr_accessor :status
+        # Only return physical bundles with the given type.
+        attr_accessor :type
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil,
+          type: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @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
+      # Attribute for field features
+      attr_reader :features
+      # Unique identifier for the object.
+      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.
+      attr_reader :livemode
+      # Friendly display name.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Whether this physical bundle can be used to create cards.
+      attr_reader :status
+      # Whether this physical bundle is a standard Stripe offering or custom-made for you.
+      attr_reader :type
+
       # 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.
       def self.list(params = {}, opts = {})
         request_stripe_object(

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

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: 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
+      OBJECT_NAME = "issuing.settlement"
+      def self.object_name
+        "issuing.settlement"
+      end
+
+      # The Bank Identification Number reflecting this settlement record.
+      attr_reader :bin
+      # The date that the transactions are cleared and posted to user's accounts.
+      attr_reader :clearing_date
+      # 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. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+      # Unique identifier for the object.
+      attr_reader :id
+      # The total interchange received as reimbursement for the transactions.
+      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.
+      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 total net amount required to settle with the network.
+      attr_reader :net_total
+      # The card network for this settlement report. One of ["visa", "maestro"]
+      attr_reader :network
+      # The total amount of fees owed to the network.
+      attr_reader :network_fees
+      # The Settlement Identification Number assigned by the network.
+      attr_reader :network_settlement_identifier
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # One of `international` or `uk_national_net`.
+      attr_reader :settlement_service
+      # The current processing status of this settlement.
+      attr_reader :status
+      # The total number of transactions reflected in this settlement.
+      attr_reader :transaction_count
+      # The total transaction amount reflected in this settlement.
+      attr_reader :transaction_volume
+    end
+  end
+end