mt-sdk 0.0.1 → 0.0.2

data/lib/modern_treasury/models/ledger_event_handler.rb

@@ -90,10 +90,9 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, discarded_at = nil, name = nil,
-                   description = nil, ledger_transaction_template = nil,
-                   conditions = nil, metadata = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   discarded_at:, name:, description:,
+                   ledger_transaction_template:, conditions:, metadata:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -134,17 +133,17 @@ module ModernTreasury
       metadata = hash.key?('metadata') ? hash['metadata'] : nil
 
       # Create object from extracted values.
-      LedgerEventHandler.new(id,
-                             object,
-                             live_mode,
-                             created_at,
-                             updated_at,
-                             discarded_at,
-                             name,
-                             description,
-                             ledger_transaction_template,
-                             conditions,
-                             metadata)
+      LedgerEventHandler.new(id: id,
+                             object: object,
+                             live_mode: live_mode,
+                             created_at: created_at,
+                             updated_at: updated_at,
+                             discarded_at: discarded_at,
+                             name: name,
+                             description: description,
+                             ledger_transaction_template: ledger_transaction_template,
+                             conditions: conditions,
+                             metadata: metadata)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/ledger_event_handler_conditions.rb

@@ -41,7 +41,7 @@ module ModernTreasury
       []
     end
 
-    def initialize(field = nil, operator = nil, value = nil)
+    def initialize(field:, operator:, value:)
       @field = field
       @operator = operator
       @value = value
@@ -57,9 +57,9 @@ module ModernTreasury
       value = hash.key?('value') ? hash['value'] : nil
 
       # Create object from extracted values.
-      LedgerEventHandlerConditions.new(field,
-                                       operator,
-                                       value)
+      LedgerEventHandlerConditions.new(field: field,
+                                       operator: operator,
+                                       value: value)
     end
 
     # Provides a human-readable string representation of the object.

data/lib/modern_treasury/models/ledger_event_handler_create_request.rb

@@ -64,15 +64,19 @@ module ModernTreasury
       ]
     end
 
-    def initialize(name = nil, ledger_transaction_template = nil,
-                   description = SKIP, ledger_id = SKIP, conditions = SKIP,
-                   metadata = SKIP)
+    def initialize(name:, ledger_transaction_template:, description: SKIP,
+                   ledger_id: SKIP, conditions: SKIP, metadata: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @name = name
       @description = description unless description == SKIP
       @ledger_id = ledger_id unless ledger_id == SKIP
       @ledger_transaction_template = ledger_transaction_template
       @conditions = conditions unless conditions == SKIP
       @metadata = metadata unless metadata == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -90,13 +94,21 @@ module ModernTreasury
         hash['conditions']
       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.
-      LedgerEventHandlerCreateRequest.new(name,
-                                          ledger_transaction_template,
-                                          description,
-                                          ledger_id,
-                                          conditions,
-                                          metadata)
+      LedgerEventHandlerCreateRequest.new(name: name,
+                                          ledger_transaction_template: ledger_transaction_template,
+                                          description: description,
+                                          ledger_id: ledger_id,
+                                          conditions: conditions,
+                                          metadata: metadata,
+                                          additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
@@ -104,7 +116,7 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} name: #{@name}, description: #{@description}, ledger_id: #{@ledger_id},"\
       " ledger_transaction_template: #{@ledger_transaction_template}, conditions: #{@conditions},"\
-      " metadata: #{@metadata}>"
+      " metadata: #{@metadata}, additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -113,7 +125,7 @@ module ModernTreasury
       "<#{class_name} name: #{@name.inspect}, description: #{@description.inspect}, ledger_id:"\
       " #{@ledger_id.inspect}, ledger_transaction_template:"\
       " #{@ledger_transaction_template.inspect}, conditions: #{@conditions.inspect}, metadata:"\
-      " #{@metadata.inspect}>"
+      " #{@metadata.inspect}, additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/ledger_event_handler_ledger_entries.rb

@@ -41,7 +41,7 @@ module ModernTreasury
       []
     end
 
-    def initialize(amount = nil, direction = nil, ledger_account_id = nil)
+    def initialize(amount:, direction:, ledger_account_id:)
       @amount = amount
       @direction = direction
       @ledger_account_id = ledger_account_id
@@ -58,9 +58,9 @@ module ModernTreasury
         hash.key?('ledger_account_id') ? hash['ledger_account_id'] : nil
 
       # Create object from extracted values.
-      LedgerEventHandlerLedgerEntries.new(amount,
-                                          direction,
-                                          ledger_account_id)
+      LedgerEventHandlerLedgerEntries.new(amount: amount,
+                                          direction: direction,
+                                          ledger_account_id: ledger_account_id)
     end
 
     # Provides a human-readable string representation of the object.

data/lib/modern_treasury/models/ledger_event_handler_ledger_transaction_template.rb

@@ -51,8 +51,7 @@ module ModernTreasury
       ]
     end
 
-    def initialize(description = nil, effective_at = nil, ledger_entries = nil,
-                   metadata = nil)
+    def initialize(description:, effective_at:, ledger_entries:, metadata:)
       @description = description
       @effective_at = effective_at
       @ledger_entries = ledger_entries
@@ -79,10 +78,10 @@ module ModernTreasury
       metadata = hash.key?('metadata') ? hash['metadata'] : nil
 
       # Create object from extracted values.
-      LedgerEventHandlerLedgerTransactionTemplate.new(description,
-                                                      effective_at,
-                                                      ledger_entries,
-                                                      metadata)
+      LedgerEventHandlerLedgerTransactionTemplate.new(description: description,
+                                                      effective_at: effective_at,
+                                                      ledger_entries: ledger_entries,
+                                                      metadata: metadata)
     end
 
     # Provides a human-readable string representation of the object.

data/lib/modern_treasury/models/ledger_transaction.rb

@@ -38,7 +38,7 @@ module ModernTreasury
     attr_accessor :description
 
     # To post a ledger transaction at creation, use `posted`.
-    # @return [Status11Enum]
+    # @return [Status11]
     attr_accessor :status
 
     # Additional data represented as key-value pairs. Both the key and value
@@ -73,7 +73,7 @@ module ModernTreasury
     # Treasury, the type will be populated here, otherwise null. This can be one
     # of payment_order, incoming_payment_detail, expected_payment, return, or
     # reversal.
-    # @return [LedgerableType2Enum]
+    # @return [LedgerableType2]
     attr_accessor :ledgerable_type
 
     # If the ledger transaction can be reconciled to another object in Modern
@@ -132,12 +132,11 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   updated_at = nil, description = nil, status = nil,
-                   metadata = nil, effective_at = nil, effective_date = nil,
-                   ledger_entries = nil, posted_at = nil, ledger_id = nil,
-                   ledgerable_type = nil, ledgerable_id = nil,
-                   external_id = nil, reverses_ledger_transaction_id = nil)
+    def initialize(id:, object:, live_mode:, created_at:, updated_at:,
+                   description:, status:, metadata:, effective_at:,
+                   effective_date:, ledger_entries:, posted_at:, ledger_id:,
+                   ledgerable_type:, ledgerable_id:, external_id:,
+                   reverses_ledger_transaction_id:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -199,23 +198,23 @@ module ModernTreasury
         hash.key?('reverses_ledger_transaction_id') ? hash['reverses_ledger_transaction_id'] : nil
 
       # Create object from extracted values.
-      LedgerTransaction.new(id,
-                            object,
-                            live_mode,
-                            created_at,
-                            updated_at,
-                            description,
-                            status,
-                            metadata,
-                            effective_at,
-                            effective_date,
-                            ledger_entries,
-                            posted_at,
-                            ledger_id,
-                            ledgerable_type,
-                            ledgerable_id,
-                            external_id,
-                            reverses_ledger_transaction_id)
+      LedgerTransaction.new(id: id,
+                            object: object,
+                            live_mode: live_mode,
+                            created_at: created_at,
+                            updated_at: updated_at,
+                            description: description,
+                            status: status,
+                            metadata: metadata,
+                            effective_at: effective_at,
+                            effective_date: effective_date,
+                            ledger_entries: ledger_entries,
+                            posted_at: posted_at,
+                            ledger_id: ledger_id,
+                            ledgerable_type: ledgerable_type,
+                            ledgerable_id: ledgerable_id,
+                            external_id: external_id,
+                            reverses_ledger_transaction_id: reverses_ledger_transaction_id)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/ledger_transaction_create_request.rb

@@ -14,7 +14,7 @@ module ModernTreasury
     attr_accessor :description
 
     # To post a ledger transaction at creation, use `posted`.
-    # @return [Status11Enum]
+    # @return [Status11]
     attr_accessor :status
 
     # Additional data represented as key-value pairs. Both the key and value
@@ -45,7 +45,7 @@ module ModernTreasury
     # Treasury, the type will be populated here, otherwise null. This can be one
     # of payment_order, incoming_payment_detail, expected_payment, return, or
     # reversal.
-    # @return [LedgerableType2Enum]
+    # @return [LedgerableType2]
     attr_accessor :ledgerable_type
 
     # If the ledger transaction can be reconciled to another object in Modern
@@ -89,10 +89,13 @@ module ModernTreasury
       ]
     end
 
-    def initialize(ledger_entries = nil, description = SKIP, status = SKIP,
-                   metadata = SKIP, effective_at = SKIP, effective_date = SKIP,
-                   external_id = SKIP, ledgerable_type = SKIP,
-                   ledgerable_id = SKIP)
+    def initialize(ledger_entries:, description: SKIP, status: SKIP,
+                   metadata: SKIP, effective_at: SKIP, effective_date: SKIP,
+                   external_id: SKIP, ledgerable_type: SKIP,
+                   ledgerable_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @description = description unless description == SKIP
       @status = status unless status == SKIP
       @metadata = metadata unless metadata == SKIP
@@ -102,6 +105,7 @@ module ModernTreasury
       @external_id = external_id unless external_id == SKIP
       @ledgerable_type = ledgerable_type unless ledgerable_type == SKIP
       @ledgerable_id = ledgerable_id unless ledgerable_id == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -130,16 +134,24 @@ module ModernTreasury
         hash.key?('ledgerable_type') ? hash['ledgerable_type'] : SKIP
       ledgerable_id = hash.key?('ledgerable_id') ? hash['ledgerable_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.
-      LedgerTransactionCreateRequest.new(ledger_entries,
-                                         description,
-                                         status,
-                                         metadata,
-                                         effective_at,
-                                         effective_date,
-                                         external_id,
-                                         ledgerable_type,
-                                         ledgerable_id)
+      LedgerTransactionCreateRequest.new(ledger_entries: ledger_entries,
+                                         description: description,
+                                         status: status,
+                                         metadata: metadata,
+                                         effective_at: effective_at,
+                                         effective_date: effective_date,
+                                         external_id: external_id,
+                                         ledgerable_type: ledgerable_type,
+                                         ledgerable_id: ledgerable_id,
+                                         additional_properties: additional_properties)
     end
 
     # Provides a human-readable string representation of the object.
@@ -148,7 +160,7 @@ module ModernTreasury
       "<#{class_name} description: #{@description}, status: #{@status}, metadata: #{@metadata},"\
       " effective_at: #{@effective_at}, effective_date: #{@effective_date}, ledger_entries:"\
       " #{@ledger_entries}, external_id: #{@external_id}, ledgerable_type: #{@ledgerable_type},"\
-      " ledgerable_id: #{@ledgerable_id}>"
+      " ledgerable_id: #{@ledgerable_id}, additional_properties: #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -158,7 +170,7 @@ module ModernTreasury
       " #{@metadata.inspect}, effective_at: #{@effective_at.inspect}, effective_date:"\
       " #{@effective_date.inspect}, ledger_entries: #{@ledger_entries.inspect}, external_id:"\
       " #{@external_id.inspect}, ledgerable_type: #{@ledgerable_type.inspect}, ledgerable_id:"\
-      " #{@ledgerable_id.inspect}>"
+      " #{@ledgerable_id.inspect}, additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/ledger_transaction_reversal_create_request.rb

@@ -17,7 +17,7 @@ module ModernTreasury
 
     # Status of the reversal ledger transaction. It defaults to `posted` if not
     # provided.
-    # @return [Status15Enum]
+    # @return [Status15]
     attr_accessor :status
 
     # Additional data to be added to the reversal ledger transaction as
@@ -37,7 +37,7 @@ module ModernTreasury
 
     # Specify this if you'd like to link the reversal ledger transaction to a
     # Payment object like Return or Reversal.
-    # @return [LedgerableType5Enum]
+    # @return [LedgerableType5]
     attr_accessor :ledgerable_type
 
     # Specify this if you'd like to link the reversal ledger transaction to a
@@ -78,9 +78,12 @@ module ModernTreasury
       ]
     end
 
-    def initialize(description = SKIP, status = SKIP, metadata = SKIP,
-                   effective_at = SKIP, external_id = SKIP,
-                   ledgerable_type = SKIP, ledgerable_id = SKIP)
+    def initialize(description: SKIP, status: SKIP, metadata: SKIP,
+                   effective_at: SKIP, external_id: SKIP, ledgerable_type: SKIP,
+                   ledgerable_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @description = description unless description == SKIP
       @status = status unless status == SKIP
       @metadata = metadata unless metadata == SKIP
@@ -88,6 +91,7 @@ module ModernTreasury
       @external_id = external_id unless external_id == SKIP
       @ledgerable_type = ledgerable_type unless ledgerable_type == SKIP
       @ledgerable_id = ledgerable_id unless ledgerable_id == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -108,14 +112,22 @@ module ModernTreasury
         hash.key?('ledgerable_type') ? hash['ledgerable_type'] : SKIP
       ledgerable_id = hash.key?('ledgerable_id') ? hash['ledgerable_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.
-      LedgerTransactionReversalCreateRequest.new(description,
-                                                 status,
-                                                 metadata,
-                                                 effective_at,
-                                                 external_id,
-                                                 ledgerable_type,
-                                                 ledgerable_id)
+      LedgerTransactionReversalCreateRequest.new(description: description,
+                                                 status: status,
+                                                 metadata: metadata,
+                                                 effective_at: effective_at,
+                                                 external_id: external_id,
+                                                 ledgerable_type: ledgerable_type,
+                                                 ledgerable_id: ledgerable_id,
+                                                 additional_properties: additional_properties)
     end
 
     def to_custom_effective_at
@@ -127,7 +139,8 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} description: #{@description}, status: #{@status}, metadata: #{@metadata},"\
       " effective_at: #{@effective_at}, external_id: #{@external_id}, ledgerable_type:"\
-      " #{@ledgerable_type}, ledgerable_id: #{@ledgerable_id}>"
+      " #{@ledgerable_type}, ledgerable_id: #{@ledgerable_id}, additional_properties:"\
+      " #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -136,7 +149,7 @@ module ModernTreasury
       "<#{class_name} description: #{@description.inspect}, status: #{@status.inspect}, metadata:"\
       " #{@metadata.inspect}, effective_at: #{@effective_at.inspect}, external_id:"\
       " #{@external_id.inspect}, ledgerable_type: #{@ledgerable_type.inspect}, ledgerable_id:"\
-      " #{@ledgerable_id.inspect}>"
+      " #{@ledgerable_id.inspect}, additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/ledger_transaction_update_request.rb

@@ -14,7 +14,7 @@ module ModernTreasury
     attr_accessor :description
 
     # To post a ledger transaction at creation, use `posted`.
-    # @return [Status11Enum]
+    # @return [Status11]
     attr_accessor :status
 
     # Additional data represented as key-value pairs. Both the key and value
@@ -60,13 +60,18 @@ module ModernTreasury
       ]
     end
 
-    def initialize(description = SKIP, status = SKIP, metadata = SKIP,
-                   effective_at = SKIP, ledger_entries = SKIP)
+    def initialize(description: SKIP, status: SKIP, metadata: SKIP,
+                   effective_at: SKIP, ledger_entries: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
       @description = description unless description == SKIP
       @status = status unless status == SKIP
       @metadata = metadata unless metadata == SKIP
       @effective_at = effective_at unless effective_at == SKIP
       @ledger_entries = ledger_entries unless ledger_entries == SKIP
+      @additional_properties = additional_properties
     end
 
     # Creates an instance of the object from a hash.
@@ -89,19 +94,28 @@ module ModernTreasury
 
       ledger_entries = SKIP unless hash.key?('ledger_entries')
 
+      # 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.
-      LedgerTransactionUpdateRequest.new(description,
-                                         status,
-                                         metadata,
-                                         effective_at,
-                                         ledger_entries)
+      LedgerTransactionUpdateRequest.new(description: description,
+                                         status: status,
+                                         metadata: metadata,
+                                         effective_at: effective_at,
+                                         ledger_entries: ledger_entries,
+                                         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} description: #{@description}, status: #{@status}, metadata: #{@metadata},"\
-      " effective_at: #{@effective_at}, ledger_entries: #{@ledger_entries}>"
+      " effective_at: #{@effective_at}, ledger_entries: #{@ledger_entries}, additional_properties:"\
+      " #{@additional_properties}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -109,7 +123,7 @@ module ModernTreasury
       class_name = self.class.name.split('::').last
       "<#{class_name} description: #{@description.inspect}, status: #{@status.inspect}, metadata:"\
       " #{@metadata.inspect}, effective_at: #{@effective_at.inspect}, ledger_entries:"\
-      " #{@ledger_entries.inspect}>"
+      " #{@ledger_entries.inspect}, additional_properties: #{@additional_properties}>"
     end
   end
 end

data/lib/modern_treasury/models/ledger_transaction_version.rb

@@ -37,7 +37,7 @@ module ModernTreasury
     attr_accessor :description
 
     # One of `pending`, `posted`, or `archived`
-    # @return [Status12Enum]
+    # @return [Status12]
     attr_accessor :status
 
     # Additional data represented as key-value pairs. Both the key and value
@@ -72,7 +72,7 @@ module ModernTreasury
     # Treasury, the type will be populated here, otherwise null. This can be one
     # of payment_order, incoming_payment_detail, expected_payment, return, or
     # reversal.
-    # @return [LedgerableType2Enum]
+    # @return [LedgerableType2]
     attr_accessor :ledgerable_type
 
     # If the ledger transaction can be reconciled to another object in Modern
@@ -128,12 +128,11 @@ module ModernTreasury
       ]
     end
 
-    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
-                   ledger_transaction_id = nil, description = nil, status = nil,
-                   metadata = nil, effective_at = nil, effective_date = nil,
-                   ledger_entries = nil, posted_at = nil, ledger_id = nil,
-                   ledgerable_type = nil, ledgerable_id = nil,
-                   external_id = nil, version = nil)
+    def initialize(id:, object:, live_mode:, created_at:,
+                   ledger_transaction_id:, description:, status:, metadata:,
+                   effective_at:, effective_date:, ledger_entries:, posted_at:,
+                   ledger_id:, ledgerable_type:, ledgerable_id:, external_id:,
+                   version:)
       @id = id
       @object = object
       @live_mode = live_mode
@@ -195,23 +194,23 @@ module ModernTreasury
       version = hash.key?('version') ? hash['version'] : nil
 
       # Create object from extracted values.
-      LedgerTransactionVersion.new(id,
-                                   object,
-                                   live_mode,
-                                   created_at,
-                                   ledger_transaction_id,
-                                   description,
-                                   status,
-                                   metadata,
-                                   effective_at,
-                                   effective_date,
-                                   ledger_entries,
-                                   posted_at,
-                                   ledger_id,
-                                   ledgerable_type,
-                                   ledgerable_id,
-                                   external_id,
-                                   version)
+      LedgerTransactionVersion.new(id: id,
+                                   object: object,
+                                   live_mode: live_mode,
+                                   created_at: created_at,
+                                   ledger_transaction_id: ledger_transaction_id,
+                                   description: description,
+                                   status: status,
+                                   metadata: metadata,
+                                   effective_at: effective_at,
+                                   effective_date: effective_date,
+                                   ledger_entries: ledger_entries,
+                                   posted_at: posted_at,
+                                   ledger_id: ledger_id,
+                                   ledgerable_type: ledgerable_type,
+                                   ledgerable_id: ledgerable_id,
+                                   external_id: external_id,
+                                   version: version)
     end
 
     def to_custom_created_at

data/lib/modern_treasury/models/{ledger_type_enum.rb → ledger_type.rb}

@@ -6,8 +6,8 @@
 module ModernTreasury
   # An optional type to auto-sync the counterparty to your ledger. Either
   # `customer` or `vendor`.
-  class LedgerTypeEnum
-    LEDGER_TYPE_ENUM = [
+  class LedgerType
+    LEDGER_TYPE = [
       # TODO: Write general description for CUSTOMER
       CUSTOMER = 'customer'.freeze,
 
@@ -18,7 +18,7 @@ module ModernTreasury
     def self.validate(value)
       return false if value.nil?
 
-      LEDGER_TYPE_ENUM.include?(value)
+      LEDGER_TYPE.include?(value)
     end
 
     def self.from_value(value, default_value = CUSTOMER)