vitable-connect 0.3.0 → 0.5.0

data/lib/vitable_connect/resources/groups.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Resources
+    class Groups
+      # @return [VitableConnect::Resources::Groups::Members]
+      attr_reader :members
+
+      # Creates a new group scoped to the authenticated organization.
+      #
+      # @overload create(external_reference_id:, name:, request_options: {})
+      #
+      # @param external_reference_id [String]
+      # @param name [String]
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::GroupResponse]
+      #
+      # @see VitableConnect::Models::GroupCreateParams
+      def create(params)
+        parsed, options = VitableConnect::GroupCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/groups",
+          body: parsed,
+          model: VitableConnect::GroupResponse,
+          options: options
+        )
+      end
+
+      # Retrieves a single group by its prefixed ID. Returns 404 if the group does not
+      # belong to the authenticated organization.
+      #
+      # @overload retrieve(group_id, request_options: {})
+      #
+      # @param group_id [String] Unique group identifier (grp\_\*)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::GroupResponse]
+      #
+      # @see VitableConnect::Models::GroupRetrieveParams
+      def retrieve(group_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/groups/%1$s", group_id],
+          model: VitableConnect::GroupResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Partially updates a group's name or external reference ID. Returns 404 if the
+      # group does not belong to the authenticated organization.
+      #
+      # @overload update(group_id, external_reference_id: nil, name: nil, request_options: {})
+      #
+      # @param group_id [String] Unique group identifier (grp\_\*)
+      #
+      # @param external_reference_id [String, nil]
+      #
+      # @param name [String, nil]
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::GroupResponse]
+      #
+      # @see VitableConnect::Models::GroupUpdateParams
+      def update(group_id, params = {})
+        parsed, options = VitableConnect::GroupUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/groups/%1$s", group_id],
+          body: parsed,
+          model: VitableConnect::GroupResponse,
+          options: options
+        )
+      end
+
+      # Returns a paginated list of groups belonging to the authenticated organization.
+      #
+      # @overload list(limit: nil, page: nil, request_options: {})
+      #
+      # @param limit [Integer] Items per page (default: 20, max: 100)
+      #
+      # @param page [Integer] Page number (default: 1)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::Group>]
+      #
+      # @see VitableConnect::Models::GroupListParams
+      def list(params = {})
+        parsed, options = VitableConnect::GroupListParams.dump_request(params)
+        query = VitableConnect::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/groups",
+          query: query,
+          page: VitableConnect::Internal::PageNumberPage,
+          model: VitableConnect::Group,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [VitableConnect::Client]
+      def initialize(client:)
+        @client = client
+        @members = VitableConnect::Resources::Groups::Members.new(client: client)
+      end
+    end
+  end
+end

data/lib/vitable_connect/resources/plans.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Resources
+    class Plans
+      # Returns a paginated list of benefit plans linked to the authenticated
+      # organization.
+      #
+      # @overload list(limit: nil, page: nil, request_options: {})
+      #
+      # @param limit [Integer] Items per page (default: 20, max: 100)
+      #
+      # @param page [Integer] Page number (default: 1)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::PlanListResponse>]
+      #
+      # @see VitableConnect::Models::PlanListParams
+      def list(params = {})
+        parsed, options = VitableConnect::PlanListParams.dump_request(params)
+        query = VitableConnect::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/plans",
+          query: query,
+          page: VitableConnect::Internal::PageNumberPage,
+          model: VitableConnect::Models::PlanListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [VitableConnect::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/vitable_connect/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VitableConnect
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/vitable_connect.rb

@@ -55,16 +55,12 @@ require_relative "vitable_connect/client"
 require_relative "vitable_connect/internal/page_number_page"
 require_relative "vitable_connect/models/auth_issue_access_token_params"
 require_relative "vitable_connect/models/auth_issue_access_token_response"
-require_relative "vitable_connect/models/benefit_eligibility_policy"
-require_relative "vitable_connect/models/benefit_eligibility_policy_response"
-require_relative "vitable_connect/models/benefit_eligibility_policy_retrieve_params"
 require_relative "vitable_connect/models/employee"
 require_relative "vitable_connect/models/employee_class"
 require_relative "vitable_connect/models/employee_list_enrollments_params"
 require_relative "vitable_connect/models/employee_retrieve_params"
 require_relative "vitable_connect/models/employee_retrieve_response"
 require_relative "vitable_connect/models/employer"
-require_relative "vitable_connect/models/employer_create_benefit_eligibility_policy_params"
 require_relative "vitable_connect/models/employer_create_params"
 require_relative "vitable_connect/models/employer_list_employees_params"
 require_relative "vitable_connect/models/employer_list_params"
@@ -72,11 +68,25 @@ require_relative "vitable_connect/models/employer_response"
 require_relative "vitable_connect/models/employer_retrieve_params"
 require_relative "vitable_connect/models/employer_submit_census_sync_params"
 require_relative "vitable_connect/models/employer_submit_census_sync_response"
+require_relative "vitable_connect/models/employer_update_settings_params"
+require_relative "vitable_connect/models/employer_update_settings_response"
 require_relative "vitable_connect/models/enrollment"
 require_relative "vitable_connect/models/enrollment_retrieve_params"
 require_relative "vitable_connect/models/enrollment_retrieve_response"
 require_relative "vitable_connect/models/enrollment_status"
+require_relative "vitable_connect/models/group"
+require_relative "vitable_connect/models/group_create_params"
+require_relative "vitable_connect/models/group_list_params"
+require_relative "vitable_connect/models/group_response"
+require_relative "vitable_connect/models/group_retrieve_params"
+require_relative "vitable_connect/models/groups/members/sync_retrieve_params"
+require_relative "vitable_connect/models/groups/members/sync_retrieve_response"
+require_relative "vitable_connect/models/groups/members/sync_submit_params"
+require_relative "vitable_connect/models/groups/members/sync_submit_response"
+require_relative "vitable_connect/models/group_update_params"
 require_relative "vitable_connect/models/pagination"
+require_relative "vitable_connect/models/plan_list_params"
+require_relative "vitable_connect/models/plan_list_response"
 require_relative "vitable_connect/models/type"
 require_relative "vitable_connect/models/webhook_event"
 require_relative "vitable_connect/models/webhook_event_list_deliveries_params"
@@ -90,4 +100,8 @@ require_relative "vitable_connect/resources/benefit_eligibility_policies"
 require_relative "vitable_connect/resources/employees"
 require_relative "vitable_connect/resources/employers"
 require_relative "vitable_connect/resources/enrollments"
+require_relative "vitable_connect/resources/groups"
+require_relative "vitable_connect/resources/groups/members"
+require_relative "vitable_connect/resources/groups/members/sync"
+require_relative "vitable_connect/resources/plans"
 require_relative "vitable_connect/resources/webhook_events"

data/rbi/vitable_connect/client.rbi

@@ -28,7 +28,6 @@ module VitableConnect
     sig { returns(VitableConnect::Resources::Auth) }
     attr_reader :auth
 
-    # Define rules that determine which employees qualify for benefits
     sig { returns(VitableConnect::Resources::BenefitEligibilityPolicies) }
     attr_reader :benefit_eligibility_policies
 
@@ -45,6 +44,12 @@ module VitableConnect
     sig { returns(VitableConnect::Resources::WebhookEvents) }
     attr_reader :webhook_events
 
+    sig { returns(VitableConnect::Resources::Groups) }
+    attr_reader :groups
+
+    sig { returns(VitableConnect::Resources::Plans) }
+    attr_reader :plans
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/vitable_connect/models/employee.rbi

@@ -25,10 +25,6 @@ module VitableConnect
       sig { returns(String) }
       attr_accessor :email
 
-      # Benefit enrollments for this employee
-      sig { returns(T::Array[VitableConnect::Employee::Enrollment]) }
-      attr_accessor :enrollments
-
       # Employee's legal first name
       sig { returns(String) }
       attr_accessor :first_name
@@ -69,10 +65,6 @@ module VitableConnect
       sig { returns(T.nilable(Date)) }
       attr_accessor :hire_date
 
-      # Phone number (10-digit US domestic string)
-      sig { returns(T.nilable(String)) }
-      attr_accessor :phone
-
       # Partner-assigned reference ID for the employee
       sig { returns(T.nilable(String)) }
       attr_accessor :reference_id
@@ -93,6 +85,10 @@ module VitableConnect
       sig { returns(String) }
       attr_accessor :member_id
 
+      # Phone number (10-digit US domestic string)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
       # Employee status (active or terminated)
       sig { returns(String) }
       attr_accessor :status
@@ -104,17 +100,16 @@ module VitableConnect
           date_of_birth: Date,
           deductions: T::Array[VitableConnect::Employee::Deduction::OrHash],
           email: String,
-          enrollments: T::Array[VitableConnect::Employee::Enrollment::OrHash],
           first_name: String,
           last_name: String,
           member_id: String,
+          phone: T.nilable(String),
           status: String,
           updated_at: Time,
           address: T.nilable(VitableConnect::Employee::Address::OrHash),
           employee_class: T.nilable(VitableConnect::EmployeeClass::OrSymbol),
           gender: T.nilable(String),
           hire_date: T.nilable(Date),
-          phone: T.nilable(String),
           reference_id: T.nilable(String),
           suffix: T.nilable(String),
           termination_date: T.nilable(Date)
@@ -132,14 +127,14 @@ module VitableConnect
         deductions:,
         # Email address
         email:,
-        # Benefit enrollments for this employee
-        enrollments:,
         # Employee's legal first name
         first_name:,
         # Employee's legal last name
         last_name:,
         # Unique member identifier with 'mbr\_' prefix
         member_id:,
+        # Phone number (10-digit US domestic string)
+        phone:,
         # Employee status (active or terminated)
         status:,
         # Timestamp when the employee was last updated
@@ -157,8 +152,6 @@ module VitableConnect
         gender: nil,
         # Employee's hire date with the employer
         hire_date: nil,
-        # Phone number (10-digit US domestic string)
-        phone: nil,
         # Partner-assigned reference ID for the employee
         reference_id: nil,
         # Name suffix (e.g., Jr., Sr., III)
@@ -176,10 +169,10 @@ module VitableConnect
             date_of_birth: Date,
             deductions: T::Array[VitableConnect::Employee::Deduction],
             email: String,
-            enrollments: T::Array[VitableConnect::Employee::Enrollment],
             first_name: String,
             last_name: String,
             member_id: String,
+            phone: T.nilable(String),
             status: String,
             updated_at: Time,
             address: T.nilable(VitableConnect::Employee::Address),
@@ -187,7 +180,6 @@ module VitableConnect
               T.nilable(VitableConnect::EmployeeClass::TaggedSymbol),
             gender: T.nilable(String),
             hire_date: T.nilable(Date),
-            phone: T.nilable(String),
             reference_id: T.nilable(String),
             suffix: T.nilable(String),
             termination_date: T.nilable(Date)
@@ -386,63 +378,6 @@ module VitableConnect
         end
       end
 
-      class Enrollment < VitableConnect::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              VitableConnect::Employee::Enrollment,
-              VitableConnect::Internal::AnyHash
-            )
-          end
-
-        # - `pending` - Pending
-        # - `enrolled` - Enrolled
-        # - `waived` - Waived
-        # - `inactive` - Inactive
-        sig { returns(VitableConnect::EnrollmentStatus::TaggedSymbol) }
-        attr_accessor :status
-
-        # Timestamp when the enrollment decision was made
-        sig { returns(T.nilable(Time)) }
-        attr_accessor :answered_at
-
-        # Unique enrollment identifier with 'enrl\_' prefix
-        sig { returns(String) }
-        attr_accessor :id
-
-        sig do
-          params(
-            id: String,
-            status: VitableConnect::EnrollmentStatus::OrSymbol,
-            answered_at: T.nilable(Time)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Unique enrollment identifier with 'enrl\_' prefix
-          id:,
-          # - `pending` - Pending
-          # - `enrolled` - Enrolled
-          # - `waived` - Waived
-          # - `inactive` - Inactive
-          status:,
-          # Timestamp when the enrollment decision was made
-          answered_at: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              status: VitableConnect::EnrollmentStatus::TaggedSymbol,
-              answered_at: T.nilable(Time)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
       class Address < VitableConnect::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/vitable_connect/models/employer.rbi

@@ -55,10 +55,6 @@ module VitableConnect
       sig { returns(T.nilable(String)) }
       attr_accessor :ein
 
-      # ID of the benefit eligibility policy (epol\_\*), if assigned
-      sig { returns(T.nilable(String)) }
-      attr_accessor :eligibility_policy_id
-
       # ID of the parent organization (org\_\*)
       sig { returns(T.nilable(String)) }
       attr_accessor :organization_id
@@ -71,7 +67,6 @@ module VitableConnect
           address: VitableConnect::Employer::Address::OrHash,
           created_at: Time,
           ein: T.nilable(String),
-          eligibility_policy_id: T.nilable(String),
           legal_name: String,
           name: String,
           organization_id: T.nilable(String),
@@ -92,8 +87,6 @@ module VitableConnect
         created_at:,
         # Employer Identification Number (masked in responses)
         ein:,
-        # ID of the benefit eligibility policy (epol\_\*), if assigned
-        eligibility_policy_id:,
         # Legal business name for compliance and tax purposes
         legal_name:,
         # Display name of the employer
@@ -119,7 +112,6 @@ module VitableConnect
             address: VitableConnect::Employer::Address,
             created_at: Time,
             ein: T.nilable(String),
-            eligibility_policy_id: T.nilable(String),
             legal_name: String,
             name: String,
             organization_id: T.nilable(String),

data/rbi/vitable_connect/models/employer_update_settings_params.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class EmployerUpdateSettingsParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::EmployerUpdateSettingsParams,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      # Unique employer identifier (empr\_\*)
+      sig { returns(String) }
+      attr_accessor :employer_id
+
+      # - `weekly` - weekly
+      # - `bi_weekly` - bi_weekly
+      # - `semi_monthly` - semi_monthly
+      # - `monthly` - monthly
+      sig do
+        returns(
+          VitableConnect::EmployerUpdateSettingsParams::PayFrequency::OrSymbol
+        )
+      end
+      attr_accessor :pay_frequency
+
+      sig do
+        params(
+          employer_id: String,
+          pay_frequency:
+            VitableConnect::EmployerUpdateSettingsParams::PayFrequency::OrSymbol,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique employer identifier (empr\_\*)
+        employer_id:,
+        # - `weekly` - weekly
+        # - `bi_weekly` - bi_weekly
+        # - `semi_monthly` - semi_monthly
+        # - `monthly` - monthly
+        pay_frequency:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            employer_id: String,
+            pay_frequency:
+              VitableConnect::EmployerUpdateSettingsParams::PayFrequency::OrSymbol,
+            request_options: VitableConnect::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # - `weekly` - weekly
+      # - `bi_weekly` - bi_weekly
+      # - `semi_monthly` - semi_monthly
+      # - `monthly` - monthly
+      module PayFrequency
+        extend VitableConnect::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              VitableConnect::EmployerUpdateSettingsParams::PayFrequency
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WEEKLY =
+          T.let(
+            :weekly,
+            VitableConnect::EmployerUpdateSettingsParams::PayFrequency::TaggedSymbol
+          )
+        BI_WEEKLY =
+          T.let(
+            :bi_weekly,
+            VitableConnect::EmployerUpdateSettingsParams::PayFrequency::TaggedSymbol
+          )
+        SEMI_MONTHLY =
+          T.let(
+            :semi_monthly,
+            VitableConnect::EmployerUpdateSettingsParams::PayFrequency::TaggedSymbol
+          )
+        MONTHLY =
+          T.let(
+            :monthly,
+            VitableConnect::EmployerUpdateSettingsParams::PayFrequency::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              VitableConnect::EmployerUpdateSettingsParams::PayFrequency::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/employer_update_settings_response.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class EmployerUpdateSettingsResponse < VitableConnect::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::Models::EmployerUpdateSettingsResponse,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(VitableConnect::Models::EmployerUpdateSettingsResponse::Data)
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data:
+            VitableConnect::Models::EmployerUpdateSettingsResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # Response containing a single employer settings resource.
+      sig do
+        params(
+          data:
+            VitableConnect::Models::EmployerUpdateSettingsResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          { data: VitableConnect::Models::EmployerUpdateSettingsResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < VitableConnect::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              VitableConnect::Models::EmployerUpdateSettingsResponse::Data,
+              VitableConnect::Internal::AnyHash
+            )
+          end
+
+        # - `weekly` - Weekly
+        # - `bi_weekly` - Bi-Weekly
+        # - `semi_monthly` - Semi-Monthly
+        # - `monthly` - Monthly
+        sig do
+          returns(
+            T.nilable(
+              VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :pay_frequency
+
+        sig do
+          params(
+            pay_frequency:
+              T.nilable(
+                VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency::OrSymbol
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # - `weekly` - Weekly
+          # - `bi_weekly` - Bi-Weekly
+          # - `semi_monthly` - Semi-Monthly
+          # - `monthly` - Monthly
+          pay_frequency:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              pay_frequency:
+                T.nilable(
+                  VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency::TaggedSymbol
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # - `weekly` - Weekly
+        # - `bi_weekly` - Bi-Weekly
+        # - `semi_monthly` - Semi-Monthly
+        # - `monthly` - Monthly
+        module PayFrequency
+          extend VitableConnect::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          WEEKLY =
+            T.let(
+              :weekly,
+              VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency::TaggedSymbol
+            )
+          BI_WEEKLY =
+            T.let(
+              :bi_weekly,
+              VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency::TaggedSymbol
+            )
+          SEMI_MONTHLY =
+            T.let(
+              :semi_monthly,
+              VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency::TaggedSymbol
+            )
+          MONTHLY =
+            T.let(
+              :monthly,
+              VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end