Class: Knockapi::Models::ScheduleUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/knockapi/models/schedule_update_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(schedule_ids:, actor: nil, data: nil, ending_at: nil, repeats: nil, scheduled_at: nil, tenant: nil, request_options: {}) ⇒ Object

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

Parameters:

  • schedule_ids (Array<String>) —

    A list of schedule IDs.

  • actor (String, Knockapi::Models::RecipientReference::ObjectReference, nil) (defaults to: nil) —

    A reference to a recipient, either a user identifier (string) or an object refer

  • data (Hash{Symbol=>Object}, nil) (defaults to: nil) —

    An optional map of data to pass into the workflow execution. There is a 10MB lim

  • ending_at (Time, nil) (defaults to: nil) —

    The ending date and time for the schedule.

  • repeats (Array<Knockapi::Models::ScheduleRepeatRule>) (defaults to: nil) —

    The repeat rule for the schedule.

  • scheduled_at (Time, nil) (defaults to: nil) —

    The starting date and time for the schedule.

  • tenant (String, Knockapi::Models::TenantRequest, nil) (defaults to: nil) —

    An request to set a tenant inline.

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



# File 'lib/knockapi/models/schedule_update_params.rb', line 56

Instance Attribute Details

#actor ⇒ String, ...

A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).

Returns:



21
 
# File 'lib/knockapi/models/schedule_update_params.rb', line 21

optional :actor, union: -> { Knockapi::RecipientReference }, nil?: true

#data ⇒ Hash{Symbol=>Object}?

An optional map of data to pass into the workflow execution. There is a 10MB limit on the size of the full ‘data` payload. Any individual string value greater than 1024 bytes in length will be [truncated](/developer-tools/api-logs#log-truncation) in your logs.

Returns:



30
 
# File 'lib/knockapi/models/schedule_update_params.rb', line 30

optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true

#ending_at ⇒ Time?

The ending date and time for the schedule.

Returns:

  • (Time, nil) 


36
 
# File 'lib/knockapi/models/schedule_update_params.rb', line 36

optional :ending_at, Time, nil?: true

#repeats ⇒ Array<Knockapi::Models::ScheduleRepeatRule>?

The repeat rule for the schedule.

Returns:



42
 
# File 'lib/knockapi/models/schedule_update_params.rb', line 42

optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }

#schedule_ids ⇒ Array<String>

A list of schedule IDs.

Returns:

  • (Array<String>) 


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

required :schedule_ids, Knockapi::Internal::Type::ArrayOf[String]

#scheduled_at ⇒ Time?

The starting date and time for the schedule.

Returns:

  • (Time, nil) 


48
 
# File 'lib/knockapi/models/schedule_update_params.rb', line 48

optional :scheduled_at, Time, nil?: true

#tenant ⇒ String, ...

An request to set a tenant inline.

Returns:



54
 
# File 'lib/knockapi/models/schedule_update_params.rb', line 54

optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true