fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/employment1.rb

@@ -0,0 +1,149 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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_v660_api/models/employment_type.rb

@@ -0,0 +1,53 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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
+
+    def self.from_value(value, default_value = CONTRACTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'contracted' then CONTRACTED
+      when 'full_time' then FULL_TIME
+      when 'other' then OTHER
+      when 'part_time' then PART_TIME
+      when 'seasonal' then SEASONAL
+      when 'temporary' then TEMPORARY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/employment_type2.rb

@@ -0,0 +1,53 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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
+
+    def self.from_value(value, default_value = CONTRACTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'contracted' then CONTRACTED
+      when 'full_time' then FULL_TIME
+      when 'other' then OTHER
+      when 'part_time' then PART_TIME
+      when 'seasonal' then SEASONAL
+      when 'temporary' then TEMPORARY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/error2.rb

@@ -0,0 +1,100 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Present if an error was encountered while retrieving this form
+  class Error2 < 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.
+      Error2.new(code: code,
+                 message: message,
+                 debug_message: debug_message,
+                 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} 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_v660_api/models/error3.rb

@@ -0,0 +1,110 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Present if an error was encountered while retrieving this account
+  class Error3 < 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.
+      Error3.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 [Error3 | 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_v660_api/models/event_frequency.rb

@@ -0,0 +1,102 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Defines how often an event occurs in a series such as a sequence of
+  # payments. Actual payment processing or other event date may be moved by
+  # processor to precede or succeed the specified date so it doesn't land on a
+  # weekend or holiday   * `ONETIME`: A single, one-time payment or event on
+  # scheduled date   * `DAILY`: A payment or event every single day   *
+  # `WEEKLY`: Payment or event every 7 days   * `BIWEEKLY`: Payment or event
+  # every 14 days   * `SEMIMONTHLY`: Payment or event every 15 days, same as
+  # `TWICEMONTHLY`, deprecated and will be removed in next major release   *
+  # `TWICEMONTHLY`: Payment or event every 15 days, often on 15th and last day
+  # of month, same as `SEMIMONTHLY`   * `FOURWEEKS`: Payment or event every 28
+  # days   * `DUEDATE`: Payment on the actual obligation due date when scheduled
+  # with Payee, often monthly, on correct date even if it moves around to avoid
+  # weekends or holidays   * `MONTHLY`: Payment or event monthly on the same
+  # date each month   * `BIMONTHLY`: Payment or event every other month on the
+  # same day of the month   * `QUARTERLY`: Payment or event every third month on
+  # the same day of the month   * `SEMIANNUALLY`: Payment or event every six
+  # months on the same day of the month   * `ANNUALLY`: Payment or event every
+  # year on the same date   * `OTHER`: Payment or event on another frequency
+  # schedule not included in this list
+  class EventFrequency
+    EVENT_FREQUENCY = [
+      # TODO: Write general description for ONETIME
+      ONETIME = 'ONETIME'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for TWICEMONTHLY
+      TWICEMONTHLY = 'TWICEMONTHLY'.freeze,
+
+      # TODO: Write general description for FOURWEEKS
+      FOURWEEKS = 'FOURWEEKS'.freeze,
+
+      # TODO: Write general description for DUEDATE
+      DUEDATE = 'DUEDATE'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for BIMONTHLY
+      BIMONTHLY = 'BIMONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ONETIME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'onetime' then ONETIME
+      when 'daily' then DAILY
+      when 'weekly' then WEEKLY
+      when 'biweekly' then BIWEEKLY
+      when 'semimonthly' then SEMIMONTHLY
+      when 'twicemonthly' then TWICEMONTHLY
+      when 'fourweeks' then FOURWEEKS
+      when 'duedate' then DUEDATE
+      when 'monthly' then MONTHLY
+      when 'bimonthly' then BIMONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'semiannually' then SEMIANNUALLY
+      when 'annually' then ANNUALLY
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/event_frequency1.rb

@@ -0,0 +1,84 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Defines how often the pension payment repeats
+  class EventFrequency1
+    EVENT_FREQUENCY1 = [
+      # TODO: Write general description for ONETIME
+      ONETIME = 'ONETIME'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for TWICEMONTHLY
+      TWICEMONTHLY = 'TWICEMONTHLY'.freeze,
+
+      # TODO: Write general description for FOURWEEKS
+      FOURWEEKS = 'FOURWEEKS'.freeze,
+
+      # TODO: Write general description for DUEDATE
+      DUEDATE = 'DUEDATE'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for BIMONTHLY
+      BIMONTHLY = 'BIMONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ONETIME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'onetime' then ONETIME
+      when 'daily' then DAILY
+      when 'weekly' then WEEKLY
+      when 'biweekly' then BIWEEKLY
+      when 'semimonthly' then SEMIMONTHLY
+      when 'twicemonthly' then TWICEMONTHLY
+      when 'fourweeks' then FOURWEEKS
+      when 'duedate' then DUEDATE
+      when 'monthly' then MONTHLY
+      when 'bimonthly' then BIMONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'semiannually' then SEMIANNUALLY
+      when 'annually' then ANNUALLY
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end