straddle 0.5.0 → 1.0.0

data/lib/straddle/models/paykey_unblock_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#unblock
+    class PaykeyUnblockParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute message
+      #   Optional message describing the reason for unblocking.
+      #
+      #   @return [String, nil]
+      optional :message, String, nil?: true
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(id:, message: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param message [String, nil] Optional message describing the reason for unblocking.
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      class AccountNameMatchDetails < Straddle::Internal::Type::BaseModel
+        # @!attribute codes
+        #   Result codes returned by the name-match check.
+        #
+        #   @return [Array<String>]
+        required :codes, Straddle::Internal::Type::ArrayOf[String]
+
+        # @!attribute decision
+        #
+        #   @return [Symbol, Straddle::Models::Paykeys::PaykeyVerificationResult]
+        required :decision, enum: -> { Straddle::Paykeys::PaykeyVerificationResult }
+
+        # @!attribute correlation_score
+        #   Strength of the match between the customer name and account-holder names.
+        #
+        #   @return [Float, nil]
+        optional :correlation_score, Float, nil?: true
+
+        # @!attribute customer_name
+        #   Customer name evaluated during account verification.
+        #
+        #   @return [String, nil]
+        optional :customer_name, String, nil?: true
+
+        # @!attribute matched_name
+        #   Account-holder name that matched the customer record.
+        #
+        #   @return [String, nil]
+        optional :matched_name, String, nil?: true
+
+        # @!attribute names_on_account
+        #   Account-holder names returned by the financial institution.
+        #
+        #   @return [Array<String>, nil]
+        optional :names_on_account, Straddle::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute reason
+        #   Reason for the name-match decision.
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!method initialize(codes:, decision:, correlation_score: nil, customer_name: nil, matched_name: nil, names_on_account: nil, reason: nil)
+        #   @param codes [Array<String>] Result codes returned by the name-match check.
+        #
+        #   @param decision [Symbol, Straddle::Models::Paykeys::PaykeyVerificationResult]
+        #
+        #   @param correlation_score [Float, nil] Strength of the match between the customer name and account-holder names.
+        #
+        #   @param customer_name [String, nil] Customer name evaluated during account verification.
+        #
+        #   @param matched_name [String, nil] Account-holder name that matched the customer record.
+        #
+        #   @param names_on_account [Array<String>, nil] Account-holder names returned by the financial institution.
+        #
+        #   @param reason [String, nil] Reason for the name-match decision.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      class AccountValidationDetails < Straddle::Internal::Type::BaseModel
+        # @!attribute codes
+        #   Result codes returned by the account-validation check.
+        #
+        #   @return [Array<String>]
+        required :codes, Straddle::Internal::Type::ArrayOf[String]
+
+        # @!attribute decision
+        #
+        #   @return [Symbol, Straddle::Models::Paykeys::PaykeyVerificationResult]
+        required :decision, enum: -> { Straddle::Paykeys::PaykeyVerificationResult }
+
+        # @!attribute reason
+        #   Reason for the account-validation decision.
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!method initialize(codes:, decision:, reason: nil)
+        #   @param codes [Array<String>] Result codes returned by the account-validation check.
+        #
+        #   @param decision [Symbol, Straddle::Models::Paykeys::PaykeyVerificationResult]
+        #
+        #   @param reason [String, nil] Reason for the account-validation decision.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      class PaykeyReview < Straddle::Internal::Type::BaseModel
+        # @!attribute paykey_details
+        #
+        #   @return [Straddle::Models::Paykey]
+        required :paykey_details, -> { Straddle::Paykey }
+
+        # @!attribute verification_details
+        #
+        #   @return [Straddle::Models::Paykeys::PaykeyVerificationDetails, nil]
+        optional :verification_details, -> { Straddle::Paykeys::PaykeyVerificationDetails }
+
+        # @!method initialize(paykey_details:, verification_details: nil)
+        #   @param paykey_details [Straddle::Models::Paykey]
+        #   @param verification_details [Straddle::Models::Paykeys::PaykeyVerificationDetails]
+      end
+    end
+
+    PaykeyReview = Paykeys::PaykeyReview
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      # @see Straddle::Resources::Paykeys::Review#list
+      class PaykeyReviewResponse < Straddle::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Straddle::Models::Paykeys::PaykeyReview]
+        required :data, -> { Straddle::Paykeys::PaykeyReview }
+
+        # @!attribute meta
+        #   Metadata for an API request.
+        #
+        #   @return [Straddle::Models::ResponseMetadata]
+        required :meta, -> { Straddle::ResponseMetadata }
+
+        # @!attribute response_type
+        #   Shape of the response envelope.
+        #
+        #   - `object` means `data` contains one JSON object.
+        #   - `array` means `data` contains an array of JSON objects.
+        #   - `error` means `error` contains the error details.
+        #   - `none` means the response contains no data.
+        #
+        #   @return [Symbol, Straddle::Models::ResponseType]
+        required :response_type, enum: -> { Straddle::ResponseType }
+
+        # @!method initialize(data:, meta:, response_type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::Paykeys::PaykeyReviewResponse} for more details.
+        #
+        #   @param data [Straddle::Models::Paykeys::PaykeyReview]
+        #
+        #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+        #
+        #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+      end
+    end
+
+    PaykeyReviewResponse = Paykeys::PaykeyReviewResponse
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      class PaykeyVerificationBreakdown < Straddle::Internal::Type::BaseModel
+        # @!attribute account_validation
+        #
+        #   @return [Straddle::Models::Paykeys::AccountValidationDetails, nil]
+        optional :account_validation, -> { Straddle::Paykeys::AccountValidationDetails }
+
+        # @!attribute name_match
+        #
+        #   @return [Straddle::Models::Paykeys::AccountNameMatchDetails, nil]
+        optional :name_match, -> { Straddle::Paykeys::AccountNameMatchDetails }
+
+        # @!method initialize(account_validation: nil, name_match: nil)
+        #   @param account_validation [Straddle::Models::Paykeys::AccountValidationDetails]
+        #   @param name_match [Straddle::Models::Paykeys::AccountNameMatchDetails]
+      end
+    end
+
+    PaykeyVerificationBreakdown = Paykeys::PaykeyVerificationBreakdown
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      class PaykeyVerificationDetails < Straddle::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the verification details.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute breakdown
+        #
+        #   @return [Straddle::Models::Paykeys::PaykeyVerificationBreakdown]
+        required :breakdown, -> { Straddle::Paykeys::PaykeyVerificationBreakdown }
+
+        # @!attribute created_at
+        #   Timestamp of when the verification was initiated.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute decision
+        #
+        #   @return [Symbol, Straddle::Models::Paykeys::PaykeyVerificationResult]
+        required :decision, enum: -> { Straddle::Paykeys::PaykeyVerificationResult }
+
+        # @!attribute messages
+        #   Messages returned by the paykey verification process.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :messages, Straddle::Internal::Type::HashOf[String]
+
+        # @!attribute updated_at
+        #   Timestamp of the most recent update to the verification details.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!method initialize(id:, breakdown:, created_at:, decision:, messages:, updated_at:)
+        #   @param id [String] Unique identifier for the verification details.
+        #
+        #   @param breakdown [Straddle::Models::Paykeys::PaykeyVerificationBreakdown]
+        #
+        #   @param created_at [Time] Timestamp of when the verification was initiated.
+        #
+        #   @param decision [Symbol, Straddle::Models::Paykeys::PaykeyVerificationResult]
+        #
+        #   @param messages [Hash{Symbol=>String}] Messages returned by the paykey verification process.
+        #
+        #   @param updated_at [Time] Timestamp of the most recent update to the verification details.
+      end
+    end
+
+    PaykeyVerificationDetails = Paykeys::PaykeyVerificationDetails
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      module PaykeyVerificationResult
+        extend Straddle::Internal::Type::Enum
+
+        ACCEPT = :accept
+        REJECT = :reject
+        REVIEW = :review
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+
+    PaykeyVerificationResult = Paykeys::PaykeyVerificationResult
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      # @see Straddle::Resources::Paykeys::Review#list
+      class ReviewListParams < 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
+        #   Optional client-generated identifier for tracing a series of related requests.
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #   Optional client-generated identifier for tracing one request.
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute straddle_account_id
+        #   For platform requests, the embedded account UUID that sets the request scope.
+        #
+        #   @return [String, nil]
+        optional :straddle_account_id, String
+
+        # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+        #
+        #   @param request_id [String] Optional client-generated identifier for tracing one request.
+        #
+        #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      # @see Straddle::Resources::Paykeys::Review#set_verification_decision
+      class ReviewSetVerificationDecisionParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Straddle::Models::Paykeys::ReviewSetVerificationDecisionParams::Status]
+        required :status, enum: -> { Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status }
+
+        # @!attribute correlation_id
+        #   Optional client-generated identifier for tracing a series of related requests.
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute idempotency_key
+        #   Optional client-generated key for an idempotent request.
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute request_id
+        #   Optional client-generated identifier for tracing one request.
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute straddle_account_id
+        #   For platform requests, the embedded account UUID that sets the request scope.
+        #
+        #   @return [String, nil]
+        optional :straddle_account_id, String
+
+        # @!method initialize(id:, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param status [Symbol, Straddle::Models::Paykeys::ReviewSetVerificationDecisionParams::Status]
+        #
+        #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+        #
+        #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+        #
+        #   @param request_id [String] Optional client-generated identifier for tracing one request.
+        #
+        #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          ACTIVE = :active
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/straddle/models/payment_authorization_proof.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaymentAuthorizationProof < 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::PaymentDocumentType]
+      required :document_type, enum: -> { Straddle::PaymentDocumentType }
+
+      # @!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::PaymentDocumentType]
+      #
+      #   @param uploaded_at [Time] The UTC timestamp when this document was uploaded.
+    end
+  end
+end

data/lib/straddle/models/payment_device.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaymentDevice < Straddle::Internal::Type::BaseModel
+      # @!attribute ip_address
+      #   The IP address of the device used when the customer authorized the charge or
+      #   payout. Use `0.0.0.0` to represent an offline consent interaction.
+      #
+      #   @return [String]
+      required :ip_address, String
+
+      # @!method initialize(ip_address:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::PaymentDevice} for more details.
+      #
+      #   @param ip_address [String] The IP address of the device used when the customer authorized the charge or pay
+    end
+  end
+end

data/lib/straddle/models/payment_document_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module PaymentDocumentType
+      extend Straddle::Internal::Type::Enum
+
+      PAYMENT_AUTHORIZATION = :payment_authorization
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end