Module: Nylas::AdminApiOperations::Destroy

Includes:
ApiOperations::Delete
Included in:
Grants, RedirectUris
Defined in:
lib/nylas/handler/admin_api_operations.rb

Overview

Deletes a Nylas object.

Instance Method Summary collapse

Instance Method Details

#destroy(object_id:, query_params: {}) ⇒ Array(TrueClass, String)

Deletes a Nylas object.

Parameters:

  • object_id (String) —

    Object ID.

  • query_params (Hash, {}) (defaults to: {}) —

    Query params to pass to the request.

Returns:

  • (Array(TrueClass, String)) —

    True and the API Request ID for the delete operation.



85
86
87
88
89
90
91
92
 
# File 'lib/nylas/handler/admin_api_operations.rb', line 85

def destroy(object_id:, query_params: {})
  _, request_id = delete(
    path: "#{api_uri}/v3/#{resource_name}/#{object_id}",
    query_params: query_params
  )

  [true, request_id]
end