straddle 0.3.0 → 0.5.0

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
         #
@@ -85,6 +85,24 @@ module Straddle
         #   @return [Array<String>]
         required :funding_ids, Straddle::Internal::Type::ArrayOf[String]
 
+        # @!attribute has_resubmit
+        #   Has the payout been resubmitted.
+        #
+        #   @return [Boolean]
+        required :has_resubmit, Straddle::Internal::Type::Boolean
+
+        # @!attribute is_refund
+        #   Is the payout a refund of an original charge.
+        #
+        #   @return [Boolean]
+        required :is_refund, Straddle::Internal::Type::Boolean
+
+        # @!attribute is_resubmit
+        #   Is the payout a resubmit of an original payout.
+        #
+        #   @return [Boolean]
+        required :is_resubmit, Straddle::Internal::Type::Boolean
+
         # @!attribute paykey
         #   Paykey.
         #
@@ -115,6 +133,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.
         #
@@ -127,6 +151,15 @@ module Straddle
         #   @return [Straddle::Models::CustomerDetailsV1, nil]
         optional :customer_details, -> { Straddle::CustomerDetailsV1 }
 
+        # @!attribute documents
+        #   Documents uploaded for this payout (e.g. proof of authorization), in the order
+        #   they were uploaded.
+        #
+        #   @return [Array<Straddle::Models::PayoutUnmaskResponse::Data::Document>, nil]
+        optional :documents,
+                 -> { Straddle::Internal::Type::ArrayOf[Straddle::Models::PayoutUnmaskResponse::Data::Document] },
+                 nil?: true
+
         # @!attribute effective_at
         #   Effective at.
         #
@@ -156,13 +189,24 @@ module Straddle
         #   @return [Time, nil]
         optional :processed_at, Time, nil?: true
 
+        # @!attribute related_payments
+        #   Related payments.
+        #
+        #   @return [Array<Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment>, nil]
+        optional :related_payments,
+                 -> { Straddle::Internal::Type::ArrayOf[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:, has_resubmit:, is_refund:, is_resubmit:, paykey:, payment_date:, status:, status_details:, status_history:, trace_ids:, created_at: nil, customer_details: nil, documents: nil, effective_at: nil, metadata: nil, paykey_details: nil, payment_rail: nil, processed_at: nil, related_payments: nil, updated_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::PayoutUnmaskResponse::Data} for more details.
+        #
         #   @param id [String] Id.
         #
         #   @param amount [Integer] Amount.
@@ -171,7 +215,7 @@ module Straddle
         #
         #   @param currency [String] Currency.
         #
-        #   @param description [String] Description.
+        #   @param description [String, nil] Description.
         #
         #   @param device [Straddle::Models::PayoutUnmaskResponse::Data::Device]
         #
@@ -179,6 +223,12 @@ module Straddle
         #
         #   @param funding_ids [Array<String>] Funding Ids
         #
+        #   @param has_resubmit [Boolean] Has the payout been resubmitted.
+        #
+        #   @param is_refund [Boolean] Is the payout a refund of an original charge.
+        #
+        #   @param is_resubmit [Boolean] Is the payout a resubmit of an original payout.
+        #
         #   @param paykey [String] Paykey.
         #
         #   @param payment_date [Date] Payment date.
@@ -189,10 +239,14 @@ 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.
         #
+        #   @param documents [Array<Straddle::Models::PayoutUnmaskResponse::Data::Document>, nil] Documents uploaded for this payout (e.g. proof of authorization), in the order t
+        #
         #   @param effective_at [Time, nil] Effective at.
         #
         #   @param metadata [Hash{Symbol=>String}, nil] Metadata.
@@ -203,10 +257,24 @@ module Straddle
         #
         #   @param processed_at [Time, nil] Processed at.
         #
+        #   @param related_payments [Array<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 +282,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.
@@ -234,6 +306,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>]
@@ -266,6 +340,7 @@ module Straddle
           PENDING = :pending
           PAID = :paid
           REVERSED = :reversed
+          VALIDATING = :validating
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -353,6 +428,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 +471,59 @@ module Straddle
             PENDING = :pending
             PAID = :paid
             REVERSED = :reversed
+            VALIDATING = :validating
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          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::PayoutUnmaskResponse::Data::Document::DocumentType]
+          required :document_type, enum: -> { Straddle::Models::PayoutUnmaskResponse::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::PayoutUnmaskResponse::Data::Document::DocumentType]
+          #
+          #   @param uploaded_at [Time] The UTC timestamp when this document was uploaded.
+
+          # @see Straddle::Models::PayoutUnmaskResponse::Data::Document#document_type
+          module DocumentType
+            extend Straddle::Internal::Type::Enum
+
+            PAYMENT_AUTHORIZATION = :payment_authorization
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -406,6 +541,59 @@ module Straddle
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        class RelatedPayment < Straddle::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the related payment.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute payment_type
+          #   The type of payment.
+          #
+          #   @return [Symbol, Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType]
+          required :payment_type,
+                   enum: -> { Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType }
+
+          # @!attribute relationship
+          #
+          #   @return [Symbol, Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::Relationship]
+          required :relationship,
+                   enum: -> { Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::Relationship }
+
+          # @!method initialize(id:, payment_type:, relationship:)
+          #   @param id [String] The ID of the related payment.
+          #
+          #   @param payment_type [Symbol, Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::PaymentType] The type of payment.
+          #
+          #   @param relationship [Symbol, Straddle::Models::PayoutUnmaskResponse::Data::RelatedPayment::Relationship]
+
+          # The type of payment.
+          #
+          # @see Straddle::Models::PayoutUnmaskResponse::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::PayoutUnmaskResponse::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
 
       # 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
       #

data/lib/straddle/models/payout_upload_authorization_document_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Payouts#upload_authorization_document
+    class PayoutUploadAuthorizationDocumentParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute file
+      #   The document file to upload as proof of authorization for this payout.
+      #
+      #   @return [Pathname, StringIO, IO, String, Straddle::FilePart]
+      required :file, Straddle::Internal::Type::FileInput, api_name: :File
+
+      # @!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:, file:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param file [Pathname, StringIO, IO, String, Straddle::FilePart] The document file to upload as proof of authorization for this payout.
+      #
+      #   @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