mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/models/payment_flow_create_request.rb

@@ -21,7 +21,7 @@ module ModernTreasury
     # Required. 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 [Direction10Enum]
+    # @return [Direction10]
     attr_accessor :direction
 
     # Required. The ID of a counterparty associated with the payment. As part of
@@ -55,13 +55,17 @@ module ModernTreasury
       []
     end
 
-    def initialize(amount = nil, currency = nil, direction = nil,
-                   counterparty_id = nil, originating_account_id = nil)
+    def initialize(amount:, currency:, direction:, counterparty_id:,
+                   originating_account_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @amount = amount
       @currency = currency
       @direction = direction
       @counterparty_id = counterparty_id
       @originating_account_id = originating_account_id
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -77,19 +81,28 @@ module ModernTreasury
       originating_account_id =
         hash.key?('originating_account_id') ? hash['originating_account_id'] : nil
 
+      # 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.
-      PaymentFlowCreateRequest.new(amount,
-                                   currency,
-                                   direction,
-                                   counterparty_id,
-                                   originating_account_id)
+      PaymentFlowCreateRequest.new(amount: amount,
+                                   currency: currency,
+                                   direction: direction,
+                                   counterparty_id: counterparty_id,
+                                   originating_account_id: originating_account_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} amount: #{@amount}, currency: #{@currency}, direction: #{@direction},"\
-      " counterparty_id: #{@counterparty_id}, originating_account_id: #{@originating_account_id}>"
+      " counterparty_id: #{@counterparty_id}, originating_account_id: #{@originating_account_id},"\
+      " additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -97,7 +110,8 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}, direction:"\
       " #{@direction.inspect}, counterparty_id: #{@counterparty_id.inspect},"\
-      " originating_account_id: #{@originating_account_id.inspect}>"
+      " originating_account_id: #{@originating_account_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/payment_flow_update_request.rb

@@ -31,8 +31,12 @@ module ModernTreasury
       []
     end
 
-    def initialize
+    def initialize(additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @status = 'cancelled'
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -42,20 +46,28 @@ module ModernTreasury
       # Extract variables from the hash.
 
 
+      # 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.
-      PaymentFlowUpdateRequest.new
+      PaymentFlowUpdateRequest.new(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} status: #{@status}>"
+      "<#{class_name} status: #{@status}, 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} status: #{@status.inspect}>"
+      "<#{class_name} status: #{@status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/{payment_method_enum.rb → payment_method.rb}

@@ -7,8 +7,8 @@ module ModernTreasury
   # When opening an invoice, whether to show the embedded payment UI ,
   # automatically debit the recipient, or rely on manual payment from the
   # recipient.
-  class PaymentMethodEnum
-    PAYMENT_METHOD_ENUM = [
+  class PaymentMethod
+    PAYMENT_METHOD = [
       # TODO: Write general description for UI
       UI = 'ui'.freeze,
 
@@ -22,7 +22,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_METHOD_ENUM.include?(value)
+      PAYMENT_METHOD.include?(value)
     end
 
     def self.from_value(value, default_value = UI)

data/lib/modern_treasury/models/{payment_method1_enum.rb → payment_method1.rb}

@@ -11,8 +11,8 @@ module ModernTreasury
   # will be debit. If the invoice amount is negative, the automatically
   # initiated payment order's direction will be credit. One of `manual`, `ui`,
   # or `automatic`.
-  class PaymentMethod1Enum
-    PAYMENT_METHOD1_ENUM = [
+  class PaymentMethod1
+    PAYMENT_METHOD1 = [
       # TODO: Write general description for UI
       UI = 'ui'.freeze,
 
@@ -26,7 +26,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_METHOD1_ENUM.include?(value)
+      PAYMENT_METHOD1.include?(value)
     end
 
     def self.from_value(value, default_value = UI)

data/lib/modern_treasury/models/payment_order.rb

@@ -35,14 +35,14 @@ module ModernTreasury
 
     # One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`,
     # `bacs`, `au_becs`, `interac`, `signet`, `provexchange`.
-    # @return [Type5Enum]
+    # @return [Type5]
     attr_accessor :type
 
     # An additional layer of classification for the type of payment order you
     # are doing. This field is only used for `ach` payment orders currently. For
     # `ach`  payment orders, the `subtype`  represents the SEC code. We
     # currently support `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.
-    # @return [SubtypeEnum]
+    # @return [Subtype]
     attr_accessor :subtype
 
     # Value in specified currency's smallest unit. e.g. $10 would be represented
@@ -55,13 +55,13 @@ 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`.
-    # @return [Direction5Enum]
+    # @return [Direction5]
     attr_accessor :direction
 
     # Either `normal` or `high`. For ACH and EFT payments, `high` represents a
     # same-day ACH or EFT transfer, respectively. For check payments, `high` can
     # mean an overnight check rather than standard mail.
-    # @return [PriorityEnum]
+    # @return [Priority]
     attr_accessor :priority
 
     # The ID of one of your organization's internal accounts.
@@ -89,7 +89,7 @@ module ModernTreasury
     attr_accessor :accounting_ledger_class_id
 
     # Three-letter ISO currency code.
-    # @return [CurrencyEnum]
+    # @return [Currency]
     attr_accessor :currency
 
     # Date transactions are to be posted to the participants' account. Defaults
@@ -132,13 +132,13 @@ module ModernTreasury
     # The party that will pay the fees for the payment order. Only applies to
     # wire payment orders. Can be one of shared, sender, or receiver, which
     # correspond respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
-    # @return [ChargeBearerEnum]
+    # @return [ChargeBearer]
     attr_accessor :charge_bearer
 
     # 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.
-    # @return [ForeignExchangeIndicatorEnum]
+    # @return [ForeignExchangeIndicator]
     attr_accessor :foreign_exchange_indicator
 
     # If present, indicates a specific foreign exchange contract number that has
@@ -186,7 +186,7 @@ module ModernTreasury
     attr_accessor :expires_at
 
     # The current status of the payment order.
-    # @return [Status3Enum]
+    # @return [Status3]
     attr_accessor :status
 
     # The receiving account. Can be an `external_account` or `internal_account`.
@@ -194,7 +194,7 @@ module ModernTreasury
     attr_accessor :receiving_account
 
     # The receiving account. Can be an `external_account` or `internal_account`.
-    # @return [ReceivingAccountTypeEnum]
+    # @return [ReceivingAccountType]
     attr_accessor :receiving_account_type
 
     # If the payment order is tied to a specific Counterparty, their id will
@@ -332,29 +332,24 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, type = nil, subtype = nil, amount = nil,
-                   direction = nil, priority = nil,
-                   originating_account_id = nil, receiving_account_id = nil,
-                   accounting = nil, accounting_category_id = nil,
-                   accounting_ledger_class_id = nil, currency = nil,
-                   effective_date = nil, description = nil,
-                   statement_descriptor = nil, remittance_information = nil,
-                   purpose = nil, metadata = nil, charge_bearer = nil,
-                   foreign_exchange_indicator = nil,
-                   foreign_exchange_contract = nil, nsf_protected = nil,
-                   originating_party_name = nil,
-                   ultimate_originating_party_name = nil,
-                   ultimate_originating_party_identifier = nil,
-                   ultimate_receiving_party_name = nil,
-                   ultimate_receiving_party_identifier = nil,
-                   send_remittance_advice = nil, expires_at = nil, status = nil,
-                   receiving_account = nil, receiving_account_type = nil,
-                   counterparty_id = nil, transaction_ids = nil,
-                   ledger_transaction_id = nil, current_return = nil,
-                   transaction_monitoring_enabled = nil,
-                   compliance_rule_metadata = nil, reference_numbers = nil,
-                   vendor_failure_reason = nil, decision_id = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:, type:,
+                   subtype:, amount:, direction:, priority:,
+                   originating_account_id:, receiving_account_id:, accounting:,
+                   accounting_category_id:, accounting_ledger_class_id:,
+                   currency:, effective_date:, description:,
+                   statement_descriptor:, remittance_information:, purpose:,
+                   metadata:, charge_bearer:, foreign_exchange_indicator:,
+                   foreign_exchange_contract:, nsf_protected:,
+                   originating_party_name:, ultimate_originating_party_name:,
+                   ultimate_originating_party_identifier:,
+                   ultimate_receiving_party_name:,
+                   ultimate_receiving_party_identifier:,
+                   send_remittance_advice:, expires_at:, status:,
+                   receiving_account:, receiving_account_type:,
+                   counterparty_id:, transaction_ids:, ledger_transaction_id:,
+                   current_return:, transaction_monitoring_enabled:,
+                   compliance_rule_metadata:, reference_numbers:,
+                   vendor_failure_reason:, decision_id:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -493,51 +488,51 @@ module ModernTreasury
       decision_id = hash.key?('decision_id') ? hash['decision_id'] : nil
 
       # Create object from extracted values.
-      PaymentOrder.new(id,
-                       object,
-                       live_mode,
-                       created_at,
-                       updated_at,
-                       type,
-                       subtype,
-                       amount,
-                       direction,
-                       priority,
-                       originating_account_id,
-                       receiving_account_id,
-                       accounting,
-                       accounting_category_id,
-                       accounting_ledger_class_id,
-                       currency,
-                       effective_date,
-                       description,
-                       statement_descriptor,
-                       remittance_information,
-                       purpose,
-                       metadata,
-                       charge_bearer,
-                       foreign_exchange_indicator,
-                       foreign_exchange_contract,
-                       nsf_protected,
-                       originating_party_name,
-                       ultimate_originating_party_name,
-                       ultimate_originating_party_identifier,
-                       ultimate_receiving_party_name,
-                       ultimate_receiving_party_identifier,
-                       send_remittance_advice,
-                       expires_at,
-                       status,
-                       receiving_account,
-                       receiving_account_type,
-                       counterparty_id,
-                       transaction_ids,
-                       ledger_transaction_id,
-                       current_return,
-                       transaction_monitoring_enabled,
-                       compliance_rule_metadata,
-                       reference_numbers,
-                       vendor_failure_reason,
-                       decision_id)
+      PaymentOrder.new(id: id,
+                       object: object,
+                       live_mode: live_mode,
+                       created_at: created_at,
+                       updated_at: updated_at,
+                       type: type,
+                       subtype: subtype,
+                       amount: amount,
+                       direction: direction,
+                       priority: priority,
+                       originating_account_id: originating_account_id,
+                       receiving_account_id: receiving_account_id,
+                       accounting: accounting,
+                       accounting_category_id: accounting_category_id,
+                       accounting_ledger_class_id: accounting_ledger_class_id,
+                       currency: currency,
+                       effective_date: effective_date,
+                       description: description,
+                       statement_descriptor: statement_descriptor,
+                       remittance_information: remittance_information,
+                       purpose: purpose,
+                       metadata: metadata,
+                       charge_bearer: charge_bearer,
+                       foreign_exchange_indicator: foreign_exchange_indicator,
+                       foreign_exchange_contract: foreign_exchange_contract,
+                       nsf_protected: nsf_protected,
+                       originating_party_name: originating_party_name,
+                       ultimate_originating_party_name: ultimate_originating_party_name,
+                       ultimate_originating_party_identifier: ultimate_originating_party_identifier,
+                       ultimate_receiving_party_name: ultimate_receiving_party_name,
+                       ultimate_receiving_party_identifier: ultimate_receiving_party_identifier,
+                       send_remittance_advice: send_remittance_advice,
+                       expires_at: expires_at,
+                       status: status,
+                       receiving_account: receiving_account,
+                       receiving_account_type: receiving_account_type,
+                       counterparty_id: counterparty_id,
+                       transaction_ids: transaction_ids,
+                       ledger_transaction_id: ledger_transaction_id,
+                       current_return: current_return,
+                       transaction_monitoring_enabled: transaction_monitoring_enabled,
+                       compliance_rule_metadata: compliance_rule_metadata,
+                       reference_numbers: reference_numbers,
+                       vendor_failure_reason: vendor_failure_reason,
+                       decision_id: decision_id)
     end
 
     def to_custom_created_at
@@ -568,15 +563,15 @@ module ModernTreasury
             APIHelper.valid_type?(value.updated_at,
                                   ->(val) { val.instance_of? DateTime }) and
             APIHelper.valid_type?(value.type,
-                                  ->(val) { Type5Enum.validate(val) }) and
+                                  ->(val) { Type5.validate(val) }) and
             APIHelper.valid_type?(value.subtype,
-                                  ->(val) { SubtypeEnum.validate(val) }) and
+                                  ->(val) { Subtype.validate(val) }) and
             APIHelper.valid_type?(value.amount,
                                   ->(val) { val.instance_of? Integer }) and
             APIHelper.valid_type?(value.direction,
-                                  ->(val) { Direction5Enum.validate(val) }) and
+                                  ->(val) { Direction5.validate(val) }) and
             APIHelper.valid_type?(value.priority,
-                                  ->(val) { PriorityEnum.validate(val) }) and
+                                  ->(val) { Priority.validate(val) }) and
             APIHelper.valid_type?(value.originating_account_id,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.receiving_account_id,
@@ -589,7 +584,7 @@ module ModernTreasury
             APIHelper.valid_type?(value.accounting_ledger_class_id,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.currency,
-                                  ->(val) { CurrencyEnum.validate(val) }) and
+                                  ->(val) { Currency.validate(val) }) and
             APIHelper.valid_type?(value.effective_date,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.description,
@@ -603,9 +598,9 @@ module ModernTreasury
             APIHelper.valid_type?(value.metadata,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.charge_bearer,
-                                  ->(val) { ChargeBearerEnum.validate(val) }) and
+                                  ->(val) { ChargeBearer.validate(val) }) and
             APIHelper.valid_type?(value.foreign_exchange_indicator,
-                                  ->(val) { ForeignExchangeIndicatorEnum.validate(val) }) and
+                                  ->(val) { ForeignExchangeIndicator.validate(val) }) and
             APIHelper.valid_type?(value.foreign_exchange_contract,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.nsf_protected,
@@ -625,11 +620,11 @@ module ModernTreasury
             APIHelper.valid_type?(value.expires_at,
                                   ->(val) { val.instance_of? DateTime }) and
             APIHelper.valid_type?(value.status,
-                                  ->(val) { Status3Enum.validate(val) }) and
+                                  ->(val) { Status3.validate(val) }) and
             UnionTypeLookUp.get(:PaymentOrderReceivingAccount)
                            .validate(value.receiving_account) and
             APIHelper.valid_type?(value.receiving_account_type,
-                                  ->(val) { ReceivingAccountTypeEnum.validate(val) }) and
+                                  ->(val) { ReceivingAccountType.validate(val) }) and
             APIHelper.valid_type?(value.counterparty_id,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.transaction_ids,
@@ -668,15 +663,15 @@ module ModernTreasury
           APIHelper.valid_type?(value['updated_at'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['type'],
-                                ->(val) { Type5Enum.validate(val) }) and
+                                ->(val) { Type5.validate(val) }) and
           APIHelper.valid_type?(value['subtype'],
-                                ->(val) { SubtypeEnum.validate(val) }) and
+                                ->(val) { Subtype.validate(val) }) and
           APIHelper.valid_type?(value['amount'],
                                 ->(val) { val.instance_of? Integer }) and
           APIHelper.valid_type?(value['direction'],
-                                ->(val) { Direction5Enum.validate(val) }) and
+                                ->(val) { Direction5.validate(val) }) and
           APIHelper.valid_type?(value['priority'],
-                                ->(val) { PriorityEnum.validate(val) }) and
+                                ->(val) { Priority.validate(val) }) and
           APIHelper.valid_type?(value['originating_account_id'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['receiving_account_id'],
@@ -689,7 +684,7 @@ module ModernTreasury
           APIHelper.valid_type?(value['accounting_ledger_class_id'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['currency'],
-                                ->(val) { CurrencyEnum.validate(val) }) and
+                                ->(val) { Currency.validate(val) }) and
           APIHelper.valid_type?(value['effective_date'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['description'],
@@ -703,9 +698,9 @@ module ModernTreasury
           APIHelper.valid_type?(value['metadata'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['charge_bearer'],
-                                ->(val) { ChargeBearerEnum.validate(val) }) and
+                                ->(val) { ChargeBearer.validate(val) }) and
           APIHelper.valid_type?(value['foreign_exchange_indicator'],
-                                ->(val) { ForeignExchangeIndicatorEnum.validate(val) }) and
+                                ->(val) { ForeignExchangeIndicator.validate(val) }) and
           APIHelper.valid_type?(value['foreign_exchange_contract'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['nsf_protected'],
@@ -725,11 +720,11 @@ module ModernTreasury
           APIHelper.valid_type?(value['expires_at'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['status'],
-                                ->(val) { Status3Enum.validate(val) }) and
+                                ->(val) { Status3.validate(val) }) and
           UnionTypeLookUp.get(:PaymentOrderReceivingAccount)
                          .validate(value['receiving_account']) and
           APIHelper.valid_type?(value['receiving_account_type'],
-                                ->(val) { ReceivingAccountTypeEnum.validate(val) }) and
+                                ->(val) { ReceivingAccountType.validate(val) }) and
           APIHelper.valid_type?(value['counterparty_id'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['transaction_ids'],