vitable-connect 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95073505c09fe79851a300e7809226f73aae321ed396dfaebd55c0a1ed443ba
-  data.tar.gz: dbdbfd8d843f86fcf1fbbc093113794f4d765f7f6c727b42759387741f2aa5f7
+  metadata.gz: 4d04d86c9bf83e95324f9f67db4112f50154df2953ac028c0c51187f7d15dd35
+  data.tar.gz: ded0a148b80bcf67f00c814029bf677cd47992a10e5e8426a23cfae0c20fe55d
 SHA512:
-  metadata.gz: 9839910b5b1614f3b79e7be1e101a1016c8ea7b3faff6f3c346709182fa75a2aed5299fa7d0de6a46bae4c88f5c26460ba3da4d69e6cfd3bd4912b8b247c1164
-  data.tar.gz: 3763f2b619fbb8c838c2834f522be20721891f8b2674a792e4535eda2eb52476a51b36fa2210f4ee0d6957b620e541b148b726419caa73c962e6823dbbf32c20
+  metadata.gz: 6dbe00ee9a908088044efbddd2a4f724b3f34f7c51dc25a7c1754194eb73d5947cf5b85148281a31e2a97a96094aa1becf92ac10aefb409a2db2d8bdb63d7383
+  data.tar.gz: 66f3d6ca4f27d134529a4d782171e07b30cefb0a4f95555ac6c664ee9eb2ba5f61b73379aba7eee7b49b3b5a5f50a4152d39b04b284964791037517bee7812e1

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## 0.6.0 (2026-08-20)
+
+Full Changelog: [v0.5.0...v0.6.0](https://github.com/Vitable-Inc/vitable-connect-ruby/compare/v0.5.0...v0.6.0)
+
+### Features
+
+* **api:** api update ([a8fa255](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/a8fa25571fcc0dfffd2cea62c700c7612837ab0e))
+* **api:** api update ([8ea65ec](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/8ea65ec4ca7cbd824bd8f84757de396be2f2d763))
+* **api:** api update ([e4c0d55](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/e4c0d55037684ff1728c169be424b135470b6a20))
+* **api:** api update ([1313a69](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/1313a69bae839b3507b9c0d99208b7a4a8fb8be3))
+* **api:** api update ([b7c3059](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/b7c3059ddbbf2e0ebb11c45d4666b8e7b15b8cf0))
+* **api:** api update ([1541690](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/1541690e7b4417b0f96fef30ca1cfb3bf501c8a0))
+* **api:** api update ([3cbc2db](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/3cbc2db1c901083f82bcf2cc5033548850a7b7ef))
+* **api:** api update ([87cb259](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/87cb259ac824d9f3132bdbae4cc126113c76f104))
+* **api:** api update ([59ec0e4](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/59ec0e49fcaf2073d7aa8d23f30fa4f66da2dc06))
+* **api:** api update ([d27c533](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/d27c533ad620cce795687476e75da6c6ca58c981))
+* **api:** api update ([9977677](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/99776776cfdda16a6c1d747411f593e6a6604a93))
+* **api:** configure all public v1 endpoints and drop dangling Type model ref ([266eb2d](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/266eb2dbb74bd7691dde067954b6cabb52feece0))
+* **api:** removed benefit policies from api reference ([a030ce5](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/a030ce509786dee1f6c331bd0d74914caaf79b16))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([432db79](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/432db791d9bb609ce1f65cbbe338e41254edf038))
+
+
+### Bug Fixes
+
+* **client:** bind IdentityProviderBearer to an identity_token client option ([d6fa230](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/d6fa230a5b7b4e97e6dde37fd4bc078b1cb7b4a4))
+
+
+### Chores
+
+* **internal:** bound formatter parallelism to CPU count ([fa81169](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/fa811693161dee1bc144df4db95258ca4755ed51))
+
+
+### Refactors
+
+* **api:** drop the IdP session endpoints from the SDK surface ([30a9c2e](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/30a9c2e3724bed64bf808615943e43e7324de9c5))
+
 ## 0.5.0 (2026-06-18)
 
 Full Changelog: [v0.4.0...v0.5.0](https://github.com/Vitable-Inc/vitable-connect-ruby/compare/v0.4.0...v0.5.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "vitable-connect", "~> 0.5.0"
+gem "vitable-connect", "~> 0.6.0"
 ```
 
 <!-- x-release-please-end -->
@@ -229,25 +229,25 @@ vitable_connect.auth.issue_access_token(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :weekly
-puts(VitableConnect::EmployerUpdateSettingsParams::PayFrequency::WEEKLY)
+# :Salary
+puts(VitableConnect::EmployeeUpdateParams::CompensationType::SALARY)
 
-# Revealed type: `T.all(VitableConnect::EmployerUpdateSettingsParams::PayFrequency, Symbol)`
-T.reveal_type(VitableConnect::EmployerUpdateSettingsParams::PayFrequency::WEEKLY)
+# Revealed type: `T.all(VitableConnect::EmployeeUpdateParams::CompensationType, Symbol)`
+T.reveal_type(VitableConnect::EmployeeUpdateParams::CompensationType::SALARY)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-vitable_connect.employers.update_settings(
-  pay_frequency: VitableConnect::EmployerUpdateSettingsParams::PayFrequency::WEEKLY,
+vitable_connect.employees.update(
+  compensation_type: VitableConnect::EmployeeUpdateParams::CompensationType::SALARY,
   # …
 )
 
 # Literal values are also permissible:
-vitable_connect.employers.update_settings(
-  pay_frequency: :weekly,
+vitable_connect.employees.update(
+  compensation_type: :Salary,
   # …
 )
 ```

data/lib/vitable_connect/client.rb

@@ -30,9 +30,6 @@ module VitableConnect
     # @return [VitableConnect::Resources::Auth]
     attr_reader :auth
 
-    # @return [VitableConnect::Resources::BenefitEligibilityPolicies]
-    attr_reader :benefit_eligibility_policies
-
     # @return [VitableConnect::Resources::Employees]
     attr_reader :employees
 
@@ -49,13 +46,29 @@ module VitableConnect
     # @return [VitableConnect::Resources::Groups]
     attr_reader :groups
 
+    # Browse the members covered across your book and read a member's profile
+    # @return [VitableConnect::Resources::Members]
+    attr_reader :members
+
+    # @return [VitableConnect::Resources::Organizations]
+    attr_reader :organizations
+
     # @return [VitableConnect::Resources::Plans]
     attr_reader :plans
 
+    # @api private
+    #
+    # @param security [Hash{Symbol=>Boolean}]
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers(security:)
+      {api_key_auth:}.slice(*security.keys).values.reduce({}, :merge)
+    end
+
     # @api private
     #
     # @return [Hash{String=>String}]
-    private def auth_headers
+    private def api_key_auth
       return {} if @api_key.nil?
 
       {"authorization" => "Bearer #{@api_key}"}
@@ -127,12 +140,13 @@ module VitableConnect
       )
 
       @auth = VitableConnect::Resources::Auth.new(client: self)
-      @benefit_eligibility_policies = VitableConnect::Resources::BenefitEligibilityPolicies.new(client: self)
       @employees = VitableConnect::Resources::Employees.new(client: self)
       @employers = VitableConnect::Resources::Employers.new(client: self)
       @enrollments = VitableConnect::Resources::Enrollments.new(client: self)
       @webhook_events = VitableConnect::Resources::WebhookEvents.new(client: self)
       @groups = VitableConnect::Resources::Groups.new(client: self)
+      @members = VitableConnect::Resources::Members.new(client: self)
+      @organizations = VitableConnect::Resources::Organizations.new(client: self)
       @plans = VitableConnect::Resources::Plans.new(client: self)
     end
   end

data/lib/vitable_connect/internal/transport/base_client.rb

@@ -31,7 +31,19 @@ module VitableConnect
           #
           # @raise [ArgumentError]
           def validate!(req)
-            keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :stream, :model, :options]
+            keys = [
+              :method,
+              :path,
+              :query,
+              :headers,
+              :body,
+              :unwrap,
+              :page,
+              :stream,
+              :model,
+              :security,
+              :options
+            ]
             case req
             in Hash
               req.each_key do |k|
@@ -252,6 +264,8 @@ module VitableConnect
         #
         #   @option req [VitableConnect::Internal::Type::Converter, Class, nil] :model
         #
+        #   @option req [Hash{Symbol=>Boolean}, nil] :security
+        #
         # @param opts [Hash{Symbol=>Object}] .
         #
         #   @option opts [String, nil] :idempotency_key
@@ -276,7 +290,11 @@ module VitableConnect
 
           headers = VitableConnect::Internal::Util.normalized_headers(
             @headers,
-            auth_headers,
+            auth_headers(
+              security: req.fetch(
+                :security, {api_key_auth: true}
+              )
+            ),
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )
@@ -448,7 +466,7 @@ module VitableConnect
         # Execute the request specified by `req`. This is the method that all resource
         # methods call into.
         #
-        # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: VitableConnect::Internal::Type::Unknown, options: {})
+        # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: VitableConnect::Internal::Type::Unknown, security: {api_key_auth: true}, options: {})
         #
         # @param method [Symbol]
         #
@@ -468,6 +486,8 @@ module VitableConnect
         #
         # @param model [VitableConnect::Internal::Type::Converter, Class, nil]
         #
+        # @param security [Hash{Symbol=>Boolean}, nil]
+        #
         # @param options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil] .
         #
         #   @option options [String, nil] :idempotency_key
@@ -560,6 +580,7 @@ module VitableConnect
               page: T.nilable(T::Class[VitableConnect::Internal::Type::BasePage[VitableConnect::Internal::Type::BaseModel]]),
               stream: T.nilable(T::Class[T.anything]),
               model: T.nilable(VitableConnect::Internal::Type::Converter::Input),
+              security: T.nilable({api_key_auth: T::Boolean}),
               options: T.nilable(VitableConnect::RequestOptions::OrHash)
             }
           end

data/lib/vitable_connect/internal/type/enum.rb

@@ -17,24 +17,28 @@ module VitableConnect
       # values safely.
       #
       # @example
-      #   # `type` is a `VitableConnect::Type`
-      #   case type
-      #   when VitableConnect::Type::EMPLOYER
+      #   # `employee_class` is a `VitableConnect::EmployeeClass`
+      #   case employee_class
+      #   when VitableConnect::EmployeeClass::FULL_TIME
       #     # ...
-      #   when VitableConnect::Type::EMPLOYEE
+      #   when VitableConnect::EmployeeClass::PART_TIME
+      #     # ...
+      #   when VitableConnect::EmployeeClass::TEMPORARY
       #     # ...
       #   else
-      #     puts(type)
+      #     puts(employee_class)
       #   end
       #
       # @example
-      #   case type
-      #   in :employer
+      #   case employee_class
+      #   in :"Full Time"
+      #     # ...
+      #   in :"Part Time"
       #     # ...
-      #   in :employee
+      #   in :Temporary
       #     # ...
       #   else
-      #     puts(type)
+      #     puts(employee_class)
       #   end
       module Enum
         include VitableConnect::Internal::Type::Converter

data/lib/vitable_connect/models/auth_issue_access_token_params.rb

@@ -48,8 +48,8 @@ module VitableConnect
         #   - `employer` - employer
         #   - `employee` - employee
         #
-        #   @return [Symbol, VitableConnect::Models::Type]
-        required :type, enum: -> { VitableConnect::Type }
+        #   @return [Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity::Type]
+        required :type, enum: -> { VitableConnect::AuthIssueAccessTokenParams::BoundEntity::Type }
 
         # @!method initialize(id:, type:)
         #   Some parameter documentations has been truncated, see
@@ -61,7 +61,21 @@ module VitableConnect
         #   @param id [String] Prefixed entity ID to bind the token to (empr*\* for employer, empl*\* for
         #   employe
         #
-        #   @param type [Symbol, VitableConnect::Models::Type] - `employer` - employer
+        #   @param type [Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity::Type] - `employer` - employer
+
+        # - `employer` - employer
+        # - `employee` - employee
+        #
+        # @see VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity#type
+        module Type
+          extend VitableConnect::Internal::Type::Enum
+
+          EMPLOYER = :employer
+          EMPLOYEE = :employee
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/vitable_connect/models/auth_issue_access_token_response.rb

@@ -51,8 +51,8 @@ module VitableConnect
         #   - `employer` - employer
         #   - `employee` - employee
         #
-        #   @return [Symbol, VitableConnect::Models::Type]
-        required :type, enum: -> { VitableConnect::Type }
+        #   @return [Symbol, VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type]
+        required :type, enum: -> { VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type }
 
         # @!method initialize(id:, type:)
         #   Some parameter documentations has been truncated, see
@@ -63,7 +63,21 @@ module VitableConnect
         #
         #   @param id [String] Prefixed entity ID the token is bound to (empr*\* or empl*\*)
         #
-        #   @param type [Symbol, VitableConnect::Models::Type] - `employer` - employer
+        #   @param type [Symbol, VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type] - `employer` - employer
+
+        # - `employer` - employer
+        # - `employee` - employee
+        #
+        # @see VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity#type
+        module Type
+          extend VitableConnect::Internal::Type::Enum
+
+          EMPLOYER = :employer
+          EMPLOYEE = :employee
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/vitable_connect/models/employee.rb

@@ -28,6 +28,17 @@ module VitableConnect
       #   @return [String]
       required :email, String
 
+      # @!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]
+      required :employee_class, enum: -> { VitableConnect::EmployeeClass }
+
       # @!attribute first_name
       #   Employee's legal first name
       #
@@ -52,16 +63,11 @@ module VitableConnect
       #   @return [VitableConnect::Models::Employee::Address, nil]
       optional :address, -> { VitableConnect::Employee::Address }, nil?: true
 
-      # @!attribute employee_class
-      #   - `Full Time` - Full Time
-      #   - `Part Time` - Part Time
-      #   - `Temporary` - Temporary
-      #   - `Intern` - Intern
-      #   - `Seasonal` - Seasonal
-      #   - `Individual Contractor` - Individual Contractor
+      # @!attribute employer_name
+      #   Name of the employer this employment is with
       #
-      #   @return [Symbol, VitableConnect::Models::EmployeeClass, nil]
-      optional :employee_class, enum: -> { VitableConnect::EmployeeClass }, nil?: true
+      #   @return [String, nil]
+      optional :employer_name, String, nil?: true
 
       # @!attribute gender
       #   Gender identity, if provided
@@ -69,12 +75,6 @@ module VitableConnect
       #   @return [String, nil]
       optional :gender, String, nil?: true
 
-      # @!attribute hire_date
-      #   Employee's hire date with the employer
-      #
-      #   @return [Date, nil]
-      optional :hire_date, Date, nil?: true
-
       # @!attribute reference_id
       #   Partner-assigned reference ID for the employee
       #
@@ -100,6 +100,31 @@ module VitableConnect
         #   @return [String]
         required :id, String
 
+        # @!attribute classification_effective_date
+        #   Date the employee's current classification took effect
+        #
+        #   @return [Date]
+        required :classification_effective_date, Date
+
+        # @!attribute compensation_type
+        #   - `Salary` - Salary
+        #   - `Hourly` - Hourly
+        #
+        #   @return [Symbol, VitableConnect::Models::Employee::CompensationType, nil]
+        required :compensation_type, enum: -> { VitableConnect::Employee::CompensationType }, nil?: true
+
+        # @!attribute compensation_type_effective_date
+        #   Date the employee's current compensation type took effect
+        #
+        #   @return [Date]
+        required :compensation_type_effective_date, Date
+
+        # @!attribute employer_id
+        #   Unique identifier of the employer this employment is with (empr\_\*)
+        #
+        #   @return [String]
+        required :employer_id, String
+
         # @!attribute member_id
         #   Unique member identifier with 'mbr\_' prefix
         #
@@ -112,19 +137,31 @@ module VitableConnect
         #   @return [String, nil]
         required :phone, String, nil?: true
 
+        # @!attribute start_date
+        #   Employee's start date with the employer
+        #
+        #   @return [Date]
+        required :start_date, Date
+
         # @!attribute status
         #   Employee status (active or terminated)
         #
-        #   @return [String]
-        required :status, String
+        #   @return [Symbol, VitableConnect::Models::Employee::Status]
+        required :status, enum: -> { VitableConnect::Employee::Status }
       end
 
-      # @!method initialize(id:, created_at:, date_of_birth:, deductions:, email:, first_name:, last_name:, member_id:, phone:, status:, updated_at:, address: nil, employee_class: nil, gender: nil, hire_date: nil, reference_id: nil, suffix: nil, termination_date: nil)
+      # @!method initialize(id:, classification_effective_date:, compensation_type:, compensation_type_effective_date:, created_at:, date_of_birth:, deductions:, email:, employee_class:, employer_id:, first_name:, last_name:, member_id:, phone:, start_date:, status:, updated_at:, address: nil, employer_name: nil, gender: nil, reference_id: nil, suffix: nil, termination_date: nil)
       #   Some parameter documentations has been truncated, see
       #   {VitableConnect::Models::Employee} for more details.
       #
       #   @param id [String] Unique employee identifier with 'empl\_' prefix
       #
+      #   @param classification_effective_date [Date] Date the employee's current classification took effect
+      #
+      #   @param compensation_type [Symbol, VitableConnect::Models::Employee::CompensationType, nil] - `Salary` - Salary
+      #
+      #   @param compensation_type_effective_date [Date] Date the employee's current compensation type took effect
+      #
       #   @param created_at [Time] Timestamp when the employee was created
       #
       #   @param date_of_birth [Date] Date of birth (YYYY-MM-DD)
@@ -133,6 +170,10 @@ module VitableConnect
       #
       #   @param email [String] Email address
       #
+      #   @param employee_class [Symbol, VitableConnect::Models::EmployeeClass] - `Full Time` - Full Time
+      #
+      #   @param employer_id [String] Unique identifier of the employer this employment is with (empr\_\*)
+      #
       #   @param first_name [String] Employee's legal first name
       #
       #   @param last_name [String] Employee's legal last name
@@ -141,24 +182,38 @@ module VitableConnect
       #
       #   @param phone [String, nil] Phone number (10-digit US domestic string)
       #
-      #   @param status [String] Employee status (active or terminated)
+      #   @param start_date [Date] Employee's start date with the employer
+      #
+      #   @param status [Symbol, VitableConnect::Models::Employee::Status] Employee status (active or terminated)
       #
       #   @param updated_at [Time] Timestamp when the employee was last updated
       #
       #   @param address [VitableConnect::Models::Employee::Address, nil] Employee's residential address
       #
-      #   @param employee_class [Symbol, VitableConnect::Models::EmployeeClass, nil] - `Full Time` - Full Time
+      #   @param employer_name [String, nil] Name of the employer this employment is with
       #
       #   @param gender [String, nil] Gender identity, if provided
       #
-      #   @param hire_date [Date, nil] Employee's hire date with the employer
-      #
       #   @param reference_id [String, nil] Partner-assigned reference ID for the employee
       #
       #   @param suffix [String, nil] Name suffix (e.g., Jr., Sr., III)
       #
       #   @param termination_date [Date, nil] Employee's termination date, if terminated
 
+      # - `Salary` - Salary
+      # - `Hourly` - Hourly
+      #
+      # @see VitableConnect::Models::Employee#compensation_type
+      module CompensationType
+        extend VitableConnect::Internal::Type::Enum
+
+        SALARY = :Salary
+        HOURLY = :Hourly
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       class Deduction < VitableConnect::Internal::Type::BaseModel
         # @!attribute benefit_name
         #   Name of the benefit plan
@@ -260,6 +315,19 @@ module VitableConnect
         end
       end
 
+      # Employee status (active or terminated)
+      #
+      # @see VitableConnect::Models::Employee#status
+      module Status
+        extend VitableConnect::Internal::Type::Enum
+
+        ACTIVE = :active
+        TERMINATED = :terminated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see VitableConnect::Models::Employee#address
       class Address < VitableConnect::Internal::Type::BaseModel
         # @!attribute address_line_1