vitable-connect 0.6.0 → 1.0.0

data/lib/vitable_connect/models/employee_update_params.rb

@@ -1,185 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,189 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    class Employer < VitableConnect::Internal::Type::BaseModel
-      # @!attribute active
-      #   Whether the employer is currently active in the system
-      #
-      #   @return [Boolean]
-      required :active, VitableConnect::Internal::Type::Boolean
-
-      # @!attribute address
-      #   Nested address within EmployerSerializer.
-      #
-      #   @return [VitableConnect::Models::Employer::Address]
-      required :address, -> { VitableConnect::Employer::Address }
-
-      # @!attribute created_at
-      #   Timestamp when the employer was created
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute legal_name
-      #   Legal business name for compliance and tax purposes
-      #
-      #   @return [String]
-      required :legal_name, String
-
-      # @!attribute name
-      #   Display name of the employer
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute updated_at
-      #   Timestamp when the employer was last updated
-      #
-      #   @return [Time]
-      required :updated_at, Time
-
-      # @!attribute email
-      #   Email address for billing and communications
-      #
-      #   @return [String, nil]
-      optional :email, String, nil?: true
-
-      # @!attribute phone_number
-      #   Employer phone number (E.164 format recommended)
-      #
-      #   @return [String, nil]
-      optional :phone_number, String, nil?: true
-
-      # @!attribute reference_id
-      #   Partner-assigned reference ID for the employer
-      #
-      #   @return [String, nil]
-      optional :reference_id, String, nil?: true
-
-      response_only do
-        # @!attribute id
-        #   Unique employer identifier with 'empr\_' prefix
-        #
-        #   @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)
-        #
-        #   @return [String, nil]
-        required :ein, String, nil?: true
-
-        # @!attribute organization_id
-        #   ID of the parent organization (org\_\*)
-        #
-        #   @return [String, nil]
-        required :organization_id, String, nil?: true
-      end
-
-      # @!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
-      #
-      #   @param active [Boolean] Whether the employer is currently active in the system
-      #
-      #   @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)
-      #
-      #   @param legal_name [String] Legal business name for compliance and tax purposes
-      #
-      #   @param name [String] Display name of the employer
-      #
-      #   @param organization_id [String, nil] ID of the parent organization (org\_\*)
-      #
-      #   @param updated_at [Time] Timestamp when the employer was last updated
-      #
-      #   @param email [String, nil] Email address for billing and communications
-      #
-      #   @param phone_number [String, nil] Employer phone number (E.164 format recommended)
-      #
-      #   @param reference_id [String, nil] Partner-assigned reference ID for the employer
-
-      # @see VitableConnect::Models::Employer#address
-      class Address < VitableConnect::Internal::Type::BaseModel
-        # @!attribute address_line_1
-        #   Primary street address
-        #
-        #   @return [String]
-        required :address_line_1, String
-
-        # @!attribute city
-        #   City name
-        #
-        #   @return [String]
-        required :city, String
-
-        # @!attribute state
-        #   Two-letter state code (e.g., CA, NY)
-        #
-        #   @return [String]
-        required :state, String
-
-        # @!attribute zipcode
-        #   ZIP code (5 or 9 digit)
-        #
-        #   @return [String]
-        required :zipcode, String
-
-        # @!attribute address_line_2
-        #   Secondary street address (apt, suite, etc.)
-        #
-        #   @return [String, nil]
-        optional :address_line_2, String, nil?: true
-
-        # @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
-        #   Nested address within EmployerSerializer.
-        #
-        #   @param address_line_1 [String] Primary street address
-        #
-        #   @param city [String] City name
-        #
-        #   @param state [String] Two-letter state code (e.g., CA, NY)
-        #
-        #   @param zipcode [String] ZIP code (5 or 9 digit)
-        #
-        #   @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_create_params.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Employers#create
-    class EmployerCreateParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute address
-      #   Employer address
-      #
-      #   @return [VitableConnect::Models::EmployerCreateParams::Address]
-      required :address, -> { VitableConnect::EmployerCreateParams::Address }
-
-      # @!attribute ein
-      #   Employer Identification Number (format: XX-XXXXXXX)
-      #
-      #   @return [String]
-      required :ein, String
-
-      # @!attribute email
-      #   Email address for billing and communications
-      #
-      #   @return [String]
-      required :email, String
-
-      # @!attribute legal_name
-      #   Legal business name
-      #
-      #   @return [String]
-      required :legal_name, String
-
-      # @!attribute name
-      #   Employer display name
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute phone_number
-      #   Employer phone number (10-digit US format, e.g. 5551234567)
-      #
-      #   @return [String, nil]
-      optional :phone_number, String, nil?: true
-
-      # @!attribute reference_id
-      #   External reference ID for this employer
-      #
-      #   @return [String, nil]
-      optional :reference_id, String, nil?: true
-
-      # @!method initialize(address:, ein:, email:, legal_name:, name:, phone_number: nil, reference_id: nil, request_options: {})
-      #   @param address [VitableConnect::Models::EmployerCreateParams::Address] Employer address
-      #
-      #   @param ein [String] Employer Identification Number (format: XX-XXXXXXX)
-      #
-      #   @param email [String] Email address for billing and communications
-      #
-      #   @param legal_name [String] Legal business name
-      #
-      #   @param name [String] Employer display name
-      #
-      #   @param phone_number [String, nil] Employer phone number (10-digit US format, e.g. 5551234567)
-      #
-      #   @param reference_id [String, nil] External reference ID for this employer
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-
-      class Address < VitableConnect::Internal::Type::BaseModel
-        # @!attribute address_line_1
-        #   Primary street address
-        #
-        #   @return [String]
-        required :address_line_1, String
-
-        # @!attribute city
-        #   City name
-        #
-        #   @return [String]
-        required :city, String
-
-        # @!attribute state
-        #   Two-letter state code
-        #
-        #   @return [String]
-        required :state, String
-
-        # @!attribute zipcode
-        #   ZIP code
-        #
-        #   @return [String]
-        required :zipcode, String
-
-        # @!attribute address_line_2
-        #   Secondary street address
-        #
-        #   @return [String, nil]
-        optional :address_line_2, String, nil?: true
-
-        # @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
-        #   Employer address
-        #
-        #   @param address_line_1 [String] Primary street address
-        #
-        #   @param city [String] City name
-        #
-        #   @param state [String] Two-letter state code
-        #
-        #   @param zipcode [String] ZIP code
-        #
-        #   @param address_line_2 [String, nil] Secondary street address
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/employer_ensure_payroll_integration_email_params.rb

@@ -1,22 +0,0 @@
-# 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

@@ -1,29 +0,0 @@
-# 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

@@ -1,80 +0,0 @@
-# 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