vitable-connect 8.3.1 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dba235b28efc858edf3b9caec5b183ae0baf3dc0c25890dfea0bc0f8fd377423
-  data.tar.gz: 3e420069e4e5f9f994d1ce000cb5730bfc71708efd25427b28aba7ec66c59c0b
+  metadata.gz: 3f5a8c1dc9f7fb0501a5eb2428a0d5ea69ee98b46c9b20c7e5fc73b0fd48c619
+  data.tar.gz: 89e9f440f59b73ffd0a1dd6bf33088ae6ba66876c421507934b576bc16092f60
 SHA512:
-  metadata.gz: '068a4f09844fdc49d2bbed043157e4c2dcc621dd065e04aa0290cd50c1eb519da2a3e4d4bc816377b6c754fd33eaa2e17461debb4520bc222808e2547cef519b'
-  data.tar.gz: 399f63bbbea5b68c07e1d2c63b96d11273c76a4253b3972bcf8f96eb70e5d498f04bea8b18d6a2d544e0d0d25fdadf63a88b23b4322a368ee4f9ab7bbc215468
+  metadata.gz: 8b81fe4a4532fd28c82667a0bee520d4816bfa354f85cf5ada705cb53f000b9e8c5e73eeaadcd580250e9fa98f62f322eaf34812ac838ae8236ee8a9e9a03343
+  data.tar.gz: 309fc69f5c6b6afe568ef3b1650b6c8db88de32f64ec3a1985c59a4bfa22bbdfda1659bc6074847d43774064645e5e5fb06f56295ddbccf8608f493d00e4ce81

data/.fern/metadata.json

@@ -7,10 +7,10 @@
     "offsetSemantics": "page-index",
     "respectAuthSchemeNames": true
   },
-  "originGitCommit": "688438f848c5df48f9db69ff3ea251cb5822f231",
+  "originGitCommit": "61d40f260d63c4439b53339aa147f819b9e9572a",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
   "requestedVersion": "AUTO",
   "ciProvider": "gitlab",
-  "sdkVersion": "8.3.1"
+  "sdkVersion": "8.4.0"
 }

data/changelog.md

@@ -1,3 +1,10 @@
+## 8.4.0 - 2026-11-10
+### Added
+* **`vitable_organization`** optional parameter on `EmployeesClient#get` and `EmployeesClient#update` — when supplied, the value is sent as the `X-Vitable-Organization` HTTP header to scope the request to a specific organization.
+* **`GetEmployeesRequest#vitable_organization`** and **`PatchedUpdateEmployeeRequest#vitable_organization`** — new optional fields (mapped to the `X-Vitable-Organization` header) on the corresponding request types.
+### Changed
+* **`EmployeesClient#update`** inline documentation expanded to describe 404, 403 (`organization_access_denied`), 422 (`email_taken`, `invalid_account_update`), and 400 (`invalid_employee_update`, `employee_already_terminated`) error responses.
+
 ## 8.3.1 - 2026-11-06
 * chore: document 409 conflict behavior for employee update endpoint
 * Expand the inline documentation for the `update` method on the

data/lib/VitableConnect/client.rb

@@ -11,7 +11,7 @@ module VitableConnect
       @raw_client = VitableConnect::Internal::Http::RawClient.new(
         base_url: base_url || VitableConnect::Environment::PRODUCTION,
         headers: {
-          "User-Agent" => "vitable-connect/8.3.1",
+          "User-Agent" => "vitable-connect/8.4.0",
           "X-Fern-Language" => "Ruby",
           Authorization: "Bearer #{api_key}"
         },

data/lib/VitableConnect/employees/client.rb

@@ -23,6 +23,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::EmployeeID] :employee_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.employees.get(employee_id: "empl_abc123def456")
@@ -30,10 +31,14 @@ module VitableConnect
       # @return [VitableConnect::Types::EmployeeResponse]
       def get(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "v1/employees/#{URI.encode_uri_component(params[:employee_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -53,9 +58,18 @@ module VitableConnect
       # Updates employee personal, contact, address, and employment fields. This endpoint currently supports email,
       # phone, gender, address, employee_class, start_date, and compensation_type. effective_date is required and
       # applies to employee_class and compensation_type when those fields are included in the request. Returns 409
-      # employer_has_hris_connection when the request changes employee_class, compensation_type or start_date for an
-      # employer with an active, pending or inactive HRIS connection (paused connections do not block); re-sending the
-      # current values with a new effective_date is allowed.
+      # `employer_has_hris_connection` when the request changes employee_class, compensation_type or start_date while an
+      # HRIS connection manages this employer's employees; re-sending the current values with a new effective_date is
+      # allowed.
+      #
+      # Returns 404 if the employee does not exist or is not accessible to the caller, and 403
+      # `organization_access_denied` when an API key sends `X-Vitable-Organization` for an organization other than its
+      # own.
+      #
+      # 422 `app_error_code` values: `email_taken` (the email belongs to another person's Vitable account),
+      # `invalid_account_update` (another account detail, such as the phone, belongs to another person). 400 is returned
+      # for malformed input and for changes the employee record rejects (`invalid_employee_update`,
+      # `employee_already_terminated`).
       #
       # @param request_options [Hash]
       # @param params [VitableConnect::Employees::Types::PatchedUpdateEmployeeRequest]
@@ -65,6 +79,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::EmployeeID] :employee_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.employees.update(
@@ -79,13 +94,17 @@ module VitableConnect
       def update(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
         request_data = VitableConnect::Employees::Types::PatchedUpdateEmployeeRequest.new(params).to_h
-        non_body_param_names = %w[employee_id]
+        non_body_param_names = %w[employee_id X-Vitable-Organization]
         body = request_data.except(*non_body_param_names)
 
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PATCH",
           path: "v1/employees/#{URI.encode_uri_component(params[:employee_id].to_s)}",
+          headers: headers,
           body: body,
           request_options: request_options
         )

data/lib/VitableConnect/employees/types/get_employees_request.rb

@@ -5,6 +5,8 @@ module VitableConnect
     module Types
       class GetEmployeesRequest < Internal::Types::Model
         field :employee_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/employees/types/patched_update_employee_request.rb

@@ -6,6 +6,8 @@ module VitableConnect
       class PatchedUpdateEmployeeRequest < Internal::Types::Model
         field :employee_id, -> { String }, optional: false, nullable: false
 
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
+
         field :email, -> { String }, optional: true, nullable: false
 
         field :phone, -> { String }, optional: true, nullable: false

data/lib/VitableConnect/version.rb

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

data/reference.md

@@ -125,6 +125,14 @@ client.employees.get(employee_id: "empl_abc123def456")
 <dl>
 <dd>
 
+**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `VitableConnect::Employees::RequestOptions` 
     
 </dd>
@@ -149,7 +157,11 @@ client.employees.get(employee_id: "empl_abc123def456")
 <dl>
 <dd>
 
-Updates employee personal, contact, address, and employment fields. This endpoint currently supports email, phone, gender, address, employee_class, start_date, and compensation_type. effective_date is required and applies to employee_class and compensation_type when those fields are included in the request. Returns 409 employer_has_hris_connection when the request changes employee_class, compensation_type or start_date for an employer with an active, pending or inactive HRIS connection (paused connections do not block); re-sending the current values with a new effective_date is allowed.
+Updates employee personal, contact, address, and employment fields. This endpoint currently supports email, phone, gender, address, employee_class, start_date, and compensation_type. effective_date is required and applies to employee_class and compensation_type when those fields are included in the request. Returns 409 `employer_has_hris_connection` when the request changes employee_class, compensation_type or start_date while an HRIS connection manages this employer's employees; re-sending the current values with a new effective_date is allowed.
+
+Returns 404 if the employee does not exist or is not accessible to the caller, and 403 `organization_access_denied` when an API key sends `X-Vitable-Organization` for an organization other than its own.
+
+422 `app_error_code` values: `email_taken` (the email belongs to another person's Vitable account), `invalid_account_update` (another account detail, such as the phone, belongs to another person). 400 is returned for malformed input and for changes the employee record rejects (`invalid_employee_update`, `employee_already_terminated`).
 </dd>
 </dl>
 </dd>
@@ -193,6 +205,14 @@ client.employees.update(
 <dl>
 <dd>
 
+**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **email:** `String` — Email address
     
 </dd>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitable-connect
 version: !ruby/object:Gem::Version
-  version: 8.3.1
+  version: 8.4.0
 platform: ruby
 authors:
 - VitableConnect
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-11-06 00:00:00.000000000 Z
+date: 2026-11-10 00:00:00.000000000 Z
 dependencies: []
 description: The VitableConnect Ruby library provides convenient access to the VitableConnect
   API from Ruby.