mt-sdk 0.0.1

data/lib/modern_treasury/models/ledger_balances_with_effective_at.rb

@@ -0,0 +1,123 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LedgerBalancesWithEffectiveAt Model.
+  class LedgerBalancesWithEffectiveAt < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The inclusive lower bound of the effective_at timestamp for the returned
+    # balances.
+    # @return [DateTime]
+    attr_accessor :effective_at_lower_bound
+
+    # The exclusive upper bound of the effective_at timestamp for the returned
+    # balances.
+    # @return [DateTime]
+    attr_accessor :effective_at_upper_bound
+
+    # The exclusive upper bound of the effective_at timestamp for the returned
+    # balances.
+    # @return [LedgerBalance]
+    attr_accessor :pending_balance
+
+    # The exclusive upper bound of the effective_at timestamp for the returned
+    # balances.
+    # @return [LedgerBalance]
+    attr_accessor :posted_balance
+
+    # The exclusive upper bound of the effective_at timestamp for the returned
+    # balances.
+    # @return [LedgerBalance]
+    attr_accessor :available_balance
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['effective_at_lower_bound'] = 'effective_at_lower_bound'
+      @_hash['effective_at_upper_bound'] = 'effective_at_upper_bound'
+      @_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
+      %w[
+        effective_at_lower_bound
+        effective_at_upper_bound
+      ]
+    end
+
+    def initialize(effective_at_lower_bound = nil,
+                   effective_at_upper_bound = nil, pending_balance = nil,
+                   posted_balance = nil, available_balance = nil)
+      @effective_at_lower_bound = effective_at_lower_bound
+      @effective_at_upper_bound = effective_at_upper_bound
+      @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.
+      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
+      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.
+      LedgerBalancesWithEffectiveAt.new(effective_at_lower_bound,
+                                        effective_at_upper_bound,
+                                        pending_balance,
+                                        posted_balance,
+                                        available_balance)
+    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} effective_at_lower_bound: #{@effective_at_lower_bound},"\
+      " effective_at_upper_bound: #{@effective_at_upper_bound}, 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} effective_at_lower_bound: #{@effective_at_lower_bound.inspect},"\
+      " effective_at_upper_bound: #{@effective_at_upper_bound.inspect}, pending_balance:"\
+      " #{@pending_balance.inspect}, posted_balance: #{@posted_balance.inspect},"\
+      " available_balance: #{@available_balance.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_create_request.rb

@@ -0,0 +1,83 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerCreateRequest Model.
+  class LedgerCreateRequest < 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[
+        description
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(name = nil, description = SKIP, metadata = SKIP)
+      @name = name
+      @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'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      LedgerCreateRequest.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_entry.rb

@@ -0,0 +1,247 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LedgerEntry Model.
+  class LedgerEntry < 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
+
+    # 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 :discarded_at
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000. Can be any integer up to 36 digits.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # One of `credit`, `debit`. Describes the direction money is flowing in the
+    # 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]
+    attr_accessor :direction
+
+    # Equal to the state of the ledger transaction when the ledger entry was
+    # created. One of `pending`, `posted`, or `archived`.
+    # @return [Status9Enum]
+    attr_accessor :status
+
+    # The ledger account that this ledger entry is associated with.
+    # @return [UUID | String]
+    attr_accessor :ledger_account_id
+
+    # Lock version of the ledger account. This can be passed when creating a
+    # ledger transaction to only succeed if no ledger transactions have posted
+    # since the given version. See our post about Designing the Ledgers API with
+    # Optimistic Locking for more details.
+    # @return [Integer]
+    attr_accessor :ledger_account_lock_version
+
+    # The currency of the ledger account.
+    # @return [String]
+    attr_accessor :ledger_account_currency
+
+    # The currency exponent of the ledger account.
+    # @return [Integer]
+    attr_accessor :ledger_account_currency_exponent
+
+    # The ledger transaction that this ledger entry is associated with.
+    # @return [String]
+    attr_accessor :ledger_transaction_id
+
+    # The ledger transaction that this ledger entry is associated with.
+    # @return [LedgerBalances]
+    attr_accessor :resulting_ledger_account_balances
+
+    # 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['discarded_at'] = 'discarded_at'
+      @_hash['amount'] = 'amount'
+      @_hash['direction'] = 'direction'
+      @_hash['status'] = 'status'
+      @_hash['ledger_account_id'] = 'ledger_account_id'
+      @_hash['ledger_account_lock_version'] = 'ledger_account_lock_version'
+      @_hash['ledger_account_currency'] = 'ledger_account_currency'
+      @_hash['ledger_account_currency_exponent'] =
+        'ledger_account_currency_exponent'
+      @_hash['ledger_transaction_id'] = 'ledger_transaction_id'
+      @_hash['resulting_ledger_account_balances'] =
+        'resulting_ledger_account_balances'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        discarded_at
+        ledger_account_lock_version
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, discarded_at = nil, amount = nil,
+                   direction = nil, status = nil, ledger_account_id = nil,
+                   ledger_account_lock_version = nil,
+                   ledger_account_currency = nil,
+                   ledger_account_currency_exponent = nil,
+                   ledger_transaction_id = nil,
+                   resulting_ledger_account_balances = nil, metadata = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @discarded_at = discarded_at
+      @amount = amount
+      @direction = direction
+      @status = status
+      @ledger_account_id = ledger_account_id
+      @ledger_account_lock_version = ledger_account_lock_version
+      @ledger_account_currency = ledger_account_currency
+      @ledger_account_currency_exponent = ledger_account_currency_exponent
+      @ledger_transaction_id = ledger_transaction_id
+      @resulting_ledger_account_balances = resulting_ledger_account_balances
+      @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
+      discarded_at = if hash.key?('discarded_at')
+                       (DateTimeHelper.from_rfc3339(hash['discarded_at']) if hash['discarded_at'])
+                     end
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      status = hash.key?('status') ? hash['status'] : 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_currency =
+        hash.key?('ledger_account_currency') ? hash['ledger_account_currency'] : nil
+      ledger_account_currency_exponent =
+        hash.key?('ledger_account_currency_exponent') ? hash['ledger_account_currency_exponent'] : nil
+      ledger_transaction_id =
+        hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : nil
+      if hash['resulting_ledger_account_balances']
+        resulting_ledger_account_balances = LedgerBalances.from_hash(hash['resulting_ledger_account_balances'])
+      end
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+
+      # Create object from extracted values.
+      LedgerEntry.new(id,
+                      object,
+                      live_mode,
+                      created_at,
+                      updated_at,
+                      discarded_at,
+                      amount,
+                      direction,
+                      status,
+                      ledger_account_id,
+                      ledger_account_lock_version,
+                      ledger_account_currency,
+                      ledger_account_currency_exponent,
+                      ledger_transaction_id,
+                      resulting_ledger_account_balances,
+                      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_discarded_at
+      DateTimeHelper.to_rfc3339(discarded_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}, discarded_at: #{@discarded_at}, amount:"\
+      " #{@amount}, direction: #{@direction}, status: #{@status}, ledger_account_id:"\
+      " #{@ledger_account_id}, ledger_account_lock_version: #{@ledger_account_lock_version},"\
+      " ledger_account_currency: #{@ledger_account_currency}, ledger_account_currency_exponent:"\
+      " #{@ledger_account_currency_exponent}, ledger_transaction_id: #{@ledger_transaction_id},"\
+      " resulting_ledger_account_balances: #{@resulting_ledger_account_balances}, 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}, discarded_at: #{@discarded_at.inspect}, amount:"\
+      " #{@amount.inspect}, direction: #{@direction.inspect}, status: #{@status.inspect},"\
+      " ledger_account_id: #{@ledger_account_id.inspect}, ledger_account_lock_version:"\
+      " #{@ledger_account_lock_version.inspect}, ledger_account_currency:"\
+      " #{@ledger_account_currency.inspect}, ledger_account_currency_exponent:"\
+      " #{@ledger_account_currency_exponent.inspect}, ledger_transaction_id:"\
+      " #{@ledger_transaction_id.inspect}, resulting_ledger_account_balances:"\
+      " #{@resulting_ledger_account_balances.inspect}, metadata: #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_entry_create_request.rb

@@ -0,0 +1,177 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerEntryCreateRequest Model.
+  class LedgerEntryCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000. Can be any integer up to 36 digits.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # One of `credit`, `debit`. Describes the direction money is flowing in the
+    # 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]
+    attr_accessor :direction
+
+    # The ledger account that this ledger entry is associated with.
+    # @return [UUID | String]
+    attr_accessor :ledger_account_id
+
+    # Lock version of the ledger account. This can be passed when creating a
+    # ledger transaction to only succeed if no ledger transactions have posted
+    # since the given version. See our post about Designing the Ledgers API with
+    # Optimistic Locking for more details.
+    # @return [Integer]
+    attr_accessor :lock_version
+
+    # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+    # account’s pending balance. If any of these conditions would be false after
+    # the transaction is created, the entire call will fail with error code 422.
+    # @return [Hash[String, Integer]]
+    attr_accessor :pending_balance_amount
+
+    # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+    # account’s posted balance. If any of these conditions would be false after
+    # the transaction is created, the entire call will fail with error code 422.
+    # @return [Hash[String, Integer]]
+    attr_accessor :posted_balance_amount
+
+    # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+    # account’s available balance. If any of these conditions would be false
+    # after the transaction is created, the entire call will fail with error
+    # code 422.
+    # @return [Hash[String, Integer]]
+    attr_accessor :available_balance_amount
+
+    # If true, response will include the balance of the associated ledger
+    # account for the entry.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_resulting_ledger_account_balances
+
+    # 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['amount'] = 'amount'
+      @_hash['direction'] = 'direction'
+      @_hash['ledger_account_id'] = 'ledger_account_id'
+      @_hash['lock_version'] = 'lock_version'
+      @_hash['pending_balance_amount'] = 'pending_balance_amount'
+      @_hash['posted_balance_amount'] = 'posted_balance_amount'
+      @_hash['available_balance_amount'] = 'available_balance_amount'
+      @_hash['show_resulting_ledger_account_balances'] =
+        'show_resulting_ledger_account_balances'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        lock_version
+        pending_balance_amount
+        posted_balance_amount
+        available_balance_amount
+        show_resulting_ledger_account_balances
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        lock_version
+        pending_balance_amount
+        posted_balance_amount
+        available_balance_amount
+        show_resulting_ledger_account_balances
+      ]
+    end
+
+    def initialize(amount = nil, direction = nil, ledger_account_id = nil,
+                   lock_version = SKIP, pending_balance_amount = SKIP,
+                   posted_balance_amount = SKIP,
+                   available_balance_amount = SKIP,
+                   show_resulting_ledger_account_balances = SKIP,
+                   metadata = SKIP)
+      @amount = amount
+      @direction = direction
+      @ledger_account_id = ledger_account_id
+      @lock_version = lock_version unless lock_version == SKIP
+      @pending_balance_amount = pending_balance_amount unless pending_balance_amount == SKIP
+      @posted_balance_amount = posted_balance_amount unless posted_balance_amount == SKIP
+      @available_balance_amount = available_balance_amount unless available_balance_amount == SKIP
+      unless show_resulting_ledger_account_balances == SKIP
+        @show_resulting_ledger_account_balances =
+          show_resulting_ledger_account_balances
+      end
+      @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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      ledger_account_id =
+        hash.key?('ledger_account_id') ? hash['ledger_account_id'] : nil
+      lock_version = hash.key?('lock_version') ? hash['lock_version'] : SKIP
+      pending_balance_amount =
+        hash.key?('pending_balance_amount') ? hash['pending_balance_amount'] : SKIP
+      posted_balance_amount =
+        hash.key?('posted_balance_amount') ? hash['posted_balance_amount'] : SKIP
+      available_balance_amount =
+        hash.key?('available_balance_amount') ? hash['available_balance_amount'] : SKIP
+      show_resulting_ledger_account_balances =
+        hash.key?('show_resulting_ledger_account_balances') ? hash['show_resulting_ledger_account_balances'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      LedgerEntryCreateRequest.new(amount,
+                                   direction,
+                                   ledger_account_id,
+                                   lock_version,
+                                   pending_balance_amount,
+                                   posted_balance_amount,
+                                   available_balance_amount,
+                                   show_resulting_ledger_account_balances,
+                                   metadata)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, direction: #{@direction}, ledger_account_id:"\
+      " #{@ledger_account_id}, lock_version: #{@lock_version}, pending_balance_amount:"\
+      " #{@pending_balance_amount}, posted_balance_amount: #{@posted_balance_amount},"\
+      " available_balance_amount: #{@available_balance_amount},"\
+      " show_resulting_ledger_account_balances: #{@show_resulting_ledger_account_balances},"\
+      " metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, direction: #{@direction.inspect},"\
+      " ledger_account_id: #{@ledger_account_id.inspect}, lock_version: #{@lock_version.inspect},"\
+      " pending_balance_amount: #{@pending_balance_amount.inspect}, posted_balance_amount:"\
+      " #{@posted_balance_amount.inspect}, available_balance_amount:"\
+      " #{@available_balance_amount.inspect}, show_resulting_ledger_account_balances:"\
+      " #{@show_resulting_ledger_account_balances.inspect}, metadata: #{@metadata.inspect}>"
+    end
+  end
+end