mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/models/mreturn.rb

@@ -38,11 +38,11 @@ module ModernTreasury
     attr_accessor :returnable_id
 
     # The type of object being returned or `null`.
-    # @return [ReturnableTypeEnum]
+    # @return [ReturnableType]
     attr_accessor :returnable_type
 
     # The return code. For ACH returns, this is the required ACH return code.
-    # @return [Code1Enum]
+    # @return [Code1]
     attr_accessor :code
 
     # Often the bank will provide an explanation for the return, which is a
@@ -61,7 +61,7 @@ module ModernTreasury
     attr_accessor :additional_information
 
     # The current status of the return.
-    # @return [Status4Enum]
+    # @return [Status4]
     attr_accessor :status
 
     # The ID of the relevant Transaction Line Item or `null`.
@@ -78,7 +78,7 @@ module ModernTreasury
 
     # The type of return. Can be one of: `ach`, `ach_noc`, `au_becs`, `bacs`,
     # `eft`, `interac`, `manual`, `paper_item`, `wire`.
-    # @return [Type6Enum]
+    # @return [Type6]
     attr_accessor :type
 
     # Value in specified currency's smallest unit. e.g. $10 would be represented
@@ -87,7 +87,7 @@ module ModernTreasury
     attr_accessor :amount
 
     # Three-letter ISO currency code.
-    # @return [CurrencyEnum]
+    # @return [Currency]
     attr_accessor :currency
 
     # If an originating return failed to be processed by the bank, a description
@@ -96,7 +96,7 @@ module ModernTreasury
     attr_accessor :failure_reason
 
     # The role of the return, can be `originating` or `receiving`.
-    # @return [RoleEnum]
+    # @return [Role]
     attr_accessor :role
 
     # The role of the return, can be `originating` or `receiving`.
@@ -162,15 +162,13 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, returnable_id = nil, returnable_type = nil,
-                   code = nil, reason = nil, date_of_death = nil,
-                   additional_information = nil, status = nil,
-                   transaction_line_item_id = nil, transaction_id = nil,
-                   internal_account_id = nil, type = nil, amount = nil,
-                   currency = nil, failure_reason = nil, role = nil,
-                   current_return = nil, reference_numbers = nil,
-                   ledger_transaction_id = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   returnable_id:, returnable_type:, code:, reason:,
+                   date_of_death:, additional_information:, status:,
+                   transaction_line_item_id:, transaction_id:,
+                   internal_account_id:, type:, amount:, currency:,
+                   failure_reason:, role:, current_return:, reference_numbers:,
+                   ledger_transaction_id:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -246,29 +244,29 @@ module ModernTreasury
         hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : nil
 
       # Create object from extracted values.
-      Return.new(id,
-                 object,
-                 live_mode,
-                 created_at,
-                 updated_at,
-                 returnable_id,
-                 returnable_type,
-                 code,
-                 reason,
-                 date_of_death,
-                 additional_information,
-                 status,
-                 transaction_line_item_id,
-                 transaction_id,
-                 internal_account_id,
-                 type,
-                 amount,
-                 currency,
-                 failure_reason,
-                 role,
-                 current_return,
-                 reference_numbers,
-                 ledger_transaction_id)
+      Return.new(id: id,
+                 object: object,
+                 live_mode: live_mode,
+                 created_at: created_at,
+                 updated_at: updated_at,
+                 returnable_id: returnable_id,
+                 returnable_type: returnable_type,
+                 code: code,
+                 reason: reason,
+                 date_of_death: date_of_death,
+                 additional_information: additional_information,
+                 status: status,
+                 transaction_line_item_id: transaction_line_item_id,
+                 transaction_id: transaction_id,
+                 internal_account_id: internal_account_id,
+                 type: type,
+                 amount: amount,
+                 currency: currency,
+                 failure_reason: failure_reason,
+                 role: role,
+                 current_return: current_return,
+                 reference_numbers: reference_numbers,
+                 ledger_transaction_id: ledger_transaction_id)
     end
 
     def to_custom_created_at
@@ -297,9 +295,9 @@ module ModernTreasury
             APIHelper.valid_type?(value.returnable_id,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.returnable_type,
-                                  ->(val) { ReturnableTypeEnum.validate(val) }) and
+                                  ->(val) { ReturnableType.validate(val) }) and
             APIHelper.valid_type?(value.code,
-                                  ->(val) { Code1Enum.validate(val) }) and
+                                  ->(val) { Code1.validate(val) }) and
             APIHelper.valid_type?(value.reason,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.date_of_death,
@@ -307,7 +305,7 @@ module ModernTreasury
             APIHelper.valid_type?(value.additional_information,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.status,
-                                  ->(val) { Status4Enum.validate(val) }) and
+                                  ->(val) { Status4.validate(val) }) and
             APIHelper.valid_type?(value.transaction_line_item_id,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.transaction_id,
@@ -315,15 +313,15 @@ module ModernTreasury
             APIHelper.valid_type?(value.internal_account_id,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.type,
-                                  ->(val) { Type6Enum.validate(val) }) and
+                                  ->(val) { Type6.validate(val) }) and
             APIHelper.valid_type?(value.amount,
                                   ->(val) { val.instance_of? Integer }) and
             APIHelper.valid_type?(value.currency,
-                                  ->(val) { CurrencyEnum.validate(val) }) and
+                                  ->(val) { Currency.validate(val) }) and
             APIHelper.valid_type?(value.failure_reason,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.role,
-                                  ->(val) { RoleEnum.validate(val) }) and
+                                  ->(val) { Role.validate(val) }) and
             APIHelper.valid_type?(value.current_return,
                                   ->(val) { Return.validate(val) },
                                   is_model_hash: true) and
@@ -352,9 +350,9 @@ module ModernTreasury
           APIHelper.valid_type?(value['returnable_id'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['returnable_type'],
-                                ->(val) { ReturnableTypeEnum.validate(val) }) and
+                                ->(val) { ReturnableType.validate(val) }) and
           APIHelper.valid_type?(value['code'],
-                                ->(val) { Code1Enum.validate(val) }) and
+                                ->(val) { Code1.validate(val) }) and
           APIHelper.valid_type?(value['reason'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['date_of_death'],
@@ -362,7 +360,7 @@ module ModernTreasury
           APIHelper.valid_type?(value['additional_information'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['status'],
-                                ->(val) { Status4Enum.validate(val) }) and
+                                ->(val) { Status4.validate(val) }) and
           APIHelper.valid_type?(value['transaction_line_item_id'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['transaction_id'],
@@ -370,15 +368,15 @@ module ModernTreasury
           APIHelper.valid_type?(value['internal_account_id'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['type'],
-                                ->(val) { Type6Enum.validate(val) }) and
+                                ->(val) { Type6.validate(val) }) and
           APIHelper.valid_type?(value['amount'],
                                 ->(val) { val.instance_of? Integer }) and
           APIHelper.valid_type?(value['currency'],
-                                ->(val) { CurrencyEnum.validate(val) }) and
+                                ->(val) { Currency.validate(val) }) and
           APIHelper.valid_type?(value['failure_reason'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['role'],
-                                ->(val) { RoleEnum.validate(val) }) and
+                                ->(val) { Role.validate(val) }) and
           APIHelper.valid_type?(value['current_return'],
                                 ->(val) { Return.validate(val) },
                                 is_model_hash: true) and

data/lib/modern_treasury/models/{normal_balance_enum.rb → normal_balance.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The normal balance of the ledger account.
-  class NormalBalanceEnum
-    NORMAL_BALANCE_ENUM = [
+  class NormalBalance
+    NORMAL_BALANCE = [
       # TODO: Write general description for CREDIT
       CREDIT = 'credit'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      NORMAL_BALANCE_ENUM.include?(value)
+      NORMAL_BALANCE.include?(value)
     end
 
     def self.from_value(value, default_value = CREDIT)

data/lib/modern_treasury/models/{normal_balance2_enum.rb → normal_balance2.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The normal balance of the ledger account category.
-  class NormalBalance2Enum
-    NORMAL_BALANCE2_ENUM = [
+  class NormalBalance2
+    NORMAL_BALANCE2 = [
       # TODO: Write general description for CREDIT
       CREDIT = 'credit'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      NORMAL_BALANCE2_ENUM.include?(value)
+      NORMAL_BALANCE2.include?(value)
     end
 
     def self.from_value(value, default_value = CREDIT)

data/lib/modern_treasury/models/order_by.rb

@@ -10,11 +10,11 @@ module ModernTreasury
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [CreatedAtEnum]
+    # @return [CreatedAt]
     attr_accessor :created_at
 
     # TODO: Write general description for this method
-    # @return [EffectiveAtEnum]
+    # @return [EffectiveAt]
     attr_accessor :effective_at
 
     # A mapping from model property names to API property names.
@@ -38,7 +38,7 @@ module ModernTreasury
       []
     end
 
-    def initialize(created_at = SKIP, effective_at = SKIP)
+    def initialize(created_at: SKIP, effective_at: SKIP)
       @created_at = created_at unless created_at == SKIP
       @effective_at = effective_at unless effective_at == SKIP
     end
@@ -52,8 +52,8 @@ module ModernTreasury
       effective_at = hash.key?('effective_at') ? hash['effective_at'] : SKIP
 
       # Create object from extracted values.
-      OrderBy.new(created_at,
-                  effective_at)
+      OrderBy.new(created_at: created_at,
+                  effective_at: effective_at)
     end
 
     # Provides a human-readable string representation of the object.

data/lib/modern_treasury/models/{originating_account_number_type_enum.rb → originating_account_number_type.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The type of the originating account number for the incoming payment detail.
-  class OriginatingAccountNumberTypeEnum
-    ORIGINATING_ACCOUNT_NUMBER_TYPE_ENUM = [
+  class OriginatingAccountNumberType
+    ORIGINATING_ACCOUNT_NUMBER_TYPE = [
       # TODO: Write general description for CLABE
       CLABE = 'clabe'.freeze,
 
@@ -26,7 +26,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      ORIGINATING_ACCOUNT_NUMBER_TYPE_ENUM.include?(value)
+      ORIGINATING_ACCOUNT_NUMBER_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = CLABE)

data/lib/modern_treasury/models/{originating_routing_number_type_enum.rb → originating_routing_number_type.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The type of the originating routing number for the incoming payment detail.
-  class OriginatingRoutingNumberTypeEnum
-    ORIGINATING_ROUTING_NUMBER_TYPE_ENUM = [
+  class OriginatingRoutingNumberType
+    ORIGINATING_ROUTING_NUMBER_TYPE = [
       # TODO: Write general description for ABA
       ABA = 'aba'.freeze,
 
@@ -41,7 +41,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      ORIGINATING_ROUTING_NUMBER_TYPE_ENUM.include?(value)
+      ORIGINATING_ROUTING_NUMBER_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = ABA)

data/lib/modern_treasury/models/paper_item.rb

@@ -43,7 +43,7 @@ module ModernTreasury
 
     # The current status of the paper item. One of `pending`, `completed`, or
     # `returned`.
-    # @return [Status16Enum]
+    # @return [Status16]
     attr_accessor :status
 
     # The identifier for the lockbox assigned by the bank.
@@ -60,7 +60,7 @@ module ModernTreasury
     attr_accessor :amount
 
     # Three-letter ISO currency code.
-    # @return [CurrencyEnum]
+    # @return [Currency]
     attr_accessor :currency
 
     # The account number on the paper item.
@@ -130,13 +130,11 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, transaction_line_item_id = nil,
-                   transaction_id = nil, status = nil, lockbox_number = nil,
-                   deposit_date = nil, amount = nil, currency = nil,
-                   account_number = nil, account_number_safe = nil,
-                   routing_number = nil, check_number = nil,
-                   remitter_name = nil, memo_field = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   transaction_line_item_id:, transaction_id:, status:,
+                   lockbox_number:, deposit_date:, amount:, currency:,
+                   account_number:, account_number_safe:, routing_number:,
+                   check_number:, remitter_name:, memo_field:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -192,24 +190,24 @@ module ModernTreasury
       memo_field = hash.key?('memo_field') ? hash['memo_field'] : nil
 
       # Create object from extracted values.
-      PaperItem.new(id,
-                    object,
-                    live_mode,
-                    created_at,
-                    updated_at,
-                    transaction_line_item_id,
-                    transaction_id,
-                    status,
-                    lockbox_number,
-                    deposit_date,
-                    amount,
-                    currency,
-                    account_number,
-                    account_number_safe,
-                    routing_number,
-                    check_number,
-                    remitter_name,
-                    memo_field)
+      PaperItem.new(id: id,
+                    object: object,
+                    live_mode: live_mode,
+                    created_at: created_at,
+                    updated_at: updated_at,
+                    transaction_line_item_id: transaction_line_item_id,
+                    transaction_id: transaction_id,
+                    status: status,
+                    lockbox_number: lockbox_number,
+                    deposit_date: deposit_date,
+                    amount: amount,
+                    currency: currency,
+                    account_number: account_number,
+                    account_number_safe: account_number_safe,
+                    routing_number: routing_number,
+                    check_number: check_number,
+                    remitter_name: remitter_name,
+                    memo_field: memo_field)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/party_address.rb

@@ -57,14 +57,18 @@ module ModernTreasury
       []
     end
 
-    def initialize(line1 = nil, locality = nil, region = nil, postal_code = nil,
-                   country = nil, line2 = SKIP)
+    def initialize(line1:, locality:, region:, postal_code:, country:,
+                   line2: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @line1 = line1
       @line2 = line2 unless line2 == SKIP
       @locality = locality
       @region = region
       @postal_code = postal_code
       @country = country
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -79,20 +83,29 @@ module ModernTreasury
       country = hash.key?('country') ? hash['country'] : nil
       line2 = hash.key?('line2') ? hash['line2'] : 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.
-      PartyAddress.new(line1,
-                       locality,
-                       region,
-                       postal_code,
-                       country,
-                       line2)
+      PartyAddress.new(line1: line1,
+                       locality: locality,
+                       region: region,
+                       postal_code: postal_code,
+                       country: country,
+                       line2: line2,
+                       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} line1: #{@line1}, line2: #{@line2}, locality: #{@locality}, region:"\
-      " #{@region}, postal_code: #{@postal_code}, country: #{@country}>"
+      " #{@region}, postal_code: #{@postal_code}, country: #{@country}, additional_properties:"\
+      " #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -100,7 +113,7 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} line1: #{@line1.inspect}, line2: #{@line2.inspect}, locality:"\
       " #{@locality.inspect}, region: #{@region.inspect}, postal_code: #{@postal_code.inspect},"\
-      " country: #{@country.inspect}>"
+      " country: #{@country.inspect}, additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/{party_type_enum.rb → party_type.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # Either `individual` or `business`.
-  class PartyTypeEnum
-    PARTY_TYPE_ENUM = [
+  class PartyType
+    PARTY_TYPE = [
       # TODO: Write general description for BUSINESS
       BUSINESS = 'business'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PARTY_TYPE_ENUM.include?(value)
+      PARTY_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = BUSINESS)

data/lib/modern_treasury/models/{party_type5_enum.rb → party_type5.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # Either individual or business.
-  class PartyType5Enum
-    PARTY_TYPE5_ENUM = [
+  class PartyType5
+    PARTY_TYPE5 = [
       # TODO: Write general description for BUSINESS
       BUSINESS = 'business'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PARTY_TYPE5_ENUM.include?(value)
+      PARTY_TYPE5.include?(value)
     end
 
     def self.from_value(value, default_value = BUSINESS)

data/lib/modern_treasury/models/{payment_direction_enum.rb → payment_direction.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # payment_direction.
-  class PaymentDirectionEnum
-    PAYMENT_DIRECTION_ENUM = [
+  class PaymentDirection
+    PAYMENT_DIRECTION = [
       # TODO: Write general description for CREDIT
       CREDIT = 'credit'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_DIRECTION_ENUM.include?(value)
+      PAYMENT_DIRECTION.include?(value)
     end
 
     def self.from_value(value, default_value = CREDIT)

data/lib/modern_treasury/models/payment_flow.rb

@@ -40,7 +40,7 @@ module ModernTreasury
 
     # The current status of the payment flow. One of `pending`, `completed`,
     # `expired`, or `cancelled`.
-    # @return [Status17Enum]
+    # @return [Status17]
     attr_accessor :status
 
     # Value in specified currency's smallest unit. e.g. $10 would be represented
@@ -54,7 +54,7 @@ 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.
-    # @return [Direction9Enum]
+    # @return [Direction9]
     attr_accessor :direction
 
     # The ID of a counterparty associated with the payment. As part of the
@@ -125,12 +125,11 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = SKIP, object = SKIP, live_mode = SKIP,
-                   created_at = SKIP, updated_at = SKIP, client_token = SKIP,
-                   status = SKIP, amount = SKIP, currency = SKIP,
-                   direction = SKIP, counterparty_id = SKIP,
-                   receiving_account_id = SKIP, originating_account_id = SKIP,
-                   payment_order_id = SKIP)
+    def initialize(id: SKIP, object: SKIP, live_mode: SKIP, created_at: SKIP,
+                   updated_at: SKIP, client_token: SKIP, status: SKIP,
+                   amount: SKIP, currency: SKIP, direction: SKIP,
+                   counterparty_id: SKIP, receiving_account_id: SKIP,
+                   originating_account_id: SKIP, payment_order_id: SKIP)
       @id = id unless id == SKIP
       @object = object unless object == SKIP
       @live_mode = live_mode unless live_mode == SKIP
@@ -180,20 +179,20 @@ module ModernTreasury
         hash.key?('payment_order_id') ? hash['payment_order_id'] : SKIP
 
       # Create object from extracted values.
-      PaymentFlow.new(id,
-                      object,
-                      live_mode,
-                      created_at,
-                      updated_at,
-                      client_token,
-                      status,
-                      amount,
-                      currency,
-                      direction,
-                      counterparty_id,
-                      receiving_account_id,
-                      originating_account_id,
-                      payment_order_id)
+      PaymentFlow.new(id: id,
+                      object: object,
+                      live_mode: live_mode,
+                      created_at: created_at,
+                      updated_at: updated_at,
+                      client_token: client_token,
+                      status: status,
+                      amount: amount,
+                      currency: currency,
+                      direction: direction,
+                      counterparty_id: counterparty_id,
+                      receiving_account_id: receiving_account_id,
+                      originating_account_id: originating_account_id,
+                      payment_order_id: payment_order_id)
     end
 
     def to_custom_created_at