traq 0.1.5

⚠️ Community Driven ⚠️ traQ v3 API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290

# \ClipApi

All URIs are relative to *https://q.trap.jp/api/v3*

Method | HTTP request | Description
------------- | ------------- | -------------
[**clip_message**](ClipApi.md#clip_message) | **POST** /clip-folders/{folderId}/messages | メッセージをクリップフォルダに追加
[**create_clip_folder**](ClipApi.md#create_clip_folder) | **POST** /clip-folders | クリップフォルダを作成
[**delete_clip_folder**](ClipApi.md#delete_clip_folder) | **DELETE** /clip-folders/{folderId} | クリップフォルダを削除
[**edit_clip_folder**](ClipApi.md#edit_clip_folder) | **PATCH** /clip-folders/{folderId} | クリップフォルダ情報を編集
[**get_clip_folder**](ClipApi.md#get_clip_folder) | **GET** /clip-folders/{folderId} | クリップフォルダ情報を取得
[**get_clip_folders**](ClipApi.md#get_clip_folders) | **GET** /clip-folders | クリップフォルダのリストを取得
[**get_clips**](ClipApi.md#get_clips) | **GET** /clip-folders/{folderId}/messages | フォルダ内のクリップのリストを取得
[**get_message_clips**](ClipApi.md#get_message_clips) | **GET** /messages/{messageId}/clips | 自分のクリップを取得
[**unclip_message**](ClipApi.md#unclip_message) | **DELETE** /clip-folders/{folderId}/messages/{messageId} | メッセージをクリップフォルダから除外



## clip_message

> crate::models::ClippedMessage clip_message(folder_id, post_clip_folder_message_request)
メッセージをクリップフォルダに追加

指定したメッセージを指定したクリップフォルダに追加します。

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**folder_id** | **uuid::Uuid** | クリップフォルダUUID | [required] |
**post_clip_folder_message_request** | Option<[**PostClipFolderMessageRequest**](PostClipFolderMessageRequest.md)> |  |  |

### Return type

[**crate::models::ClippedMessage**](ClippedMessage.md)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_clip_folder

> crate::models::ClipFolder create_clip_folder(post_clip_folder_request)
クリップフォルダを作成

クリップフォルダを作成します。 既にあるフォルダと同名のフォルダを作成することは可能です。

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**post_clip_folder_request** | Option<[**PostClipFolderRequest**](PostClipFolderRequest.md)> |  |  |

### Return type

[**crate::models::ClipFolder**](ClipFolder.md)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_clip_folder

> delete_clip_folder(folder_id)
クリップフォルダを削除

指定したクリップフォルダを削除します。

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**folder_id** | **uuid::Uuid** | クリップフォルダUUID | [required] |

### Return type

 (empty response body)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## edit_clip_folder

> edit_clip_folder(folder_id, patch_clip_folder_request)
クリップフォルダ情報を編集

指定したクリップフォルダの情報を編集します。

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**folder_id** | **uuid::Uuid** | クリップフォルダUUID | [required] |
**patch_clip_folder_request** | Option<[**PatchClipFolderRequest**](PatchClipFolderRequest.md)> |  |  |

### Return type

 (empty response body)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_clip_folder

> crate::models::ClipFolder get_clip_folder(folder_id)
クリップフォルダ情報を取得

指定したクリップフォルダの情報を取得します。

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**folder_id** | **uuid::Uuid** | クリップフォルダUUID | [required] |

### Return type

[**crate::models::ClipFolder**](ClipFolder.md)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_clip_folders

> Vec<crate::models::ClipFolder> get_clip_folders()
クリップフォルダのリストを取得

自身が所有するクリップフォルダのリストを取得します。

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<crate::models::ClipFolder>**](ClipFolder.md)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_clips

> Vec<crate::models::ClippedMessage> get_clips(folder_id, limit, offset, order)
フォルダ内のクリップのリストを取得

指定したフォルダ内のクリップのリストを取得します。 `order`を指定しない場合、クリップした日時の新しい順で返されます。

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**folder_id** | **uuid::Uuid** | クリップフォルダUUID | [required] |
**limit** | Option<**i32**> | 取得する件数 |  |
**offset** | Option<**i32**> | 取得するオフセット |  |[default to 0]
**order** | Option<**String**> | 昇順か降順か |  |[default to desc]

### Return type

[**Vec<crate::models::ClippedMessage>**](ClippedMessage.md)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_message_clips

> Vec<crate::models::MessageClip> get_message_clips(message_id)
自分のクリップを取得

対象のメッセージの自分のクリップの一覧を返します。

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**message_id** | **uuid::Uuid** | メッセージUUID | [required] |

### Return type

[**Vec<crate::models::MessageClip>**](MessageClip.md)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## unclip_message

> unclip_message(folder_id, message_id)
メッセージをクリップフォルダから除外

指定したフォルダから指定したメッセージのクリップを除外します。 既に外されているメッセージを指定した場合は204を返します。

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**folder_id** | **uuid::Uuid** | クリップフォルダUUID | [required] |
**message_id** | **uuid::Uuid** | メッセージUUID | [required] |

### Return type

 (empty response body)

### Authorization

[OAuth2](../README.md#OAuth2), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)