vitable-connect 0.5.0 → 0.6.0

data/lib/vitable_connect/models/employee_update_params.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employees#update
+    class EmployeeUpdateParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      # @!attribute employee_id
+      #   Unique employee identifier (empl\_\*)
+      #
+      #   @return [String]
+      required :employee_id, String
+
+      # @!attribute effective_date
+      #   Past or present date applied to each tracked employment field included in this
+      #   request
+      #
+      #   @return [Date]
+      required :effective_date, Date
+
+      # @!attribute address
+      #   Employee's residential address
+      #
+      #   @return [VitableConnect::Models::EmployeeUpdateParams::Address, nil]
+      optional :address, -> { VitableConnect::EmployeeUpdateParams::Address }, nil?: true
+
+      # @!attribute compensation_type
+      #   - `Salary` - Salary
+      #   - `Hourly` - Hourly
+      #
+      #   @return [Symbol, VitableConnect::Models::EmployeeUpdateParams::CompensationType, nil]
+      optional :compensation_type,
+               enum: -> { VitableConnect::EmployeeUpdateParams::CompensationType },
+               nil?: true
+
+      # @!attribute email
+      #   Email address
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute employee_class
+      #   - `Full Time` - Full Time
+      #   - `Part Time` - Part Time
+      #   - `Temporary` - Temporary
+      #   - `Intern` - Intern
+      #   - `Seasonal` - Seasonal
+      #   - `Individual Contractor` - Individual Contractor
+      #
+      #   @return [Symbol, VitableConnect::Models::EmployeeClass, nil]
+      optional :employee_class, enum: -> { VitableConnect::EmployeeClass }, nil?: true
+
+      # @!attribute gender
+      #   - `Male` - Male
+      #   - `Female` - Female
+      #   - `Transgender` - Transgender
+      #   - `Non-binary` - Non-binary
+      #   - `Prefer not to respond` - Prefer not to respond
+      #
+      #   @return [Symbol, VitableConnect::Models::EmployeeUpdateParams::Gender, nil]
+      optional :gender, enum: -> { VitableConnect::EmployeeUpdateParams::Gender }, nil?: true
+
+      # @!attribute phone
+      #   Phone number
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!attribute start_date
+      #   Employment start date
+      #
+      #   @return [Date, nil]
+      optional :start_date, Date, nil?: true
+
+      # @!method initialize(employee_id:, effective_date:, address: nil, compensation_type: nil, email: nil, employee_class: nil, gender: nil, phone: nil, start_date: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {VitableConnect::Models::EmployeeUpdateParams} for more details.
+      #
+      #   @param employee_id [String] Unique employee identifier (empl\_\*)
+      #
+      #   @param effective_date [Date] Past or present date applied to each tracked employment field included in this r
+      #
+      #   @param address [VitableConnect::Models::EmployeeUpdateParams::Address, nil] Employee's residential address
+      #
+      #   @param compensation_type [Symbol, VitableConnect::Models::EmployeeUpdateParams::CompensationType, nil] - `Salary` - Salary
+      #
+      #   @param email [String, nil] Email address
+      #
+      #   @param employee_class [Symbol, VitableConnect::Models::EmployeeClass, nil] - `Full Time` - Full Time
+      #
+      #   @param gender [Symbol, VitableConnect::Models::EmployeeUpdateParams::Gender, nil] - `Male` - Male
+      #
+      #   @param phone [String, nil] Phone number
+      #
+      #   @param start_date [Date, nil] Employment start date
+      #
+      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
+
+      class Address < VitableConnect::Internal::Type::BaseModel
+        # @!attribute city
+        #   City name
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute state
+        #   Two-letter state code
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!attribute street_1
+        #   Primary street address
+        #
+        #   @return [String]
+        required :street_1, String
+
+        # @!attribute zip_code
+        #   ZIP code
+        #
+        #   @return [String]
+        required :zip_code, String
+
+        # @!attribute country
+        #   Country code
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute street_2
+        #   Secondary street address
+        #
+        #   @return [String, nil]
+        optional :street_2, String, nil?: true
+
+        # @!method initialize(city:, state:, street_1:, zip_code:, country: nil, street_2: nil)
+        #   Employee's residential address
+        #
+        #   @param city [String] City name
+        #
+        #   @param state [String] Two-letter state code
+        #
+        #   @param street_1 [String] Primary street address
+        #
+        #   @param zip_code [String] ZIP code
+        #
+        #   @param country [String] Country code
+        #
+        #   @param street_2 [String, nil] Secondary street address
+      end
+
+      # - `Salary` - Salary
+      # - `Hourly` - Hourly
+      module CompensationType
+        extend VitableConnect::Internal::Type::Enum
+
+        SALARY = :Salary
+        HOURLY = :Hourly
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # - `Male` - Male
+      # - `Female` - Female
+      # - `Transgender` - Transgender
+      # - `Non-binary` - Non-binary
+      # - `Prefer not to respond` - Prefer not to respond
+      module Gender
+        extend VitableConnect::Internal::Type::Enum
+
+        MALE = :Male
+        FEMALE = :Female
+        TRANSGENDER = :Transgender
+        NON_BINARY = :"Non-binary"
+        PREFER_NOT_TO_RESPOND = :"Prefer not to respond"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/employee_update_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employees#update
+    class EmployeeUpdateResponse < VitableConnect::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [VitableConnect::Models::Employee]
+      required :data, -> { VitableConnect::Employee }
+
+      # @!method initialize(data:)
+      #   Response containing a single employee resource.
+      #
+      #   @param data [VitableConnect::Models::Employee]
+    end
+  end
+end

data/lib/vitable_connect/models/employer.rb

@@ -2,7 +2,6 @@
 
 module VitableConnect
   module Models
-    # @see VitableConnect::Resources::Employers#list
     class Employer < VitableConnect::Internal::Type::BaseModel
       # @!attribute active
       #   Whether the employer is currently active in the system
@@ -65,6 +64,13 @@ module VitableConnect
         #   @return [String]
         required :id, String
 
+        # @!attribute contact
+        #   Primary company-admin contact (email + phone; company admins have no person
+        #   name).
+        #
+        #   @return [VitableConnect::Models::Employer::Contact, nil]
+        required :contact, -> { VitableConnect::Employer::Contact }, nil?: true
+
         # @!attribute ein
         #   Employer Identification Number (masked in responses)
         #
@@ -78,7 +84,10 @@ module VitableConnect
         required :organization_id, String, nil?: true
       end
 
-      # @!method initialize(id:, active:, address:, created_at:, ein:, legal_name:, name:, organization_id:, updated_at:, email: nil, phone_number: nil, reference_id: nil)
+      # @!method initialize(id:, active:, address:, contact:, created_at:, ein:, legal_name:, name:, organization_id:, updated_at:, email: nil, phone_number: nil, reference_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {VitableConnect::Models::Employer} for more details.
+      #
       #   Serializer for Employer entity in public API responses.
       #
       #   @param id [String] Unique employer identifier with 'empr\_' prefix
@@ -87,6 +96,8 @@ module VitableConnect
       #
       #   @param address [VitableConnect::Models::Employer::Address] Nested address within EmployerSerializer.
       #
+      #   @param contact [VitableConnect::Models::Employer::Contact, nil] Primary company-admin contact (email + phone; company admins have no person name
+      #
       #   @param created_at [Time] Timestamp when the employer was created
       #
       #   @param ein [String, nil] Employer Identification Number (masked in responses)
@@ -150,6 +161,29 @@ module VitableConnect
         #
         #   @param address_line_2 [String, nil] Secondary street address (apt, suite, etc.)
       end
+
+      # @see VitableConnect::Models::Employer#contact
+      class Contact < VitableConnect::Internal::Type::BaseModel
+        # @!attribute email
+        #   Primary contact email
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!attribute phone
+        #   Primary contact phone, or null
+        #
+        #   @return [String, nil]
+        required :phone, String, nil?: true
+
+        # @!method initialize(email:, phone:)
+        #   Primary company-admin contact (email + phone; company admins have no person
+        #   name).
+        #
+        #   @param email [String, nil] Primary contact email
+        #
+        #   @param phone [String, nil] Primary contact phone, or null
+      end
     end
   end
 end

data/lib/vitable_connect/models/employer_ensure_payroll_integration_email_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employers#ensure_payroll_integration_email
+    class EmployerEnsurePayrollIntegrationEmailParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      # @!attribute employer_id
+      #   Unique employer identifier (empr\_\*)
+      #
+      #   @return [String]
+      required :employer_id, String
+
+      # @!method initialize(employer_id:, request_options: {})
+      #   @param employer_id [String] Unique employer identifier (empr\_\*)
+      #
+      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/vitable_connect/models/employer_ensure_payroll_integration_email_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employers#ensure_payroll_integration_email
+    class EmployerEnsurePayrollIntegrationEmailResponse < VitableConnect::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [VitableConnect::Models::EmployerEnsurePayrollIntegrationEmailResponse::Data]
+      required :data, -> { VitableConnect::Models::EmployerEnsurePayrollIntegrationEmailResponse::Data }
+
+      # @!method initialize(data:)
+      #   Response containing a single payroll integration email resource.
+      #
+      #   @param data [VitableConnect::Models::EmployerEnsurePayrollIntegrationEmailResponse::Data]
+
+      # @see VitableConnect::Models::EmployerEnsurePayrollIntegrationEmailResponse#data
+      class Data < VitableConnect::Internal::Type::BaseModel
+        # @!attribute integration_email
+        #
+        #   @return [String]
+        required :integration_email, String
+
+        # @!method initialize(integration_email:)
+        #   @param integration_email [String]
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/employer_list_benefit_plan_year_enrollments_params.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employers#list_benefit_plan_year_enrollments
+    class EmployerListBenefitPlanYearEnrollmentsParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      # @!attribute employer_id
+      #   Unique employer identifier (empr\_\*)
+      #
+      #   @return [String]
+      required :employer_id, String
+
+      # @!attribute benefit_plan_year_id
+      #   Unique benefit-plan-year identifier (plyr\_\*).
+      #
+      #   @return [String]
+      required :benefit_plan_year_id, String
+
+      # @!attribute election_status
+      #   Filter by election status. Repeat the parameter to match several.
+      #
+      #   @return [Array<Symbol, VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsParams::ElectionStatus>, nil]
+      optional :election_status,
+               -> { VitableConnect::Internal::Type::ArrayOf[enum: VitableConnect::EmployerListBenefitPlanYearEnrollmentsParams::ElectionStatus] }
+
+      # @!attribute limit
+      #   Items per page (default: 20, max: 100)
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute page
+      #   Page number (default: 1)
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute search
+      #   Case-insensitive search. Matches member name partially, and the `member_id`
+      #   exactly — either your own reference id or the prefixed `grpmbr_<...>` id.
+      #
+      #   @return [String, nil]
+      optional :search, String
+
+      # @!method initialize(employer_id:, benefit_plan_year_id:, election_status: nil, limit: nil, page: nil, search: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsParams} for more
+      #   details.
+      #
+      #   @param employer_id [String] Unique employer identifier (empr\_\*)
+      #
+      #   @param benefit_plan_year_id [String] Unique benefit-plan-year identifier (plyr\_\*).
+      #
+      #   @param election_status [Array<Symbol, VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsParams::ElectionStatus>] Filter by election status. Repeat the parameter to match several.
+      #
+      #   @param limit [Integer] Items per page (default: 20, max: 100)
+      #
+      #   @param page [Integer] Page number (default: 1)
+      #
+      #   @param search [String] Case-insensitive search. Matches member name partially, and the `member_id` exac
+      #
+      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
+
+      module ElectionStatus
+        extend VitableConnect::Internal::Type::Enum
+
+        ENROLLED = :Enrolled
+        EXPIRED = :Expired
+        PENDING = :Pending
+        WAIVED = :Waived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/employer_list_benefit_plan_year_enrollments_response.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employers#list_benefit_plan_year_enrollments
+    class EmployerListBenefitPlanYearEnrollmentsResponse < VitableConnect::Internal::Type::BaseModel
+      # @!attribute carrier
+      #   The carrier for this enrollment: the individual-market carrier for an ICHRA
+      #   plan, otherwise the benefit's own. Null when the benefit has no carrier.
+      #
+      #   @return [String, nil]
+      required :carrier, String, nil?: true
+
+      # @!attribute dependent_count
+      #   Dependents covered under this enrollment today. Counts the same dependents
+      #   `premium_in_cents` is priced for, so a dependent whose termination is dated in
+      #   the future still counts.
+      #
+      #   @return [Integer]
+      required :dependent_count, Integer
+
+      # @!attribute election_status
+      #   - `Enrolled` - Enrolled
+      #   - `Waived` - Waived
+      #   - `Pending` - Pending
+      #   - `Expired` - Expired
+      #
+      #   @return [Symbol, VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse::ElectionStatus]
+      required :election_status,
+               enum: -> { VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse::ElectionStatus }
+
+      # @!attribute employee_deduction_in_cents
+      #   What the employee is deducted monthly, in cents: `premium_in_cents` less
+      #   `employer_contribution_in_cents`, floored at zero. Null when unanswered/waived.
+      #
+      #   @return [Integer, nil]
+      required :employee_deduction_in_cents, Integer, nil?: true
+
+      # @!attribute employee_external_reference_id
+      #   Your own reference id for this employee, as you supplied it. Null when you have
+      #   not set one.
+      #
+      #   @return [String, nil]
+      required :employee_external_reference_id, String, nil?: true
+
+      # @!attribute employee_id
+      #   Our id for this person's employment with this employer (`empl_<...>`). A person
+      #   who leaves and is rehired has two.
+      #
+      #   @return [String]
+      required :employee_id, String
+
+      # @!attribute employer_contribution_in_cents
+      #   The employer's monthly share of `premium_in_cents`, in cents. Null when
+      #   unanswered/waived.
+      #
+      #   @return [Integer, nil]
+      required :employer_contribution_in_cents, Integer, nil?: true
+
+      # @!attribute member_first_name
+      #   The member's first name.
+      #
+      #   @return [String]
+      required :member_first_name, String
+
+      # @!attribute member_id
+      #   Our id for the person (`mbr_<...>`). Stable across every employer they work for.
+      #
+      #   @return [String]
+      required :member_id, String
+
+      # @!attribute member_last_name
+      #   The member's last name.
+      #
+      #   @return [String]
+      required :member_last_name, String
+
+      # @!attribute plan
+      #   Chosen plan name, or null when unanswered/waived.
+      #
+      #   @return [String, nil]
+      required :plan, String, nil?: true
+
+      # @!attribute policy_status
+      #   - `Coverage Upcoming` - Coverage Upcoming
+      #   - `Coverage Effective` - Coverage Effective
+      #   - `Coverage Ended` - Coverage Ended
+      #
+      #   @return [Symbol, VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse::PolicyStatus, nil]
+      required :policy_status,
+               enum: -> { VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse::PolicyStatus },
+               nil?: true
+
+      # @!attribute premium_in_cents
+      #   Monthly premium in cents for the chosen plan, dependents included. The plan's
+      #   own cost, not the employer's share of it. Null when unanswered/waived.
+      #
+      #   @return [Integer, nil]
+      required :premium_in_cents, Integer, nil?: true
+
+      # @!attribute tier
+      #   Chosen coverage tier, or null when unanswered/waived.
+      #
+      #   @return [String, nil]
+      required :tier, String, nil?: true
+
+      # @!method initialize(carrier:, dependent_count:, election_status:, employee_deduction_in_cents:, employee_external_reference_id:, employee_id:, employer_contribution_in_cents:, member_first_name:, member_id:, member_last_name:, plan:, policy_status:, premium_in_cents:, tier:)
+      #   Some parameter documentations has been truncated, see
+      #   {VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse} for
+      #   more details.
+      #
+      #   @param carrier [String, nil] The carrier for this enrollment: the individual-market carrier for an ICHRA plan
+      #
+      #   @param dependent_count [Integer] Dependents covered under this enrollment today. Counts the same dependents `prem
+      #
+      #   @param election_status [Symbol, VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse::ElectionStatus] - `Enrolled` - Enrolled
+      #
+      #   @param employee_deduction_in_cents [Integer, nil] What the employee is deducted monthly, in cents: `premium_in_cents` less `employ
+      #
+      #   @param employee_external_reference_id [String, nil] Your own reference id for this employee, as you supplied it. Null when you have
+      #
+      #   @param employee_id [String] Our id for this person's employment with this employer (`empl_<...>`). A person
+      #
+      #   @param employer_contribution_in_cents [Integer, nil] The employer's monthly share of `premium_in_cents`, in cents. Null when unanswer
+      #
+      #   @param member_first_name [String] The member's first name.
+      #
+      #   @param member_id [String] Our id for the person (`mbr_<...>`). Stable across every employer they work for.
+      #
+      #   @param member_last_name [String] The member's last name.
+      #
+      #   @param plan [String, nil] Chosen plan name, or null when unanswered/waived.
+      #
+      #   @param policy_status [Symbol, VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse::PolicyStatus, nil] - `Coverage Upcoming` - Coverage Upcoming
+      #
+      #   @param premium_in_cents [Integer, nil] Monthly premium in cents for the chosen plan, dependents included. The plan's ow
+      #
+      #   @param tier [String, nil] Chosen coverage tier, or null when unanswered/waived.
+
+      # - `Enrolled` - Enrolled
+      # - `Waived` - Waived
+      # - `Pending` - Pending
+      # - `Expired` - Expired
+      #
+      # @see VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse#election_status
+      module ElectionStatus
+        extend VitableConnect::Internal::Type::Enum
+
+        ENROLLED = :Enrolled
+        WAIVED = :Waived
+        PENDING = :Pending
+        EXPIRED = :Expired
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # - `Coverage Upcoming` - Coverage Upcoming
+      # - `Coverage Effective` - Coverage Effective
+      # - `Coverage Ended` - Coverage Ended
+      #
+      # @see VitableConnect::Models::EmployerListBenefitPlanYearEnrollmentsResponse#policy_status
+      module PolicyStatus
+        extend VitableConnect::Internal::Type::Enum
+
+        COVERAGE_UPCOMING = :"Coverage Upcoming"
+        COVERAGE_EFFECTIVE = :"Coverage Effective"
+        COVERAGE_ENDED = :"Coverage Ended"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/employer_list_benefit_plan_years_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employers#list_benefit_plan_years
+    class EmployerListBenefitPlanYearsParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      # @!attribute employer_id
+      #   Unique employer identifier (empr\_\*)
+      #
+      #   @return [String]
+      required :employer_id, String
+
+      # @!method initialize(employer_id:, request_options: {})
+      #   @param employer_id [String] Unique employer identifier (empr\_\*)
+      #
+      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end