Class: Knockapi::Resources::Channels::Bulk

Inherits:

Object

• Object
• Knockapi::Resources::Channels::Bulk

Defined in:

lib/knockapi/resources/channels/bulk.rb,
sig/knockapi/resources/channels/bulk.rbs

Overview

A bulk operation is a set of changes applied across zero or more records triggered via a call to the Knock API and performed asynchronously.

Instance Method Summary

• #initialize(client:) ⇒ Bulk constructor private

  A new instance of Bulk.

• #update_message_status(channel_id, action, archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {}) ⇒ Knockapi::Models::BulkOperation

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

Constructor Details

#initialize(client:) ⇒ Bulk

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 Bulk.

Parameters:

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

# File 'lib/knockapi/resources/channels/bulk.rb', line 62

def initialize(client:)
  @client = client
end

Instance Method Details

#update_message_status(channel_id, action, archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {}) ⇒ Knockapi::Models::BulkOperation

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

Bulk update the status of messages for a specific channel. The channel is specified by the channel_id parameter. The action to perform is specified by the action parameter, where the action is a status change action (e.g. archive, unarchive).

Parameters:

• channel_id (String) —

  The ID of the channel to update messages for.

• action (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action) —

  The target status to be applied to the messages.

• archived (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived) —

  Limits the results to messages with the given archived status.

• delivery_status (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus) —

  Limits the results to messages with the given delivery status.

• engagement_status (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus) —

  Limits the results to messages with the given engagement status.

• has_tenant (Boolean) —

  Limits the results to messages that have a tenant or not.

• newer_than (Time) —

  Limits the results to messages inserted after the given date.

• older_than (Time) —

  Limits the results to messages inserted before the given date.

• recipient_ids (Array<String>) —

  Limits the results to messages with the given recipient IDs.

• tenants (Array<String>) —

  Limits the results to messages with the given tenant IDs.

• trigger_data (String) —

  Limits the results to only messages that were generated with the given data. See

• workflows (Array<String>) —

  Limits the results to messages with the given workflow keys.

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

Returns:

• (Knockapi::Models::BulkOperation)

See Also:

• Models::Channels::BulkUpdateMessageStatusParams

# File 'lib/knockapi/resources/channels/bulk.rb', line 48

def update_message_status(channel_id, action, params = {})
  parsed, options = Knockapi::Channels::BulkUpdateMessageStatusParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/channels/%1$s/messages/bulk/%2$s", channel_id, action],
    body: parsed,
    model: Knockapi::BulkOperation,
    options: options
  )
end