fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/currency_entity2.rb

@@ -0,0 +1,108 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Currency if different from that of account
+  class CurrencyEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Currency rate between original and converted currency
+    # @return [Float]
+    attr_accessor :currency_rate
+
+    # ISO 4217 currency code
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency_code
+
+    # Original ISO 4217 currency code
+    # @return [Iso4217CurrencyCode1]
+    attr_accessor :original_currency_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_rate'] = 'currencyRate'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['original_currency_code'] = 'originalCurrencyCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency_rate
+        currency_code
+        original_currency_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency_rate: SKIP, currency_code: SKIP,
+                   original_currency_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency_rate = currency_rate unless currency_rate == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @original_currency_code = original_currency_code unless original_currency_code == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency_rate = hash.key?('currencyRate') ? hash['currencyRate'] : SKIP
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      original_currency_code =
+        hash.key?('originalCurrencyCode') ? hash['originalCurrencyCode'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CurrencyEntity2.new(currency_rate: currency_rate,
+                          currency_code: currency_code,
+                          original_currency_code: original_currency_code,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CurrencyEntity2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency_rate: #{@currency_rate}, currency_code: #{@currency_code},"\
+      " original_currency_code: #{@original_currency_code}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency_rate: #{@currency_rate.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, original_currency_code: #{@original_currency_code.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/currency_entity4.rb

@@ -0,0 +1,108 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Account currency
+  class CurrencyEntity4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Currency rate between original and converted currency
+    # @return [Float]
+    attr_accessor :currency_rate
+
+    # ISO 4217 currency code
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency_code
+
+    # Original ISO 4217 currency code
+    # @return [Iso4217CurrencyCode1]
+    attr_accessor :original_currency_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_rate'] = 'currencyRate'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['original_currency_code'] = 'originalCurrencyCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency_rate
+        currency_code
+        original_currency_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency_rate: SKIP, currency_code: SKIP,
+                   original_currency_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency_rate = currency_rate unless currency_rate == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @original_currency_code = original_currency_code unless original_currency_code == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency_rate = hash.key?('currencyRate') ? hash['currencyRate'] : SKIP
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      original_currency_code =
+        hash.key?('originalCurrencyCode') ? hash['originalCurrencyCode'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CurrencyEntity4.new(currency_rate: currency_rate,
+                          currency_code: currency_code,
+                          original_currency_code: original_currency_code,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CurrencyEntity4 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency_rate: #{@currency_rate}, currency_code: #{@currency_code},"\
+      " original_currency_code: #{@original_currency_code}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency_rate: #{@currency_rate.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, original_currency_code: #{@original_currency_code.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/customer_entity.rb

@@ -0,0 +1,241 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Represents a customer
+  class CustomerEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of the contact email addresses
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # Array of the contact physical addresses
+    # @return [Array[DeliveryAddress]]
+    attr_accessor :addresses
+
+    # Array of the contact telephone numbers
+    # @return [Array[TelephoneNumber]]
+    attr_accessor :telephones
+
+    # The person's date of birth
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Country specific Tax Id associated with this customer (SIN or NAS in
+    # Canada, SSN or TIN in US, etc.)
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Country originating the Customer's taxId element
+    # @return [Iso3166CountryCode]
+    attr_accessor :tax_id_country
+
+    # A federal (such as passport) or state (such as driver's license) issued
+    # identifier
+    # @return [String]
+    attr_accessor :government_id
+
+    # Long-term persistent identity of the customer. This identity must be
+    # unique to the owning institution
+    # @return [String]
+    attr_accessor :customer_id
+
+    # Type of entity. One of BUSINESS or CONSUMER
+    # @return [BusinessOrConsumerType]
+    attr_accessor :type
+
+    # The customer's name
+    # @return [CustomerNameEntity]
+    attr_accessor :name
+
+    # The business customer information, only used if 'type' is 'BUSINESS'.
+    # @return [BusinessCustomerEntity]
+    attr_accessor :business_customer
+
+    # The customer's start date at the financial institution
+    # @return [Date]
+    attr_accessor :customer_start_date
+
+    # The customer's date of last account activity at the financial institution
+    # @return [Date]
+    attr_accessor :last_activity_date
+
+    # List of accounts related to this customer
+    # @return [Array[CustomerToAccountRelationshipEntity]]
+    attr_accessor :accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash['telephones'] = 'telephones'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['tax_id_country'] = 'taxIdCountry'
+      @_hash['government_id'] = 'governmentId'
+      @_hash['customer_id'] = 'customerId'
+      @_hash['type'] = 'type'
+      @_hash['name'] = 'name'
+      @_hash['business_customer'] = 'businessCustomer'
+      @_hash['customer_start_date'] = 'customerStartDate'
+      @_hash['last_activity_date'] = 'lastActivityDate'
+      @_hash['accounts'] = 'accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        addresses
+        telephones
+        date_of_birth
+        tax_id
+        tax_id_country
+        government_id
+        customer_id
+        type
+        name
+        business_customer
+        customer_start_date
+        last_activity_date
+        accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emails: SKIP, addresses: SKIP, telephones: SKIP,
+                   date_of_birth: SKIP, tax_id: SKIP, tax_id_country: SKIP,
+                   government_id: SKIP, customer_id: SKIP, type: SKIP,
+                   name: SKIP, business_customer: SKIP,
+                   customer_start_date: SKIP, last_activity_date: SKIP,
+                   accounts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emails = emails unless emails == SKIP
+      @addresses = addresses unless addresses == SKIP
+      @telephones = telephones unless telephones == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @tax_id_country = tax_id_country unless tax_id_country == SKIP
+      @government_id = government_id unless government_id == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @type = type unless type == SKIP
+      @name = name unless name == SKIP
+      @business_customer = business_customer unless business_customer == SKIP
+      @customer_start_date = customer_start_date unless customer_start_date == SKIP
+      @last_activity_date = last_activity_date unless last_activity_date == SKIP
+      @accounts = accounts unless accounts == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (DeliveryAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      telephones = nil
+      unless hash['telephones'].nil?
+        telephones = []
+        hash['telephones'].each do |structure|
+          telephones << (TelephoneNumber.from_hash(structure) if structure)
+        end
+      end
+
+      telephones = SKIP unless hash.key?('telephones')
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      tax_id_country = hash.key?('taxIdCountry') ? hash['taxIdCountry'] : SKIP
+      government_id = hash.key?('governmentId') ? hash['governmentId'] : SKIP
+      customer_id = hash.key?('customerId') ? hash['customerId'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      name = CustomerNameEntity.from_hash(hash['name']) if hash['name']
+      business_customer = BusinessCustomerEntity.from_hash(hash['businessCustomer']) if
+        hash['businessCustomer']
+      customer_start_date =
+        hash.key?('customerStartDate') ? hash['customerStartDate'] : SKIP
+      last_activity_date =
+        hash.key?('lastActivityDate') ? hash['lastActivityDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (CustomerToAccountRelationshipEntity.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CustomerEntity.new(emails: emails,
+                         addresses: addresses,
+                         telephones: telephones,
+                         date_of_birth: date_of_birth,
+                         tax_id: tax_id,
+                         tax_id_country: tax_id_country,
+                         government_id: government_id,
+                         customer_id: customer_id,
+                         type: type,
+                         name: name,
+                         business_customer: business_customer,
+                         customer_start_date: customer_start_date,
+                         last_activity_date: last_activity_date,
+                         accounts: accounts,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emails: #{@emails}, addresses: #{@addresses}, telephones: #{@telephones},"\
+      " date_of_birth: #{@date_of_birth}, tax_id: #{@tax_id}, tax_id_country: #{@tax_id_country},"\
+      " government_id: #{@government_id}, customer_id: #{@customer_id}, type: #{@type}, name:"\
+      " #{@name}, business_customer: #{@business_customer}, customer_start_date:"\
+      " #{@customer_start_date}, last_activity_date: #{@last_activity_date}, accounts:"\
+      " #{@accounts}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emails: #{@emails.inspect}, addresses: #{@addresses.inspect}, telephones:"\
+      " #{@telephones.inspect}, date_of_birth: #{@date_of_birth.inspect}, tax_id:"\
+      " #{@tax_id.inspect}, tax_id_country: #{@tax_id_country.inspect}, government_id:"\
+      " #{@government_id.inspect}, customer_id: #{@customer_id.inspect}, type: #{@type.inspect},"\
+      " name: #{@name.inspect}, business_customer: #{@business_customer.inspect},"\
+      " customer_start_date: #{@customer_start_date.inspect}, last_activity_date:"\
+      " #{@last_activity_date.inspect}, accounts: #{@accounts.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/customer_name_entity.rb

@@ -0,0 +1,134 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The customer's name
+  class CustomerNameEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # First name
+    # @return [String]
+    attr_accessor :first
+
+    # Middle initial
+    # @return [String]
+    attr_accessor :middle
+
+    # Last name
+    # @return [String]
+    attr_accessor :last
+
+    # Generational or academic suffix
+    # @return [String]
+    attr_accessor :suffix
+
+    # Name prefix, e.g. Mr.
+    # @return [String]
+    attr_accessor :prefix
+
+    # Company name
+    # @return [String]
+    attr_accessor :company
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first'] = 'first'
+      @_hash['middle'] = 'middle'
+      @_hash['last'] = 'last'
+      @_hash['suffix'] = 'suffix'
+      @_hash['prefix'] = 'prefix'
+      @_hash['company'] = 'company'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first
+        middle
+        last
+        suffix
+        prefix
+        company
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first: SKIP, middle: SKIP, last: SKIP, suffix: SKIP,
+                   prefix: SKIP, company: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @first = first unless first == SKIP
+      @middle = middle unless middle == SKIP
+      @last = last unless last == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @prefix = prefix unless prefix == SKIP
+      @company = company unless company == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      first = hash.key?('first') ? hash['first'] : SKIP
+      middle = hash.key?('middle') ? hash['middle'] : SKIP
+      last = hash.key?('last') ? hash['last'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
+      company = hash.key?('company') ? hash['company'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CustomerNameEntity.new(first: first,
+                             middle: middle,
+                             last: last,
+                             suffix: suffix,
+                             prefix: prefix,
+                             company: company,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomerNameEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first: #{@first}, middle: #{@middle}, last: #{@last}, suffix: #{@suffix},"\
+      " prefix: #{@prefix}, company: #{@company}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first: #{@first.inspect}, middle: #{@middle.inspect}, last:"\
+      " #{@last.inspect}, suffix: #{@suffix.inspect}, prefix: #{@prefix.inspect}, company:"\
+      " #{@company.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end