stripe 5.55.0 → 18.2.0.pre.beta.1

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

@@ -3,23 +3,322 @@
 
 module Stripe
   module Issuing
+    # As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
+    #
+    # Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes)
     class Dispute < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "issuing.dispute"
+      def self.object_name
+        "issuing.dispute"
+      end
+
+      class Evidence < ::Stripe::StripeObject
+        class Canceled < ::Stripe::StripeObject
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_reader :additional_documentation
+          # Date when order was canceled.
+          attr_reader :canceled_at
+          # Whether the cardholder was provided with a cancellation policy.
+          attr_reader :cancellation_policy_provided
+          # Reason for canceling the order.
+          attr_reader :cancellation_reason
+          # Date when the cardholder expected to receive the product.
+          attr_reader :expected_at
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_reader :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_reader :product_description
+          # Whether the product was a merchandise or service.
+          attr_reader :product_type
+          # Result of cardholder's attempt to return the product.
+          attr_reader :return_status
+          # Date when the product was returned or attempted to be returned.
+          attr_reader :returned_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Duplicate < ::Stripe::StripeObject
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_reader :additional_documentation
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
+          attr_reader :card_statement
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
+          attr_reader :cash_receipt
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
+          attr_reader :check_image
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_reader :explanation
+          # Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
+          attr_reader :original_transaction
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Fraudulent < ::Stripe::StripeObject
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_reader :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_reader :explanation
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class MerchandiseNotAsDescribed < ::Stripe::StripeObject
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_reader :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_reader :explanation
+          # Date when the product was received.
+          attr_reader :received_at
+          # Description of the cardholder's attempt to return the product.
+          attr_reader :return_description
+          # Result of cardholder's attempt to return the product.
+          attr_reader :return_status
+          # Date when the product was returned or attempted to be returned.
+          attr_reader :returned_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class NoValidAuthorization < ::Stripe::StripeObject
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_reader :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_reader :explanation
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class NotReceived < ::Stripe::StripeObject
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_reader :additional_documentation
+          # Date when the cardholder expected to receive the product.
+          attr_reader :expected_at
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_reader :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_reader :product_description
+          # Whether the product was a merchandise or service.
+          attr_reader :product_type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Other < ::Stripe::StripeObject
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_reader :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_reader :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_reader :product_description
+          # Whether the product was a merchandise or service.
+          attr_reader :product_type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class ServiceNotAsDescribed < ::Stripe::StripeObject
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_reader :additional_documentation
+          # Date when order was canceled.
+          attr_reader :canceled_at
+          # Reason for canceling the order.
+          attr_reader :cancellation_reason
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_reader :explanation
+          # Date when the product was received.
+          attr_reader :received_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field canceled
+        attr_reader :canceled
+        # Attribute for field duplicate
+        attr_reader :duplicate
+        # Attribute for field fraudulent
+        attr_reader :fraudulent
+        # Attribute for field merchandise_not_as_described
+        attr_reader :merchandise_not_as_described
+        # Attribute for field no_valid_authorization
+        attr_reader :no_valid_authorization
+        # Attribute for field not_received
+        attr_reader :not_received
+        # Attribute for field other
+        attr_reader :other
+        # The reason for filing the dispute. Its value will match the field containing the evidence.
+        attr_reader :reason
+        # Attribute for field service_not_as_described
+        attr_reader :service_not_as_described
+
+        def self.inner_class_types
+          @inner_class_types = {
+            canceled: Canceled,
+            duplicate: Duplicate,
+            fraudulent: Fraudulent,
+            merchandise_not_as_described: MerchandiseNotAsDescribed,
+            no_valid_authorization: NoValidAuthorization,
+            not_received: NotReceived,
+            other: Other,
+            service_not_as_described: ServiceNotAsDescribed,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Treasury < ::Stripe::StripeObject
+        # The Treasury [DebitReversal](https://docs.stripe.com/api/treasury/debit_reversals) representing this Issuing dispute
+        attr_reader :debit_reversal
+        # The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) that is being disputed.
+        attr_reader :received_debit
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).
+      attr_reader :amount
+      # List of balance transactions associated with the dispute.
+      attr_reader :balance_transactions
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The currency the `transaction` was made in.
+      attr_reader :currency
+      # Attribute for field evidence
+      attr_reader :evidence
+      # 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 enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.
+      attr_reader :loss_reason
+      # Set of [key-value pairs](https://docs.stripe.com/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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Current status of the dispute.
+      attr_reader :status
+      # The transaction being disputed.
+      attr_reader :transaction
+      # [Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
+      attr_reader :treasury
+
+      # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/issuing/disputes",
+          params: params,
+          opts: opts
+        )
+      end
 
-      custom_method :submit, http_verb: :post
+      # Returns a list of Issuing Dispute 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/disputes",
+          params: params,
+          opts: opts
+        )
+      end
 
+      # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
       def submit(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/submit",
+          path: format("/v1/issuing/disputes/%<dispute>s/submit", { dispute: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
+
+      # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
+      def self.submit(dispute, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/disputes/%<dispute>s/submit", { dispute: CGI.escape(dispute) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.
+      def self.update(dispute, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/disputes/%<dispute>s", { dispute: CGI.escape(dispute) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { evidence: Evidence, treasury: Treasury }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -0,0 +1,71 @@
+# 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 NetworkData < ::Stripe::StripeObject
+        # The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
+        attr_reader :processing_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        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
+      # Details about the transaction, such as processing dates, set by the card network.
+      attr_reader :network_data
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = { network_data: NetworkData }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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
+
+      # 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://docs.stripe.com/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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,206 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
+    class PersonalizationDesign < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "issuing.personalization_design"
+      def self.object_name
+        "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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        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://docs.stripe.com/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(
+          method: :post,
+          path: "/v1/issuing/personalization_designs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of personalization design 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/personalization_designs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a card personalization object.
+      def self.update(personalization_design, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/personalization_designs/%<personalization_design>s", { personalization_design: CGI.escape(personalization_design) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = PersonalizationDesign
+        def self.resource_class
+          "PersonalizationDesign"
+        end
+
+        # Updates the status of the specified testmode personalization design object to active.
+        def self.activate(personalization_design, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/activate", { personalization_design: CGI.escape(personalization_design) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Updates the status of the specified testmode personalization design object to active.
+        def activate(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/activate", { personalization_design: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Updates the status of the specified testmode personalization design object to inactive.
+        def self.deactivate(personalization_design, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/deactivate", { personalization_design: CGI.escape(personalization_design) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Updates the status of the specified testmode personalization design object to inactive.
+        def deactivate(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/deactivate", { personalization_design: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Updates the status of the specified testmode personalization design object to rejected.
+        def self.reject(personalization_design, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/reject", { personalization_design: CGI.escape(personalization_design) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Updates the status of the specified testmode personalization design object to rejected.
+        def reject(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/reject", { personalization_design: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          carrier_text: CarrierText,
+          preferences: Preferences,
+          rejection_reasons: RejectionReasons,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end