mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/models/{field_enum.rb → field.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # Field.
-  class FieldEnum
-    FIELD_ENUM = [
+  class Field
+    FIELD = [
       # TODO: Write general description for NAME
       NAME = 'name'.freeze,
 
@@ -74,7 +74,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      FIELD_ENUM.include?(value)
+      FIELD.include?(value)
     end
 
     def self.from_value(value, default_value = NAME)

data/lib/modern_treasury/models/file.rb

@@ -44,7 +44,7 @@ module ModernTreasury
       []
     end
 
-    def initialize(size = SKIP, filename = SKIP, content_type = SKIP)
+    def initialize(size: SKIP, filename: SKIP, content_type: SKIP)
       @size = size unless size == SKIP
       @filename = filename unless filename == SKIP
       @content_type = content_type unless content_type == SKIP
@@ -60,9 +60,9 @@ module ModernTreasury
       content_type = hash.key?('content_type') ? hash['content_type'] : SKIP
 
       # Create object from extracted values.
-      File.new(size,
-               filename,
-               content_type)
+      File.new(size: size,
+               filename: filename,
+               content_type: content_type)
     end
 
     # Provides a human-readable string representation of the object.

data/lib/modern_treasury/models/{foreign_exchange_indicator_enum.rb → foreign_exchange_indicator.rb}

@@ -7,8 +7,8 @@ module ModernTreasury
   # Indicates the type of FX transfer to initiate, can be either
   # `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
   # currency matches the originating account currency.
-  class ForeignExchangeIndicatorEnum
-    FOREIGN_EXCHANGE_INDICATOR_ENUM = [
+  class ForeignExchangeIndicator
+    FOREIGN_EXCHANGE_INDICATOR = [
       # TODO: Write general description for FIXED_TO_VARIABLE
       FIXED_TO_VARIABLE = 'fixed_to_variable'.freeze,
 
@@ -19,7 +19,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      FOREIGN_EXCHANGE_INDICATOR_ENUM.include?(value)
+      FOREIGN_EXCHANGE_INDICATOR.include?(value)
     end
 
     def self.from_value(value, default_value = FIXED_TO_VARIABLE)

data/lib/modern_treasury/models/incoming_payment_detail.rb

@@ -63,7 +63,7 @@ module ModernTreasury
 
     # One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`,
     # or `wire`.
-    # @return [Type4Enum]
+    # @return [Type4]
     attr_accessor :type
 
     # The raw data from the payment pre-notification file that we get from the
@@ -77,16 +77,16 @@ module ModernTreasury
     attr_accessor :amount
 
     # Three-letter ISO currency code.
-    # @return [CurrencyEnum]
+    # @return [Currency]
     attr_accessor :currency
 
     # One of `credit` or `debit`.
-    # @return [Direction4Enum]
+    # @return [Direction4]
     attr_accessor :direction
 
     # The current status of the incoming payment order. One of `pending`,
     # `completed`, or `returned`.
-    # @return [Status2Enum]
+    # @return [Status2]
     attr_accessor :status
 
     # Additional data represented as key-value pairs. Both the key and value
@@ -109,7 +109,7 @@ module ModernTreasury
 
     # The type of the originating routing number for the incoming payment
     # detail.
-    # @return [OriginatingRoutingNumberTypeEnum]
+    # @return [OriginatingRoutingNumberType]
     attr_accessor :originating_routing_number_type
 
     # The account number of the originating account for the incoming payment
@@ -124,7 +124,7 @@ module ModernTreasury
 
     # The type of the originating account number for the incoming payment
     # detail.
-    # @return [OriginatingAccountNumberTypeEnum]
+    # @return [OriginatingAccountNumberType]
     attr_accessor :originating_account_number_type
 
     # A mapping from model property names to API property names.
@@ -184,18 +184,16 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, internal_account_id = nil,
-                   virtual_account_id = nil, virtual_account = nil,
-                   transaction_line_item_id = nil, transaction_id = nil,
-                   ledger_transaction_id = nil, type = nil, data = nil,
-                   amount = nil, currency = nil, direction = nil, status = nil,
-                   metadata = nil, as_of_date = nil, vendor_id = nil,
-                   originating_routing_number = nil,
-                   originating_routing_number_type = nil,
-                   originating_account_number_safe = nil,
-                   originating_account_number_type = nil,
-                   originating_account_number = SKIP)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   internal_account_id:, virtual_account_id:, virtual_account:,
+                   transaction_line_item_id:, transaction_id:,
+                   ledger_transaction_id:, type:, data:, amount:, currency:,
+                   direction:, status:, metadata:, as_of_date:, vendor_id:,
+                   originating_routing_number:,
+                   originating_routing_number_type:,
+                   originating_account_number_safe:,
+                   originating_account_number_type:,
+                   originating_account_number: SKIP)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -273,31 +271,31 @@ module ModernTreasury
         hash.key?('originating_account_number') ? hash['originating_account_number'] : SKIP
 
       # Create object from extracted values.
-      IncomingPaymentDetail.new(id,
-                                object,
-                                live_mode,
-                                created_at,
-                                updated_at,
-                                internal_account_id,
-                                virtual_account_id,
-                                virtual_account,
-                                transaction_line_item_id,
-                                transaction_id,
-                                ledger_transaction_id,
-                                type,
-                                data,
-                                amount,
-                                currency,
-                                direction,
-                                status,
-                                metadata,
-                                as_of_date,
-                                vendor_id,
-                                originating_routing_number,
-                                originating_routing_number_type,
-                                originating_account_number_safe,
-                                originating_account_number_type,
-                                originating_account_number)
+      IncomingPaymentDetail.new(id: id,
+                                object: object,
+                                live_mode: live_mode,
+                                created_at: created_at,
+                                updated_at: updated_at,
+                                internal_account_id: internal_account_id,
+                                virtual_account_id: virtual_account_id,
+                                virtual_account: virtual_account,
+                                transaction_line_item_id: transaction_line_item_id,
+                                transaction_id: transaction_id,
+                                ledger_transaction_id: ledger_transaction_id,
+                                type: type,
+                                data: data,
+                                amount: amount,
+                                currency: currency,
+                                direction: direction,
+                                status: status,
+                                metadata: metadata,
+                                as_of_date: as_of_date,
+                                vendor_id: vendor_id,
+                                originating_routing_number: originating_routing_number,
+                                originating_routing_number_type: originating_routing_number_type,
+                                originating_account_number_safe: originating_account_number_safe,
+                                originating_account_number_type: originating_account_number_type,
+                                originating_account_number: originating_account_number)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/incoming_payment_detail_create_request.rb

@@ -10,11 +10,11 @@ module ModernTreasury
     private_constant :SKIP
 
     # One of `ach`, `wire`, `check`.
-    # @return [Type10Enum]
+    # @return [Type10]
     attr_accessor :type
 
     # One of `credit`, `debit`.
-    # @return [Direction14Enum]
+    # @return [Direction14]
     attr_accessor :direction
 
     # Value in specified currency's smallest unit. e.g. $10 would be represented
@@ -23,7 +23,7 @@ module ModernTreasury
     attr_accessor :amount
 
     # Three-letter ISO currency code.
-    # @return [CurrencyEnum]
+    # @return [Currency]
     attr_accessor :currency
 
     # The ID of one of your internal accounts.
@@ -80,10 +80,13 @@ module ModernTreasury
       ]
     end
 
-    def initialize(type = SKIP, direction = SKIP, amount = SKIP,
-                   currency = SKIP, internal_account_id = SKIP,
-                   virtual_account_id = SKIP, as_of_date = SKIP,
-                   description = SKIP)
+    def initialize(type: SKIP, direction: SKIP, amount: SKIP, currency: SKIP,
+                   internal_account_id: SKIP, virtual_account_id: SKIP,
+                   as_of_date: SKIP, description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @type = type unless type == SKIP
       @direction = direction unless direction == SKIP
       @amount = amount unless amount == SKIP
@@ -92,6 +95,7 @@ module ModernTreasury
       @virtual_account_id = virtual_account_id unless virtual_account_id == SKIP
       @as_of_date = as_of_date unless as_of_date == SKIP
       @description = description unless description == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -110,15 +114,23 @@ module ModernTreasury
       as_of_date = hash.key?('as_of_date') ? hash['as_of_date'] : SKIP
       description = hash.key?('description') ? hash['description'] : 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.
-      IncomingPaymentDetailCreateRequest.new(type,
-                                             direction,
-                                             amount,
-                                             currency,
-                                             internal_account_id,
-                                             virtual_account_id,
-                                             as_of_date,
-                                             description)
+      IncomingPaymentDetailCreateRequest.new(type: type,
+                                             direction: direction,
+                                             amount: amount,
+                                             currency: currency,
+                                             internal_account_id: internal_account_id,
+                                             virtual_account_id: virtual_account_id,
+                                             as_of_date: as_of_date,
+                                             description: description,
+                                             additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
@@ -126,7 +138,8 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} type: #{@type}, direction: #{@direction}, amount: #{@amount}, currency:"\
       " #{@currency}, internal_account_id: #{@internal_account_id}, virtual_account_id:"\
-      " #{@virtual_account_id}, as_of_date: #{@as_of_date}, description: #{@description}>"
+      " #{@virtual_account_id}, as_of_date: #{@as_of_date}, description: #{@description},"\
+      " additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -135,7 +148,8 @@ module ModernTreasury
       "<#{class_name} type: #{@type.inspect}, direction: #{@direction.inspect}, amount:"\
       " #{@amount.inspect}, currency: #{@currency.inspect}, internal_account_id:"\
       " #{@internal_account_id.inspect}, virtual_account_id: #{@virtual_account_id.inspect},"\
-      " as_of_date: #{@as_of_date.inspect}, description: #{@description.inspect}>"
+      " as_of_date: #{@as_of_date.inspect}, description: #{@description.inspect},"\
+      " additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/incoming_payment_detail_update_request.rb

@@ -33,8 +33,12 @@ module ModernTreasury
       []
     end
 
-    def initialize(metadata = SKIP)
+    def initialize(metadata: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @metadata = metadata unless metadata == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -44,20 +48,29 @@ module ModernTreasury
       # Extract variables from the hash.
       metadata = hash.key?('metadata') ? hash['metadata'] : 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.
-      IncomingPaymentDetailUpdateRequest.new(metadata)
+      IncomingPaymentDetailUpdateRequest.new(metadata: metadata,
+                                             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} metadata: #{@metadata}>"
+      "<#{class_name} metadata: #{@metadata}, 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} metadata: #{@metadata.inspect}>"
+      "<#{class_name} metadata: #{@metadata.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/internal_account.rb

@@ -34,7 +34,7 @@ module ModernTreasury
     attr_accessor :updated_at
 
     # Can be checking, savings or other.
-    # @return [AccountType5Enum]
+    # @return [AccountType5]
     attr_accessor :account_type
 
     # The legal name of the entity which owns the account.
@@ -42,7 +42,7 @@ module ModernTreasury
     attr_accessor :party_name
 
     # Either individual or business.
-    # @return [PartyType5Enum]
+    # @return [PartyType5]
     attr_accessor :party_type
 
     # Either individual or business.
@@ -66,7 +66,7 @@ module ModernTreasury
     attr_accessor :connection
 
     # Three-letter ISO currency code.
-    # @return [CurrencyEnum]
+    # @return [Currency]
     attr_accessor :currency
 
     # Additional data represented as key-value pairs. Both the key and value
@@ -129,13 +129,11 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, account_type = nil, party_name = nil,
-                   party_type = nil, party_address = nil, name = nil,
-                   account_details = nil, routing_details = nil,
-                   connection = nil, currency = nil, metadata = nil,
-                   parent_account_id = nil, counterparty_id = nil,
-                   ledger_account_id = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   account_type:, party_name:, party_type:, party_address:,
+                   name:, account_details:, routing_details:, connection:,
+                   currency:, metadata:, parent_account_id:, counterparty_id:,
+                   ledger_account_id:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -206,24 +204,24 @@ module ModernTreasury
         hash.key?('ledger_account_id') ? hash['ledger_account_id'] : nil
 
       # Create object from extracted values.
-      InternalAccount.new(id,
-                          object,
-                          live_mode,
-                          created_at,
-                          updated_at,
-                          account_type,
-                          party_name,
-                          party_type,
-                          party_address,
-                          name,
-                          account_details,
-                          routing_details,
-                          connection,
-                          currency,
-                          metadata,
-                          parent_account_id,
-                          counterparty_id,
-                          ledger_account_id)
+      InternalAccount.new(id: id,
+                          object: object,
+                          live_mode: live_mode,
+                          created_at: created_at,
+                          updated_at: updated_at,
+                          account_type: account_type,
+                          party_name: party_name,
+                          party_type: party_type,
+                          party_address: party_address,
+                          name: name,
+                          account_details: account_details,
+                          routing_details: routing_details,
+                          connection: connection,
+                          currency: currency,
+                          metadata: metadata,
+                          parent_account_id: parent_account_id,
+                          counterparty_id: counterparty_id,
+                          ledger_account_id: ledger_account_id)
     end
 
     def to_custom_created_at
@@ -250,11 +248,11 @@ module ModernTreasury
             APIHelper.valid_type?(value.updated_at,
                                   ->(val) { val.instance_of? DateTime }) and
             APIHelper.valid_type?(value.account_type,
-                                  ->(val) { AccountType5Enum.validate(val) }) and
+                                  ->(val) { AccountType5.validate(val) }) and
             APIHelper.valid_type?(value.party_name,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.party_type,
-                                  ->(val) { PartyType5Enum.validate(val) }) and
+                                  ->(val) { PartyType5.validate(val) }) and
             APIHelper.valid_type?(value.party_address,
                                   ->(val) { Address.validate(val) },
                                   is_model_hash: true) and
@@ -272,7 +270,7 @@ module ModernTreasury
                                   ->(val) { Connection.validate(val) },
                                   is_model_hash: true) and
             APIHelper.valid_type?(value.currency,
-                                  ->(val) { CurrencyEnum.validate(val) }) and
+                                  ->(val) { Currency.validate(val) }) and
             APIHelper.valid_type?(value.metadata,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.parent_account_id,
@@ -298,11 +296,11 @@ module ModernTreasury
           APIHelper.valid_type?(value['updated_at'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['account_type'],
-                                ->(val) { AccountType5Enum.validate(val) }) and
+                                ->(val) { AccountType5.validate(val) }) and
           APIHelper.valid_type?(value['party_name'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['party_type'],
-                                ->(val) { PartyType5Enum.validate(val) }) and
+                                ->(val) { PartyType5.validate(val) }) and
           APIHelper.valid_type?(value['party_address'],
                                 ->(val) { Address.validate(val) },
                                 is_model_hash: true) and
@@ -320,7 +318,7 @@ module ModernTreasury
                                 ->(val) { Connection.validate(val) },
                                 is_model_hash: true) and
           APIHelper.valid_type?(value['currency'],
-                                ->(val) { CurrencyEnum.validate(val) }) and
+                                ->(val) { Currency.validate(val) }) and
           APIHelper.valid_type?(value['metadata'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['parent_account_id'],

data/lib/modern_treasury/models/internal_account_create_request.rb

@@ -27,7 +27,7 @@ module ModernTreasury
 
     # Either "USD" or "CAD". Internal accounts created at Increase only supports
     # "USD".
-    # @return [Currency1Enum]
+    # @return [Currency1]
     attr_accessor :currency
 
     # A hash of vendor specific attributes that will be used when creating the
@@ -72,10 +72,13 @@ module ModernTreasury
       []
     end
 
-    def initialize(connection_id = nil, name = nil, party_name = nil,
-                   currency = nil, party_address = SKIP,
-                   vendor_attributes = SKIP, parent_account_id = SKIP,
-                   counterparty_id = SKIP)
+    def initialize(connection_id:, name:, party_name:, currency:,
+                   party_address: SKIP, vendor_attributes: SKIP,
+                   parent_account_id: SKIP, counterparty_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @connection_id = connection_id
       @name = name
       @party_name = party_name
@@ -84,6 +87,7 @@ module ModernTreasury
       @vendor_attributes = vendor_attributes unless vendor_attributes == SKIP
       @parent_account_id = parent_account_id unless parent_account_id == SKIP
       @counterparty_id = counterparty_id unless counterparty_id == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -103,15 +107,23 @@ module ModernTreasury
       counterparty_id =
         hash.key?('counterparty_id') ? hash['counterparty_id'] : 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.
-      InternalAccountCreateRequest.new(connection_id,
-                                       name,
-                                       party_name,
-                                       currency,
-                                       party_address,
-                                       vendor_attributes,
-                                       parent_account_id,
-                                       counterparty_id)
+      InternalAccountCreateRequest.new(connection_id: connection_id,
+                                       name: name,
+                                       party_name: party_name,
+                                       currency: currency,
+                                       party_address: party_address,
+                                       vendor_attributes: vendor_attributes,
+                                       parent_account_id: parent_account_id,
+                                       counterparty_id: counterparty_id,
+                                       additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
@@ -120,7 +132,7 @@ module ModernTreasury
       "<#{class_name} connection_id: #{@connection_id}, name: #{@name}, party_name:"\
       " #{@party_name}, party_address: #{@party_address}, currency: #{@currency},"\
       " vendor_attributes: #{@vendor_attributes}, parent_account_id: #{@parent_account_id},"\
-      " counterparty_id: #{@counterparty_id}>"
+      " counterparty_id: #{@counterparty_id}, additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -129,7 +141,8 @@ module ModernTreasury
       "<#{class_name} connection_id: #{@connection_id.inspect}, name: #{@name.inspect},"\
       " party_name: #{@party_name.inspect}, party_address: #{@party_address.inspect}, currency:"\
       " #{@currency.inspect}, vendor_attributes: #{@vendor_attributes.inspect}, parent_account_id:"\
-      " #{@parent_account_id.inspect}, counterparty_id: #{@counterparty_id.inspect}>"
+      " #{@parent_account_id.inspect}, counterparty_id: #{@counterparty_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/internal_account_update_request.rb

@@ -51,12 +51,16 @@ module ModernTreasury
       []
     end
 
-    def initialize(name = SKIP, metadata = SKIP, parent_account_id = SKIP,
-                   counterparty_id = SKIP)
+    def initialize(name: SKIP, metadata: SKIP, parent_account_id: SKIP,
+                   counterparty_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @name = name unless name == SKIP
       @metadata = metadata unless metadata == SKIP
       @parent_account_id = parent_account_id unless parent_account_id == SKIP
       @counterparty_id = counterparty_id unless counterparty_id == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -71,25 +75,35 @@ module ModernTreasury
       counterparty_id =
         hash.key?('counterparty_id') ? hash['counterparty_id'] : 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.
-      InternalAccountUpdateRequest.new(name,
-                                       metadata,
-                                       parent_account_id,
-                                       counterparty_id)
+      InternalAccountUpdateRequest.new(name: name,
+                                       metadata: metadata,
+                                       parent_account_id: parent_account_id,
+                                       counterparty_id: counterparty_id,
+                                       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} name: #{@name}, metadata: #{@metadata}, parent_account_id:"\
-      " #{@parent_account_id}, counterparty_id: #{@counterparty_id}>"
+      " #{@parent_account_id}, counterparty_id: #{@counterparty_id}, 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} name: #{@name.inspect}, metadata: #{@metadata.inspect}, parent_account_id:"\
-      " #{@parent_account_id.inspect}, counterparty_id: #{@counterparty_id.inspect}>"
+      " #{@parent_account_id.inspect}, counterparty_id: #{@counterparty_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
     end
   end
 end