mt-sdk 0.0.1

data/lib/modern_treasury/models/ledgerable_event_create_request.rb

@@ -0,0 +1,140 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LedgerableEventCreateRequest Model.
+  class LedgerableEventCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # 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['direction'] = 'direction'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['currency_exponent'] = 'currency_exponent'
+      @_hash['custom_data'] = 'custom_data'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        direction
+        currency
+        currency_exponent
+        custom_data
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        direction
+        currency
+        currency_exponent
+        custom_data
+      ]
+    end
+
+    def initialize(name = nil, amount = nil, description = SKIP,
+                   direction = SKIP, currency = SKIP, currency_exponent = SKIP,
+                   custom_data = SKIP, metadata = SKIP)
+      @name = name
+      @description = description unless description == SKIP
+      @direction = direction unless direction == SKIP
+      @amount = amount
+      @currency = currency unless currency == SKIP
+      @currency_exponent = currency_exponent unless currency_exponent == SKIP
+      @custom_data = custom_data unless custom_data == 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
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      currency_exponent =
+        hash.key?('currency_exponent') ? hash['currency_exponent'] : SKIP
+      custom_data = hash.key?('custom_data') ? hash['custom_data'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      LedgerableEventCreateRequest.new(name,
+                                       amount,
+                                       description,
+                                       direction,
+                                       currency,
+                                       currency_exponent,
+                                       custom_data,
+                                       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}, direction: #{@direction},"\
+      " amount: #{@amount}, currency: #{@currency}, currency_exponent: #{@currency_exponent},"\
+      " custom_data: #{@custom_data}, 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}, direction:"\
+      " #{@direction.inspect}, amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " currency_exponent: #{@currency_exponent.inspect}, custom_data: #{@custom_data.inspect},"\
+      " metadata: #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/ledgerable_type2_enum.rb

@@ -0,0 +1,71 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # 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.
+  class LedgerableType2Enum
+    LEDGERABLE_TYPE2_ENUM = [
+      # TODO: Write general description for COUNTERPARTY
+      COUNTERPARTY = 'counterparty'.freeze,
+
+      # TODO: Write general description for EXPECTED_PAYMENT
+      EXPECTED_PAYMENT = 'expected_payment'.freeze,
+
+      # TODO: Write general description for INCOMING_PAYMENT_DETAIL
+      INCOMING_PAYMENT_DETAIL = 'incoming_payment_detail'.freeze,
+
+      # TODO: Write general description for INTERNAL_ACCOUNT
+      INTERNAL_ACCOUNT = 'internal_account'.freeze,
+
+      # TODO: Write general description for LINE_ITEM
+      LINE_ITEM = 'line_item'.freeze,
+
+      # TODO: Write general description for PAPER_ITEM
+      PAPER_ITEM = 'paper_item'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER
+      PAYMENT_ORDER = 'payment_order'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER_ATTEMPT
+      PAYMENT_ORDER_ATTEMPT = 'payment_order_attempt'.freeze,
+
+      # TODO: Write general description for ENUM_RETURN
+      ENUM_RETURN = 'return'.freeze,
+
+      # TODO: Write general description for REVERSAL
+      REVERSAL = 'reversal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LEDGERABLE_TYPE2_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = COUNTERPARTY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'counterparty' then COUNTERPARTY
+      when 'expected_payment' then EXPECTED_PAYMENT
+      when 'incoming_payment_detail' then INCOMING_PAYMENT_DETAIL
+      when 'internal_account' then INTERNAL_ACCOUNT
+      when 'line_item' then LINE_ITEM
+      when 'paper_item' then PAPER_ITEM
+      when 'payment_order' then PAYMENT_ORDER
+      when 'payment_order_attempt' then PAYMENT_ORDER_ATTEMPT
+      when 'enum_return' then ENUM_RETURN
+      when 'reversal' then REVERSAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledgerable_type5_enum.rb

@@ -0,0 +1,69 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # Specify this if you'd like to link the reversal ledger transaction to a
+  # Payment object like Return or Reversal.
+  class LedgerableType5Enum
+    LEDGERABLE_TYPE5_ENUM = [
+      # TODO: Write general description for COUNTERPARTY
+      COUNTERPARTY = 'counterparty'.freeze,
+
+      # TODO: Write general description for EXPECTED_PAYMENT
+      EXPECTED_PAYMENT = 'expected_payment'.freeze,
+
+      # TODO: Write general description for INCOMING_PAYMENT_DETAIL
+      INCOMING_PAYMENT_DETAIL = 'incoming_payment_detail'.freeze,
+
+      # TODO: Write general description for INTERNAL_ACCOUNT
+      INTERNAL_ACCOUNT = 'internal_account'.freeze,
+
+      # TODO: Write general description for LINE_ITEM
+      LINE_ITEM = 'line_item'.freeze,
+
+      # TODO: Write general description for PAPER_ITEM
+      PAPER_ITEM = 'paper_item'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER
+      PAYMENT_ORDER = 'payment_order'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER_ATTEMPT
+      PAYMENT_ORDER_ATTEMPT = 'payment_order_attempt'.freeze,
+
+      # TODO: Write general description for ENUM_RETURN
+      ENUM_RETURN = 'return'.freeze,
+
+      # TODO: Write general description for REVERSAL
+      REVERSAL = 'reversal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LEDGERABLE_TYPE5_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = COUNTERPARTY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'counterparty' then COUNTERPARTY
+      when 'expected_payment' then EXPECTED_PAYMENT
+      when 'incoming_payment_detail' then INCOMING_PAYMENT_DETAIL
+      when 'internal_account' then INTERNAL_ACCOUNT
+      when 'line_item' then LINE_ITEM
+      when 'paper_item' then PAPER_ITEM
+      when 'payment_order' then PAYMENT_ORDER
+      when 'payment_order_attempt' then PAYMENT_ORDER_ATTEMPT
+      when 'enum_return' then ENUM_RETURN
+      when 'reversal' then REVERSAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledgerable_type6_enum.rb

@@ -0,0 +1,68 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ledgerable_type6.
+  class LedgerableType6Enum
+    LEDGERABLE_TYPE6_ENUM = [
+      # TODO: Write general description for COUNTERPARTY
+      COUNTERPARTY = 'counterparty'.freeze,
+
+      # TODO: Write general description for EXPECTED_PAYMENT
+      EXPECTED_PAYMENT = 'expected_payment'.freeze,
+
+      # TODO: Write general description for INCOMING_PAYMENT_DETAIL
+      INCOMING_PAYMENT_DETAIL = 'incoming_payment_detail'.freeze,
+
+      # TODO: Write general description for INTERNAL_ACCOUNT
+      INTERNAL_ACCOUNT = 'internal_account'.freeze,
+
+      # TODO: Write general description for LINE_ITEM
+      LINE_ITEM = 'line_item'.freeze,
+
+      # TODO: Write general description for PAPER_ITEM
+      PAPER_ITEM = 'paper_item'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER
+      PAYMENT_ORDER = 'payment_order'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER_ATTEMPT
+      PAYMENT_ORDER_ATTEMPT = 'payment_order_attempt'.freeze,
+
+      # TODO: Write general description for ENUM_RETURN
+      ENUM_RETURN = 'return'.freeze,
+
+      # TODO: Write general description for REVERSAL
+      REVERSAL = 'reversal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LEDGERABLE_TYPE6_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = COUNTERPARTY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'counterparty' then COUNTERPARTY
+      when 'expected_payment' then EXPECTED_PAYMENT
+      when 'incoming_payment_detail' then INCOMING_PAYMENT_DETAIL
+      when 'internal_account' then INTERNAL_ACCOUNT
+      when 'line_item' then LINE_ITEM
+      when 'paper_item' then PAPER_ITEM
+      when 'payment_order' then PAYMENT_ORDER
+      when 'payment_order_attempt' then PAYMENT_ORDER_ATTEMPT
+      when 'enum_return' then ENUM_RETURN
+      when 'reversal' then REVERSAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/ledgerable_type_enum.rb

@@ -0,0 +1,38 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # 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.
+  class LedgerableTypeEnum
+    LEDGERABLE_TYPE_ENUM = [
+      # TODO: Write general description for EXTERNAL_ACCOUNT
+      EXTERNAL_ACCOUNT = 'external_account'.freeze,
+
+      # TODO: Write general description for INTERNAL_ACCOUNT
+      INTERNAL_ACCOUNT = 'internal_account'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LEDGERABLE_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXTERNAL_ACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'external_account' then EXTERNAL_ACCOUNT
+      when 'internal_account' then INTERNAL_ACCOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/legacy_document_create_request.rb

@@ -0,0 +1,70 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LegacyDocumentCreateRequest Model.
+  class LegacyDocumentCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A category given to the document, can be `null`.
+    # @return [String]
+    attr_accessor :document_type
+
+    # A category given to the document, can be `null`.
+    # @return [Binary]
+    attr_accessor :file
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['document_type'] = 'document_type'
+      @_hash['file'] = 'file'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        document_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(file = nil, document_type = SKIP)
+      @document_type = document_type unless document_type == SKIP
+      @file = file
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      file = hash.key?('file') ? hash['file'] : nil
+      document_type = hash.key?('document_type') ? hash['document_type'] : SKIP
+
+      # Create object from extracted values.
+      LegacyDocumentCreateRequest.new(file,
+                                      document_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} document_type: #{@document_type}, file: #{@file}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} document_type: #{@document_type.inspect}, file: #{@file.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/line_item.rb

@@ -0,0 +1,200 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # LineItem Model.
+  class LineItem < 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 payment order or expected payment.
+    # @return [UUID | String]
+    attr_accessor :itemizable_id
+
+    # One of `payment_orders` or `expected_payments`.
+    # @return [ItemizableTypeEnum]
+    attr_accessor :itemizable_type
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # A free-form description of the line item.
+    # @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
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Accounting]
+    attr_accessor :accounting
+
+    # The ID of one of your accounting categories. Note that these will only be
+    # accessible if your accounting system has been connected.
+    # @return [UUID | String]
+    attr_accessor :accounting_category_id
+
+    # The ID of one of the class objects in your accounting system. Class
+    # objects track segments of your business independent of client or project.
+    # Note that these will only be accessible if your accounting system has been
+    # connected.
+    # @return [UUID | String]
+    attr_accessor :accounting_ledger_class_id
+
+    # 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['itemizable_id'] = 'itemizable_id'
+      @_hash['itemizable_type'] = 'itemizable_type'
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['metadata'] = 'metadata'
+      @_hash['accounting'] = 'accounting'
+      @_hash['accounting_category_id'] = 'accounting_category_id'
+      @_hash['accounting_ledger_class_id'] = 'accounting_ledger_class_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        accounting_category_id
+        accounting_ledger_class_id
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, itemizable_id = nil, itemizable_type = nil,
+                   amount = nil, description = nil, metadata = nil,
+                   accounting = nil, accounting_category_id = nil,
+                   accounting_ledger_class_id = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @itemizable_id = itemizable_id
+      @itemizable_type = itemizable_type
+      @amount = amount
+      @description = description
+      @metadata = metadata
+      @accounting = accounting
+      @accounting_category_id = accounting_category_id
+      @accounting_ledger_class_id = accounting_ledger_class_id
+    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
+      itemizable_id = hash.key?('itemizable_id') ? hash['itemizable_id'] : nil
+      itemizable_type =
+        hash.key?('itemizable_type') ? hash['itemizable_type'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      accounting = Accounting.from_hash(hash['accounting']) if hash['accounting']
+      accounting_category_id =
+        hash.key?('accounting_category_id') ? hash['accounting_category_id'] : nil
+      accounting_ledger_class_id =
+        hash.key?('accounting_ledger_class_id') ? hash['accounting_ledger_class_id'] : nil
+
+      # Create object from extracted values.
+      LineItem.new(id,
+                   object,
+                   live_mode,
+                   created_at,
+                   updated_at,
+                   itemizable_id,
+                   itemizable_type,
+                   amount,
+                   description,
+                   metadata,
+                   accounting,
+                   accounting_category_id,
+                   accounting_ledger_class_id)
+    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}, itemizable_id: #{@itemizable_id},"\
+      " itemizable_type: #{@itemizable_type}, amount: #{@amount}, description: #{@description},"\
+      " metadata: #{@metadata}, accounting: #{@accounting}, accounting_category_id:"\
+      " #{@accounting_category_id}, accounting_ledger_class_id: #{@accounting_ledger_class_id}>"
+    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}, itemizable_id: #{@itemizable_id.inspect}, itemizable_type:"\
+      " #{@itemizable_type.inspect}, amount: #{@amount.inspect}, description:"\
+      " #{@description.inspect}, metadata: #{@metadata.inspect}, accounting:"\
+      " #{@accounting.inspect}, accounting_category_id: #{@accounting_category_id.inspect},"\
+      " accounting_ledger_class_id: #{@accounting_ledger_class_id.inspect}>"
+    end
+  end
+end