straddle 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6434af7d317097aa21f1993bcbfffc0df3661c98722719304c4a375a02bfeffc
-  data.tar.gz: b5a7f9eec6c595ab6b5406d9140f0c3b803ea93d7ed34c7ffe84a450e4fc0ce8
+  metadata.gz: c565d8666792b9e9e15e8037302268c3be6544daa5c3e230411d2c835e0e82ff
+  data.tar.gz: 721c8b3563e20f209e8bebdb74bb3c50a7b230c82f9eca7e4699827d8c0906a8
 SHA512:
-  metadata.gz: 4c109c641b80e7e87fc6f7002e06a61ca536eb674798c73afdc99ed21cc83d0015000078e88c93e39620f004ff289a4b06725301d1f0ed481a422c9d4a344e10
-  data.tar.gz: ce0ef51d8928bd78ce2a2dbafdf99cef9f22d2bd1be75095ece27a58fb125554ae3e41255215fa77cbfb9de64b1b43b75e9fc3e44e9554290f6d50230aac1389
+  metadata.gz: 06a0293faaecfa000fd3af9a8f58695c57632560055a8dda0ffa15a35d3407240b29e5f6a5a6eed792aded8594988e06c143d881caa7a7896f33aa321c4378f8
+  data.tar.gz: 7b852b929d99776ba583e670adb08e5ddcfe4c418110659a38298be600b14d8a9b87d964b1eb9c6b75b6d0ee2d560a638c9cae00eeeff20d59436e8e326ad5d3

data/CHANGELOG.md

@@ -1,5 +1,58 @@
 # Changelog
 
+## 0.5.0 (2026-08-20)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/straddleio/straddle-ruby/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **docs:** Preliminary update to SDK Spec ([e7b29ac](https://github.com/straddleio/straddle-ruby/commit/e7b29ac6f7e7f724df5efe7363b660e8f9a89cfa))
+* **docs:** Preliminary update to SDK Spec ([ed5e050](https://github.com/straddleio/straddle-ruby/commit/ed5e05094ff6f4a235ef5391e2f703fb407f6d3b))
+* **docs:** Preliminary update to SDK Spec ([7c0bb4e](https://github.com/straddleio/straddle-ruby/commit/7c0bb4ef05b1a44561b64fb5a79c630872749059))
+* **docs:** Preliminary update to SDK Spec ([7002bf6](https://github.com/straddleio/straddle-ruby/commit/7002bf6fac839b1dc36efb16dd314de81233989d))
+* **docs:** Preliminary update to SDK Spec ([c47e7c8](https://github.com/straddleio/straddle-ruby/commit/c47e7c8b792f4ad29d58c0de1ed0b0b798387bb1))
+* **docs:** Preliminary update to SDK Spec ([26c3cb7](https://github.com/straddleio/straddle-ruby/commit/26c3cb7493ee9dbfc74d6ca50957ec389e17b6e3))
+* **docs:** Preliminary update to SDK Spec ([e0cc45e](https://github.com/straddleio/straddle-ruby/commit/e0cc45ee2fa2e92222c197a5f623c4646db4a150))
+* **docs:** Preliminary update to SDK Spec ([f6ff7e9](https://github.com/straddleio/straddle-ruby/commit/f6ff7e965acc866271017a12571d9cd9cbe3555e))
+* **docs:** Preliminary update to SDK Spec ([069900e](https://github.com/straddleio/straddle-ruby/commit/069900e9afbc11761aaaba9bf2da9ca483eb91b9))
+* **docs:** Preliminary update to SDK Spec ([b75c086](https://github.com/straddleio/straddle-ruby/commit/b75c08610abfb58987d3e4f967e86fec6d0858f1))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([a22c44c](https://github.com/straddleio/straddle-ruby/commit/a22c44c216033b0e7139e2a7a145aff4306f5aab))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([288cb36](https://github.com/straddleio/straddle-ruby/commit/288cb36bc01644ad79b36a74a51bca05823e601d))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([2054d2d](https://github.com/straddleio/straddle-ruby/commit/2054d2d6013b2a5e9590b9c367691940dad6a35a))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([00ed553](https://github.com/straddleio/straddle-ruby/commit/00ed5533f68d5a5544bdad919cad27f4c7cffcd1))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([7002e3b](https://github.com/straddleio/straddle-ruby/commit/7002e3b61de10383548251a079dee909e012b5d7))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([400fba0](https://github.com/straddleio/straddle-ruby/commit/400fba0874ab2c2cab4f5c563c70c1b5133a8d9c))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([0b6a3e6](https://github.com/straddleio/straddle-ruby/commit/0b6a3e62ce018a034b1a22f52be0c541d9db8aa6))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([1a6840c](https://github.com/straddleio/straddle-ruby/commit/1a6840c843dba1f817dcbac2b224536ae69810cb))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([c9e050b](https://github.com/straddleio/straddle-ruby/commit/c9e050b1e63ae60c5946bcd96523fdc9101529ef))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([dc39609](https://github.com/straddleio/straddle-ruby/commit/dc39609d6658b6e2c137047eaa07d09e03fe3bbe))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([efed5dd](https://github.com/straddleio/straddle-ruby/commit/efed5ddd1f6b99bf5eddaf61e169682c1dd6eee9))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([977268e](https://github.com/straddleio/straddle-ruby/commit/977268e0e20e577961ab293ef45742e6b1f225aa))
+* **docs:** Release Updates to SDK based on Open API Spec (Final) ([0ffc081](https://github.com/straddleio/straddle-ruby/commit/0ffc081971f6bb4097bc432c2851064842a31d78))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([8510658](https://github.com/straddleio/straddle-ruby/commit/85106582fe5e52651f06179d95406fdfbe01514e))
+* support setting headers via env ([1035a65](https://github.com/straddleio/straddle-ruby/commit/1035a65355f65811ae5a5e93ef3fb8fed7d64061))
+
+
+### Bug Fixes
+
+* align path encoding with RFC 3986 section 3.3 ([a1c1ca0](https://github.com/straddleio/straddle-ruby/commit/a1c1ca05b98340a96927e521646b98ec7127c388))
+* **client:** elide content type header on requests without body ([f8b0052](https://github.com/straddleio/straddle-ruby/commit/f8b0052437d42a064e2f99eb3369d83253bd0020))
+* **client:** send content-type header for requests with an omitted optional body ([c7d6ae5](https://github.com/straddleio/straddle-ruby/commit/c7d6ae5c76e1688bf57b094759c95d5f99c3d993))
+* **internal:** correct multipart form field name encoding ([c3fe8ba](https://github.com/straddleio/straddle-ruby/commit/c3fe8baca80d691689f17cf3ff465094bfe86fd9))
+* multipart encoding for file arrays ([b45ee2f](https://github.com/straddleio/straddle-ruby/commit/b45ee2ff796e02cc8f2386219fb6d7c2716cd03a))
+* variable name typo ([3840f23](https://github.com/straddleio/straddle-ruby/commit/3840f23f47dead5d75012c9071a06b1a33dc92ec))
+
+
+### Chores
+
+* **ci:** support opting out of skipping builds on metadata-only commits ([d92ad12](https://github.com/straddleio/straddle-ruby/commit/d92ad12b3d78aa92e5aeba1c39d12bfc7917420b))
+* **internal:** allow the mock server port to be set with STAINLESS_MOCK_PORT ([c45511c](https://github.com/straddleio/straddle-ruby/commit/c45511c71f985869840a1f41a178e759ee6038d4))
+* **internal:** bound formatter parallelism to CPU count ([6434980](https://github.com/straddleio/straddle-ruby/commit/64349804ab8b9ad6263e156c7007136dda591c4c))
+* **internal:** more robust bootstrap script ([1a07668](https://github.com/straddleio/straddle-ruby/commit/1a076684b8e059d19bc70380ac4ffc7719fa8b61))
+* **tests:** bump steady to v0.20.1 ([b415e2c](https://github.com/straddleio/straddle-ruby/commit/b415e2c8779f8fefb4190303d42e624ce7d32b7d))
+* **tests:** bump steady to v0.20.2 ([0b8bd79](https://github.com/straddleio/straddle-ruby/commit/0b8bd793d05c72366b45bbeee667897d0675bf45))
+* **tests:** bump steady to v0.22.1 ([acfadaa](https://github.com/straddleio/straddle-ruby/commit/acfadaaf986ebd3eca6851eee5617345e061865c))
+
 ## 0.4.0 (2026-03-25)
 
 Full Changelog: [v0.3.0...v0.4.0](https://github.com/straddleio/straddle-ruby/compare/v0.3.0...v0.4.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "straddle", "~> 0.4.0"
+gem "straddle", "~> 0.5.0"
 ```
 
 <!-- x-release-please-end -->
@@ -85,6 +85,28 @@ if page.next_page?
 end
 ```
 
+### File uploads
+
+Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
+
+```ruby
+require "pathname"
+
+# Use `Pathname` to send the filename and/or avoid paging a large file into memory:
+payout_v1 = straddle.payouts.upload_authorization_document(file: Pathname("/path/to/file"))
+
+# Alternatively, pass file contents or a `StringIO` directly:
+payout_v1 = straddle.payouts.upload_authorization_document(file: File.read("/path/to/file"))
+
+# Or, to control the filename and/or content type:
+File = Straddle::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")
+payout_v1 = straddle.payouts.upload_authorization_document(file: File)
+
+puts(payout_v1.data)
+```
+
+Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
+
 ### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Straddle::Errors::APIError` will be thrown:

data/lib/straddle/client.rb

@@ -135,6 +135,19 @@ module Straddle
         raise ArgumentError.new("api_key is required, and can be set via environ: \"STRADDLE_API_KEY\"")
       end
 
+      headers = {}
+      custom_headers_env = ENV["STRADDLE_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_key = api_key.to_s
 
       super(
@@ -142,7 +155,8 @@ module Straddle
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @embed = Straddle::Resources::Embed.new(client: self)

data/lib/straddle/internal/transport/base_client.rb

@@ -306,6 +306,11 @@ module Straddle
               Straddle::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          # Generated methods always pass `req[:body]` for operations that define a
+          # request body, so only elide the content-type header when the operation
+          # has no body at all, not when an optional body param was omitted.
+          headers.delete("content-type") if body.nil? && !req.key?(:body)
+
           url = Straddle::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

data/lib/straddle/internal/util.rb

@@ -157,7 +157,7 @@ module Straddle
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{Straddle::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{Straddle::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module Straddle
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module Straddle
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(Straddle::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module Straddle
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -571,16 +585,15 @@ module Straddle
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in Straddle::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -597,6 +610,7 @@ module Straddle
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -606,7 +620,7 @@ module Straddle
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || Straddle::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -622,6 +636,7 @@ module Straddle
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/straddle/models/charge_create_params.rb

@@ -190,6 +190,8 @@ module Straddle
           REVERSED_CUSTOMER_DISPUTE = :reversed_customer_dispute
           FAILED_CLOSED_BANK_ACCOUNT = :failed_closed_bank_account
           REVERSED_CLOSED_BANK_ACCOUNT = :reversed_closed_bank_account
+          FAILED_NOT_AUTHORIZED = :failed_not_authorized
+          REVERSED_NOT_AUTHORIZED = :reversed_not_authorized
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/straddle/models/charge_unmask_response.rb

@@ -100,6 +100,24 @@ module Straddle
         #   @return [Array<String>]
         required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
 
+        # @!attribute has_refund
+        #   Has the charge been refunded by an associated payout.
+        #
+        #   @return [Boolean]
+        required :has_refund, Straddle::Internal::Type::Boolean
+
+        # @!attribute has_resubmit
+        #   Has the charge been resubmitted.
+        #
+        #   @return [Boolean]
+        required :has_resubmit, Straddle::Internal::Type::Boolean
+
+        # @!attribute is_resubmit
+        #   Is the charge a resubmit of an original charge.
+        #
+        #   @return [Boolean]
+        required :is_resubmit, Straddle::Internal::Type::Boolean
+
         # @!attribute paykey
         #   Paykey.
         #
@@ -148,6 +166,15 @@ module Straddle
         #   @return [Straddle::Models::CustomerDetailsV1, nil]
         optional :customer_details, -> { Straddle::CustomerDetailsV1 }
 
+        # @!attribute documents
+        #   Documents uploaded for this charge (e.g. proof of authorization), in the order
+        #   they were uploaded.
+        #
+        #   @return [Array<Straddle::Models::ChargeUnmaskResponse::Data::Document>, nil]
+        optional :documents,
+                 -> { Straddle::Internal::Type::ArrayOf[Straddle::Models::ChargeUnmaskResponse::Data::Document] },
+                 nil?: true
+
         # @!attribute effective_at
         #   Effective at.
         #
@@ -180,12 +207,12 @@ module Straddle
         # @!attribute related_payments
         #   Related payments.
         #
-        #   @return [Hash{Symbol=>Symbol, Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment}, nil]
+        #   @return [Array<Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment>, nil]
         optional :related_payments,
-                 -> { Straddle::Internal::Type::HashOf[enum: Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment] },
+                 -> { Straddle::Internal::Type::ArrayOf[Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment] },
                  nil?: true
 
-        # @!method initialize(id:, amount:, config:, consent_type:, created_at:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, updated_at:, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil)
+        # @!method initialize(id:, amount:, config:, consent_type:, created_at:, currency:, description:, device:, external_id:, funding_ids:, has_refund:, has_resubmit:, is_resubmit:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, updated_at:, customer_details: nil, documents: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::ChargeUnmaskResponse::Data} for more details.
         #
@@ -209,6 +236,12 @@ module Straddle
         #
         #   @param funding_ids [Array<String>] Funding Ids
         #
+        #   @param has_refund [Boolean] Has the charge been refunded by an associated payout.
+        #
+        #   @param has_resubmit [Boolean] Has the charge been resubmitted.
+        #
+        #   @param is_resubmit [Boolean] Is the charge a resubmit of an original charge.
+        #
         #   @param paykey [String] Paykey.
         #
         #   @param payment_date [Date] Payment date.
@@ -225,6 +258,8 @@ module Straddle
         #
         #   @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the charge or payout.
         #
+        #   @param documents [Array<Straddle::Models::ChargeUnmaskResponse::Data::Document>, nil] Documents uploaded for this charge (e.g. proof of authorization), in the order t
+        #
         #   @param effective_at [Time, nil] Effective at.
         #
         #   @param metadata [Hash{Symbol=>String}, nil] Metadata.
@@ -235,7 +270,7 @@ module Straddle
         #
         #   @param processed_at [Time, nil] Processed at.
         #
-        #   @param related_payments [Hash{Symbol=>Symbol, Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment}, nil] Related payments.
+        #   @param related_payments [Array<Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment>, nil] Related payments.
 
         # @see Straddle::Models::ChargeUnmaskResponse::Data#config
         class Config < Straddle::Internal::Type::BaseModel
@@ -304,6 +339,8 @@ module Straddle
             REVERSED_CUSTOMER_DISPUTE = :reversed_customer_dispute
             FAILED_CLOSED_BANK_ACCOUNT = :failed_closed_bank_account
             REVERSED_CLOSED_BANK_ACCOUNT = :reversed_closed_bank_account
+            FAILED_NOT_AUTHORIZED = :failed_not_authorized
+            REVERSED_NOT_AUTHORIZED = :reversed_not_authorized
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -490,6 +527,58 @@ module Straddle
           end
         end
 
+        class Document < Straddle::Internal::Type::BaseModel
+          # @!attribute document_id
+          #   Unique identifier for this document.
+          #
+          #   @return [String]
+          required :document_id, String
+
+          # @!attribute document_name
+          #   The file name of this document as uploaded.
+          #
+          #   @return [String]
+          required :document_name, String
+
+          # @!attribute document_size
+          #   The size of this document in bytes.
+          #
+          #   @return [Integer]
+          required :document_size, Integer
+
+          # @!attribute document_type
+          #
+          #   @return [Symbol, Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType]
+          required :document_type, enum: -> { Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType }
+
+          # @!attribute uploaded_at
+          #   The UTC timestamp when this document was uploaded.
+          #
+          #   @return [Time]
+          required :uploaded_at, Time
+
+          # @!method initialize(document_id:, document_name:, document_size:, document_type:, uploaded_at:)
+          #   @param document_id [String] Unique identifier for this document.
+          #
+          #   @param document_name [String] The file name of this document as uploaded.
+          #
+          #   @param document_size [Integer] The size of this document in bytes.
+          #
+          #   @param document_type [Symbol, Straddle::Models::ChargeUnmaskResponse::Data::Document::DocumentType]
+          #
+          #   @param uploaded_at [Time] The UTC timestamp when this document was uploaded.
+
+          # @see Straddle::Models::ChargeUnmaskResponse::Data::Document#document_type
+          module DocumentType
+            extend Straddle::Internal::Type::Enum
+
+            PAYMENT_AUTHORIZATION = :payment_authorization
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # The payment rail used for the charge or payout.
         #
         # @see Straddle::Models::ChargeUnmaskResponse::Data#payment_rail
@@ -502,15 +591,57 @@ module Straddle
           #   @return [Array<Symbol>]
         end
 
-        module RelatedPayment
-          extend Straddle::Internal::Type::Enum
+        class RelatedPayment < Straddle::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the related payment.
+          #
+          #   @return [String]
+          required :id, String
 
-          ORIGINAL = :original
-          RESUBMIT = :resubmit
-          REFUND = :refund
+          # @!attribute payment_type
+          #   The type of payment.
+          #
+          #   @return [Symbol, Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType]
+          required :payment_type,
+                   enum: -> { Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType }
 
-          # @!method self.values
-          #   @return [Array<Symbol>]
+          # @!attribute relationship
+          #
+          #   @return [Symbol, Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship]
+          required :relationship,
+                   enum: -> { Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship }
+
+          # @!method initialize(id:, payment_type:, relationship:)
+          #   @param id [String] The ID of the related payment.
+          #
+          #   @param payment_type [Symbol, Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::PaymentType] The type of payment.
+          #
+          #   @param relationship [Symbol, Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment::Relationship]
+
+          # The type of payment.
+          #
+          # @see Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment#payment_type
+          module PaymentType
+            extend Straddle::Internal::Type::Enum
+
+            CHARGE = :charge
+            PAYOUT = :payout
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Straddle::Models::ChargeUnmaskResponse::Data::RelatedPayment#relationship
+          module Relationship
+            extend Straddle::Internal::Type::Enum
+
+            ORIGINAL = :original
+            RESUBMIT = :resubmit
+            REFUND = :refund
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end