Module: Qiita::ResourceBasedMethods

Included in:
Client
Defined in:
lib/qiita/resource_based_methods.rb

Instance Method Summary collapse

Instance Method Details

#create_access_token(params = nil, headers = nil) ⇒ Object

### Qiita::Client#create_access_token(params = nil, headers = nil) Create a new access token.



6
7
8
 
# File 'lib/qiita/resource_based_methods.rb', line 6

def create_access_token(params = nil, headers = nil)
  post("/api/v2/access_tokens", params, headers)
end

#create_expanded_template(params = nil, headers = nil) ⇒ Object

### Qiita::Client#create_expanded_template(params = nil, headers = nil) Get a template where its variables are expanded.



76
77
78
 
# File 'lib/qiita/resource_based_methods.rb', line 76

def create_expanded_template(params = nil, headers = nil)
  post("/api/v2/expanded_templates", params, headers)
end

#create_item(params = nil, headers = nil) ⇒ Object

### Qiita::Client#create_item(params = nil, headers = nil) Create an item.



97
98
99
 
# File 'lib/qiita/resource_based_methods.rb', line 97

def create_item(params = nil, headers = nil)
  post("/api/v2/items", params, headers)
end

#create_item_comment(params = nil, headers = nil) ⇒ Object

### Qiita::Client#create_item_comment(params = nil, headers = nil) Post a comment on an item.



69
70
71
 
# File 'lib/qiita/resource_based_methods.rb', line 69

def create_item_comment(params = nil, headers = nil)
  post("/api/v2/items/#{item_id}/comments", params, headers)
end

#create_project(params = nil, headers = nil) ⇒ Object

### Qiita::Client#create_project(params = nil, headers = nil) Create a new project.



195
196
197
 
# File 'lib/qiita/resource_based_methods.rb', line 195

def create_project(params = nil, headers = nil)
  post("/api/v2/projects", params, headers)
end

#create_tagging(params = nil, headers = nil) ⇒ Object

### Qiita::Client#create_tagging(params = nil, headers = nil) Add a tag to an item (only available on Qiita:Team)



265
266
267
 
# File 'lib/qiita/resource_based_methods.rb', line 265

def create_tagging(params = nil, headers = nil)
  post("/api/v2/items/#{item_id}/taggings", params, headers)
end

#create_template(params = nil, headers = nil) ⇒ Object

### Qiita::Client#create_template(params = nil, headers = nil) Create a new template.



307
308
309
 
# File 'lib/qiita/resource_based_methods.rb', line 307

def create_template(params = nil, headers = nil)
  post("/api/v2/templates", params, headers)
end

#delete_access_token(params = nil, headers = nil) ⇒ Object

### Qiita::Client#delete_access_token(params = nil, headers = nil) Deactivate an access token.



13
14
15
 
# File 'lib/qiita/resource_based_methods.rb', line 13

def delete_access_token(params = nil, headers = nil)
  delete("/api/v2/access_tokens/#{access_token}", params, headers)
end

#delete_comment(params = nil, headers = nil) ⇒ Object

### Qiita::Client#delete_comment(params = nil, headers = nil) Delete a comment.



27
28
29
 
# File 'lib/qiita/resource_based_methods.rb', line 27

def delete_comment(params = nil, headers = nil)
  delete("/api/v2/comments/#{comment_id}", params, headers)
end

#delete_item(params = nil, headers = nil) ⇒ Object

### Qiita::Client#delete_item(params = nil, headers = nil) Delete an item.



104
105
106
 
# File 'lib/qiita/resource_based_methods.rb', line 104

def delete_item(params = nil, headers = nil)
  get("/api/v2/items/#{item_id}", params, headers)
end

#delete_project(params = nil, headers = nil) ⇒ Object

### Qiita::Client#delete_project(params = nil, headers = nil) Delete a project.



202
203
204
 
# File 'lib/qiita/resource_based_methods.rb', line 202

def delete_project(params = nil, headers = nil)
  delete("/api/v2/projects/#{project_id}", params, headers)
end

#delete_tagging(params = nil, headers = nil) ⇒ Object

### Qiita::Client#delete_tagging(params = nil, headers = nil) Remove a tag from an item (only available on Qiita:Team)



272
273
274
 
# File 'lib/qiita/resource_based_methods.rb', line 272

def delete_tagging(params = nil, headers = nil)
  delete("/api/v2/items/#{item_id}/taggings/#{tagging_id}", params, headers)
end

#delete_template(params = nil, headers = nil) ⇒ Object

### Qiita::Client#delete_template(params = nil, headers = nil) Delete a template.



293
294
295
 
# File 'lib/qiita/resource_based_methods.rb', line 293

def delete_template(params = nil, headers = nil)
  delete("/api/v2/templates/#{template_id}", params, headers)
end

#follow_tag(params = nil, headers = nil) ⇒ Object

### Qiita::Client#follow_tag(params = nil, headers = nil) Follow a tag.



258
259
260
 
# File 'lib/qiita/resource_based_methods.rb', line 258

def follow_tag(params = nil, headers = nil)
  put("/api/v2/tags/#{tag_id}/following", params, headers)
end

#follow_user(params = nil, headers = nil) ⇒ Object

### Qiita::Client#follow_user(params = nil, headers = nil) Follow a user.



370
371
372
 
# File 'lib/qiita/resource_based_methods.rb', line 370

def follow_user(params = nil, headers = nil)
  put("/api/v2/users/#{user_id}/following", params, headers)
end

#get_authenticated_user(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_authenticated_user(params = nil, headers = nil) Get a user associated to the current access token.



20
21
22
 
# File 'lib/qiita/resource_based_methods.rb', line 20

def get_authenticated_user(params = nil, headers = nil)
  get("/api/v2/authenticated_user", params, headers)
end

#get_comment(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_comment(params = nil, headers = nil) Get a comment.



34
35
36
 
# File 'lib/qiita/resource_based_methods.rb', line 34

def get_comment(params = nil, headers = nil)
  get("/api/v2/comments/#{comment_id}", params, headers)
end

#get_item(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_item(params = nil, headers = nil) Get an item.



111
112
113
 
# File 'lib/qiita/resource_based_methods.rb', line 111

def get_item(params = nil, headers = nil)
  get("/api/v2/items/#{item_id}", params, headers)
end

#get_item_stock(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_item_stock(params = nil, headers = nil) Check if you stocked an item.



146
147
148
 
# File 'lib/qiita/resource_based_methods.rb', line 146

def get_item_stock(params = nil, headers = nil)
  get("/api/v2/items/#{item_id}/stock", params, headers)
end

#get_project(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_project(params = nil, headers = nil) Get a project.



209
210
211
 
# File 'lib/qiita/resource_based_methods.rb', line 209

def get_project(params = nil, headers = nil)
  get("/api/v2/projects/#{project_id}", params, headers)
end

#get_tag(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_tag(params = nil, headers = nil) Get a tag.



230
231
232
 
# File 'lib/qiita/resource_based_methods.rb', line 230

def get_tag(params = nil, headers = nil)
  get("/api/v2/tags/#{tag_id}", params, headers)
end

#get_tag_following(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_tag_following(params = nil, headers = nil) Check if you are following a tag or not.



251
252
253
 
# File 'lib/qiita/resource_based_methods.rb', line 251

def get_tag_following(params = nil, headers = nil)
  get("/api/v2/tags/#{tag_id}/following", params, headers)
end

#get_template(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_template(params = nil, headers = nil) Get a template.



300
301
302
 
# File 'lib/qiita/resource_based_methods.rb', line 300

def get_template(params = nil, headers = nil)
  get("/api/v2/templates/#{template_id}", params, headers)
end

#get_user(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_user(params = nil, headers = nil) Get a user.



335
336
337
 
# File 'lib/qiita/resource_based_methods.rb', line 335

def get_user(params = nil, headers = nil)
  get("/api/v2/users/#{user_id}", params, headers)
end

#get_user_following(params = nil, headers = nil) ⇒ Object

### Qiita::Client#get_user_following(params = nil, headers = nil) Check if the current user is following a user.



363
364
365
 
# File 'lib/qiita/resource_based_methods.rb', line 363

def get_user_following(params = nil, headers = nil)
  get("/api/v2/users/#{user_id}/following", params, headers)
end

#like_item(params = nil, headers = nil) ⇒ Object

### Qiita::Client#like_item(params = nil, headers = nil) Like an item (only available on Qiita:Team).



132
133
134
 
# File 'lib/qiita/resource_based_methods.rb', line 132

def like_item(params = nil, headers = nil)
  put("/api/v2/items/#{item_id}/like", params, headers)
end

#list_authenticated_user_items(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_authenticated_user_items(params = nil, headers = nil) List the authenticated user’s items in newest order



83
84
85
 
# File 'lib/qiita/resource_based_methods.rb', line 83

def list_authenticated_user_items(params = nil, headers = nil)
  get("/api/v2/authenticated_user/items", params, headers)
end

#list_item_comments(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_item_comments(params = nil, headers = nil) List comments on an item in newest order.



62
63
64
 
# File 'lib/qiita/resource_based_methods.rb', line 62

def list_item_comments(params = nil, headers = nil)
  get("/api/v2/items/#{item_id}/comments", params, headers)
end

#list_item_stockers(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_item_stockers(params = nil, headers = nil) List users who stocked an item in recent-stocked order.



321
322
323
 
# File 'lib/qiita/resource_based_methods.rb', line 321

def list_item_stockers(params = nil, headers = nil)
  get("/api/v2/items/#{item_id}/stockers", params, headers)
end

#list_items(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_items(params = nil, headers = nil) List items.



90
91
92
 
# File 'lib/qiita/resource_based_methods.rb', line 90

def list_items(params = nil, headers = nil)
  get("/api/v2/items", params, headers)
end

#list_projects(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_projects(params = nil, headers = nil) List projects in newest order.



188
189
190
 
# File 'lib/qiita/resource_based_methods.rb', line 188

def list_projects(params = nil, headers = nil)
  get("/api/v2/projects", params, headers)
end

#list_tag_items(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_tag_items(params = nil, headers = nil) List tagged items in recently-tagged order.



167
168
169
 
# File 'lib/qiita/resource_based_methods.rb', line 167

def list_tag_items(params = nil, headers = nil)
  get("/api/v2/tags/#{tag_id}/items", params, headers)
end

#list_tags(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_tags(params = nil, headers = nil) List tags in newest order.



223
224
225
 
# File 'lib/qiita/resource_based_methods.rb', line 223

def list_tags(params = nil, headers = nil)
  get("/api/v2/tags", params, headers)
end

#list_teams(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_teams(params = nil, headers = nil) List teams the user belongs to in newest order.



279
280
281
 
# File 'lib/qiita/resource_based_methods.rb', line 279

def list_teams(params = nil, headers = nil)
  get("/api/v2/teams", params, headers)
end

#list_templates(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_templates(params = nil, headers = nil) List templates in a team.



286
287
288
 
# File 'lib/qiita/resource_based_methods.rb', line 286

def list_templates(params = nil, headers = nil)
  get("/api/v2/templates", params, headers)
end

#list_user_followees(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_user_followees(params = nil, headers = nil) List users a user is following.



342
343
344
 
# File 'lib/qiita/resource_based_methods.rb', line 342

def list_user_followees(params = nil, headers = nil)
  get("/api/v2/users/#{user_id}/followees", params, headers)
end

#list_user_followers(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_user_followers(params = nil, headers = nil) List users who are following a user.



349
350
351
 
# File 'lib/qiita/resource_based_methods.rb', line 349

def list_user_followers(params = nil, headers = nil)
  get("/api/v2/users/#{user_id}/followers", params, headers)
end

#list_user_following_tags(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_user_following_tags(params = nil, headers = nil) List tags a user is following to in recently-tagged order.



237
238
239
 
# File 'lib/qiita/resource_based_methods.rb', line 237

def list_user_following_tags(params = nil, headers = nil)
  get("/api/v2/users/#{user_id}/following_tags", params, headers)
end

#list_user_items(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_user_items(params = nil, headers = nil) List a user’s items in newest order.



174
175
176
 
# File 'lib/qiita/resource_based_methods.rb', line 174

def list_user_items(params = nil, headers = nil)
  get("/api/v2/users/#{user_id}/items", params, headers)
end

#list_user_stocks(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_user_stocks(params = nil, headers = nil) List a user’s stocked items in recently-stocked order.



181
182
183
 
# File 'lib/qiita/resource_based_methods.rb', line 181

def list_user_stocks(params = nil, headers = nil)
  get("/api/v2/users/#{user_id}/stocks", params, headers)
end

#list_users(params = nil, headers = nil) ⇒ Object

### Qiita::Client#list_users(params = nil, headers = nil) List users in newest order.



328
329
330
 
# File 'lib/qiita/resource_based_methods.rb', line 328

def list_users(params = nil, headers = nil)
  get("/api/v2/users", params, headers)
end

#patch_project(params = nil, headers = nil) ⇒ Object

### Qiita::Client#patch_project(params = nil, headers = nil) Update a project



216
217
218
 
# File 'lib/qiita/resource_based_methods.rb', line 216

def patch_project(params = nil, headers = nil)
  patch("/api/v2/projects/#{project_id}", params, headers)
end

#stock_item(params = nil, headers = nil) ⇒ Object

### Qiita::Client#stock_item(params = nil, headers = nil) Stock an item.



153
154
155
 
# File 'lib/qiita/resource_based_methods.rb', line 153

def stock_item(params = nil, headers = nil)
  put("/api/v2/items/#{item_id}/stock", params, headers)
end

#thank_comment(params = nil, headers = nil) ⇒ Object

### Qiita::Client#thank_comment(params = nil, headers = nil) Send a thank to a comment.



55
56
57
 
# File 'lib/qiita/resource_based_methods.rb', line 55

def thank_comment(params = nil, headers = nil)
  put("/api/v2/comments/#{comment_id}/thank", params, headers)
end

#unfollow_tag(params = nil, headers = nil) ⇒ Object

### Qiita::Client#unfollow_tag(params = nil, headers = nil) Unfollow a tag.



244
245
246
 
# File 'lib/qiita/resource_based_methods.rb', line 244

def unfollow_tag(params = nil, headers = nil)
  delete("/api/v2/tags/#{tag_id}/following", params, headers)
end

#unfollow_user(params = nil, headers = nil) ⇒ Object

### Qiita::Client#unfollow_user(params = nil, headers = nil) Unfollow a user.



356
357
358
 
# File 'lib/qiita/resource_based_methods.rb', line 356

def unfollow_user(params = nil, headers = nil)
  delete("/api/v2/users/#{user_id}/following", params, headers)
end

#unlike_item(params = nil, headers = nil) ⇒ Object

### Qiita::Client#unlike_item(params = nil, headers = nil) Unlike an item (only available on Qiita:Team).



125
126
127
 
# File 'lib/qiita/resource_based_methods.rb', line 125

def unlike_item(params = nil, headers = nil)
  delete("/api/v2/items/#{item_id}/like", params, headers)
end

#unstock_item(params = nil, headers = nil) ⇒ Object

### Qiita::Client#unstock_item(params = nil, headers = nil) Unstock an item.



139
140
141
 
# File 'lib/qiita/resource_based_methods.rb', line 139

def unstock_item(params = nil, headers = nil)
  delete("/api/v2/items/#{item_id}/stock", params, headers)
end

#unthank_comment(params = nil, headers = nil) ⇒ Object

### Qiita::Client#unthank_comment(params = nil, headers = nil) Delete a thank from a comment.



48
49
50
 
# File 'lib/qiita/resource_based_methods.rb', line 48

def unthank_comment(params = nil, headers = nil)
  delete("/api/v2/comments/#{comment_id}/thank", params, headers)
end

#update_comment(params = nil, headers = nil) ⇒ Object

### Qiita::Client#update_comment(params = nil, headers = nil) Update a comment.



41
42
43
 
# File 'lib/qiita/resource_based_methods.rb', line 41

def update_comment(params = nil, headers = nil)
  patch("/api/v2/comments/#{comment_id}", params, headers)
end

#update_item(params = nil, headers = nil) ⇒ Object

### Qiita::Client#update_item(params = nil, headers = nil) Update an item.



118
119
120
 
# File 'lib/qiita/resource_based_methods.rb', line 118

def update_item(params = nil, headers = nil)
  patch("/api/v2/items/#{item_id}", params, headers)
end

#update_template(params = nil, headers = nil) ⇒ Object

### Qiita::Client#update_template(params = nil, headers = nil) Update a template.



314
315
316
 
# File 'lib/qiita/resource_based_methods.rb', line 314

def update_template(params = nil, headers = nil)
  patch("/api/v2/templates/#{template_id}", params, headers)
end