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) 与えられた認証情報をもとに新しいアクセストークンを発行します。



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) 受け取ったテンプレート用文字列の変数を展開して返します。



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

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) 新たに投稿を作成します。



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

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

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

### Qiita::Client#create_item_comment(item_id, params = nil, headers = nil) 特定の投稿にコメントを付けます。



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

def create_item_comment(item_id, 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) プロジェクトを新たに作成します。



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

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

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

### Qiita::Client#create_tagging(item_id, params = nil, headers = nil) 投稿にタグを追加します。Qiita:Teamでのみ有効です。



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

def create_tagging(item_id, 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) 新しくテンプレートを作成します。



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

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

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

### Qiita::Client#delete_access_token(token, params = nil, headers = nil) 与えられたアクセストークンを失効させ、それ以降利用されないようにします。



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

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

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

### Qiita::Client#delete_comment(id, params = nil, headers = nil) 特定のコメントを削除します。



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

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

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

### Qiita::Client#delete_item(id, params = nil, headers = nil) 特定の投稿を削除します。



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

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

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

### Qiita::Client#delete_project(id, params = nil, headers = nil) 特定のプロジェクトを削除します。



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

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

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

### Qiita::Client#delete_tagging(item_id, name, params = nil, headers = nil) 投稿から指定されたタグを取り除きます。Qiita:Teamでのみ有効です。



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

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

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

### Qiita::Client#delete_template(id, params = nil, headers = nil) 特定のテンプレートを削除します。



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

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

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

### Qiita::Client#follow_tag(id, params = nil, headers = nil) 特定のタグをフォローします。



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

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

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

### Qiita::Client#follow_user(user_id, params = nil, headers = nil) 特定のユーザをフォローします。



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

def follow_user(user_id, 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) アクセストークンに紐付いたユーザを返します。



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

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

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

### Qiita::Client#get_comment(id, params = nil, headers = nil) 特定のコメントを返します。



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

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

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

### Qiita::Client#get_item(id, params = nil, headers = nil) 特定の投稿を返します。



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

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

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

### Qiita::Client#get_item_stock(item_id, params = nil, headers = nil) 特定の投稿をストックしている場合に204を返します。



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

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

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

### Qiita::Client#get_project(id, params = nil, headers = nil) 特定のプロジェクトを返します。



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

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

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

### Qiita::Client#get_tag(id, params = nil, headers = nil) 特定のタグを返します。



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

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

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

### Qiita::Client#get_tag_following(id, params = nil, headers = nil) 特定のタグをフォローしている場合に204を返します。



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

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

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

### Qiita::Client#get_template(id, params = nil, headers = nil) 特定のテンプレートを返します。



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

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

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

### Qiita::Client#get_user(id, params = nil, headers = nil) 特定のユーザを返します。



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

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

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

### Qiita::Client#get_user_following(user_id, params = nil, headers = nil) 特定のユーザをフォローしている場合に204を返します。



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

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

#lgtm_item(item_id, params = nil, headers = nil) ⇒ Object

### Qiita::Client#lgtm_item(item_id, params = nil, headers = nil) 特定の投稿に「いいね！」を付けます。



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

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

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

### Qiita::Client#list_authenticated_user_items(params = nil, headers = nil) 認証中のユーザの投稿の一覧を返します。



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

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

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

### Qiita::Client#list_item_comments(item_id, params = nil, headers = nil) 特定の投稿に寄せられたコメント一覧を返します。



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

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

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

### Qiita::Client#list_item_stockers(item_id, params = nil, headers = nil) 特定の投稿をストックしているユーザ一覧を返します。



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

def list_item_stockers(item_id, 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) 投稿の一覧を返します。



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

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) チーム内に存在するプロジェクト一覧を返します。



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

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

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

### Qiita::Client#list_tag_items(id, params = nil, headers = nil) 特定のタグが付けられた投稿一覧を返します。



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

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

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

### Qiita::Client#list_tags(params = nil, headers = nil) 全てのタグ一覧を返します。



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

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) 現在のリクエストで認証されているユーザが所属している全てのチームを返します。



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

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) 全てのテンプレート一覧を返します。



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

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

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

### Qiita::Client#list_user_followees(user_id, params = nil, headers = nil) 特定のユーザがフォローしているユーザ一覧を返します。



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

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

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

### Qiita::Client#list_user_followers(user_id, params = nil, headers = nil) 特定のユーザをフォローしているユーザ一覧を返します。



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

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

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

### Qiita::Client#list_user_following_tags(user_id, params = nil, headers = nil) 特定のユーザがフォローしているタグ一覧を返します。



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

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

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

### Qiita::Client#list_user_items(user_id, params = nil, headers = nil) 特定のユーザの投稿一覧を返します。



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

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

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

### Qiita::Client#list_user_stocks(user_id, params = nil, headers = nil) 特定のユーザがストックした投稿一覧を返します。



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

def list_user_stocks(user_id, 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) 全てのユーザの一覧を返します。



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

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

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

### Qiita::Client#stock_item(item_id, params = nil, headers = nil) 特定の投稿をストックします。



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

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

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

### Qiita::Client#thank_comment(comment_id, params = nil, headers = nil) 特定のコメントにThankを付けます。



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

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

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

### Qiita::Client#unfollow_tag(id, params = nil, headers = nil) 特定のタグへのフォローを解除します。



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

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

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

### Qiita::Client#unfollow_user(user_id, params = nil, headers = nil) 特定のユーザへのフォローを外します。



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

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

#unlgtm_item(item_id, params = nil, headers = nil) ⇒ Object

### Qiita::Client#unlgtm_item(item_id, params = nil, headers = nil) 特定の投稿への「いいね！」を取り消します。



160
161
162
 
# File 'lib/qiita/resource_based_methods.rb', line 160

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

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

### Qiita::Client#unstock_item(item_id, params = nil, headers = nil) 特定の投稿をストックから取り除きます。



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

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

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

### Qiita::Client#unthank_comment(comment_id, params = nil, headers = nil) 特定のコメントからThankを外します。



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

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

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

### Qiita::Client#update_comment(id, params = nil, headers = nil) 特定のコメントを更新します。



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

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

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

### Qiita::Client#update_item(id, params = nil, headers = nil) 特定の投稿を編集します。



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

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

#update_project(id, params = nil, headers = nil) ⇒ Object

### Qiita::Client#update_project(id, params = nil, headers = nil) 特定のプロジェクトを編集します。



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

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

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

### Qiita::Client#update_template(id, params = nil, headers = nil) 特定のテンプレートを編集します。



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

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