vitable-connect 4.0.0 → 5.0.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bd641f8cbcc651041563f6c1fecc4aab6a27ab3909b001fa3b3eaa00ccd9871a
4
- data.tar.gz: aca5cbedb59b94753becde48a42260f1c4a3086a6adea5850ebd0432584ff48f
3
+ metadata.gz: b162298617d7b89533daa5c67fa965d07aca620afb55ae41ab8586ba238086e1
4
+ data.tar.gz: 2bfd5a1e8ec9a287b5c476a1d8398f6038bb93f78c7d2c994c8adc714e14d68d
5
5
  SHA512:
6
- metadata.gz: 1cec2e039c69e02007532b5089cce1be6ce7652ad5577fa010e81a6cea407a57640e24e56d7e0b1a221e0ff947e02b1be3d5ef0fe3333ca2319d98da51b473de
7
- data.tar.gz: 7d23eb05aab210dc106668373219d2a5fc6d7261a246a268c1332dc53a7d6f6a2cab839d1e29e1d9a908dddbd539b5ae71141a3d8a2fefe162593c8a84fadc69
6
+ metadata.gz: 7427cc04b8ec323b3093265cdc548a3e901b79dd0f0e1e636d611a971bed1031a9ccd8e0ce1e14dd3433f0f9ad033eb30b03e9a3154909899dc03074132e0dad
7
+ data.tar.gz: 9a588fd86d8a7fea25500ac2a054fff7111a57d5a7914e59401044c1ab1a9cb6b0cf18d7099ec0566b58288c3dcf736280009b569a43aa9717fc71a8bb034065
data/.fern/metadata.json CHANGED
@@ -7,10 +7,10 @@
7
7
  "offsetSemantics": "page-index",
8
8
  "respectAuthSchemeNames": true
9
9
  },
10
- "originGitCommit": "12dcf229a31e934e995568332f46ee8b2da93c69",
10
+ "originGitCommit": "c5381ba7a87884d1cd29c57d6f2a896ba2222903",
11
11
  "originGitCommitIsDirty": false,
12
12
  "invokedBy": "ci",
13
13
  "requestedVersion": "AUTO",
14
14
  "ciProvider": "gitlab",
15
- "sdkVersion": "4.0.0"
15
+ "sdkVersion": "5.0.0"
16
16
  }
data/changelog.md CHANGED
@@ -1,3 +1,16 @@
1
+ ## 5.0.0 - 2026-09-24
2
+ ### Breaking Changes
3
+ * **`VitableConnect::Types::AccessMethod`** has been removed. Replace any references with `VitableConnect::Types::PayrollAccessMethod`, which carries the same `SELF_SETUP` and `NEEDS_HELP` values.
4
+ * **`VitableConnect::Types::AdditionalAccessMethod`** has been removed. The `additional_access_method` field on `SubmitPayrollAccessSetupRequest` now uses `VitableConnect::Types::PayrollAccessMethod`; update any constant references accordingly.
5
+ * **`VitableConnect::Types::BenefitPlanNetwork#address`** now returns a `DetailedAddress` instead of an `Address`. Update any code that reads fields from this object to use the new `DetailedAddress` shape.
6
+ ### Added
7
+ * **`VitableConnect::Types::PayrollAccessMethod`** — unified enum replacing the former `AccessMethod` and `AdditionalAccessMethod` enums, used for both primary and additional payroll access method fields.
8
+ * **`VitableConnect::Types::DetailedAddress`** — new structured address model with `address_line_1`, `address_line_2`, `city`, `zipcode`, `state`, `latitude`, `longitude`, `county_fips_code`, and `county_name` fields.
9
+
10
+ ## 4.1.0 - 2026-09-22
11
+ ### Added
12
+ * **`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.
13
+
1
14
  ## 4.0.0 - 2026-09-16
2
15
  ### Breaking Changes
3
16
  * **`VitableConnect::Organizations::Client#create`** has been removed. Any calls to `client.organizations.create(...)` will raise `NoMethodError`; remove or replace these call sites.
@@ -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/4.0.0",
14
+ "User-Agent" => "vitable-connect/5.0.0",
15
15
  "X-Fern-Language" => "Ruby",
16
16
  Authorization: "Bearer #{api_key}"
17
17
  },
@@ -28,7 +28,7 @@ module VitableConnect
28
28
 
29
29
  field :same_payroll_covers_other_eins, -> { Internal::Types::Boolean }, optional: true, nullable: false
30
30
 
31
- field :access_method, -> { VitableConnect::Types::AccessMethod }, optional: false, nullable: false
31
+ field :access_method, -> { VitableConnect::Types::PayrollAccessMethod }, optional: false, nullable: false
32
32
 
33
33
  field :login_url, -> { String }, optional: true, nullable: false
34
34
 
@@ -42,7 +42,7 @@ module VitableConnect
42
42
 
43
43
  field :has_additional_payroll_system, -> { Internal::Types::Boolean }, optional: false, nullable: false
44
44
 
45
- field :additional_access_method, -> { VitableConnect::Types::AdditionalAccessMethod }, optional: true, nullable: false
45
+ field :additional_access_method, -> { VitableConnect::Types::PayrollAccessMethod }, optional: true, nullable: false
46
46
 
47
47
  field :additional_login_url, -> { String }, optional: true, nullable: false
48
48
 
@@ -9,7 +9,7 @@ module VitableConnect
9
9
 
10
10
  field :logo, -> { String }, optional: false, nullable: true
11
11
 
12
- field :address, -> { VitableConnect::Types::Address }, optional: false, nullable: false
12
+ field :address, -> { VitableConnect::Types::DetailedAddress }, optional: false, nullable: false
13
13
 
14
14
  field :edi, -> { String }, optional: true, nullable: false
15
15
 
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ module VitableConnect
4
+ module Types
5
+ class DetailedAddress < Internal::Types::Model
6
+ field :address_line1, -> { String }, optional: false, nullable: false, api_name: "address_line_1"
7
+
8
+ field :address_line2, -> { String }, optional: true, nullable: false, api_name: "address_line_2"
9
+
10
+ field :city, -> { String }, optional: false, nullable: false
11
+
12
+ field :zipcode, -> { String }, optional: false, nullable: false
13
+
14
+ field :state, -> { VitableConnect::Types::State }, optional: false, nullable: false
15
+
16
+ field :latitude, -> { Integer }, optional: true, nullable: false
17
+
18
+ field :longitude, -> { Integer }, optional: true, nullable: false
19
+
20
+ field :county_fips_code, -> { String }, optional: true, nullable: false
21
+
22
+ field :county_name, -> { String }, optional: true, nullable: false
23
+ end
24
+ end
25
+ 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
@@ -2,7 +2,7 @@
2
2
 
3
3
  module VitableConnect
4
4
  module Types
5
- module AccessMethod
5
+ module PayrollAccessMethod
6
6
  extend VitableConnect::Internal::Types::Enum
7
7
 
8
8
  SELF_SETUP = "SELF_SETUP"
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module VitableConnect
4
- VERSION = "4.0.0"
4
+ VERSION = "5.0.0"
5
5
  end
@@ -39,25 +39,26 @@ require_relative "VitableConnect/types/benefit_family_param_item"
39
39
  require_relative "VitableConnect/types/benefit_lifecycle_stage_item"
40
40
  require_relative "VitableConnect/types/hris_status_item"
41
41
  require_relative "VitableConnect/types/election_status_item"
42
- require_relative "VitableConnect/types/access_method"
43
42
  require_relative "VitableConnect/types/bound_entity_type"
44
43
  require_relative "VitableConnect/types/bound_entity_response"
45
44
  require_relative "VitableConnect/types/access_token_response"
46
- require_relative "VitableConnect/types/additional_access_method"
47
45
  require_relative "VitableConnect/types/address"
48
46
  require_relative "VitableConnect/types/address_request"
49
47
  require_relative "VitableConnect/types/benefit_family"
48
+ require_relative "VitableConnect/types/state"
49
+ require_relative "VitableConnect/types/detailed_address"
50
50
  require_relative "VitableConnect/types/benefit_plan_network"
51
51
  require_relative "VitableConnect/types/benefit_status"
52
52
  require_relative "VitableConnect/types/contribution_class_compensation"
53
53
  require_relative "VitableConnect/types/contribution_class_employment"
54
54
  require_relative "VitableConnect/types/contribution_class_location"
55
+ require_relative "VitableConnect/types/contribution_range"
55
56
  require_relative "VitableConnect/types/coverage_tier"
56
57
  require_relative "VitableConnect/types/eligibility_rule_compensation_type"
57
58
  require_relative "VitableConnect/types/eligibility_rule_employee_class"
59
+ require_relative "VitableConnect/types/enrollment_rate"
58
60
  require_relative "VitableConnect/types/termination_rule"
59
61
  require_relative "VitableConnect/types/waiting_period"
60
- require_relative "VitableConnect/types/contribution_range"
61
62
  require_relative "VitableConnect/types/contribution_tier"
62
63
  require_relative "VitableConnect/types/ichra_contribution_class"
63
64
  require_relative "VitableConnect/types/contribution_strategy"
@@ -65,7 +66,6 @@ require_relative "VitableConnect/types/eligible_geographical_location_type"
65
66
  require_relative "VitableConnect/types/eligible_geographical_location"
66
67
  require_relative "VitableConnect/types/eligibility_policy_rule"
67
68
  require_relative "VitableConnect/types/eligibility_policy"
68
- require_relative "VitableConnect/types/enrollment_rate"
69
69
  require_relative "VitableConnect/types/benefit_plan_year_detail"
70
70
  require_relative "VitableConnect/types/benefit_plan_year_list"
71
71
  require_relative "VitableConnect/types/category"
@@ -75,7 +75,6 @@ require_relative "VitableConnect/types/bound_entity"
75
75
  require_relative "VitableConnect/types/card_type"
76
76
  require_relative "VitableConnect/types/census_sync_response"
77
77
  require_relative "VitableConnect/types/census_sync_detail_response"
78
- require_relative "VitableConnect/types/state"
79
78
  require_relative "VitableConnect/types/census_sync_employee_address_request"
80
79
  require_relative "VitableConnect/types/compensation_type"
81
80
  require_relative "VitableConnect/types/employee_class"
@@ -172,6 +171,7 @@ require_relative "VitableConnect/types/organization_type"
172
171
  require_relative "VitableConnect/types/organization_user_role"
173
172
  require_relative "VitableConnect/types/organization_membership"
174
173
  require_relative "VitableConnect/types/organizations_list_response"
174
+ require_relative "VitableConnect/types/payroll_access_method"
175
175
  require_relative "VitableConnect/types/payroll_access_setup_status"
176
176
  require_relative "VitableConnect/types/payroll_access_setup_status_response"
177
177
  require_relative "VitableConnect/types/payroll_integration_email"
@@ -187,13 +187,13 @@ require_relative "VitableConnect/types/update_employer_address_input"
187
187
  require_relative "VitableConnect/types/webhook_event"
188
188
  require_relative "VitableConnect/types/webhook_event_list_response"
189
189
  require_relative "VitableConnect/types/webhook_event_response"
190
- require_relative "VitableConnect/types/employee_id"
190
+ require_relative "VitableConnect/types/x_vitable_organization"
191
+ require_relative "VitableConnect/types/employer_id"
191
192
  require_relative "VitableConnect/types/limit"
192
193
  require_relative "VitableConnect/types/page"
193
- require_relative "VitableConnect/types/x_vitable_organization"
194
- require_relative "VitableConnect/types/include_cancelled"
195
194
  require_relative "VitableConnect/types/search"
196
- require_relative "VitableConnect/types/employer_id"
195
+ require_relative "VitableConnect/types/employee_id"
196
+ require_relative "VitableConnect/types/include_cancelled"
197
197
  require_relative "VitableConnect/types/benefit_plan_year_id"
198
198
  require_relative "VitableConnect/types/employer_search"
199
199
  require_relative "VitableConnect/types/employee_search"
data/reference.md CHANGED
@@ -1736,7 +1736,7 @@ client.employers.submit_payroll_access_setup(
1736
1736
  <dl>
1737
1737
  <dd>
1738
1738
 
1739
- **access_method:** `VitableConnect::Types::AccessMethod`
1739
+ **access_method:** `VitableConnect::Types::PayrollAccessMethod`
1740
1740
 
1741
1741
  </dd>
1742
1742
  </dl>
@@ -1792,7 +1792,7 @@ client.employers.submit_payroll_access_setup(
1792
1792
  <dl>
1793
1793
  <dd>
1794
1794
 
1795
- **additional_access_method:** `VitableConnect::Types::AdditionalAccessMethod` — How Vitable will access the second payroll system.
1795
+ **additional_access_method:** `VitableConnect::Types::PayrollAccessMethod` — How Vitable will access the second payroll system.
1796
1796
 
1797
1797
  </dd>
1798
1798
  </dl>
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.0.0
4
+ version: 5.0.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-16 00:00:00.000000000 Z
11
+ date: 2026-09-24 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.
@@ -111,9 +111,7 @@ files:
111
111
  - lib/VitableConnect/organizations/client.rb
112
112
  - lib/VitableConnect/plans/client.rb
113
113
  - lib/VitableConnect/plans/types/list_plans_request.rb
114
- - lib/VitableConnect/types/access_method.rb
115
114
  - lib/VitableConnect/types/access_token_response.rb
116
- - lib/VitableConnect/types/additional_access_method.rb
117
115
  - lib/VitableConnect/types/address.rb
118
116
  - lib/VitableConnect/types/address_request.rb
119
117
  - lib/VitableConnect/types/benefit_family.rb
@@ -147,6 +145,7 @@ files:
147
145
  - lib/VitableConnect/types/created_before.rb
148
146
  - lib/VitableConnect/types/deduction_detail.rb
149
147
  - lib/VitableConnect/types/deduction_frequency.rb
148
+ - lib/VitableConnect/types/detailed_address.rb
150
149
  - lib/VitableConnect/types/digital_benefit_card.rb
151
150
  - lib/VitableConnect/types/election_status_item.rb
152
151
  - lib/VitableConnect/types/eligibility_policy.rb
@@ -252,6 +251,7 @@ files:
252
251
  - lib/VitableConnect/types/organizations_list_response.rb
253
252
  - lib/VitableConnect/types/page.rb
254
253
  - lib/VitableConnect/types/pagination.rb
254
+ - lib/VitableConnect/types/payroll_access_method.rb
255
255
  - lib/VitableConnect/types/payroll_access_setup_status.rb
256
256
  - lib/VitableConnect/types/payroll_access_setup_status_response.rb
257
257
  - lib/VitableConnect/types/payroll_deduction_statement.rb
@@ -1,12 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module VitableConnect
4
- module Types
5
- module AdditionalAccessMethod
6
- extend VitableConnect::Internal::Types::Enum
7
-
8
- SELF_SETUP = "SELF_SETUP"
9
- NEEDS_HELP = "NEEDS_HELP"
10
- end
11
- end
12
- end