mt-sdk 0.0.1

data/lib/modern_treasury/models/ledger_account_statement.rb

@@ -0,0 +1,233 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LedgerAccountStatement Model.
+  class LedgerAccountStatement < 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
+
+    # The id of the ledger that this ledger account statement belongs to.
+    # @return [UUID | String]
+    attr_accessor :ledger_id
+
+    # The description of the ledger account statement.
+    # @return [String]
+    attr_accessor :description
+
+    # The id of the ledger account whose ledger entries are queried against, and
+    # its balances are computed as a result.
+    # @return [UUID | String]
+    attr_accessor :ledger_account_id
+
+    # Lock version of the ledger account at the time of statement generation.
+    # @return [Integer]
+    attr_accessor :ledger_account_lock_version
+
+    # The normal balance of the ledger account.
+    # @return [LedgerAccountNormalBalanceEnum]
+    attr_accessor :ledger_account_normal_balance
+
+    # The inclusive lower bound of the effective_at timestamp of the ledger
+    # entries to be included in the ledger account statement.
+    # @return [DateTime]
+    attr_accessor :effective_at_lower_bound
+
+    # The exclusive upper bound of the effective_at timestamp of the ledger
+    # entries to be included in the ledger account statement.
+    # @return [DateTime]
+    attr_accessor :effective_at_upper_bound
+
+    # The exclusive upper bound of the effective_at timestamp of the ledger
+    # entries to be included in the ledger account statement.
+    # @return [LedgerBalances]
+    attr_accessor :starting_balance
+
+    # The exclusive upper bound of the effective_at timestamp of the ledger
+    # entries to be included in the ledger account statement.
+    # @return [LedgerBalances]
+    attr_accessor :ending_balance
+
+    # 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['ledger_id'] = 'ledger_id'
+      @_hash['description'] = 'description'
+      @_hash['ledger_account_id'] = 'ledger_account_id'
+      @_hash['ledger_account_lock_version'] = 'ledger_account_lock_version'
+      @_hash['ledger_account_normal_balance'] =
+        'ledger_account_normal_balance'
+      @_hash['effective_at_lower_bound'] = 'effective_at_lower_bound'
+      @_hash['effective_at_upper_bound'] = 'effective_at_upper_bound'
+      @_hash['starting_balance'] = 'starting_balance'
+      @_hash['ending_balance'] = 'ending_balance'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, ledger_id = nil, description = nil,
+                   ledger_account_id = nil, ledger_account_lock_version = nil,
+                   ledger_account_normal_balance = nil,
+                   effective_at_lower_bound = nil,
+                   effective_at_upper_bound = nil, starting_balance = nil,
+                   ending_balance = nil, metadata = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @ledger_id = ledger_id
+      @description = description
+      @ledger_account_id = ledger_account_id
+      @ledger_account_lock_version = ledger_account_lock_version
+      @ledger_account_normal_balance = ledger_account_normal_balance
+      @effective_at_lower_bound = effective_at_lower_bound
+      @effective_at_upper_bound = effective_at_upper_bound
+      @starting_balance = starting_balance
+      @ending_balance = ending_balance
+      @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
+      ledger_id = hash.key?('ledger_id') ? hash['ledger_id'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      ledger_account_id =
+        hash.key?('ledger_account_id') ? hash['ledger_account_id'] : nil
+      ledger_account_lock_version =
+        hash.key?('ledger_account_lock_version') ? hash['ledger_account_lock_version'] : nil
+      ledger_account_normal_balance =
+        hash.key?('ledger_account_normal_balance') ? hash['ledger_account_normal_balance'] : nil
+      effective_at_lower_bound = if hash.key?('effective_at_lower_bound')
+                                   (DateTimeHelper.from_rfc3339(hash['effective_at_lower_bound']) if hash['effective_at_lower_bound'])
+                                 end
+      effective_at_upper_bound = if hash.key?('effective_at_upper_bound')
+                                   (DateTimeHelper.from_rfc3339(hash['effective_at_upper_bound']) if hash['effective_at_upper_bound'])
+                                 end
+      starting_balance = LedgerBalances.from_hash(hash['starting_balance']) if
+        hash['starting_balance']
+      ending_balance = LedgerBalances.from_hash(hash['ending_balance']) if hash['ending_balance']
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+
+      # Create object from extracted values.
+      LedgerAccountStatement.new(id,
+                                 object,
+                                 live_mode,
+                                 created_at,
+                                 updated_at,
+                                 ledger_id,
+                                 description,
+                                 ledger_account_id,
+                                 ledger_account_lock_version,
+                                 ledger_account_normal_balance,
+                                 effective_at_lower_bound,
+                                 effective_at_upper_bound,
+                                 starting_balance,
+                                 ending_balance,
+                                 metadata)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    def to_custom_effective_at_lower_bound
+      DateTimeHelper.to_rfc3339(effective_at_lower_bound)
+    end
+
+    def to_custom_effective_at_upper_bound
+      DateTimeHelper.to_rfc3339(effective_at_upper_bound)
+    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}, ledger_id: #{@ledger_id}, description:"\
+      " #{@description}, ledger_account_id: #{@ledger_account_id}, ledger_account_lock_version:"\
+      " #{@ledger_account_lock_version}, ledger_account_normal_balance:"\
+      " #{@ledger_account_normal_balance}, effective_at_lower_bound: #{@effective_at_lower_bound},"\
+      " effective_at_upper_bound: #{@effective_at_upper_bound}, starting_balance:"\
+      " #{@starting_balance}, ending_balance: #{@ending_balance}, 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}, ledger_id: #{@ledger_id.inspect}, description:"\
+      " #{@description.inspect}, ledger_account_id: #{@ledger_account_id.inspect},"\
+      " ledger_account_lock_version: #{@ledger_account_lock_version.inspect},"\
+      " ledger_account_normal_balance: #{@ledger_account_normal_balance.inspect},"\
+      " effective_at_lower_bound: #{@effective_at_lower_bound.inspect}, effective_at_upper_bound:"\
+      " #{@effective_at_upper_bound.inspect}, starting_balance: #{@starting_balance.inspect},"\
+      " ending_balance: #{@ending_balance.inspect}, metadata: #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_statement_create_request.rb

@@ -0,0 +1,122 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LedgerAccountStatementCreateRequest Model.
+  class LedgerAccountStatementCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the ledger account statement.
+    # @return [String]
+    attr_accessor :description
+
+    # The id of the ledger account whose ledger entries are queried against, and
+    # its balances are computed as a result.
+    # @return [UUID | String]
+    attr_accessor :ledger_account_id
+
+    # The inclusive lower bound of the effective_at timestamp of the ledger
+    # entries to be included in the ledger account statement.
+    # @return [DateTime]
+    attr_accessor :effective_at_lower_bound
+
+    # The exclusive upper bound of the effective_at timestamp of the ledger
+    # entries to be included in the ledger account statement.
+    # @return [DateTime]
+    attr_accessor :effective_at_upper_bound
+
+    # 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['description'] = 'description'
+      @_hash['ledger_account_id'] = 'ledger_account_id'
+      @_hash['effective_at_lower_bound'] = 'effective_at_lower_bound'
+      @_hash['effective_at_upper_bound'] = 'effective_at_upper_bound'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(ledger_account_id = nil, effective_at_lower_bound = nil,
+                   effective_at_upper_bound = nil, description = SKIP,
+                   metadata = SKIP)
+      @description = description unless description == SKIP
+      @ledger_account_id = ledger_account_id
+      @effective_at_lower_bound = effective_at_lower_bound
+      @effective_at_upper_bound = effective_at_upper_bound
+      @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.
+      ledger_account_id =
+        hash.key?('ledger_account_id') ? hash['ledger_account_id'] : nil
+      effective_at_lower_bound = if hash.key?('effective_at_lower_bound')
+                                   (DateTimeHelper.from_rfc3339(hash['effective_at_lower_bound']) if hash['effective_at_lower_bound'])
+                                 end
+      effective_at_upper_bound = if hash.key?('effective_at_upper_bound')
+                                   (DateTimeHelper.from_rfc3339(hash['effective_at_upper_bound']) if hash['effective_at_upper_bound'])
+                                 end
+      description = hash.key?('description') ? hash['description'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      LedgerAccountStatementCreateRequest.new(ledger_account_id,
+                                              effective_at_lower_bound,
+                                              effective_at_upper_bound,
+                                              description,
+                                              metadata)
+    end
+
+    def to_custom_effective_at_lower_bound
+      DateTimeHelper.to_rfc3339(effective_at_lower_bound)
+    end
+
+    def to_custom_effective_at_upper_bound
+      DateTimeHelper.to_rfc3339(effective_at_upper_bound)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description}, ledger_account_id: #{@ledger_account_id},"\
+      " effective_at_lower_bound: #{@effective_at_lower_bound}, effective_at_upper_bound:"\
+      " #{@effective_at_upper_bound}, metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, ledger_account_id:"\
+      " #{@ledger_account_id.inspect}, effective_at_lower_bound:"\
+      " #{@effective_at_lower_bound.inspect}, effective_at_upper_bound:"\
+      " #{@effective_at_upper_bound.inspect}, metadata: #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_update_request.rb

@@ -0,0 +1,84 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerAccountUpdateRequest Model.
+  class LedgerAccountUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the ledger account.
+    # @return [String]
+    attr_accessor :name
+
+    # The description of the ledger account.
+    # @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.
+      LedgerAccountUpdateRequest.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/ledger_balance.rb

@@ -0,0 +1,97 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerBalance Model.
+  class LedgerBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :credits
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :debits
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The currency of the ledger account.
+    # @return [String]
+    attr_accessor :currency
+
+    # The currency exponent of the ledger account.
+    # @return [Integer]
+    attr_accessor :currency_exponent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credits'] = 'credits'
+      @_hash['debits'] = 'debits'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['currency_exponent'] = 'currency_exponent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(credits = nil, debits = nil, amount = nil, currency = nil,
+                   currency_exponent = nil)
+      @credits = credits
+      @debits = debits
+      @amount = amount
+      @currency = currency
+      @currency_exponent = currency_exponent
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      credits = hash.key?('credits') ? hash['credits'] : nil
+      debits = hash.key?('debits') ? hash['debits'] : 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
+
+      # Create object from extracted values.
+      LedgerBalance.new(credits,
+                        debits,
+                        amount,
+                        currency,
+                        currency_exponent)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} credits: #{@credits}, debits: #{@debits}, amount: #{@amount}, currency:"\
+      " #{@currency}, currency_exponent: #{@currency_exponent}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} credits: #{@credits.inspect}, debits: #{@debits.inspect}, amount:"\
+      " #{@amount.inspect}, currency: #{@currency.inspect}, currency_exponent:"\
+      " #{@currency_exponent.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_balances.rb

@@ -0,0 +1,81 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerBalances Model.
+  class LedgerBalances < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [LedgerBalance]
+    attr_accessor :pending_balance
+
+    # TODO: Write general description for this method
+    # @return [LedgerBalance]
+    attr_accessor :posted_balance
+
+    # TODO: Write general description for this method
+    # @return [LedgerBalance]
+    attr_accessor :available_balance
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pending_balance'] = 'pending_balance'
+      @_hash['posted_balance'] = 'posted_balance'
+      @_hash['available_balance'] = 'available_balance'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pending_balance = nil, posted_balance = nil,
+                   available_balance = nil)
+      @pending_balance = pending_balance
+      @posted_balance = posted_balance
+      @available_balance = available_balance
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      pending_balance = LedgerBalance.from_hash(hash['pending_balance']) if
+        hash['pending_balance']
+      posted_balance = LedgerBalance.from_hash(hash['posted_balance']) if hash['posted_balance']
+      available_balance = LedgerBalance.from_hash(hash['available_balance']) if
+        hash['available_balance']
+
+      # Create object from extracted values.
+      LedgerBalances.new(pending_balance,
+                         posted_balance,
+                         available_balance)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pending_balance: #{@pending_balance}, posted_balance: #{@posted_balance},"\
+      " available_balance: #{@available_balance}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pending_balance: #{@pending_balance.inspect}, posted_balance:"\
+      " #{@posted_balance.inspect}, available_balance: #{@available_balance.inspect}>"
+    end
+  end
+end