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

data/lib/modern_treasury/models/counterparty_delete_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class CounterpartyDeleteParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Counterparties#delete
+    class CounterpartyDeleteParams < 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/counterparty_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class CounterpartyListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Counterparties#list
+    class CounterpartyListParams < 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
       #
@@ -34,7 +35,7 @@ module ModernTreasury
 
       # @!attribute [r] email
       #   Performs a partial string match of the email field. This is also case
-      #     insensitive.
+      #   insensitive.
       #
       #   @return [String, nil]
       optional :email, String
@@ -55,11 +56,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}]
@@ -67,7 +68,7 @@ module ModernTreasury
 
       # @!attribute [r] name
       #   Performs a partial string match of the name field. This is also case
-      #     insensitive.
+      #   insensitive.
       #
       #   @return [String, nil]
       optional :name, String
@@ -111,7 +112,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/counterparty_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class CounterpartyRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Counterparties#retrieve
+    class CounterpartyRetrieveParams < 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/counterparty_update_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class CounterpartyUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Counterparties#update
+    class CounterpartyUpdateParams < 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] email
       #   A new email for the counterparty.
@@ -25,10 +26,10 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   Additional data in the form of key-value pairs. Pairs can be removed by passing
-      #     an empty string or `null` as the value.
+      #   an empty string or `null` as the value.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -46,10 +47,10 @@ module ModernTreasury
 
       # @!attribute [r] send_remittance_advice
       #   If this is `true`, Modern Treasury will send an email to the counterparty
-      #     whenever an associated payment order is sent to the bank.
+      #   whenever an associated payment order is sent to the bank.
       #
       #   @return [Boolean, nil]
-      optional :send_remittance_advice, ModernTreasury::BooleanModel
+      optional :send_remittance_advice, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -87,7 +88,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/currency.rb

@@ -2,28 +2,10 @@
 
 module ModernTreasury
   module Models
-    # @abstract
-    #
     # Three-letter ISO currency code.
-    #
-    # @example
-    # ```ruby
-    # case currency
-    # in :AED
-    #   # ...
-    # in :AFN
-    #   # ...
-    # in :ALL
-    #   # ...
-    # in :AMD
-    #   # ...
-    # in :ANG
-    #   # ...
-    # in ...
-    #   #...
-    # end
-    # ```
-    class Currency < ModernTreasury::Enum
+    module Currency
+      extend ModernTreasury::Internal::Type::Enum
+
       AED = :AED
       AFN = :AFN
       ALL = :ALL
@@ -218,7 +200,6 @@ module ModernTreasury
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end

data/lib/modern_treasury/models/document.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class Document < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Documents#create
+    class Document < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -22,7 +23,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::Document::DocumentDetail>]
       required :document_details,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::Document::DocumentDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::Document::DocumentDetail] }
 
       # @!attribute document_type
       #   A category given to the document, can be `null`.
@@ -38,8 +39,8 @@ module ModernTreasury
 
       # @!attribute documentable_type
       #   The type of the associated object. Currently can be one of `payment_order`,
-      #     `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      #     `case`, `internal_account`, `decision`, or `external_account`.
+      #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
+      #   `case`, `internal_account`, `decision`, or `external_account`.
       #
       #   @return [Symbol, ModernTreasury::Models::Document::DocumentableType]
       required :documentable_type, enum: -> { ModernTreasury::Models::Document::DocumentableType }
@@ -51,10 +52,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
       #
@@ -104,9 +105,9 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class DocumentDetail < ModernTreasury::BaseModel
+      class DocumentDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -134,10 +135,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,33 +174,17 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # The type of the associated object. Currently can be one of `payment_order`,
-      #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      #   `case`, `internal_account`, `decision`, or `external_account`.
+      # `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
+      # `case`, `internal_account`, `decision`, or `external_account`.
       #
-      # @example
-      # ```ruby
-      # case documentable_type
-      # in :case
-      #   # ...
-      # in :counterparty
-      #   # ...
-      # in :expected_payment
-      #   # ...
-      # in :external_account
-      #   # ...
-      # in :incoming_payment_detail
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class DocumentableType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::Document#documentable_type
+      module DocumentableType
+        extend ModernTreasury::Internal::Type::Enum
+
         CASE = :case
         COUNTERPARTY = :counterparty
         EXPECTED_PAYMENT = :expected_payment
@@ -217,11 +202,11 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      class File < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::Document#file
+      class File < ModernTreasury::Internal::Type::BaseModel
         # @!attribute [r] content_type
         #   The MIME content type of the document.
         #
@@ -259,7 +244,7 @@ module ModernTreasury
         #   #
         #   def initialize(content_type: nil, filename: nil, size: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/document_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class DocumentCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Documents#create
+    class DocumentCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute documentable_id
       #   The unique identifier for the associated object.
@@ -42,28 +43,11 @@ module ModernTreasury
       #   #
       #   def initialize(documentable_id:, documentable_type:, file:, document_type: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module DocumentableType
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case documentable_type
-      # in :cases
-      #   # ...
-      # in :counterparties
-      #   # ...
-      # in :expected_payments
-      #   # ...
-      # in :external_accounts
-      #   # ...
-      # in :incoming_payment_details
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class DocumentableType < ModernTreasury::Enum
         CASES = :cases
         COUNTERPARTIES = :counterparties
         EXPECTED_PAYMENTS = :expected_payments
@@ -81,7 +65,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/document_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class DocumentListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Documents#list
+    class DocumentListParams < 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,8 +25,8 @@ module ModernTreasury
 
       # @!attribute [r] documentable_type
       #   The type of the associated object. Currently can be one of `payment_order`,
-      #     `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      #     `case`, `internal_account`, `decision`, or `external_account`.
+      #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
+      #   `case`, `internal_account`, `decision`, or `external_account`.
       #
       #   @return [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType, nil]
       optional :documentable_type, enum: -> { ModernTreasury::Models::DocumentListParams::DocumentableType }
@@ -52,32 +53,14 @@ module ModernTreasury
       #   #
       #   def initialize(after_cursor: nil, documentable_id: nil, documentable_type: nil, per_page: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of the associated object. Currently can be one of `payment_order`,
-      #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
-      #   `case`, `internal_account`, `decision`, or `external_account`.
-      #
-      # @example
-      # ```ruby
-      # case documentable_type
-      # in :cases
-      #   # ...
-      # in :counterparties
-      #   # ...
-      # in :expected_payments
-      #   # ...
-      # in :external_accounts
-      #   # ...
-      # in :incoming_payment_details
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class DocumentableType < ModernTreasury::Enum
+      # `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
+      # `case`, `internal_account`, `decision`, or `external_account`.
+      module DocumentableType
+        extend ModernTreasury::Internal::Type::Enum
+
         CASES = :cases
         COUNTERPARTIES = :counterparties
         EXPECTED_PAYMENTS = :expected_payments
@@ -95,7 +78,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/document_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class DocumentRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Documents#retrieve
+    class DocumentRetrieveParams < 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/event.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class Event < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Events#retrieve
+    class Event < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -17,7 +18,7 @@ module ModernTreasury
       #   The body of the event.
       #
       #   @return [Hash{Symbol=>Object}]
-      required :data, ModernTreasury::HashOf[ModernTreasury::Unknown]
+      required :data, ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
 
       # @!attribute entity_id
       #   The ID of the entity for the event.
@@ -39,10 +40,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
       #
@@ -88,7 +89,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/event_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class EventListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Events#list
+    class EventListParams < 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
       #
@@ -92,7 +93,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/event_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class EventRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Events#retrieve
+    class EventRetrieveParams < 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