@productcraft/social 1.0.3 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +187 -175
- package/api.md +4993 -0
- package/dist/index.cjs +5172 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +15947 -863
- package/dist/index.d.ts +15947 -863
- package/dist/index.js +5107 -8
- package/dist/index.js.map +1 -1
- package/dist/testing.cjs +3226 -0
- package/dist/testing.cjs.map +1 -0
- package/dist/testing.d.cts +32 -0
- package/dist/testing.d.ts +32 -0
- package/dist/testing.js +3224 -0
- package/dist/testing.js.map +1 -0
- package/manifest.json +3080 -0
- package/package.json +15 -5
package/manifest.json
ADDED
|
@@ -0,0 +1,3080 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operations": {
|
|
3
|
+
"ActorController_batchGetByExternal": {
|
|
4
|
+
"actor": null,
|
|
5
|
+
"deprecated": false,
|
|
6
|
+
"http": "POST /v1/communities/{community_id}/actors/by-external/batch",
|
|
7
|
+
"idempotent": false,
|
|
8
|
+
"method": "batch",
|
|
9
|
+
"paginated": false,
|
|
10
|
+
"params": "Social.ActorByExternalBatchParams",
|
|
11
|
+
"poll": null,
|
|
12
|
+
"public": false,
|
|
13
|
+
"resource": "actors.byExternal",
|
|
14
|
+
"scope": "community",
|
|
15
|
+
"signature": "social.community(…).actors.byExternal.batch(params, options?): Social.ActorsByExternalBatch",
|
|
16
|
+
"snippet": "const actorsByExternalBatch = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.byExternal.batch({ external_ids: [\"user_abc123\", \"user_def456\"] });"
|
|
17
|
+
},
|
|
18
|
+
"ActorController_batchUpsert": {
|
|
19
|
+
"actor": null,
|
|
20
|
+
"deprecated": false,
|
|
21
|
+
"http": "POST /v1/communities/{community_id}/actors/batch",
|
|
22
|
+
"idempotent": false,
|
|
23
|
+
"method": "batch",
|
|
24
|
+
"paginated": false,
|
|
25
|
+
"params": "Social.ActorBatchParams",
|
|
26
|
+
"poll": null,
|
|
27
|
+
"public": false,
|
|
28
|
+
"resource": "actors",
|
|
29
|
+
"scope": "community",
|
|
30
|
+
"signature": "social.community(…).actors.batch(params, options?): Social.BatchActors",
|
|
31
|
+
"snippet": "const batchActors = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.batch({ actors: [{ external_id: \"user_abc123\" }] });"
|
|
32
|
+
},
|
|
33
|
+
"ActorController_delete": {
|
|
34
|
+
"actor": null,
|
|
35
|
+
"deprecated": false,
|
|
36
|
+
"http": "DELETE /v1/communities/{community_id}/actors/{actor_id}",
|
|
37
|
+
"idempotent": false,
|
|
38
|
+
"method": "delete",
|
|
39
|
+
"paginated": false,
|
|
40
|
+
"params": null,
|
|
41
|
+
"poll": null,
|
|
42
|
+
"public": false,
|
|
43
|
+
"resource": "actors",
|
|
44
|
+
"scope": "community",
|
|
45
|
+
"signature": "social.community(…).actors.delete(actorId, options?): void",
|
|
46
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.delete(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\");"
|
|
47
|
+
},
|
|
48
|
+
"ActorController_getByExternal": {
|
|
49
|
+
"actor": null,
|
|
50
|
+
"deprecated": false,
|
|
51
|
+
"http": "GET /v1/communities/{community_id}/actors/by-external/{external_id}",
|
|
52
|
+
"idempotent": false,
|
|
53
|
+
"method": "retrieve",
|
|
54
|
+
"paginated": false,
|
|
55
|
+
"params": null,
|
|
56
|
+
"poll": null,
|
|
57
|
+
"public": false,
|
|
58
|
+
"resource": "actors.byExternal",
|
|
59
|
+
"scope": "community",
|
|
60
|
+
"signature": "social.community(…).actors.byExternal.retrieve(externalId, options?): Social.Actor",
|
|
61
|
+
"snippet": "const actor = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.byExternal.retrieve(\"user_abc123\");"
|
|
62
|
+
},
|
|
63
|
+
"ActorController_getById": {
|
|
64
|
+
"actor": null,
|
|
65
|
+
"deprecated": false,
|
|
66
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}",
|
|
67
|
+
"idempotent": false,
|
|
68
|
+
"method": "retrieve",
|
|
69
|
+
"paginated": false,
|
|
70
|
+
"params": null,
|
|
71
|
+
"poll": null,
|
|
72
|
+
"public": false,
|
|
73
|
+
"resource": "actors",
|
|
74
|
+
"scope": "community",
|
|
75
|
+
"signature": "social.community(…).actors.retrieve(actorId, options?): Social.Actor",
|
|
76
|
+
"snippet": "const actor = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.retrieve(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\");"
|
|
77
|
+
},
|
|
78
|
+
"ActorController_list": {
|
|
79
|
+
"actor": null,
|
|
80
|
+
"deprecated": false,
|
|
81
|
+
"http": "GET /v1/communities/{community_id}/actors",
|
|
82
|
+
"idempotent": false,
|
|
83
|
+
"method": "list",
|
|
84
|
+
"paginated": true,
|
|
85
|
+
"params": "Social.ActorListParams",
|
|
86
|
+
"poll": null,
|
|
87
|
+
"public": false,
|
|
88
|
+
"resource": "actors",
|
|
89
|
+
"scope": "community",
|
|
90
|
+
"signature": "social.community(…).actors.list(params?, options?): PagePromise<Social.Actor>",
|
|
91
|
+
"snippet": "for await (const actor of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.list()) {\n console.log(actor);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.list({}, { timeout: 5_000 });"
|
|
92
|
+
},
|
|
93
|
+
"ActorController_update": {
|
|
94
|
+
"actor": null,
|
|
95
|
+
"deprecated": false,
|
|
96
|
+
"http": "PATCH /v1/communities/{community_id}/actors/{actor_id}",
|
|
97
|
+
"idempotent": false,
|
|
98
|
+
"method": "update",
|
|
99
|
+
"paginated": false,
|
|
100
|
+
"params": "Social.ActorUpdateParams",
|
|
101
|
+
"poll": null,
|
|
102
|
+
"public": false,
|
|
103
|
+
"resource": "actors",
|
|
104
|
+
"scope": "community",
|
|
105
|
+
"signature": "social.community(…).actors.update(actorId, params?, options?): Social.Actor",
|
|
106
|
+
"snippet": "const actor = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.update(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", { avatar_url: \"string\" });"
|
|
107
|
+
},
|
|
108
|
+
"ActorController_upsert": {
|
|
109
|
+
"actor": null,
|
|
110
|
+
"deprecated": false,
|
|
111
|
+
"http": "POST /v1/communities/{community_id}/actors",
|
|
112
|
+
"idempotent": true,
|
|
113
|
+
"method": "create",
|
|
114
|
+
"paginated": false,
|
|
115
|
+
"params": "Social.ActorCreateParams",
|
|
116
|
+
"poll": null,
|
|
117
|
+
"public": false,
|
|
118
|
+
"resource": "actors",
|
|
119
|
+
"scope": "community",
|
|
120
|
+
"signature": "social.community(…).actors.create(params, options?): Social.UpsertActor",
|
|
121
|
+
"snippet": "const upsertActor = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.create({ external_id: \"user_abc123\" });"
|
|
122
|
+
},
|
|
123
|
+
"ActorListController_addMember": {
|
|
124
|
+
"actor": "body",
|
|
125
|
+
"deprecated": false,
|
|
126
|
+
"http": "POST /v1/communities/{community_id}/lists/{list_id}/members",
|
|
127
|
+
"idempotent": true,
|
|
128
|
+
"method": "create",
|
|
129
|
+
"paginated": false,
|
|
130
|
+
"params": "Social.ListMemberCreateParams",
|
|
131
|
+
"poll": null,
|
|
132
|
+
"public": false,
|
|
133
|
+
"resource": "lists.members",
|
|
134
|
+
"scope": "community",
|
|
135
|
+
"signature": "social.community(…).lists.members.create(listId, params, options?): Social.ActorListMember",
|
|
136
|
+
"snippet": "const actorListMember = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.members.create(\"list\", {});"
|
|
137
|
+
},
|
|
138
|
+
"ActorListController_create": {
|
|
139
|
+
"actor": "body",
|
|
140
|
+
"deprecated": false,
|
|
141
|
+
"http": "POST /v1/communities/{community_id}/lists",
|
|
142
|
+
"idempotent": true,
|
|
143
|
+
"method": "create",
|
|
144
|
+
"paginated": false,
|
|
145
|
+
"params": "Social.ListCreateParams",
|
|
146
|
+
"poll": null,
|
|
147
|
+
"public": false,
|
|
148
|
+
"resource": "lists",
|
|
149
|
+
"scope": "community",
|
|
150
|
+
"signature": "social.community(…).lists.create(params, options?): Social.ActorList",
|
|
151
|
+
"snippet": "const actorList = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.create({ name: \"Tech news\" });"
|
|
152
|
+
},
|
|
153
|
+
"ActorListController_delete": {
|
|
154
|
+
"actor": "query",
|
|
155
|
+
"deprecated": false,
|
|
156
|
+
"http": "DELETE /v1/communities/{community_id}/lists/{list_id}",
|
|
157
|
+
"idempotent": false,
|
|
158
|
+
"method": "delete",
|
|
159
|
+
"paginated": false,
|
|
160
|
+
"params": "Social.ListDeleteParams",
|
|
161
|
+
"poll": null,
|
|
162
|
+
"public": false,
|
|
163
|
+
"resource": "lists",
|
|
164
|
+
"scope": "community",
|
|
165
|
+
"signature": "social.community(…).lists.delete(listId, params, options?): void",
|
|
166
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.delete(\"list\", {});"
|
|
167
|
+
},
|
|
168
|
+
"ActorListController_getById": {
|
|
169
|
+
"actor": "query",
|
|
170
|
+
"deprecated": false,
|
|
171
|
+
"http": "GET /v1/communities/{community_id}/lists/{list_id}",
|
|
172
|
+
"idempotent": false,
|
|
173
|
+
"method": "retrieve",
|
|
174
|
+
"paginated": false,
|
|
175
|
+
"params": "Social.ListRetrieveParams",
|
|
176
|
+
"poll": null,
|
|
177
|
+
"public": false,
|
|
178
|
+
"resource": "lists",
|
|
179
|
+
"scope": "community",
|
|
180
|
+
"signature": "social.community(…).lists.retrieve(listId, params?, options?): Social.ActorList",
|
|
181
|
+
"snippet": "const actorList = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.retrieve(\"list\");"
|
|
182
|
+
},
|
|
183
|
+
"ActorListController_list": {
|
|
184
|
+
"actor": "query",
|
|
185
|
+
"deprecated": false,
|
|
186
|
+
"http": "GET /v1/communities/{community_id}/lists",
|
|
187
|
+
"idempotent": false,
|
|
188
|
+
"method": "list",
|
|
189
|
+
"paginated": true,
|
|
190
|
+
"params": "Social.ListListParams",
|
|
191
|
+
"poll": null,
|
|
192
|
+
"public": false,
|
|
193
|
+
"resource": "lists",
|
|
194
|
+
"scope": "community",
|
|
195
|
+
"signature": "social.community(…).lists.list(params?, options?): PagePromise<Social.ActorList>",
|
|
196
|
+
"snippet": "for await (const list of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.list()) {\n console.log(list);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.list({}, { timeout: 5_000 });"
|
|
197
|
+
},
|
|
198
|
+
"ActorListController_listMembers": {
|
|
199
|
+
"actor": "query",
|
|
200
|
+
"deprecated": false,
|
|
201
|
+
"http": "GET /v1/communities/{community_id}/lists/{list_id}/members",
|
|
202
|
+
"idempotent": false,
|
|
203
|
+
"method": "list",
|
|
204
|
+
"paginated": true,
|
|
205
|
+
"params": "Social.ListMemberListParams",
|
|
206
|
+
"poll": null,
|
|
207
|
+
"public": false,
|
|
208
|
+
"resource": "lists.members",
|
|
209
|
+
"scope": "community",
|
|
210
|
+
"signature": "social.community(…).lists.members.list(listId, params?, options?): PagePromise<Social.ActorListMember>",
|
|
211
|
+
"snippet": "for await (const member of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.members.list(\"list\")) {\n console.log(member);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.members.list(\"list\", {}, { timeout: 5_000 });"
|
|
212
|
+
},
|
|
213
|
+
"ActorListController_removeMember": {
|
|
214
|
+
"actor": "query",
|
|
215
|
+
"deprecated": false,
|
|
216
|
+
"http": "DELETE /v1/communities/{community_id}/lists/{list_id}/members/{member_actor_id}",
|
|
217
|
+
"idempotent": false,
|
|
218
|
+
"method": "delete",
|
|
219
|
+
"paginated": false,
|
|
220
|
+
"params": "Social.ListMemberDeleteParams",
|
|
221
|
+
"poll": null,
|
|
222
|
+
"public": false,
|
|
223
|
+
"resource": "lists.members",
|
|
224
|
+
"scope": "community",
|
|
225
|
+
"signature": "social.community(…).lists.members.delete(listId, memberActorId, params, options?): void",
|
|
226
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.members.delete(\"list\", \"member_actor\", {});"
|
|
227
|
+
},
|
|
228
|
+
"ActorListController_update": {
|
|
229
|
+
"actor": "body",
|
|
230
|
+
"deprecated": false,
|
|
231
|
+
"http": "PATCH /v1/communities/{community_id}/lists/{list_id}",
|
|
232
|
+
"idempotent": false,
|
|
233
|
+
"method": "update",
|
|
234
|
+
"paginated": false,
|
|
235
|
+
"params": "Social.ListUpdateParams",
|
|
236
|
+
"poll": null,
|
|
237
|
+
"public": false,
|
|
238
|
+
"resource": "lists",
|
|
239
|
+
"scope": "community",
|
|
240
|
+
"signature": "social.community(…).lists.update(listId, params?, options?): Social.ActorList",
|
|
241
|
+
"snippet": "const actorList = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.update(\"list\");"
|
|
242
|
+
},
|
|
243
|
+
"AnalyticsController_getCommunityAnalytics": {
|
|
244
|
+
"actor": null,
|
|
245
|
+
"deprecated": false,
|
|
246
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/analytics",
|
|
247
|
+
"idempotent": false,
|
|
248
|
+
"method": "analytics",
|
|
249
|
+
"paginated": false,
|
|
250
|
+
"params": null,
|
|
251
|
+
"poll": null,
|
|
252
|
+
"public": false,
|
|
253
|
+
"resource": "communities",
|
|
254
|
+
"scope": null,
|
|
255
|
+
"signature": "social.communities.analytics(communityId, options?): Social.CommunityAnalytics",
|
|
256
|
+
"snippet": "const communityAnalytics = await social.communities.analytics(\"cccccccc-cccc-cccc-cccc-cccccccccccc\");"
|
|
257
|
+
},
|
|
258
|
+
"AssetController_complete": {
|
|
259
|
+
"actor": null,
|
|
260
|
+
"deprecated": false,
|
|
261
|
+
"http": "POST /v1/communities/{community_id}/assets/{asset_id}/complete",
|
|
262
|
+
"idempotent": true,
|
|
263
|
+
"method": "complete",
|
|
264
|
+
"paginated": false,
|
|
265
|
+
"params": null,
|
|
266
|
+
"poll": null,
|
|
267
|
+
"public": false,
|
|
268
|
+
"resource": "assets",
|
|
269
|
+
"scope": "community",
|
|
270
|
+
"signature": "social.community(…).assets.complete(assetId, options?): Social.UploadAsset",
|
|
271
|
+
"snippet": "const uploadAsset = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").assets.complete(\"eeeeeeee-0000-0000-0000-000000000001\");"
|
|
272
|
+
},
|
|
273
|
+
"AssetController_delete": {
|
|
274
|
+
"actor": null,
|
|
275
|
+
"deprecated": false,
|
|
276
|
+
"http": "DELETE /v1/communities/{community_id}/assets/{asset_id}",
|
|
277
|
+
"idempotent": false,
|
|
278
|
+
"method": "delete",
|
|
279
|
+
"paginated": false,
|
|
280
|
+
"params": null,
|
|
281
|
+
"poll": null,
|
|
282
|
+
"public": false,
|
|
283
|
+
"resource": "assets",
|
|
284
|
+
"scope": "community",
|
|
285
|
+
"signature": "social.community(…).assets.delete(assetId, options?): void",
|
|
286
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").assets.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
287
|
+
},
|
|
288
|
+
"AssetController_get": {
|
|
289
|
+
"actor": null,
|
|
290
|
+
"deprecated": false,
|
|
291
|
+
"http": "GET /v1/communities/{community_id}/assets/{asset_id}",
|
|
292
|
+
"idempotent": false,
|
|
293
|
+
"method": "retrieve",
|
|
294
|
+
"paginated": false,
|
|
295
|
+
"params": null,
|
|
296
|
+
"poll": null,
|
|
297
|
+
"public": false,
|
|
298
|
+
"resource": "assets",
|
|
299
|
+
"scope": "community",
|
|
300
|
+
"signature": "social.community(…).assets.retrieve(assetId, options?): Social.Asset",
|
|
301
|
+
"snippet": "const asset = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").assets.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
302
|
+
},
|
|
303
|
+
"AssetController_listByActor": {
|
|
304
|
+
"actor": null,
|
|
305
|
+
"deprecated": false,
|
|
306
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/assets",
|
|
307
|
+
"idempotent": false,
|
|
308
|
+
"method": "list",
|
|
309
|
+
"paginated": true,
|
|
310
|
+
"params": "Social.ActorAssetListParams",
|
|
311
|
+
"poll": null,
|
|
312
|
+
"public": false,
|
|
313
|
+
"resource": "actors.assets",
|
|
314
|
+
"scope": "community",
|
|
315
|
+
"signature": "social.community(…).actors.assets.list(actorId, params?, options?): PagePromise<Social.Asset>",
|
|
316
|
+
"snippet": "for await (const asset of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.assets.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(asset);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.assets.list(\"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
317
|
+
},
|
|
318
|
+
"AssetController_upload": {
|
|
319
|
+
"actor": "body",
|
|
320
|
+
"deprecated": false,
|
|
321
|
+
"http": "POST /v1/communities/{community_id}/assets",
|
|
322
|
+
"idempotent": true,
|
|
323
|
+
"method": "create",
|
|
324
|
+
"paginated": false,
|
|
325
|
+
"params": "Social.AssetCreateParams",
|
|
326
|
+
"poll": null,
|
|
327
|
+
"public": false,
|
|
328
|
+
"resource": "assets",
|
|
329
|
+
"scope": "community",
|
|
330
|
+
"signature": "social.community(…).assets.create(params?, options?): Social.UploadAsset",
|
|
331
|
+
"snippet": "const uploadAsset = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").assets.create();"
|
|
332
|
+
},
|
|
333
|
+
"BookmarkController_create": {
|
|
334
|
+
"actor": "body",
|
|
335
|
+
"deprecated": false,
|
|
336
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/bookmark",
|
|
337
|
+
"idempotent": false,
|
|
338
|
+
"method": "bookmark",
|
|
339
|
+
"paginated": false,
|
|
340
|
+
"params": "Social.PostBookmarkParams",
|
|
341
|
+
"poll": null,
|
|
342
|
+
"public": false,
|
|
343
|
+
"resource": "posts",
|
|
344
|
+
"scope": "community",
|
|
345
|
+
"signature": "social.community(…).posts.bookmark(postId, params, options?): Social.BookmarkToggle",
|
|
346
|
+
"snippet": "const bookmarkToggle = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.bookmark(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {});"
|
|
347
|
+
},
|
|
348
|
+
"BookmarkController_delete": {
|
|
349
|
+
"actor": "query",
|
|
350
|
+
"deprecated": false,
|
|
351
|
+
"http": "DELETE /v1/communities/{community_id}/posts/{post_id}/bookmark",
|
|
352
|
+
"idempotent": false,
|
|
353
|
+
"method": "unbookmark",
|
|
354
|
+
"paginated": false,
|
|
355
|
+
"params": "Social.PostUnbookmarkParams",
|
|
356
|
+
"poll": null,
|
|
357
|
+
"public": false,
|
|
358
|
+
"resource": "posts",
|
|
359
|
+
"scope": "community",
|
|
360
|
+
"signature": "social.community(…).posts.unbookmark(postId, params, options?): void",
|
|
361
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.unbookmark(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {});"
|
|
362
|
+
},
|
|
363
|
+
"BookmarkController_list": {
|
|
364
|
+
"actor": null,
|
|
365
|
+
"deprecated": false,
|
|
366
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/bookmarks",
|
|
367
|
+
"idempotent": false,
|
|
368
|
+
"method": "list",
|
|
369
|
+
"paginated": true,
|
|
370
|
+
"params": "Social.ActorBookmarkListParams",
|
|
371
|
+
"poll": null,
|
|
372
|
+
"public": false,
|
|
373
|
+
"resource": "actors.bookmarks",
|
|
374
|
+
"scope": "community",
|
|
375
|
+
"signature": "social.community(…).actors.bookmarks.list(actorId, params?, options?): PagePromise<Social.Bookmark>",
|
|
376
|
+
"snippet": "for await (const bookmark of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.bookmarks.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(bookmark);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.bookmarks.list(\"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
377
|
+
},
|
|
378
|
+
"CollectionController_addItem": {
|
|
379
|
+
"actor": "body",
|
|
380
|
+
"deprecated": false,
|
|
381
|
+
"http": "POST /v1/communities/{community_id}/collections/{collection_id}/items",
|
|
382
|
+
"idempotent": true,
|
|
383
|
+
"method": "create",
|
|
384
|
+
"paginated": false,
|
|
385
|
+
"params": "Social.CollectionItemCreateParams",
|
|
386
|
+
"poll": null,
|
|
387
|
+
"public": false,
|
|
388
|
+
"resource": "collections.items",
|
|
389
|
+
"scope": "community",
|
|
390
|
+
"signature": "social.community(…).collections.items.create(collectionId, params, options?): Social.CollectionItem",
|
|
391
|
+
"snippet": "const collectionItem = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.items.create(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { post_id: \"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\" });"
|
|
392
|
+
},
|
|
393
|
+
"CollectionController_create": {
|
|
394
|
+
"actor": "body",
|
|
395
|
+
"deprecated": false,
|
|
396
|
+
"http": "POST /v1/communities/{community_id}/collections",
|
|
397
|
+
"idempotent": true,
|
|
398
|
+
"method": "create",
|
|
399
|
+
"paginated": false,
|
|
400
|
+
"params": "Social.CollectionCreateParams",
|
|
401
|
+
"poll": null,
|
|
402
|
+
"public": false,
|
|
403
|
+
"resource": "collections",
|
|
404
|
+
"scope": "community",
|
|
405
|
+
"signature": "social.community(…).collections.create(params, options?): Social.Collection",
|
|
406
|
+
"snippet": "const collection = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.create({ name: \"Travel\" });"
|
|
407
|
+
},
|
|
408
|
+
"CollectionController_delete": {
|
|
409
|
+
"actor": "query",
|
|
410
|
+
"deprecated": false,
|
|
411
|
+
"http": "DELETE /v1/communities/{community_id}/collections/{collection_id}",
|
|
412
|
+
"idempotent": false,
|
|
413
|
+
"method": "delete",
|
|
414
|
+
"paginated": false,
|
|
415
|
+
"params": "Social.CollectionDeleteParams",
|
|
416
|
+
"poll": null,
|
|
417
|
+
"public": false,
|
|
418
|
+
"resource": "collections",
|
|
419
|
+
"scope": "community",
|
|
420
|
+
"signature": "social.community(…).collections.delete(collectionId, params?, options?): void",
|
|
421
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { caller_actor_id: \"aaaaaaaa-0000-0000-0000-000000000001\" });"
|
|
422
|
+
},
|
|
423
|
+
"CollectionController_getById": {
|
|
424
|
+
"actor": "query",
|
|
425
|
+
"deprecated": false,
|
|
426
|
+
"http": "GET /v1/communities/{community_id}/collections/{collection_id}",
|
|
427
|
+
"idempotent": false,
|
|
428
|
+
"method": "retrieve",
|
|
429
|
+
"paginated": false,
|
|
430
|
+
"params": "Social.CollectionRetrieveParams",
|
|
431
|
+
"poll": null,
|
|
432
|
+
"public": false,
|
|
433
|
+
"resource": "collections",
|
|
434
|
+
"scope": "community",
|
|
435
|
+
"signature": "social.community(…).collections.retrieve(collectionId, params?, options?): Social.Collection",
|
|
436
|
+
"snippet": "const collection = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
437
|
+
},
|
|
438
|
+
"CollectionController_list": {
|
|
439
|
+
"actor": "query",
|
|
440
|
+
"deprecated": false,
|
|
441
|
+
"http": "GET /v1/communities/{community_id}/collections",
|
|
442
|
+
"idempotent": false,
|
|
443
|
+
"method": "list",
|
|
444
|
+
"paginated": true,
|
|
445
|
+
"params": "Social.CollectionListParams",
|
|
446
|
+
"poll": null,
|
|
447
|
+
"public": false,
|
|
448
|
+
"resource": "collections",
|
|
449
|
+
"scope": "community",
|
|
450
|
+
"signature": "social.community(…).collections.list(params?, options?): PagePromise<Social.Collection>",
|
|
451
|
+
"snippet": "for await (const collection of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.list()) {\n console.log(collection);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.list({}, { timeout: 5_000 });"
|
|
452
|
+
},
|
|
453
|
+
"CollectionController_listItems": {
|
|
454
|
+
"actor": "query",
|
|
455
|
+
"deprecated": false,
|
|
456
|
+
"http": "GET /v1/communities/{community_id}/collections/{collection_id}/items",
|
|
457
|
+
"idempotent": false,
|
|
458
|
+
"method": "list",
|
|
459
|
+
"paginated": true,
|
|
460
|
+
"params": "Social.CollectionItemListParams",
|
|
461
|
+
"poll": null,
|
|
462
|
+
"public": false,
|
|
463
|
+
"resource": "collections.items",
|
|
464
|
+
"scope": "community",
|
|
465
|
+
"signature": "social.community(…).collections.items.list(collectionId, params?, options?): PagePromise<Social.CollectionItem>",
|
|
466
|
+
"snippet": "for await (const item of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.items.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(item);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.items.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
467
|
+
},
|
|
468
|
+
"CollectionController_removeItem": {
|
|
469
|
+
"actor": "query",
|
|
470
|
+
"deprecated": false,
|
|
471
|
+
"http": "DELETE /v1/communities/{community_id}/collections/{collection_id}/items/{post_id}",
|
|
472
|
+
"idempotent": false,
|
|
473
|
+
"method": "delete",
|
|
474
|
+
"paginated": false,
|
|
475
|
+
"params": "Social.CollectionItemDeleteParams",
|
|
476
|
+
"poll": null,
|
|
477
|
+
"public": false,
|
|
478
|
+
"resource": "collections.items",
|
|
479
|
+
"scope": "community",
|
|
480
|
+
"signature": "social.community(…).collections.items.delete(collectionId, postId, params?, options?): void",
|
|
481
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.items.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { caller_actor_id: \"aaaaaaaa-0000-0000-0000-000000000001\" });"
|
|
482
|
+
},
|
|
483
|
+
"CollectionController_reorderItem": {
|
|
484
|
+
"actor": "body",
|
|
485
|
+
"deprecated": false,
|
|
486
|
+
"http": "PATCH /v1/communities/{community_id}/collections/{collection_id}/items/{post_id}",
|
|
487
|
+
"idempotent": false,
|
|
488
|
+
"method": "update",
|
|
489
|
+
"paginated": false,
|
|
490
|
+
"params": "Social.CollectionItemUpdateParams",
|
|
491
|
+
"poll": null,
|
|
492
|
+
"public": false,
|
|
493
|
+
"resource": "collections.items",
|
|
494
|
+
"scope": "community",
|
|
495
|
+
"signature": "social.community(…).collections.items.update(collectionId, postId, params, options?): Social.CollectionItem",
|
|
496
|
+
"snippet": "const collectionItem = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.items.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { position: 3 });"
|
|
497
|
+
},
|
|
498
|
+
"CollectionController_update": {
|
|
499
|
+
"actor": "body",
|
|
500
|
+
"deprecated": false,
|
|
501
|
+
"http": "PATCH /v1/communities/{community_id}/collections/{collection_id}",
|
|
502
|
+
"idempotent": false,
|
|
503
|
+
"method": "update",
|
|
504
|
+
"paginated": false,
|
|
505
|
+
"params": "Social.CollectionUpdateParams",
|
|
506
|
+
"poll": null,
|
|
507
|
+
"public": false,
|
|
508
|
+
"resource": "collections",
|
|
509
|
+
"scope": "community",
|
|
510
|
+
"signature": "social.community(…).collections.update(collectionId, params?, options?): Social.Collection",
|
|
511
|
+
"snippet": "const collection = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").collections.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
512
|
+
},
|
|
513
|
+
"CommentController_approve": {
|
|
514
|
+
"actor": "body",
|
|
515
|
+
"deprecated": false,
|
|
516
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}/approve",
|
|
517
|
+
"idempotent": false,
|
|
518
|
+
"method": "approve",
|
|
519
|
+
"paginated": false,
|
|
520
|
+
"params": "Social.PostCommentApproveParams",
|
|
521
|
+
"poll": null,
|
|
522
|
+
"public": false,
|
|
523
|
+
"resource": "posts.comments",
|
|
524
|
+
"scope": "community",
|
|
525
|
+
"signature": "social.community(…).posts.comments.approve(postId, commentId, params?, options?): Social.Comment",
|
|
526
|
+
"snippet": "const comment = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.approve(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"comment\");"
|
|
527
|
+
},
|
|
528
|
+
"CommentController_create": {
|
|
529
|
+
"actor": "body",
|
|
530
|
+
"deprecated": false,
|
|
531
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/comments",
|
|
532
|
+
"idempotent": true,
|
|
533
|
+
"method": "create",
|
|
534
|
+
"paginated": false,
|
|
535
|
+
"params": "Social.PostCommentCreateParams",
|
|
536
|
+
"poll": null,
|
|
537
|
+
"public": false,
|
|
538
|
+
"resource": "posts.comments",
|
|
539
|
+
"scope": "community",
|
|
540
|
+
"signature": "social.community(…).posts.comments.create(postId, params, options?): Social.Comment",
|
|
541
|
+
"snippet": "const comment = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.create(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", { body: \"Looks great, shipping today.\" });"
|
|
542
|
+
},
|
|
543
|
+
"CommentController_delete": {
|
|
544
|
+
"actor": null,
|
|
545
|
+
"deprecated": false,
|
|
546
|
+
"http": "DELETE /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}",
|
|
547
|
+
"idempotent": false,
|
|
548
|
+
"method": "delete",
|
|
549
|
+
"paginated": false,
|
|
550
|
+
"params": null,
|
|
551
|
+
"poll": null,
|
|
552
|
+
"public": false,
|
|
553
|
+
"resource": "posts.comments",
|
|
554
|
+
"scope": "community",
|
|
555
|
+
"signature": "social.community(…).posts.comments.delete(postId, commentId, options?): void",
|
|
556
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.delete(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"comment\");"
|
|
557
|
+
},
|
|
558
|
+
"CommentController_getById": {
|
|
559
|
+
"actor": "query",
|
|
560
|
+
"deprecated": false,
|
|
561
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}",
|
|
562
|
+
"idempotent": false,
|
|
563
|
+
"method": "retrieve",
|
|
564
|
+
"paginated": false,
|
|
565
|
+
"params": "Social.PostCommentRetrieveParams",
|
|
566
|
+
"poll": null,
|
|
567
|
+
"public": false,
|
|
568
|
+
"resource": "posts.comments",
|
|
569
|
+
"scope": "community",
|
|
570
|
+
"signature": "social.community(…).posts.comments.retrieve(postId, commentId, params?, options?): Social.Comment",
|
|
571
|
+
"snippet": "const comment = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.retrieve(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"bbbbbbbb-0000-0000-0000-000000000001\");"
|
|
572
|
+
},
|
|
573
|
+
"CommentController_list": {
|
|
574
|
+
"actor": "query",
|
|
575
|
+
"deprecated": false,
|
|
576
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/comments",
|
|
577
|
+
"idempotent": false,
|
|
578
|
+
"method": "list",
|
|
579
|
+
"paginated": true,
|
|
580
|
+
"params": "Social.PostCommentListParams",
|
|
581
|
+
"poll": null,
|
|
582
|
+
"public": false,
|
|
583
|
+
"resource": "posts.comments",
|
|
584
|
+
"scope": "community",
|
|
585
|
+
"signature": "social.community(…).posts.comments.list(postId, params?, options?): PagePromise<Social.Comment>",
|
|
586
|
+
"snippet": "for await (const comment of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\")) {\n console.log(comment);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {}, { timeout: 5_000 });"
|
|
587
|
+
},
|
|
588
|
+
"CommentController_pin": {
|
|
589
|
+
"actor": "body",
|
|
590
|
+
"deprecated": false,
|
|
591
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}/pin",
|
|
592
|
+
"idempotent": false,
|
|
593
|
+
"method": "pin",
|
|
594
|
+
"paginated": false,
|
|
595
|
+
"params": "Social.PostCommentPinParams",
|
|
596
|
+
"poll": null,
|
|
597
|
+
"public": false,
|
|
598
|
+
"resource": "posts.comments",
|
|
599
|
+
"scope": "community",
|
|
600
|
+
"signature": "social.community(…).posts.comments.pin(postId, commentId, params, options?): Social.Comment",
|
|
601
|
+
"snippet": "const comment = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.pin(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"comment\", {});"
|
|
602
|
+
},
|
|
603
|
+
"CommentController_unpin": {
|
|
604
|
+
"actor": "body",
|
|
605
|
+
"deprecated": false,
|
|
606
|
+
"http": "DELETE /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}/pin",
|
|
607
|
+
"idempotent": false,
|
|
608
|
+
"method": "unpin",
|
|
609
|
+
"paginated": false,
|
|
610
|
+
"params": "Social.PostCommentUnpinParams",
|
|
611
|
+
"poll": null,
|
|
612
|
+
"public": false,
|
|
613
|
+
"resource": "posts.comments",
|
|
614
|
+
"scope": "community",
|
|
615
|
+
"signature": "social.community(…).posts.comments.unpin(postId, commentId, params, options?): Social.Comment",
|
|
616
|
+
"snippet": "const comment = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.unpin(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"comment\", {});"
|
|
617
|
+
},
|
|
618
|
+
"CommentController_update": {
|
|
619
|
+
"actor": null,
|
|
620
|
+
"deprecated": false,
|
|
621
|
+
"http": "PATCH /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}",
|
|
622
|
+
"idempotent": false,
|
|
623
|
+
"method": "update",
|
|
624
|
+
"paginated": false,
|
|
625
|
+
"params": "Social.PostCommentUpdateParams",
|
|
626
|
+
"poll": null,
|
|
627
|
+
"public": false,
|
|
628
|
+
"resource": "posts.comments",
|
|
629
|
+
"scope": "community",
|
|
630
|
+
"signature": "social.community(…).posts.comments.update(postId, commentId, params?, options?): Social.Comment",
|
|
631
|
+
"snippet": "const comment = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.update(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"comment\", { body: \"string\" });"
|
|
632
|
+
},
|
|
633
|
+
"CommentReactionController_add": {
|
|
634
|
+
"actor": "body",
|
|
635
|
+
"deprecated": false,
|
|
636
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}/reactions",
|
|
637
|
+
"idempotent": true,
|
|
638
|
+
"method": "create",
|
|
639
|
+
"paginated": false,
|
|
640
|
+
"params": "Social.PostCommentReactionCreateParams",
|
|
641
|
+
"poll": null,
|
|
642
|
+
"public": false,
|
|
643
|
+
"resource": "posts.comments.reactions",
|
|
644
|
+
"scope": "community",
|
|
645
|
+
"signature": "social.community(…).posts.comments.reactions.create(postId, commentId, params, options?): Social.AddCommentReaction",
|
|
646
|
+
"snippet": "const addCommentReaction = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.reactions.create(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"bbbbbbbb-0000-0000-0000-000000000001\", { type: \"like\" });"
|
|
647
|
+
},
|
|
648
|
+
"CommentReactionController_list": {
|
|
649
|
+
"actor": null,
|
|
650
|
+
"deprecated": false,
|
|
651
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}/reactions",
|
|
652
|
+
"idempotent": false,
|
|
653
|
+
"method": "list",
|
|
654
|
+
"paginated": true,
|
|
655
|
+
"params": "Social.PostCommentReactionListParams",
|
|
656
|
+
"poll": null,
|
|
657
|
+
"public": false,
|
|
658
|
+
"resource": "posts.comments.reactions",
|
|
659
|
+
"scope": "community",
|
|
660
|
+
"signature": "social.community(…).posts.comments.reactions.list(postId, commentId, params?, options?): PagePromise<Social.CommentReactionEntry>",
|
|
661
|
+
"snippet": "for await (const reaction of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.reactions.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"bbbbbbbb-0000-0000-0000-000000000001\")) {\n console.log(reaction);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.reactions.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"bbbbbbbb-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
662
|
+
},
|
|
663
|
+
"CommentReactionController_remove": {
|
|
664
|
+
"actor": null,
|
|
665
|
+
"deprecated": false,
|
|
666
|
+
"http": "DELETE /v1/communities/{community_id}/posts/{post_id}/comments/{comment_id}/reactions/{src_actor_id}/{type}",
|
|
667
|
+
"idempotent": false,
|
|
668
|
+
"method": "delete",
|
|
669
|
+
"paginated": false,
|
|
670
|
+
"params": null,
|
|
671
|
+
"poll": null,
|
|
672
|
+
"public": false,
|
|
673
|
+
"resource": "posts.comments.reactions",
|
|
674
|
+
"scope": "community",
|
|
675
|
+
"signature": "social.community(…).posts.comments.reactions.delete(postId, commentId, srcActorId, type, options?): Social.CommentReactionCounts",
|
|
676
|
+
"snippet": "const commentReactionCounts = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.comments.reactions.delete(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"bbbbbbbb-0000-0000-0000-000000000001\", \"src_actor\", \"like\");"
|
|
677
|
+
},
|
|
678
|
+
"CommunityController_create": {
|
|
679
|
+
"actor": null,
|
|
680
|
+
"deprecated": false,
|
|
681
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities",
|
|
682
|
+
"idempotent": true,
|
|
683
|
+
"method": "create",
|
|
684
|
+
"paginated": false,
|
|
685
|
+
"params": "Social.CommunityCreateParams",
|
|
686
|
+
"poll": null,
|
|
687
|
+
"public": false,
|
|
688
|
+
"resource": "communities",
|
|
689
|
+
"scope": null,
|
|
690
|
+
"signature": "social.communities.create(params, options?): Social.Community",
|
|
691
|
+
"snippet": "const community = await social.communities.create({ display_name: \"My Product Community\", slug: \"my-product-community\" });"
|
|
692
|
+
},
|
|
693
|
+
"CommunityController_delete": {
|
|
694
|
+
"actor": null,
|
|
695
|
+
"deprecated": false,
|
|
696
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/communities/{community_id}",
|
|
697
|
+
"idempotent": false,
|
|
698
|
+
"method": "delete",
|
|
699
|
+
"paginated": false,
|
|
700
|
+
"params": null,
|
|
701
|
+
"poll": null,
|
|
702
|
+
"public": false,
|
|
703
|
+
"resource": "communities",
|
|
704
|
+
"scope": null,
|
|
705
|
+
"signature": "social.communities.delete(communityId, options?): void",
|
|
706
|
+
"snippet": "await social.communities.delete(\"cccccccc-cccc-cccc-cccc-cccccccccccc\");"
|
|
707
|
+
},
|
|
708
|
+
"CommunityController_get": {
|
|
709
|
+
"actor": null,
|
|
710
|
+
"deprecated": false,
|
|
711
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}",
|
|
712
|
+
"idempotent": false,
|
|
713
|
+
"method": "retrieve",
|
|
714
|
+
"paginated": false,
|
|
715
|
+
"params": null,
|
|
716
|
+
"poll": null,
|
|
717
|
+
"public": false,
|
|
718
|
+
"resource": "communities",
|
|
719
|
+
"scope": null,
|
|
720
|
+
"signature": "social.communities.retrieve(communityId, options?): Social.Community",
|
|
721
|
+
"snippet": "const community = await social.communities.retrieve(\"cccccccc-cccc-cccc-cccc-cccccccccccc\");"
|
|
722
|
+
},
|
|
723
|
+
"CommunityController_list": {
|
|
724
|
+
"actor": null,
|
|
725
|
+
"deprecated": false,
|
|
726
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities",
|
|
727
|
+
"idempotent": false,
|
|
728
|
+
"method": "list",
|
|
729
|
+
"paginated": true,
|
|
730
|
+
"params": "Social.CommunityListParams",
|
|
731
|
+
"poll": null,
|
|
732
|
+
"public": false,
|
|
733
|
+
"resource": "communities",
|
|
734
|
+
"scope": null,
|
|
735
|
+
"signature": "social.communities.list(params?, options?): PagePromise<Social.Community>",
|
|
736
|
+
"snippet": "for await (const community of social.communities.list()) {\n console.log(community);\n}\nconst page = await social.communities.list({}, { timeout: 5_000 });"
|
|
737
|
+
},
|
|
738
|
+
"CommunityController_update": {
|
|
739
|
+
"actor": null,
|
|
740
|
+
"deprecated": false,
|
|
741
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/communities/{community_id}",
|
|
742
|
+
"idempotent": false,
|
|
743
|
+
"method": "update",
|
|
744
|
+
"paginated": false,
|
|
745
|
+
"params": "Social.CommunityUpdateParams",
|
|
746
|
+
"poll": null,
|
|
747
|
+
"public": false,
|
|
748
|
+
"resource": "communities",
|
|
749
|
+
"scope": null,
|
|
750
|
+
"signature": "social.communities.update(communityId, params?, options?): Social.Community",
|
|
751
|
+
"snippet": "const community = await social.communities.update(\"cccccccc-cccc-cccc-cccc-cccccccccccc\", { description: \"string\" });"
|
|
752
|
+
},
|
|
753
|
+
"ConnectionController_accept": {
|
|
754
|
+
"actor": null,
|
|
755
|
+
"deprecated": false,
|
|
756
|
+
"http": "POST /v1/communities/{community_id}/connections/{dst_actor_id}/{src_actor_id}/accept",
|
|
757
|
+
"idempotent": false,
|
|
758
|
+
"method": "accept",
|
|
759
|
+
"paginated": false,
|
|
760
|
+
"params": null,
|
|
761
|
+
"poll": null,
|
|
762
|
+
"public": false,
|
|
763
|
+
"resource": "connections",
|
|
764
|
+
"scope": "community",
|
|
765
|
+
"signature": "social.community(…).connections.accept(dstActorId, srcActorId, options?): Social.ConnectionResult",
|
|
766
|
+
"snippet": "const connectionResult = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").connections.accept(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
767
|
+
},
|
|
768
|
+
"ConnectionController_request": {
|
|
769
|
+
"actor": null,
|
|
770
|
+
"deprecated": false,
|
|
771
|
+
"http": "POST /v1/communities/{community_id}/connections",
|
|
772
|
+
"idempotent": true,
|
|
773
|
+
"method": "create",
|
|
774
|
+
"paginated": false,
|
|
775
|
+
"params": "Social.ConnectionCreateParams",
|
|
776
|
+
"poll": null,
|
|
777
|
+
"public": false,
|
|
778
|
+
"resource": "connections",
|
|
779
|
+
"scope": "community",
|
|
780
|
+
"signature": "social.community(…).connections.create(params, options?): Social.ConnectionResult",
|
|
781
|
+
"snippet": "const connectionResult = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").connections.create({\n dst_actor_id: \"aaaaaaaa-0000-0000-0000-000000000002\",\n src_actor_id: \"aaaaaaaa-0000-0000-0000-000000000001\",\n});"
|
|
782
|
+
},
|
|
783
|
+
"ConnectionController_sever": {
|
|
784
|
+
"actor": null,
|
|
785
|
+
"deprecated": false,
|
|
786
|
+
"http": "DELETE /v1/communities/{community_id}/connections/{actor_id}/{other_actor_id}",
|
|
787
|
+
"idempotent": false,
|
|
788
|
+
"method": "delete",
|
|
789
|
+
"paginated": false,
|
|
790
|
+
"params": null,
|
|
791
|
+
"poll": null,
|
|
792
|
+
"public": false,
|
|
793
|
+
"resource": "connections",
|
|
794
|
+
"scope": "community",
|
|
795
|
+
"signature": "social.community(…).connections.delete(actorId, otherActorId, options?): void",
|
|
796
|
+
"snippet": "await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").connections.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
797
|
+
},
|
|
798
|
+
"ConversationController_addMember": {
|
|
799
|
+
"actor": "body",
|
|
800
|
+
"deprecated": false,
|
|
801
|
+
"http": "POST /v1/communities/{community_id}/conversations/{conversation_id}/members",
|
|
802
|
+
"idempotent": true,
|
|
803
|
+
"method": "create",
|
|
804
|
+
"paginated": false,
|
|
805
|
+
"params": "Social.ConversationMemberCreateParams",
|
|
806
|
+
"poll": null,
|
|
807
|
+
"public": false,
|
|
808
|
+
"resource": "conversations.members",
|
|
809
|
+
"scope": "community",
|
|
810
|
+
"signature": "social.community(…).conversations.members.create(conversationId, params, options?): Social.Conversation",
|
|
811
|
+
"snippet": "const conversation = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.members.create(\"conversation\", {});"
|
|
812
|
+
},
|
|
813
|
+
"ConversationController_create": {
|
|
814
|
+
"actor": "body",
|
|
815
|
+
"deprecated": false,
|
|
816
|
+
"http": "POST /v1/communities/{community_id}/conversations",
|
|
817
|
+
"idempotent": true,
|
|
818
|
+
"method": "create",
|
|
819
|
+
"paginated": false,
|
|
820
|
+
"params": "Social.ConversationCreateParams",
|
|
821
|
+
"poll": null,
|
|
822
|
+
"public": false,
|
|
823
|
+
"resource": "conversations",
|
|
824
|
+
"scope": "community",
|
|
825
|
+
"signature": "social.community(…).conversations.create(params, options?): Social.Conversation",
|
|
826
|
+
"snippet": "const conversation = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.create({});"
|
|
827
|
+
},
|
|
828
|
+
"ConversationController_deleteMessage": {
|
|
829
|
+
"actor": "query",
|
|
830
|
+
"deprecated": false,
|
|
831
|
+
"http": "DELETE /v1/communities/{community_id}/conversations/{conversation_id}/messages/{message_id}",
|
|
832
|
+
"idempotent": false,
|
|
833
|
+
"method": "delete",
|
|
834
|
+
"paginated": false,
|
|
835
|
+
"params": "Social.ConversationMessageDeleteParams",
|
|
836
|
+
"poll": null,
|
|
837
|
+
"public": false,
|
|
838
|
+
"resource": "conversations.messages",
|
|
839
|
+
"scope": "community",
|
|
840
|
+
"signature": "social.community(…).conversations.messages.delete(conversationId, messageId, params, options?): void",
|
|
841
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.messages.delete(\"conversation\", \"message\", {});"
|
|
842
|
+
},
|
|
843
|
+
"ConversationController_editMessage": {
|
|
844
|
+
"actor": "body",
|
|
845
|
+
"deprecated": false,
|
|
846
|
+
"http": "PATCH /v1/communities/{community_id}/conversations/{conversation_id}/messages/{message_id}",
|
|
847
|
+
"idempotent": false,
|
|
848
|
+
"method": "update",
|
|
849
|
+
"paginated": false,
|
|
850
|
+
"params": "Social.ConversationMessageUpdateParams",
|
|
851
|
+
"poll": null,
|
|
852
|
+
"public": false,
|
|
853
|
+
"resource": "conversations.messages",
|
|
854
|
+
"scope": "community",
|
|
855
|
+
"signature": "social.community(…).conversations.messages.update(conversationId, messageId, params, options?): Social.DirectMessage",
|
|
856
|
+
"snippet": "const directMessage = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.messages.update(\"conversation\", \"message\", { body: \"edited\" });"
|
|
857
|
+
},
|
|
858
|
+
"ConversationController_getById": {
|
|
859
|
+
"actor": "query",
|
|
860
|
+
"deprecated": false,
|
|
861
|
+
"http": "GET /v1/communities/{community_id}/conversations/{conversation_id}",
|
|
862
|
+
"idempotent": false,
|
|
863
|
+
"method": "retrieve",
|
|
864
|
+
"paginated": false,
|
|
865
|
+
"params": "Social.ConversationRetrieveParams",
|
|
866
|
+
"poll": null,
|
|
867
|
+
"public": false,
|
|
868
|
+
"resource": "conversations",
|
|
869
|
+
"scope": "community",
|
|
870
|
+
"signature": "social.community(…).conversations.retrieve(conversationId, params, options?): Social.Conversation",
|
|
871
|
+
"snippet": "const conversation = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.retrieve(\"conversation\", {});"
|
|
872
|
+
},
|
|
873
|
+
"ConversationController_getMessage": {
|
|
874
|
+
"actor": "query",
|
|
875
|
+
"deprecated": false,
|
|
876
|
+
"http": "GET /v1/communities/{community_id}/conversations/{conversation_id}/messages/{message_id}",
|
|
877
|
+
"idempotent": false,
|
|
878
|
+
"method": "retrieve",
|
|
879
|
+
"paginated": false,
|
|
880
|
+
"params": "Social.ConversationMessageRetrieveParams",
|
|
881
|
+
"poll": null,
|
|
882
|
+
"public": false,
|
|
883
|
+
"resource": "conversations.messages",
|
|
884
|
+
"scope": "community",
|
|
885
|
+
"signature": "social.community(…).conversations.messages.retrieve(conversationId, messageId, params, options?): Social.DirectMessage",
|
|
886
|
+
"snippet": "const directMessage = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.messages.retrieve(\"conversation\", \"message\", {});"
|
|
887
|
+
},
|
|
888
|
+
"ConversationController_leave": {
|
|
889
|
+
"actor": "query",
|
|
890
|
+
"deprecated": false,
|
|
891
|
+
"http": "DELETE /v1/communities/{community_id}/conversations/{conversation_id}",
|
|
892
|
+
"idempotent": false,
|
|
893
|
+
"method": "delete",
|
|
894
|
+
"paginated": false,
|
|
895
|
+
"params": "Social.ConversationDeleteParams",
|
|
896
|
+
"poll": null,
|
|
897
|
+
"public": false,
|
|
898
|
+
"resource": "conversations",
|
|
899
|
+
"scope": "community",
|
|
900
|
+
"signature": "social.community(…).conversations.delete(conversationId, params, options?): void",
|
|
901
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.delete(\"conversation\", {});"
|
|
902
|
+
},
|
|
903
|
+
"ConversationController_list": {
|
|
904
|
+
"actor": "query",
|
|
905
|
+
"deprecated": false,
|
|
906
|
+
"http": "GET /v1/communities/{community_id}/conversations",
|
|
907
|
+
"idempotent": false,
|
|
908
|
+
"method": "list",
|
|
909
|
+
"paginated": true,
|
|
910
|
+
"params": "Social.ConversationListParams",
|
|
911
|
+
"poll": null,
|
|
912
|
+
"public": false,
|
|
913
|
+
"resource": "conversations",
|
|
914
|
+
"scope": "community",
|
|
915
|
+
"signature": "social.community(…).conversations.list(params, options?): PagePromise<Social.Conversation>",
|
|
916
|
+
"snippet": "for await (const conversation of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.list({})) {\n console.log(conversation);\n}"
|
|
917
|
+
},
|
|
918
|
+
"ConversationController_listMessages": {
|
|
919
|
+
"actor": "query",
|
|
920
|
+
"deprecated": false,
|
|
921
|
+
"http": "GET /v1/communities/{community_id}/conversations/{conversation_id}/messages",
|
|
922
|
+
"idempotent": false,
|
|
923
|
+
"method": "list",
|
|
924
|
+
"paginated": true,
|
|
925
|
+
"params": "Social.ConversationMessageListParams",
|
|
926
|
+
"poll": null,
|
|
927
|
+
"public": false,
|
|
928
|
+
"resource": "conversations.messages",
|
|
929
|
+
"scope": "community",
|
|
930
|
+
"signature": "social.community(…).conversations.messages.list(conversationId, params, options?): PagePromise<Social.DirectMessage>",
|
|
931
|
+
"snippet": "for await (const message of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.messages.list(\"conversation\", {})) {\n console.log(message);\n}"
|
|
932
|
+
},
|
|
933
|
+
"ConversationController_markRead": {
|
|
934
|
+
"actor": "body",
|
|
935
|
+
"deprecated": false,
|
|
936
|
+
"http": "POST /v1/communities/{community_id}/conversations/{conversation_id}/read",
|
|
937
|
+
"idempotent": false,
|
|
938
|
+
"method": "markRead",
|
|
939
|
+
"paginated": false,
|
|
940
|
+
"params": "Social.ConversationMarkReadParams",
|
|
941
|
+
"poll": null,
|
|
942
|
+
"public": false,
|
|
943
|
+
"resource": "conversations",
|
|
944
|
+
"scope": "community",
|
|
945
|
+
"signature": "social.community(…).conversations.markRead(conversationId, params, options?): void",
|
|
946
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.markRead(\"conversation\", {});"
|
|
947
|
+
},
|
|
948
|
+
"ConversationController_removeMember": {
|
|
949
|
+
"actor": "query",
|
|
950
|
+
"deprecated": false,
|
|
951
|
+
"http": "DELETE /v1/communities/{community_id}/conversations/{conversation_id}/members/{member_actor_id}",
|
|
952
|
+
"idempotent": false,
|
|
953
|
+
"method": "delete",
|
|
954
|
+
"paginated": false,
|
|
955
|
+
"params": "Social.ConversationMemberDeleteParams",
|
|
956
|
+
"poll": null,
|
|
957
|
+
"public": false,
|
|
958
|
+
"resource": "conversations.members",
|
|
959
|
+
"scope": "community",
|
|
960
|
+
"signature": "social.community(…).conversations.members.delete(conversationId, memberActorId, params, options?): void",
|
|
961
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.members.delete(\"conversation\", \"member_actor\", {});"
|
|
962
|
+
},
|
|
963
|
+
"ConversationController_send": {
|
|
964
|
+
"actor": "body",
|
|
965
|
+
"deprecated": false,
|
|
966
|
+
"http": "POST /v1/communities/{community_id}/conversations/{conversation_id}/messages",
|
|
967
|
+
"idempotent": true,
|
|
968
|
+
"method": "create",
|
|
969
|
+
"paginated": false,
|
|
970
|
+
"params": "Social.ConversationMessageCreateParams",
|
|
971
|
+
"poll": null,
|
|
972
|
+
"public": false,
|
|
973
|
+
"resource": "conversations.messages",
|
|
974
|
+
"scope": "community",
|
|
975
|
+
"signature": "social.community(…).conversations.messages.create(conversationId, params, options?): Social.DirectMessage",
|
|
976
|
+
"snippet": "const directMessage = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.messages.create(\"conversation\", {});"
|
|
977
|
+
},
|
|
978
|
+
"ConversationController_unreadCount": {
|
|
979
|
+
"actor": "query",
|
|
980
|
+
"deprecated": false,
|
|
981
|
+
"http": "GET /v1/communities/{community_id}/conversations/unread-count",
|
|
982
|
+
"idempotent": false,
|
|
983
|
+
"method": "unreadCount",
|
|
984
|
+
"paginated": false,
|
|
985
|
+
"params": "Social.ConversationUnreadCountParams",
|
|
986
|
+
"poll": null,
|
|
987
|
+
"public": false,
|
|
988
|
+
"resource": "conversations",
|
|
989
|
+
"scope": "community",
|
|
990
|
+
"signature": "social.community(…).conversations.unreadCount(params, options?): Social.UnreadCount",
|
|
991
|
+
"snippet": "const unreadCount = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.unreadCount({});"
|
|
992
|
+
},
|
|
993
|
+
"ConversationController_update": {
|
|
994
|
+
"actor": "body",
|
|
995
|
+
"deprecated": false,
|
|
996
|
+
"http": "PATCH /v1/communities/{community_id}/conversations/{conversation_id}",
|
|
997
|
+
"idempotent": false,
|
|
998
|
+
"method": "update",
|
|
999
|
+
"paginated": false,
|
|
1000
|
+
"params": "Social.ConversationUpdateParams",
|
|
1001
|
+
"poll": null,
|
|
1002
|
+
"public": false,
|
|
1003
|
+
"resource": "conversations",
|
|
1004
|
+
"scope": "community",
|
|
1005
|
+
"signature": "social.community(…).conversations.update(conversationId, params, options?): Social.Conversation",
|
|
1006
|
+
"snippet": "const conversation = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.update(\"conversation\", {});"
|
|
1007
|
+
},
|
|
1008
|
+
"ConversationController_updateMember": {
|
|
1009
|
+
"actor": "body",
|
|
1010
|
+
"deprecated": false,
|
|
1011
|
+
"http": "PATCH /v1/communities/{community_id}/conversations/{conversation_id}/members/{member_actor_id}",
|
|
1012
|
+
"idempotent": false,
|
|
1013
|
+
"method": "update",
|
|
1014
|
+
"paginated": false,
|
|
1015
|
+
"params": "Social.ConversationMemberUpdateParams",
|
|
1016
|
+
"poll": null,
|
|
1017
|
+
"public": false,
|
|
1018
|
+
"resource": "conversations.members",
|
|
1019
|
+
"scope": "community",
|
|
1020
|
+
"signature": "social.community(…).conversations.members.update(conversationId, memberActorId, params?, options?): Social.Conversation",
|
|
1021
|
+
"snippet": "const conversation = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.members.update(\"conversation\", \"member_actor\");"
|
|
1022
|
+
},
|
|
1023
|
+
"ConversationModerationController_listConversations": {
|
|
1024
|
+
"actor": null,
|
|
1025
|
+
"deprecated": false,
|
|
1026
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/conversations",
|
|
1027
|
+
"idempotent": false,
|
|
1028
|
+
"method": "list",
|
|
1029
|
+
"paginated": true,
|
|
1030
|
+
"params": "Social.CommunityModerationConversationListParams",
|
|
1031
|
+
"poll": null,
|
|
1032
|
+
"public": false,
|
|
1033
|
+
"resource": "communities.moderation.conversations",
|
|
1034
|
+
"scope": null,
|
|
1035
|
+
"signature": "social.communities.moderation.conversations.list(communityId, params?, options?): PagePromise<Social.ConversationAdmin>",
|
|
1036
|
+
"snippet": "for await (const conversation of social.communities.moderation.conversations.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(conversation);\n}\nconst page = await social.communities.moderation.conversations.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
1037
|
+
},
|
|
1038
|
+
"ConversationModerationController_listMessages": {
|
|
1039
|
+
"actor": null,
|
|
1040
|
+
"deprecated": false,
|
|
1041
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/conversations/{conversation_id}/messages",
|
|
1042
|
+
"idempotent": false,
|
|
1043
|
+
"method": "list",
|
|
1044
|
+
"paginated": true,
|
|
1045
|
+
"params": "Social.CommunityModerationConversationMessageListParams",
|
|
1046
|
+
"poll": null,
|
|
1047
|
+
"public": false,
|
|
1048
|
+
"resource": "communities.moderation.conversations.messages",
|
|
1049
|
+
"scope": null,
|
|
1050
|
+
"signature": "social.communities.moderation.conversations.messages.list(communityId, conversationId, params?, options?): PagePromise<Social.DirectMessageAdmin>",
|
|
1051
|
+
"snippet": "for await (const message of social.communities.moderation.conversations.messages.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"conversation\")) {\n console.log(message);\n}\nconst page = await social.communities.moderation.conversations.messages.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"conversation\", {}, { timeout: 5_000 });"
|
|
1052
|
+
},
|
|
1053
|
+
"CounterController_getBatchCounters": {
|
|
1054
|
+
"actor": null,
|
|
1055
|
+
"deprecated": false,
|
|
1056
|
+
"http": "GET /v1/communities/{community_id}/counters",
|
|
1057
|
+
"idempotent": false,
|
|
1058
|
+
"method": "list",
|
|
1059
|
+
"paginated": false,
|
|
1060
|
+
"params": "Social.CounterListParams",
|
|
1061
|
+
"poll": null,
|
|
1062
|
+
"public": false,
|
|
1063
|
+
"resource": "counters",
|
|
1064
|
+
"scope": "community",
|
|
1065
|
+
"signature": "social.community(…).counters.list(params, options?): Social.BatchCounters",
|
|
1066
|
+
"snippet": "const batchCounters = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").counters.list({ actor_ids: \"string\" });"
|
|
1067
|
+
},
|
|
1068
|
+
"CounterController_getCounters": {
|
|
1069
|
+
"actor": null,
|
|
1070
|
+
"deprecated": false,
|
|
1071
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/counters",
|
|
1072
|
+
"idempotent": false,
|
|
1073
|
+
"method": "counters",
|
|
1074
|
+
"paginated": false,
|
|
1075
|
+
"params": null,
|
|
1076
|
+
"poll": null,
|
|
1077
|
+
"public": false,
|
|
1078
|
+
"resource": "actors",
|
|
1079
|
+
"scope": "community",
|
|
1080
|
+
"signature": "social.community(…).actors.counters(actorId, options?): Social.ActorCounters",
|
|
1081
|
+
"snippet": "const actorCounters = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.counters(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\");"
|
|
1082
|
+
},
|
|
1083
|
+
"DirectMessageReactionController_add": {
|
|
1084
|
+
"actor": "body",
|
|
1085
|
+
"deprecated": false,
|
|
1086
|
+
"http": "POST /v1/communities/{community_id}/conversations/{conversation_id}/messages/{message_id}/reactions",
|
|
1087
|
+
"idempotent": true,
|
|
1088
|
+
"method": "create",
|
|
1089
|
+
"paginated": false,
|
|
1090
|
+
"params": "Social.ConversationMessageReactionCreateParams",
|
|
1091
|
+
"poll": null,
|
|
1092
|
+
"public": false,
|
|
1093
|
+
"resource": "conversations.messages.reactions",
|
|
1094
|
+
"scope": "community",
|
|
1095
|
+
"signature": "social.community(…).conversations.messages.reactions.create(conversationId, messageId, params, options?): Social.DirectMessageReactionCreated",
|
|
1096
|
+
"snippet": "const directMessageReactionCreated = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.messages.reactions.create(\"11111111-2222-3333-4444-555555555555\", \"mmmmmmmm-0000-0000-0000-000000000001\", { type: \"heart\" });"
|
|
1097
|
+
},
|
|
1098
|
+
"DirectMessageReactionController_list": {
|
|
1099
|
+
"actor": "query",
|
|
1100
|
+
"deprecated": false,
|
|
1101
|
+
"http": "GET /v1/communities/{community_id}/conversations/{conversation_id}/messages/{message_id}/reactions",
|
|
1102
|
+
"idempotent": false,
|
|
1103
|
+
"method": "list",
|
|
1104
|
+
"paginated": true,
|
|
1105
|
+
"params": "Social.ConversationMessageReactionListParams",
|
|
1106
|
+
"poll": null,
|
|
1107
|
+
"public": false,
|
|
1108
|
+
"resource": "conversations.messages.reactions",
|
|
1109
|
+
"scope": "community",
|
|
1110
|
+
"signature": "social.community(…).conversations.messages.reactions.list(conversationId, messageId, params, options?): PagePromise<Social.DirectMessageReaction>",
|
|
1111
|
+
"snippet": "for await (const reaction of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.messages.reactions.list(\"11111111-2222-3333-4444-555555555555\", \"mmmmmmmm-0000-0000-0000-000000000001\", {})) {\n console.log(reaction);\n}"
|
|
1112
|
+
},
|
|
1113
|
+
"DirectMessageReactionController_remove": {
|
|
1114
|
+
"actor": null,
|
|
1115
|
+
"deprecated": false,
|
|
1116
|
+
"http": "DELETE /v1/communities/{community_id}/conversations/{conversation_id}/messages/{message_id}/reactions/{actor_id}/{type}",
|
|
1117
|
+
"idempotent": false,
|
|
1118
|
+
"method": "delete",
|
|
1119
|
+
"paginated": false,
|
|
1120
|
+
"params": null,
|
|
1121
|
+
"poll": null,
|
|
1122
|
+
"public": false,
|
|
1123
|
+
"resource": "conversations.messages.reactions",
|
|
1124
|
+
"scope": "community",
|
|
1125
|
+
"signature": "social.community(…).conversations.messages.reactions.delete(conversationId, messageId, actorId, type, options?): Social.DirectMessageReactionRemoved",
|
|
1126
|
+
"snippet": "const directMessageReactionRemoved = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").conversations.messages.reactions.delete(\"11111111-2222-3333-4444-555555555555\", \"mmmmmmmm-0000-0000-0000-000000000001\", \"actor\", \"like\");"
|
|
1127
|
+
},
|
|
1128
|
+
"DraftController_listArchived": {
|
|
1129
|
+
"actor": null,
|
|
1130
|
+
"deprecated": false,
|
|
1131
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/archived",
|
|
1132
|
+
"idempotent": false,
|
|
1133
|
+
"method": "list",
|
|
1134
|
+
"paginated": true,
|
|
1135
|
+
"params": "Social.ActorArchivedListParams",
|
|
1136
|
+
"poll": null,
|
|
1137
|
+
"public": false,
|
|
1138
|
+
"resource": "actors.archived",
|
|
1139
|
+
"scope": "community",
|
|
1140
|
+
"signature": "social.community(…).actors.archived.list(actorId, params?, options?): PagePromise<Social.Post>",
|
|
1141
|
+
"snippet": "for await (const archived of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.archived.list(\"actor\")) {\n console.log(archived);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.archived.list(\"actor\", {}, { timeout: 5_000 });"
|
|
1142
|
+
},
|
|
1143
|
+
"DraftController_listDrafts": {
|
|
1144
|
+
"actor": null,
|
|
1145
|
+
"deprecated": false,
|
|
1146
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/drafts",
|
|
1147
|
+
"idempotent": false,
|
|
1148
|
+
"method": "list",
|
|
1149
|
+
"paginated": true,
|
|
1150
|
+
"params": "Social.ActorDraftListParams",
|
|
1151
|
+
"poll": null,
|
|
1152
|
+
"public": false,
|
|
1153
|
+
"resource": "actors.drafts",
|
|
1154
|
+
"scope": "community",
|
|
1155
|
+
"signature": "social.community(…).actors.drafts.list(actorId, params?, options?): PagePromise<Social.Post>",
|
|
1156
|
+
"snippet": "for await (const draft of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.drafts.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\")) {\n console.log(draft);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.drafts.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", {}, { timeout: 5_000 });"
|
|
1157
|
+
},
|
|
1158
|
+
"DraftController_listScheduledPosts": {
|
|
1159
|
+
"actor": null,
|
|
1160
|
+
"deprecated": false,
|
|
1161
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/scheduled-posts",
|
|
1162
|
+
"idempotent": false,
|
|
1163
|
+
"method": "list",
|
|
1164
|
+
"paginated": true,
|
|
1165
|
+
"params": "Social.ActorScheduledPostListParams",
|
|
1166
|
+
"poll": null,
|
|
1167
|
+
"public": false,
|
|
1168
|
+
"resource": "actors.scheduledPosts",
|
|
1169
|
+
"scope": "community",
|
|
1170
|
+
"signature": "social.community(…).actors.scheduledPosts.list(actorId, params?, options?): PagePromise<Social.Post>",
|
|
1171
|
+
"snippet": "for await (const scheduledPost of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.scheduledPosts.list(\"actor\")) {\n console.log(scheduledPost);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.scheduledPosts.list(\"actor\", {}, { timeout: 5_000 });"
|
|
1172
|
+
},
|
|
1173
|
+
"EdgeController_approveFollowRequest": {
|
|
1174
|
+
"actor": null,
|
|
1175
|
+
"deprecated": false,
|
|
1176
|
+
"http": "POST /v1/communities/{community_id}/follow-requests/{dst_actor_id}/{src_actor_id}/approve",
|
|
1177
|
+
"idempotent": false,
|
|
1178
|
+
"method": "approve",
|
|
1179
|
+
"paginated": false,
|
|
1180
|
+
"params": null,
|
|
1181
|
+
"poll": null,
|
|
1182
|
+
"public": false,
|
|
1183
|
+
"resource": "followRequests",
|
|
1184
|
+
"scope": "community",
|
|
1185
|
+
"signature": "social.community(…).followRequests.approve(dstActorId, srcActorId, options?): Social.CreateEdge",
|
|
1186
|
+
"snippet": "const createEdge = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").followRequests.approve(\"dst_actor\", \"src_actor\");"
|
|
1187
|
+
},
|
|
1188
|
+
"EdgeController_batchFollows": {
|
|
1189
|
+
"actor": null,
|
|
1190
|
+
"deprecated": false,
|
|
1191
|
+
"http": "POST /v1/communities/{community_id}/follows/batch",
|
|
1192
|
+
"idempotent": false,
|
|
1193
|
+
"method": "batch",
|
|
1194
|
+
"paginated": false,
|
|
1195
|
+
"params": "Social.FollowBatchParams",
|
|
1196
|
+
"poll": null,
|
|
1197
|
+
"public": false,
|
|
1198
|
+
"resource": "follows",
|
|
1199
|
+
"scope": "community",
|
|
1200
|
+
"signature": "social.community(…).follows.batch(params, options?): Social.BatchFollows",
|
|
1201
|
+
"snippet": "const batchFollows = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").follows.batch({\n follows: [\n {\n actor_id: \"aaaaaaaa-0000-0000-0000-000000000001\",\n dst_actor_id: \"aaaaaaaa-0000-0000-0000-000000000002\",\n },\n ],\n});"
|
|
1202
|
+
},
|
|
1203
|
+
"EdgeController_block": {
|
|
1204
|
+
"actor": "body",
|
|
1205
|
+
"deprecated": false,
|
|
1206
|
+
"http": "POST /v1/communities/{community_id}/blocks",
|
|
1207
|
+
"idempotent": true,
|
|
1208
|
+
"method": "create",
|
|
1209
|
+
"paginated": false,
|
|
1210
|
+
"params": "Social.BlockCreateParams",
|
|
1211
|
+
"poll": null,
|
|
1212
|
+
"public": false,
|
|
1213
|
+
"resource": "blocks",
|
|
1214
|
+
"scope": "community",
|
|
1215
|
+
"signature": "social.community(…).blocks.create(params, options?): Social.CreateEdge",
|
|
1216
|
+
"snippet": "const createEdge = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").blocks.create({ dst_actor_id: \"aaaaaaaa-0000-0000-0000-000000000002\" });"
|
|
1217
|
+
},
|
|
1218
|
+
"EdgeController_declineFollowRequest": {
|
|
1219
|
+
"actor": null,
|
|
1220
|
+
"deprecated": false,
|
|
1221
|
+
"http": "DELETE /v1/communities/{community_id}/follow-requests/{dst_actor_id}/{src_actor_id}",
|
|
1222
|
+
"idempotent": false,
|
|
1223
|
+
"method": "delete",
|
|
1224
|
+
"paginated": false,
|
|
1225
|
+
"params": null,
|
|
1226
|
+
"poll": null,
|
|
1227
|
+
"public": false,
|
|
1228
|
+
"resource": "followRequests",
|
|
1229
|
+
"scope": "community",
|
|
1230
|
+
"signature": "social.community(…).followRequests.delete(dstActorId, srcActorId, options?): void",
|
|
1231
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").followRequests.delete(\"dst_actor\", \"src_actor\");"
|
|
1232
|
+
},
|
|
1233
|
+
"EdgeController_dismissSuggestion": {
|
|
1234
|
+
"actor": "body",
|
|
1235
|
+
"deprecated": false,
|
|
1236
|
+
"http": "POST /v1/communities/{community_id}/dismissed-suggestions",
|
|
1237
|
+
"idempotent": true,
|
|
1238
|
+
"method": "create",
|
|
1239
|
+
"paginated": false,
|
|
1240
|
+
"params": "Social.DismissedSuggestionCreateParams",
|
|
1241
|
+
"poll": null,
|
|
1242
|
+
"public": false,
|
|
1243
|
+
"resource": "dismissedSuggestions",
|
|
1244
|
+
"scope": "community",
|
|
1245
|
+
"signature": "social.community(…).dismissedSuggestions.create(params, options?): Social.CreateEdge",
|
|
1246
|
+
"snippet": "const createEdge = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").dismissedSuggestions.create({ dst_actor_id: \"aaaaaaaa-0000-0000-0000-000000000002\" });"
|
|
1247
|
+
},
|
|
1248
|
+
"EdgeController_follow": {
|
|
1249
|
+
"actor": "body",
|
|
1250
|
+
"deprecated": false,
|
|
1251
|
+
"http": "POST /v1/communities/{community_id}/follows",
|
|
1252
|
+
"idempotent": true,
|
|
1253
|
+
"method": "create",
|
|
1254
|
+
"paginated": false,
|
|
1255
|
+
"params": "Social.FollowCreateParams",
|
|
1256
|
+
"poll": null,
|
|
1257
|
+
"public": false,
|
|
1258
|
+
"resource": "follows",
|
|
1259
|
+
"scope": "community",
|
|
1260
|
+
"signature": "social.community(…).follows.create(params, options?): Social.FollowResult",
|
|
1261
|
+
"snippet": "const followResult = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").follows.create({ dst_actor_id: \"aaaaaaaa-0000-0000-0000-000000000002\" });"
|
|
1262
|
+
},
|
|
1263
|
+
"EdgeController_hidePost": {
|
|
1264
|
+
"actor": "body",
|
|
1265
|
+
"deprecated": false,
|
|
1266
|
+
"http": "POST /v1/communities/{community_id}/hides",
|
|
1267
|
+
"idempotent": true,
|
|
1268
|
+
"method": "create",
|
|
1269
|
+
"paginated": false,
|
|
1270
|
+
"params": "Social.HideCreateParams",
|
|
1271
|
+
"poll": null,
|
|
1272
|
+
"public": false,
|
|
1273
|
+
"resource": "hides",
|
|
1274
|
+
"scope": "community",
|
|
1275
|
+
"signature": "social.community(…).hides.create(params, options?): Social.HideResult",
|
|
1276
|
+
"snippet": "const hideResult = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").hides.create({ post_id: \"bbbbbbbb-0000-0000-0000-000000000001\" });"
|
|
1277
|
+
},
|
|
1278
|
+
"EdgeController_listBlocks": {
|
|
1279
|
+
"actor": null,
|
|
1280
|
+
"deprecated": false,
|
|
1281
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/blocks",
|
|
1282
|
+
"idempotent": false,
|
|
1283
|
+
"method": "list",
|
|
1284
|
+
"paginated": true,
|
|
1285
|
+
"params": "Social.ActorBlockListParams",
|
|
1286
|
+
"poll": null,
|
|
1287
|
+
"public": false,
|
|
1288
|
+
"resource": "actors.blocks",
|
|
1289
|
+
"scope": "community",
|
|
1290
|
+
"signature": "social.community(…).actors.blocks.list(actorId, params?, options?): PagePromise<Social.OutboundEdge>",
|
|
1291
|
+
"snippet": "for await (const block of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.blocks.list(\"actor\")) {\n console.log(block);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.blocks.list(\"actor\", {}, { timeout: 5_000 });"
|
|
1292
|
+
},
|
|
1293
|
+
"EdgeController_listDismissedSuggestions": {
|
|
1294
|
+
"actor": null,
|
|
1295
|
+
"deprecated": false,
|
|
1296
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/dismissed-suggestions",
|
|
1297
|
+
"idempotent": false,
|
|
1298
|
+
"method": "list",
|
|
1299
|
+
"paginated": true,
|
|
1300
|
+
"params": "Social.ActorDismissedSuggestionListParams",
|
|
1301
|
+
"poll": null,
|
|
1302
|
+
"public": false,
|
|
1303
|
+
"resource": "actors.dismissedSuggestions",
|
|
1304
|
+
"scope": "community",
|
|
1305
|
+
"signature": "social.community(…).actors.dismissedSuggestions.list(actorId, params?, options?): PagePromise<Social.OutboundEdge>",
|
|
1306
|
+
"snippet": "for await (const dismissedSuggestion of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.dismissedSuggestions.list(\"actor\")) {\n console.log(dismissedSuggestion);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.dismissedSuggestions.list(\"actor\", {}, { timeout: 5_000 });"
|
|
1307
|
+
},
|
|
1308
|
+
"EdgeController_listFollowers": {
|
|
1309
|
+
"actor": null,
|
|
1310
|
+
"deprecated": false,
|
|
1311
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/followers",
|
|
1312
|
+
"idempotent": false,
|
|
1313
|
+
"method": "list",
|
|
1314
|
+
"paginated": true,
|
|
1315
|
+
"params": "Social.ActorFollowerListParams",
|
|
1316
|
+
"poll": null,
|
|
1317
|
+
"public": false,
|
|
1318
|
+
"resource": "actors.followers",
|
|
1319
|
+
"scope": "community",
|
|
1320
|
+
"signature": "social.community(…).actors.followers.list(actorId, params?, options?): PagePromise<Social.FollowerEdge>",
|
|
1321
|
+
"snippet": "for await (const follower of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.followers.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\")) {\n console.log(follower);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.followers.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", {}, { timeout: 5_000 });"
|
|
1322
|
+
},
|
|
1323
|
+
"EdgeController_listFollowing": {
|
|
1324
|
+
"actor": null,
|
|
1325
|
+
"deprecated": false,
|
|
1326
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/following",
|
|
1327
|
+
"idempotent": false,
|
|
1328
|
+
"method": "list",
|
|
1329
|
+
"paginated": true,
|
|
1330
|
+
"params": "Social.ActorFollowingListParams",
|
|
1331
|
+
"poll": null,
|
|
1332
|
+
"public": false,
|
|
1333
|
+
"resource": "actors.following",
|
|
1334
|
+
"scope": "community",
|
|
1335
|
+
"signature": "social.community(…).actors.following.list(actorId, params?, options?): PagePromise<Social.OutboundEdge>",
|
|
1336
|
+
"snippet": "for await (const following of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.following.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\")) {\n console.log(following);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.following.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", {}, { timeout: 5_000 });"
|
|
1337
|
+
},
|
|
1338
|
+
"EdgeController_listHides": {
|
|
1339
|
+
"actor": null,
|
|
1340
|
+
"deprecated": false,
|
|
1341
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/hides",
|
|
1342
|
+
"idempotent": false,
|
|
1343
|
+
"method": "list",
|
|
1344
|
+
"paginated": true,
|
|
1345
|
+
"params": "Social.ActorHideListParams",
|
|
1346
|
+
"poll": null,
|
|
1347
|
+
"public": false,
|
|
1348
|
+
"resource": "actors.hides",
|
|
1349
|
+
"scope": "community",
|
|
1350
|
+
"signature": "social.community(…).actors.hides.list(actorId, params?, options?): PagePromise<Social.HideEntry>",
|
|
1351
|
+
"snippet": "for await (const hide of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.hides.list(\"actor\")) {\n console.log(hide);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.hides.list(\"actor\", {}, { timeout: 5_000 });"
|
|
1352
|
+
},
|
|
1353
|
+
"EdgeController_listIncomingRequests": {
|
|
1354
|
+
"actor": null,
|
|
1355
|
+
"deprecated": false,
|
|
1356
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/follow-requests",
|
|
1357
|
+
"idempotent": false,
|
|
1358
|
+
"method": "list",
|
|
1359
|
+
"paginated": true,
|
|
1360
|
+
"params": "Social.ActorFollowRequestListParams",
|
|
1361
|
+
"poll": null,
|
|
1362
|
+
"public": false,
|
|
1363
|
+
"resource": "actors.followRequests",
|
|
1364
|
+
"scope": "community",
|
|
1365
|
+
"signature": "social.community(…).actors.followRequests.list(actorId, params?, options?): PagePromise<Social.FollowRequestEntry>",
|
|
1366
|
+
"snippet": "for await (const followRequest of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.followRequests.list(\"actor\")) {\n console.log(followRequest);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.followRequests.list(\"actor\", {}, { timeout: 5_000 });"
|
|
1367
|
+
},
|
|
1368
|
+
"EdgeController_listMutes": {
|
|
1369
|
+
"actor": null,
|
|
1370
|
+
"deprecated": false,
|
|
1371
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/mutes",
|
|
1372
|
+
"idempotent": false,
|
|
1373
|
+
"method": "list",
|
|
1374
|
+
"paginated": true,
|
|
1375
|
+
"params": "Social.ActorMuteListParams",
|
|
1376
|
+
"poll": null,
|
|
1377
|
+
"public": false,
|
|
1378
|
+
"resource": "actors.mutes",
|
|
1379
|
+
"scope": "community",
|
|
1380
|
+
"signature": "social.community(…).actors.mutes.list(actorId, params?, options?): PagePromise<Social.OutboundEdge>",
|
|
1381
|
+
"snippet": "for await (const mute of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.mutes.list(\"actor\")) {\n console.log(mute);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.mutes.list(\"actor\", {}, { timeout: 5_000 });"
|
|
1382
|
+
},
|
|
1383
|
+
"EdgeController_listRestricts": {
|
|
1384
|
+
"actor": null,
|
|
1385
|
+
"deprecated": false,
|
|
1386
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/restricts",
|
|
1387
|
+
"idempotent": false,
|
|
1388
|
+
"method": "list",
|
|
1389
|
+
"paginated": true,
|
|
1390
|
+
"params": "Social.ActorRestrictListParams",
|
|
1391
|
+
"poll": null,
|
|
1392
|
+
"public": false,
|
|
1393
|
+
"resource": "actors.restricts",
|
|
1394
|
+
"scope": "community",
|
|
1395
|
+
"signature": "social.community(…).actors.restricts.list(actorId, params?, options?): PagePromise<Social.OutboundEdge>",
|
|
1396
|
+
"snippet": "for await (const restrict of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.restricts.list(\"actor\")) {\n console.log(restrict);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.restricts.list(\"actor\", {}, { timeout: 5_000 });"
|
|
1397
|
+
},
|
|
1398
|
+
"EdgeController_mute": {
|
|
1399
|
+
"actor": "body",
|
|
1400
|
+
"deprecated": false,
|
|
1401
|
+
"http": "POST /v1/communities/{community_id}/mutes",
|
|
1402
|
+
"idempotent": true,
|
|
1403
|
+
"method": "create",
|
|
1404
|
+
"paginated": false,
|
|
1405
|
+
"params": "Social.MuteCreateParams",
|
|
1406
|
+
"poll": null,
|
|
1407
|
+
"public": false,
|
|
1408
|
+
"resource": "mutes",
|
|
1409
|
+
"scope": "community",
|
|
1410
|
+
"signature": "social.community(…).mutes.create(params, options?): Social.CreateEdge",
|
|
1411
|
+
"snippet": "const createEdge = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").mutes.create({ dst_actor_id: \"aaaaaaaa-0000-0000-0000-000000000002\" });"
|
|
1412
|
+
},
|
|
1413
|
+
"EdgeController_relationships": {
|
|
1414
|
+
"actor": null,
|
|
1415
|
+
"deprecated": false,
|
|
1416
|
+
"http": "GET /v1/communities/{community_id}/actors/{src_actor_id}/relationships",
|
|
1417
|
+
"idempotent": false,
|
|
1418
|
+
"method": "list",
|
|
1419
|
+
"paginated": false,
|
|
1420
|
+
"params": "Social.ActorRelationshipListParams",
|
|
1421
|
+
"poll": null,
|
|
1422
|
+
"public": false,
|
|
1423
|
+
"resource": "actors.relationships",
|
|
1424
|
+
"scope": "community",
|
|
1425
|
+
"signature": "social.community(…).actors.relationships.list(srcActorId, params, options?): Social.RelationshipList",
|
|
1426
|
+
"snippet": "const relationshipList = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.relationships.list(\"aaaaaaaa-0000-0000-0000-000000000001\", { with: \"string\" });"
|
|
1427
|
+
},
|
|
1428
|
+
"EdgeController_restrict": {
|
|
1429
|
+
"actor": "body",
|
|
1430
|
+
"deprecated": false,
|
|
1431
|
+
"http": "POST /v1/communities/{community_id}/restricts",
|
|
1432
|
+
"idempotent": true,
|
|
1433
|
+
"method": "create",
|
|
1434
|
+
"paginated": false,
|
|
1435
|
+
"params": "Social.RestrictCreateParams",
|
|
1436
|
+
"poll": null,
|
|
1437
|
+
"public": false,
|
|
1438
|
+
"resource": "restricts",
|
|
1439
|
+
"scope": "community",
|
|
1440
|
+
"signature": "social.community(…).restricts.create(params, options?): Social.CreateEdge",
|
|
1441
|
+
"snippet": "const createEdge = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").restricts.create({ dst_actor_id: \"aaaaaaaa-0000-0000-0000-000000000002\" });"
|
|
1442
|
+
},
|
|
1443
|
+
"EdgeController_unblock": {
|
|
1444
|
+
"actor": null,
|
|
1445
|
+
"deprecated": false,
|
|
1446
|
+
"http": "DELETE /v1/communities/{community_id}/blocks/{src_actor_id}/{dst_actor_id}",
|
|
1447
|
+
"idempotent": false,
|
|
1448
|
+
"method": "delete",
|
|
1449
|
+
"paginated": false,
|
|
1450
|
+
"params": null,
|
|
1451
|
+
"poll": null,
|
|
1452
|
+
"public": false,
|
|
1453
|
+
"resource": "blocks",
|
|
1454
|
+
"scope": "community",
|
|
1455
|
+
"signature": "social.community(…).blocks.delete(srcActorId, dstActorId, options?): void",
|
|
1456
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").blocks.delete(\"src_actor\", \"dst_actor\");"
|
|
1457
|
+
},
|
|
1458
|
+
"EdgeController_undismissSuggestion": {
|
|
1459
|
+
"actor": null,
|
|
1460
|
+
"deprecated": false,
|
|
1461
|
+
"http": "DELETE /v1/communities/{community_id}/dismissed-suggestions/{src_actor_id}/{dst_actor_id}",
|
|
1462
|
+
"idempotent": false,
|
|
1463
|
+
"method": "delete",
|
|
1464
|
+
"paginated": false,
|
|
1465
|
+
"params": null,
|
|
1466
|
+
"poll": null,
|
|
1467
|
+
"public": false,
|
|
1468
|
+
"resource": "dismissedSuggestions",
|
|
1469
|
+
"scope": "community",
|
|
1470
|
+
"signature": "social.community(…).dismissedSuggestions.delete(srcActorId, dstActorId, options?): void",
|
|
1471
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").dismissedSuggestions.delete(\"src_actor\", \"dst_actor\");"
|
|
1472
|
+
},
|
|
1473
|
+
"EdgeController_unfollow": {
|
|
1474
|
+
"actor": null,
|
|
1475
|
+
"deprecated": false,
|
|
1476
|
+
"http": "DELETE /v1/communities/{community_id}/follows/{src_actor_id}/{dst_actor_id}",
|
|
1477
|
+
"idempotent": false,
|
|
1478
|
+
"method": "delete",
|
|
1479
|
+
"paginated": false,
|
|
1480
|
+
"params": null,
|
|
1481
|
+
"poll": null,
|
|
1482
|
+
"public": false,
|
|
1483
|
+
"resource": "follows",
|
|
1484
|
+
"scope": "community",
|
|
1485
|
+
"signature": "social.community(…).follows.delete(srcActorId, dstActorId, options?): void",
|
|
1486
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").follows.delete(\"aaaaaaaa-0000-0000-0000-000000000001\", \"aaaaaaaa-0000-0000-0000-000000000002\");"
|
|
1487
|
+
},
|
|
1488
|
+
"EdgeController_unhidePost": {
|
|
1489
|
+
"actor": null,
|
|
1490
|
+
"deprecated": false,
|
|
1491
|
+
"http": "DELETE /v1/communities/{community_id}/hides/{src_actor_id}/{post_id}",
|
|
1492
|
+
"idempotent": false,
|
|
1493
|
+
"method": "delete",
|
|
1494
|
+
"paginated": false,
|
|
1495
|
+
"params": null,
|
|
1496
|
+
"poll": null,
|
|
1497
|
+
"public": false,
|
|
1498
|
+
"resource": "hides",
|
|
1499
|
+
"scope": "community",
|
|
1500
|
+
"signature": "social.community(…).hides.delete(srcActorId, postId, options?): void",
|
|
1501
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").hides.delete(\"src_actor\", \"post\");"
|
|
1502
|
+
},
|
|
1503
|
+
"EdgeController_unmute": {
|
|
1504
|
+
"actor": null,
|
|
1505
|
+
"deprecated": false,
|
|
1506
|
+
"http": "DELETE /v1/communities/{community_id}/mutes/{src_actor_id}/{dst_actor_id}",
|
|
1507
|
+
"idempotent": false,
|
|
1508
|
+
"method": "delete",
|
|
1509
|
+
"paginated": false,
|
|
1510
|
+
"params": null,
|
|
1511
|
+
"poll": null,
|
|
1512
|
+
"public": false,
|
|
1513
|
+
"resource": "mutes",
|
|
1514
|
+
"scope": "community",
|
|
1515
|
+
"signature": "social.community(…).mutes.delete(srcActorId, dstActorId, options?): void",
|
|
1516
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").mutes.delete(\"src_actor\", \"dst_actor\");"
|
|
1517
|
+
},
|
|
1518
|
+
"EdgeController_unrestrict": {
|
|
1519
|
+
"actor": null,
|
|
1520
|
+
"deprecated": false,
|
|
1521
|
+
"http": "DELETE /v1/communities/{community_id}/restricts/{src_actor_id}/{dst_actor_id}",
|
|
1522
|
+
"idempotent": false,
|
|
1523
|
+
"method": "delete",
|
|
1524
|
+
"paginated": false,
|
|
1525
|
+
"params": null,
|
|
1526
|
+
"poll": null,
|
|
1527
|
+
"public": false,
|
|
1528
|
+
"resource": "restricts",
|
|
1529
|
+
"scope": "community",
|
|
1530
|
+
"signature": "social.community(…).restricts.delete(srcActorId, dstActorId, options?): void",
|
|
1531
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").restricts.delete(\"src_actor\", \"dst_actor\");"
|
|
1532
|
+
},
|
|
1533
|
+
"ExportController_comments": {
|
|
1534
|
+
"actor": null,
|
|
1535
|
+
"deprecated": false,
|
|
1536
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/actors/{actor_id}/comments",
|
|
1537
|
+
"idempotent": false,
|
|
1538
|
+
"method": "list",
|
|
1539
|
+
"paginated": true,
|
|
1540
|
+
"params": "Social.CommunityActorCommentListParams",
|
|
1541
|
+
"poll": null,
|
|
1542
|
+
"public": false,
|
|
1543
|
+
"resource": "communities.actors.comments",
|
|
1544
|
+
"scope": null,
|
|
1545
|
+
"signature": "social.communities.actors.comments.list(communityId, actorId, params?, options?): PagePromise<Social.Comment>",
|
|
1546
|
+
"snippet": "for await (const comment of social.communities.actors.comments.list(\"cccccccc-cccc-cccc-cccc-cccccccccccc\", \"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(comment);\n}\nconst page = await social.communities.actors.comments.list(\"cccccccc-cccc-cccc-cccc-cccccccccccc\", \"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
1547
|
+
},
|
|
1548
|
+
"ExportController_reactions": {
|
|
1549
|
+
"actor": null,
|
|
1550
|
+
"deprecated": false,
|
|
1551
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/actors/{actor_id}/reactions",
|
|
1552
|
+
"idempotent": false,
|
|
1553
|
+
"method": "list",
|
|
1554
|
+
"paginated": true,
|
|
1555
|
+
"params": "Social.CommunityActorReactionListParams",
|
|
1556
|
+
"poll": null,
|
|
1557
|
+
"public": false,
|
|
1558
|
+
"resource": "communities.actors.reactions",
|
|
1559
|
+
"scope": null,
|
|
1560
|
+
"signature": "social.communities.actors.reactions.list(communityId, actorId, params?, options?): PagePromise<Social.ActorReactionEntry>",
|
|
1561
|
+
"snippet": "for await (const reaction of social.communities.actors.reactions.list(\"cccccccc-cccc-cccc-cccc-cccccccccccc\", \"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(reaction);\n}\nconst page = await social.communities.actors.reactions.list(\"cccccccc-cccc-cccc-cccc-cccccccccccc\", \"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
1562
|
+
},
|
|
1563
|
+
"FeedController_getDiscoverFeed": {
|
|
1564
|
+
"actor": "query",
|
|
1565
|
+
"deprecated": false,
|
|
1566
|
+
"http": "GET /v1/communities/{community_id}/discover-feed",
|
|
1567
|
+
"idempotent": false,
|
|
1568
|
+
"method": "list",
|
|
1569
|
+
"paginated": true,
|
|
1570
|
+
"params": "Social.DiscoverFeedListParams",
|
|
1571
|
+
"poll": null,
|
|
1572
|
+
"public": false,
|
|
1573
|
+
"resource": "discoverFeed",
|
|
1574
|
+
"scope": "community",
|
|
1575
|
+
"signature": "social.community(…).discoverFeed.list(params?, options?): PagePromise<Social.Post>",
|
|
1576
|
+
"snippet": "for await (const discoverFeed of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").discoverFeed.list()) {\n console.log(discoverFeed);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").discoverFeed.list({}, { timeout: 5_000 });"
|
|
1577
|
+
},
|
|
1578
|
+
"FeedController_getFeed": {
|
|
1579
|
+
"actor": null,
|
|
1580
|
+
"deprecated": false,
|
|
1581
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/feed",
|
|
1582
|
+
"idempotent": false,
|
|
1583
|
+
"method": "list",
|
|
1584
|
+
"paginated": true,
|
|
1585
|
+
"params": "Social.ActorFeedListParams",
|
|
1586
|
+
"poll": null,
|
|
1587
|
+
"public": false,
|
|
1588
|
+
"resource": "actors.feed",
|
|
1589
|
+
"scope": "community",
|
|
1590
|
+
"signature": "social.community(…).actors.feed.list(actorId, params?, options?): PagePromise<Social.Post>",
|
|
1591
|
+
"snippet": "for await (const feed of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.feed.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\")) {\n console.log(feed);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.feed.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", {}, { timeout: 5_000 });"
|
|
1592
|
+
},
|
|
1593
|
+
"FeedController_getListFeed": {
|
|
1594
|
+
"actor": "query",
|
|
1595
|
+
"deprecated": false,
|
|
1596
|
+
"http": "GET /v1/communities/{community_id}/lists/{list_id}/feed",
|
|
1597
|
+
"idempotent": false,
|
|
1598
|
+
"method": "list",
|
|
1599
|
+
"paginated": true,
|
|
1600
|
+
"params": "Social.ListFeedListParams",
|
|
1601
|
+
"poll": null,
|
|
1602
|
+
"public": false,
|
|
1603
|
+
"resource": "lists.feed",
|
|
1604
|
+
"scope": "community",
|
|
1605
|
+
"signature": "social.community(…).lists.feed.list(listId, params, options?): PagePromise<Social.Post>",
|
|
1606
|
+
"snippet": "for await (const feed of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").lists.feed.list(\"list\", {})) {\n console.log(feed);\n}"
|
|
1607
|
+
},
|
|
1608
|
+
"FlagController_create": {
|
|
1609
|
+
"actor": "body",
|
|
1610
|
+
"deprecated": false,
|
|
1611
|
+
"http": "POST /v1/communities/{community_id}/flags",
|
|
1612
|
+
"idempotent": true,
|
|
1613
|
+
"method": "create",
|
|
1614
|
+
"paginated": false,
|
|
1615
|
+
"params": "Social.FlagCreateParams",
|
|
1616
|
+
"poll": null,
|
|
1617
|
+
"public": false,
|
|
1618
|
+
"resource": "flags",
|
|
1619
|
+
"scope": "community",
|
|
1620
|
+
"signature": "social.community(…).flags.create(params, options?): Social.CreateFlag",
|
|
1621
|
+
"snippet": "const createFlag = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").flags.create({ target_id: \"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", target_kind: \"post\" });"
|
|
1622
|
+
},
|
|
1623
|
+
"FlagController_listMine": {
|
|
1624
|
+
"actor": "query",
|
|
1625
|
+
"deprecated": false,
|
|
1626
|
+
"http": "GET /v1/communities/{community_id}/flags",
|
|
1627
|
+
"idempotent": false,
|
|
1628
|
+
"method": "list",
|
|
1629
|
+
"paginated": true,
|
|
1630
|
+
"params": "Social.FlagListParams",
|
|
1631
|
+
"poll": null,
|
|
1632
|
+
"public": false,
|
|
1633
|
+
"resource": "flags",
|
|
1634
|
+
"scope": "community",
|
|
1635
|
+
"signature": "social.community(…).flags.list(params?, options?): PagePromise<Social.Flag>",
|
|
1636
|
+
"snippet": "for await (const flag of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").flags.list()) {\n console.log(flag);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").flags.list({}, { timeout: 5_000 });"
|
|
1637
|
+
},
|
|
1638
|
+
"HashtagController_autocomplete": {
|
|
1639
|
+
"actor": null,
|
|
1640
|
+
"deprecated": false,
|
|
1641
|
+
"http": "GET /v1/communities/{community_id}/search/hashtags",
|
|
1642
|
+
"idempotent": false,
|
|
1643
|
+
"method": "list",
|
|
1644
|
+
"paginated": true,
|
|
1645
|
+
"params": "Social.SearchHashtagListParams",
|
|
1646
|
+
"poll": null,
|
|
1647
|
+
"public": false,
|
|
1648
|
+
"resource": "search.hashtags",
|
|
1649
|
+
"scope": "community",
|
|
1650
|
+
"signature": "social.community(…).search.hashtags.list(params, options?): PagePromise<Social.Hashtag>",
|
|
1651
|
+
"snippet": "for await (const hashtag of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").search.hashtags.list({ q: \"string\" })) {\n console.log(hashtag);\n}"
|
|
1652
|
+
},
|
|
1653
|
+
"HashtagController_getOne": {
|
|
1654
|
+
"actor": null,
|
|
1655
|
+
"deprecated": false,
|
|
1656
|
+
"http": "GET /v1/communities/{community_id}/hashtags/{tag}",
|
|
1657
|
+
"idempotent": false,
|
|
1658
|
+
"method": "retrieve",
|
|
1659
|
+
"paginated": false,
|
|
1660
|
+
"params": null,
|
|
1661
|
+
"poll": null,
|
|
1662
|
+
"public": false,
|
|
1663
|
+
"resource": "hashtags",
|
|
1664
|
+
"scope": "community",
|
|
1665
|
+
"signature": "social.community(…).hashtags.retrieve(tag, options?): Social.HashtagDetail",
|
|
1666
|
+
"snippet": "const hashtagDetail = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").hashtags.retrieve(\"storymode\");"
|
|
1667
|
+
},
|
|
1668
|
+
"HashtagController_list": {
|
|
1669
|
+
"actor": null,
|
|
1670
|
+
"deprecated": false,
|
|
1671
|
+
"http": "GET /v1/communities/{community_id}/hashtags",
|
|
1672
|
+
"idempotent": false,
|
|
1673
|
+
"method": "list",
|
|
1674
|
+
"paginated": true,
|
|
1675
|
+
"params": "Social.HashtagListParams",
|
|
1676
|
+
"poll": null,
|
|
1677
|
+
"public": false,
|
|
1678
|
+
"resource": "hashtags",
|
|
1679
|
+
"scope": "community",
|
|
1680
|
+
"signature": "social.community(…).hashtags.list(params?, options?): PagePromise<Social.Hashtag>",
|
|
1681
|
+
"snippet": "for await (const hashtag of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").hashtags.list()) {\n console.log(hashtag);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").hashtags.list({}, { timeout: 5_000 });"
|
|
1682
|
+
},
|
|
1683
|
+
"HashtagFeedController_list": {
|
|
1684
|
+
"actor": null,
|
|
1685
|
+
"deprecated": false,
|
|
1686
|
+
"http": "GET /v1/communities/{community_id}/hashtags/{tag}/posts",
|
|
1687
|
+
"idempotent": false,
|
|
1688
|
+
"method": "list",
|
|
1689
|
+
"paginated": true,
|
|
1690
|
+
"params": "Social.HashtagPostListParams",
|
|
1691
|
+
"poll": null,
|
|
1692
|
+
"public": false,
|
|
1693
|
+
"resource": "hashtags.posts",
|
|
1694
|
+
"scope": "community",
|
|
1695
|
+
"signature": "social.community(…).hashtags.posts.list(tag, params?, options?): PagePromise<Social.Post>",
|
|
1696
|
+
"snippet": "for await (const post of social.community(\"community\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").hashtags.posts.list(\"tag\")) {\n console.log(post);\n}\nconst page = await social.community(\"community\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").hashtags.posts.list(\"tag\", {}, { timeout: 5_000 });"
|
|
1697
|
+
},
|
|
1698
|
+
"HashtagFollowController_follow": {
|
|
1699
|
+
"actor": null,
|
|
1700
|
+
"deprecated": false,
|
|
1701
|
+
"http": "POST /v1/communities/{community_id}/actors/{actor_id}/hashtag-follows",
|
|
1702
|
+
"idempotent": true,
|
|
1703
|
+
"method": "create",
|
|
1704
|
+
"paginated": false,
|
|
1705
|
+
"params": "Social.ActorHashtagFollowCreateParams",
|
|
1706
|
+
"poll": null,
|
|
1707
|
+
"public": false,
|
|
1708
|
+
"resource": "actors.hashtagFollows",
|
|
1709
|
+
"scope": "community",
|
|
1710
|
+
"signature": "social.community(…).actors.hashtagFollows.create(actorId, params, options?): Social.HashtagFollow",
|
|
1711
|
+
"snippet": "const hashtagFollow = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.hashtagFollows.create(\"aaaaaaaa-0000-0000-0000-000000000001\", { tag: \"storymode\" });"
|
|
1712
|
+
},
|
|
1713
|
+
"HashtagFollowController_list": {
|
|
1714
|
+
"actor": null,
|
|
1715
|
+
"deprecated": false,
|
|
1716
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/hashtag-follows",
|
|
1717
|
+
"idempotent": false,
|
|
1718
|
+
"method": "list",
|
|
1719
|
+
"paginated": true,
|
|
1720
|
+
"params": "Social.ActorHashtagFollowListParams",
|
|
1721
|
+
"poll": null,
|
|
1722
|
+
"public": false,
|
|
1723
|
+
"resource": "actors.hashtagFollows",
|
|
1724
|
+
"scope": "community",
|
|
1725
|
+
"signature": "social.community(…).actors.hashtagFollows.list(actorId, params?, options?): PagePromise<Social.HashtagFollow>",
|
|
1726
|
+
"snippet": "for await (const hashtagFollow of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.hashtagFollows.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(hashtagFollow);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.hashtagFollows.list(\"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
1727
|
+
},
|
|
1728
|
+
"HashtagFollowController_unfollow": {
|
|
1729
|
+
"actor": null,
|
|
1730
|
+
"deprecated": false,
|
|
1731
|
+
"http": "DELETE /v1/communities/{community_id}/actors/{actor_id}/hashtag-follows/{tag}",
|
|
1732
|
+
"idempotent": false,
|
|
1733
|
+
"method": "delete",
|
|
1734
|
+
"paginated": false,
|
|
1735
|
+
"params": null,
|
|
1736
|
+
"poll": null,
|
|
1737
|
+
"public": false,
|
|
1738
|
+
"resource": "actors.hashtagFollows",
|
|
1739
|
+
"scope": "community",
|
|
1740
|
+
"signature": "social.community(…).actors.hashtagFollows.delete(actorId, tag, options?): void",
|
|
1741
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.hashtagFollows.delete(\"aaaaaaaa-0000-0000-0000-000000000001\", \"storymode\");"
|
|
1742
|
+
},
|
|
1743
|
+
"InsightsController_actorInsights": {
|
|
1744
|
+
"actor": null,
|
|
1745
|
+
"deprecated": false,
|
|
1746
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/insights",
|
|
1747
|
+
"idempotent": false,
|
|
1748
|
+
"method": "insights",
|
|
1749
|
+
"paginated": false,
|
|
1750
|
+
"params": "Social.ActorInsightsParams",
|
|
1751
|
+
"poll": null,
|
|
1752
|
+
"public": false,
|
|
1753
|
+
"resource": "actors",
|
|
1754
|
+
"scope": "community",
|
|
1755
|
+
"signature": "social.community(…).actors.insights(actorId, params?, options?): Social.ActorInsights",
|
|
1756
|
+
"snippet": "const actorInsights = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.insights(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1757
|
+
},
|
|
1758
|
+
"InsightsController_postInsights": {
|
|
1759
|
+
"actor": null,
|
|
1760
|
+
"deprecated": false,
|
|
1761
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/insights",
|
|
1762
|
+
"idempotent": false,
|
|
1763
|
+
"method": "insights",
|
|
1764
|
+
"paginated": false,
|
|
1765
|
+
"params": "Social.PostInsightsParams",
|
|
1766
|
+
"poll": null,
|
|
1767
|
+
"public": false,
|
|
1768
|
+
"resource": "posts",
|
|
1769
|
+
"scope": "community",
|
|
1770
|
+
"signature": "social.community(…).posts.insights(postId, params?, options?): Social.PostInsights",
|
|
1771
|
+
"snippet": "const postInsights = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.insights(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
1772
|
+
},
|
|
1773
|
+
"MentionController_list": {
|
|
1774
|
+
"actor": null,
|
|
1775
|
+
"deprecated": false,
|
|
1776
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/mentions",
|
|
1777
|
+
"idempotent": false,
|
|
1778
|
+
"method": "list",
|
|
1779
|
+
"paginated": true,
|
|
1780
|
+
"params": "Social.ActorMentionListParams",
|
|
1781
|
+
"poll": null,
|
|
1782
|
+
"public": false,
|
|
1783
|
+
"resource": "actors.mentions",
|
|
1784
|
+
"scope": "community",
|
|
1785
|
+
"signature": "social.community(…).actors.mentions.list(actorId, params?, options?): PagePromise<Social.MentionEntry>",
|
|
1786
|
+
"snippet": "for await (const mention of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.mentions.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(mention);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.mentions.list(\"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
1787
|
+
},
|
|
1788
|
+
"ModerationAdminController_act": {
|
|
1789
|
+
"actor": null,
|
|
1790
|
+
"deprecated": false,
|
|
1791
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/flags/{flag_id}/actions",
|
|
1792
|
+
"idempotent": true,
|
|
1793
|
+
"method": "resolve",
|
|
1794
|
+
"paginated": false,
|
|
1795
|
+
"params": "Social.CommunityModerationFlagResolveParams",
|
|
1796
|
+
"poll": null,
|
|
1797
|
+
"public": false,
|
|
1798
|
+
"resource": "communities.moderation.flags",
|
|
1799
|
+
"scope": null,
|
|
1800
|
+
"signature": "social.communities.moderation.flags.resolve(communityId, flagId, params, options?): Social.ActOnFlag",
|
|
1801
|
+
"snippet": "const actOnFlag = await social.communities.moderation.flags.resolve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { action: \"hide\" });"
|
|
1802
|
+
},
|
|
1803
|
+
"ModerationAdminController_actDirect": {
|
|
1804
|
+
"actor": null,
|
|
1805
|
+
"deprecated": false,
|
|
1806
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/actions",
|
|
1807
|
+
"idempotent": true,
|
|
1808
|
+
"method": "create",
|
|
1809
|
+
"paginated": false,
|
|
1810
|
+
"params": "Social.CommunityModerationActionCreateParams",
|
|
1811
|
+
"poll": null,
|
|
1812
|
+
"public": false,
|
|
1813
|
+
"resource": "communities.moderation.actions",
|
|
1814
|
+
"scope": null,
|
|
1815
|
+
"signature": "social.communities.moderation.actions.create(communityId, params, options?): Social.ModerationAction",
|
|
1816
|
+
"snippet": "const moderationAction = await social.communities.moderation.actions.create(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {\n action: \"remove\",\n target_id: \"bbbbbbbb-0000-0000-0000-000000000001\",\n target_kind: \"direct_message\",\n});"
|
|
1817
|
+
},
|
|
1818
|
+
"ModerationAdminController_addBlockedTerm": {
|
|
1819
|
+
"actor": null,
|
|
1820
|
+
"deprecated": false,
|
|
1821
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/blocked-terms",
|
|
1822
|
+
"idempotent": true,
|
|
1823
|
+
"method": "create",
|
|
1824
|
+
"paginated": false,
|
|
1825
|
+
"params": "Social.CommunityModerationBlockedTermCreateParams",
|
|
1826
|
+
"poll": null,
|
|
1827
|
+
"public": false,
|
|
1828
|
+
"resource": "communities.moderation.blockedTerms",
|
|
1829
|
+
"scope": null,
|
|
1830
|
+
"signature": "social.communities.moderation.blockedTerms.create(communityId, params, options?): Social.BlockedTerm",
|
|
1831
|
+
"snippet": "const blockedTerm = await social.communities.moderation.blockedTerms.create(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { term: \"spoiler\" });"
|
|
1832
|
+
},
|
|
1833
|
+
"ModerationAdminController_listAudit": {
|
|
1834
|
+
"actor": "query",
|
|
1835
|
+
"deprecated": false,
|
|
1836
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/audit",
|
|
1837
|
+
"idempotent": false,
|
|
1838
|
+
"method": "list",
|
|
1839
|
+
"paginated": true,
|
|
1840
|
+
"params": "Social.CommunityModerationAuditListParams",
|
|
1841
|
+
"poll": null,
|
|
1842
|
+
"public": false,
|
|
1843
|
+
"resource": "communities.moderation.audit",
|
|
1844
|
+
"scope": null,
|
|
1845
|
+
"signature": "social.communities.moderation.audit.list(communityId, params?, options?): PagePromise<Social.ModerationAction>",
|
|
1846
|
+
"snippet": "for await (const audit of social.communities.moderation.audit.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(audit);\n}\nconst page = await social.communities.moderation.audit.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
1847
|
+
},
|
|
1848
|
+
"ModerationAdminController_listBlockedTerms": {
|
|
1849
|
+
"actor": null,
|
|
1850
|
+
"deprecated": false,
|
|
1851
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/blocked-terms",
|
|
1852
|
+
"idempotent": false,
|
|
1853
|
+
"method": "list",
|
|
1854
|
+
"paginated": true,
|
|
1855
|
+
"params": "Social.CommunityModerationBlockedTermListParams",
|
|
1856
|
+
"poll": null,
|
|
1857
|
+
"public": false,
|
|
1858
|
+
"resource": "communities.moderation.blockedTerms",
|
|
1859
|
+
"scope": null,
|
|
1860
|
+
"signature": "social.communities.moderation.blockedTerms.list(communityId, params?, options?): PagePromise<Social.BlockedTerm>",
|
|
1861
|
+
"snippet": "for await (const blockedTerm of social.communities.moderation.blockedTerms.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(blockedTerm);\n}\nconst page = await social.communities.moderation.blockedTerms.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
1862
|
+
},
|
|
1863
|
+
"ModerationAdminController_listFlags": {
|
|
1864
|
+
"actor": null,
|
|
1865
|
+
"deprecated": false,
|
|
1866
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/flags",
|
|
1867
|
+
"idempotent": false,
|
|
1868
|
+
"method": "list",
|
|
1869
|
+
"paginated": true,
|
|
1870
|
+
"params": "Social.CommunityModerationFlagListParams",
|
|
1871
|
+
"poll": null,
|
|
1872
|
+
"public": false,
|
|
1873
|
+
"resource": "communities.moderation.flags",
|
|
1874
|
+
"scope": null,
|
|
1875
|
+
"signature": "social.communities.moderation.flags.list(communityId, params?, options?): PagePromise<Social.Flag>",
|
|
1876
|
+
"snippet": "for await (const flag of social.communities.moderation.flags.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(flag);\n}\nconst page = await social.communities.moderation.flags.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
1877
|
+
},
|
|
1878
|
+
"ModerationAdminController_listShadowBanned": {
|
|
1879
|
+
"actor": null,
|
|
1880
|
+
"deprecated": false,
|
|
1881
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/shadow-banned",
|
|
1882
|
+
"idempotent": false,
|
|
1883
|
+
"method": "list",
|
|
1884
|
+
"paginated": true,
|
|
1885
|
+
"params": "Social.CommunityModerationShadowBannedListParams",
|
|
1886
|
+
"poll": null,
|
|
1887
|
+
"public": false,
|
|
1888
|
+
"resource": "communities.moderation.shadowBanned",
|
|
1889
|
+
"scope": null,
|
|
1890
|
+
"signature": "social.communities.moderation.shadowBanned.list(communityId, params?, options?): PagePromise<Social.ModerationActor>",
|
|
1891
|
+
"snippet": "for await (const shadowBanned of social.communities.moderation.shadowBanned.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(shadowBanned);\n}\nconst page = await social.communities.moderation.shadowBanned.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
1892
|
+
},
|
|
1893
|
+
"ModerationAdminController_removeBlockedTerm": {
|
|
1894
|
+
"actor": null,
|
|
1895
|
+
"deprecated": false,
|
|
1896
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/blocked-terms/{term}",
|
|
1897
|
+
"idempotent": false,
|
|
1898
|
+
"method": "delete",
|
|
1899
|
+
"paginated": false,
|
|
1900
|
+
"params": null,
|
|
1901
|
+
"poll": null,
|
|
1902
|
+
"public": false,
|
|
1903
|
+
"resource": "communities.moderation.blockedTerms",
|
|
1904
|
+
"scope": null,
|
|
1905
|
+
"signature": "social.communities.moderation.blockedTerms.delete(communityId, term, options?): void",
|
|
1906
|
+
"snippet": "await social.communities.moderation.blockedTerms.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"term\");"
|
|
1907
|
+
},
|
|
1908
|
+
"ModerationAdminController_shadowBan": {
|
|
1909
|
+
"actor": null,
|
|
1910
|
+
"deprecated": false,
|
|
1911
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/actors/{actor_id}/shadow-ban",
|
|
1912
|
+
"idempotent": true,
|
|
1913
|
+
"method": "shadowBan",
|
|
1914
|
+
"paginated": false,
|
|
1915
|
+
"params": "Social.CommunityModerationActorShadowBanParams",
|
|
1916
|
+
"poll": null,
|
|
1917
|
+
"public": false,
|
|
1918
|
+
"resource": "communities.moderation.actors",
|
|
1919
|
+
"scope": null,
|
|
1920
|
+
"signature": "social.communities.moderation.actors.shadowBan(communityId, actorId, params?, options?): Social.ModerationActor",
|
|
1921
|
+
"snippet": "const moderationActor = await social.communities.moderation.actors.shadowBan(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { duration_hours: 168 });"
|
|
1922
|
+
},
|
|
1923
|
+
"ModerationAdminController_unshadow": {
|
|
1924
|
+
"actor": null,
|
|
1925
|
+
"deprecated": false,
|
|
1926
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/communities/{community_id}/moderation/actors/{actor_id}/shadow-ban",
|
|
1927
|
+
"idempotent": false,
|
|
1928
|
+
"method": "unshadowBan",
|
|
1929
|
+
"paginated": false,
|
|
1930
|
+
"params": null,
|
|
1931
|
+
"poll": null,
|
|
1932
|
+
"public": false,
|
|
1933
|
+
"resource": "communities.moderation.actors",
|
|
1934
|
+
"scope": null,
|
|
1935
|
+
"signature": "social.communities.moderation.actors.unshadowBan(communityId, actorId, options?): Social.ModerationActor",
|
|
1936
|
+
"snippet": "const moderationActor = await social.communities.moderation.actors.unshadowBan(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
1937
|
+
},
|
|
1938
|
+
"MutedTermController_create": {
|
|
1939
|
+
"actor": null,
|
|
1940
|
+
"deprecated": false,
|
|
1941
|
+
"http": "POST /v1/communities/{community_id}/actors/{actor_id}/muted-terms",
|
|
1942
|
+
"idempotent": true,
|
|
1943
|
+
"method": "create",
|
|
1944
|
+
"paginated": false,
|
|
1945
|
+
"params": "Social.ActorMutedTermCreateParams",
|
|
1946
|
+
"poll": null,
|
|
1947
|
+
"public": false,
|
|
1948
|
+
"resource": "actors.mutedTerms",
|
|
1949
|
+
"scope": "community",
|
|
1950
|
+
"signature": "social.community(…).actors.mutedTerms.create(actorId, params, options?): Social.MutedTerm",
|
|
1951
|
+
"snippet": "const mutedTerm = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.mutedTerms.create(\"aaaaaaaa-0000-0000-0000-000000000001\", { term: \"spoiler\" });"
|
|
1952
|
+
},
|
|
1953
|
+
"MutedTermController_delete": {
|
|
1954
|
+
"actor": null,
|
|
1955
|
+
"deprecated": false,
|
|
1956
|
+
"http": "DELETE /v1/communities/{community_id}/actors/{actor_id}/muted-terms/{term}",
|
|
1957
|
+
"idempotent": false,
|
|
1958
|
+
"method": "delete",
|
|
1959
|
+
"paginated": false,
|
|
1960
|
+
"params": null,
|
|
1961
|
+
"poll": null,
|
|
1962
|
+
"public": false,
|
|
1963
|
+
"resource": "actors.mutedTerms",
|
|
1964
|
+
"scope": "community",
|
|
1965
|
+
"signature": "social.community(…).actors.mutedTerms.delete(actorId, term, options?): void",
|
|
1966
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.mutedTerms.delete(\"aaaaaaaa-0000-0000-0000-000000000001\", \"term\");"
|
|
1967
|
+
},
|
|
1968
|
+
"MutedTermController_list": {
|
|
1969
|
+
"actor": null,
|
|
1970
|
+
"deprecated": false,
|
|
1971
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/muted-terms",
|
|
1972
|
+
"idempotent": false,
|
|
1973
|
+
"method": "list",
|
|
1974
|
+
"paginated": true,
|
|
1975
|
+
"params": "Social.ActorMutedTermListParams",
|
|
1976
|
+
"poll": null,
|
|
1977
|
+
"public": false,
|
|
1978
|
+
"resource": "actors.mutedTerms",
|
|
1979
|
+
"scope": "community",
|
|
1980
|
+
"signature": "social.community(…).actors.mutedTerms.list(actorId, params?, options?): PagePromise<Social.MutedTerm>",
|
|
1981
|
+
"snippet": "for await (const mutedTerm of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.mutedTerms.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(mutedTerm);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.mutedTerms.list(\"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
1982
|
+
},
|
|
1983
|
+
"NotificationController_list": {
|
|
1984
|
+
"actor": null,
|
|
1985
|
+
"deprecated": false,
|
|
1986
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/notifications",
|
|
1987
|
+
"idempotent": false,
|
|
1988
|
+
"method": "list",
|
|
1989
|
+
"paginated": true,
|
|
1990
|
+
"params": "Social.ActorNotificationListParams",
|
|
1991
|
+
"poll": null,
|
|
1992
|
+
"public": false,
|
|
1993
|
+
"resource": "actors.notifications",
|
|
1994
|
+
"scope": "community",
|
|
1995
|
+
"signature": "social.community(…).actors.notifications.list(actorId, params?, options?): PagePromise<Social.NotificationResponse>",
|
|
1996
|
+
"snippet": "for await (const notification of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.notifications.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(notification);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.notifications.list(\"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
1997
|
+
},
|
|
1998
|
+
"NotificationController_markAllRead": {
|
|
1999
|
+
"actor": null,
|
|
2000
|
+
"deprecated": false,
|
|
2001
|
+
"http": "POST /v1/communities/{community_id}/actors/{actor_id}/notifications/read-all",
|
|
2002
|
+
"idempotent": false,
|
|
2003
|
+
"method": "markAllRead",
|
|
2004
|
+
"paginated": false,
|
|
2005
|
+
"params": "Social.ActorNotificationMarkAllReadParams",
|
|
2006
|
+
"poll": null,
|
|
2007
|
+
"public": false,
|
|
2008
|
+
"resource": "actors.notifications",
|
|
2009
|
+
"scope": "community",
|
|
2010
|
+
"signature": "social.community(…).actors.notifications.markAllRead(actorId, params?, options?): Social.MarkAllReadResponse",
|
|
2011
|
+
"snippet": "const result = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.notifications.markAllRead(\"aaaaaaaa-0000-0000-0000-000000000001\", { before: \"2026-05-01T00:00:00.000Z\" });"
|
|
2012
|
+
},
|
|
2013
|
+
"NotificationController_markRead": {
|
|
2014
|
+
"actor": null,
|
|
2015
|
+
"deprecated": false,
|
|
2016
|
+
"http": "PATCH /v1/communities/{community_id}/actors/{actor_id}/notifications/{notification_id}",
|
|
2017
|
+
"idempotent": false,
|
|
2018
|
+
"method": "update",
|
|
2019
|
+
"paginated": false,
|
|
2020
|
+
"params": "Social.ActorNotificationUpdateParams",
|
|
2021
|
+
"poll": null,
|
|
2022
|
+
"public": false,
|
|
2023
|
+
"resource": "actors.notifications",
|
|
2024
|
+
"scope": "community",
|
|
2025
|
+
"signature": "social.community(…).actors.notifications.update(actorId, notificationId, params, options?): void",
|
|
2026
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.notifications.update(\"aaaaaaaa-0000-0000-0000-000000000001\", \"11111111-1111-1111-1111-111111111111\", { read: true });"
|
|
2027
|
+
},
|
|
2028
|
+
"NotificationController_unreadCount": {
|
|
2029
|
+
"actor": null,
|
|
2030
|
+
"deprecated": false,
|
|
2031
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/notifications/unread-count",
|
|
2032
|
+
"idempotent": false,
|
|
2033
|
+
"method": "unreadCount",
|
|
2034
|
+
"paginated": false,
|
|
2035
|
+
"params": null,
|
|
2036
|
+
"poll": null,
|
|
2037
|
+
"public": false,
|
|
2038
|
+
"resource": "actors.notifications",
|
|
2039
|
+
"scope": "community",
|
|
2040
|
+
"signature": "social.community(…).actors.notifications.unreadCount(actorId, options?): Social.UnreadCountResponse",
|
|
2041
|
+
"snippet": "const result = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.notifications.unreadCount(\"aaaaaaaa-0000-0000-0000-000000000001\");"
|
|
2042
|
+
},
|
|
2043
|
+
"NotificationPrefController_list": {
|
|
2044
|
+
"actor": null,
|
|
2045
|
+
"deprecated": false,
|
|
2046
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/notification-prefs",
|
|
2047
|
+
"idempotent": false,
|
|
2048
|
+
"method": "list",
|
|
2049
|
+
"paginated": false,
|
|
2050
|
+
"params": null,
|
|
2051
|
+
"poll": null,
|
|
2052
|
+
"public": false,
|
|
2053
|
+
"resource": "actors.notificationPrefs",
|
|
2054
|
+
"scope": "community",
|
|
2055
|
+
"signature": "social.community(…).actors.notificationPrefs.list(actorId, options?): Social.NotificationPrefList",
|
|
2056
|
+
"snippet": "const notificationPrefList = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.notificationPrefs.list(\"aaaaaaaa-0000-0000-0000-000000000001\");"
|
|
2057
|
+
},
|
|
2058
|
+
"NotificationPrefController_set": {
|
|
2059
|
+
"actor": null,
|
|
2060
|
+
"deprecated": false,
|
|
2061
|
+
"http": "PATCH /v1/communities/{community_id}/actors/{actor_id}/notification-prefs/{kind}",
|
|
2062
|
+
"idempotent": false,
|
|
2063
|
+
"method": "update",
|
|
2064
|
+
"paginated": false,
|
|
2065
|
+
"params": "Social.ActorNotificationPrefUpdateParams",
|
|
2066
|
+
"poll": null,
|
|
2067
|
+
"public": false,
|
|
2068
|
+
"resource": "actors.notificationPrefs",
|
|
2069
|
+
"scope": "community",
|
|
2070
|
+
"signature": "social.community(…).actors.notificationPrefs.update(actorId, kind, params, options?): Social.NotificationPref",
|
|
2071
|
+
"snippet": "const notificationPref = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.notificationPrefs.update(\"aaaaaaaa-0000-0000-0000-000000000001\", \"kind\", { enabled: false });"
|
|
2072
|
+
},
|
|
2073
|
+
"PostController_create": {
|
|
2074
|
+
"actor": "body",
|
|
2075
|
+
"deprecated": false,
|
|
2076
|
+
"http": "POST /v1/communities/{community_id}/posts",
|
|
2077
|
+
"idempotent": true,
|
|
2078
|
+
"method": "create",
|
|
2079
|
+
"paginated": false,
|
|
2080
|
+
"params": "Social.PostCreateParams",
|
|
2081
|
+
"poll": null,
|
|
2082
|
+
"public": false,
|
|
2083
|
+
"resource": "posts",
|
|
2084
|
+
"scope": "community",
|
|
2085
|
+
"signature": "social.community(…).posts.create(params, options?): Social.Post",
|
|
2086
|
+
"snippet": "const post = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.create({});"
|
|
2087
|
+
},
|
|
2088
|
+
"PostController_delete": {
|
|
2089
|
+
"actor": null,
|
|
2090
|
+
"deprecated": false,
|
|
2091
|
+
"http": "DELETE /v1/communities/{community_id}/posts/{post_id}",
|
|
2092
|
+
"idempotent": false,
|
|
2093
|
+
"method": "delete",
|
|
2094
|
+
"paginated": false,
|
|
2095
|
+
"params": null,
|
|
2096
|
+
"poll": null,
|
|
2097
|
+
"public": false,
|
|
2098
|
+
"resource": "posts",
|
|
2099
|
+
"scope": "community",
|
|
2100
|
+
"signature": "social.community(…).posts.delete(postId, options?): void",
|
|
2101
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.delete(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\");"
|
|
2102
|
+
},
|
|
2103
|
+
"PostController_getById": {
|
|
2104
|
+
"actor": "query",
|
|
2105
|
+
"deprecated": false,
|
|
2106
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}",
|
|
2107
|
+
"idempotent": false,
|
|
2108
|
+
"method": "retrieve",
|
|
2109
|
+
"paginated": false,
|
|
2110
|
+
"params": "Social.PostRetrieveParams",
|
|
2111
|
+
"poll": null,
|
|
2112
|
+
"public": false,
|
|
2113
|
+
"resource": "posts",
|
|
2114
|
+
"scope": "community",
|
|
2115
|
+
"signature": "social.community(…).posts.retrieve(postId, params?, options?): Social.Post",
|
|
2116
|
+
"snippet": "const post = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.retrieve(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\");"
|
|
2117
|
+
},
|
|
2118
|
+
"PostController_list": {
|
|
2119
|
+
"actor": null,
|
|
2120
|
+
"deprecated": false,
|
|
2121
|
+
"http": "GET /v1/communities/{community_id}/posts",
|
|
2122
|
+
"idempotent": false,
|
|
2123
|
+
"method": "list",
|
|
2124
|
+
"paginated": true,
|
|
2125
|
+
"params": "Social.PostListParams",
|
|
2126
|
+
"poll": null,
|
|
2127
|
+
"public": false,
|
|
2128
|
+
"resource": "posts",
|
|
2129
|
+
"scope": "community",
|
|
2130
|
+
"signature": "social.community(…).posts.list(params?, options?): PagePromise<Social.Post>",
|
|
2131
|
+
"snippet": "for await (const post of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.list()) {\n console.log(post);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.list({}, { timeout: 5_000 });"
|
|
2132
|
+
},
|
|
2133
|
+
"PostController_listQuotes": {
|
|
2134
|
+
"actor": null,
|
|
2135
|
+
"deprecated": false,
|
|
2136
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/quotes",
|
|
2137
|
+
"idempotent": false,
|
|
2138
|
+
"method": "list",
|
|
2139
|
+
"paginated": true,
|
|
2140
|
+
"params": "Social.PostQuoteListParams",
|
|
2141
|
+
"poll": null,
|
|
2142
|
+
"public": false,
|
|
2143
|
+
"resource": "posts.quotes",
|
|
2144
|
+
"scope": "community",
|
|
2145
|
+
"signature": "social.community(…).posts.quotes.list(postId, params?, options?): PagePromise<Social.Post>",
|
|
2146
|
+
"snippet": "for await (const quote of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.quotes.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\")) {\n console.log(quote);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.quotes.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {}, { timeout: 5_000 });"
|
|
2147
|
+
},
|
|
2148
|
+
"PostController_listRevisions": {
|
|
2149
|
+
"actor": null,
|
|
2150
|
+
"deprecated": false,
|
|
2151
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/revisions",
|
|
2152
|
+
"idempotent": false,
|
|
2153
|
+
"method": "list",
|
|
2154
|
+
"paginated": true,
|
|
2155
|
+
"params": "Social.PostRevisionListParams",
|
|
2156
|
+
"poll": null,
|
|
2157
|
+
"public": false,
|
|
2158
|
+
"resource": "posts.revisions",
|
|
2159
|
+
"scope": "community",
|
|
2160
|
+
"signature": "social.community(…).posts.revisions.list(postId, params?, options?): PagePromise<Social.PostRevision>",
|
|
2161
|
+
"snippet": "for await (const revision of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.revisions.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\")) {\n console.log(revision);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.revisions.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {}, { timeout: 5_000 });"
|
|
2162
|
+
},
|
|
2163
|
+
"PostController_recordImpressions": {
|
|
2164
|
+
"actor": "body",
|
|
2165
|
+
"deprecated": false,
|
|
2166
|
+
"http": "POST /v1/communities/{community_id}/posts/impressions",
|
|
2167
|
+
"idempotent": false,
|
|
2168
|
+
"method": "recordImpressions",
|
|
2169
|
+
"paginated": false,
|
|
2170
|
+
"params": "Social.PostRecordImpressionsParams",
|
|
2171
|
+
"poll": null,
|
|
2172
|
+
"public": false,
|
|
2173
|
+
"resource": "posts",
|
|
2174
|
+
"scope": "community",
|
|
2175
|
+
"signature": "social.community(…).posts.recordImpressions(params, options?): void",
|
|
2176
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.recordImpressions({\n post_ids: [\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"cccccccc-cccc-cccc-cccc-cccccccccccc\"],\n});"
|
|
2177
|
+
},
|
|
2178
|
+
"PostController_update": {
|
|
2179
|
+
"actor": null,
|
|
2180
|
+
"deprecated": false,
|
|
2181
|
+
"http": "PATCH /v1/communities/{community_id}/posts/{post_id}",
|
|
2182
|
+
"idempotent": false,
|
|
2183
|
+
"method": "update",
|
|
2184
|
+
"paginated": false,
|
|
2185
|
+
"params": "Social.PostUpdateParams",
|
|
2186
|
+
"poll": null,
|
|
2187
|
+
"public": false,
|
|
2188
|
+
"resource": "posts",
|
|
2189
|
+
"scope": "community",
|
|
2190
|
+
"signature": "social.community(…).posts.update(postId, params?, options?): Social.Post",
|
|
2191
|
+
"snippet": "const post = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.update(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", { attributes: {} });"
|
|
2192
|
+
},
|
|
2193
|
+
"PostReactionController_list": {
|
|
2194
|
+
"actor": null,
|
|
2195
|
+
"deprecated": false,
|
|
2196
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/reactions",
|
|
2197
|
+
"idempotent": false,
|
|
2198
|
+
"method": "list",
|
|
2199
|
+
"paginated": true,
|
|
2200
|
+
"params": "Social.PostReactionListParams",
|
|
2201
|
+
"poll": null,
|
|
2202
|
+
"public": false,
|
|
2203
|
+
"resource": "posts.reactions",
|
|
2204
|
+
"scope": "community",
|
|
2205
|
+
"signature": "social.community(…).posts.reactions.list(postId, params?, options?): PagePromise<Social.PostReactionEntry>",
|
|
2206
|
+
"snippet": "for await (const reaction of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.reactions.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\")) {\n console.log(reaction);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.reactions.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {}, { timeout: 5_000 });"
|
|
2207
|
+
},
|
|
2208
|
+
"PostReactionController_react": {
|
|
2209
|
+
"actor": "body",
|
|
2210
|
+
"deprecated": false,
|
|
2211
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/reactions",
|
|
2212
|
+
"idempotent": true,
|
|
2213
|
+
"method": "create",
|
|
2214
|
+
"paginated": false,
|
|
2215
|
+
"params": "Social.PostReactionCreateParams",
|
|
2216
|
+
"poll": null,
|
|
2217
|
+
"public": false,
|
|
2218
|
+
"resource": "posts.reactions",
|
|
2219
|
+
"scope": "community",
|
|
2220
|
+
"signature": "social.community(…).posts.reactions.create(postId, params, options?): Social.Reaction",
|
|
2221
|
+
"snippet": "const reaction = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.reactions.create(\"post\", { type: \"like\" });"
|
|
2222
|
+
},
|
|
2223
|
+
"PostReactionController_unreact": {
|
|
2224
|
+
"actor": null,
|
|
2225
|
+
"deprecated": false,
|
|
2226
|
+
"http": "DELETE /v1/communities/{community_id}/posts/{post_id}/reactions/{src_actor_id}/{type}",
|
|
2227
|
+
"idempotent": false,
|
|
2228
|
+
"method": "delete",
|
|
2229
|
+
"paginated": false,
|
|
2230
|
+
"params": null,
|
|
2231
|
+
"poll": null,
|
|
2232
|
+
"public": false,
|
|
2233
|
+
"resource": "posts.reactions",
|
|
2234
|
+
"scope": "community",
|
|
2235
|
+
"signature": "social.community(…).posts.reactions.delete(postId, srcActorId, type, options?): Social.ReactionCounts",
|
|
2236
|
+
"snippet": "const reactionCounts = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.reactions.delete(\"post\", \"src_actor\", \"like\");"
|
|
2237
|
+
},
|
|
2238
|
+
"PostTagController_approve": {
|
|
2239
|
+
"actor": "body",
|
|
2240
|
+
"deprecated": false,
|
|
2241
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/tags/{tagged_actor_id}/approve",
|
|
2242
|
+
"idempotent": false,
|
|
2243
|
+
"method": "approve",
|
|
2244
|
+
"paginated": false,
|
|
2245
|
+
"params": "Social.PostTagApproveParams",
|
|
2246
|
+
"poll": null,
|
|
2247
|
+
"public": false,
|
|
2248
|
+
"resource": "posts.tags",
|
|
2249
|
+
"scope": "community",
|
|
2250
|
+
"signature": "social.community(…).posts.tags.approve(postId, taggedActorId, params, options?): Social.PostTag",
|
|
2251
|
+
"snippet": "const postTag = await social.community(\"community\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.tags.approve(\"post\", \"tagged_actor\", {});"
|
|
2252
|
+
},
|
|
2253
|
+
"PostTagController_listTagged": {
|
|
2254
|
+
"actor": "query",
|
|
2255
|
+
"deprecated": false,
|
|
2256
|
+
"http": "GET /v1/communities/{community_id}/actors/{tagged_actor_id}/tagged",
|
|
2257
|
+
"idempotent": false,
|
|
2258
|
+
"method": "list",
|
|
2259
|
+
"paginated": true,
|
|
2260
|
+
"params": "Social.ActorTaggedListParams",
|
|
2261
|
+
"poll": null,
|
|
2262
|
+
"public": false,
|
|
2263
|
+
"resource": "actors.tagged",
|
|
2264
|
+
"scope": "community",
|
|
2265
|
+
"signature": "social.community(…).actors.tagged.list(taggedActorId, params?, options?): PagePromise<Social.Post>",
|
|
2266
|
+
"snippet": "for await (const tagged of social.community(\"community\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.tagged.list(\"tagged_actor\")) {\n console.log(tagged);\n}\nconst page = await social.community(\"community\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.tagged.list(\"tagged_actor\", {}, { timeout: 5_000 });"
|
|
2267
|
+
},
|
|
2268
|
+
"PostTagController_remove": {
|
|
2269
|
+
"actor": "body",
|
|
2270
|
+
"deprecated": false,
|
|
2271
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/tags/{tagged_actor_id}/remove",
|
|
2272
|
+
"idempotent": false,
|
|
2273
|
+
"method": "delete",
|
|
2274
|
+
"paginated": false,
|
|
2275
|
+
"params": "Social.PostTagDeleteParams",
|
|
2276
|
+
"poll": null,
|
|
2277
|
+
"public": false,
|
|
2278
|
+
"resource": "posts.tags",
|
|
2279
|
+
"scope": "community",
|
|
2280
|
+
"signature": "social.community(…).posts.tags.delete(postId, taggedActorId, params, options?): Social.PostTag",
|
|
2281
|
+
"snippet": "const postTag = await social.community(\"community\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.tags.delete(\"post\", \"tagged_actor\", {});"
|
|
2282
|
+
},
|
|
2283
|
+
"RepostController_create": {
|
|
2284
|
+
"actor": "body",
|
|
2285
|
+
"deprecated": false,
|
|
2286
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/repost",
|
|
2287
|
+
"idempotent": false,
|
|
2288
|
+
"method": "repost",
|
|
2289
|
+
"paginated": false,
|
|
2290
|
+
"params": "Social.PostRepostParams",
|
|
2291
|
+
"poll": null,
|
|
2292
|
+
"public": false,
|
|
2293
|
+
"resource": "posts",
|
|
2294
|
+
"scope": "community",
|
|
2295
|
+
"signature": "social.community(…).posts.repost(postId, params, options?): Social.CreateRepost",
|
|
2296
|
+
"snippet": "const createRepost = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.repost(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {});"
|
|
2297
|
+
},
|
|
2298
|
+
"RepostController_delete": {
|
|
2299
|
+
"actor": "query",
|
|
2300
|
+
"deprecated": false,
|
|
2301
|
+
"http": "DELETE /v1/communities/{community_id}/posts/{post_id}/repost",
|
|
2302
|
+
"idempotent": false,
|
|
2303
|
+
"method": "unrepost",
|
|
2304
|
+
"paginated": false,
|
|
2305
|
+
"params": "Social.PostUnrepostParams",
|
|
2306
|
+
"poll": null,
|
|
2307
|
+
"public": false,
|
|
2308
|
+
"resource": "posts",
|
|
2309
|
+
"scope": "community",
|
|
2310
|
+
"signature": "social.community(…).posts.unrepost(postId, params, options?): void",
|
|
2311
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.unrepost(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {});"
|
|
2312
|
+
},
|
|
2313
|
+
"RepostController_list": {
|
|
2314
|
+
"actor": null,
|
|
2315
|
+
"deprecated": false,
|
|
2316
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/reposts",
|
|
2317
|
+
"idempotent": false,
|
|
2318
|
+
"method": "list",
|
|
2319
|
+
"paginated": true,
|
|
2320
|
+
"params": "Social.PostRepostListParams",
|
|
2321
|
+
"poll": null,
|
|
2322
|
+
"public": false,
|
|
2323
|
+
"resource": "posts.reposts",
|
|
2324
|
+
"scope": "community",
|
|
2325
|
+
"signature": "social.community(…).posts.reposts.list(postId, params?, options?): PagePromise<Social.Post>",
|
|
2326
|
+
"snippet": "for await (const repost of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.reposts.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\")) {\n console.log(repost);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.reposts.list(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", {}, { timeout: 5_000 });"
|
|
2327
|
+
},
|
|
2328
|
+
"SearchController_searchActors": {
|
|
2329
|
+
"actor": "query",
|
|
2330
|
+
"deprecated": false,
|
|
2331
|
+
"http": "GET /v1/communities/{community_id}/search/actors",
|
|
2332
|
+
"idempotent": false,
|
|
2333
|
+
"method": "list",
|
|
2334
|
+
"paginated": true,
|
|
2335
|
+
"params": "Social.SearchActorListParams",
|
|
2336
|
+
"poll": null,
|
|
2337
|
+
"public": false,
|
|
2338
|
+
"resource": "search.actors",
|
|
2339
|
+
"scope": "community",
|
|
2340
|
+
"signature": "social.community(…).search.actors.list(params, options?): PagePromise<Social.ActorSearchHit>",
|
|
2341
|
+
"snippet": "for await (const actor of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").search.actors.list({ q: \"string\" })) {\n console.log(actor);\n}"
|
|
2342
|
+
},
|
|
2343
|
+
"SearchController_searchPosts": {
|
|
2344
|
+
"actor": "query",
|
|
2345
|
+
"deprecated": false,
|
|
2346
|
+
"http": "GET /v1/communities/{community_id}/search/posts",
|
|
2347
|
+
"idempotent": false,
|
|
2348
|
+
"method": "list",
|
|
2349
|
+
"paginated": true,
|
|
2350
|
+
"params": "Social.SearchPostListParams",
|
|
2351
|
+
"poll": null,
|
|
2352
|
+
"public": false,
|
|
2353
|
+
"resource": "search.posts",
|
|
2354
|
+
"scope": "community",
|
|
2355
|
+
"signature": "social.community(…).search.posts.list(params, options?): PagePromise<Social.PostSearchHit>",
|
|
2356
|
+
"snippet": "for await (const post of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").search.posts.list({ q: \"string\" })) {\n console.log(post);\n}"
|
|
2357
|
+
},
|
|
2358
|
+
"StoryController_addCloseFriend": {
|
|
2359
|
+
"actor": "body",
|
|
2360
|
+
"deprecated": false,
|
|
2361
|
+
"http": "POST /v1/communities/{community_id}/close-friends",
|
|
2362
|
+
"idempotent": true,
|
|
2363
|
+
"method": "create",
|
|
2364
|
+
"paginated": false,
|
|
2365
|
+
"params": "Social.CloseFriendCreateParams",
|
|
2366
|
+
"poll": null,
|
|
2367
|
+
"public": false,
|
|
2368
|
+
"resource": "closeFriends",
|
|
2369
|
+
"scope": "community",
|
|
2370
|
+
"signature": "social.community(…).closeFriends.create(params, options?): void",
|
|
2371
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").closeFriends.create({ member_actor_id: \"aaaaaaaa-0000-0000-0000-000000000002\" });"
|
|
2372
|
+
},
|
|
2373
|
+
"StoryController_castVote": {
|
|
2374
|
+
"actor": "body",
|
|
2375
|
+
"deprecated": false,
|
|
2376
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/votes",
|
|
2377
|
+
"idempotent": true,
|
|
2378
|
+
"method": "create",
|
|
2379
|
+
"paginated": false,
|
|
2380
|
+
"params": "Social.PostVoteCreateParams",
|
|
2381
|
+
"poll": null,
|
|
2382
|
+
"public": false,
|
|
2383
|
+
"resource": "posts.votes",
|
|
2384
|
+
"scope": "community",
|
|
2385
|
+
"signature": "social.community(…).posts.votes.create(postId, params, options?): void",
|
|
2386
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.votes.create(\"bbbbbbbb-0000-0000-0000-000000000001\", { option_index: 1 });"
|
|
2387
|
+
},
|
|
2388
|
+
"StoryController_deleteVote": {
|
|
2389
|
+
"actor": null,
|
|
2390
|
+
"deprecated": false,
|
|
2391
|
+
"http": "DELETE /v1/communities/{community_id}/posts/{post_id}/votes/{actor_id}",
|
|
2392
|
+
"idempotent": false,
|
|
2393
|
+
"method": "delete",
|
|
2394
|
+
"paginated": false,
|
|
2395
|
+
"params": null,
|
|
2396
|
+
"poll": null,
|
|
2397
|
+
"public": false,
|
|
2398
|
+
"resource": "posts.votes",
|
|
2399
|
+
"scope": "community",
|
|
2400
|
+
"signature": "social.community(…).posts.votes.delete(postId, actorId, options?): void",
|
|
2401
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.votes.delete(\"bbbbbbbb-0000-0000-0000-000000000001\", \"aaaaaaaa-0000-0000-0000-000000000002\");"
|
|
2402
|
+
},
|
|
2403
|
+
"StoryController_getHighlights": {
|
|
2404
|
+
"actor": "query",
|
|
2405
|
+
"deprecated": false,
|
|
2406
|
+
"http": "GET /v1/communities/{community_id}/actors/{owner_actor_id}/highlights",
|
|
2407
|
+
"idempotent": false,
|
|
2408
|
+
"method": "list",
|
|
2409
|
+
"paginated": true,
|
|
2410
|
+
"params": "Social.ActorHighlightListParams",
|
|
2411
|
+
"poll": null,
|
|
2412
|
+
"public": false,
|
|
2413
|
+
"resource": "actors.highlights",
|
|
2414
|
+
"scope": "community",
|
|
2415
|
+
"signature": "social.community(…).actors.highlights.list(ownerActorId, params?, options?): PagePromise<Social.Post>",
|
|
2416
|
+
"snippet": "for await (const highlight of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.highlights.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(highlight);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.highlights.list(\"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
2417
|
+
},
|
|
2418
|
+
"StoryController_getPollResults": {
|
|
2419
|
+
"actor": null,
|
|
2420
|
+
"deprecated": false,
|
|
2421
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/poll-results",
|
|
2422
|
+
"idempotent": false,
|
|
2423
|
+
"method": "pollResults",
|
|
2424
|
+
"paginated": false,
|
|
2425
|
+
"params": null,
|
|
2426
|
+
"poll": null,
|
|
2427
|
+
"public": false,
|
|
2428
|
+
"resource": "posts",
|
|
2429
|
+
"scope": "community",
|
|
2430
|
+
"signature": "social.community(…).posts.pollResults(postId, options?): Social.PollResultsResponse",
|
|
2431
|
+
"snippet": "const result = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.pollResults(\"bbbbbbbb-0000-0000-0000-000000000001\");"
|
|
2432
|
+
},
|
|
2433
|
+
"StoryController_getTray": {
|
|
2434
|
+
"actor": null,
|
|
2435
|
+
"deprecated": false,
|
|
2436
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/story-tray",
|
|
2437
|
+
"idempotent": false,
|
|
2438
|
+
"method": "list",
|
|
2439
|
+
"paginated": true,
|
|
2440
|
+
"params": null,
|
|
2441
|
+
"poll": null,
|
|
2442
|
+
"public": false,
|
|
2443
|
+
"resource": "actors.storyTray",
|
|
2444
|
+
"scope": "community",
|
|
2445
|
+
"signature": "social.community(…).actors.storyTray.list(actorId, options?): PagePromise<Social.StoryTrayEntryResponse>",
|
|
2446
|
+
"snippet": "for await (const storyTray of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.storyTray.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(storyTray);\n}"
|
|
2447
|
+
},
|
|
2448
|
+
"StoryController_getVote": {
|
|
2449
|
+
"actor": null,
|
|
2450
|
+
"deprecated": false,
|
|
2451
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/votes/{actor_id}",
|
|
2452
|
+
"idempotent": false,
|
|
2453
|
+
"method": "retrieve",
|
|
2454
|
+
"paginated": false,
|
|
2455
|
+
"params": null,
|
|
2456
|
+
"poll": null,
|
|
2457
|
+
"public": false,
|
|
2458
|
+
"resource": "posts.votes",
|
|
2459
|
+
"scope": "community",
|
|
2460
|
+
"signature": "social.community(…).posts.votes.retrieve(postId, actorId, options?): Social.PollVoteResponse",
|
|
2461
|
+
"snippet": "const result = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.votes.retrieve(\"bbbbbbbb-0000-0000-0000-000000000001\", \"aaaaaaaa-0000-0000-0000-000000000002\");"
|
|
2462
|
+
},
|
|
2463
|
+
"StoryController_listCloseFriends": {
|
|
2464
|
+
"actor": null,
|
|
2465
|
+
"deprecated": false,
|
|
2466
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/close-friends",
|
|
2467
|
+
"idempotent": false,
|
|
2468
|
+
"method": "list",
|
|
2469
|
+
"paginated": true,
|
|
2470
|
+
"params": "Social.ActorCloseFriendListParams",
|
|
2471
|
+
"poll": null,
|
|
2472
|
+
"public": false,
|
|
2473
|
+
"resource": "actors.closeFriends",
|
|
2474
|
+
"scope": "community",
|
|
2475
|
+
"signature": "social.community(…).actors.closeFriends.list(actorId, params?, options?): PagePromise<Social.CloseFriendResponse>",
|
|
2476
|
+
"snippet": "for await (const closeFriend of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.closeFriends.list(\"aaaaaaaa-0000-0000-0000-000000000001\")) {\n console.log(closeFriend);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.closeFriends.list(\"aaaaaaaa-0000-0000-0000-000000000001\", {}, { timeout: 5_000 });"
|
|
2477
|
+
},
|
|
2478
|
+
"StoryController_listViewers": {
|
|
2479
|
+
"actor": "query",
|
|
2480
|
+
"deprecated": false,
|
|
2481
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/viewers",
|
|
2482
|
+
"idempotent": false,
|
|
2483
|
+
"method": "list",
|
|
2484
|
+
"paginated": true,
|
|
2485
|
+
"params": "Social.PostViewerListParams",
|
|
2486
|
+
"poll": null,
|
|
2487
|
+
"public": false,
|
|
2488
|
+
"resource": "posts.viewers",
|
|
2489
|
+
"scope": "community",
|
|
2490
|
+
"signature": "social.community(…).posts.viewers.list(postId, params, options?): PagePromise<Social.StoryViewerResponse>",
|
|
2491
|
+
"snippet": "for await (const viewer of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.viewers.list(\"bbbbbbbb-0000-0000-0000-000000000001\", {})) {\n console.log(viewer);\n}"
|
|
2492
|
+
},
|
|
2493
|
+
"StoryController_listVoters": {
|
|
2494
|
+
"actor": "query",
|
|
2495
|
+
"deprecated": false,
|
|
2496
|
+
"http": "GET /v1/communities/{community_id}/posts/{post_id}/voters",
|
|
2497
|
+
"idempotent": false,
|
|
2498
|
+
"method": "list",
|
|
2499
|
+
"paginated": true,
|
|
2500
|
+
"params": "Social.PostVoterListParams",
|
|
2501
|
+
"poll": null,
|
|
2502
|
+
"public": false,
|
|
2503
|
+
"resource": "posts.voters",
|
|
2504
|
+
"scope": "community",
|
|
2505
|
+
"signature": "social.community(…).posts.voters.list(postId, params, options?): PagePromise<Social.PollVoterResponse>",
|
|
2506
|
+
"snippet": "for await (const voter of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.voters.list(\"bbbbbbbb-0000-0000-0000-000000000001\", {})) {\n console.log(voter);\n}"
|
|
2507
|
+
},
|
|
2508
|
+
"StoryController_recordView": {
|
|
2509
|
+
"actor": "body",
|
|
2510
|
+
"deprecated": false,
|
|
2511
|
+
"http": "POST /v1/communities/{community_id}/posts/{post_id}/views",
|
|
2512
|
+
"idempotent": false,
|
|
2513
|
+
"method": "recordView",
|
|
2514
|
+
"paginated": false,
|
|
2515
|
+
"params": "Social.PostRecordViewParams",
|
|
2516
|
+
"poll": null,
|
|
2517
|
+
"public": false,
|
|
2518
|
+
"resource": "posts",
|
|
2519
|
+
"scope": "community",
|
|
2520
|
+
"signature": "social.community(…).posts.recordView(postId, params, options?): void",
|
|
2521
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").posts.recordView(\"bbbbbbbb-0000-0000-0000-000000000001\", {});"
|
|
2522
|
+
},
|
|
2523
|
+
"StoryController_removeCloseFriend": {
|
|
2524
|
+
"actor": null,
|
|
2525
|
+
"deprecated": false,
|
|
2526
|
+
"http": "DELETE /v1/communities/{community_id}/close-friends/{owner_actor_id}/{member_actor_id}",
|
|
2527
|
+
"idempotent": false,
|
|
2528
|
+
"method": "delete",
|
|
2529
|
+
"paginated": false,
|
|
2530
|
+
"params": null,
|
|
2531
|
+
"poll": null,
|
|
2532
|
+
"public": false,
|
|
2533
|
+
"resource": "closeFriends",
|
|
2534
|
+
"scope": "community",
|
|
2535
|
+
"signature": "social.community(…).closeFriends.delete(ownerActorId, memberActorId, options?): void",
|
|
2536
|
+
"snippet": "await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").closeFriends.delete(\"aaaaaaaa-0000-0000-0000-000000000001\", \"aaaaaaaa-0000-0000-0000-000000000002\");"
|
|
2537
|
+
},
|
|
2538
|
+
"SuggestionController_list": {
|
|
2539
|
+
"actor": null,
|
|
2540
|
+
"deprecated": false,
|
|
2541
|
+
"http": "GET /v1/communities/{community_id}/actors/{actor_id}/suggested-follows",
|
|
2542
|
+
"idempotent": false,
|
|
2543
|
+
"method": "list",
|
|
2544
|
+
"paginated": true,
|
|
2545
|
+
"params": "Social.ActorSuggestedFollowListParams",
|
|
2546
|
+
"poll": null,
|
|
2547
|
+
"public": false,
|
|
2548
|
+
"resource": "actors.suggestedFollows",
|
|
2549
|
+
"scope": "community",
|
|
2550
|
+
"signature": "social.community(…).actors.suggestedFollows.list(actorId, params?, options?): PagePromise<Social.SuggestedFollow>",
|
|
2551
|
+
"snippet": "for await (const suggestedFollow of social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.suggestedFollows.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\")) {\n console.log(suggestedFollow);\n}\nconst page = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.suggestedFollows.list(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\", {}, { timeout: 5_000 });"
|
|
2552
|
+
},
|
|
2553
|
+
"ViewerStateController_postState": {
|
|
2554
|
+
"actor": null,
|
|
2555
|
+
"deprecated": false,
|
|
2556
|
+
"http": "POST /v1/communities/{community_id}/actors/{actor_id}/post-state",
|
|
2557
|
+
"idempotent": false,
|
|
2558
|
+
"method": "postState",
|
|
2559
|
+
"paginated": false,
|
|
2560
|
+
"params": "Social.ActorPostStateParams",
|
|
2561
|
+
"poll": null,
|
|
2562
|
+
"public": false,
|
|
2563
|
+
"resource": "actors",
|
|
2564
|
+
"scope": "community",
|
|
2565
|
+
"signature": "social.community(…).actors.postState(actorId, params, options?): Social.PostState",
|
|
2566
|
+
"snippet": "const postState = await social.community(\"cccccccc-cccc-cccc-cccc-cccccccccccc\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").actors.postState(\"aaaaaaaa-0000-0000-0000-000000000001\", {\n post_ids: [\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\", \"cccccccc-cccc-cccc-cccc-cccccccccccc\"],\n});"
|
|
2567
|
+
},
|
|
2568
|
+
"WebhooksController_social_community_createEndpoint": {
|
|
2569
|
+
"actor": null,
|
|
2570
|
+
"deprecated": false,
|
|
2571
|
+
"http": "POST /v1/communities/{community_id}/webhooks/endpoints",
|
|
2572
|
+
"idempotent": true,
|
|
2573
|
+
"method": "create",
|
|
2574
|
+
"paginated": false,
|
|
2575
|
+
"params": "Social.CommunityScopedWebhookEndpointCreateParams",
|
|
2576
|
+
"poll": null,
|
|
2577
|
+
"public": false,
|
|
2578
|
+
"resource": "webhooks.endpoints",
|
|
2579
|
+
"scope": "community",
|
|
2580
|
+
"signature": "social.community(…).webhooks.endpoints.create(params, options?): Social.WebhookEndpointWithSecret",
|
|
2581
|
+
"snippet": "const webhookEndpointWithSecret = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.endpoints.create({ url: \"https://api.acme.com/webhooks\" });"
|
|
2582
|
+
},
|
|
2583
|
+
"WebhooksController_social_community_deleteEndpoint": {
|
|
2584
|
+
"actor": null,
|
|
2585
|
+
"deprecated": false,
|
|
2586
|
+
"http": "DELETE /v1/communities/{community_id}/webhooks/endpoints/{endpoint_id}",
|
|
2587
|
+
"idempotent": false,
|
|
2588
|
+
"method": "delete",
|
|
2589
|
+
"paginated": false,
|
|
2590
|
+
"params": null,
|
|
2591
|
+
"poll": null,
|
|
2592
|
+
"public": false,
|
|
2593
|
+
"resource": "webhooks.endpoints",
|
|
2594
|
+
"scope": "community",
|
|
2595
|
+
"signature": "social.community(…).webhooks.endpoints.delete(endpointId, options?): void",
|
|
2596
|
+
"snippet": "await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.endpoints.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
2597
|
+
},
|
|
2598
|
+
"WebhooksController_social_community_getEndpoint": {
|
|
2599
|
+
"actor": null,
|
|
2600
|
+
"deprecated": false,
|
|
2601
|
+
"http": "GET /v1/communities/{community_id}/webhooks/endpoints/{endpoint_id}",
|
|
2602
|
+
"idempotent": false,
|
|
2603
|
+
"method": "retrieve",
|
|
2604
|
+
"paginated": false,
|
|
2605
|
+
"params": null,
|
|
2606
|
+
"poll": null,
|
|
2607
|
+
"public": false,
|
|
2608
|
+
"resource": "webhooks.endpoints",
|
|
2609
|
+
"scope": "community",
|
|
2610
|
+
"signature": "social.community(…).webhooks.endpoints.retrieve(endpointId, options?): Social.WebhookEndpoint",
|
|
2611
|
+
"snippet": "const webhookEndpoint = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.endpoints.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
2612
|
+
},
|
|
2613
|
+
"WebhooksController_social_community_getEvent": {
|
|
2614
|
+
"actor": null,
|
|
2615
|
+
"deprecated": false,
|
|
2616
|
+
"http": "GET /v1/communities/{community_id}/webhooks/events/{event_id}",
|
|
2617
|
+
"idempotent": false,
|
|
2618
|
+
"method": "retrieve",
|
|
2619
|
+
"paginated": false,
|
|
2620
|
+
"params": null,
|
|
2621
|
+
"poll": null,
|
|
2622
|
+
"public": false,
|
|
2623
|
+
"resource": "webhooks.events",
|
|
2624
|
+
"scope": "community",
|
|
2625
|
+
"signature": "social.community(…).webhooks.events.retrieve(eventId, options?): Social.WebhookEventDetail",
|
|
2626
|
+
"snippet": "const webhookEventDetail = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.events.retrieve(\"event\");"
|
|
2627
|
+
},
|
|
2628
|
+
"WebhooksController_social_community_listEndpoints": {
|
|
2629
|
+
"actor": null,
|
|
2630
|
+
"deprecated": false,
|
|
2631
|
+
"http": "GET /v1/communities/{community_id}/webhooks/endpoints",
|
|
2632
|
+
"idempotent": false,
|
|
2633
|
+
"method": "list",
|
|
2634
|
+
"paginated": true,
|
|
2635
|
+
"params": null,
|
|
2636
|
+
"poll": null,
|
|
2637
|
+
"public": false,
|
|
2638
|
+
"resource": "webhooks.endpoints",
|
|
2639
|
+
"scope": "community",
|
|
2640
|
+
"signature": "social.community(…).webhooks.endpoints.list(options?): PagePromise<Social.WebhookEndpoint>",
|
|
2641
|
+
"snippet": "for await (const endpoint of social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.endpoints.list()) {\n console.log(endpoint);\n}"
|
|
2642
|
+
},
|
|
2643
|
+
"WebhooksController_social_community_listEventTypes": {
|
|
2644
|
+
"actor": null,
|
|
2645
|
+
"deprecated": false,
|
|
2646
|
+
"http": "GET /v1/communities/{community_id}/webhooks/event-types",
|
|
2647
|
+
"idempotent": false,
|
|
2648
|
+
"method": "list",
|
|
2649
|
+
"paginated": false,
|
|
2650
|
+
"params": null,
|
|
2651
|
+
"poll": null,
|
|
2652
|
+
"public": false,
|
|
2653
|
+
"resource": "webhooks.eventTypes",
|
|
2654
|
+
"scope": "community",
|
|
2655
|
+
"signature": "social.community(…).webhooks.eventTypes.list(options?): Social.ListWebhookEventTypes",
|
|
2656
|
+
"snippet": "const listWebhookEventTypes = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.eventTypes.list();"
|
|
2657
|
+
},
|
|
2658
|
+
"WebhooksController_social_community_listEvents": {
|
|
2659
|
+
"actor": null,
|
|
2660
|
+
"deprecated": false,
|
|
2661
|
+
"http": "GET /v1/communities/{community_id}/webhooks/events",
|
|
2662
|
+
"idempotent": false,
|
|
2663
|
+
"method": "list",
|
|
2664
|
+
"paginated": true,
|
|
2665
|
+
"params": "Social.CommunityScopedWebhookEventListParams",
|
|
2666
|
+
"poll": null,
|
|
2667
|
+
"public": false,
|
|
2668
|
+
"resource": "webhooks.events",
|
|
2669
|
+
"scope": "community",
|
|
2670
|
+
"signature": "social.community(…).webhooks.events.list(params?, options?): PagePromise<Social.WebhookEvent>",
|
|
2671
|
+
"snippet": "for await (const event of social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.events.list()) {\n console.log(event);\n}\nconst page = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.events.list({}, { timeout: 5_000 });"
|
|
2672
|
+
},
|
|
2673
|
+
"WebhooksController_social_community_replay": {
|
|
2674
|
+
"actor": null,
|
|
2675
|
+
"deprecated": false,
|
|
2676
|
+
"http": "POST /v1/communities/{community_id}/webhooks/events/{event_id}/replay",
|
|
2677
|
+
"idempotent": true,
|
|
2678
|
+
"method": "replay",
|
|
2679
|
+
"paginated": false,
|
|
2680
|
+
"params": "Social.CommunityScopedWebhookEventReplayParams",
|
|
2681
|
+
"poll": null,
|
|
2682
|
+
"public": false,
|
|
2683
|
+
"resource": "webhooks.events",
|
|
2684
|
+
"scope": "community",
|
|
2685
|
+
"signature": "social.community(…).webhooks.events.replay(eventId, params?, options?): Social.ReplayWebhookEvent",
|
|
2686
|
+
"snippet": "const replayWebhookEvent = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.events.replay(\"event\");"
|
|
2687
|
+
},
|
|
2688
|
+
"WebhooksController_social_community_rotateSecret": {
|
|
2689
|
+
"actor": null,
|
|
2690
|
+
"deprecated": false,
|
|
2691
|
+
"http": "POST /v1/communities/{community_id}/webhooks/endpoints/{endpoint_id}/rotate-secret",
|
|
2692
|
+
"idempotent": true,
|
|
2693
|
+
"method": "rotateSecret",
|
|
2694
|
+
"paginated": false,
|
|
2695
|
+
"params": "Social.CommunityScopedWebhookEndpointRotateSecretParams",
|
|
2696
|
+
"poll": null,
|
|
2697
|
+
"public": false,
|
|
2698
|
+
"resource": "webhooks.endpoints",
|
|
2699
|
+
"scope": "community",
|
|
2700
|
+
"signature": "social.community(…).webhooks.endpoints.rotateSecret(endpointId, params?, options?): Social.WebhookEndpointWithSecret",
|
|
2701
|
+
"snippet": "const webhookEndpointWithSecret = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.endpoints.rotateSecret(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { grace_hours: 24 });"
|
|
2702
|
+
},
|
|
2703
|
+
"WebhooksController_social_community_sendTest": {
|
|
2704
|
+
"actor": null,
|
|
2705
|
+
"deprecated": false,
|
|
2706
|
+
"http": "POST /v1/communities/{community_id}/webhooks/endpoints/{endpoint_id}/test",
|
|
2707
|
+
"idempotent": true,
|
|
2708
|
+
"method": "test",
|
|
2709
|
+
"paginated": false,
|
|
2710
|
+
"params": "Social.CommunityScopedWebhookEndpointTestParams",
|
|
2711
|
+
"poll": null,
|
|
2712
|
+
"public": false,
|
|
2713
|
+
"resource": "webhooks.endpoints",
|
|
2714
|
+
"scope": "community",
|
|
2715
|
+
"signature": "social.community(…).webhooks.endpoints.test(endpointId, params, options?): Social.WebhookDeliveryAttempt",
|
|
2716
|
+
"snippet": "const webhookDeliveryAttempt = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.endpoints.test(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { event_type: \"post.created\" });"
|
|
2717
|
+
},
|
|
2718
|
+
"WebhooksController_social_community_updateEndpoint": {
|
|
2719
|
+
"actor": null,
|
|
2720
|
+
"deprecated": false,
|
|
2721
|
+
"http": "PATCH /v1/communities/{community_id}/webhooks/endpoints/{endpoint_id}",
|
|
2722
|
+
"idempotent": true,
|
|
2723
|
+
"method": "update",
|
|
2724
|
+
"paginated": false,
|
|
2725
|
+
"params": "Social.CommunityScopedWebhookEndpointUpdateParams",
|
|
2726
|
+
"poll": null,
|
|
2727
|
+
"public": false,
|
|
2728
|
+
"resource": "webhooks.endpoints",
|
|
2729
|
+
"scope": "community",
|
|
2730
|
+
"signature": "social.community(…).webhooks.endpoints.update(endpointId, params?, options?): Social.WebhookEndpoint",
|
|
2731
|
+
"snippet": "const webhookEndpoint = await social.community(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\").as(\"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d\").webhooks.endpoints.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { description: \"Production receiver\" });"
|
|
2732
|
+
},
|
|
2733
|
+
"WebhooksController_social_workspace_community_createEndpoint": {
|
|
2734
|
+
"actor": null,
|
|
2735
|
+
"deprecated": false,
|
|
2736
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints",
|
|
2737
|
+
"idempotent": true,
|
|
2738
|
+
"method": "create",
|
|
2739
|
+
"paginated": false,
|
|
2740
|
+
"params": "Social.CommunityWebhookEndpointCreateParams",
|
|
2741
|
+
"poll": null,
|
|
2742
|
+
"public": false,
|
|
2743
|
+
"resource": "communities.webhooks.endpoints",
|
|
2744
|
+
"scope": null,
|
|
2745
|
+
"signature": "social.communities.webhooks.endpoints.create(communityId, params, options?): Social.WebhookEndpointWithSecret",
|
|
2746
|
+
"snippet": "const webhookEndpointWithSecret = await social.communities.webhooks.endpoints.create(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { url: \"https://api.acme.com/webhooks\" });"
|
|
2747
|
+
},
|
|
2748
|
+
"WebhooksController_social_workspace_community_deleteEndpoint": {
|
|
2749
|
+
"actor": null,
|
|
2750
|
+
"deprecated": false,
|
|
2751
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}",
|
|
2752
|
+
"idempotent": false,
|
|
2753
|
+
"method": "delete",
|
|
2754
|
+
"paginated": false,
|
|
2755
|
+
"params": null,
|
|
2756
|
+
"poll": null,
|
|
2757
|
+
"public": false,
|
|
2758
|
+
"resource": "communities.webhooks.endpoints",
|
|
2759
|
+
"scope": null,
|
|
2760
|
+
"signature": "social.communities.webhooks.endpoints.delete(communityId, endpointId, options?): void",
|
|
2761
|
+
"snippet": "await social.communities.webhooks.endpoints.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
2762
|
+
},
|
|
2763
|
+
"WebhooksController_social_workspace_community_getEndpoint": {
|
|
2764
|
+
"actor": null,
|
|
2765
|
+
"deprecated": false,
|
|
2766
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}",
|
|
2767
|
+
"idempotent": false,
|
|
2768
|
+
"method": "retrieve",
|
|
2769
|
+
"paginated": false,
|
|
2770
|
+
"params": null,
|
|
2771
|
+
"poll": null,
|
|
2772
|
+
"public": false,
|
|
2773
|
+
"resource": "communities.webhooks.endpoints",
|
|
2774
|
+
"scope": null,
|
|
2775
|
+
"signature": "social.communities.webhooks.endpoints.retrieve(communityId, endpointId, options?): Social.WebhookEndpoint",
|
|
2776
|
+
"snippet": "const webhookEndpoint = await social.communities.webhooks.endpoints.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
2777
|
+
},
|
|
2778
|
+
"WebhooksController_social_workspace_community_getEvent": {
|
|
2779
|
+
"actor": null,
|
|
2780
|
+
"deprecated": false,
|
|
2781
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/events/{event_id}",
|
|
2782
|
+
"idempotent": false,
|
|
2783
|
+
"method": "retrieve",
|
|
2784
|
+
"paginated": false,
|
|
2785
|
+
"params": null,
|
|
2786
|
+
"poll": null,
|
|
2787
|
+
"public": false,
|
|
2788
|
+
"resource": "communities.webhooks.events",
|
|
2789
|
+
"scope": null,
|
|
2790
|
+
"signature": "social.communities.webhooks.events.retrieve(communityId, eventId, options?): Social.WebhookEventDetail",
|
|
2791
|
+
"snippet": "const webhookEventDetail = await social.communities.webhooks.events.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"event\");"
|
|
2792
|
+
},
|
|
2793
|
+
"WebhooksController_social_workspace_community_listEndpoints": {
|
|
2794
|
+
"actor": null,
|
|
2795
|
+
"deprecated": false,
|
|
2796
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints",
|
|
2797
|
+
"idempotent": false,
|
|
2798
|
+
"method": "list",
|
|
2799
|
+
"paginated": true,
|
|
2800
|
+
"params": null,
|
|
2801
|
+
"poll": null,
|
|
2802
|
+
"public": false,
|
|
2803
|
+
"resource": "communities.webhooks.endpoints",
|
|
2804
|
+
"scope": null,
|
|
2805
|
+
"signature": "social.communities.webhooks.endpoints.list(communityId, options?): PagePromise<Social.WebhookEndpoint>",
|
|
2806
|
+
"snippet": "for await (const endpoint of social.communities.webhooks.endpoints.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(endpoint);\n}"
|
|
2807
|
+
},
|
|
2808
|
+
"WebhooksController_social_workspace_community_listEventTypes": {
|
|
2809
|
+
"actor": null,
|
|
2810
|
+
"deprecated": false,
|
|
2811
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/event-types",
|
|
2812
|
+
"idempotent": false,
|
|
2813
|
+
"method": "list",
|
|
2814
|
+
"paginated": false,
|
|
2815
|
+
"params": null,
|
|
2816
|
+
"poll": null,
|
|
2817
|
+
"public": false,
|
|
2818
|
+
"resource": "communities.webhooks.eventTypes",
|
|
2819
|
+
"scope": null,
|
|
2820
|
+
"signature": "social.communities.webhooks.eventTypes.list(communityId, options?): Social.ListWebhookEventTypes",
|
|
2821
|
+
"snippet": "const listWebhookEventTypes = await social.communities.webhooks.eventTypes.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
2822
|
+
},
|
|
2823
|
+
"WebhooksController_social_workspace_community_listEvents": {
|
|
2824
|
+
"actor": null,
|
|
2825
|
+
"deprecated": false,
|
|
2826
|
+
"http": "GET /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/events",
|
|
2827
|
+
"idempotent": false,
|
|
2828
|
+
"method": "list",
|
|
2829
|
+
"paginated": true,
|
|
2830
|
+
"params": "Social.CommunityWebhookEventListParams",
|
|
2831
|
+
"poll": null,
|
|
2832
|
+
"public": false,
|
|
2833
|
+
"resource": "communities.webhooks.events",
|
|
2834
|
+
"scope": null,
|
|
2835
|
+
"signature": "social.communities.webhooks.events.list(communityId, params?, options?): PagePromise<Social.WebhookEvent>",
|
|
2836
|
+
"snippet": "for await (const event of social.communities.webhooks.events.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(event);\n}\nconst page = await social.communities.webhooks.events.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
2837
|
+
},
|
|
2838
|
+
"WebhooksController_social_workspace_community_replay": {
|
|
2839
|
+
"actor": null,
|
|
2840
|
+
"deprecated": false,
|
|
2841
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/events/{event_id}/replay",
|
|
2842
|
+
"idempotent": true,
|
|
2843
|
+
"method": "replay",
|
|
2844
|
+
"paginated": false,
|
|
2845
|
+
"params": "Social.CommunityWebhookEventReplayParams",
|
|
2846
|
+
"poll": null,
|
|
2847
|
+
"public": false,
|
|
2848
|
+
"resource": "communities.webhooks.events",
|
|
2849
|
+
"scope": null,
|
|
2850
|
+
"signature": "social.communities.webhooks.events.replay(communityId, eventId, params?, options?): Social.ReplayWebhookEvent",
|
|
2851
|
+
"snippet": "const replayWebhookEvent = await social.communities.webhooks.events.replay(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"event\");"
|
|
2852
|
+
},
|
|
2853
|
+
"WebhooksController_social_workspace_community_rotateSecret": {
|
|
2854
|
+
"actor": null,
|
|
2855
|
+
"deprecated": false,
|
|
2856
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}/rotate-secret",
|
|
2857
|
+
"idempotent": true,
|
|
2858
|
+
"method": "rotateSecret",
|
|
2859
|
+
"paginated": false,
|
|
2860
|
+
"params": "Social.CommunityWebhookEndpointRotateSecretParams",
|
|
2861
|
+
"poll": null,
|
|
2862
|
+
"public": false,
|
|
2863
|
+
"resource": "communities.webhooks.endpoints",
|
|
2864
|
+
"scope": null,
|
|
2865
|
+
"signature": "social.communities.webhooks.endpoints.rotateSecret(communityId, endpointId, params?, options?): Social.WebhookEndpointWithSecret",
|
|
2866
|
+
"snippet": "const webhookEndpointWithSecret = await social.communities.webhooks.endpoints.rotateSecret(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { grace_hours: 24 });"
|
|
2867
|
+
},
|
|
2868
|
+
"WebhooksController_social_workspace_community_sendTest": {
|
|
2869
|
+
"actor": null,
|
|
2870
|
+
"deprecated": false,
|
|
2871
|
+
"http": "POST /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}/test",
|
|
2872
|
+
"idempotent": true,
|
|
2873
|
+
"method": "test",
|
|
2874
|
+
"paginated": false,
|
|
2875
|
+
"params": "Social.CommunityWebhookEndpointTestParams",
|
|
2876
|
+
"poll": null,
|
|
2877
|
+
"public": false,
|
|
2878
|
+
"resource": "communities.webhooks.endpoints",
|
|
2879
|
+
"scope": null,
|
|
2880
|
+
"signature": "social.communities.webhooks.endpoints.test(communityId, endpointId, params, options?): Social.WebhookDeliveryAttempt",
|
|
2881
|
+
"snippet": "const webhookDeliveryAttempt = await social.communities.webhooks.endpoints.test(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { event_type: \"post.created\" });"
|
|
2882
|
+
},
|
|
2883
|
+
"WebhooksController_social_workspace_community_updateEndpoint": {
|
|
2884
|
+
"actor": null,
|
|
2885
|
+
"deprecated": false,
|
|
2886
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/communities/{community_id}/webhooks/endpoints/{endpoint_id}",
|
|
2887
|
+
"idempotent": true,
|
|
2888
|
+
"method": "update",
|
|
2889
|
+
"paginated": false,
|
|
2890
|
+
"params": "Social.CommunityWebhookEndpointUpdateParams",
|
|
2891
|
+
"poll": null,
|
|
2892
|
+
"public": false,
|
|
2893
|
+
"resource": "communities.webhooks.endpoints",
|
|
2894
|
+
"scope": null,
|
|
2895
|
+
"signature": "social.communities.webhooks.endpoints.update(communityId, endpointId, params?, options?): Social.WebhookEndpoint",
|
|
2896
|
+
"snippet": "const webhookEndpoint = await social.communities.webhooks.endpoints.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { description: \"Production receiver\" });"
|
|
2897
|
+
},
|
|
2898
|
+
"WebhooksController_social_workspace_createEndpoint": {
|
|
2899
|
+
"actor": null,
|
|
2900
|
+
"deprecated": false,
|
|
2901
|
+
"http": "POST /v1/workspaces/{workspace_id}/webhooks/endpoints",
|
|
2902
|
+
"idempotent": true,
|
|
2903
|
+
"method": "create",
|
|
2904
|
+
"paginated": false,
|
|
2905
|
+
"params": "Social.WebhookEndpointCreateParams",
|
|
2906
|
+
"poll": null,
|
|
2907
|
+
"public": false,
|
|
2908
|
+
"resource": "webhooks.endpoints",
|
|
2909
|
+
"scope": null,
|
|
2910
|
+
"signature": "social.webhooks.endpoints.create(params, options?): Social.WebhookEndpointWithSecret",
|
|
2911
|
+
"snippet": "const webhookEndpointWithSecret = await social.webhooks.endpoints.create({ url: \"https://api.acme.com/webhooks\" });"
|
|
2912
|
+
},
|
|
2913
|
+
"WebhooksController_social_workspace_deleteEndpoint": {
|
|
2914
|
+
"actor": null,
|
|
2915
|
+
"deprecated": false,
|
|
2916
|
+
"http": "DELETE /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}",
|
|
2917
|
+
"idempotent": false,
|
|
2918
|
+
"method": "delete",
|
|
2919
|
+
"paginated": false,
|
|
2920
|
+
"params": null,
|
|
2921
|
+
"poll": null,
|
|
2922
|
+
"public": false,
|
|
2923
|
+
"resource": "webhooks.endpoints",
|
|
2924
|
+
"scope": null,
|
|
2925
|
+
"signature": "social.webhooks.endpoints.delete(endpointId, options?): void",
|
|
2926
|
+
"snippet": "await social.webhooks.endpoints.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
2927
|
+
},
|
|
2928
|
+
"WebhooksController_social_workspace_getEndpoint": {
|
|
2929
|
+
"actor": null,
|
|
2930
|
+
"deprecated": false,
|
|
2931
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}",
|
|
2932
|
+
"idempotent": false,
|
|
2933
|
+
"method": "retrieve",
|
|
2934
|
+
"paginated": false,
|
|
2935
|
+
"params": null,
|
|
2936
|
+
"poll": null,
|
|
2937
|
+
"public": false,
|
|
2938
|
+
"resource": "webhooks.endpoints",
|
|
2939
|
+
"scope": null,
|
|
2940
|
+
"signature": "social.webhooks.endpoints.retrieve(endpointId, options?): Social.WebhookEndpoint",
|
|
2941
|
+
"snippet": "const webhookEndpoint = await social.webhooks.endpoints.retrieve(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
2942
|
+
},
|
|
2943
|
+
"WebhooksController_social_workspace_getEvent": {
|
|
2944
|
+
"actor": null,
|
|
2945
|
+
"deprecated": false,
|
|
2946
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/events/{event_id}",
|
|
2947
|
+
"idempotent": false,
|
|
2948
|
+
"method": "retrieve",
|
|
2949
|
+
"paginated": false,
|
|
2950
|
+
"params": null,
|
|
2951
|
+
"poll": null,
|
|
2952
|
+
"public": false,
|
|
2953
|
+
"resource": "webhooks.events",
|
|
2954
|
+
"scope": null,
|
|
2955
|
+
"signature": "social.webhooks.events.retrieve(eventId, options?): Social.WebhookEventDetail",
|
|
2956
|
+
"snippet": "const webhookEventDetail = await social.webhooks.events.retrieve(\"event\");"
|
|
2957
|
+
},
|
|
2958
|
+
"WebhooksController_social_workspace_listEndpoints": {
|
|
2959
|
+
"actor": null,
|
|
2960
|
+
"deprecated": false,
|
|
2961
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/endpoints",
|
|
2962
|
+
"idempotent": false,
|
|
2963
|
+
"method": "list",
|
|
2964
|
+
"paginated": true,
|
|
2965
|
+
"params": null,
|
|
2966
|
+
"poll": null,
|
|
2967
|
+
"public": false,
|
|
2968
|
+
"resource": "webhooks.endpoints",
|
|
2969
|
+
"scope": null,
|
|
2970
|
+
"signature": "social.webhooks.endpoints.list(options?): PagePromise<Social.WebhookEndpoint>",
|
|
2971
|
+
"snippet": "for await (const endpoint of social.webhooks.endpoints.list()) {\n console.log(endpoint);\n}"
|
|
2972
|
+
},
|
|
2973
|
+
"WebhooksController_social_workspace_listEventTypes": {
|
|
2974
|
+
"actor": null,
|
|
2975
|
+
"deprecated": false,
|
|
2976
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/event-types",
|
|
2977
|
+
"idempotent": false,
|
|
2978
|
+
"method": "list",
|
|
2979
|
+
"paginated": false,
|
|
2980
|
+
"params": null,
|
|
2981
|
+
"poll": null,
|
|
2982
|
+
"public": false,
|
|
2983
|
+
"resource": "webhooks.eventTypes",
|
|
2984
|
+
"scope": null,
|
|
2985
|
+
"signature": "social.webhooks.eventTypes.list(options?): Social.ListWebhookEventTypes",
|
|
2986
|
+
"snippet": "const listWebhookEventTypes = await social.webhooks.eventTypes.list();"
|
|
2987
|
+
},
|
|
2988
|
+
"WebhooksController_social_workspace_listEvents": {
|
|
2989
|
+
"actor": null,
|
|
2990
|
+
"deprecated": false,
|
|
2991
|
+
"http": "GET /v1/workspaces/{workspace_id}/webhooks/events",
|
|
2992
|
+
"idempotent": false,
|
|
2993
|
+
"method": "list",
|
|
2994
|
+
"paginated": true,
|
|
2995
|
+
"params": "Social.WebhookEventListParams",
|
|
2996
|
+
"poll": null,
|
|
2997
|
+
"public": false,
|
|
2998
|
+
"resource": "webhooks.events",
|
|
2999
|
+
"scope": null,
|
|
3000
|
+
"signature": "social.webhooks.events.list(params?, options?): PagePromise<Social.WebhookEvent>",
|
|
3001
|
+
"snippet": "for await (const event of social.webhooks.events.list()) {\n console.log(event);\n}\nconst page = await social.webhooks.events.list({}, { timeout: 5_000 });"
|
|
3002
|
+
},
|
|
3003
|
+
"WebhooksController_social_workspace_replay": {
|
|
3004
|
+
"actor": null,
|
|
3005
|
+
"deprecated": false,
|
|
3006
|
+
"http": "POST /v1/workspaces/{workspace_id}/webhooks/events/{event_id}/replay",
|
|
3007
|
+
"idempotent": true,
|
|
3008
|
+
"method": "replay",
|
|
3009
|
+
"paginated": false,
|
|
3010
|
+
"params": "Social.WebhookEventReplayParams",
|
|
3011
|
+
"poll": null,
|
|
3012
|
+
"public": false,
|
|
3013
|
+
"resource": "webhooks.events",
|
|
3014
|
+
"scope": null,
|
|
3015
|
+
"signature": "social.webhooks.events.replay(eventId, params?, options?): Social.ReplayWebhookEvent",
|
|
3016
|
+
"snippet": "const replayWebhookEvent = await social.webhooks.events.replay(\"event\");"
|
|
3017
|
+
},
|
|
3018
|
+
"WebhooksController_social_workspace_rotateSecret": {
|
|
3019
|
+
"actor": null,
|
|
3020
|
+
"deprecated": false,
|
|
3021
|
+
"http": "POST /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/rotate-secret",
|
|
3022
|
+
"idempotent": true,
|
|
3023
|
+
"method": "rotateSecret",
|
|
3024
|
+
"paginated": false,
|
|
3025
|
+
"params": "Social.WebhookEndpointRotateSecretParams",
|
|
3026
|
+
"poll": null,
|
|
3027
|
+
"public": false,
|
|
3028
|
+
"resource": "webhooks.endpoints",
|
|
3029
|
+
"scope": null,
|
|
3030
|
+
"signature": "social.webhooks.endpoints.rotateSecret(endpointId, params?, options?): Social.WebhookEndpointWithSecret",
|
|
3031
|
+
"snippet": "const webhookEndpointWithSecret = await social.webhooks.endpoints.rotateSecret(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { grace_hours: 24 });"
|
|
3032
|
+
},
|
|
3033
|
+
"WebhooksController_social_workspace_sendTest": {
|
|
3034
|
+
"actor": null,
|
|
3035
|
+
"deprecated": false,
|
|
3036
|
+
"http": "POST /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}/test",
|
|
3037
|
+
"idempotent": true,
|
|
3038
|
+
"method": "test",
|
|
3039
|
+
"paginated": false,
|
|
3040
|
+
"params": "Social.WebhookEndpointTestParams",
|
|
3041
|
+
"poll": null,
|
|
3042
|
+
"public": false,
|
|
3043
|
+
"resource": "webhooks.endpoints",
|
|
3044
|
+
"scope": null,
|
|
3045
|
+
"signature": "social.webhooks.endpoints.test(endpointId, params, options?): Social.WebhookDeliveryAttempt",
|
|
3046
|
+
"snippet": "const webhookDeliveryAttempt = await social.webhooks.endpoints.test(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { event_type: \"post.created\" });"
|
|
3047
|
+
},
|
|
3048
|
+
"WebhooksController_social_workspace_updateEndpoint": {
|
|
3049
|
+
"actor": null,
|
|
3050
|
+
"deprecated": false,
|
|
3051
|
+
"http": "PATCH /v1/workspaces/{workspace_id}/webhooks/endpoints/{endpoint_id}",
|
|
3052
|
+
"idempotent": true,
|
|
3053
|
+
"method": "update",
|
|
3054
|
+
"paginated": false,
|
|
3055
|
+
"params": "Social.WebhookEndpointUpdateParams",
|
|
3056
|
+
"poll": null,
|
|
3057
|
+
"public": false,
|
|
3058
|
+
"resource": "webhooks.endpoints",
|
|
3059
|
+
"scope": null,
|
|
3060
|
+
"signature": "social.webhooks.endpoints.update(endpointId, params?, options?): Social.WebhookEndpoint",
|
|
3061
|
+
"snippet": "const webhookEndpoint = await social.webhooks.endpoints.update(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", { description: \"Production receiver\" });"
|
|
3062
|
+
},
|
|
3063
|
+
"WorkspaceStatsController_get": {
|
|
3064
|
+
"actor": null,
|
|
3065
|
+
"deprecated": false,
|
|
3066
|
+
"http": "GET /v1/workspaces/{workspace_id}/stats",
|
|
3067
|
+
"idempotent": false,
|
|
3068
|
+
"method": "retrieve",
|
|
3069
|
+
"paginated": false,
|
|
3070
|
+
"params": "Social.StatsRetrieveParams",
|
|
3071
|
+
"poll": null,
|
|
3072
|
+
"public": false,
|
|
3073
|
+
"resource": "stats",
|
|
3074
|
+
"scope": null,
|
|
3075
|
+
"signature": "social.stats.retrieve(params?, options?): Social.SocialWorkspaceStats",
|
|
3076
|
+
"snippet": "const socialWorkspaceStats = await social.stats.retrieve();"
|
|
3077
|
+
}
|
|
3078
|
+
},
|
|
3079
|
+
"package": "@productcraft/social"
|
|
3080
|
+
}
|