Class: Knockapi::Models::ScheduleListParams

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

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(workflow:, after: nil, before: nil, page_size: nil, recipients: nil, tenant: nil, request_options: {}) ⇒ Object

Parameters:

  • workflow (String) —

    Filter by workflow key.

  • after (String) (defaults to: nil) —

    The cursor to fetch entries after.

  • before (String) (defaults to: nil) —

    The cursor to fetch entries before.

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

    The number of items per page (defaults to 50).

  • recipients (Array<String, Knockapi::Models::RecipientReference::ObjectReference>) (defaults to: nil) —

    Filter by recipient references.

  • tenant (String) (defaults to: nil) —

    Filter by tenant ID.

  • request_options (Knockapi::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/knockapi/models/schedule_list_params.rb', line 46

Instance Attribute Details

#after ⇒ String?

The cursor to fetch entries after.

Returns:

  • (String, nil) 


20
 
# File 'lib/knockapi/models/schedule_list_params.rb', line 20

optional :after, String

#before ⇒ String?

The cursor to fetch entries before.

Returns:

  • (String, nil) 


26
 
# File 'lib/knockapi/models/schedule_list_params.rb', line 26

optional :before, String

#page_size ⇒ Integer?

The number of items per page (defaults to 50).

Returns:

  • (Integer, nil) 


32
 
# File 'lib/knockapi/models/schedule_list_params.rb', line 32

optional :page_size, Integer

#recipients ⇒ Array<String, Knockapi::Models::RecipientReference::ObjectReference>?

Filter by recipient references.

Returns:



38
 
# File 'lib/knockapi/models/schedule_list_params.rb', line 38

optional :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }

#tenant ⇒ String?

Filter by tenant ID.

Returns:

  • (String, nil) 


44
 
# File 'lib/knockapi/models/schedule_list_params.rb', line 44

optional :tenant, String

#workflow ⇒ String

Filter by workflow key.

Returns:

  • (String) 


14
 
# File 'lib/knockapi/models/schedule_list_params.rb', line 14

required :workflow, String