Class: Knockapi::Models::WorkflowCancelParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::WorkflowCancelParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/knockapi/models/workflow_cancel_params.rb

Overview

See Also:

• Resources::Workflows#cancel

Instance Attribute Summary

• #cancellation_key ⇒ String

  An optional key that is used to reference a specific workflow trigger request when issuing a [workflow cancellation](/send-notifications/canceling-workflows) request.

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

  A list of recipients to cancel the notification for.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(cancellation_key:, recipients: nil, request_options: {}) ⇒ Object constructor

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

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(cancellation_key:, recipients: nil, request_options: {}) ⇒ Object

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

Parameters:

• cancellation_key (String) —

  An optional key that is used to reference a specific workflow trigger request wh

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

  A list of recipients to cancel the notification for. If omitted, cancels for all

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

# File 'lib/knockapi/models/workflow_cancel_params.rb', line 29

Instance Attribute Details

#cancellation_key ⇒ String

An optional key that is used to reference a specific workflow trigger request when issuing a [workflow cancellation](/send-notifications/canceling-workflows) request. Must be provided while triggering a workflow in order to enable subsequent cancellation. Should be unique across trigger requests to avoid unintentional cancellations.

Returns:

• (String)

# File 'lib/knockapi/models/workflow_cancel_params.rb', line 18

required :cancellation_key, String

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

A list of recipients to cancel the notification for. If omitted, cancels for all recipients associated with the cancellation key.

Returns:

• (Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil)

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

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