straddle 0.2.0 → 0.4.0

data/lib/straddle/models/paykey_summary_paged_v1.rb

@@ -100,6 +100,13 @@ module Straddle
         #   @return [Time, nil]
         optional :expires_at, Time, nil?: true
 
+        # @!attribute external_id
+        #   Unique identifier for the paykey in your database, used for cross-referencing
+        #   between Straddle and your systems.
+        #
+        #   @return [String, nil]
+        optional :external_id, String, nil?: true
+
         # @!attribute institution_name
         #   Name of the financial institution.
         #
@@ -111,7 +118,15 @@ module Straddle
         #   @return [Straddle::Models::PaykeySummaryPagedV1::Data::StatusDetails, nil]
         optional :status_details, -> { Straddle::PaykeySummaryPagedV1::Data::StatusDetails }
 
-        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, institution_name: nil, status_details: nil)
+        # @!attribute unblock_eligible
+        #   Indicates whether this paykey is eligible for client-initiated unblocking. Only
+        #   present for blocked paykeys. True when blocked due to R29 returns and not
+        #   previously unblocked, false otherwise. Null when paykey is not blocked.
+        #
+        #   @return [Boolean, nil]
+        optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, status_details: nil, unblock_eligible: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::PaykeySummaryPagedV1::Data} for more details.
         #
@@ -137,20 +152,42 @@ module Straddle
         #
         #   @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
         #
+        #   @param external_id [String, nil] Unique identifier for the paykey in your database, used for cross-referencing be
+        #
         #   @param institution_name [String, nil] Name of the financial institution.
         #
         #   @param status_details [Straddle::Models::PaykeySummaryPagedV1::Data::StatusDetails]
+        #
+        #   @param unblock_eligible [Boolean, nil] Indicates whether this paykey is eligible for client-initiated unblocking. Only
 
         # @see Straddle::Models::PaykeySummaryPagedV1::Data#config
         class Config < Straddle::Internal::Type::BaseModel
+          # @!attribute processing_method
+          #
+          #   @return [Symbol, Straddle::Models::PaykeySummaryPagedV1::Data::Config::ProcessingMethod, nil]
+          optional :processing_method, enum: -> { Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod }
+
           # @!attribute sandbox_outcome
           #
           #   @return [Symbol, Straddle::Models::PaykeySummaryPagedV1::Data::Config::SandboxOutcome, nil]
           optional :sandbox_outcome, enum: -> { Straddle::PaykeySummaryPagedV1::Data::Config::SandboxOutcome }
 
-          # @!method initialize(sandbox_outcome: nil)
+          # @!method initialize(processing_method: nil, sandbox_outcome: nil)
+          #   @param processing_method [Symbol, Straddle::Models::PaykeySummaryPagedV1::Data::Config::ProcessingMethod]
           #   @param sandbox_outcome [Symbol, Straddle::Models::PaykeySummaryPagedV1::Data::Config::SandboxOutcome]
 
+          # @see Straddle::Models::PaykeySummaryPagedV1::Data::Config#processing_method
+          module ProcessingMethod
+            extend Straddle::Internal::Type::Enum
+
+            INLINE = :inline
+            BACKGROUND = :background
+            SKIP = :skip
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see Straddle::Models::PaykeySummaryPagedV1::Data::Config#sandbox_outcome
           module SandboxOutcome
             extend Straddle::Internal::Type::Enum
@@ -158,6 +195,7 @@ module Straddle
             STANDARD = :standard
             ACTIVE = :active
             REJECTED = :rejected
+            REVIEW = :review
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -188,6 +226,7 @@ module Straddle
           INACTIVE = :inactive
           REJECTED = :rejected
           REVIEW = :review
+          BLOCKED = :blocked
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -300,6 +339,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/paykey_unmasked_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/paykey_unmasked_v1.rb

@@ -107,6 +107,13 @@ module Straddle
         #   @return [Time, nil]
         optional :expires_at, Time, nil?: true
 
+        # @!attribute external_id
+        #   Unique identifier for the paykey in your database, used for cross-referencing
+        #   between Straddle and your systems.
+        #
+        #   @return [String, nil]
+        optional :external_id, String, nil?: true
+
         # @!attribute institution_name
         #   Name of the financial institution.
         #
@@ -125,7 +132,7 @@ module Straddle
         #   @return [Straddle::Models::PaykeyUnmaskedV1::Data::StatusDetails, nil]
         optional :status_details, -> { Straddle::PaykeyUnmaskedV1::Data::StatusDetails }
 
-        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, institution_name: nil, metadata: nil, status_details: nil)
+        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::PaykeyUnmaskedV1::Data} for more details.
         #
@@ -153,6 +160,8 @@ module Straddle
         #
         #   @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
         #
+        #   @param external_id [String, nil] Unique identifier for the paykey in your database, used for cross-referencing be
+        #
         #   @param institution_name [String, nil] Name of the financial institution.
         #
         #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
@@ -161,14 +170,32 @@ module Straddle
 
         # @see Straddle::Models::PaykeyUnmaskedV1::Data#config
         class Config < Straddle::Internal::Type::BaseModel
+          # @!attribute processing_method
+          #
+          #   @return [Symbol, Straddle::Models::PaykeyUnmaskedV1::Data::Config::ProcessingMethod, nil]
+          optional :processing_method, enum: -> { Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod }
+
           # @!attribute sandbox_outcome
           #
           #   @return [Symbol, Straddle::Models::PaykeyUnmaskedV1::Data::Config::SandboxOutcome, nil]
           optional :sandbox_outcome, enum: -> { Straddle::PaykeyUnmaskedV1::Data::Config::SandboxOutcome }
 
-          # @!method initialize(sandbox_outcome: nil)
+          # @!method initialize(processing_method: nil, sandbox_outcome: nil)
+          #   @param processing_method [Symbol, Straddle::Models::PaykeyUnmaskedV1::Data::Config::ProcessingMethod]
           #   @param sandbox_outcome [Symbol, Straddle::Models::PaykeyUnmaskedV1::Data::Config::SandboxOutcome]
 
+          # @see Straddle::Models::PaykeyUnmaskedV1::Data::Config#processing_method
+          module ProcessingMethod
+            extend Straddle::Internal::Type::Enum
+
+            INLINE = :inline
+            BACKGROUND = :background
+            SKIP = :skip
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see Straddle::Models::PaykeyUnmaskedV1::Data::Config#sandbox_outcome
           module SandboxOutcome
             extend Straddle::Internal::Type::Enum
@@ -176,6 +203,7 @@ module Straddle
             STANDARD = :standard
             ACTIVE = :active
             REJECTED = :rejected
+            REVIEW = :review
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -206,6 +234,7 @@ module Straddle
           INACTIVE = :inactive
           REJECTED = :rejected
           REVIEW = :review
+          BLOCKED = :blocked
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -353,6 +382,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/{customer_refresh_review_params.rb → paykey_update_balance_params.rb}

@@ -2,11 +2,16 @@
 
 module Straddle
   module Models
-    # @see Straddle::Resources::Customers#refresh_review
-    class CustomerRefreshReviewParams < Straddle::Internal::Type::BaseModel
+    # @see Straddle::Resources::Paykeys#update_balance
+    class PaykeyUpdateBalanceParams < 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]
@@ -27,7 +32,8 @@ module Straddle
       #   @return [String, nil]
       optional :straddle_account_id, String
 
-      # @!method initialize(correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @!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]

data/lib/straddle/models/paykey_v1.rb

@@ -107,6 +107,13 @@ module Straddle
         #   @return [Time, nil]
         optional :expires_at, Time, nil?: true
 
+        # @!attribute external_id
+        #   Unique identifier for the paykey in your database, used for cross-referencing
+        #   between Straddle and your systems.
+        #
+        #   @return [String, nil]
+        optional :external_id, String, nil?: true
+
         # @!attribute institution_name
         #   Name of the financial institution.
         #
@@ -125,7 +132,15 @@ module Straddle
         #   @return [Straddle::Models::PaykeyV1::Data::StatusDetails, nil]
         optional :status_details, -> { Straddle::PaykeyV1::Data::StatusDetails }
 
-        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, institution_name: nil, metadata: nil, status_details: nil)
+        # @!attribute unblock_eligible
+        #   Indicates whether this paykey is eligible for client-initiated unblocking. Only
+        #   present for blocked paykeys. True when blocked due to R29 returns and not
+        #   previously unblocked, false otherwise. Null when paykey is not blocked.
+        #
+        #   @return [Boolean, nil]
+        optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil, unblock_eligible: nil)
         #   Some parameter documentations has been truncated, see
         #   {Straddle::Models::PaykeyV1::Data} for more details.
         #
@@ -153,22 +168,44 @@ module Straddle
         #
         #   @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
         #
+        #   @param external_id [String, nil] Unique identifier for the paykey in your database, used for cross-referencing be
+        #
         #   @param institution_name [String, nil] Name of the financial institution.
         #
         #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
         #
         #   @param status_details [Straddle::Models::PaykeyV1::Data::StatusDetails]
+        #
+        #   @param unblock_eligible [Boolean, nil] Indicates whether this paykey is eligible for client-initiated unblocking. Only
 
         # @see Straddle::Models::PaykeyV1::Data#config
         class Config < Straddle::Internal::Type::BaseModel
+          # @!attribute processing_method
+          #
+          #   @return [Symbol, Straddle::Models::PaykeyV1::Data::Config::ProcessingMethod, nil]
+          optional :processing_method, enum: -> { Straddle::PaykeyV1::Data::Config::ProcessingMethod }
+
           # @!attribute sandbox_outcome
           #
           #   @return [Symbol, Straddle::Models::PaykeyV1::Data::Config::SandboxOutcome, nil]
           optional :sandbox_outcome, enum: -> { Straddle::PaykeyV1::Data::Config::SandboxOutcome }
 
-          # @!method initialize(sandbox_outcome: nil)
+          # @!method initialize(processing_method: nil, sandbox_outcome: nil)
+          #   @param processing_method [Symbol, Straddle::Models::PaykeyV1::Data::Config::ProcessingMethod]
           #   @param sandbox_outcome [Symbol, Straddle::Models::PaykeyV1::Data::Config::SandboxOutcome]
 
+          # @see Straddle::Models::PaykeyV1::Data::Config#processing_method
+          module ProcessingMethod
+            extend Straddle::Internal::Type::Enum
+
+            INLINE = :inline
+            BACKGROUND = :background
+            SKIP = :skip
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see Straddle::Models::PaykeyV1::Data::Config#sandbox_outcome
           module SandboxOutcome
             extend Straddle::Internal::Type::Enum
@@ -176,6 +213,7 @@ module Straddle
             STANDARD = :standard
             ACTIVE = :active
             REJECTED = :rejected
+            REVIEW = :review
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -206,6 +244,7 @@ module Straddle
           INACTIVE = :inactive
           REJECTED = :rejected
           REVIEW = :review
+          BLOCKED = :blocked
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -357,6 +396,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/paykeys/review_decision_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      # @see Straddle::Resources::Paykeys::Review#decision
+      class ReviewDecisionParams < 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::ReviewDecisionParams::Status]
+        required :status, enum: -> { Straddle::Paykeys::ReviewDecisionParams::Status }
+
+        # @!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:, 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::ReviewDecisionParams::Status]
+        #   @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}]
+
+        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/paykeys/review_get_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Paykeys
+      # @see Straddle::Resources::Paykeys::Review#get
+      class ReviewGetParams < 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 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, 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]
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end