mt-sdk 0.0.1

data/lib/modern_treasury/models/ledger_account_create_request.rb

@@ -0,0 +1,150 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerAccountCreateRequest Model.
+  class LedgerAccountCreateRequest < 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
+
+    # The normal balance of the ledger account.
+    # @return [NormalBalanceEnum]
+    attr_accessor :normal_balance
+
+    # The id of the ledger that this account belongs to.
+    # @return [UUID | String]
+    attr_accessor :ledger_id
+
+    # The currency of the ledger account.
+    # @return [String]
+    attr_accessor :currency
+
+    # The currency exponent of the ledger account.
+    # @return [Integer]
+    attr_accessor :currency_exponent
+
+    # If the ledger account links to another object in Modern Treasury, the id
+    # will be populated here, otherwise null.
+    # @return [UUID | String]
+    attr_accessor :ledgerable_id
+
+    # If the ledger account links to another object in Modern Treasury, the type
+    # will be populated here, otherwise null. The value is one of
+    # internal_account or external_account.
+    # @return [LedgerableTypeEnum]
+    attr_accessor :ledgerable_type
+
+    # 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['normal_balance'] = 'normal_balance'
+      @_hash['ledger_id'] = 'ledger_id'
+      @_hash['currency'] = 'currency'
+      @_hash['currency_exponent'] = 'currency_exponent'
+      @_hash['ledgerable_id'] = 'ledgerable_id'
+      @_hash['ledgerable_type'] = 'ledgerable_type'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        currency_exponent
+        ledgerable_id
+        ledgerable_type
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        currency_exponent
+      ]
+    end
+
+    def initialize(name = nil, normal_balance = nil, ledger_id = nil,
+                   currency = nil, description = SKIP, currency_exponent = SKIP,
+                   ledgerable_id = SKIP, ledgerable_type = SKIP,
+                   metadata = SKIP)
+      @name = name
+      @description = description unless description == SKIP
+      @normal_balance = normal_balance
+      @ledger_id = ledger_id
+      @currency = currency
+      @currency_exponent = currency_exponent unless currency_exponent == SKIP
+      @ledgerable_id = ledgerable_id unless ledgerable_id == SKIP
+      @ledgerable_type = ledgerable_type unless ledgerable_type == 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
+      normal_balance =
+        hash.key?('normal_balance') ? hash['normal_balance'] : nil
+      ledger_id = hash.key?('ledger_id') ? hash['ledger_id'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      currency_exponent =
+        hash.key?('currency_exponent') ? hash['currency_exponent'] : SKIP
+      ledgerable_id = hash.key?('ledgerable_id') ? hash['ledgerable_id'] : SKIP
+      ledgerable_type =
+        hash.key?('ledgerable_type') ? hash['ledgerable_type'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      LedgerAccountCreateRequest.new(name,
+                                     normal_balance,
+                                     ledger_id,
+                                     currency,
+                                     description,
+                                     currency_exponent,
+                                     ledgerable_id,
+                                     ledgerable_type,
+                                     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}, normal_balance:"\
+      " #{@normal_balance}, ledger_id: #{@ledger_id}, currency: #{@currency}, currency_exponent:"\
+      " #{@currency_exponent}, ledgerable_id: #{@ledgerable_id}, ledgerable_type:"\
+      " #{@ledgerable_type}, 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},"\
+      " normal_balance: #{@normal_balance.inspect}, ledger_id: #{@ledger_id.inspect}, currency:"\
+      " #{@currency.inspect}, currency_exponent: #{@currency_exponent.inspect}, ledgerable_id:"\
+      " #{@ledgerable_id.inspect}, ledgerable_type: #{@ledgerable_type.inspect}, metadata:"\
+      " #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_normal_balance_enum.rb

@@ -0,0 +1,36 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # The normal balance of the ledger account.
+  class LedgerAccountNormalBalanceEnum
+    LEDGER_ACCOUNT_NORMAL_BALANCE_ENUM = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'debit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LEDGER_ACCOUNT_NORMAL_BALANCE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_payout.rb

@@ -0,0 +1,238 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LedgerAccountPayout Model.
+  class LedgerAccountPayout < 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 payout belongs to.
+    # @return [UUID | String]
+    attr_accessor :ledger_id
+
+    # The description of the ledger account payout.
+    # @return [String]
+    attr_accessor :description
+
+    # The status of the ledger account payout. One of `processing`, `pending`,
+    # `posted`, `archiving` or `archived`.
+    # @return [Status6Enum]
+    attr_accessor :status
+
+    # The id of the payout ledger account whose ledger entries are queried
+    # against, and its balance is reduced as a result.
+    # @return [UUID | String]
+    attr_accessor :payout_ledger_account_id
+
+    # The id of the funding ledger account that sends to or receives funds from
+    # the payout ledger account.
+    # @return [UUID | String]
+    attr_accessor :funding_ledger_account_id
+
+    # The exclusive upper bound of the effective_at timestamp of the ledger
+    # entries to be included in the ledger account payout. The default value is
+    # the created_at timestamp of the ledger account payout.
+    # @return [DateTime]
+    attr_accessor :effective_at_upper_bound
+
+    # The id of the ledger transaction that this payout is associated with.
+    # @return [UUID | String]
+    attr_accessor :ledger_transaction_id
+
+    # The amount of the ledger account payout.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The currency of the ledger account payout.
+    # @return [String]
+    attr_accessor :currency
+
+    # The currency exponent of the ledger account payout.
+    # @return [Integer]
+    attr_accessor :currency_exponent
+
+    # 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['status'] = 'status'
+      @_hash['payout_ledger_account_id'] = 'payout_ledger_account_id'
+      @_hash['funding_ledger_account_id'] = 'funding_ledger_account_id'
+      @_hash['effective_at_upper_bound'] = 'effective_at_upper_bound'
+      @_hash['ledger_transaction_id'] = 'ledger_transaction_id'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['currency_exponent'] = 'currency_exponent'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        ledger_transaction_id
+        amount
+        currency_exponent
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, ledger_id = nil, description = nil,
+                   status = nil, payout_ledger_account_id = nil,
+                   funding_ledger_account_id = nil,
+                   effective_at_upper_bound = nil, ledger_transaction_id = nil,
+                   amount = nil, currency = nil, currency_exponent = 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
+      @status = status
+      @payout_ledger_account_id = payout_ledger_account_id
+      @funding_ledger_account_id = funding_ledger_account_id
+      @effective_at_upper_bound = effective_at_upper_bound
+      @ledger_transaction_id = ledger_transaction_id
+      @amount = amount
+      @currency = currency
+      @currency_exponent = currency_exponent
+      @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
+      status = hash.key?('status') ? hash['status'] : nil
+      payout_ledger_account_id =
+        hash.key?('payout_ledger_account_id') ? hash['payout_ledger_account_id'] : nil
+      funding_ledger_account_id =
+        hash.key?('funding_ledger_account_id') ? hash['funding_ledger_account_id'] : nil
+      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
+      ledger_transaction_id =
+        hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : 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
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+
+      # Create object from extracted values.
+      LedgerAccountPayout.new(id,
+                              object,
+                              live_mode,
+                              created_at,
+                              updated_at,
+                              ledger_id,
+                              description,
+                              status,
+                              payout_ledger_account_id,
+                              funding_ledger_account_id,
+                              effective_at_upper_bound,
+                              ledger_transaction_id,
+                              amount,
+                              currency,
+                              currency_exponent,
+                              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_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}, status: #{@status}, payout_ledger_account_id:"\
+      " #{@payout_ledger_account_id}, funding_ledger_account_id: #{@funding_ledger_account_id},"\
+      " effective_at_upper_bound: #{@effective_at_upper_bound}, ledger_transaction_id:"\
+      " #{@ledger_transaction_id}, amount: #{@amount}, currency: #{@currency}, currency_exponent:"\
+      " #{@currency_exponent}, 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}, status: #{@status.inspect}, payout_ledger_account_id:"\
+      " #{@payout_ledger_account_id.inspect}, funding_ledger_account_id:"\
+      " #{@funding_ledger_account_id.inspect}, effective_at_upper_bound:"\
+      " #{@effective_at_upper_bound.inspect}, ledger_transaction_id:"\
+      " #{@ledger_transaction_id.inspect}, amount: #{@amount.inspect}, currency:"\
+      " #{@currency.inspect}, currency_exponent: #{@currency_exponent.inspect}, metadata:"\
+      " #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_payout_create_request.rb

@@ -0,0 +1,152 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LedgerAccountPayoutCreateRequest Model.
+  class LedgerAccountPayoutCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the ledger account payout.
+    # @return [String]
+    attr_accessor :description
+
+    # The status of the ledger account payout. It is set to `pending` by
+    # default. To post a ledger account payout at creation, use `posted`.
+    # @return [Status7Enum]
+    attr_accessor :status
+
+    # The id of the payout ledger account whose ledger entries are queried
+    # against, and its balance is reduced as a result.
+    # @return [UUID | String]
+    attr_accessor :payout_ledger_account_id
+
+    # The id of the funding ledger account that sends to or receives funds from
+    # the payout ledger account.
+    # @return [UUID | String]
+    attr_accessor :funding_ledger_account_id
+
+    # The exclusive upper bound of the effective_at timestamp of the ledger
+    # entries to be included in the ledger account payout. The default value is
+    # the created_at timestamp of the ledger account payout.
+    # @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
+
+    # It is set to `false` by default. It should be set to `true` when migrating
+    # existing payouts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_payout_ledger_transaction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['status'] = 'status'
+      @_hash['payout_ledger_account_id'] = 'payout_ledger_account_id'
+      @_hash['funding_ledger_account_id'] = 'funding_ledger_account_id'
+      @_hash['effective_at_upper_bound'] = 'effective_at_upper_bound'
+      @_hash['metadata'] = 'metadata'
+      @_hash['skip_payout_ledger_transaction'] =
+        'skip_payout_ledger_transaction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        status
+        effective_at_upper_bound
+        metadata
+        skip_payout_ledger_transaction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        status
+        effective_at_upper_bound
+        skip_payout_ledger_transaction
+      ]
+    end
+
+    def initialize(payout_ledger_account_id = nil,
+                   funding_ledger_account_id = nil, description = SKIP,
+                   status = SKIP, effective_at_upper_bound = SKIP,
+                   metadata = SKIP, skip_payout_ledger_transaction = SKIP)
+      @description = description unless description == SKIP
+      @status = status unless status == SKIP
+      @payout_ledger_account_id = payout_ledger_account_id
+      @funding_ledger_account_id = funding_ledger_account_id
+      @effective_at_upper_bound = effective_at_upper_bound unless effective_at_upper_bound == SKIP
+      @metadata = metadata unless metadata == SKIP
+      unless skip_payout_ledger_transaction == SKIP
+        @skip_payout_ledger_transaction =
+          skip_payout_ledger_transaction
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payout_ledger_account_id =
+        hash.key?('payout_ledger_account_id') ? hash['payout_ledger_account_id'] : nil
+      funding_ledger_account_id =
+        hash.key?('funding_ledger_account_id') ? hash['funding_ledger_account_id'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      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'])
+                                 else
+                                   SKIP
+                                 end
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      skip_payout_ledger_transaction =
+        hash.key?('skip_payout_ledger_transaction') ? hash['skip_payout_ledger_transaction'] : SKIP
+
+      # Create object from extracted values.
+      LedgerAccountPayoutCreateRequest.new(payout_ledger_account_id,
+                                           funding_ledger_account_id,
+                                           description,
+                                           status,
+                                           effective_at_upper_bound,
+                                           metadata,
+                                           skip_payout_ledger_transaction)
+    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}, status: #{@status}, payout_ledger_account_id:"\
+      " #{@payout_ledger_account_id}, funding_ledger_account_id: #{@funding_ledger_account_id},"\
+      " effective_at_upper_bound: #{@effective_at_upper_bound}, metadata: #{@metadata},"\
+      " skip_payout_ledger_transaction: #{@skip_payout_ledger_transaction}>"
+    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},"\
+      " payout_ledger_account_id: #{@payout_ledger_account_id.inspect}, funding_ledger_account_id:"\
+      " #{@funding_ledger_account_id.inspect}, effective_at_upper_bound:"\
+      " #{@effective_at_upper_bound.inspect}, metadata: #{@metadata.inspect},"\
+      " skip_payout_ledger_transaction: #{@skip_payout_ledger_transaction.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_account_payout_update_request.rb

@@ -0,0 +1,85 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerAccountPayoutUpdateRequest Model.
+  class LedgerAccountPayoutUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the ledger account payout.
+    # @return [String]
+    attr_accessor :description
+
+    # To post a pending ledger account payout, use `posted`. To archive a
+    # pending ledger transaction, use `archived`.
+    # @return [Status8Enum]
+    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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        status
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(description = SKIP, status = SKIP, metadata = SKIP)
+      @description = description unless description == SKIP
+      @status = status unless status == 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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      LedgerAccountPayoutUpdateRequest.new(description,
+                                           status,
+                                           metadata)
+    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}>"
+    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}>"
+    end
+  end
+end