mt-sdk 0.0.1 → 0.0.4

data/lib/modern_treasury/models/{direction4_enum.rb → direction4.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # One of `credit` or `debit`.
-  class Direction4Enum
-    DIRECTION4_ENUM = [
+  class Direction4
+    DIRECTION4 = [
       # TODO: Write general description for CREDIT
       CREDIT = 'credit'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      DIRECTION4_ENUM.include?(value)
+      DIRECTION4.include?(value)
     end
 
     def self.from_value(value, default_value = CREDIT)

data/lib/modern_treasury/models/{direction5_enum.rb → direction5.rb}

@@ -8,8 +8,8 @@ module ModernTreasury
   # transaction. A `credit` moves money from your account to someone else's. A
   # `debit` pulls money from someone else's account to your own. Note that wire,
   # rtp, and check payments will always be `credit`.
-  class Direction5Enum
-    DIRECTION5_ENUM = [
+  class Direction5
+    DIRECTION5 = [
       # TODO: Write general description for CREDIT
       CREDIT = 'credit'.freeze,
 
@@ -20,7 +20,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      DIRECTION5_ENUM.include?(value)
+      DIRECTION5.include?(value)
     end
 
     def self.from_value(value, default_value = CREDIT)

data/lib/modern_treasury/models/{direction9_enum.rb → direction9.rb}

@@ -6,8 +6,8 @@
 module ModernTreasury
   # Describes the direction money is flowing in the transaction. Can only be
   # `debit`. A `debit` pulls money from someone else's account to your own.
-  class Direction9Enum
-    DIRECTION9_ENUM = [
+  class Direction9
+    DIRECTION9 = [
       # TODO: Write general description for CREDIT
       CREDIT = 'credit'.freeze,
 
@@ -18,7 +18,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      DIRECTION9_ENUM.include?(value)
+      DIRECTION9.include?(value)
     end
 
     def self.from_value(value, default_value = CREDIT)

data/lib/modern_treasury/models/document.rb

@@ -55,7 +55,7 @@ module ModernTreasury
     # `payment_order`, `transaction`, `paper_item`, `expected_payment`,
     # `counterparty`, `organization`, `case`, `internal_account`, `decision`, or
     # `external_account`.
-    # @return [DocumentableTypeEnum]
+    # @return [DocumentableType]
     attr_accessor :documentable_type
 
     # The type of the associated object. Currently can be one of
@@ -103,10 +103,9 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, discarded_at = nil, document_type = nil,
-                   source = nil, documentable_id = nil, documentable_type = nil,
-                   document_details = nil, file = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   discarded_at:, document_type:, source:, documentable_id:,
+                   documentable_type:, document_details:, file:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -157,18 +156,18 @@ module ModernTreasury
       file = File.from_hash(hash['file']) if hash['file']
 
       # Create object from extracted values.
-      Document.new(id,
-                   object,
-                   live_mode,
-                   created_at,
-                   updated_at,
-                   discarded_at,
-                   document_type,
-                   source,
-                   documentable_id,
-                   documentable_type,
-                   document_details,
-                   file)
+      Document.new(id: id,
+                   object: object,
+                   live_mode: live_mode,
+                   created_at: created_at,
+                   updated_at: updated_at,
+                   discarded_at: discarded_at,
+                   document_type: document_type,
+                   source: source,
+                   documentable_id: documentable_id,
+                   documentable_type: documentable_type,
+                   document_details: document_details,
+                   file: file)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/document_create_request.rb

@@ -14,7 +14,7 @@ module ModernTreasury
     attr_accessor :documentable_id
 
     # The unique identifier for the associated object.
-    # @return [DocumentableType1Enum]
+    # @return [DocumentableType1]
     attr_accessor :documentable_type
 
     # A category given to the document, can be `null`.
@@ -47,12 +47,16 @@ module ModernTreasury
       []
     end
 
-    def initialize(documentable_id = nil, documentable_type = nil, file = nil,
-                   document_type = SKIP)
+    def initialize(documentable_id:, documentable_type:, file:,
+                   document_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @documentable_id = documentable_id
       @documentable_type = documentable_type
       @document_type = document_type unless document_type == SKIP
       @file = file
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -67,18 +71,27 @@ module ModernTreasury
       file = hash.key?('file') ? hash['file'] : nil
       document_type = hash.key?('document_type') ? hash['document_type'] : SKIP
 
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
       # Create object from extracted values.
-      DocumentCreateRequest.new(documentable_id,
-                                documentable_type,
-                                file,
-                                document_type)
+      DocumentCreateRequest.new(documentable_id: documentable_id,
+                                documentable_type: documentable_type,
+                                file: file,
+                                document_type: document_type,
+                                additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
       "<#{class_name} documentable_id: #{@documentable_id}, documentable_type:"\
-      " #{@documentable_type}, document_type: #{@document_type}, file: #{@file}>"
+      " #{@documentable_type}, document_type: #{@document_type}, file: #{@file},"\
+      " additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -86,7 +99,7 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} documentable_id: #{@documentable_id.inspect}, documentable_type:"\
       " #{@documentable_type.inspect}, document_type: #{@document_type.inspect}, file:"\
-      " #{@file.inspect}>"
+      " #{@file.inspect}, additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/document_detail.rb

@@ -74,9 +74,9 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, discarded_at = nil,
-                   document_identifier_type = nil, document_identifier = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   discarded_at:, document_identifier_type:,
+                   document_identifier:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -110,14 +110,14 @@ module ModernTreasury
         hash.key?('document_identifier') ? hash['document_identifier'] : nil
 
       # Create object from extracted values.
-      DocumentDetail.new(id,
-                         object,
-                         live_mode,
-                         created_at,
-                         updated_at,
-                         discarded_at,
-                         document_identifier_type,
-                         document_identifier)
+      DocumentDetail.new(id: id,
+                         object: object,
+                         live_mode: live_mode,
+                         created_at: created_at,
+                         updated_at: updated_at,
+                         discarded_at: discarded_at,
+                         document_identifier_type: document_identifier_type,
+                         document_identifier: document_identifier)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/{documentable_type_enum.rb → documentable_type.rb}

@@ -8,8 +8,8 @@ module ModernTreasury
   # `transaction`, `paper_item`, `expected_payment`, `counterparty`,
   # `organization`, `case`, `internal_account`, `decision`, or
   # `external_account`.
-  class DocumentableTypeEnum
-    DOCUMENTABLE_TYPE_ENUM = [
+  class DocumentableType
+    DOCUMENTABLE_TYPE = [
       # TODO: Write general description for ENUM_CASE
       ENUM_CASE = 'case'.freeze,
 
@@ -47,7 +47,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      DOCUMENTABLE_TYPE_ENUM.include?(value)
+      DOCUMENTABLE_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = ENUM_CASE)

data/lib/modern_treasury/models/{documentable_type1_enum.rb → documentable_type1.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # DocumentableType1.
-  class DocumentableType1Enum
-    DOCUMENTABLE_TYPE1_ENUM = [
+  class DocumentableType1
+    DOCUMENTABLE_TYPE1 = [
       # TODO: Write general description for CASES
       CASES = 'cases'.freeze,
 
@@ -44,7 +44,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      DOCUMENTABLE_TYPE1_ENUM.include?(value)
+      DOCUMENTABLE_TYPE1.include?(value)
     end
 
     def self.from_value(value, default_value = CASES)

data/lib/modern_treasury/models/{documentable_type2_enum.rb → documentable_type2.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # documentable_type2.
-  class DocumentableType2Enum
-    DOCUMENTABLE_TYPE2_ENUM = [
+  class DocumentableType2
+    DOCUMENTABLE_TYPE2 = [
       # TODO: Write general description for CASES
       CASES = 'cases'.freeze,
 
@@ -44,7 +44,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      DOCUMENTABLE_TYPE2_ENUM.include?(value)
+      DOCUMENTABLE_TYPE2.include?(value)
     end
 
     def self.from_value(value, default_value = CASES)

data/lib/modern_treasury/models/{effective_at_enum.rb → effective_at.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # EffectiveAt.
-  class EffectiveAtEnum
-    EFFECTIVE_AT_ENUM = [
+  class EffectiveAt
+    EFFECTIVE_AT = [
       # TODO: Write general description for ASC
       ASC = 'asc'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      EFFECTIVE_AT_ENUM.include?(value)
+      EFFECTIVE_AT.include?(value)
     end
 
     def self.from_value(value, default_value = ASC)

data/lib/modern_treasury/models/errors.rb

@@ -10,7 +10,7 @@ module ModernTreasury
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [CodeEnum]
+    # @return [Code]
     attr_accessor :code
 
     # TODO: Write general description for this method
@@ -44,10 +44,15 @@ module ModernTreasury
       []
     end
 
-    def initialize(code = SKIP, message = SKIP, parameter = SKIP)
+    def initialize(code: SKIP, message: SKIP, parameter: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @code = code unless code == SKIP
       @message = message unless message == SKIP
       @parameter = parameter unless parameter == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -59,23 +64,32 @@ module ModernTreasury
       message = hash.key?('message') ? hash['message'] : SKIP
       parameter = hash.key?('parameter') ? hash['parameter'] : SKIP
 
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
       # Create object from extracted values.
-      Errors.new(code,
-                 message,
-                 parameter)
+      Errors.new(code: code,
+                 message: message,
+                 parameter: parameter,
+                 additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} code: #{@code}, message: #{@message}, parameter: #{@parameter}>"
+      "<#{class_name} code: #{@code}, message: #{@message}, parameter: #{@parameter},"\
+      " additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
       "<#{class_name} code: #{@code.inspect}, message: #{@message.inspect}, parameter:"\
-      " #{@parameter.inspect}>"
+      " #{@parameter.inspect}, additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/event.rb

@@ -79,9 +79,8 @@ module ModernTreasury
       []
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, resource = nil, event_name = nil,
-                   event_time = nil, data = nil, entity_id = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   resource:, event_name:, event_time:, data:, entity_id:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -117,16 +116,16 @@ module ModernTreasury
       entity_id = hash.key?('entity_id') ? hash['entity_id'] : nil
 
       # Create object from extracted values.
-      Event.new(id,
-                object,
-                live_mode,
-                created_at,
-                updated_at,
-                resource,
-                event_name,
-                event_time,
-                data,
-                entity_id)
+      Event.new(id: id,
+                object: object,
+                live_mode: live_mode,
+                created_at: created_at,
+                updated_at: updated_at,
+                resource: resource,
+                event_name: event_name,
+                event_time: event_time,
+                data: data,
+                entity_id: entity_id)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/expected_payment.rb

@@ -45,7 +45,7 @@ module ModernTreasury
 
     # One of credit or debit. When you are receiving money, use credit. When you
     # are being charged, use debit.
-    # @return [Direction1Enum]
+    # @return [Direction1]
     attr_accessor :direction
 
     # The ID of the Internal Account for the expected payment.
@@ -54,11 +54,11 @@ module ModernTreasury
 
     # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,
     # sen, sepa, signet, wire.
-    # @return [Type1Enum]
+    # @return [Type1]
     attr_accessor :type
 
     # Three-letter ISO currency code.
-    # @return [CurrencyEnum]
+    # @return [Currency]
     attr_accessor :currency
 
     # The latest date the payment may come in. Format: yyyy-mm-dd
@@ -114,13 +114,13 @@ module ModernTreasury
     attr_accessor :transaction_line_item_id
 
     # One of unreconciled, reconciled, or archived.
-    # @return [Status1Enum]
+    # @return [Status1]
     attr_accessor :status
 
     # One of manual if this expected payment was manually reconciled in the
     # dashboard, automatic if it was automatically reconciled by Modern
     # Treasury, or null if it is unreconciled.
-    # @return [ReconciliationMethodEnum]
+    # @return [ReconciliationMethod]
     attr_accessor :reconciliation_method
 
     # The ID of the ledger transaction linked to the expected payment.
@@ -182,17 +182,14 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, amount_upper_bound = nil,
-                   amount_lower_bound = nil, direction = nil,
-                   internal_account_id = nil, type = nil, currency = nil,
-                   date_upper_bound = nil, date_lower_bound = nil,
-                   description = nil, statement_descriptor = nil,
-                   metadata = nil, counterparty_id = nil,
-                   remittance_information = nil, reconciliation_groups = nil,
-                   reconciliation_filters = nil, transaction_id = nil,
-                   transaction_line_item_id = nil, status = nil,
-                   reconciliation_method = nil, ledger_transaction_id = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   amount_upper_bound:, amount_lower_bound:, direction:,
+                   internal_account_id:, type:, currency:, date_upper_bound:,
+                   date_lower_bound:, description:, statement_descriptor:,
+                   metadata:, counterparty_id:, remittance_information:,
+                   reconciliation_groups:, reconciliation_filters:,
+                   transaction_id:, transaction_line_item_id:, status:,
+                   reconciliation_method:, ledger_transaction_id:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -270,31 +267,31 @@ module ModernTreasury
         hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : nil
 
       # Create object from extracted values.
-      ExpectedPayment.new(id,
-                          object,
-                          live_mode,
-                          created_at,
-                          updated_at,
-                          amount_upper_bound,
-                          amount_lower_bound,
-                          direction,
-                          internal_account_id,
-                          type,
-                          currency,
-                          date_upper_bound,
-                          date_lower_bound,
-                          description,
-                          statement_descriptor,
-                          metadata,
-                          counterparty_id,
-                          remittance_information,
-                          reconciliation_groups,
-                          reconciliation_filters,
-                          transaction_id,
-                          transaction_line_item_id,
-                          status,
-                          reconciliation_method,
-                          ledger_transaction_id)
+      ExpectedPayment.new(id: id,
+                          object: object,
+                          live_mode: live_mode,
+                          created_at: created_at,
+                          updated_at: updated_at,
+                          amount_upper_bound: amount_upper_bound,
+                          amount_lower_bound: amount_lower_bound,
+                          direction: direction,
+                          internal_account_id: internal_account_id,
+                          type: type,
+                          currency: currency,
+                          date_upper_bound: date_upper_bound,
+                          date_lower_bound: date_lower_bound,
+                          description: description,
+                          statement_descriptor: statement_descriptor,
+                          metadata: metadata,
+                          counterparty_id: counterparty_id,
+                          remittance_information: remittance_information,
+                          reconciliation_groups: reconciliation_groups,
+                          reconciliation_filters: reconciliation_filters,
+                          transaction_id: transaction_id,
+                          transaction_line_item_id: transaction_line_item_id,
+                          status: status,
+                          reconciliation_method: reconciliation_method,
+                          ledger_transaction_id: ledger_transaction_id)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/expected_payment_create_request.rb

@@ -21,7 +21,7 @@ module ModernTreasury
 
     # One of credit or debit. When you are receiving money, use credit. When you
     # are being charged, use debit.
-    # @return [Direction1Enum]
+    # @return [Direction1]
     attr_accessor :direction
 
     # The ID of the Internal Account for the expected payment.
@@ -30,11 +30,11 @@ module ModernTreasury
 
     # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,
     # sen, sepa, signet, wire.
-    # @return [Type1Enum]
+    # @return [Type1]
     attr_accessor :type
 
     # Three-letter ISO currency code.
-    # @return [CurrencyEnum]
+    # @return [Currency]
     attr_accessor :currency
 
     # The latest date the payment may come in. Format: yyyy-mm-dd
@@ -138,14 +138,17 @@ module ModernTreasury
       ]
     end
 
-    def initialize(amount_upper_bound = nil, amount_lower_bound = nil,
-                   direction = nil, internal_account_id = nil, type = SKIP,
-                   currency = SKIP, date_upper_bound = SKIP,
-                   date_lower_bound = SKIP, description = SKIP,
-                   statement_descriptor = SKIP, metadata = SKIP,
-                   counterparty_id = SKIP, remittance_information = SKIP,
-                   reconciliation_groups = SKIP, reconciliation_filters = SKIP,
-                   line_items = SKIP)
+    def initialize(amount_upper_bound:, amount_lower_bound:, direction:,
+                   internal_account_id:, type: SKIP, currency: SKIP,
+                   date_upper_bound: SKIP, date_lower_bound: SKIP,
+                   description: SKIP, statement_descriptor: SKIP,
+                   metadata: SKIP, counterparty_id: SKIP,
+                   remittance_information: SKIP, reconciliation_groups: SKIP,
+                   reconciliation_filters: SKIP, line_items: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @amount_upper_bound = amount_upper_bound
       @amount_lower_bound = amount_lower_bound
       @direction = direction
@@ -162,6 +165,7 @@ module ModernTreasury
       @reconciliation_groups = reconciliation_groups unless reconciliation_groups == SKIP
       @reconciliation_filters = reconciliation_filters unless reconciliation_filters == SKIP
       @line_items = line_items unless line_items == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -205,23 +209,31 @@ module ModernTreasury
 
       line_items = SKIP unless hash.key?('line_items')
 
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
       # Create object from extracted values.
-      ExpectedPaymentCreateRequest.new(amount_upper_bound,
-                                       amount_lower_bound,
-                                       direction,
-                                       internal_account_id,
-                                       type,
-                                       currency,
-                                       date_upper_bound,
-                                       date_lower_bound,
-                                       description,
-                                       statement_descriptor,
-                                       metadata,
-                                       counterparty_id,
-                                       remittance_information,
-                                       reconciliation_groups,
-                                       reconciliation_filters,
-                                       line_items)
+      ExpectedPaymentCreateRequest.new(amount_upper_bound: amount_upper_bound,
+                                       amount_lower_bound: amount_lower_bound,
+                                       direction: direction,
+                                       internal_account_id: internal_account_id,
+                                       type: type,
+                                       currency: currency,
+                                       date_upper_bound: date_upper_bound,
+                                       date_lower_bound: date_lower_bound,
+                                       description: description,
+                                       statement_descriptor: statement_descriptor,
+                                       metadata: metadata,
+                                       counterparty_id: counterparty_id,
+                                       remittance_information: remittance_information,
+                                       reconciliation_groups: reconciliation_groups,
+                                       reconciliation_filters: reconciliation_filters,
+                                       line_items: line_items,
+                                       additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
@@ -234,7 +246,8 @@ module ModernTreasury
       " #{@description}, statement_descriptor: #{@statement_descriptor}, metadata: #{@metadata},"\
       " counterparty_id: #{@counterparty_id}, remittance_information: #{@remittance_information},"\
       " reconciliation_groups: #{@reconciliation_groups}, reconciliation_filters:"\
-      " #{@reconciliation_filters}, line_items: #{@line_items}>"
+      " #{@reconciliation_filters}, line_items: #{@line_items}, additional_properties:"\
+      " #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -248,7 +261,8 @@ module ModernTreasury
       " #{@statement_descriptor.inspect}, metadata: #{@metadata.inspect}, counterparty_id:"\
       " #{@counterparty_id.inspect}, remittance_information: #{@remittance_information.inspect},"\
       " reconciliation_groups: #{@reconciliation_groups.inspect}, reconciliation_filters:"\
-      " #{@reconciliation_filters.inspect}, line_items: #{@line_items.inspect}>"
+      " #{@reconciliation_filters.inspect}, line_items: #{@line_items.inspect},"\
+      " additional_properties: #{@additional_properties}>"
     end
   end
 end