vitable-connect 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e05e3a3f3747ca3413326b3d1c8e45146d55f7a75613ab1ffac7a9f0fc295037
-  data.tar.gz: aa0805a497b13fdc5569d925b0f1e32958c30f8a259cada8e079e40ca6628064
+  metadata.gz: 3876def06b9afaa111d207b5ffda7fffde2f86ef71be0a25678b381e85ad89ba
+  data.tar.gz: cab5048d7b03f986723d3710a7422975f6e3979fc16293c5a32520bbf54c8260
 SHA512:
-  metadata.gz: e44d7da1af9af98b949125ac11120ff60abb30452a96454171324a701a849ba66fcf8f767d31a6367f3f374c42f6b60844e6a669ab8984de7271bd607f396490
-  data.tar.gz: 10b184369640ce94f2899e739635bc59e4f9c5611ff199104d602b38dc9669124adb98e8f1d42ab62eed0631ec4ce5b219fdb3e68607f0338568d2a855e73c19
+  metadata.gz: 4b52a45594ec11e90b5dad8342de2d66a752a5ee9aa1a9de97ed47e36b2f62d5ee1ca3417a3754cf7ae5bcb6d4a3676a4b65c41256e7a72efda27f4cfd793d39
+  data.tar.gz: b939ad09ccd2324532fce2367a80890fac4a6ec8e9d722883a65ea1b7643b19b29154d93d1aa2c9185e85b15a7afdd3120a49e5913b111cb4d619ed01487ab52

data/.fern/metadata.json

@@ -7,10 +7,10 @@
     "offsetSemantics": "page-index",
     "respectAuthSchemeNames": true
   },
-  "originGitCommit": "64323692ea69e2f0cf1d57beaa927d91c19d25bf",
+  "originGitCommit": "9736b4df903f268951f7b298f0c9ebd03e9c1515",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
   "requestedVersion": "AUTO",
   "ciProvider": "gitlab",
-  "sdkVersion": "5.1.0"
+  "sdkVersion": "5.2.0"
 }

data/changelog.md

@@ -1,3 +1,11 @@
+## 5.2.0 - 2026-10-02
+### Added
+* **`VitableConnect::Members::Client#create_dependent`** — new method that saves a spouse or child dependent for a member, posting to `v1/members/:member_id/dependents`; returns a `SavedMemberDependentResponse` with `created: true` for new dependents or `created: false` when an existing active match is reused.
+* **`VitableConnect::Members::Types::CreateMemberDependentRequest`** — request model for the new endpoint, with required fields `member_id`, `first_name`, `last_name`, `date_of_birth`, `relationship`, and `address`, plus optional fields `suffix`, `sex_at_birth`, `gender`, `email`, `phone`, and `vitable_organization`.
+* **`VitableConnect::Types::CreateMemberDependentAddressRequest`** — address model used within the create-dependent request, accepting `address_line1`, `city`, `state`, and `zipcode` (required) plus optional `address_line2`.
+* **`VitableConnect::Types::SavedMemberDependent`** — response model representing a saved dependent row, including `member_id`, `primary_member_id`, `first_name`, `last_name`, `relationship`, `date_of_birth`, `age`, `sex_at_birth`, `legal_dependent_id`, and `created`.
+* **`VitableConnect::Types::SavedMemberDependentResponse`** — wrapper response type containing a single `SavedMemberDependent` in its `data` field.
+
 ## 5.1.0 - 2026-09-28
 ### Added
 * **`VitableConnect::Types::PlanYearIchraAffordability`** — new enum with `AFFORDABLE` and `NOT_AFFORDABLE` values indicating whether an ICHRA plan year meets affordability requirements.

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/5.1.0",
+          "User-Agent" => "vitable-connect/5.2.0",
           "X-Fern-Language" => "Ruby",
           Authorization: "Bearer #{api_key}"
         },

data/lib/VitableConnect/members/client.rb

@@ -97,6 +97,76 @@ module VitableConnect
         end
       end
 
+      # Saves a dependent (spouse or child) for a member. Saving does not enroll the dependent or change the member's
+      # coverage or coverage tier. If the member already has an active dependent matching this person, that relationship
+      # is reused and returned with a 200 and `created: false`; otherwise a new one is created with a 201 and `created:
+      # true`. In both cases the dependent's address is set to the one supplied; other details of a person Vitable
+      # already has on file are not changed. When a new dependent is created at exactly the member's address, Vitable
+      # also adds them to the member's household where it can; this never fails the request. The returned IDs identify
+      # the saved dependent. Social Security numbers are not accepted, and a body with an `ssn` field returns a 400. The
+      # caller must have write access to the target member, and API access tokens cannot save dependents. A member not
+      # visible to the caller returns a 404 before the body is validated. Business-rule failures return a 422 with
+      # `child_over_max_age` (a child must be under 26), `duplicate_active_spouse` (the member already has a different
+      # active spouse), `same_member`, `member_creation_failed`, or `legal_dependent_creation_failed`.
+      #
+      # @param request_options [Hash]
+      # @param params [VitableConnect::Members::Types::CreateMemberDependentRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [VitableConnect::Types::MemberID] :member_id
+      # @option params [String, nil] :vitable_organization
+      #
+      # @example
+      #   client.members.create_dependent(
+      #     member_id: "mbr_abc123def456",
+      #     first_name: "Sam",
+      #     last_name: "Doe",
+      #     date_of_birth: "2015-06-01",
+      #     sex_at_birth: "Male",
+      #     relationship: "Child",
+      #     address: {
+      #       address_line1: "123 Main St",
+      #       city: "Detroit",
+      #       state: "MI",
+      #       zipcode: "48201"
+      #     }
+      #   )
+      #
+      # @return [VitableConnect::Types::SavedMemberDependentResponse]
+      def create_dependent(request_options: {}, **params)
+        params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        request_data = VitableConnect::Members::Types::CreateMemberDependentRequest.new(params).to_h
+        non_body_param_names = %w[member_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: "POST",
+          path: "v1/members/#{URI.encode_uri_component(params[:member_id].to_s)}/dependents",
+          headers: headers,
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise VitableConnect::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          VitableConnect::Types::SavedMemberDependentResponse.load(response.body)
+        else
+          error_class = VitableConnect::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # Lists a member's employment across every employer — the same employee record shape as the employer's employees
       # list, plus the employer name. For an organization caller the rows are scoped to companies in that organization's
       # book; a member (self/household) or Vitable Admin sees all employments. A member not visible to the caller

data/lib/VitableConnect/members/types/create_member_dependent_request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Members
+    module Types
+      class CreateMemberDependentRequest < Internal::Types::Model
+        field :member_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
+
+        field :first_name, -> { String }, optional: false, nullable: false
+
+        field :last_name, -> { String }, optional: false, nullable: false
+
+        field :suffix, -> { VitableConnect::Types::NameSuffix }, optional: true, nullable: false
+
+        field :date_of_birth, -> { String }, optional: false, nullable: false
+
+        field :sex_at_birth, -> { VitableConnect::Types::SexAtBirth }, optional: true, nullable: false
+
+        field :gender, -> { VitableConnect::Types::Gender }, optional: true, nullable: false
+
+        field :email, -> { String }, optional: true, nullable: false
+
+        field :phone, -> { String }, optional: true, nullable: false
+
+        field :relationship, -> { VitableConnect::Types::Relationship }, optional: false, nullable: false
+
+        field :address, -> { VitableConnect::Types::CreateMemberDependentAddressRequest }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/types/create_member_dependent_address_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class CreateMemberDependentAddressRequest < Internal::Types::Model
+      field :address_line1, -> { String }, optional: false, nullable: false, api_name: "address_line_1"
+
+      field :address_line2, -> { String }, optional: true, nullable: false, api_name: "address_line_2"
+
+      field :city, -> { String }, optional: false, nullable: false
+
+      field :state, -> { VitableConnect::Types::State }, optional: false, nullable: false
+
+      field :zipcode, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/saved_member_dependent.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Wire serializer for :class:`MemberLegalDependentDTO` (one legal-dependent row).
+    class SavedMemberDependent < Internal::Types::Model
+      field :member_id, -> { String }, optional: true, nullable: false
+
+      field :primary_member_id, -> { String }, optional: true, nullable: false
+
+      field :first_name, -> { String }, optional: false, nullable: false
+
+      field :last_name, -> { String }, optional: false, nullable: false
+
+      field :relationship, -> { VitableConnect::Types::Relationship }, optional: false, nullable: false
+
+      field :date_of_birth, -> { String }, optional: false, nullable: false
+
+      field :age, -> { Integer }, optional: false, nullable: false
+
+      field :sex_at_birth, -> { VitableConnect::Types::SexAtBirth }, optional: true, nullable: false
+
+      field :legal_dependent_id, -> { String }, optional: false, nullable: false
+
+      field :created, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/saved_member_dependent_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Response containing a single saved member dependent resource.
+    class SavedMemberDependentResponse < Internal::Types::Model
+      field :data, -> { VitableConnect::Types::SavedMemberDependent }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/version.rb

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

data/lib/VitableConnect.rb

@@ -80,6 +80,7 @@ require_relative "VitableConnect/types/compensation_type"
 require_relative "VitableConnect/types/employee_class"
 require_relative "VitableConnect/types/census_sync_employee_request"
 require_relative "VitableConnect/types/classification_correction_source"
+require_relative "VitableConnect/types/create_member_dependent_address_request"
 require_relative "VitableConnect/types/deduction_frequency"
 require_relative "VitableConnect/types/tax_classification"
 require_relative "VitableConnect/types/deduction_detail"
@@ -184,6 +185,8 @@ require_relative "VitableConnect/types/plan_year_enrollment_list_response"
 require_relative "VitableConnect/types/reissue_enrollment"
 require_relative "VitableConnect/types/reissue_enrollment_response"
 require_relative "VitableConnect/types/remaining_employee_action"
+require_relative "VitableConnect/types/saved_member_dependent"
+require_relative "VitableConnect/types/saved_member_dependent_response"
 require_relative "VitableConnect/types/update_employer_address_input"
 require_relative "VitableConnect/types/webhook_event"
 require_relative "VitableConnect/types/webhook_event_list_response"
@@ -250,6 +253,7 @@ require_relative "VitableConnect/groups/types/patched_update_group_request"
 require_relative "VitableConnect/members/client"
 require_relative "VitableConnect/members/types/get_members_request"
 require_relative "VitableConnect/members/types/list_dependents_members_request"
+require_relative "VitableConnect/members/types/create_member_dependent_request"
 require_relative "VitableConnect/members/types/list_employments_members_request"
 require_relative "VitableConnect/members/types/list_enrollments_members_request"
 require_relative "VitableConnect/members/types/get_household_members_request"

data/reference.md

@@ -201,7 +201,7 @@ client.employees.update(
 <dl>
 <dd>
 
-**phone:** `String` — Phone number
+**phone:** `String` — 10-digit US phone number; formatting characters and a leading 1 are ignored
     
 </dd>
 </dl>
@@ -2852,6 +2852,199 @@ client.members.list_dependents(member_id: "mbr_abc123def456")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.members.<a href="/lib/VitableConnect/members/client.rb">create_dependent</a>(member_id:, request) -> VitableConnect::Types::SavedMemberDependentResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Saves a dependent (spouse or child) for a member. Saving does not enroll the dependent or change the member's coverage or coverage tier. If the member already has an active dependent matching this person, that relationship is reused and returned with a 200 and `created: false`; otherwise a new one is created with a 201 and `created: true`. In both cases the dependent's address is set to the one supplied; other details of a person Vitable already has on file are not changed. When a new dependent is created at exactly the member's address, Vitable also adds them to the member's household where it can; this never fails the request. The returned IDs identify the saved dependent. Social Security numbers are not accepted, and a body with an `ssn` field returns a 400. The caller must have write access to the target member, and API access tokens cannot save dependents. A member not visible to the caller returns a 404 before the body is validated. Business-rule failures return a 422 with `child_over_max_age` (a child must be under 26), `duplicate_active_spouse` (the member already has a different active spouse), `same_member`, `member_creation_failed`, or `legal_dependent_creation_failed`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.members.create_dependent(
+  member_id: "mbr_abc123def456",
+  first_name: "Sam",
+  last_name: "Doe",
+  date_of_birth: "2015-06-01",
+  sex_at_birth: "Male",
+  relationship: "Child",
+  address: {
+    address_line1: "123 Main St",
+    city: "Detroit",
+    state: "MI",
+    zipcode: "48201"
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**member_id:** `String` — Unique member identifier (mbr_*)
+    
+</dd>
+</dl>
+
+<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>
+
+**first_name:** `String` — Dependent's legal first name
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**last_name:** `String` — Dependent's legal last name
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**suffix:** `VitableConnect::Types::NameSuffix` 
+
+Name suffix
+
+* `Sr` - Sr
+* `Jr` - Jr
+* `I` - I
+* `II` - II
+* `III` - III
+* `IV` - IV
+* `V` - V
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**date_of_birth:** `String` — Date of birth (YYYY-MM-DD); cannot be in the future
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**sex_at_birth:** `VitableConnect::Types::SexAtBirth` 
+
+Sex assigned at birth
+
+* `Male` - Male
+* `Female` - Female
+* `Other` - Other
+* `Unknown` - Unknown
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**gender:** `VitableConnect::Types::Gender` 
+
+Gender identity
+
+* `Male` - Male
+* `Female` - Female
+* `Transgender` - Transgender
+* `Non-binary` - Non-binary
+* `Prefer not to respond` - Prefer not to respond
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**email:** `String` — Dependent's email address. Ignored for dependents under 18, and not changed for a dependent Vitable already has on file.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**phone:** `String` — Dependent's 10-digit US phone number; formatting characters and a leading 1 are ignored. Ignored for dependents under 18, and not changed for a dependent Vitable already has on file.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**relationship:** `VitableConnect::Types::Relationship` 
+
+Relationship of the dependent to the member
+
+* `Spouse` - Spouse
+* `Child` - Child
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**address:** `VitableConnect::Types::CreateMemberDependentAddressRequest` — Dependent's residential address
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `VitableConnect::Members::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitable-connect
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - VitableConnect
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-28 00:00:00.000000000 Z
+date: 2026-10-02 00:00:00.000000000 Z
 dependencies: []
 description: The VitableConnect Ruby library provides convenient access to the VitableConnect
   API from Ruby.
@@ -100,6 +100,7 @@ files:
 - lib/VitableConnect/internal/types/unknown.rb
 - lib/VitableConnect/internal/types/utils.rb
 - lib/VitableConnect/members/client.rb
+- lib/VitableConnect/members/types/create_member_dependent_request.rb
 - lib/VitableConnect/members/types/get_household_members_request.rb
 - lib/VitableConnect/members/types/get_members_request.rb
 - lib/VitableConnect/members/types/list_dependents_members_request.rb
@@ -141,6 +142,7 @@ files:
 - lib/VitableConnect/types/contribution_strategy.rb
 - lib/VitableConnect/types/contribution_tier.rb
 - lib/VitableConnect/types/coverage_tier.rb
+- lib/VitableConnect/types/create_member_dependent_address_request.rb
 - lib/VitableConnect/types/created_after.rb
 - lib/VitableConnect/types/created_before.rb
 - lib/VitableConnect/types/deduction_detail.rb
@@ -275,6 +277,8 @@ files:
 - lib/VitableConnect/types/request_id.rb
 - lib/VitableConnect/types/resource_id.rb
 - lib/VitableConnect/types/resource_type.rb
+- lib/VitableConnect/types/saved_member_dependent.rb
+- lib/VitableConnect/types/saved_member_dependent_response.rb
 - lib/VitableConnect/types/search.rb
 - lib/VitableConnect/types/sex_at_birth.rb
 - lib/VitableConnect/types/state.rb