Class: Knockapi::Resources::BulkOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/knockapi/resources/bulk_operations.rb,
sig/knockapi/resources/bulk_operations.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 collapse

Constructor Details

#initialize(client:) ⇒ BulkOperations

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

Parameters:



31
32
33
 
# File 'lib/knockapi/resources/bulk_operations.rb', line 31

def initialize(client:)
  @client = client
end

Instance Method Details

#get(id, request_options: {}) ⇒ Knockapi::Models::BulkOperation

Retrieves a bulk operation (if it exists) and displays the current state of it.

Parameters:

Returns:

See Also:



19
20
21
22
23
24
25
26
 
# File 'lib/knockapi/resources/bulk_operations.rb', line 19

def get(id, params = {})
  @client.request(
    method: :get,
    path: ["v1/bulk_operations/%1$s", id],
    model: Knockapi::BulkOperation,
    options: params[:request_options]
  )
end