vitable-connect 2.0.0 → 2.1.0

data/reference.md

@@ -483,6 +483,14 @@ client.employers.list(
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -551,6 +559,14 @@ client.employers.create(
 <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>
+
 **name:** `String` — Employer display name
     
 </dd>
@@ -669,6 +685,14 @@ client.employers.get(employer_id: "empr_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::Employers::RequestOptions` 
     
 </dd>
@@ -731,6 +755,14 @@ client.employers.update(employer_id: "empr_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>
+
 **name:** `String` — Employer display name
     
 </dd>
@@ -825,6 +857,14 @@ client.employers.list_benefit_plan_years(employer_id: "empr_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::Employers::RequestOptions` 
     
 </dd>
@@ -898,6 +938,14 @@ client.employers.get_benefit_plan_year(
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -1005,6 +1053,14 @@ client.employers.list_benefit_plan_year_enrollments(
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -1203,6 +1259,14 @@ client.employers.list_employees(
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -1265,6 +1329,14 @@ client.employers.get_hris(employer_id: "empr_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::Employers::RequestOptions` 
     
 </dd>
@@ -1346,6 +1418,14 @@ client.employers.list_invoices(
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -1419,6 +1499,14 @@ client.employers.get_invoice_pdf(
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -1481,6 +1569,14 @@ client.employers.get_payroll_access_setup(employer_id: "empr_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::Employers::RequestOptions` 
     
 </dd>
@@ -1552,6 +1648,14 @@ client.employers.submit_payroll_access_setup(
 <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>
+
 **employees_in_payroll_acknowledged:** `Internal::Types::Boolean` — Attestation that all benefit-eligible employees appear in the payroll system.
     
 </dd>
@@ -1818,6 +1922,14 @@ client.employers.list_payroll_deduction_statements(
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -1880,6 +1992,14 @@ client.employers.ensure_payroll_integration_email(employer_id: "empr_abc123def45
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -1945,6 +2065,14 @@ client.employers.update_settings(
 <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>
+
 **pay_frequency:** `VitableConnect::Types::DeductionFrequency` 
     
 </dd>
@@ -2007,6 +2135,14 @@ client.employers.list_hris_providers
 <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::Employers::RequestOptions` 
     
 </dd>
@@ -2070,6 +2206,14 @@ client.enrollments.get(enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ")
 <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::Enrollments::RequestOptions` 
     
 </dd>
@@ -2137,6 +2281,14 @@ client.enrollments.reissue(
 <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>
+
 **reason:** `String` — Audit reason for the reissue; required for user-backed callers and optional for long-lived organization API-key callers
     
 </dd>
@@ -2228,6 +2380,14 @@ client.enrollments.terminate(
 <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>
+
 **reason:** `String` — Audit reason for the termination; required for user-backed callers and optional for long-lived organization API-key callers
     
 </dd>
@@ -2606,6 +2766,14 @@ client.members.get(member_id: "mbr_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::Members::RequestOptions` 
     
 </dd>
@@ -2668,6 +2836,14 @@ client.members.list_dependents(member_id: "mbr_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::Members::RequestOptions` 
     
 </dd>
@@ -2730,6 +2906,14 @@ client.members.list_employments(member_id: "mbr_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::Members::RequestOptions` 
     
 </dd>
@@ -2792,6 +2976,14 @@ client.members.list_enrollments(member_id: "mbr_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::Members::RequestOptions` 
     
 </dd>
@@ -2854,6 +3046,14 @@ client.members.get_household(member_id: "mbr_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::Members::RequestOptions` 
     
 </dd>
@@ -2916,6 +3116,14 @@ client.members.list_id_cards(member_id: "mbr_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::Members::RequestOptions` 
     
 </dd>
@@ -3006,6 +3214,14 @@ client.members.list_qualifying_life_events(
 <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::Members::RequestOptions` 
     
 </dd>
@@ -3087,6 +3303,14 @@ client.members.list(
 <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::Members::RequestOptions` 
     
 </dd>
@@ -3166,7 +3390,7 @@ client.organizations.list
 <dl>
 <dd>
 
-Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin). 409 `organization_already_exists` when the user already has an organization (v0: one organization per user).
+Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin). A user may hold several organizations and selects which one a request acts as with the `X-Vitable-Organization` header. The founder's email domain is claimed only when no other organization holds it, so a taken domain is left with its owner rather than rejected.
 </dd>
 </dl>
 </dd>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vitable-connect
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - VitableConnect
@@ -48,6 +48,7 @@ files:
 - lib/VitableConnect/employers/types/list_benefit_plan_years_employers_request.rb
 - lib/VitableConnect/employers/types/list_employees_employers_request.rb
 - lib/VitableConnect/employers/types/list_employers_request.rb
+- lib/VitableConnect/employers/types/list_hris_providers_employers_request.rb
 - lib/VitableConnect/employers/types/list_invoices_employers_request.rb
 - lib/VitableConnect/employers/types/list_payroll_deduction_statements_employers_request.rb
 - lib/VitableConnect/employers/types/submit_payroll_access_setup_request.rb
@@ -286,6 +287,7 @@ files:
 - lib/VitableConnect/types/webhook_event.rb
 - lib/VitableConnect/types/webhook_event_list_response.rb
 - lib/VitableConnect/types/webhook_event_response.rb
+- lib/VitableConnect/types/x_vitable_organization.rb
 - lib/VitableConnect/version.rb
 - lib/VitableConnect/webhook_events/client.rb
 - lib/VitableConnect/webhook_events/types/get_webhook_events_request.rb