Class: Knockapi::Models::UserListSchedulesParams

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

Overview

See Also:

  • Knockapi::Resources::Users#list_schedules

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

Parameters:

  • user_id (String)
  • 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).

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

    The tenant ID to filter schedules for.

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

    The workflow key to filter schedules for.

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



# File 'lib/knockapi/models/user_list_schedules_params.rb', line 45

Instance Attribute Details

#after ⇒ String?

The cursor to fetch entries after.

Parameters:

  • (String)

Returns:

  • (String, nil) 


19
 
# File 'lib/knockapi/models/user_list_schedules_params.rb', line 19

optional :after, String

#before ⇒ String?

The cursor to fetch entries before.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/knockapi/models/user_list_schedules_params.rb', line 25

optional :before, String

#page_size ⇒ Integer?

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

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


31
 
# File 'lib/knockapi/models/user_list_schedules_params.rb', line 31

optional :page_size, Integer

#tenant ⇒ String?

The tenant ID to filter schedules for.

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/knockapi/models/user_list_schedules_params.rb', line 37

optional :tenant, String

#user_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/knockapi/models/user_list_schedules_params.rb', line 13

required :user_id, String

#workflow ⇒ String?

The workflow key to filter schedules for.

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/knockapi/models/user_list_schedules_params.rb', line 43

optional :workflow, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/knockapi/models/user_list_schedules_params.rbs', line 50

def to_hash: -> {