fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/employment1.rb

@@ -0,0 +1,149 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The employee's employment
+  class Employment1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The employer for the job/position
+    # @return [EmployerEntity1]
+    attr_accessor :employer
+
+    # The title of the job/position
+    # @return [String]
+    attr_accessor :job_title
+
+    # The date when employee joined for the first time.
+    # @return [Date]
+    attr_accessor :original_hire_date
+
+    # The date when employee re-joined most recently.
+    # @return [Date]
+    attr_accessor :most_recent_hire_date
+
+    # The employment end date
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The employee's employment status, ACTIVE or INACTIVE
+    # @return [ActiveInactiveStatus2]
+    attr_accessor :status
+
+    # Supplemental detail of employee's employment status
+    # @return [SupplementalStatus2]
+    attr_accessor :supplemental_status
+
+    # The employee's employment type, CONTRACTED, FULL-TIME, OTHER, PART-TIME,
+    # SEASONAL, TEMPORARY
+    # @return [EmploymentType2]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['employer'] = 'employer'
+      @_hash['job_title'] = 'jobTitle'
+      @_hash['original_hire_date'] = 'originalHireDate'
+      @_hash['most_recent_hire_date'] = 'mostRecentHireDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['status'] = 'status'
+      @_hash['supplemental_status'] = 'supplementalStatus'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        job_title
+        original_hire_date
+        most_recent_hire_date
+        end_date
+        supplemental_status
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(employer:, status:, job_title: SKIP,
+                   original_hire_date: SKIP, most_recent_hire_date: SKIP,
+                   end_date: SKIP, supplemental_status: SKIP, type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @employer = employer
+      @job_title = job_title unless job_title == SKIP
+      @original_hire_date = original_hire_date unless original_hire_date == SKIP
+      @most_recent_hire_date = most_recent_hire_date unless most_recent_hire_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @status = status
+      @supplemental_status = supplemental_status unless supplemental_status == SKIP
+      @type = type unless type == 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.
+      employer = EmployerEntity1.from_hash(hash['employer']) if hash['employer']
+      status = hash.key?('status') ? hash['status'] : nil
+      job_title = hash.key?('jobTitle') ? hash['jobTitle'] : SKIP
+      original_hire_date =
+        hash.key?('originalHireDate') ? hash['originalHireDate'] : SKIP
+      most_recent_hire_date =
+        hash.key?('mostRecentHireDate') ? hash['mostRecentHireDate'] : SKIP
+      end_date = hash.key?('endDate') ? hash['endDate'] : SKIP
+      supplemental_status =
+        hash.key?('supplementalStatus') ? hash['supplementalStatus'] : SKIP
+      type = hash.key?('type') ? hash['type'] : 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.
+      Employment1.new(employer: employer,
+                      status: status,
+                      job_title: job_title,
+                      original_hire_date: original_hire_date,
+                      most_recent_hire_date: most_recent_hire_date,
+                      end_date: end_date,
+                      supplemental_status: supplemental_status,
+                      type: type,
+                      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} employer: #{@employer}, job_title: #{@job_title}, original_hire_date:"\
+      " #{@original_hire_date}, most_recent_hire_date: #{@most_recent_hire_date}, end_date:"\
+      " #{@end_date}, status: #{@status}, supplemental_status: #{@supplemental_status}, type:"\
+      " #{@type}, 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} employer: #{@employer.inspect}, job_title: #{@job_title.inspect},"\
+      " original_hire_date: #{@original_hire_date.inspect}, most_recent_hire_date:"\
+      " #{@most_recent_hire_date.inspect}, end_date: #{@end_date.inspect}, status:"\
+      " #{@status.inspect}, supplemental_status: #{@supplemental_status.inspect}, type:"\
+      " #{@type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/employment_type.rb

@@ -0,0 +1,36 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Specifies the employment type, such as CONTRACTED, FULL-TIME, OTHER,
+  # PART-TIME, SEASONAL, TEMPORARY
+  class EmploymentType
+    EMPLOYMENT_TYPE = [
+      # TODO: Write general description for CONTRACTED
+      CONTRACTED = 'CONTRACTED'.freeze,
+
+      # TODO: Write general description for FULL_TIME
+      FULL_TIME = 'FULL_TIME'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for PART_TIME
+      PART_TIME = 'PART_TIME'.freeze,
+
+      # TODO: Write general description for SEASONAL
+      SEASONAL = 'SEASONAL'.freeze,
+
+      # TODO: Write general description for TEMPORARY
+      TEMPORARY = 'TEMPORARY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/employment_type2.rb

@@ -0,0 +1,36 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The employee's employment type, CONTRACTED, FULL-TIME, OTHER, PART-TIME,
+  # SEASONAL, TEMPORARY
+  class EmploymentType2
+    EMPLOYMENT_TYPE2 = [
+      # TODO: Write general description for CONTRACTED
+      CONTRACTED = 'CONTRACTED'.freeze,
+
+      # TODO: Write general description for FULL_TIME
+      FULL_TIME = 'FULL_TIME'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for PART_TIME
+      PART_TIME = 'PART_TIME'.freeze,
+
+      # TODO: Write general description for SEASONAL
+      SEASONAL = 'SEASONAL'.freeze,
+
+      # TODO: Write general description for TEMPORARY
+      TEMPORARY = 'TEMPORARY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/error1.rb

@@ -0,0 +1,113 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An error entity which can be used at the API level for error responses or at
+  # the account level to indicate a problem specific to a particular account.
+  # See the error codes and descriptions defined in the latest FDX API
+  # Specification document, section 6.2 Errors
+  class Error1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code defined by FDX API Specification or Data Provider indicating
+    # the error situation which has occurred
+    # @return [String]
+    attr_accessor :code
+
+    # End user displayable information which might help the customer diagnose an
+    # error
+    # @return [String]
+    attr_accessor :message
+
+    # Message used to debug the root cause of the error. Contents should not be
+    # used in consumer's business logic. Can change at any time and should only
+    # be used for consumer to communicate with the data provider about an issue.
+    # Provider can include an error GUID in message for their use.
+    # @return [String]
+    attr_accessor :debug_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['message'] = 'message'
+      @_hash['debug_message'] = 'debugMessage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        message
+        debug_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, message: SKIP, debug_message: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @message = message unless message == SKIP
+      @debug_message = debug_message unless debug_message == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      debug_message = hash.key?('debugMessage') ? hash['debugMessage'] : 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.
+      Error1.new(code: code,
+                 message: message,
+                 debug_message: debug_message,
+                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Error1 | 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} code: #{@code}, message: #{@message}, debug_message: #{@debug_message},"\
+      " 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} code: #{@code.inspect}, message: #{@message.inspect}, debug_message:"\
+      " #{@debug_message.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/expired_option_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of expired stock option. Used by IRS Form 8949
+  class ExpiredOptionType
+    EXPIRED_OPTION_TYPE = [
+      # TODO: Write general description for GRANTED
+      GRANTED = 'GRANTED'.freeze,
+
+      # TODO: Write general description for PURCHASED
+      PURCHASED = 'PURCHASED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/expired_option_type2.rb

@@ -0,0 +1,24 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # To indicate gain or loss resulted from option expiration. If salesPrice (1d,
+  # proceeds) is zero, use PURCHASED. If costBasis (1e) is zero, use GRANTED
+  class ExpiredOptionType2
+    EXPIRED_OPTION_TYPE2 = [
+      # TODO: Write general description for GRANTED
+      GRANTED = 'GRANTED'.freeze,
+
+      # TODO: Write general description for PURCHASED
+      PURCHASED = 'PURCHASED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/external_account_id_scheme_entity.rb

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

data/lib/fdx_api/models/external_financial_institution_id_scheme_entity.rb

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