Class: VitableConnect::Models::WebhookEventListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/vitable_connect/models/webhook_event_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: EventName, ResourceType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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:




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

Instance Attribute Details

#created_after ⇒ Time?

Returns:

  • (Time, nil) 


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

optional :created_after, Time

#created_before ⇒ Time?

Returns:

  • (Time, nil) 


18
 
# 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.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

  • ‘employer.eligibility_policy_created` - Employer Eligibility Policy Created

  • ‘employee.deduction_created` - Employee Deduction Created

Returns:



34
 
# 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)

Returns:

  • (Integer, nil) 


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

optional :limit, Integer

#page ⇒ Integer?

Page number (default: 1)

Returns:

  • (Integer, nil) 


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

optional :page, Integer

#resource_id ⇒ String?

Returns:

  • (String, nil) 


51
 
# 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:



62
 
# 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