modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/models/bulk_request_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class BulkRequestListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::BulkRequests#list
+    class BulkRequestListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute [r] action_type
       #   One of create, or update.
@@ -24,11 +25,11 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -85,24 +86,12 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # One of create, or update.
-      #
-      # @example
-      # ```ruby
-      # case action_type
-      # in :create
-      #   # ...
-      # in :update
-      #   # ...
-      # in :delete
-      #   # ...
-      # end
-      # ```
-      class ActionType < ModernTreasury::Enum
+      module ActionType
+        extend ModernTreasury::Internal::Type::Enum
+
         CREATE = :create
         UPDATE = :update
         DELETE = :delete
@@ -111,57 +100,31 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of payment_order, expected_payment, or ledger_transaction.
-      #
-      # @example
-      # ```ruby
-      # case resource_type
-      # in :payment_order
-      #   # ...
-      # in :ledger_transaction
-      #   # ...
-      # in :transaction
-      #   # ...
-      # in :expected_payment
-      #   # ...
-      # end
-      # ```
-      class ResourceType < ModernTreasury::Enum
+      module ResourceType
+        extend ModernTreasury::Internal::Type::Enum
+
         PAYMENT_ORDER = :payment_order
+        LEDGER_ACCOUNT = :ledger_account
         LEDGER_TRANSACTION = :ledger_transaction
-        TRANSACTION = :transaction
         EXPECTED_PAYMENT = :expected_payment
+        TRANSACTION = :transaction
+        ENTITY_LINK = :entity_link
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of pending, processing, or completed.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :pending
-      #   # ...
-      # in :processing
-      #   # ...
-      # in :completed
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         PENDING = :pending
         PROCESSING = :processing
         COMPLETED = :completed
@@ -170,7 +133,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/bulk_request_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class BulkRequestRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::BulkRequests#retrieve
+    class BulkRequestRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/bulk_result.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class BulkResult < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::BulkResults#retrieve
+    class BulkResult < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -15,8 +16,8 @@ module ModernTreasury
 
       # @!attribute entity
       #   An object with type as indicated by `entity_type`. This is the result object
-      #     that is generated by performing the requested action on the provided input
-      #     `request_params`.
+      #   that is generated by performing the requested action on the provided input
+      #   `request_params`.
       #
       #   @return [ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError]
       required :entity, union: -> { ModernTreasury::Models::BulkResult::Entity }
@@ -29,18 +30,18 @@ module ModernTreasury
 
       # @!attribute entity_type
       #   The type of the result entity object. For a successful bulk result, this is the
-      #     same as the `resource_type` of the bulk request. For a failed bulk result, this
-      #     is always bulk_error
+      #   same as the `resource_type` of the bulk request. For a failed bulk result, this
+      #   is always bulk_error
       #
       #   @return [Symbol, ModernTreasury::Models::BulkResult::EntityType]
       required :entity_type, enum: -> { ModernTreasury::Models::BulkResult::EntityType }
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
-      #     if it exists in the test environment.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute object
       #
@@ -49,22 +50,22 @@ module ModernTreasury
 
       # @!attribute request_id
       #   Unique identifier for the request that created this bulk result. This is the ID
-      #     of the bulk request when `request_type` is bulk_request
+      #   of the bulk request when `request_type` is bulk_request
       #
       #   @return [String]
       required :request_id, String
 
       # @!attribute request_params
       #   An optional object that contains the provided input params for the request that
-      #     created this result. This is an item in the `resources` array for the
-      #     bulk_request
+      #   created this result. This is an item in the `resources` array for the
+      #   bulk_request
       #
       #   @return [Hash{Symbol=>String}, nil]
-      required :request_params, ModernTreasury::HashOf[String], nil?: true
+      required :request_params, ModernTreasury::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute request_type
       #   The type of the request that created this result. bulk_request is the only
-      #     supported `request_type`
+      #   supported `request_type`
       #
       #   @return [Symbol, ModernTreasury::Models::BulkResult::RequestType]
       required :request_type, enum: -> { ModernTreasury::Models::BulkResult::RequestType }
@@ -112,30 +113,16 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # An object with type as indicated by `entity_type`. This is the result object
-      #   that is generated by performing the requested action on the provided input
-      #   `request_params`.
+      # that is generated by performing the requested action on the provided input
+      # `request_params`.
       #
-      # @example
-      # ```ruby
-      # case entity
-      # in ModernTreasury::Models::PaymentOrder
-      #   # ...
-      # in ModernTreasury::Models::ExpectedPayment
-      #   # ...
-      # in ModernTreasury::Models::LedgerTransaction
-      #   # ...
-      # in ModernTreasury::Models::Transaction
-      #   # ...
-      # in ModernTreasury::Models::BulkResult::Entity::BulkError
-      #   # ...
-      # end
-      # ```
-      class Entity < ModernTreasury::Union
+      # @see ModernTreasury::Models::BulkResult#entity
+      module Entity
+        extend ModernTreasury::Internal::Type::Union
+
         variant -> { ModernTreasury::Models::PaymentOrder }
 
         variant -> { ModernTreasury::Models::ExpectedPayment }
@@ -146,7 +133,7 @@ module ModernTreasury
 
         variant -> { ModernTreasury::Models::BulkResult::Entity::BulkError }
 
-        class BulkError < ModernTreasury::BaseModel
+        class BulkError < ModernTreasury::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -159,10 +146,10 @@ module ModernTreasury
 
           # @!attribute live_mode
           #   This field will be true if this object exists in the live environment or false
-          #     if it exists in the test environment.
+          #   if it exists in the test environment.
           #
           #   @return [Boolean]
-          required :live_mode, ModernTreasury::BooleanModel
+          required :live_mode, ModernTreasury::Internal::Type::Boolean
 
           # @!attribute object
           #
@@ -173,7 +160,7 @@ module ModernTreasury
           #
           #   @return [Array<ModernTreasury::Models::BulkResult::Entity::BulkError::RequestError>]
           required :request_errors,
-                   -> { ModernTreasury::ArrayOf[ModernTreasury::Models::BulkResult::Entity::BulkError::RequestError] }
+                   -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::BulkResult::Entity::BulkError::RequestError] }
 
           # @!attribute updated_at
           #
@@ -190,9 +177,9 @@ module ModernTreasury
           #   #
           #   def initialize(id:, created_at:, live_mode:, object:, request_errors:, updated_at:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-          class RequestError < ModernTreasury::BaseModel
+          class RequestError < ModernTreasury::Internal::Type::BaseModel
             # @!attribute [r] code
             #
             #   @return [String, nil]
@@ -227,86 +214,60 @@ module ModernTreasury
             #   #
             #   def initialize(code: nil, message: nil, parameter: nil, **) = super
 
-            # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+            # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
           end
         end
+
+        # @!parse
+        #   # @return [Array(ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError)]
+        #   def self.variants; end
       end
 
-      # @abstract
-      #
       # The type of the result entity object. For a successful bulk result, this is the
-      #   same as the `resource_type` of the bulk request. For a failed bulk result, this
-      #   is always bulk_error
+      # same as the `resource_type` of the bulk request. For a failed bulk result, this
+      # is always bulk_error
       #
-      # @example
-      # ```ruby
-      # case entity_type
-      # in :payment_order
-      #   # ...
-      # in :ledger_transaction
-      #   # ...
-      # in :transaction
-      #   # ...
-      # in :expected_payment
-      #   # ...
-      # in :bulk_error
-      #   # ...
-      # end
-      # ```
-      class EntityType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::BulkResult#entity_type
+      module EntityType
+        extend ModernTreasury::Internal::Type::Enum
+
         PAYMENT_ORDER = :payment_order
+        LEDGER_ACCOUNT = :ledger_account
         LEDGER_TRANSACTION = :ledger_transaction
-        TRANSACTION = :transaction
         EXPECTED_PAYMENT = :expected_payment
+        TRANSACTION = :transaction
+        ENTITY_LINK = :entity_link
         BULK_ERROR = :bulk_error
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The type of the request that created this result. bulk_request is the only
-      #   supported `request_type`
+      # supported `request_type`
       #
-      # @example
-      # ```ruby
-      # case request_type
-      # in :bulk_request
-      #   # ...
-      # end
-      # ```
-      class RequestType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::BulkResult#request_type
+      module RequestType
+        extend ModernTreasury::Internal::Type::Enum
+
         BULK_REQUEST = :bulk_request
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of successful or failed.
       #
-      # @example
-      # ```ruby
-      # case status
-      # in :pending
-      #   # ...
-      # in :successful
-      #   # ...
-      # in :failed
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # @see ModernTreasury::Models::BulkResult#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         PENDING = :pending
         SUCCESSFUL = :successful
         FAILED = :failed
@@ -315,7 +276,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/bulk_result_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class BulkResultListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::BulkResults#list
+    class BulkResultListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
       #
@@ -24,7 +25,7 @@ module ModernTreasury
 
       # @!attribute [r] entity_type
       #   The type of the request that created this result. bulk_request is the only
-      #     supported `request_type`
+      #   supported `request_type`
       #
       #   @return [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType, nil]
       optional :entity_type, enum: -> { ModernTreasury::Models::BulkResultListParams::EntityType }
@@ -44,7 +45,7 @@ module ModernTreasury
 
       # @!attribute [r] request_id
       #   Unique identifier for the request that created this bulk result. This is the ID
-      #     of the bulk request when `request_type` is bulk_request
+      #   of the bulk request when `request_type` is bulk_request
       #
       #   @return [String, nil]
       optional :request_id, String
@@ -55,7 +56,7 @@ module ModernTreasury
 
       # @!attribute [r] request_type
       #   The type of the request that created this result. bulk_request is the only
-      #     supported `request_type`
+      #   supported `request_type`
       #
       #   @return [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType, nil]
       optional :request_type, enum: -> { ModernTreasury::Models::BulkResultListParams::RequestType }
@@ -98,82 +99,46 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of the request that created this result. bulk_request is the only
-      #   supported `request_type`
-      #
-      # @example
-      # ```ruby
-      # case entity_type
-      # in :payment_order
-      #   # ...
-      # in :ledger_transaction
-      #   # ...
-      # in :transaction
-      #   # ...
-      # in :expected_payment
-      #   # ...
-      # in :bulk_error
-      #   # ...
-      # end
-      # ```
-      class EntityType < ModernTreasury::Enum
+      # supported `request_type`
+      module EntityType
+        extend ModernTreasury::Internal::Type::Enum
+
         PAYMENT_ORDER = :payment_order
+        LEDGER_ACCOUNT = :ledger_account
         LEDGER_TRANSACTION = :ledger_transaction
-        TRANSACTION = :transaction
         EXPECTED_PAYMENT = :expected_payment
+        TRANSACTION = :transaction
+        ENTITY_LINK = :entity_link
         BULK_ERROR = :bulk_error
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The type of the request that created this result. bulk_request is the only
-      #   supported `request_type`
-      #
-      # @example
-      # ```ruby
-      # case request_type
-      # in :bulk_request
-      #   # ...
-      # end
-      # ```
-      class RequestType < ModernTreasury::Enum
+      # supported `request_type`
+      module RequestType
+        extend ModernTreasury::Internal::Type::Enum
+
         BULK_REQUEST = :bulk_request
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of successful or failed.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :pending
-      #   # ...
-      # in :successful
-      #   # ...
-      # in :failed
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         PENDING = :pending
         SUCCESSFUL = :successful
         FAILED = :failed
@@ -182,7 +147,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/bulk_result_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class BulkResultRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::BulkResults#retrieve
+    class BulkResultRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/client_ping_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class ClientPingParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Client#ping
+    class ClientPingParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/connection.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class Connection < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Connections#list
+    class Connection < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -20,10 +21,10 @@ module ModernTreasury
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
-      #     if it exists in the test environment.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute object
       #
@@ -79,7 +80,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end