Class: Knockapi::Resources::Workflows

Inherits:

Object

• Object
• Knockapi::Resources::Workflows

Defined in:

lib/knockapi/resources/workflows.rb,
sig/knockapi/resources/workflows.rbs

Overview

A workflow is a structured set of steps that is triggered to produce notifications sent over channels.

Instance Method Summary

• #cancel(key, cancellation_key:, recipients: nil, request_options: {}) ⇒ nil

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

• #initialize(client:) ⇒ Workflows constructor private

  A new instance of Workflows.

• #trigger(key, recipients:, actor: nil, cancellation_key: nil, data: nil, settings: nil, tenant: nil, request_options: {}) ⇒ Knockapi::Models::WorkflowTriggerResponse

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

Constructor Details

#initialize(client:) ⇒ Workflows

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Workflows.

Parameters:

• client (Knockapi::Client)
• client: (Knockapi::Client)

# File 'lib/knockapi/resources/workflows.rb', line 83

def initialize(client:)
  @client = client
end

Instance Method Details

#cancel(key, cancellation_key:, recipients: nil, request_options: {}) ⇒ nil

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

When invoked for a workflow using a specific workflow key and cancellation key, will cancel any queued workflow runs associated with that key/cancellation key pair. Can optionally be provided one or more recipients to scope the request to.

Parameters:

• key (String) —

  The key of the workflow to cancel.

• cancellation_key (String) —

  A key that is used to reference a specific workflow trigger request when issuing

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

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

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

Returns:

• (nil)

See Also:

• Models::WorkflowCancelParams

# File 'lib/knockapi/resources/workflows.rb', line 28

def cancel(key, params)
  parsed, options = Knockapi::WorkflowCancelParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/workflows/%1$s/cancel", key],
    body: parsed,
    model: NilClass,
    options: options
  )
end

#trigger(key, recipients:, actor: nil, cancellation_key: nil, data: nil, settings: nil, tenant: nil, request_options: {}) ⇒ Knockapi::Models::WorkflowTriggerResponse

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

Trigger a workflow (specified by the key) to run for the given recipients, using the parameters provided. Returns an identifier for the workflow run request. All workflow runs are executed asynchronously. This endpoint also handles inline identifications for the actor, recipient, and tenant fields.

Parameters:

• key (String) —

  Key of the workflow to trigger.

• recipients (Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>) —

  The recipients to trigger the workflow for. Can inline identify users, objects,

• actor (String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil) —

  Specifies a recipient in a request. This can either be a user identifier (string

• cancellation_key (String, nil) —

  A key that is used to reference a specific workflow trigger request when issuing

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

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

• settings (Knockapi::Models::WorkflowTriggerParams::Settings, nil) —

  Optional settings that control how this workflow trigger is executed.

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

  An request to set a tenant inline.

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

Returns:

• (Knockapi::Models::WorkflowTriggerResponse)

See Also:

• Models::WorkflowTriggerParams

# File 'lib/knockapi/resources/workflows.rb', line 69

def trigger(key, params)
  parsed, options = Knockapi::WorkflowTriggerParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/workflows/%1$s/trigger", key],
    body: parsed,
    model: Knockapi::Models::WorkflowTriggerResponse,
    options: options
  )
end