Class: Knockapi::Resources::Schedules::Bulk

Inherits:

Object

• Object
• Knockapi::Resources::Schedules::Bulk

Defined in:

lib/knockapi/resources/schedules/bulk.rb,
sig/knockapi/resources/schedules/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

• #create(schedules:, request_options: {}) ⇒ Knockapi::Models::BulkOperation

  Bulk creates up to 1,000 schedules at a time.

• #initialize(client:) ⇒ Bulk constructor private

  A new instance of Bulk.

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/schedules/bulk.rb', line 36

def initialize(client:)
  @client = client
end

Instance Method Details

#create(schedules:, request_options: {}) ⇒ Knockapi::Models::BulkOperation

Bulk creates up to 1,000 schedules at a time. This endpoint also handles inline identifications for the actor, recipient, and tenant fields.

Parameters:

• schedules (Array<Knockapi::Models::Schedules::BulkCreateParams::Schedule>) —

  A list of schedules.

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

Returns:

• (Knockapi::Models::BulkOperation)

See Also:

• Models::Schedules::BulkCreateParams

# File 'lib/knockapi/resources/schedules/bulk.rb', line 22

def create(params)
  parsed, options = Knockapi::Schedules::BulkCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/schedules/bulk/create",
    body: parsed,
    model: Knockapi::BulkOperation,
    options: options
  )
end