Method: NFTStorage::NFTStorageAPI#delete_with_http_info

Defined in:
lib/nft_storage/api/nft_storage_api.rb

#delete_with_http_info(cid, opts = {}) ⇒ Array<(DeleteResponse, Integer, Hash)>

Stop storing the content with the passed CID Stop storing the content with the passed CID on nft.storage. - Unpin the item from the underlying IPFS pinning service. - Cease renewals for expired Filecoin deals involving the CID. ⚠️ This does not remove the content from the network. - Does not terminate any established Filecoin deal. - Does not remove the content from other IPFS nodes in the network that already cached or pinned the CID. Note: the content will remain available if another user has stored the CID with nft.storage.

Parameters:

  • cid (String) —

    CID for the NFT

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

    the optional parameters

Returns:

  • (Array<(DeleteResponse, Integer, Hash)>) —

    DeleteResponse data, response status code and response headers


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/nft_storage/api/nft_storage_api.rb', line 37

def delete_with_http_info(cid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NFTStorageAPI.delete ...'
  end
  # verify the required parameter 'cid' is set
  if @api_client.config.client_side_validation && cid.nil?
    fail ArgumentError, "Missing the required parameter 'cid' when calling NFTStorageAPI.delete"
  end
  # resource path
  local_var_path = '/{cid}'.sub('{' + 'cid' + '}', CGI.escape(cid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"NFTStorageAPI.delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NFTStorageAPI#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end