Module: Forem::APIOperations::Delete::ClassMethods

Defined in:

lib/forem/api_operations/delete.rb

Overview

Class-level delete helpers.

Instance Method Summary

• #delete(id, opts = {}) ⇒ ForemObject^?

  Delete a resource by its ID via the Forem API.

Instance Method Details

#delete(id, opts = {}) ⇒ ForemObject^?

Delete a resource by its ID via the Forem API.

Sends a DELETE request to {resource_path}/{id}. If the server responds with a non-empty body it is used to construct a resource instance (representing the deleted object); otherwise nil is returned.

Examples:

Deleting an article by ID

client.articles.delete(12345)

Parameters:

• id (Integer, String) —

  the unique identifier of the resource to delete.

• opts (Hash) (defaults to: {}) —

  per-request options.

Options Hash (opts):

• :api_key (String) —

  override the API key for this request.

• :requestor (APIRequestor) —

  a custom requestor to use.

Returns:

• (ForemObject, nil) —

  the deleted resource (if the API returns a body), or nil.

Raises:

• (NotFoundError) —

  on HTTP 404.

• (AuthenticationError) —

  on HTTP 401.

• (AuthorizationError) —

  on HTTP 403.

• (ForemError) —

  on other API or network errors.

See Also:

• https://developers.forem.com/api/v1

# File 'lib/forem/api_operations/delete.rb', line 54

def delete(id, opts = {})
  requestor = opts[:requestor]
  resp = request(:delete, "#{resource_path}/#{id}", {}, opts)
  resp.parsed_body ? construct_from(resp.parsed_body, requestor: requestor) : nil
end