class PassiveTotal::Client::Tag

Public Instance Methods

delete(artifact, tags) click to toggle source

Remove a set of tags from an artifact or artifacts. api.passivetotal.org/api/docs/#api-Tag_Artifact-DeleteV2ArtifactTag

@param [String] artifact the artifact id or ids to update @param [Array<String>] tags the tags or tag to delete (list or str)

@return [Hash]

# File lib/passivetotal/clients/tag.rb, line 31
def delete(artifact, tags)
  params = {
    artifact: artifact,
    tags: tags,
  }.compact

  _delete("/artifact/tag", params) { |json| json }
end
get(artifact) click to toggle source

Retrieve the tags of an artifact or artifacts. api.passivetotal.org/api/docs/#api-Tag_Artifact-GetV2ArtifactTag

@param [String] artifact the artifact id or ids to list

@return [Hash]

# File lib/passivetotal/clients/tag.rb, line 14
def get(artifact)
  params = {
    artifact: artifact,
  }.compact

  _get("/artifact/tag", params) { |json| json }
end
set(artifact, tags) click to toggle source

Set the tags of an artifact or artifacts. api.passivetotal.org/api/docs/#api-Tag_Artifact-PutV2ArtifactTag

@param [String] artifact the artifact id or ids to update @param [Array<String>] tags the tags or tag to set (list or str)

@return [Hash]

# File lib/passivetotal/clients/tag.rb, line 49
def set(artifact, tags)
  params = {
    artifact: artifact,
    tags: tags,
  }.compact

  _put("/artifact/tag", params) { |json| json }
end
update(artifact, tags) click to toggle source

Add tags to an artifact or artifacts. api.passivetotal.org/api/docs/#api-Tag_Artifact-PostV2ArtifactTag

@param [String] artifact the artifact id or ids to update @param [Array<String>] tags the tags or tag to add (list or str)

@return [Hash]

# File lib/passivetotal/clients/tag.rb, line 67
def update(artifact, tags)
  params = {
    artifact: artifact,
    tags: tags,
  }.compact

  _post("/artifact/tag", params) { |json| json }
end