fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/generic_financial_institution_id_entity.rb

@@ -0,0 +1,107 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Generic financial institution identifier entity
+  class GenericFinancialInstitutionIdEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Financial institution identifier
+    # @return [String]
+    attr_accessor :fi_id
+
+    # Issuer name
+    # @return [String]
+    attr_accessor :issuer_name
+
+    # Identification scheme associated with the generic financial institution
+    # @return [Object]
+    attr_accessor :id_scheme
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fi_id'] = 'fiId'
+      @_hash['issuer_name'] = 'issuerName'
+      @_hash['id_scheme'] = 'idScheme'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fi_id
+        issuer_name
+        id_scheme
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fi_id: SKIP, issuer_name: SKIP, id_scheme: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fi_id = fi_id unless fi_id == SKIP
+      @issuer_name = issuer_name unless issuer_name == SKIP
+      @id_scheme = id_scheme unless id_scheme == 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.
+      fi_id = hash.key?('fiId') ? hash['fiId'] : SKIP
+      issuer_name = hash.key?('issuerName') ? hash['issuerName'] : SKIP
+      id_scheme = hash.key?('idScheme') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:GenericFinancialInstitutionIdEntityIdScheme), hash['idScheme']
+      ) : 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.
+      GenericFinancialInstitutionIdEntity.new(fi_id: fi_id,
+                                              issuer_name: issuer_name,
+                                              id_scheme: id_scheme,
+                                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GenericFinancialInstitutionIdEntity | 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} fi_id: #{@fi_id}, issuer_name: #{@issuer_name}, id_scheme: #{@id_scheme},"\
+      " 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} fi_id: #{@fi_id.inspect}, issuer_name: #{@issuer_name.inspect}, id_scheme:"\
+      " #{@id_scheme.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/government_issued_id_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Government Issued ID Type
+  class GovernmentIssuedIdType
+    GOVERNMENT_ISSUED_ID_TYPE = [
+      # TODO: Write general description for DRIVERLICENSE
+      DRIVERLICENSE = 'DRIVERLICENSE'.freeze,
+
+      # TODO: Write general description for PASSPORT
+      PASSPORT = 'PASSPORT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/government_issued_id_type2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of the identification
+  class GovernmentIssuedIdType2
+    GOVERNMENT_ISSUED_ID_TYPE2 = [
+      # TODO: Write general description for DRIVERLICENSE
+      DRIVERLICENSE = 'DRIVERLICENSE'.freeze,
+
+      # TODO: Write general description for PASSPORT
+      PASSPORT = 'PASSPORT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/government_issued_party_identification_entity.rb

@@ -0,0 +1,118 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Government issued identification document that is used to uniquely identify
+  # a person or business
+  class GovernmentIssuedPartyIdentificationEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identification number
+    # @return [String]
+    attr_accessor :id_number
+
+    # Issued date
+    # @return [String]
+    attr_accessor :issued_date
+
+    # Expiry date
+    # @return [String]
+    attr_accessor :expiry_date
+
+    # Type of the identification
+    # @return [GovernmentIssuedIdType2]
+    attr_accessor :type
+
+    # Name of the issuing country
+    # @return [String]
+    attr_accessor :issuing_country_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id_number'] = 'idNumber'
+      @_hash['issued_date'] = 'issuedDate'
+      @_hash['expiry_date'] = 'expiryDate'
+      @_hash['type'] = 'type'
+      @_hash['issuing_country_name'] = 'issuingCountryName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id_number
+        issued_date
+        expiry_date
+        type
+        issuing_country_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id_number: SKIP, issued_date: SKIP, expiry_date: SKIP,
+                   type: SKIP, issuing_country_name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id_number = id_number unless id_number == SKIP
+      @issued_date = issued_date unless issued_date == SKIP
+      @expiry_date = expiry_date unless expiry_date == SKIP
+      @type = type unless type == SKIP
+      @issuing_country_name = issuing_country_name unless issuing_country_name == 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_number = hash.key?('idNumber') ? hash['idNumber'] : SKIP
+      issued_date = hash.key?('issuedDate') ? hash['issuedDate'] : SKIP
+      expiry_date = hash.key?('expiryDate') ? hash['expiryDate'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      issuing_country_name =
+        hash.key?('issuingCountryName') ? hash['issuingCountryName'] : 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.
+      GovernmentIssuedPartyIdentificationEntity.new(id_number: id_number,
+                                                    issued_date: issued_date,
+                                                    expiry_date: expiry_date,
+                                                    type: type,
+                                                    issuing_country_name: issuing_country_name,
+                                                    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} id_number: #{@id_number}, issued_date: #{@issued_date}, expiry_date:"\
+      " #{@expiry_date}, type: #{@type}, issuing_country_name: #{@issuing_country_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} id_number: #{@id_number.inspect}, issued_date: #{@issued_date.inspect},"\
+      " expiry_date: #{@expiry_date.inspect}, type: #{@type.inspect}, issuing_country_name:"\
+      " #{@issuing_country_name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/hateoas_link.rb

@@ -0,0 +1,119 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # REST application constraint (Hypermedia As The Engine Of Application State)
+  class HateoasLink < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to invoke the action on the resource
+    # @return [String]
+    attr_accessor :href
+
+    # HTTP Method to use for the request
+    # @return [HttpActionType]
+    attr_accessor :action
+
+    # Relation of this link to its containing entity, as defined by and with
+    # many example relation values at [IETF
+    # RFC5988](https://datatracker.ietf.org/doc/html/rfc5988)
+    # @return [String]
+    attr_accessor :rel
+
+    # Content-types that can be used in the Accept header
+    # @return [Array[ContentTypes]]
+    attr_accessor :types
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['action'] = 'action'
+      @_hash['rel'] = 'rel'
+      @_hash['types'] = 'types'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        rel
+        types
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href:, action: SKIP, rel: SKIP, types: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @href = href
+      @action = action unless action == SKIP
+      @rel = rel unless rel == SKIP
+      @types = types unless types == 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.
+      href = hash.key?('href') ? hash['href'] : nil
+      action = hash.key?('action') ? hash['action'] : SKIP
+      rel = hash.key?('rel') ? hash['rel'] : SKIP
+      types = hash.key?('types') ? hash['types'] : 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.
+      HateoasLink.new(href: href,
+                      action: action,
+                      rel: rel,
+                      types: types,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [HateoasLink | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.href,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['href'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, action: #{@action}, rel: #{@rel}, types: #{@types},"\
+      " 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} href: #{@href.inspect}, action: #{@action.inspect}, rel: #{@rel.inspect},"\
+      " types: #{@types.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/health_insurance_coverage.rb

@@ -0,0 +1,115 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Used on Form 1095-A Part III
+  class HealthInsuranceCoverage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Monthly enrollment premiums
+    # @return [Float]
+    attr_accessor :enrollment_premium
+
+    # Monthly second lowest cost silver plan (SLCSP) premium
+    # @return [Float]
+    attr_accessor :slcsp_premium
+
+    # Monthly advance payment of premium tax credit
+    # @return [Float]
+    attr_accessor :advance_premium_tax_credit_payment
+
+    # Month of coverage
+    # @return [CoverageMonth3]
+    attr_accessor :month
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['enrollment_premium'] = 'enrollmentPremium'
+      @_hash['slcsp_premium'] = 'slcspPremium'
+      @_hash['advance_premium_tax_credit_payment'] =
+        'advancePremiumTaxCreditPayment'
+      @_hash['month'] = 'month'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        enrollment_premium
+        slcsp_premium
+        advance_premium_tax_credit_payment
+        month
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(enrollment_premium: SKIP, slcsp_premium: SKIP,
+                   advance_premium_tax_credit_payment: SKIP, month: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @enrollment_premium = enrollment_premium unless enrollment_premium == SKIP
+      @slcsp_premium = slcsp_premium unless slcsp_premium == SKIP
+      unless advance_premium_tax_credit_payment == SKIP
+        @advance_premium_tax_credit_payment =
+          advance_premium_tax_credit_payment
+      end
+      @month = month unless month == 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.
+      enrollment_premium =
+        hash.key?('enrollmentPremium') ? hash['enrollmentPremium'] : SKIP
+      slcsp_premium = hash.key?('slcspPremium') ? hash['slcspPremium'] : SKIP
+      advance_premium_tax_credit_payment =
+        hash.key?('advancePremiumTaxCreditPayment') ? hash['advancePremiumTaxCreditPayment'] : SKIP
+      month = hash.key?('month') ? hash['month'] : 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.
+      HealthInsuranceCoverage.new(enrollment_premium: enrollment_premium,
+                                  slcsp_premium: slcsp_premium,
+                                  advance_premium_tax_credit_payment: advance_premium_tax_credit_payment,
+                                  month: month,
+                                  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} enrollment_premium: #{@enrollment_premium}, slcsp_premium:"\
+      " #{@slcsp_premium}, advance_premium_tax_credit_payment:"\
+      " #{@advance_premium_tax_credit_payment}, month: #{@month}, 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} enrollment_premium: #{@enrollment_premium.inspect}, slcsp_premium:"\
+      " #{@slcsp_premium.inspect}, advance_premium_tax_credit_payment:"\
+      " #{@advance_premium_tax_credit_payment.inspect}, month: #{@month.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/health_insurance_covered_individual.rb

@@ -0,0 +1,118 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Used on Form 1095-B Part IV and Form 1095-C Part III
+  class HealthInsuranceCoveredIndividual < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of responsible individual
+    # @return [IndividualName]
+    attr_accessor :name
+
+    # Social security number or other TIN
+    # @return [String]
+    attr_accessor :tin
+
+    # Date of birth
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Covered all 12 months
+    # @return [TrueClass | FalseClass]
+    attr_accessor :covered_all12_months
+
+    # Months covered
+    # @return [Array[MonthAbbreviation]]
+    attr_accessor :covered_months
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['tin'] = 'tin'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['covered_all12_months'] = 'coveredAll12Months'
+      @_hash['covered_months'] = 'coveredMonths'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        tin
+        date_of_birth
+        covered_all12_months
+        covered_months
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, tin: SKIP, date_of_birth: SKIP,
+                   covered_all12_months: SKIP, covered_months: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @tin = tin unless tin == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @covered_all12_months = covered_all12_months unless covered_all12_months == SKIP
+      @covered_months = covered_months unless covered_months == 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.
+      name = IndividualName.from_hash(hash['name']) if hash['name']
+      tin = hash.key?('tin') ? hash['tin'] : SKIP
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      covered_all12_months =
+        hash.key?('coveredAll12Months') ? hash['coveredAll12Months'] : SKIP
+      covered_months = hash.key?('coveredMonths') ? hash['coveredMonths'] : 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.
+      HealthInsuranceCoveredIndividual.new(name: name,
+                                           tin: tin,
+                                           date_of_birth: date_of_birth,
+                                           covered_all12_months: covered_all12_months,
+                                           covered_months: covered_months,
+                                           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} name: #{@name}, tin: #{@tin}, date_of_birth: #{@date_of_birth},"\
+      " covered_all12_months: #{@covered_all12_months}, covered_months: #{@covered_months},"\
+      " 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} name: #{@name.inspect}, tin: #{@tin.inspect}, date_of_birth:"\
+      " #{@date_of_birth.inspect}, covered_all12_months: #{@covered_all12_months.inspect},"\
+      " covered_months: #{@covered_months.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end