Class: LabClient::ProjectBadges

Inherits:
Common
  • Object
show all
Includes:
ClassHelpers
Defined in:
lib/labclient/projects/badges/list.rb,
lib/labclient/projects/badges/show.rb,
lib/labclient/projects/badges/client.rb,
lib/labclient/projects/badges/create.rb,
lib/labclient/projects/badges/delete.rb,
lib/labclient/projects/badges/update.rb,
lib/labclient/projects/badges/preview.rb

Overview

Specifics

Constant Summary

Constants included from AccessLevel

AccessLevel::HUMAN_ACCESS_LEVELS, AccessLevel::MACHINE_ACCESS_LEVELS

Instance Attribute Summary

Attributes inherited from Common

#client

Instance Method Summary collapse

Methods included from ClassHelpers

#has?, #keys, #raw

Methods inherited from Common

#api_methods, #api_methods_help, #format_id, #format_query_id, #format_query_ids, #format_time?, #group_name, #help, #initialize, #inspect, #klass, #protected_query_access_level, #query_access_level, #query_format_time

Methods included from Docs

#demo, #desc, #doc, docs, #example, #group_name, #help, json, #markdown, #navigation, #option, #result, #subtitle, #title

Methods included from AccessLevel

#human_access_level, #human_protected_access_level, #machine_access_level, #machine_protected_access_level

Constructor Details

This class inherits a constructor from LabClient::Common

Instance Method Details

#create(project_id, query) ⇒ Object 



42
43
44
45
46
 
# File 'lib/labclient/projects/badges/create.rb', line 42

def create(project_id, query)
  project_id = format_id(project_id)

  client.request(:post, "projects/#{project_id}/badges", klass: ProjectBadge, body: query)
end

#delete(project_id, badge_id) ⇒ Object 



26
27
28
29
30
31
 
# File 'lib/labclient/projects/badges/delete.rb', line 26

def delete(project_id, badge_id)
  project_id = format_id(project_id)
  badge_id = format_id(badge_id)

  client.request(:delete, "projects/#{project_id}/badges/#{badge_id}")
end

#list(project_id) ⇒ Object 



22
23
24
25
26
 
# File 'lib/labclient/projects/badges/list.rb', line 22

def list(project_id)
  project_id = format_id(project_id)

  client.request(:get, "projects/#{project_id}/badges", klass: ProjectBadge)
end

#preview(project_id, query) ⇒ Object 



35
36
37
38
39
 
# File 'lib/labclient/projects/badges/preview.rb', line 35

def preview(project_id, query)
  project_id = format_id(project_id)

  client.request(:get, "projects/#{project_id}/badges/render", body: query)
end

#show(project_id, badge_id) ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/labclient/projects/badges/show.rb', line 20

def show(project_id, badge_id)
  project_id = format_id(project_id)
  badge_id = format_id(badge_id)

  client.request(:get, "projects/#{project_id}/badges/#{badge_id}", klass: ProjectBadge)
end

#update(project_id, badge_id, query) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/labclient/projects/badges/update.rb', line 38

def update(project_id, badge_id, query)
  project_id = format_id(project_id)
  badge_id = format_id(badge_id)

  client.request(:put, "projects/#{project_id}/badges/#{badge_id}", klass: ProjectBadge, body: query)
end