straddle 0.2.0 → 0.4.0

data/lib/straddle/models/paykeys/review_refresh_review_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      # @see Straddle::Resources::Paykeys::Review#refresh_review
+      class ReviewRefreshReviewParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute straddle_account_id
+        #
+        #   @return [String, nil]
+        optional :straddle_account_id, String
+
+        # @!method initialize(id:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
+        #   @param correlation_id [String]
+        #   @param idempotency_key [String]
+        #   @param request_id [String]
+        #   @param straddle_account_id [String]
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/straddle/models/payment_list_params.rb

@@ -41,6 +41,12 @@ module Straddle
       #   @return [String, nil]
       optional :funding_id, String
 
+      # @!attribute include_metadata
+      #   Include the metadata for payments in the returned data.
+      #
+      #   @return [Boolean, nil]
+      optional :include_metadata, Straddle::Internal::Type::Boolean
+
       # @!attribute max_amount
       #   Search using a maximum `amount` of a `charge` or `payout`.
       #
@@ -179,7 +185,7 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, include_metadata: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #   @param customer_id [String] Search using the `customer_id` of a `charge` or `payout`.
       #
       #   @param default_page_size [Integer]
@@ -192,6 +198,8 @@ module Straddle
       #
       #   @param funding_id [String] Search using the `funding_id` of a `charge` or `payout`.
       #
+      #   @param include_metadata [Boolean] Include the metadata for payments in the returned data.
+      #
       #   @param max_amount [Integer] Search using a maximum `amount` of a `charge` or `payout`.
       #
       #   @param max_created_at [Time] Search using the latest `created_at` date of a `charge` or `payout`.
@@ -276,6 +284,7 @@ module Straddle
         PENDING = :pending
         PAID = :paid
         REVERSED = :reversed
+        VALIDATING = :validating
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -339,6 +348,13 @@ module Straddle
         OK = :ok
         OTHER_NETWORK_RETURN = :other_network_return
         PAYOUT_REFUSED = :payout_refused
+        CANCEL_REQUEST = :cancel_request
+        FAILED_VERIFICATION = :failed_verification
+        REQUIRE_REVIEW = :require_review
+        BLOCKED_BY_SYSTEM = :blocked_by_system
+        WATCHTOWER_REVIEW = :watchtower_review
+        VALIDATING = :validating
+        AUTO_HOLD = :auto_hold
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/straddle/models/payment_summary_paged_v1.rb

@@ -63,8 +63,8 @@ module Straddle
         # @!attribute description
         #   An arbitrary description for the `charge` or `payout`.
         #
-        #   @return [String]
-        required :description, String
+        #   @return [String, nil]
+        required :description, String, nil?: true
 
         # @!attribute external_id
         #   Unique identifier for the `charge` or `payout` in your database. This value must
@@ -111,6 +111,12 @@ module Straddle
         #   @return [Straddle::Models::StatusDetailsV1]
         required :status_details, -> { Straddle::StatusDetailsV1 }
 
+        # @!attribute trace_ids
+        #   Trace ids.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :trace_ids, Straddle::Internal::Type::HashOf[String]
+
         # @!attribute updated_at
         #   The time the `charge` or `payout` was last updated.
         #
@@ -138,13 +144,19 @@ module Straddle
         #   @return [String, nil]
         optional :funding_id, String, nil?: true
 
+        # @!attribute metadata
+        #   Metadata for payment - only included if requested.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
         # @!attribute paykey_details
         #   Information about the paykey used for the `charge` or `payout`.
         #
         #   @return [Straddle::Models::PaykeyDetailsV1, nil]
         optional :paykey_details, -> { Straddle::PaykeyDetailsV1 }
 
-        # @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, paykey:, payment_date:, payment_type:, status:, status_details:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, paykey_details: nil)
+        # @!method initialize(id:, amount:, created_at:, currency:, description:, external_id:, funding_ids:, paykey:, payment_date:, payment_type:, status:, status_details:, trace_ids:, updated_at:, customer_details: nil, effective_at: nil, funding_id: nil, metadata: nil, paykey_details: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::PaymentSummaryPagedV1::Data} for more details.
         #
@@ -156,7 +168,7 @@ module Straddle
         #
         #   @param currency [String] The currency of the `charge` or `payout`. Only USD is supported.
         #
-        #   @param description [String] An arbitrary description for the `charge` or `payout`.
+        #   @param description [String, nil] An arbitrary description for the `charge` or `payout`.
         #
         #   @param external_id [String] Unique identifier for the `charge` or `payout` in your database. This value must
         #
@@ -172,6 +184,8 @@ module Straddle
         #
         #   @param status_details [Straddle::Models::StatusDetailsV1] Details about the current status of the `charge` or `payout`.
         #
+        #   @param trace_ids [Hash{Symbol=>String}] Trace ids.
+        #
         #   @param updated_at [Time] The time the `charge` or `payout` was last updated.
         #
         #   @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the charge or payout.
@@ -180,6 +194,8 @@ module Straddle
         #
         #   @param funding_id [String, nil] Unique identifier for the funding event associated with the `charge` or `payout`
         #
+        #   @param metadata [Hash{Symbol=>String}, nil] Metadata for payment - only included if requested.
+        #
         #   @param paykey_details [Straddle::Models::PaykeyDetailsV1] Information about the paykey used for the `charge` or `payout`.
 
         # The type of payment. Valid values are `charge` or `payout`.
@@ -209,6 +225,7 @@ module Straddle
           PENDING = :pending
           PAID = :paid
           REVERSED = :reversed
+          VALIDATING = :validating
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/straddle/models/payout_cancel_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute reason
       #   Details about why the payout status was updated.
       #
@@ -33,7 +38,9 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
       #   @param reason [String] Details about why the payout status was updated.
       #
       #   @param correlation_id [String]

data/lib/straddle/models/payout_create_params.rb

@@ -22,8 +22,8 @@ module Straddle
       # @!attribute description
       #   An arbitrary description for the payout.
       #
-      #   @return [String]
-      required :description, String
+      #   @return [String, nil]
+      required :description, String, nil?: true
 
       # @!attribute device
       #   Information about the device used when the customer authorized the payout.
@@ -91,7 +91,7 @@ module Straddle
       #
       #   @param currency [String] The currency of the payout. Only USD is supported.
       #
-      #   @param description [String] An arbitrary description for the payout.
+      #   @param description [String, nil] An arbitrary description for the payout.
       #
       #   @param device [Straddle::Models::DeviceInfoV1] Information about the device used when the customer authorized the payout.
       #
@@ -116,13 +116,29 @@ module Straddle
       #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
 
       class Config < Straddle::Internal::Type::BaseModel
+        # @!attribute auto_hold
+        #   Defines whether to automatically place this charge on hold after being created.
+        #
+        #   @return [Boolean, nil]
+        optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
+
+        # @!attribute auto_hold_message
+        #   The reason the payout is being automatically held on creation.
+        #
+        #   @return [String, nil]
+        optional :auto_hold_message, String, nil?: true
+
         # @!attribute sandbox_outcome
         #   Payment will simulate processing if not Standard.
         #
         #   @return [Symbol, Straddle::Models::PayoutCreateParams::Config::SandboxOutcome, nil]
         optional :sandbox_outcome, enum: -> { Straddle::PayoutCreateParams::Config::SandboxOutcome }
 
-        # @!method initialize(sandbox_outcome: nil)
+        # @!method initialize(auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
+        #   @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
+        #
+        #   @param auto_hold_message [String, nil] The reason the payout is being automatically held on creation.
+        #
         #   @param sandbox_outcome [Symbol, Straddle::Models::PayoutCreateParams::Config::SandboxOutcome] Payment will simulate processing if not Standard.
 
         # Payment will simulate processing if not Standard.

data/lib/straddle/models/payout_get_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param request_id [String]
       #   @param straddle_account_id [String]

data/lib/straddle/models/payout_hold_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute reason
       #   Details about why the payout status was updated.
       #
@@ -33,7 +38,9 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
       #   @param reason [String] Details about why the payout status was updated.
       #
       #   @param correlation_id [String]

data/lib/straddle/models/payout_release_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute reason
       #   Details about why the payout status was updated.
       #
@@ -33,7 +38,9 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
       #   @param reason [String] Details about why the payout status was updated.
       #
       #   @param correlation_id [String]

data/lib/straddle/models/payout_unmask_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute correlation_id
       #
       #   @return [String, nil]
@@ -22,7 +27,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
       #   @param correlation_id [String]
       #   @param request_id [String]
       #   @param straddle_account_id [String]

data/lib/straddle/models/payout_unmask_response.rb

@@ -65,8 +65,8 @@ module Straddle
         # @!attribute description
         #   Description.
         #
-        #   @return [String]
-        required :description, String
+        #   @return [String, nil]
+        required :description, String, nil?: true
 
         # @!attribute device
         #
@@ -115,6 +115,12 @@ module Straddle
         required :status_history,
                  -> { Straddle::Internal::Type::ArrayOf[Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory] }
 
+        # @!attribute trace_ids
+        #   Trace Ids.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :trace_ids, Straddle::Internal::Type::HashOf[String]
+
         # @!attribute created_at
         #   Created at.
         #
@@ -156,13 +162,21 @@ module Straddle
         #   @return [Time, nil]
         optional :processed_at, Time, nil?: true
 
+        # @!attribute related_payments
+        #   Related payments.
+        #
+        #   @return [Hash{Symbol=>Symbol, Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment}, nil]
+        optional :related_payments,
+                 -> { Straddle::Internal::Type::HashOf[enum: Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment] },
+                 nil?: true
+
         # @!attribute updated_at
         #   Updated at.
         #
         #   @return [Time, nil]
         optional :updated_at, Time, nil?: true
 
-        # @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, updated_at: nil)
+        # @!method initialize(id:, amount:, config:, currency:, description:, device:, external_id:, funding_ids:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, created_at: nil, customer_details: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil, updated_at: nil)
         #   @param id [String] Id.
         #
         #   @param amount [Integer] Amount.
@@ -171,7 +185,7 @@ module Straddle
         #
         #   @param currency [String] Currency.
         #
-        #   @param description [String] Description.
+        #   @param description [String, nil] Description.
         #
         #   @param device [Straddle::Models::PayoutUnmaskResponse::Data::Device]
         #
@@ -189,6 +203,8 @@ module Straddle
         #
         #   @param status_history [Array<Straddle::Models::PayoutUnmaskResponse::Data::StatusHistory>] Status history.
         #
+        #   @param trace_ids [Hash{Symbol=>String}] Trace Ids.
+        #
         #   @param created_at [Time, nil] Created at.
         #
         #   @param customer_details [Straddle::Models::CustomerDetailsV1] Information about the customer associated with the charge or payout.
@@ -203,10 +219,24 @@ module Straddle
         #
         #   @param processed_at [Time, nil] Processed at.
         #
+        #   @param related_payments [Hash{Symbol=>Symbol, Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment}, nil] Related payments.
+        #
         #   @param updated_at [Time, nil] Updated at.
 
         # @see Straddle::Models::PayoutUnmaskResponse::Data#config
         class Config < Straddle::Internal::Type::BaseModel
+          # @!attribute auto_hold
+          #   Defines whether to automatically place this charge on hold after being created.
+          #
+          #   @return [Boolean, nil]
+          optional :auto_hold, Straddle::Internal::Type::Boolean, nil?: true
+
+          # @!attribute auto_hold_message
+          #   The reason the payout is being automatically held on creation.
+          #
+          #   @return [String, nil]
+          optional :auto_hold_message, String, nil?: true
+
           # @!attribute sandbox_outcome
           #   Payment will simulate processing if not Standard.
           #
@@ -214,7 +244,11 @@ module Straddle
           optional :sandbox_outcome,
                    enum: -> { Straddle::Models::PayoutUnmaskResponse::Data::Config::SandboxOutcome }
 
-          # @!method initialize(sandbox_outcome: nil)
+          # @!method initialize(auto_hold: nil, auto_hold_message: nil, sandbox_outcome: nil)
+          #   @param auto_hold [Boolean, nil] Defines whether to automatically place this charge on hold after being created.
+          #
+          #   @param auto_hold_message [String, nil] The reason the payout is being automatically held on creation.
+          #
           #   @param sandbox_outcome [Symbol, Straddle::Models::PayoutUnmaskResponse::Data::Config::SandboxOutcome] Payment will simulate processing if not Standard.
 
           # Payment will simulate processing if not Standard.
@@ -266,6 +300,7 @@ module Straddle
           PENDING = :pending
           PAID = :paid
           REVERSED = :reversed
+          VALIDATING = :validating
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -353,6 +388,13 @@ module Straddle
             OK = :ok
             OTHER_NETWORK_RETURN = :other_network_return
             PAYOUT_REFUSED = :payout_refused
+            CANCEL_REQUEST = :cancel_request
+            FAILED_VERIFICATION = :failed_verification
+            REQUIRE_REVIEW = :require_review
+            BLOCKED_BY_SYSTEM = :blocked_by_system
+            WATCHTOWER_REVIEW = :watchtower_review
+            VALIDATING = :validating
+            AUTO_HOLD = :auto_hold
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -389,6 +431,7 @@ module Straddle
             PENDING = :pending
             PAID = :paid
             REVERSED = :reversed
+            VALIDATING = :validating
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -406,6 +449,17 @@ module Straddle
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        module RelatedPayment
+          extend Straddle::Internal::Type::Enum
+
+          ORIGINAL = :original
+          RESUBMIT = :resubmit
+          REFUND = :refund
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # Indicates the structure of the returned content.

data/lib/straddle/models/payout_update_params.rb

@@ -7,6 +7,11 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute amount
       #   The amount of the payout in cents.
       #
@@ -16,8 +21,8 @@ module Straddle
       # @!attribute description
       #   An arbitrary description for the payout.
       #
-      #   @return [String]
-      required :description, String
+      #   @return [String, nil]
+      required :description, String, nil?: true
 
       # @!attribute payment_date
       #   The desired date on which the payment should be occur. For payouts, this means
@@ -53,13 +58,15 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!method initialize(id:, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Straddle::Models::PayoutUpdateParams} for more details.
       #
+      #   @param id [String]
+      #
       #   @param amount [Integer] The amount of the payout in cents.
       #
-      #   @param description [String] An arbitrary description for the payout.
+      #   @param description [String, nil] An arbitrary description for the payout.
       #
       #   @param payment_date [Date] The desired date on which the payment should be occur. For payouts, this means t
       #