fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/hateoas_link5.rb

@@ -0,0 +1,136 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The URL to retrieve the JWKS public keys from the data provider, needed to
+  # enable payload level encryption above the TLS layer
+  class HateoasLink5 < 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 [HttpActionType2]
+    attr_accessor :action
+
+    # Relation of this link to its containing entity, as defined by IETF RFC5988
+    # with many relation values specified in its [Section
+    # 6.2.2](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2), for
+    # example:
+    #   * `self` - Link to the current resource latest state or with more detail
+    #   * `prev` - Previous page in a paginated result set
+    #   * `next` - Subsequent page in a paginated result set
+    #   * `first` - First page in a paginated result set
+    #   * `last` - Last page in a paginated result set
+    #   * `related` - Link to a related resource, like a Transaction's
+    # referenceTransactionId
+    #   * `up` - Link to a related 'parent' resource, like a child account's
+    # parent account
+    #   * `payment` - Link to a payment-scheduling endpoint
+    # Specific to FDX, `rel` values can contain a data cluster or
+    # space-delimited list of data clusters which link to the referenced data
+    # type(s), for example:
+    #   * `ACCOUNT_DETAILED` - Link to the account's details via
+    # `/accounts/{accountId}`
+    #   * `PAYMENT_SUPPORT` - Link to the account's ID and bank ID for payments
+    # or transfers via `/accounts/{accountId}/payment-networks`
+    #   * `CUSTOMER_CONTACT` - Link to the account's customer contact details
+    # via `/accounts/{accountId}/contact`
+    #   * `TRANSACTIONS` - Link to the account's transactions list via
+    # `/accounts/{accountId}/transactions`
+    #   * `REWARDS` - Link to the account's reward program via
+    # `/reward-programs/{rewardProgramId}`
+    #   * `TRANSACTIONS REWARDS` - Specific link to the account's transaction
+    # rewards via `/accounts/{accountId}/reward-transactions`
+    #   * `STATEMENTS` - Link to the account's statements list via
+    # `/accounts/{accountId}/statements`
+    #   * `IMAGES` - Link to the transaction's images list via
+    # `/accounts/{accountId}/transaction-images/{imageId}`
+    # @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.
+      HateoasLink5.new(href: href,
+                       action: action,
+                       rel: rel,
+                       types: types,
+                       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} 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_v660_api/models/hateoas_link6.rb

@@ -0,0 +1,135 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Resource URL for retrieving updates since last request
+  class HateoasLink6 < 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 [HttpActionType2]
+    attr_accessor :action
+
+    # Relation of this link to its containing entity, as defined by IETF RFC5988
+    # with many relation values specified in its [Section
+    # 6.2.2](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2), for
+    # example:
+    #   * `self` - Link to the current resource latest state or with more detail
+    #   * `prev` - Previous page in a paginated result set
+    #   * `next` - Subsequent page in a paginated result set
+    #   * `first` - First page in a paginated result set
+    #   * `last` - Last page in a paginated result set
+    #   * `related` - Link to a related resource, like a Transaction's
+    # referenceTransactionId
+    #   * `up` - Link to a related 'parent' resource, like a child account's
+    # parent account
+    #   * `payment` - Link to a payment-scheduling endpoint
+    # Specific to FDX, `rel` values can contain a data cluster or
+    # space-delimited list of data clusters which link to the referenced data
+    # type(s), for example:
+    #   * `ACCOUNT_DETAILED` - Link to the account's details via
+    # `/accounts/{accountId}`
+    #   * `PAYMENT_SUPPORT` - Link to the account's ID and bank ID for payments
+    # or transfers via `/accounts/{accountId}/payment-networks`
+    #   * `CUSTOMER_CONTACT` - Link to the account's customer contact details
+    # via `/accounts/{accountId}/contact`
+    #   * `TRANSACTIONS` - Link to the account's transactions list via
+    # `/accounts/{accountId}/transactions`
+    #   * `REWARDS` - Link to the account's reward program via
+    # `/reward-programs/{rewardProgramId}`
+    #   * `TRANSACTIONS REWARDS` - Specific link to the account's transaction
+    # rewards via `/accounts/{accountId}/reward-transactions`
+    #   * `STATEMENTS` - Link to the account's statements list via
+    # `/accounts/{accountId}/statements`
+    #   * `IMAGES` - Link to the transaction's images list via
+    # `/accounts/{accountId}/transaction-images/{imageId}`
+    # @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.
+      HateoasLink6.new(href: href,
+                       action: action,
+                       rel: rel,
+                       types: types,
+                       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} 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_v660_api/models/hateoas_link7.rb

@@ -0,0 +1,135 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Resource URL for retrieving full request for payment details
+  class HateoasLink7 < 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 [HttpActionType2]
+    attr_accessor :action
+
+    # Relation of this link to its containing entity, as defined by IETF RFC5988
+    # with many relation values specified in its [Section
+    # 6.2.2](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2), for
+    # example:
+    #   * `self` - Link to the current resource latest state or with more detail
+    #   * `prev` - Previous page in a paginated result set
+    #   * `next` - Subsequent page in a paginated result set
+    #   * `first` - First page in a paginated result set
+    #   * `last` - Last page in a paginated result set
+    #   * `related` - Link to a related resource, like a Transaction's
+    # referenceTransactionId
+    #   * `up` - Link to a related 'parent' resource, like a child account's
+    # parent account
+    #   * `payment` - Link to a payment-scheduling endpoint
+    # Specific to FDX, `rel` values can contain a data cluster or
+    # space-delimited list of data clusters which link to the referenced data
+    # type(s), for example:
+    #   * `ACCOUNT_DETAILED` - Link to the account's details via
+    # `/accounts/{accountId}`
+    #   * `PAYMENT_SUPPORT` - Link to the account's ID and bank ID for payments
+    # or transfers via `/accounts/{accountId}/payment-networks`
+    #   * `CUSTOMER_CONTACT` - Link to the account's customer contact details
+    # via `/accounts/{accountId}/contact`
+    #   * `TRANSACTIONS` - Link to the account's transactions list via
+    # `/accounts/{accountId}/transactions`
+    #   * `REWARDS` - Link to the account's reward program via
+    # `/reward-programs/{rewardProgramId}`
+    #   * `TRANSACTIONS REWARDS` - Specific link to the account's transaction
+    # rewards via `/accounts/{accountId}/reward-transactions`
+    #   * `STATEMENTS` - Link to the account's statements list via
+    # `/accounts/{accountId}/statements`
+    #   * `IMAGES` - Link to the transaction's images list via
+    # `/accounts/{accountId}/transaction-images/{imageId}`
+    # @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.
+      HateoasLink7.new(href: href,
+                       action: action,
+                       rel: rel,
+                       types: types,
+                       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} 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_v660_api/models/health_insurance_coverage.rb

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

@@ -0,0 +1,118 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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 [IndividualName5]
+    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 = IndividualName5.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