vitable-connect 3.0.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.fern/metadata.json +2 -2
- data/changelog.md +10 -0
- data/lib/VitableConnect/client.rb +1 -1
- data/lib/VitableConnect/organizations/client.rb +0 -44
- data/lib/VitableConnect/types/member_enrollment.rb +2 -0
- data/lib/VitableConnect/version.rb +1 -1
- data/lib/VitableConnect.rb +2 -4
- data/reference.md +0 -73
- metadata +2 -4
- data/lib/VitableConnect/organizations/types/create_organization_request.rb +0 -13
- data/lib/VitableConnect/types/organization.rb +0 -19
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: eaf8e71d5533b31ea104a6541c9224500c7cc101bc726e09b02f6b88b550fad7
|
|
4
|
+
data.tar.gz: 6ecaee8310e6f55cd8bda3c8d715b561a38a5683063c53b1f12168964ccfa7fe
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c1f054f2400eda17108e968065669baf0a270bf42576b1331ec72de1e98e6f7049245a215003eb8172c69e3933bd0fad59c069ed72f0b9534f27372e04c3c75b
|
|
7
|
+
data.tar.gz: 44205871b34837d7eb7091be6e71a3026895faff6c2413ca9e45109df7c9a30ace597d9ac1da224099b1c24a46744f431d461d0f9d111d649aaba7bdc4473b0a
|
data/.fern/metadata.json
CHANGED
|
@@ -7,10 +7,10 @@
|
|
|
7
7
|
"offsetSemantics": "page-index",
|
|
8
8
|
"respectAuthSchemeNames": true
|
|
9
9
|
},
|
|
10
|
-
"originGitCommit": "
|
|
10
|
+
"originGitCommit": "781feaa3950b4ba9c610cacee97069761ab8ab73",
|
|
11
11
|
"originGitCommitIsDirty": false,
|
|
12
12
|
"invokedBy": "ci",
|
|
13
13
|
"requestedVersion": "AUTO",
|
|
14
14
|
"ciProvider": "gitlab",
|
|
15
|
-
"sdkVersion": "
|
|
15
|
+
"sdkVersion": "4.1.0"
|
|
16
16
|
}
|
data/changelog.md
CHANGED
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
## 4.1.0 - 2026-09-22
|
|
2
|
+
### Added
|
|
3
|
+
* **`VitableConnect::Types::MemberEnrollment#enrolled_date`** — new nullable `String` field exposing the date a member was enrolled, available alongside the existing `issued_date` and `enrollment_window_start` fields.
|
|
4
|
+
|
|
5
|
+
## 4.0.0 - 2026-09-16
|
|
6
|
+
### Breaking Changes
|
|
7
|
+
* **`VitableConnect::Organizations::Client#create`** has been removed. Any calls to `client.organizations.create(...)` will raise `NoMethodError`; remove or replace these call sites.
|
|
8
|
+
* **`VitableConnect::Organizations::Types::CreateOrganizationRequest`** has been removed. Replace any direct references to this class with your own request construction or remove them entirely.
|
|
9
|
+
* **`VitableConnect::Types::Organization`** has been removed. Any code that references this class (e.g. `is_a?` checks, constant lookups, or return-value handling) must be updated; use `VitableConnect::Types::OrganizationMembership` for organization data returned by the list endpoint.
|
|
10
|
+
|
|
1
11
|
## 3.0.0 - 2026-09-11
|
|
2
12
|
### Breaking Changes
|
|
3
13
|
* **`VitableConnect::Types::CreateOrganizationRequestType`** has been removed. Replace any references with `VitableConnect::Types::OrganizationType`, which carries the same enum values.
|
|
@@ -11,7 +11,7 @@ module VitableConnect
|
|
|
11
11
|
@raw_client = VitableConnect::Internal::Http::RawClient.new(
|
|
12
12
|
base_url: base_url || VitableConnect::Environment::PRODUCTION,
|
|
13
13
|
headers: {
|
|
14
|
-
"User-Agent" => "vitable-connect/
|
|
14
|
+
"User-Agent" => "vitable-connect/4.1.0",
|
|
15
15
|
"X-Fern-Language" => "Ruby",
|
|
16
16
|
Authorization: "Bearer #{api_key}"
|
|
17
17
|
},
|
|
@@ -45,50 +45,6 @@ module VitableConnect
|
|
|
45
45
|
raise error_class.new(response.body, code: code)
|
|
46
46
|
end
|
|
47
47
|
end
|
|
48
|
-
|
|
49
|
-
# Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin
|
|
50
|
-
# membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin). A user
|
|
51
|
-
# may hold several organizations and selects which one a request acts as with the `X-Vitable-Organization` header.
|
|
52
|
-
# The founder's email domain is claimed only when no other organization holds it, so a taken domain is left with
|
|
53
|
-
# its owner rather than rejected.
|
|
54
|
-
#
|
|
55
|
-
# @param request_options [Hash]
|
|
56
|
-
# @param params [VitableConnect::Organizations::Types::CreateOrganizationRequest]
|
|
57
|
-
# @option request_options [String] :base_url
|
|
58
|
-
# @option request_options [Hash{String => Object}] :additional_headers
|
|
59
|
-
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
60
|
-
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
61
|
-
# @option request_options [Integer] :timeout_in_seconds
|
|
62
|
-
#
|
|
63
|
-
# @example
|
|
64
|
-
# client.organizations.create(
|
|
65
|
-
# name: "Acme Brokerage",
|
|
66
|
-
# type: "BROKERAGE"
|
|
67
|
-
# )
|
|
68
|
-
#
|
|
69
|
-
# @return [VitableConnect::Types::Organization]
|
|
70
|
-
def create(request_options: {}, **params)
|
|
71
|
-
params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
|
|
72
|
-
request = VitableConnect::Internal::JSON::Request.new(
|
|
73
|
-
base_url: request_options[:base_url],
|
|
74
|
-
method: "POST",
|
|
75
|
-
path: "v1/organizations",
|
|
76
|
-
body: VitableConnect::Organizations::Types::CreateOrganizationRequest.new(params).to_h,
|
|
77
|
-
request_options: request_options
|
|
78
|
-
)
|
|
79
|
-
begin
|
|
80
|
-
response = @client.send(request)
|
|
81
|
-
rescue Net::HTTPRequestTimeout
|
|
82
|
-
raise VitableConnect::Errors::TimeoutError
|
|
83
|
-
end
|
|
84
|
-
code = response.code.to_i
|
|
85
|
-
if code.between?(200, 299)
|
|
86
|
-
VitableConnect::Types::Organization.load(response.body)
|
|
87
|
-
else
|
|
88
|
-
error_class = VitableConnect::Errors::ResponseError.subclass_for_code(code)
|
|
89
|
-
raise error_class.new(response.body, code: code)
|
|
90
|
-
end
|
|
91
|
-
end
|
|
92
48
|
end
|
|
93
49
|
end
|
|
94
50
|
end
|
|
@@ -42,6 +42,8 @@ module VitableConnect
|
|
|
42
42
|
|
|
43
43
|
field :issued_date, -> { String }, optional: false, nullable: false
|
|
44
44
|
|
|
45
|
+
field :enrolled_date, -> { String }, optional: false, nullable: true
|
|
46
|
+
|
|
45
47
|
field :enrollment_window_start, -> { String }, optional: false, nullable: false
|
|
46
48
|
|
|
47
49
|
field :enrollment_window_end, -> { String }, optional: true, nullable: false
|
data/lib/VitableConnect.rb
CHANGED
|
@@ -161,8 +161,6 @@ require_relative "VitableConnect/types/member_qualifying_life_event"
|
|
|
161
161
|
require_relative "VitableConnect/types/member_qualifying_life_event_list_response"
|
|
162
162
|
require_relative "VitableConnect/types/member_response"
|
|
163
163
|
require_relative "VitableConnect/types/missing_employee_resolution"
|
|
164
|
-
require_relative "VitableConnect/types/organization_type"
|
|
165
|
-
require_relative "VitableConnect/types/organization"
|
|
166
164
|
require_relative "VitableConnect/types/employer_benefit_lifecycle_stage"
|
|
167
165
|
require_relative "VitableConnect/types/enrollment_rate_summary"
|
|
168
166
|
require_relative "VitableConnect/types/employer_hris_status"
|
|
@@ -170,6 +168,7 @@ require_relative "VitableConnect/types/organization_employer"
|
|
|
170
168
|
require_relative "VitableConnect/types/organization_employer_list_response"
|
|
171
169
|
require_relative "VitableConnect/types/organization_hris_provider"
|
|
172
170
|
require_relative "VitableConnect/types/organization_hris_providers_response"
|
|
171
|
+
require_relative "VitableConnect/types/organization_type"
|
|
173
172
|
require_relative "VitableConnect/types/organization_user_role"
|
|
174
173
|
require_relative "VitableConnect/types/organization_membership"
|
|
175
174
|
require_relative "VitableConnect/types/organizations_list_response"
|
|
@@ -188,10 +187,10 @@ require_relative "VitableConnect/types/update_employer_address_input"
|
|
|
188
187
|
require_relative "VitableConnect/types/webhook_event"
|
|
189
188
|
require_relative "VitableConnect/types/webhook_event_list_response"
|
|
190
189
|
require_relative "VitableConnect/types/webhook_event_response"
|
|
190
|
+
require_relative "VitableConnect/types/x_vitable_organization"
|
|
191
191
|
require_relative "VitableConnect/types/employee_id"
|
|
192
192
|
require_relative "VitableConnect/types/limit"
|
|
193
193
|
require_relative "VitableConnect/types/page"
|
|
194
|
-
require_relative "VitableConnect/types/x_vitable_organization"
|
|
195
194
|
require_relative "VitableConnect/types/include_cancelled"
|
|
196
195
|
require_relative "VitableConnect/types/search"
|
|
197
196
|
require_relative "VitableConnect/types/employer_id"
|
|
@@ -257,7 +256,6 @@ require_relative "VitableConnect/members/types/list_id_cards_members_request"
|
|
|
257
256
|
require_relative "VitableConnect/members/types/list_qualifying_life_events_members_request"
|
|
258
257
|
require_relative "VitableConnect/members/types/list_members_request"
|
|
259
258
|
require_relative "VitableConnect/organizations/client"
|
|
260
|
-
require_relative "VitableConnect/organizations/types/create_organization_request"
|
|
261
259
|
require_relative "VitableConnect/plans/client"
|
|
262
260
|
require_relative "VitableConnect/plans/types/list_plans_request"
|
|
263
261
|
require_relative "VitableConnect/webhook_events/client"
|
data/reference.md
CHANGED
|
@@ -3374,79 +3374,6 @@ client.organizations.list
|
|
|
3374
3374
|
</dl>
|
|
3375
3375
|
|
|
3376
3376
|
|
|
3377
|
-
</dd>
|
|
3378
|
-
</dl>
|
|
3379
|
-
</details>
|
|
3380
|
-
|
|
3381
|
-
<details><summary><code>client.organizations.<a href="/lib/VitableConnect/organizations/client.rb">create</a>(request) -> VitableConnect::Types::Organization</code></summary>
|
|
3382
|
-
<dl>
|
|
3383
|
-
<dd>
|
|
3384
|
-
|
|
3385
|
-
#### 📝 Description
|
|
3386
|
-
|
|
3387
|
-
<dl>
|
|
3388
|
-
<dd>
|
|
3389
|
-
|
|
3390
|
-
<dl>
|
|
3391
|
-
<dd>
|
|
3392
|
-
|
|
3393
|
-
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.
|
|
3394
|
-
</dd>
|
|
3395
|
-
</dl>
|
|
3396
|
-
</dd>
|
|
3397
|
-
</dl>
|
|
3398
|
-
|
|
3399
|
-
#### 🔌 Usage
|
|
3400
|
-
|
|
3401
|
-
<dl>
|
|
3402
|
-
<dd>
|
|
3403
|
-
|
|
3404
|
-
<dl>
|
|
3405
|
-
<dd>
|
|
3406
|
-
|
|
3407
|
-
```ruby
|
|
3408
|
-
client.organizations.create(
|
|
3409
|
-
name: "Acme Brokerage",
|
|
3410
|
-
type: "BROKERAGE"
|
|
3411
|
-
)
|
|
3412
|
-
```
|
|
3413
|
-
</dd>
|
|
3414
|
-
</dl>
|
|
3415
|
-
</dd>
|
|
3416
|
-
</dl>
|
|
3417
|
-
|
|
3418
|
-
#### ⚙️ Parameters
|
|
3419
|
-
|
|
3420
|
-
<dl>
|
|
3421
|
-
<dd>
|
|
3422
|
-
|
|
3423
|
-
<dl>
|
|
3424
|
-
<dd>
|
|
3425
|
-
|
|
3426
|
-
**name:** `String` — Legal or trading name of the organization.
|
|
3427
|
-
|
|
3428
|
-
</dd>
|
|
3429
|
-
</dl>
|
|
3430
|
-
|
|
3431
|
-
<dl>
|
|
3432
|
-
<dd>
|
|
3433
|
-
|
|
3434
|
-
**type:** `VitableConnect::Types::OrganizationType` — Category of organization being onboarded.
|
|
3435
|
-
|
|
3436
|
-
</dd>
|
|
3437
|
-
</dl>
|
|
3438
|
-
|
|
3439
|
-
<dl>
|
|
3440
|
-
<dd>
|
|
3441
|
-
|
|
3442
|
-
**request_options:** `VitableConnect::Organizations::RequestOptions`
|
|
3443
|
-
|
|
3444
|
-
</dd>
|
|
3445
|
-
</dl>
|
|
3446
|
-
</dd>
|
|
3447
|
-
</dl>
|
|
3448
|
-
|
|
3449
|
-
|
|
3450
3377
|
</dd>
|
|
3451
3378
|
</dl>
|
|
3452
3379
|
</details>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: vitable-connect
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 4.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- VitableConnect
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-09-
|
|
11
|
+
date: 2026-09-22 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: The VitableConnect Ruby library provides convenient access to the VitableConnect
|
|
14
14
|
API from Ruby.
|
|
@@ -109,7 +109,6 @@ files:
|
|
|
109
109
|
- lib/VitableConnect/members/types/list_members_request.rb
|
|
110
110
|
- lib/VitableConnect/members/types/list_qualifying_life_events_members_request.rb
|
|
111
111
|
- lib/VitableConnect/organizations/client.rb
|
|
112
|
-
- lib/VitableConnect/organizations/types/create_organization_request.rb
|
|
113
112
|
- lib/VitableConnect/plans/client.rb
|
|
114
113
|
- lib/VitableConnect/plans/types/list_plans_request.rb
|
|
115
114
|
- lib/VitableConnect/types/access_method.rb
|
|
@@ -243,7 +242,6 @@ files:
|
|
|
243
242
|
- lib/VitableConnect/types/missing_employee_resolution.rb
|
|
244
243
|
- lib/VitableConnect/types/name_suffix.rb
|
|
245
244
|
- lib/VitableConnect/types/offset.rb
|
|
246
|
-
- lib/VitableConnect/types/organization.rb
|
|
247
245
|
- lib/VitableConnect/types/organization_employer.rb
|
|
248
246
|
- lib/VitableConnect/types/organization_employer_list_response.rb
|
|
249
247
|
- lib/VitableConnect/types/organization_hris_provider.rb
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module VitableConnect
|
|
4
|
-
module Organizations
|
|
5
|
-
module Types
|
|
6
|
-
class CreateOrganizationRequest < Internal::Types::Model
|
|
7
|
-
field :name, -> { String }, optional: false, nullable: false
|
|
8
|
-
|
|
9
|
-
field :type, -> { VitableConnect::Types::OrganizationType }, optional: true, nullable: false
|
|
10
|
-
end
|
|
11
|
-
end
|
|
12
|
-
end
|
|
13
|
-
end
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module VitableConnect
|
|
4
|
-
module Types
|
|
5
|
-
class Organization < Internal::Types::Model
|
|
6
|
-
field :id, -> { String }, optional: false, nullable: false
|
|
7
|
-
|
|
8
|
-
field :name, -> { String }, optional: false, nullable: false
|
|
9
|
-
|
|
10
|
-
field :type, -> { VitableConnect::Types::OrganizationType }, optional: false, nullable: true
|
|
11
|
-
|
|
12
|
-
field :idp_org_id, -> { String }, optional: false, nullable: true
|
|
13
|
-
|
|
14
|
-
field :idp_provider, -> { VitableConnect::Types::IdpProvider }, optional: false, nullable: true
|
|
15
|
-
|
|
16
|
-
field :super_in, -> { Internal::Types::Boolean }, optional: false, nullable: false
|
|
17
|
-
end
|
|
18
|
-
end
|
|
19
|
-
end
|