fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/digital_wallet_transaction_type2.rb

@@ -0,0 +1,61 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # ADJUSTMENT, BILL_PAYMENT, CREDIT, DEBIT, DEPOSIT, DIRECT_DEPOSIT, DIVIDEND,
+  # FEE, INTEREST, MERCHANT_PAYMENT, MERCHANT_REFUND, TRANSFER_IN, TRANSFER_OUT,
+  # WITHDRAWAL
+  class DigitalWalletTransactionType2
+    DIGITAL_WALLET_TRANSACTION_TYPE2 = [
+      # TODO: Write general description for ADJUSTMENT
+      ADJUSTMENT = 'ADJUSTMENT'.freeze,
+
+      # TODO: Write general description for BILL_PAYMENT
+      BILL_PAYMENT = 'BILL_PAYMENT'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'CREDIT'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'DEBIT'.freeze,
+
+      # TODO: Write general description for DEPOSIT
+      DEPOSIT = 'DEPOSIT'.freeze,
+
+      # TODO: Write general description for DIRECT_DEPOSIT
+      DIRECT_DEPOSIT = 'DIRECT_DEPOSIT'.freeze,
+
+      # TODO: Write general description for DIVIDEND
+      DIVIDEND = 'DIVIDEND'.freeze,
+
+      # TODO: Write general description for FEE
+      FEE = 'FEE'.freeze,
+
+      # TODO: Write general description for INTEREST
+      INTEREST = 'INTEREST'.freeze,
+
+      # TODO: Write general description for MERCHANT_PAYMENT
+      MERCHANT_PAYMENT = 'MERCHANT_PAYMENT'.freeze,
+
+      # TODO: Write general description for MERCHANT_REFUND
+      MERCHANT_REFUND = 'MERCHANT_REFUND'.freeze,
+
+      # TODO: Write general description for TRANSFER_IN
+      TRANSFER_IN = 'TRANSFER_IN'.freeze,
+
+      # TODO: Write general description for TRANSFER_OUT
+      TRANSFER_OUT = 'TRANSFER_OUT'.freeze,
+
+      # TODO: Write general description for WITHDRAWAL
+      WITHDRAWAL = 'WITHDRAWAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/direct_deposit_entity.rb

@@ -0,0 +1,98 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Direct deposit details
+  class DirectDepositEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the direct deposit configuration
+    # @return [String]
+    attr_accessor :direct_deposit_id
+
+    # Type code of a registration for a direct deposit account
+    # @return [String]
+    attr_accessor :registration_type_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['direct_deposit_id'] = 'directDepositId'
+      @_hash['registration_type_code'] = 'registrationTypeCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        direct_deposit_id
+        registration_type_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(direct_deposit_id: SKIP, registration_type_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @direct_deposit_id = direct_deposit_id unless direct_deposit_id == SKIP
+      @registration_type_code = registration_type_code unless registration_type_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.
+      direct_deposit_id =
+        hash.key?('directDepositId') ? hash['directDepositId'] : SKIP
+      registration_type_code =
+        hash.key?('registrationTypeCode') ? hash['registrationTypeCode'] : 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.
+      DirectDepositEntity.new(direct_deposit_id: direct_deposit_id,
+                              registration_type_code: registration_type_code,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DirectDepositEntity | 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} direct_deposit_id: #{@direct_deposit_id}, registration_type_code:"\
+      " #{@registration_type_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} direct_deposit_id: #{@direct_deposit_id.inspect}, registration_type_code:"\
+      " #{@registration_type_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/document_status.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines the status of a document
+  class DocumentStatus
+    DOCUMENT_STATUS = [
+      # TODO: Write general description for AVAILABLE
+      AVAILABLE = 'AVAILABLE'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'PROCESSING'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/document_status2.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Availability status of statement
+  class DocumentStatus2
+    DOCUMENT_STATUS2 = [
+      # TODO: Write general description for AVAILABLE
+      AVAILABLE = 'AVAILABLE'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'PROCESSING'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/domicile_entity.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The country and region of the business customer's location
+  class DomicileEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Country sub-division; state or province or territory
+    # @return [String]
+    attr_accessor :region
+
+    # ISO 3166 Country Code
+    # @return [Iso3166CountryCode2]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['region'] = 'region'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        region
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(region: SKIP, country: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @region = region unless region == SKIP
+      @country = country unless country == 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.
+      region = hash.key?('region') ? hash['region'] : SKIP
+      country = hash.key?('country') ? hash['country'] : 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.
+      DomicileEntity.new(region: region,
+                         country: country,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DomicileEntity | 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} region: #{@region}, country: #{@country}, 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} region: #{@region.inspect}, country: #{@country.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/domicile_entity1.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The country and region of the account's legal jurisdiction
+  class DomicileEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Country sub-division; state or province or territory
+    # @return [String]
+    attr_accessor :region
+
+    # ISO 3166 Country Code
+    # @return [Iso3166CountryCode2]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['region'] = 'region'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        region
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(region: SKIP, country: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @region = region unless region == SKIP
+      @country = country unless country == 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.
+      region = hash.key?('region') ? hash['region'] : SKIP
+      country = hash.key?('country') ? hash['country'] : 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.
+      DomicileEntity1.new(region: region,
+                          country: country,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DomicileEntity1 | 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} region: #{@region}, country: #{@country}, 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} region: #{@region.inspect}, country: #{@country.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/electronic_address_entity.rb

@@ -0,0 +1,87 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Electronic address details
+  class ElectronicAddressEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Value of the email address
+    # @return [String]
+    attr_accessor :email_address_text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address_text'] = 'emailAddressText'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address_text: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @email_address_text = email_address_text unless email_address_text == 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.
+      email_address_text =
+        hash.key?('emailAddressText') ? hash['emailAddressText'] : 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.
+      ElectronicAddressEntity.new(email_address_text: email_address_text,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ElectronicAddressEntity | 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} email_address_text: #{@email_address_text}, 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} email_address_text: #{@email_address_text.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/employee_entity.rb

@@ -0,0 +1,175 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Represents an employee
+  class EmployeeEntity < 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
+
+    # Provider's long-term persistent id for the employee
+    # @return [String]
+    attr_accessor :employee_id
+
+    # Employee's full name
+    # @return [IndividualName]
+    attr_accessor :name
+
+    # 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['employee_id'] = 'employeeId'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        addresses
+        telephones
+        date_of_birth
+        tax_id
+        tax_id_country
+        government_id
+        employee_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, emails: SKIP, addresses: SKIP, telephones: SKIP,
+                   date_of_birth: SKIP, tax_id: SKIP, tax_id_country: SKIP,
+                   government_id: SKIP, employee_id: 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
+      @employee_id = employee_id unless employee_id == SKIP
+      @name = name
+      @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.
+      name = IndividualName.from_hash(hash['name']) if hash['name']
+      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
+      employee_id = hash.key?('employeeId') ? hash['employeeId'] : 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.
+      EmployeeEntity.new(name: 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,
+                         employee_id: employee_id,
+                         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}, employee_id: #{@employee_id}, name: #{@name},"\
+      " 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}, employee_id: #{@employee_id.inspect}, name: #{@name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end