Module: BacklogKit::Client::Project

Included in:
BacklogKit::Client
Defined in:
lib/backlog_kit/client/project.rb

Instance Method Summary collapse

Instance Method Details

#add_category(project_id_or_key, name) ⇒ Object 



77
78
79
 
# File 'lib/backlog_kit/client/project.rb', line 77

def add_category(project_id_or_key, name)
  post("projects/#{project_id_or_key}/categories", name: name)
end

#add_issue_type(project_id_or_key, name, color) ⇒ Object 



61
62
63
 
# File 'lib/backlog_kit/client/project.rb', line 61

def add_issue_type(project_id_or_key, name, color)
  post("projects/#{project_id_or_key}/issueTypes", name: name, color: color)
end

#add_project_admin_auth(project_id_or_key, user_id) ⇒ Object 



49
50
51
 
# File 'lib/backlog_kit/client/project.rb', line 49

def add_project_admin_auth(project_id_or_key, user_id)
  post("projects/#{project_id_or_key}/administrators", user_id: user_id)
end

#add_project_user(project_id_or_key, user_id) ⇒ Object 



37
38
39
 
# File 'lib/backlog_kit/client/project.rb', line 37

def add_project_user(project_id_or_key, user_id)
  post("projects/#{project_id_or_key}/users", user_id: user_id)
end

#add_version(project_id_or_key, name, params = {}) ⇒ Object 



93
94
95
96
 
# File 'lib/backlog_kit/client/project.rb', line 93

def add_version(project_id_or_key, name, params = {})
  params.merge!(name: name)
  post("projects/#{project_id_or_key}/versions", params)
end

#add_webhook(project_id_or_key, name, hook_url, params = {}) ⇒ Object 



126
127
128
129
 
# File 'lib/backlog_kit/client/project.rb', line 126

def add_webhook(project_id_or_key, name, hook_url, params = {})
  params.merge!(name: name, hook_url: hook_url)
  post("projects/#{project_id_or_key}/webhooks", params)
end

#create_project(key, name, params = {}) ⇒ Object 



12
13
14
15
 
# File 'lib/backlog_kit/client/project.rb', line 12

def create_project(key, name, params = {})
  params.merge!(key: key, name: name)
  post('projects', params)
end

#delete_project(project_id_or_key) ⇒ Object 



21
22
23
 
# File 'lib/backlog_kit/client/project.rb', line 21

def delete_project(project_id_or_key)
  delete("projects/#{project_id_or_key}")
end

#download_project_icon(project_id_or_key) ⇒ Object 



25
26
27
 
# File 'lib/backlog_kit/client/project.rb', line 25

def download_project_icon(project_id_or_key)
  get("projects/#{project_id_or_key}/image")
end

#download_shared_file(project_id_or_key, file_id) ⇒ Object 



110
111
112
 
# File 'lib/backlog_kit/client/project.rb', line 110

def download_shared_file(project_id_or_key, file_id)
  get("projects/#{project_id_or_key}/files/#{file_id}")
end

#get_categories(project_id_or_key) ⇒ Object 



73
74
75
 
# File 'lib/backlog_kit/client/project.rb', line 73

def get_categories(project_id_or_key)
  get("projects/#{project_id_or_key}/categories")
end

#get_issue_types(project_id_or_key) ⇒ Object 



57
58
59
 
# File 'lib/backlog_kit/client/project.rb', line 57

def get_issue_types(project_id_or_key)
  get("projects/#{project_id_or_key}/issueTypes")
end

#get_project(project_id_or_key) ⇒ Object 



8
9
10
 
# File 'lib/backlog_kit/client/project.rb', line 8

def get_project(project_id_or_key)
  get("projects/#{project_id_or_key}")
end

#get_project_activities(project_id_or_key, params = {}) ⇒ Object 



29
30
31
 
# File 'lib/backlog_kit/client/project.rb', line 29

def get_project_activities(project_id_or_key, params = {})
  get("projects/#{project_id_or_key}/activities", params)
end

#get_project_administrators(project_id_or_key) ⇒ Object 



45
46
47
 
# File 'lib/backlog_kit/client/project.rb', line 45

def get_project_administrators(project_id_or_key)
  get("projects/#{project_id_or_key}/administrators")
end

#get_project_disk_usage(project_id_or_key) ⇒ Object 



114
115
116
 
# File 'lib/backlog_kit/client/project.rb', line 114

def get_project_disk_usage(project_id_or_key)
  get("projects/#{project_id_or_key}/diskUsage")
end

#get_project_users(project_id_or_key) ⇒ Object 



33
34
35
 
# File 'lib/backlog_kit/client/project.rb', line 33

def get_project_users(project_id_or_key)
  get("projects/#{project_id_or_key}/users")
end

#get_projects ⇒ Object 



4
5
6
 
# File 'lib/backlog_kit/client/project.rb', line 4

def get_projects
  get('projects')
end

#get_shared_files(project_id_or_key, directory_path = '', params = {}) ⇒ Object 



106
107
108
 
# File 'lib/backlog_kit/client/project.rb', line 106

def get_shared_files(project_id_or_key, directory_path = '', params = {})
  get("projects/#{project_id_or_key}/files/metadata/#{directory_path}", params)
end

#get_versions(project_id_or_key) ⇒ Object 



89
90
91
 
# File 'lib/backlog_kit/client/project.rb', line 89

def get_versions(project_id_or_key)
  get("projects/#{project_id_or_key}/versions")
end

#get_webhook(project_id_or_key, webhook_id) ⇒ Object 



122
123
124
 
# File 'lib/backlog_kit/client/project.rb', line 122

def get_webhook(project_id_or_key, webhook_id)
  get("projects/#{project_id_or_key}/webhooks/#{webhook_id}")
end

#get_webhooks(project_id_or_key) ⇒ Object 



118
119
120
 
# File 'lib/backlog_kit/client/project.rb', line 118

def get_webhooks(project_id_or_key)
  get("projects/#{project_id_or_key}/webhooks")
end

#remove_category(project_id_or_key, category_id) ⇒ Object 



85
86
87
 
# File 'lib/backlog_kit/client/project.rb', line 85

def remove_category(project_id_or_key, category_id)
  delete("projects/#{project_id_or_key}/categories/#{category_id}")
end

#remove_issue_type(project_id_or_key, type_id, substitute_type_id) ⇒ Object 



69
70
71
 
# File 'lib/backlog_kit/client/project.rb', line 69

def remove_issue_type(project_id_or_key, type_id, substitute_type_id)
  delete("projects/#{project_id_or_key}/issueTypes/#{type_id}", substitute_issue_type_id: substitute_type_id)
end

#remove_project_admin_auth(project_id_or_key, user_id) ⇒ Object 



53
54
55
 
# File 'lib/backlog_kit/client/project.rb', line 53

def remove_project_admin_auth(project_id_or_key, user_id)
  delete("projects/#{project_id_or_key}/administrators", user_id: user_id)
end

#remove_project_user(project_id_or_key, user_id) ⇒ Object 



41
42
43
 
# File 'lib/backlog_kit/client/project.rb', line 41

def remove_project_user(project_id_or_key, user_id)
  delete("projects/#{project_id_or_key}/users", user_id: user_id)
end

#remove_version(project_id_or_key, version_id) ⇒ Object 



102
103
104
 
# File 'lib/backlog_kit/client/project.rb', line 102

def remove_version(project_id_or_key, version_id)
  delete("projects/#{project_id_or_key}/versions/#{version_id}")
end

#remove_webhook(project_id_or_key, webhook_id) ⇒ Object 



135
136
137
 
# File 'lib/backlog_kit/client/project.rb', line 135

def remove_webhook(project_id_or_key, webhook_id)
  delete("projects/#{project_id_or_key}/webhooks/#{webhook_id}")
end

#update_category(project_id_or_key, category_id, name) ⇒ Object 



81
82
83
 
# File 'lib/backlog_kit/client/project.rb', line 81

def update_category(project_id_or_key, category_id, name)
  patch("projects/#{project_id_or_key}/categories/#{category_id}", name: name)
end

#update_issue_type(project_id_or_key, type_id, params = {}) ⇒ Object 



65
66
67
 
# File 'lib/backlog_kit/client/project.rb', line 65

def update_issue_type(project_id_or_key, type_id, params = {})
  patch("projects/#{project_id_or_key}/issueTypes/#{type_id}", params)
end

#update_project(project_id_or_key, params = {}) ⇒ Object 



17
18
19
 
# File 'lib/backlog_kit/client/project.rb', line 17

def update_project(project_id_or_key, params = {})
  patch("projects/#{project_id_or_key}", params)
end

#update_version(project_id_or_key, version_id, params = {}) ⇒ Object 



98
99
100
 
# File 'lib/backlog_kit/client/project.rb', line 98

def update_version(project_id_or_key, version_id, params = {})
  patch("projects/#{project_id_or_key}/versions/#{version_id}", params)
end

#update_webhook(project_id_or_key, webhook_id, params = {}) ⇒ Object 



131
132
133
 
# File 'lib/backlog_kit/client/project.rb', line 131

def update_webhook(project_id_or_key, webhook_id, params = {})
  patch("projects/#{project_id_or_key}/webhooks/#{webhook_id}", params)
end