Class: VitableConnect::Models::WebhookEventListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• VitableConnect::Models::WebhookEventListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/vitable_connect/models/webhook_event_list_params.rb,
sig/vitable_connect/models/webhook_event_list_params.rbs

Overview

See Also:

• VitableConnect::Resources::WebhookEvents#list

Defined Under Namespace

Modules: EventName, ResourceType

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::VitableConnect

Instance Attribute Summary

• #created_after ⇒ Time^?
• #created_before ⇒ Time^?
• #event_name ⇒ Symbol, ...
  • enrollment.accepted - Enrollment Accepted - enrollment.terminated - Enrollment Terminated - enrollment.termination_rescheduled - Enrollment Termination Rescheduled - enrollment.elected - Enrollment Elected - enrollment.granted - Enrollment Granted - enrollment.waived - Enrollment Waived - enrollment.started - Enrollment Started - employee.eligibility_granted - Employee Eligibility Granted - employee.eligibility_terminated - Employee Eligibility Terminated - employee.deactivated - Employee Deactivated - employee.deduction_created - Employee Deduction Created.
• #limit ⇒ Integer^?

  Items per page (default: 20, max: 100).

• #page ⇒ Integer^?

  Page number (default: 1).

• #resource_id ⇒ String^?
• #resource_type ⇒ Symbol, ...
  • enrollment - Enrollment - employee - Employee - employer - Employer - dependent - Dependent - plan_year - Plan Year - payroll_deduction - Payroll Deduction.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(created_after: nil, created_before: nil, event_name: nil, limit: nil, page: nil, resource_id: nil, resource_type: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see WebhookEventListParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(created_after: nil, created_before: nil, event_name: nil, limit: nil, page: nil, resource_id: nil, resource_type: nil, request_options: {}) ⇒ Object

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

Parameters:

• created_after (Time) (defaults to: nil)
• created_before (Time) (defaults to: nil)
• event_name (Symbol, VitableConnect::Models::WebhookEventListParams::EventName) (defaults to: nil) —
  • enrollment.accepted - Enrollment Accepted
• limit (Integer) (defaults to: nil) —

  Items per page (default: 20, max: 100)

• page (Integer) (defaults to: nil) —

  Page number (default: 1)

• resource_id (String) (defaults to: nil)
• resource_type (Symbol, VitableConnect::Models::WebhookEventListParams::ResourceType) (defaults to: nil) —
  • enrollment - Enrollment
• request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 64

Instance Attribute Details

#created_after ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 13

optional :created_after, Time

#created_before ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 18

optional :created_before, Time

#event_name ⇒ Symbol, ...

• enrollment.accepted - Enrollment Accepted
• enrollment.terminated - Enrollment Terminated
• enrollment.termination_rescheduled - Enrollment Termination Rescheduled
• enrollment.elected - Enrollment Elected
• enrollment.granted - Enrollment Granted
• enrollment.waived - Enrollment Waived
• enrollment.started - Enrollment Started
• employee.eligibility_granted - Employee Eligibility Granted
• employee.eligibility_terminated - Employee Eligibility Terminated
• employee.deactivated - Employee Deactivated
• employee.deduction_created - Employee Deduction Created

Returns:

• (Symbol, VitableConnect::Models::WebhookEventListParams::EventName, nil)

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 34

optional :event_name, enum: -> { VitableConnect::WebhookEventListParams::EventName }

#limit ⇒ Integer^?

Items per page (default: 20, max: 100)

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 40

optional :limit, Integer

#page ⇒ Integer^?

Page number (default: 1)

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 46

optional :page, Integer

#resource_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 51

optional :resource_id, String

#resource_type ⇒ Symbol, ...

• enrollment - Enrollment
• employee - Employee
• employer - Employer
• dependent - Dependent
• plan_year - Plan Year
• payroll_deduction - Payroll Deduction

Returns:

• (Symbol, VitableConnect::Models::WebhookEventListParams::ResourceType, nil)

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 62

optional :resource_type, enum: -> { VitableConnect::WebhookEventListParams::ResourceType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/vitable_connect/models/webhook_event_list_params.rb', line 110

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/vitable_connect/models/webhook_event_list_params.rbs', line 62

def to_hash: -> {