Class: Knockapi::Resources::BulkOperations

Inherits:

Object

• Object
• Knockapi::Resources::BulkOperations

Defined in:

lib/knockapi/resources/bulk_operations.rb

Instance Method Summary

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

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

• #initialize(client:) ⇒ BulkOperations constructor private

  A new instance of BulkOperations.

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:

• client (Knockapi::Client)

# File 'lib/knockapi/resources/bulk_operations.rb', line 29

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:

• id (String) —

  The ID of the bulk operation to retrieve.

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

Returns:

• (Knockapi::Models::BulkOperation)

See Also:

• Models::BulkOperationGetParams

# File 'lib/knockapi/resources/bulk_operations.rb', line 17

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