mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/models/payment_order_update_request.rb

@@ -12,14 +12,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
@@ -32,13 +32,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.
@@ -68,7 +68,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
@@ -111,13 +111,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
@@ -177,7 +177,7 @@ module ModernTreasury
     # To cancel a payment order, use `cancelled`. To redraft a returned payment
     # order, use `approved`. To undo approval on a denied or approved payment
     # order, use `needs_approval`.
-    # @return [Status18Enum]
+    # @return [Status18]
     attr_accessor :status
 
     # Required when receiving_account_id is passed the ID of an external
@@ -188,7 +188,7 @@ module ModernTreasury
     # A payment type to fallback to if the original type is not valid for the
     # receiving account. Currently, this only supports falling back from RTP to
     # ACH (type=rtp and fallback_type=ach)
-    # @return [FallbackTypeEnum]
+    # @return [FallbackType]
     attr_accessor :fallback_type
 
     # Either `receiving_account` or `receiving_account_id` must be present. When
@@ -308,24 +308,28 @@ module ModernTreasury
       ]
     end
 
-    def initialize(type = SKIP, subtype = SKIP, amount = SKIP, direction = SKIP,
-                   priority = SKIP, originating_account_id = SKIP,
-                   receiving_account_id = SKIP, accounting = SKIP,
-                   accounting_category_id = SKIP,
-                   accounting_ledger_class_id = SKIP, currency = SKIP,
-                   effective_date = SKIP, description = SKIP,
-                   statement_descriptor = SKIP, remittance_information = SKIP,
-                   purpose = SKIP, metadata = SKIP, charge_bearer = SKIP,
-                   foreign_exchange_indicator = SKIP,
-                   foreign_exchange_contract = SKIP, nsf_protected = SKIP,
-                   originating_party_name = SKIP,
-                   ultimate_originating_party_name = SKIP,
-                   ultimate_originating_party_identifier = SKIP,
-                   ultimate_receiving_party_name = SKIP,
-                   ultimate_receiving_party_identifier = SKIP,
-                   send_remittance_advice = SKIP, expires_at = SKIP,
-                   status = SKIP, counterparty_id = SKIP, fallback_type = SKIP,
-                   receiving_account = SKIP, line_items = SKIP)
+    def initialize(type: SKIP, subtype: SKIP, amount: SKIP, direction: SKIP,
+                   priority: SKIP, originating_account_id: SKIP,
+                   receiving_account_id: SKIP, accounting: SKIP,
+                   accounting_category_id: SKIP,
+                   accounting_ledger_class_id: SKIP, currency: SKIP,
+                   effective_date: SKIP, description: SKIP,
+                   statement_descriptor: SKIP, remittance_information: SKIP,
+                   purpose: SKIP, metadata: SKIP, charge_bearer: SKIP,
+                   foreign_exchange_indicator: SKIP,
+                   foreign_exchange_contract: SKIP, nsf_protected: SKIP,
+                   originating_party_name: SKIP,
+                   ultimate_originating_party_name: SKIP,
+                   ultimate_originating_party_identifier: SKIP,
+                   ultimate_receiving_party_name: SKIP,
+                   ultimate_receiving_party_identifier: SKIP,
+                   send_remittance_advice: SKIP, expires_at: SKIP, status: SKIP,
+                   counterparty_id: SKIP, fallback_type: SKIP,
+                   receiving_account: SKIP, line_items: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @type = type unless type == SKIP
       @subtype = subtype unless subtype == SKIP
       @amount = amount unless amount == SKIP
@@ -380,6 +384,7 @@ module ModernTreasury
       @fallback_type = fallback_type unless fallback_type == SKIP
       @receiving_account = receiving_account unless receiving_account == SKIP
       @line_items = line_items unless line_items == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -451,40 +456,48 @@ module ModernTreasury
 
       line_items = SKIP unless hash.key?('line_items')
 
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
       # Create object from extracted values.
-      PaymentOrderUpdateRequest.new(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,
-                                    counterparty_id,
-                                    fallback_type,
-                                    receiving_account,
-                                    line_items)
+      PaymentOrderUpdateRequest.new(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,
+                                    counterparty_id: counterparty_id,
+                                    fallback_type: fallback_type,
+                                    receiving_account: receiving_account,
+                                    line_items: line_items,
+                                    additional_properties: additional_properties)
     end
 
     def to_custom_expires_at
@@ -511,7 +524,8 @@ module ModernTreasury
       " #{@ultimate_receiving_party_identifier}, send_remittance_advice:"\
       " #{@send_remittance_advice}, expires_at: #{@expires_at}, status: #{@status},"\
       " counterparty_id: #{@counterparty_id}, fallback_type: #{@fallback_type}, receiving_account:"\
-      " #{@receiving_account}, line_items: #{@line_items}>"
+      " #{@receiving_account}, line_items: #{@line_items}, additional_properties:"\
+      " #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -537,7 +551,8 @@ module ModernTreasury
       " send_remittance_advice: #{@send_remittance_advice.inspect}, expires_at:"\
       " #{@expires_at.inspect}, status: #{@status.inspect}, counterparty_id:"\
       " #{@counterparty_id.inspect}, fallback_type: #{@fallback_type.inspect}, receiving_account:"\
-      " #{@receiving_account.inspect}, line_items: #{@line_items.inspect}>"
+      " #{@receiving_account.inspect}, line_items: #{@line_items.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/payment_reference.rb

@@ -38,7 +38,7 @@ module ModernTreasury
     attr_accessor :reference_number
 
     # The type of the reference number. Referring to the vendor payment id.
-    # @return [ReferenceNumberTypeEnum]
+    # @return [ReferenceNumberType]
     attr_accessor :reference_number_type
 
     # A mapping from model property names to API property names.
@@ -64,9 +64,8 @@ module ModernTreasury
       []
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, reference_number = nil,
-                   reference_number_type = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   reference_number:, reference_number_type:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -96,13 +95,13 @@ module ModernTreasury
         hash.key?('reference_number_type') ? hash['reference_number_type'] : nil
 
       # Create object from extracted values.
-      PaymentReference.new(id,
-                           object,
-                           live_mode,
-                           created_at,
-                           updated_at,
-                           reference_number,
-                           reference_number_type)
+      PaymentReference.new(id: id,
+                           object: object,
+                           live_mode: live_mode,
+                           created_at: created_at,
+                           updated_at: updated_at,
+                           reference_number: reference_number,
+                           reference_number_type: reference_number_type)
     end
 
     def to_custom_created_at
@@ -131,7 +130,7 @@ module ModernTreasury
             APIHelper.valid_type?(value.reference_number,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.reference_number_type,
-                                  ->(val) { ReferenceNumberTypeEnum.validate(val) })
+                                  ->(val) { ReferenceNumberType.validate(val) })
         )
       end
 
@@ -151,7 +150,7 @@ module ModernTreasury
           APIHelper.valid_type?(value['reference_number'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['reference_number_type'],
-                                ->(val) { ReferenceNumberTypeEnum.validate(val) })
+                                ->(val) { ReferenceNumberType.validate(val) })
       )
     end
 

data/lib/modern_treasury/models/payment_reference_object.rb

@@ -40,7 +40,7 @@ module ModernTreasury
 
     # One of the referenceable types. This must be accompanied by the id of the
     # referenceable or will return an error.
-    # @return [ReferenceableTypeEnum]
+    # @return [ReferenceableType]
     attr_accessor :referenceable_type
 
     # The actual reference number assigned by the bank.
@@ -48,7 +48,7 @@ module ModernTreasury
     attr_accessor :reference_number
 
     # The type of reference number.
-    # @return [ReferenceNumberType1Enum]
+    # @return [ReferenceNumberType1]
     attr_accessor :reference_number_type
 
     # A mapping from model property names to API property names.
@@ -76,10 +76,9 @@ module ModernTreasury
       []
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, referenceable_id = nil,
-                   referenceable_type = nil, reference_number = nil,
-                   reference_number_type = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   referenceable_id:, referenceable_type:, reference_number:,
+                   reference_number_type:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -115,15 +114,15 @@ module ModernTreasury
         hash.key?('reference_number_type') ? hash['reference_number_type'] : nil
 
       # Create object from extracted values.
-      PaymentReferenceObject.new(id,
-                                 object,
-                                 live_mode,
-                                 created_at,
-                                 updated_at,
-                                 referenceable_id,
-                                 referenceable_type,
-                                 reference_number,
-                                 reference_number_type)
+      PaymentReferenceObject.new(id: id,
+                                 object: object,
+                                 live_mode: live_mode,
+                                 created_at: created_at,
+                                 updated_at: updated_at,
+                                 referenceable_id: referenceable_id,
+                                 referenceable_type: referenceable_type,
+                                 reference_number: reference_number,
+                                 reference_number_type: reference_number_type)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/{payment_type_enum.rb → payment_type.rb}

@@ -6,8 +6,8 @@
 module ModernTreasury
   # An account created with this flow will support payments of one of these
   # types.
-  class PaymentTypeEnum
-    PAYMENT_TYPE_ENUM = [
+  class PaymentType
+    PAYMENT_TYPE = [
       # TODO: Write general description for ACH
       ACH = 'ach'.freeze,
 
@@ -18,7 +18,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_TYPE_ENUM.include?(value)
+      PAYMENT_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = ACH)

data/lib/modern_treasury/models/{payment_type1_enum.rb → payment_type1.rb}

@@ -6,8 +6,8 @@
 module ModernTreasury
   # If the routing detail is to be used for a specific payment type this field
   # will be populated, otherwise null.
-  class PaymentType1Enum
-    PAYMENT_TYPE1_ENUM = [
+  class PaymentType1
+    PAYMENT_TYPE1 = [
       # TODO: Write general description for ACH
       ACH = 'ach'.freeze,
 
@@ -63,7 +63,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_TYPE1_ENUM.include?(value)
+      PAYMENT_TYPE1.include?(value)
     end
 
     def self.from_value(value, default_value = ACH)

data/lib/modern_treasury/models/{payment_type13_enum.rb → payment_type13.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # payment_type13.
-  class PaymentType13Enum
-    PAYMENT_TYPE13_ENUM = [
+  class PaymentType13
+    PAYMENT_TYPE13 = [
       # TODO: Write general description for ACH
       ACH = 'ach'.freeze,
 
@@ -62,7 +62,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_TYPE13_ENUM.include?(value)
+      PAYMENT_TYPE13.include?(value)
     end
 
     def self.from_value(value, default_value = ACH)

data/lib/modern_treasury/models/{payment_type2_enum.rb → payment_type2.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # PaymentType2.
-  class PaymentType2Enum
-    PAYMENT_TYPE2_ENUM = [
+  class PaymentType2
+    PAYMENT_TYPE2 = [
       # TODO: Write general description for ACH
       ACH = 'ach'.freeze,
 
@@ -62,7 +62,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_TYPE2_ENUM.include?(value)
+      PAYMENT_TYPE2.include?(value)
     end
 
     def self.from_value(value, default_value = ACH)

data/lib/modern_treasury/models/{payment_type4_enum.rb → payment_type4.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # Both ach and eft are supported payment types.
-  class PaymentType4Enum
-    PAYMENT_TYPE4_ENUM = [
+  class PaymentType4
+    PAYMENT_TYPE4 = [
       # TODO: Write general description for ACH
       ACH = 'ach'.freeze,
 
@@ -62,7 +62,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_TYPE4_ENUM.include?(value)
+      PAYMENT_TYPE4.include?(value)
     end
 
     def self.from_value(value, default_value = ACH)

data/lib/modern_treasury/models/{payment_type5_enum.rb → payment_type5.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # One of `ach` or `eft`
-  class PaymentType5Enum
-    PAYMENT_TYPE5_ENUM = [
+  class PaymentType5
+    PAYMENT_TYPE5 = [
       # TODO: Write general description for EFT
       EFT = 'eft'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_TYPE5_ENUM.include?(value)
+      PAYMENT_TYPE5.include?(value)
     end
 
     def self.from_value(value, default_value = EFT)

data/lib/modern_treasury/models/{payment_type6_enum.rb → payment_type6.rb}

@@ -6,8 +6,8 @@
 module ModernTreasury
   # One of `ach`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sepa`, `bacs`,
   # `au_becs`, `interac`, `signet`, `provexchange`.
-  class PaymentType6Enum
-    PAYMENT_TYPE6_ENUM = [
+  class PaymentType6
+    PAYMENT_TYPE6 = [
       # TODO: Write general description for ACH
       ACH = 'ach'.freeze,
 
@@ -63,7 +63,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PAYMENT_TYPE6_ENUM.include?(value)
+      PAYMENT_TYPE6.include?(value)
     end
 
     def self.from_value(value, default_value = ACH)

data/lib/modern_treasury/models/ping_response.rb

@@ -30,7 +30,7 @@ module ModernTreasury
       []
     end
 
-    def initialize(ping = nil)
+    def initialize(ping:)
       @ping = ping
     end
 
@@ -42,7 +42,7 @@ module ModernTreasury
       ping = hash.key?('ping') ? hash['ping'] : nil
 
       # Create object from extracted values.
-      PingResponse.new(ping)
+      PingResponse.new(ping: ping)
     end
 
     # Provides a human-readable string representation of the object.

data/lib/modern_treasury/models/{priority_enum.rb → priority.rb}

@@ -7,8 +7,8 @@ module ModernTreasury
   # 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.
-  class PriorityEnum
-    PRIORITY_ENUM = [
+  class Priority
+    PRIORITY = [
       # TODO: Write general description for HIGH
       HIGH = 'high'.freeze,
 
@@ -19,7 +19,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PRIORITY_ENUM.include?(value)
+      PRIORITY.include?(value)
     end
 
     def self.from_value(value, default_value = HIGH)

data/lib/modern_treasury/models/{priority4_enum.rb → priority4.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # priority4.
-  class Priority4Enum
-    PRIORITY4_ENUM = [
+  class Priority4
+    PRIORITY4 = [
       # TODO: Write general description for HIGH
       HIGH = 'high'.freeze,
 
@@ -17,7 +17,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      PRIORITY4_ENUM.include?(value)
+      PRIORITY4.include?(value)
     end
 
     def self.from_value(value, default_value = HIGH)

data/lib/modern_treasury/models/{reason_enum.rb → reason.rb}

@@ -5,8 +5,8 @@
 
 module ModernTreasury
   # The reason for the reversal.
-  class ReasonEnum
-    REASON_ENUM = [
+  class Reason
+    REASON = [
       # TODO: Write general description for DUPLICATE
       DUPLICATE = 'duplicate'.freeze,
 
@@ -26,7 +26,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      REASON_ENUM.include?(value)
+      REASON.include?(value)
     end
 
     def self.from_value(value, default_value = DUPLICATE)

data/lib/modern_treasury/models/{reason1_enum.rb → reason1.rb}

@@ -7,8 +7,8 @@ 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`.
-  class Reason1Enum
-    REASON1_ENUM = [
+  class Reason1
+    REASON1 = [
       # TODO: Write general description for DUPLICATE
       DUPLICATE = 'duplicate'.freeze,
 
@@ -28,7 +28,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      REASON1_ENUM.include?(value)
+      REASON1.include?(value)
     end
 
     def self.from_value(value, default_value = DUPLICATE)