Class: VitableConnect::Resources::Enrollments

Inherits:
Object
  • Object
show all
Defined in:
lib/vitable_connect/resources/enrollments.rb,
sig/vitable_connect/resources/enrollments.rbs

Overview

Manage benefit enrollments and elections for employees

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Enrollments

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Enrollments.

Parameters:



105
106
107
 
# File 'lib/vitable_connect/resources/enrollments.rb', line 105

def initialize(client:)
  @client = client
end

Instance Method Details

#reissue(enrollment_id, qualifying_life_event_id: nil, reason: nil, ticket_number: nil, request_options: {}) ⇒ VitableConnect::Models::EnrollmentReissueResponse

Some parameter documentations has been truncated, see Models::EnrollmentReissueParams for more details.

Closes the targeted enrollment and creates a new unanswered enrollment for the same member and plan year. VPC never requires a qualifying life event; other products require an accepted, member-owned event outside open enrollment. User-backed callers must provide a reason; it is optional for userless organization callers. API keys and unbound access tokens may act across the caller organization's book. Employer-bound access tokens may act only on that employer's enrollments, and employee-bound access tokens may act only on that employee's enrollment. Tenant or token-scope mismatches return the same non-disclosing 404 before the request body is validated.

Parameters:

  • enrollment_id (String) —

    Unique enrollment identifier (enrl_*)

  • qualifying_life_event_id (String, nil) —

    Accepted member qualifying life event identifier (qle_*)

  • reason (String, nil) —

    Audit reason for the reissue; required for user-backed callers and optional for

  • ticket_number (String, nil) —

    Optional support or operational ticket number

  • request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/vitable_connect/resources/enrollments.rb', line 55

def reissue(enrollment_id, params = {})
  parsed, options = VitableConnect::EnrollmentReissueParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/enrollments/%1$s/reissue", enrollment_id],
    body: parsed,
    model: VitableConnect::Models::EnrollmentReissueResponse,
    options: options
  )
end

#retrieve(enrollment_id, request_options: {}) ⇒ VitableConnect::Models::EnrollmentRetrieveResponse

Retrieves detailed information for a specific enrollment by ID.

Parameters:

Returns:

See Also:



18
19
20
21
22
23
24
25
 
# File 'lib/vitable_connect/resources/enrollments.rb', line 18

def retrieve(enrollment_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/enrollments/%1$s", enrollment_id],
    model: VitableConnect::Models::EnrollmentRetrieveResponse,
    options: params[:request_options]
  )
end

#terminate(enrollment_id, qualifying_life_event_id: nil, reason: nil, ticket_number: nil, request_options: {}) ⇒ nil

Some parameter documentations has been truncated, see Models::EnrollmentTerminateParams for more details.

Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. User-backed callers must provide a reason; it is optional for userless organization callers. API keys may act across the caller organization's book. Tenant mismatches return the same non-disclosing 404 before the request body is validated.

Parameters:

  • enrollment_id (String) —

    Unique enrollment identifier (enrl_*)

  • qualifying_life_event_id (String, nil) —

    Accepted member qualifying life event identifier (qle_*)

  • reason (String, nil) —

    Audit reason for the termination; required for user-backed callers and optional

  • ticket_number (String, nil) —

    Optional support or operational ticket number

  • request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/vitable_connect/resources/enrollments.rb', line 91

def terminate(enrollment_id, params = {})
  parsed, options = VitableConnect::EnrollmentTerminateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/enrollments/%1$s/terminate", enrollment_id],
    body: parsed,
    model: NilClass,
    options: options
  )
end