mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/models/receiving_account.rb

@@ -39,11 +39,11 @@ module ModernTreasury
     attr_accessor :discarded_at
 
     # Can be `checking`, `savings` or `other`.
-    # @return [AccountTypeEnum]
+    # @return [AccountType]
     attr_accessor :account_type
 
     # Either `individual` or `business`.
-    # @return [PartyTypeEnum]
+    # @return [PartyType]
     attr_accessor :party_type
 
     # Either `individual` or `business`.
@@ -85,7 +85,7 @@ module ModernTreasury
 
     # If the external account links to a ledger account in Modern Treasury, the
     # id of the ledger account will be populated here.
-    # @return [VerificationStatusEnum]
+    # @return [VerificationStatus]
     attr_accessor :verification_status
 
     # A mapping from model property names to API property names.
@@ -145,12 +145,16 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = SKIP, object = SKIP, live_mode = SKIP,
-                   created_at = SKIP, updated_at = SKIP, discarded_at = SKIP,
-                   account_type = SKIP, party_type = SKIP, party_address = SKIP,
-                   name = SKIP, account_details = SKIP, routing_details = SKIP,
-                   metadata = SKIP, party_name = SKIP, contact_details = SKIP,
-                   ledger_account_id = SKIP, verification_status = SKIP)
+    def initialize(id: SKIP, object: SKIP, live_mode: SKIP, created_at: SKIP,
+                   updated_at: SKIP, discarded_at: SKIP, account_type: SKIP,
+                   party_type: SKIP, party_address: SKIP, name: SKIP,
+                   account_details: SKIP, routing_details: SKIP, metadata: SKIP,
+                   party_name: SKIP, contact_details: SKIP,
+                   ledger_account_id: SKIP, verification_status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @id = id unless id == SKIP
       @object = object unless object == SKIP
       @live_mode = live_mode unless live_mode == SKIP
@@ -168,6 +172,7 @@ module ModernTreasury
       @contact_details = contact_details unless contact_details == SKIP
       @ledger_account_id = ledger_account_id unless ledger_account_id == SKIP
       @verification_status = verification_status unless verification_status == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -234,24 +239,32 @@ module ModernTreasury
       verification_status =
         hash.key?('verification_status') ? hash['verification_status'] : 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.
-      ReceivingAccount.new(id,
-                           object,
-                           live_mode,
-                           created_at,
-                           updated_at,
-                           discarded_at,
-                           account_type,
-                           party_type,
-                           party_address,
-                           name,
-                           account_details,
-                           routing_details,
-                           metadata,
-                           party_name,
-                           contact_details,
-                           ledger_account_id,
-                           verification_status)
+      ReceivingAccount.new(id: id,
+                           object: object,
+                           live_mode: live_mode,
+                           created_at: created_at,
+                           updated_at: updated_at,
+                           discarded_at: discarded_at,
+                           account_type: account_type,
+                           party_type: party_type,
+                           party_address: party_address,
+                           name: name,
+                           account_details: account_details,
+                           routing_details: routing_details,
+                           metadata: metadata,
+                           party_name: party_name,
+                           contact_details: contact_details,
+                           ledger_account_id: ledger_account_id,
+                           verification_status: verification_status,
+                           additional_properties: additional_properties)
     end
 
     def to_custom_created_at
@@ -284,7 +297,8 @@ module ModernTreasury
       " #{@account_type}, party_type: #{@party_type}, party_address: #{@party_address}, name:"\
       " #{@name}, account_details: #{@account_details}, routing_details: #{@routing_details},"\
       " metadata: #{@metadata}, party_name: #{@party_name}, contact_details: #{@contact_details},"\
-      " ledger_account_id: #{@ledger_account_id}, verification_status: #{@verification_status}>"
+      " ledger_account_id: #{@ledger_account_id}, verification_status: #{@verification_status},"\
+      " additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -298,7 +312,8 @@ module ModernTreasury
       " #{@account_details.inspect}, routing_details: #{@routing_details.inspect}, metadata:"\
       " #{@metadata.inspect}, party_name: #{@party_name.inspect}, contact_details:"\
       " #{@contact_details.inspect}, ledger_account_id: #{@ledger_account_id.inspect},"\
-      " verification_status: #{@verification_status.inspect}>"
+      " verification_status: #{@verification_status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/receiving_account1.rb

@@ -12,11 +12,11 @@ module ModernTreasury
     private_constant :SKIP
 
     # Can be `checking`, `savings` or `other`.
-    # @return [AccountTypeEnum]
+    # @return [AccountType]
     attr_accessor :account_type
 
     # Either `individual` or `business`.
-    # @return [PartyTypeEnum]
+    # @return [PartyType]
     attr_accessor :party_type
 
     # Either `individual` or `business`.
@@ -112,11 +112,14 @@ module ModernTreasury
       ]
     end
 
-    def initialize(account_type = SKIP, party_type = SKIP, party_address = SKIP,
-                   name = SKIP, account_details = SKIP, routing_details = SKIP,
-                   metadata = SKIP, party_name = SKIP, party_identifier = SKIP,
-                   ledger_account = SKIP, plaid_processor_token = SKIP,
-                   contact_details = SKIP)
+    def initialize(account_type: SKIP, party_type: SKIP, party_address: SKIP,
+                   name: SKIP, account_details: SKIP, routing_details: SKIP,
+                   metadata: SKIP, party_name: SKIP, party_identifier: SKIP,
+                   ledger_account: SKIP, plaid_processor_token: SKIP,
+                   contact_details: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @account_type = account_type unless account_type == SKIP
       @party_type = party_type unless party_type == SKIP
       @party_address = party_address unless party_address == SKIP
@@ -129,6 +132,7 @@ module ModernTreasury
       @ledger_account = ledger_account unless ledger_account == SKIP
       @plaid_processor_token = plaid_processor_token unless plaid_processor_token == SKIP
       @contact_details = contact_details unless contact_details == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -179,19 +183,27 @@ module ModernTreasury
 
       contact_details = SKIP unless hash.key?('contact_details')
 
+      # 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.
-      ReceivingAccount1.new(account_type,
-                            party_type,
-                            party_address,
-                            name,
-                            account_details,
-                            routing_details,
-                            metadata,
-                            party_name,
-                            party_identifier,
-                            ledger_account,
-                            plaid_processor_token,
-                            contact_details)
+      ReceivingAccount1.new(account_type: account_type,
+                            party_type: party_type,
+                            party_address: party_address,
+                            name: name,
+                            account_details: account_details,
+                            routing_details: routing_details,
+                            metadata: metadata,
+                            party_name: party_name,
+                            party_identifier: party_identifier,
+                            ledger_account: ledger_account,
+                            plaid_processor_token: plaid_processor_token,
+                            contact_details: contact_details,
+                            additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
@@ -201,7 +213,8 @@ module ModernTreasury
       " #{@party_address}, name: #{@name}, account_details: #{@account_details}, routing_details:"\
       " #{@routing_details}, metadata: #{@metadata}, party_name: #{@party_name}, party_identifier:"\
       " #{@party_identifier}, ledger_account: #{@ledger_account}, plaid_processor_token:"\
-      " #{@plaid_processor_token}, contact_details: #{@contact_details}>"
+      " #{@plaid_processor_token}, contact_details: #{@contact_details}, additional_properties:"\
+      " #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -213,7 +226,7 @@ module ModernTreasury
       " #{@metadata.inspect}, party_name: #{@party_name.inspect}, party_identifier:"\
       " #{@party_identifier.inspect}, ledger_account: #{@ledger_account.inspect},"\
       " plaid_processor_token: #{@plaid_processor_token.inspect}, contact_details:"\
-      " #{@contact_details.inspect}>"
+      " #{@contact_details.inspect}, additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/{receiving_account_type_enum.rb → receiving_account_type.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # ReceivingAccountType.
-  class ReceivingAccountTypeEnum
-    RECEIVING_ACCOUNT_TYPE_ENUM = [
+  class ReceivingAccountType
+    RECEIVING_ACCOUNT_TYPE = [
       # TODO: Write general description for INTERNAL_ACCOUNT
       INTERNAL_ACCOUNT = 'internal_account'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      RECEIVING_ACCOUNT_TYPE_ENUM.include?(value)
+      RECEIVING_ACCOUNT_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = INTERNAL_ACCOUNT)

data/lib/modern_treasury/models/{reconciliation_method_enum.rb → reconciliation_method.rb}

@@ -7,8 +7,8 @@ module ModernTreasury
   # 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.
-  class ReconciliationMethodEnum
-    RECONCILIATION_METHOD_ENUM = [
+  class ReconciliationMethod
+    RECONCILIATION_METHOD = [
       # TODO: Write general description for AUTOMATIC
       AUTOMATIC = 'automatic'.freeze,
 
@@ -19,7 +19,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      RECONCILIATION_METHOD_ENUM.include?(value)
+      RECONCILIATION_METHOD.include?(value)
     end
 
     def self.from_value(value, default_value = AUTOMATIC)

data/lib/modern_treasury/models/{reference_number_type_enum.rb → reference_number_type.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The type of the reference number. Referring to the vendor payment id.
-  class ReferenceNumberTypeEnum
-    REFERENCE_NUMBER_TYPE_ENUM = [
+  class ReferenceNumberType
+    REFERENCE_NUMBER_TYPE = [
       # TODO: Write general description for ACH_ORIGINAL_TRACE_NUMBER
       ACH_ORIGINAL_TRACE_NUMBER = 'ach_original_trace_number'.freeze,
 
@@ -176,7 +176,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      REFERENCE_NUMBER_TYPE_ENUM.include?(value)
+      REFERENCE_NUMBER_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = ACH_ORIGINAL_TRACE_NUMBER)

data/lib/modern_treasury/models/{reference_number_type1_enum.rb → reference_number_type1.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The type of reference number.
-  class ReferenceNumberType1Enum
-    REFERENCE_NUMBER_TYPE1_ENUM = [
+  class ReferenceNumberType1
+    REFERENCE_NUMBER_TYPE1 = [
       # TODO: Write general description for ACH_ORIGINAL_TRACE_NUMBER
       ACH_ORIGINAL_TRACE_NUMBER = 'ach_original_trace_number'.freeze,
 
@@ -176,7 +176,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      REFERENCE_NUMBER_TYPE1_ENUM.include?(value)
+      REFERENCE_NUMBER_TYPE1.include?(value)
     end
 
     def self.from_value(value, default_value = ACH_ORIGINAL_TRACE_NUMBER)

data/lib/modern_treasury/models/{referenceable_type_enum.rb → referenceable_type.rb}

@@ -6,8 +6,8 @@
 module ModernTreasury
   # One of the referenceable types. This must be accompanied by the id of the
   # referenceable or will return an error.
-  class ReferenceableTypeEnum
-    REFERENCEABLE_TYPE_ENUM = [
+  class ReferenceableType
+    REFERENCEABLE_TYPE = [
       # TODO: Write general description for PAYMENT_ORDER
       PAYMENT_ORDER = 'payment_order'.freeze,
 
@@ -21,7 +21,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      REFERENCEABLE_TYPE_ENUM.include?(value)
+      REFERENCEABLE_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = PAYMENT_ORDER)

data/lib/modern_treasury/models/{referenceable_type1_enum.rb → referenceable_type1.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # referenceable_type1.
-  class ReferenceableType1Enum
-    REFERENCEABLE_TYPE1_ENUM = [
+  class ReferenceableType1
+    REFERENCEABLE_TYPE1 = [
       # TODO: Write general description for PAYMENT_ORDER
       PAYMENT_ORDER = 'payment_order'.freeze,
 
@@ -20,7 +20,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      REFERENCEABLE_TYPE1_ENUM.include?(value)
+      REFERENCEABLE_TYPE1.include?(value)
     end
 
     def self.from_value(value, default_value = PAYMENT_ORDER)

data/lib/modern_treasury/models/return_create_request.rb

@@ -14,7 +14,7 @@ module ModernTreasury
     attr_accessor :returnable_id
 
     # The return code. For ACH returns, this is the required ACH return code.
-    # @return [Code1Enum]
+    # @return [Code1]
     attr_accessor :code
 
     # An optional description of the reason for the return. This is for internal
@@ -70,14 +70,19 @@ module ModernTreasury
       ]
     end
 
-    def initialize(returnable_id = nil, code = SKIP, reason = SKIP,
-                   date_of_death = SKIP, additional_information = SKIP)
+    def initialize(returnable_id:, code: SKIP, reason: SKIP,
+                   date_of_death: SKIP, additional_information: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @returnable_id = returnable_id
       @code = code unless code == SKIP
       @reason = reason unless reason == SKIP
       @date_of_death = date_of_death unless date_of_death == SKIP
       @additional_information = additional_information unless additional_information == SKIP
       @returnable_type = 'incoming_payment_detail'
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -92,12 +97,20 @@ module ModernTreasury
       additional_information =
         hash.key?('additional_information') ? hash['additional_information'] : 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.
-      ReturnCreateRequest.new(returnable_id,
-                              code,
-                              reason,
-                              date_of_death,
-                              additional_information)
+      ReturnCreateRequest.new(returnable_id: returnable_id,
+                              code: code,
+                              reason: reason,
+                              date_of_death: date_of_death,
+                              additional_information: additional_information,
+                              additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
@@ -105,7 +118,7 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} returnable_id: #{@returnable_id}, code: #{@code}, reason: #{@reason},"\
       " date_of_death: #{@date_of_death}, additional_information: #{@additional_information},"\
-      " returnable_type: #{@returnable_type}>"
+      " returnable_type: #{@returnable_type}, additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -113,7 +126,8 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} returnable_id: #{@returnable_id.inspect}, code: #{@code.inspect}, reason:"\
       " #{@reason.inspect}, date_of_death: #{@date_of_death.inspect}, additional_information:"\
-      " #{@additional_information.inspect}, returnable_type: #{@returnable_type.inspect}>"
+      " #{@additional_information.inspect}, returnable_type: #{@returnable_type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/{returnable_type_enum.rb → returnable_type.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The type of object being returned or `null`.
-  class ReturnableTypeEnum
-    RETURNABLE_TYPE_ENUM = [
+  class ReturnableType
+    RETURNABLE_TYPE = [
       # TODO: Write general description for INCOMING_PAYMENT_DETAIL
       INCOMING_PAYMENT_DETAIL = 'incoming_payment_detail'.freeze,
 
@@ -26,7 +26,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      RETURNABLE_TYPE_ENUM.include?(value)
+      RETURNABLE_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = INCOMING_PAYMENT_DETAIL)

data/lib/modern_treasury/models/{returnable_type1_enum.rb → returnable_type1.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # returnable_type1.
-  class ReturnableType1Enum
-    RETURNABLE_TYPE1_ENUM = [
+  class ReturnableType1
+    RETURNABLE_TYPE1 = [
       # TODO: Write general description for INCOMING_PAYMENT_DETAIL
       INCOMING_PAYMENT_DETAIL = 'incoming_payment_detail'.freeze,
 
@@ -26,7 +26,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      RETURNABLE_TYPE1_ENUM.include?(value)
+      RETURNABLE_TYPE1.include?(value)
     end
 
     def self.from_value(value, default_value = INCOMING_PAYMENT_DETAIL)

data/lib/modern_treasury/models/reversal.rb

@@ -34,7 +34,7 @@ module ModernTreasury
     attr_accessor :updated_at
 
     # The current status of the reversal.
-    # @return [Status19Enum]
+    # @return [Status19]
     attr_accessor :status
 
     # The ID of the relevant Payment Order.
@@ -47,7 +47,7 @@ module ModernTreasury
     attr_accessor :metadata
 
     # The reason for the reversal.
-    # @return [ReasonEnum]
+    # @return [Reason]
     attr_accessor :reason
 
     # A mapping from model property names to API property names.
@@ -77,9 +77,8 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, status = nil, payment_order_id = nil,
-                   metadata = nil, reason = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:, status:,
+                   payment_order_id:, metadata:, reason:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -112,15 +111,15 @@ module ModernTreasury
       reason = hash.key?('reason') ? hash['reason'] : nil
 
       # Create object from extracted values.
-      Reversal.new(id,
-                   object,
-                   live_mode,
-                   created_at,
-                   updated_at,
-                   status,
-                   payment_order_id,
-                   metadata,
-                   reason)
+      Reversal.new(id: id,
+                   object: object,
+                   live_mode: live_mode,
+                   created_at: created_at,
+                   updated_at: updated_at,
+                   status: status,
+                   payment_order_id: payment_order_id,
+                   metadata: metadata,
+                   reason: reason)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/reversal_create_request.rb

@@ -12,7 +12,7 @@ module ModernTreasury
     # The reason for the reversal. Must be one of `duplicate`,
     # `incorrect_amount`, `incorrect_receiving_account`,
     # `date_earlier_than_intended`, `date_later_than_intended`.
-    # @return [Reason1Enum]
+    # @return [Reason1]
     attr_accessor :reason
 
     # Additional data represented as key-value pairs. Both the key and value
@@ -47,10 +47,15 @@ module ModernTreasury
       []
     end
 
-    def initialize(reason = nil, metadata = SKIP, ledger_transaction = SKIP)
+    def initialize(reason:, metadata: SKIP, ledger_transaction: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @reason = reason
       @metadata = metadata unless metadata == SKIP
       @ledger_transaction = ledger_transaction unless ledger_transaction == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -63,24 +68,33 @@ module ModernTreasury
       ledger_transaction = LedgerTransactionCreateRequest.from_hash(hash['ledger_transaction']) if
         hash['ledger_transaction']
 
+      # 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.
-      ReversalCreateRequest.new(reason,
-                                metadata,
-                                ledger_transaction)
+      ReversalCreateRequest.new(reason: reason,
+                                metadata: metadata,
+                                ledger_transaction: ledger_transaction,
+                                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} reason: #{@reason}, metadata: #{@metadata}, ledger_transaction:"\
-      " #{@ledger_transaction}>"
+      " #{@ledger_transaction}, 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} reason: #{@reason.inspect}, metadata: #{@metadata.inspect},"\
-      " ledger_transaction: #{@ledger_transaction.inspect}>"
+      " ledger_transaction: #{@ledger_transaction.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/{role_enum.rb → role.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The role of the return, can be `originating` or `receiving`.
-  class RoleEnum
-    ROLE_ENUM = [
+  class Role
+    ROLE = [
       # TODO: Write general description for ORIGINATING
       ORIGINATING = 'originating'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      ROLE_ENUM.include?(value)
+      ROLE.include?(value)
     end
 
     def self.from_value(value, default_value = ORIGINATING)