mt-sdk 0.0.1

data/lib/modern_treasury/models/ledger_transaction_update_request.rb

@@ -0,0 +1,115 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerTransactionUpdateRequest Model.
+  class LedgerTransactionUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An optional description for internal use.
+    # @return [String]
+    attr_accessor :description
+
+    # To post a ledger transaction at creation, use `posted`.
+    # @return [Status11Enum]
+    attr_accessor :status
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # The timestamp (ISO8601 format) at which the ledger transaction happened
+    # for reporting purposes.
+    # @return [Date]
+    attr_accessor :effective_at
+
+    # An array of ledger entry objects.
+    # @return [Array[LedgerEntryCreateRequest]]
+    attr_accessor :ledger_entries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['status'] = 'status'
+      @_hash['metadata'] = 'metadata'
+      @_hash['effective_at'] = 'effective_at'
+      @_hash['ledger_entries'] = 'ledger_entries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        status
+        metadata
+        effective_at
+        ledger_entries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(description = SKIP, status = SKIP, metadata = SKIP,
+                   effective_at = SKIP, ledger_entries = SKIP)
+      @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
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      effective_at = hash.key?('effective_at') ? hash['effective_at'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      ledger_entries = nil
+      unless hash['ledger_entries'].nil?
+        ledger_entries = []
+        hash['ledger_entries'].each do |structure|
+          ledger_entries << (LedgerEntryCreateRequest.from_hash(structure) if structure)
+        end
+      end
+
+      ledger_entries = SKIP unless hash.key?('ledger_entries')
+
+      # Create object from extracted values.
+      LedgerTransactionUpdateRequest.new(description,
+                                         status,
+                                         metadata,
+                                         effective_at,
+                                         ledger_entries)
+    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}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      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}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_transaction_version.rb

@@ -0,0 +1,254 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LedgerTransactionVersion Model.
+  class LedgerTransactionVersion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :live_mode
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The ID of the ledger transaction
+    # @return [UUID | String]
+    attr_accessor :ledger_transaction_id
+
+    # An optional description for internal use.
+    # @return [String]
+    attr_accessor :description
+
+    # One of `pending`, `posted`, or `archived`
+    # @return [Status12Enum]
+    attr_accessor :status
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # The timestamp (ISO8601 format) at which the ledger transaction happened
+    # for reporting purposes.
+    # @return [DateTime]
+    attr_accessor :effective_at
+
+    # The date (YYYY-MM-DD) on which the ledger transaction happened for
+    # reporting purposes.
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # An array of ledger entry objects.
+    # @return [Array[LedgerEntryOfTransactionVersion]]
+    attr_accessor :ledger_entries
+
+    # The time on which the ledger transaction posted. This is null if the
+    # ledger transaction is pending.
+    # @return [DateTime]
+    attr_accessor :posted_at
+
+    # The ID of the ledger this ledger transaction belongs to.
+    # @return [UUID | String]
+    attr_accessor :ledger_id
+
+    # If the ledger transaction can be reconciled to another object in Modern
+    # 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]
+    attr_accessor :ledgerable_type
+
+    # If the ledger transaction can be reconciled to another object in Modern
+    # Treasury, the id will be populated here, otherwise null.
+    # @return [UUID | String]
+    attr_accessor :ledgerable_id
+
+    # A unique string to represent the ledger transaction. Only one pending or
+    # posted ledger transaction may have this ID in the ledger.
+    # @return [String]
+    attr_accessor :external_id
+
+    # Version number of the ledger transaction.
+    # @return [Integer]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['live_mode'] = 'live_mode'
+      @_hash['created_at'] = 'created_at'
+      @_hash['ledger_transaction_id'] = 'ledger_transaction_id'
+      @_hash['description'] = 'description'
+      @_hash['status'] = 'status'
+      @_hash['metadata'] = 'metadata'
+      @_hash['effective_at'] = 'effective_at'
+      @_hash['effective_date'] = 'effective_date'
+      @_hash['ledger_entries'] = 'ledger_entries'
+      @_hash['posted_at'] = 'posted_at'
+      @_hash['ledger_id'] = 'ledger_id'
+      @_hash['ledgerable_type'] = 'ledgerable_type'
+      @_hash['ledgerable_id'] = 'ledgerable_id'
+      @_hash['external_id'] = 'external_id'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        posted_at
+        ledgerable_type
+        ledgerable_id
+        external_id
+      ]
+    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)
+      @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
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      object = hash.key?('object') ? hash['object'] : nil
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      ledger_transaction_id =
+        hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      effective_at = if hash.key?('effective_at')
+                       (DateTimeHelper.from_rfc3339(hash['effective_at']) if hash['effective_at'])
+                     end
+      effective_date =
+        hash.key?('effective_date') ? hash['effective_date'] : nil
+      # Parameter is an array, so we need to iterate through it
+      ledger_entries = nil
+      unless hash['ledger_entries'].nil?
+        ledger_entries = []
+        hash['ledger_entries'].each do |structure|
+          ledger_entries << (LedgerEntryOfTransactionVersion.from_hash(structure) if structure)
+        end
+      end
+
+      ledger_entries = nil unless hash.key?('ledger_entries')
+      posted_at = if hash.key?('posted_at')
+                    (DateTimeHelper.from_rfc3339(hash['posted_at']) if hash['posted_at'])
+                  end
+      ledger_id = hash.key?('ledger_id') ? hash['ledger_id'] : nil
+      ledgerable_type =
+        hash.key?('ledgerable_type') ? hash['ledgerable_type'] : nil
+      ledgerable_id = hash.key?('ledgerable_id') ? hash['ledgerable_id'] : nil
+      external_id = hash.key?('external_id') ? hash['external_id'] : nil
+      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)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_effective_at
+      DateTimeHelper.to_rfc3339(effective_at)
+    end
+
+    def to_custom_posted_at
+      DateTimeHelper.to_rfc3339(posted_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
+      " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, ledger_transaction_id:"\
+      " #{@ledger_transaction_id.inspect}, description: #{@description.inspect}, status:"\
+      " #{@status.inspect}, metadata: #{@metadata.inspect}, effective_at:"\
+      " #{@effective_at.inspect}, effective_date: #{@effective_date.inspect}, ledger_entries:"\
+      " #{@ledger_entries.inspect}, posted_at: #{@posted_at.inspect}, ledger_id:"\
+      " #{@ledger_id.inspect}, ledgerable_type: #{@ledgerable_type.inspect}, ledgerable_id:"\
+      " #{@ledgerable_id.inspect}, external_id: #{@external_id.inspect}, version:"\
+      " #{@version.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_type_enum.rb

@@ -0,0 +1,37 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # An optional type to auto-sync the counterparty to your ledger. Either
+  # `customer` or `vendor`.
+  class LedgerTypeEnum
+    LEDGER_TYPE_ENUM = [
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'customer'.freeze,
+
+      # TODO: Write general description for VENDOR
+      VENDOR = 'vendor'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LEDGER_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CUSTOMER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'customer' then CUSTOMER
+      when 'vendor' then VENDOR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_update_request.rb

@@ -0,0 +1,84 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerUpdateRequest Model.
+  class LedgerUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the ledger.
+    # @return [String]
+    attr_accessor :name
+
+    # An optional free-form description for internal use.
+    # @return [String]
+    attr_accessor :description
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        description
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(name = SKIP, description = SKIP, metadata = SKIP)
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @metadata = metadata unless metadata == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      LedgerUpdateRequest.new(name,
+                              description,
+                              metadata)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, description: #{@description}, metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, description: #{@description.inspect}, metadata:"\
+      " #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledgerable_event.rb

@@ -0,0 +1,206 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LedgerableEvent Model.
+  class LedgerableEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :live_mode
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Name of the ledgerable event.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the ledgerable event.
+    # @return [String]
+    attr_accessor :description
+
+    # One of `credit`, `debit`.
+    # @return [String]
+    attr_accessor :direction
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # An ISO 4217 conformed currency or a custom currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # Must be included if currency is a custom currency. The currency_exponent
+    # cannot exceed 30.
+    # @return [Integer]
+    attr_accessor :currency_exponent
+
+    # Additionally data to be used by the Ledger Event Handler.
+    # @return [Object]
+    attr_accessor :custom_data
+
+    # Id of the ledger event handler that is used to create a ledger
+    # transaction.
+    # @return [UUID | String]
+    attr_accessor :ledger_event_handler_id
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['live_mode'] = 'live_mode'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['direction'] = 'direction'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['currency_exponent'] = 'currency_exponent'
+      @_hash['custom_data'] = 'custom_data'
+      @_hash['ledger_event_handler_id'] = 'ledger_event_handler_id'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        direction
+        currency_exponent
+        custom_data
+        metadata
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, name = nil, description = nil,
+                   direction = nil, amount = nil, currency = nil,
+                   currency_exponent = nil, custom_data = nil,
+                   ledger_event_handler_id = nil, metadata = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @name = name
+      @description = description
+      @direction = direction
+      @amount = amount
+      @currency = currency
+      @currency_exponent = currency_exponent
+      @custom_data = custom_data
+      @ledger_event_handler_id = ledger_event_handler_id
+      @metadata = metadata
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      object = hash.key?('object') ? hash['object'] : nil
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      currency_exponent =
+        hash.key?('currency_exponent') ? hash['currency_exponent'] : nil
+      custom_data = hash.key?('custom_data') ? hash['custom_data'] : nil
+      ledger_event_handler_id =
+        hash.key?('ledger_event_handler_id') ? hash['ledger_event_handler_id'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+
+      # Create object from extracted values.
+      LedgerableEvent.new(id,
+                          object,
+                          live_mode,
+                          created_at,
+                          updated_at,
+                          name,
+                          description,
+                          direction,
+                          amount,
+                          currency,
+                          currency_exponent,
+                          custom_data,
+                          ledger_event_handler_id,
+                          metadata)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, object: #{@object}, live_mode: #{@live_mode}, created_at:"\
+      " #{@created_at}, updated_at: #{@updated_at}, name: #{@name}, description: #{@description},"\
+      " direction: #{@direction}, amount: #{@amount}, currency: #{@currency}, currency_exponent:"\
+      " #{@currency_exponent}, custom_data: #{@custom_data}, ledger_event_handler_id:"\
+      " #{@ledger_event_handler_id}, metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
+      " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, name: #{@name.inspect}, description: #{@description.inspect},"\
+      " direction: #{@direction.inspect}, amount: #{@amount.inspect}, currency:"\
+      " #{@currency.inspect}, currency_exponent: #{@currency_exponent.inspect}, custom_data:"\
+      " #{@custom_data.inspect}, ledger_event_handler_id: #{@ledger_event_handler_id.inspect},"\
+      " metadata: #{@metadata.inspect}>"
+    end
+  end
+end