mt-sdk 0.0.1

data/lib/modern_treasury/models/counterparty_create_request.rb

@@ -0,0 +1,161 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # CounterpartyCreateRequest Model.
+  class CounterpartyCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A human friendly name for this counterparty.
+    # @return [String]
+    attr_accessor :name
+
+    # The accounts for this counterparty.
+    # @return [Array[Account1]]
+    attr_accessor :accounts
+
+    # The counterparty's email.
+    # @return [String]
+    attr_accessor :email
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # Send an email to the counterparty whenever an associated payment order is
+    # sent to the bank.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_remittance_advice
+
+    # The verification status of the counterparty.
+    # @return [VerificationStatus1Enum]
+    attr_accessor :verification_status
+
+    # The verification status of the counterparty.
+    # @return [Accounting1]
+    attr_accessor :accounting
+
+    # An optional type to auto-sync the counterparty to your ledger. Either
+    # `customer` or `vendor`.
+    # @return [LedgerTypeEnum]
+    attr_accessor :ledger_type
+
+    # Either a valid SSN or EIN.
+    # @return [String]
+    attr_accessor :taxpayer_identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['accounts'] = 'accounts'
+      @_hash['email'] = 'email'
+      @_hash['metadata'] = 'metadata'
+      @_hash['send_remittance_advice'] = 'send_remittance_advice'
+      @_hash['verification_status'] = 'verification_status'
+      @_hash['accounting'] = 'accounting'
+      @_hash['ledger_type'] = 'ledger_type'
+      @_hash['taxpayer_identifier'] = 'taxpayer_identifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accounts
+        email
+        metadata
+        send_remittance_advice
+        verification_status
+        accounting
+        ledger_type
+        taxpayer_identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        name
+        email
+      ]
+    end
+
+    def initialize(name = nil, accounts = SKIP, email = SKIP, metadata = SKIP,
+                   send_remittance_advice = SKIP, verification_status = SKIP,
+                   accounting = SKIP, ledger_type = SKIP,
+                   taxpayer_identifier = SKIP)
+      @name = name
+      @accounts = accounts unless accounts == SKIP
+      @email = email unless email == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @send_remittance_advice = send_remittance_advice unless send_remittance_advice == SKIP
+      @verification_status = verification_status unless verification_status == SKIP
+      @accounting = accounting unless accounting == SKIP
+      @ledger_type = ledger_type unless ledger_type == SKIP
+      @taxpayer_identifier = taxpayer_identifier unless taxpayer_identifier == 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
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (Account1.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+      email = hash.key?('email') ? hash['email'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      send_remittance_advice =
+        hash.key?('send_remittance_advice') ? hash['send_remittance_advice'] : SKIP
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : SKIP
+      accounting = Accounting1.from_hash(hash['accounting']) if hash['accounting']
+      ledger_type = hash.key?('ledger_type') ? hash['ledger_type'] : SKIP
+      taxpayer_identifier =
+        hash.key?('taxpayer_identifier') ? hash['taxpayer_identifier'] : SKIP
+
+      # Create object from extracted values.
+      CounterpartyCreateRequest.new(name,
+                                    accounts,
+                                    email,
+                                    metadata,
+                                    send_remittance_advice,
+                                    verification_status,
+                                    accounting,
+                                    ledger_type,
+                                    taxpayer_identifier)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, accounts: #{@accounts}, email: #{@email}, metadata:"\
+      " #{@metadata}, send_remittance_advice: #{@send_remittance_advice}, verification_status:"\
+      " #{@verification_status}, accounting: #{@accounting}, ledger_type: #{@ledger_type},"\
+      " taxpayer_identifier: #{@taxpayer_identifier}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, accounts: #{@accounts.inspect}, email:"\
+      " #{@email.inspect}, metadata: #{@metadata.inspect}, send_remittance_advice:"\
+      " #{@send_remittance_advice.inspect}, verification_status: #{@verification_status.inspect},"\
+      " accounting: #{@accounting.inspect}, ledger_type: #{@ledger_type.inspect},"\
+      " taxpayer_identifier: #{@taxpayer_identifier.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/counterparty_shipping_address.rb

@@ -0,0 +1,107 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # The counterparty's shipping address where physical goods should be
+  # delivered.
+  class CounterpartyShippingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :line1
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :line2
+
+    # Locality or City.
+    # @return [String]
+    attr_accessor :locality
+
+    # Region or State.
+    # @return [String]
+    attr_accessor :region
+
+    # The postal code of the address.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country code conforms to [ISO 3166-1 alpha-2]
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['locality'] = 'locality'
+      @_hash['region'] = 'region'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1 = nil, locality = nil, region = nil, postal_code = nil,
+                   country = nil, line2 = SKIP)
+      @line1 = line1
+      @line2 = line2 unless line2 == SKIP
+      @locality = locality
+      @region = region
+      @postal_code = postal_code
+      @country = country
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      line1 = hash.key?('line1') ? hash['line1'] : nil
+      locality = hash.key?('locality') ? hash['locality'] : nil
+      region = hash.key?('region') ? hash['region'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+
+      # Create object from extracted values.
+      CounterpartyShippingAddress.new(line1,
+                                      locality,
+                                      region,
+                                      postal_code,
+                                      country,
+                                      line2)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1}, line2: #{@line2}, locality: #{@locality}, region:"\
+      " #{@region}, postal_code: #{@postal_code}, country: #{@country}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1.inspect}, line2: #{@line2.inspect}, locality:"\
+      " #{@locality.inspect}, region: #{@region.inspect}, postal_code: #{@postal_code.inspect},"\
+      " country: #{@country.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/counterparty_update_request.rb

@@ -0,0 +1,107 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # CounterpartyUpdateRequest Model.
+  class CounterpartyUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A new name for the counterparty. Will only update if passed.
+    # @return [String]
+    attr_accessor :name
+
+    # A new email for the counterparty.
+    # @return [String]
+    attr_accessor :email
+
+    # Additional data in the form of key-value pairs. Pairs can be removed by
+    # passing an empty string or `null` as the value.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # If this is `true`, Modern Treasury will send an email to the counterparty
+    # whenever an associated payment order is sent to the bank.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_remittance_advice
+
+    # Either a valid SSN or EIN.
+    # @return [String]
+    attr_accessor :taxpayer_identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash['metadata'] = 'metadata'
+      @_hash['send_remittance_advice'] = 'send_remittance_advice'
+      @_hash['taxpayer_identifier'] = 'taxpayer_identifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        email
+        metadata
+        send_remittance_advice
+        taxpayer_identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, email = SKIP, metadata = SKIP,
+                   send_remittance_advice = SKIP, taxpayer_identifier = SKIP)
+      @name = name unless name == SKIP
+      @email = email unless email == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @send_remittance_advice = send_remittance_advice unless send_remittance_advice == SKIP
+      @taxpayer_identifier = taxpayer_identifier unless taxpayer_identifier == 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
+      email = hash.key?('email') ? hash['email'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      send_remittance_advice =
+        hash.key?('send_remittance_advice') ? hash['send_remittance_advice'] : SKIP
+      taxpayer_identifier =
+        hash.key?('taxpayer_identifier') ? hash['taxpayer_identifier'] : SKIP
+
+      # Create object from extracted values.
+      CounterpartyUpdateRequest.new(name,
+                                    email,
+                                    metadata,
+                                    send_remittance_advice,
+                                    taxpayer_identifier)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, email: #{@email}, metadata: #{@metadata},"\
+      " send_remittance_advice: #{@send_remittance_advice}, taxpayer_identifier:"\
+      " #{@taxpayer_identifier}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, email: #{@email.inspect}, metadata:"\
+      " #{@metadata.inspect}, send_remittance_advice: #{@send_remittance_advice.inspect},"\
+      " taxpayer_identifier: #{@taxpayer_identifier.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/created_at_enum.rb

@@ -0,0 +1,36 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # CreatedAt.
+  class CreatedAtEnum
+    CREATED_AT_ENUM = [
+      # TODO: Write general description for ASC
+      ASC = 'asc'.freeze,
+
+      # TODO: Write general description for DESC
+      DESC = 'desc'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREATED_AT_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asc' then ASC
+      when 'desc' then DESC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/currency1_enum.rb

@@ -0,0 +1,37 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # Either "USD" or "CAD". Internal accounts created at Increase only supports
+  # "USD".
+  class Currency1Enum
+    CURRENCY1_ENUM = [
+      # TODO: Write general description for USD
+      USD = 'USD'.freeze,
+
+      # TODO: Write general description for CAD
+      CAD = 'CAD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CURRENCY1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = USD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'usd' then USD
+      when 'cad' then CAD
+      else
+        default_value
+      end
+    end
+  end
+end