vitable-connect 0.5.0 → 1.0.0

data/lib/VitableConnect/types/created_before.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module CreatedBefore
+      # CreatedBefore is an alias for String
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/VitableConnect/types/deduction_detail.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class DeductionDetail < Internal::Types::Model
+      field :deduction_category, -> { String }, optional: false, nullable: true
+
+      field :deduction_amount_in_cents, -> { Integer }, optional: false, nullable: false
+
+      field :tax_classification, -> { VitableConnect::Types::TaxClassification }, optional: false, nullable: false
+
+      field :frequency, -> { VitableConnect::Types::DeductionFrequency }, optional: false, nullable: false
+
+      field :benefit_name, -> { String }, optional: false, nullable: false
+
+      field :period_start_date, -> { String }, optional: false, nullable: false
+
+      field :period_end_date, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/deduction_frequency.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module DeductionFrequency
+      extend VitableConnect::Internal::Types::Enum
+
+      WEEKLY = "weekly"
+      BI_WEEKLY = "bi_weekly"
+      SEMI_MONTHLY = "semi_monthly"
+      MONTHLY = "monthly"
+    end
+  end
+end

data/lib/VitableConnect/types/digital_benefit_card.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Wire serializer for :class:`DigitalBenefitCardDTO` (one benefit ID card).
+    class DigitalBenefitCard < Internal::Types::Model
+      field :card_type, -> { VitableConnect::Types::CardType }, optional: false, nullable: false
+
+      field :group_id, -> { String }, optional: false, nullable: false
+
+      field :group_member_id, -> { String }, optional: false, nullable: false
+
+      field :member_name, -> { String }, optional: false, nullable: false
+
+      field :employer_name, -> { String }, optional: true, nullable: false
+
+      field :plan_name, -> { String }, optional: true, nullable: false
+
+      field :benefit_code, -> { VitableConnect::Types::ProductCode }, optional: true, nullable: false
+
+      field :network, -> { VitableConnect::Types::BenefitPlanNetwork }, optional: true, nullable: false
+
+      field :claims_payer_display_name, -> { String }, optional: true, nullable: false
+
+      field :carrier_phone, -> { String }, optional: true, nullable: false
+
+      field :carrier_website, -> { String }, optional: true, nullable: false
+
+      field :plan_disclaimer, -> { String }, optional: true, nullable: false
+
+      field :general_disclaimer, -> { String }, optional: true, nullable: false
+
+      field :nsa_table, -> { Internal::Types::Array[Internal::Types::Array[String]] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/election_status_item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module ElectionStatusItem
+      extend VitableConnect::Internal::Types::Enum
+
+      ENROLLED = "Enrolled"
+      EXPIRED = "Expired"
+      PENDING = "Pending"
+      WAIVED = "Waived"
+    end
+  end
+end

data/lib/VitableConnect/types/eligibility_policy.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # The plan year's active eligibility policy. Mirrors the internal ``PlanYearEligibilityPolicyDTO``
+    # but exposes only the public subset (no raw ids, ``active_in``, or timestamps).
+    class EligibilityPolicy < Internal::Types::Model
+      field :waiting_period, -> { VitableConnect::Types::WaitingPeriod }, optional: false, nullable: true
+
+      field :termination_rule, -> { VitableConnect::Types::TerminationRule }, optional: false, nullable: false
+
+      field :termination_n_months, -> { Integer }, optional: false, nullable: true
+
+      field :rules, -> { Internal::Types::Array[VitableConnect::Types::EligibilityPolicyRule] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/eligibility_policy_rule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # One eligibility rule — the workforce slice it makes eligible. Mirrors the internal
+    # ``PlanYearEligibilityPolicyRuleDTO`` minus the raw ids and timestamps.
+    class EligibilityPolicyRule < Internal::Types::Model
+      field :employee_class, -> { VitableConnect::Types::EligibilityRuleEmployeeClass }, optional: false, nullable: false
+
+      field :compensation_type, -> { VitableConnect::Types::EligibilityRuleCompensationType }, optional: false, nullable: false
+
+      field :eligible_geographical_location, -> { VitableConnect::Types::EligibleGeographicalLocation }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/eligibility_rule_compensation_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EligibilityRuleCompensationType
+      extend VitableConnect::Internal::Types::Enum
+
+      SALARY = "Salary"
+      HOURLY = "Hourly"
+      ALL = "All"
+    end
+  end
+end

data/lib/VitableConnect/types/eligibility_rule_employee_class.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EligibilityRuleEmployeeClass
+      extend VitableConnect::Internal::Types::Enum
+
+      FULL_TIME = "Full Time"
+      PART_TIME = "Part Time"
+      TEMPORARY = "Temporary"
+      INTERN = "Intern"
+      SEASONAL = "Seasonal"
+      INDIVIDUAL_CONTRACTOR = "Individual Contractor"
+      ALL = "All"
+    end
+  end
+end

data/lib/VitableConnect/types/eligible_geographical_location.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EligibleGeographicalLocation < Internal::Types::Model
+      field :type, -> { VitableConnect::Types::EligibleGeographicalLocationType }, optional: false, nullable: false
+
+      field :state_codes, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/eligible_geographical_location_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EligibleGeographicalLocationType
+      extend VitableConnect::Internal::Types::Enum
+
+      ALL = "All"
+      STATE_CODES = "StateCodes"
+    end
+  end
+end

data/lib/VitableConnect/types/employee.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class Employee < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :member_id, -> { String }, optional: true, nullable: false
+
+      field :employer_id, -> { String }, optional: true, nullable: false
+
+      field :reference_id, -> { String }, optional: true, nullable: false
+
+      field :employer_name, -> { String }, optional: true, nullable: false
+
+      field :first_name, -> { String }, optional: false, nullable: false
+
+      field :last_name, -> { String }, optional: false, nullable: false
+
+      field :suffix, -> { String }, optional: true, nullable: false
+
+      field :email, -> { String }, optional: false, nullable: false
+
+      field :date_of_birth, -> { String }, optional: false, nullable: false
+
+      field :gender, -> { String }, optional: true, nullable: false
+
+      field :phone, -> { String }, optional: true, nullable: false
+
+      field :employee_class, -> { VitableConnect::Types::EmployeeClass }, optional: false, nullable: false
+
+      field :status, -> { VitableConnect::Types::EmployeeStatus }, optional: true, nullable: false
+
+      field :start_date, -> { String }, optional: true, nullable: false
+
+      field :classification_effective_date, -> { String }, optional: true, nullable: false
+
+      field :compensation_type, -> { VitableConnect::Types::CompensationType }, optional: true, nullable: false
+
+      field :compensation_type_effective_date, -> { String }, optional: true, nullable: false
+
+      field :termination_date, -> { String }, optional: true, nullable: false
+
+      field :address, -> { VitableConnect::Types::EmployeeAddress }, optional: true, nullable: false
+
+      field :deductions, -> { Internal::Types::Array[VitableConnect::Types::DeductionDetail] }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employee_address.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EmployeeAddress < Internal::Types::Model
+      field :address_line1, -> { String }, optional: false, nullable: false, api_name: "address_line_1"
+
+      field :address_line2, -> { String }, optional: true, nullable: false, api_name: "address_line_2"
+
+      field :city, -> { String }, optional: false, nullable: false
+
+      field :state, -> { String }, optional: false, nullable: false
+
+      field :zipcode, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employee_address_input.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EmployeeAddressInput < Internal::Types::Model
+      field :street1, -> { String }, optional: false, nullable: false, api_name: "street_1"
+
+      field :street2, -> { String }, optional: true, nullable: false, api_name: "street_2"
+
+      field :city, -> { String }, optional: false, nullable: false
+
+      field :state, -> { String }, optional: false, nullable: false
+
+      field :zip_code, -> { String }, optional: false, nullable: false
+
+      field :country, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employee_class.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EmployeeClass
+      extend VitableConnect::Internal::Types::Enum
+
+      FULL_TIME = "Full Time"
+      PART_TIME = "Part Time"
+      TEMPORARY = "Temporary"
+      INTERN = "Intern"
+      SEASONAL = "Seasonal"
+      INDIVIDUAL_CONTRACTOR = "Individual Contractor"
+    end
+  end
+end

data/lib/VitableConnect/types/employee_id.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EmployeeID
+      # EmployeeID is an alias for String
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/VitableConnect/types/employee_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Paginated list response containing employee resources.
+    class EmployeeListResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::Employee] }, optional: false, nullable: false
+
+      field :pagination, -> { VitableConnect::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employee_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Response containing a single employee resource.
+    class EmployeeResponse < Internal::Types::Model
+      field :data, -> { VitableConnect::Types::Employee }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employee_search.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EmployeeSearch
+      # EmployeeSearch is an alias for String
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/VitableConnect/types/employee_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EmployeeStatus
+      extend VitableConnect::Internal::Types::Enum
+
+      ACTIVE = "active"
+      TERMINATED = "terminated"
+    end
+  end
+end

data/lib/VitableConnect/types/employer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Serializer for Employer entity in public API responses.
+    class Employer < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :organization_id, -> { String }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :legal_name, -> { String }, optional: false, nullable: false
+
+      field :ein, -> { String }, optional: true, nullable: false
+
+      field :reference_id, -> { String }, optional: true, nullable: false
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :phone_number, -> { String }, optional: true, nullable: false
+
+      field :active, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :address, -> { VitableConnect::Types::EmployerAddress }, optional: false, nullable: false
+
+      field :contact, -> { VitableConnect::Types::EmployerContact }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_address.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Nested address within EmployerSerializer.
+    class EmployerAddress < Internal::Types::Model
+      field :address_line1, -> { String }, optional: false, nullable: false, api_name: "address_line_1"
+
+      field :address_line2, -> { String }, optional: true, nullable: false, api_name: "address_line_2"
+
+      field :city, -> { String }, optional: false, nullable: false
+
+      field :state, -> { String }, optional: false, nullable: false
+
+      field :zipcode, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_address_input.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EmployerAddressInput < Internal::Types::Model
+      field :address_line1, -> { String }, optional: false, nullable: false, api_name: "address_line_1"
+
+      field :address_line2, -> { String }, optional: true, nullable: false, api_name: "address_line_2"
+
+      field :city, -> { String }, optional: false, nullable: false
+
+      field :state, -> { String }, optional: false, nullable: false
+
+      field :zipcode, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_benefit_lifecycle_stage.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EmployerBenefitLifecycleStage < Internal::Types::Model
+      field :stage, -> { String }, optional: false, nullable: false
+
+      field :as_of_date, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/employer_benefit_plan_year_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Response containing a single employer benefit plan year resource.
+    class EmployerBenefitPlanYearResponse < Internal::Types::Model
+      field :data, -> { VitableConnect::Types::BenefitPlanYearDetail }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_benefit_plan_years_list_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EmployerBenefitPlanYearsListResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::BenefitPlanYearList] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_contact.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Primary company-admin contact (email + phone; company admins have no person name).
+    class EmployerContact < Internal::Types::Model
+      field :email, -> { String }, optional: false, nullable: true
+
+      field :phone, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/employer_hris.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EmployerHris < Internal::Types::Model
+      field :hris, -> { VitableConnect::Types::HrisConnection }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/employer_hris_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Response containing a single employer hris resource.
+    class EmployerHrisResponse < Internal::Types::Model
+      field :data, -> { VitableConnect::Types::EmployerHris }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_hris_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EmployerHrisStatus < Internal::Types::Model
+      field :provider, -> { String }, optional: false, nullable: false
+
+      field :provider_label, -> { String }, optional: false, nullable: false
+
+      field :status, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_id.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EmployerID
+      # EmployerID is an alias for String
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/VitableConnect/types/employer_invoice_pdf.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EmployerInvoicePdf < Internal::Types::Model
+      field :download_url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_invoice_pdf_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Response containing a single employer invoice pdf resource.
+    class EmployerInvoicePdfResponse < Internal::Types::Model
+      field :data, -> { VitableConnect::Types::EmployerInvoicePdf }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_invoices_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Cursor-paginated invoices envelope: ``{ "data": [...], "pagination": { "next_offset": ... } }``.
+    class EmployerInvoicesListResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::Invoice] }, optional: false, nullable: false
+
+      field :pagination, -> { VitableConnect::Types::InvoicesCursorPagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_payroll_deduction_statement_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Paginated list response containing employer payroll deduction statement resources.
+    class EmployerPayrollDeductionStatementListResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::PayrollDeductionStatement] }, optional: false, nullable: false
+
+      field :pagination, -> { VitableConnect::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/employer_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Response containing a single employer resource.
+    class EmployerResponse < Internal::Types::Model
+      field :data, -> { VitableConnect::Types::Employer }, optional: false, nullable: false
+    end
+  end
+end