@openhandle/sdk 0.5.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/LICENSE +21 -0
- package/README.md +239 -0
- package/dist/errors.d.ts +26 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +31 -0
- package/dist/errors.js.map +1 -0
- package/dist/generated/operations.d.ts +1830 -0
- package/dist/generated/operations.d.ts.map +1 -0
- package/dist/generated/operations.js +2455 -0
- package/dist/generated/operations.js.map +1 -0
- package/dist/generated/public-types.d.ts +679 -0
- package/dist/generated/public-types.d.ts.map +1 -0
- package/dist/generated/public-types.js +3 -0
- package/dist/generated/public-types.js.map +1 -0
- package/dist/generated/resources.d.ts +1949 -0
- package/dist/generated/resources.d.ts.map +1 -0
- package/dist/generated/resources.js +3 -0
- package/dist/generated/resources.js.map +1 -0
- package/dist/generated/schema.d.ts +30218 -0
- package/dist/generated/schema.d.ts.map +1 -0
- package/dist/generated/schema.js +3 -0
- package/dist/generated/schema.js.map +1 -0
- package/dist/index.d.ts +12 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -0
- package/dist/index.js.map +1 -0
- package/dist/references.d.ts +3 -0
- package/dist/references.d.ts.map +1 -0
- package/dist/references.js +162 -0
- package/dist/references.js.map +1 -0
- package/dist/runtime.d.ts +16 -0
- package/dist/runtime.d.ts.map +1 -0
- package/dist/runtime.js +230 -0
- package/dist/runtime.js.map +1 -0
- package/dist/types.d.ts +99 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/package.json +56 -0
|
@@ -0,0 +1,1949 @@
|
|
|
1
|
+
import type { FetchOptions, OperationOptions, OperationPage, OperationResponse, ProfileReference, ResourceReference } from '../types.js';
|
|
2
|
+
export interface GeneratedClient {
|
|
3
|
+
readonly instagram: InstagramResource;
|
|
4
|
+
readonly testData: TestDataResource;
|
|
5
|
+
readonly tiktok: TikTokResource;
|
|
6
|
+
readonly twitter: TwitterResource;
|
|
7
|
+
/**
|
|
8
|
+
* Fetch the resource at a social URL
|
|
9
|
+
*
|
|
10
|
+
* Parse a supported social URL locally, then return the same typed resource as its canonical Openhandle operation. The underlying data read is metered once and redirects are never followed.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* await openhandle.fetch('https://www.instagram.com/openai/', { freshness: '24h' });
|
|
14
|
+
*/
|
|
15
|
+
readonly fetch: (url: string, options?: FetchOptions) => Promise<OperationResponse<"/v1/urls/fetch", "post">>;
|
|
16
|
+
}
|
|
17
|
+
export interface InstagramResource {
|
|
18
|
+
/**
|
|
19
|
+
* Select the comment resource using a supported string shorthand or an explicit ID or URL reference.
|
|
20
|
+
*
|
|
21
|
+
* Resource selection is synchronous and does not perform a request.
|
|
22
|
+
*/
|
|
23
|
+
readonly comment: (reference: ResourceReference) => InstagramCommentResource;
|
|
24
|
+
/**
|
|
25
|
+
* Select the hashtag resource using a supported string shorthand or an explicit ID or URL reference.
|
|
26
|
+
*
|
|
27
|
+
* Resource selection is synchronous and does not perform a request.
|
|
28
|
+
*/
|
|
29
|
+
readonly hashtag: (reference: ResourceReference) => InstagramHashtagResource;
|
|
30
|
+
/**
|
|
31
|
+
* Select the highlight resource using a supported string shorthand or an explicit ID or URL reference.
|
|
32
|
+
*
|
|
33
|
+
* Resource selection is synchronous and does not perform a request.
|
|
34
|
+
*/
|
|
35
|
+
readonly highlight: (reference: ResourceReference) => InstagramHighlightResource;
|
|
36
|
+
/**
|
|
37
|
+
* Select the location resource using a supported string shorthand or an explicit ID or URL reference.
|
|
38
|
+
*
|
|
39
|
+
* Resource selection is synchronous and does not perform a request.
|
|
40
|
+
*/
|
|
41
|
+
readonly location: (reference: ResourceReference) => InstagramLocationResource;
|
|
42
|
+
/**
|
|
43
|
+
* Select the music resource using a supported string shorthand or an explicit ID or URL reference.
|
|
44
|
+
*
|
|
45
|
+
* Resource selection is synchronous and does not perform a request.
|
|
46
|
+
*/
|
|
47
|
+
readonly music: (reference: ResourceReference) => InstagramMusicResource;
|
|
48
|
+
/**
|
|
49
|
+
* Select the post resource using a supported string shorthand or an explicit ID or URL reference.
|
|
50
|
+
*
|
|
51
|
+
* Resource selection is synchronous and does not perform a request.
|
|
52
|
+
*/
|
|
53
|
+
readonly post: (reference: ResourceReference) => InstagramPostResource;
|
|
54
|
+
/**
|
|
55
|
+
* Select the profile resource using a username shorthand or an explicit ID or URL reference.
|
|
56
|
+
*
|
|
57
|
+
* Resource selection is synchronous and does not perform a request.
|
|
58
|
+
*/
|
|
59
|
+
readonly profile: (reference: ProfileReference) => InstagramProfileResource;
|
|
60
|
+
readonly search: InstagramSearchResource;
|
|
61
|
+
/**
|
|
62
|
+
* Select the story resource using a supported string shorthand or an explicit ID or URL reference.
|
|
63
|
+
*
|
|
64
|
+
* Resource selection is synchronous and does not perform a request.
|
|
65
|
+
*/
|
|
66
|
+
readonly story: (reference: ResourceReference) => InstagramStoryResource;
|
|
67
|
+
}
|
|
68
|
+
export interface InstagramCommentResource {
|
|
69
|
+
readonly likers: InstagramCommentLikersResource;
|
|
70
|
+
}
|
|
71
|
+
export interface InstagramCommentLikersResource {
|
|
72
|
+
/**
|
|
73
|
+
* List comment likers
|
|
74
|
+
*
|
|
75
|
+
* List comment likers from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* await openhandle.instagram.comment("910100000001").likers.list({ mediaId: "910100000001", freshness: "24h" });
|
|
79
|
+
*
|
|
80
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-comment-likers-list
|
|
81
|
+
*/
|
|
82
|
+
readonly list: (options: OperationOptions<"/v1/instagram/comments/{identifier}/likers", "get">) => Promise<OperationPage<"/v1/instagram/comments/{identifier}/likers", "get">>;
|
|
83
|
+
}
|
|
84
|
+
export interface InstagramHashtagResource {
|
|
85
|
+
readonly posts: InstagramHashtagPostsResource;
|
|
86
|
+
readonly reels: InstagramHashtagReelsResource;
|
|
87
|
+
/**
|
|
88
|
+
* Get a hashtag
|
|
89
|
+
*
|
|
90
|
+
* Return one public hashtag by its native identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* await openhandle.instagram.hashtag("syntheticvolume").get({ freshness: "24h" });
|
|
94
|
+
*
|
|
95
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-hashtag-get
|
|
96
|
+
*/
|
|
97
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/hashtags/{identifier}", "get">) => Promise<OperationResponse<"/v1/instagram/hashtags/{identifier}", "get">>;
|
|
98
|
+
}
|
|
99
|
+
export interface InstagramHashtagPostsResource {
|
|
100
|
+
/**
|
|
101
|
+
* List hashtag posts
|
|
102
|
+
*
|
|
103
|
+
* Return a cursor-paginated collection of public posts. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
104
|
+
*
|
|
105
|
+
* @example
|
|
106
|
+
* await openhandle.instagram.hashtag("syntheticvolume").posts.list({ freshness: "24h" });
|
|
107
|
+
*
|
|
108
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-hashtag-posts-list
|
|
109
|
+
*/
|
|
110
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/hashtags/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/instagram/hashtags/{identifier}/posts", "get">>;
|
|
111
|
+
}
|
|
112
|
+
export interface InstagramHashtagReelsResource {
|
|
113
|
+
/**
|
|
114
|
+
* List hashtag reels
|
|
115
|
+
*
|
|
116
|
+
* Return a cursor-paginated collection of Instagram reels for a hashtag. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* await openhandle.instagram.hashtag("910100000001").reels.list({ freshness: "24h" });
|
|
120
|
+
*
|
|
121
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-hashtag-reels-list
|
|
122
|
+
*/
|
|
123
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/hashtags/{identifier}/reels", "get">) => Promise<OperationPage<"/v1/instagram/hashtags/{identifier}/reels", "get">>;
|
|
124
|
+
}
|
|
125
|
+
export interface InstagramHighlightResource {
|
|
126
|
+
/**
|
|
127
|
+
* Get a highlight
|
|
128
|
+
*
|
|
129
|
+
* Get a highlight from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* await openhandle.instagram.highlight("910100000001").get({ freshness: "24h" });
|
|
133
|
+
*
|
|
134
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-highlight-get
|
|
135
|
+
*/
|
|
136
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/highlights/{identifier}", "get">) => Promise<OperationResponse<"/v1/instagram/highlights/{identifier}", "get">>;
|
|
137
|
+
}
|
|
138
|
+
export interface InstagramLocationResource {
|
|
139
|
+
readonly guides: InstagramLocationGuidesResource;
|
|
140
|
+
readonly posts: InstagramLocationPostsResource;
|
|
141
|
+
/**
|
|
142
|
+
* Get a location
|
|
143
|
+
*
|
|
144
|
+
* Return one public location by its native identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
145
|
+
*
|
|
146
|
+
* @example
|
|
147
|
+
* await openhandle.instagram.location("950000000002").get({ freshness: "24h" });
|
|
148
|
+
*
|
|
149
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-location-get
|
|
150
|
+
*/
|
|
151
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/locations/{identifier}", "get">) => Promise<OperationResponse<"/v1/instagram/locations/{identifier}", "get">>;
|
|
152
|
+
}
|
|
153
|
+
export interface InstagramLocationGuidesResource {
|
|
154
|
+
/**
|
|
155
|
+
* List location guides
|
|
156
|
+
*
|
|
157
|
+
* List location guides from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
158
|
+
*
|
|
159
|
+
* @example
|
|
160
|
+
* await openhandle.instagram.location("910100000001").guides.list({ freshness: "24h" });
|
|
161
|
+
*
|
|
162
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-location-guides-list
|
|
163
|
+
*/
|
|
164
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/locations/{identifier}/guides", "get">) => Promise<OperationPage<"/v1/instagram/locations/{identifier}/guides", "get">>;
|
|
165
|
+
}
|
|
166
|
+
export interface InstagramLocationPostsResource {
|
|
167
|
+
/**
|
|
168
|
+
* List location posts
|
|
169
|
+
*
|
|
170
|
+
* Return a cursor-paginated collection of public posts. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
171
|
+
*
|
|
172
|
+
* @example
|
|
173
|
+
* await openhandle.instagram.location("950000000002").posts.list({ freshness: "24h" });
|
|
174
|
+
*
|
|
175
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-location-posts-list
|
|
176
|
+
*/
|
|
177
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/locations/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/instagram/locations/{identifier}/posts", "get">>;
|
|
178
|
+
}
|
|
179
|
+
export interface InstagramMusicResource {
|
|
180
|
+
readonly stream: InstagramMusicStreamResource;
|
|
181
|
+
/**
|
|
182
|
+
* Get a music
|
|
183
|
+
*
|
|
184
|
+
* Return one public music by its native identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
185
|
+
*
|
|
186
|
+
* @example
|
|
187
|
+
* await openhandle.instagram.music("950000000003").get({ freshness: "24h" });
|
|
188
|
+
*
|
|
189
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-music-get
|
|
190
|
+
*/
|
|
191
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/music/{identifier}", "get">) => Promise<OperationResponse<"/v1/instagram/music/{identifier}", "get">>;
|
|
192
|
+
}
|
|
193
|
+
export interface InstagramMusicStreamResource {
|
|
194
|
+
/**
|
|
195
|
+
* List music stream pages
|
|
196
|
+
*
|
|
197
|
+
* List music stream pages from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
198
|
+
*
|
|
199
|
+
* @example
|
|
200
|
+
* await openhandle.instagram.music("910100000001").stream.list({ freshness: "24h" });
|
|
201
|
+
*
|
|
202
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-music-stream-list
|
|
203
|
+
*/
|
|
204
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/music/{identifier}/stream", "get">) => Promise<OperationPage<"/v1/instagram/music/{identifier}/stream", "get">>;
|
|
205
|
+
}
|
|
206
|
+
export interface InstagramPostResource {
|
|
207
|
+
readonly clipMetadata: InstagramPostClipMetadataResource;
|
|
208
|
+
/**
|
|
209
|
+
* Select the comment resource using a supported string shorthand or an explicit ID or URL reference.
|
|
210
|
+
*
|
|
211
|
+
* Resource selection is synchronous and does not perform a request.
|
|
212
|
+
*/
|
|
213
|
+
readonly comment: (reference: ResourceReference) => InstagramPostCommentResource;
|
|
214
|
+
readonly commentMetadata: InstagramPostCommentMetadataResource;
|
|
215
|
+
readonly commentModeration: InstagramPostCommentModerationResource;
|
|
216
|
+
readonly comments: InstagramPostCommentsResource;
|
|
217
|
+
readonly insights: InstagramPostInsightsResource;
|
|
218
|
+
readonly likers: InstagramPostLikersResource;
|
|
219
|
+
readonly oembed: InstagramPostOEmbedResource;
|
|
220
|
+
readonly taggedUsers: InstagramPostTaggedUsersResource;
|
|
221
|
+
readonly template: InstagramPostTemplateResource;
|
|
222
|
+
/**
|
|
223
|
+
* Get a post
|
|
224
|
+
*
|
|
225
|
+
* Get a post by a canonical platform identifier. URLs must be converted before calling a data endpoint. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
226
|
+
*
|
|
227
|
+
* @example
|
|
228
|
+
* await openhandle.instagram.post("910100000001").get({ freshness: "24h" });
|
|
229
|
+
*
|
|
230
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-get
|
|
231
|
+
*/
|
|
232
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/posts/{identifier}", "get">) => Promise<OperationResponse<"/v1/instagram/posts/{identifier}", "get">>;
|
|
233
|
+
}
|
|
234
|
+
export interface InstagramPostClipMetadataResource {
|
|
235
|
+
/**
|
|
236
|
+
* Get clip metadata
|
|
237
|
+
*
|
|
238
|
+
* Get clip metadata from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
239
|
+
*
|
|
240
|
+
* @example
|
|
241
|
+
* await openhandle.instagram.post("910100000001").clipMetadata.get({ freshness: "24h" });
|
|
242
|
+
*
|
|
243
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-clip-metadata-get
|
|
244
|
+
*/
|
|
245
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/clip-metadata", "get">) => Promise<OperationResponse<"/v1/instagram/posts/{identifier}/clip-metadata", "get">>;
|
|
246
|
+
}
|
|
247
|
+
export interface InstagramPostCommentResource {
|
|
248
|
+
readonly replies: InstagramPostCommentRepliesResource;
|
|
249
|
+
}
|
|
250
|
+
export interface InstagramPostCommentRepliesResource {
|
|
251
|
+
/**
|
|
252
|
+
* List comment replies
|
|
253
|
+
*
|
|
254
|
+
* Return a stable page of replies for one comment. Use find_test_data to discover compatible post and comment IDs. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
255
|
+
*
|
|
256
|
+
* @example
|
|
257
|
+
* await openhandle.instagram.post("910100000001").comment("910200000001").replies.list({ freshness: "24h" });
|
|
258
|
+
*
|
|
259
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-comment-replies-list
|
|
260
|
+
*/
|
|
261
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/comments/{comment_id}/replies", "get">) => Promise<OperationPage<"/v1/instagram/posts/{identifier}/comments/{comment_id}/replies", "get">>;
|
|
262
|
+
}
|
|
263
|
+
export interface InstagramPostCommentMetadataResource {
|
|
264
|
+
/**
|
|
265
|
+
* Get comment metadata
|
|
266
|
+
*
|
|
267
|
+
* Get comment metadata from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
268
|
+
*
|
|
269
|
+
* @example
|
|
270
|
+
* await openhandle.instagram.post("910100000001").commentMetadata.get({ freshness: "24h" });
|
|
271
|
+
*
|
|
272
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-comment-metadata-get
|
|
273
|
+
*/
|
|
274
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/comment-metadata", "get">) => Promise<OperationResponse<"/v1/instagram/posts/{identifier}/comment-metadata", "get">>;
|
|
275
|
+
}
|
|
276
|
+
export interface InstagramPostCommentModerationResource {
|
|
277
|
+
/**
|
|
278
|
+
* Check comment moderation
|
|
279
|
+
*
|
|
280
|
+
* Check comment moderation from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
281
|
+
*
|
|
282
|
+
* @example
|
|
283
|
+
* await openhandle.instagram.post("910100000001").commentModeration.get({ comment: "synthetic comment", freshness: "24h" });
|
|
284
|
+
*
|
|
285
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-comment-moderation-get
|
|
286
|
+
*/
|
|
287
|
+
readonly get: (options: OperationOptions<"/v1/instagram/posts/{identifier}/comment-moderation", "get">) => Promise<OperationResponse<"/v1/instagram/posts/{identifier}/comment-moderation", "get">>;
|
|
288
|
+
}
|
|
289
|
+
export interface InstagramPostCommentsResource {
|
|
290
|
+
/**
|
|
291
|
+
* List post comments
|
|
292
|
+
*
|
|
293
|
+
* List post comments by a canonical platform identifier. URLs must be converted before calling a data endpoint. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
294
|
+
*
|
|
295
|
+
* @example
|
|
296
|
+
* await openhandle.instagram.post("910100000001").comments.list({ freshness: "24h" });
|
|
297
|
+
*
|
|
298
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-comments-list
|
|
299
|
+
*/
|
|
300
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/comments", "get">) => Promise<OperationPage<"/v1/instagram/posts/{identifier}/comments", "get">>;
|
|
301
|
+
}
|
|
302
|
+
export interface InstagramPostInsightsResource {
|
|
303
|
+
/**
|
|
304
|
+
* Get post insights
|
|
305
|
+
*
|
|
306
|
+
* Get post insights from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
307
|
+
*
|
|
308
|
+
* @example
|
|
309
|
+
* await openhandle.instagram.post("910100000001").insights.get({ freshness: "24h" });
|
|
310
|
+
*
|
|
311
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-insights-get
|
|
312
|
+
*/
|
|
313
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/insights", "get">) => Promise<OperationResponse<"/v1/instagram/posts/{identifier}/insights", "get">>;
|
|
314
|
+
}
|
|
315
|
+
export interface InstagramPostLikersResource {
|
|
316
|
+
/**
|
|
317
|
+
* List post likers
|
|
318
|
+
*
|
|
319
|
+
* Return public profiles that liked an Instagram post. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
320
|
+
*
|
|
321
|
+
* @example
|
|
322
|
+
* await openhandle.instagram.post("910100000001").likers.list({ freshness: "24h" });
|
|
323
|
+
*
|
|
324
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-likers-list
|
|
325
|
+
*/
|
|
326
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/likers", "get">) => Promise<OperationPage<"/v1/instagram/posts/{identifier}/likers", "get">>;
|
|
327
|
+
}
|
|
328
|
+
export interface InstagramPostOEmbedResource {
|
|
329
|
+
/**
|
|
330
|
+
* Get post oEmbed data
|
|
331
|
+
*
|
|
332
|
+
* Get post oEmbed data from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
333
|
+
*
|
|
334
|
+
* @example
|
|
335
|
+
* await openhandle.instagram.post("910100000001").oembed.get({ freshness: "24h" });
|
|
336
|
+
*
|
|
337
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-oembed-get
|
|
338
|
+
*/
|
|
339
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/oembed", "get">) => Promise<OperationResponse<"/v1/instagram/posts/{identifier}/oembed", "get">>;
|
|
340
|
+
}
|
|
341
|
+
export interface InstagramPostTaggedUsersResource {
|
|
342
|
+
/**
|
|
343
|
+
* List tagged users
|
|
344
|
+
*
|
|
345
|
+
* Return public profiles tagged in an Instagram post. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
346
|
+
*
|
|
347
|
+
* @example
|
|
348
|
+
* await openhandle.instagram.post("910100000001").taggedUsers.list({ freshness: "24h" });
|
|
349
|
+
*
|
|
350
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-tagged-users-list
|
|
351
|
+
*/
|
|
352
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/tagged-users", "get">) => Promise<OperationPage<"/v1/instagram/posts/{identifier}/tagged-users", "get">>;
|
|
353
|
+
}
|
|
354
|
+
export interface InstagramPostTemplateResource {
|
|
355
|
+
/**
|
|
356
|
+
* Get post template
|
|
357
|
+
*
|
|
358
|
+
* Get post template from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
359
|
+
*
|
|
360
|
+
* @example
|
|
361
|
+
* await openhandle.instagram.post("910100000001").template.get({ freshness: "24h" });
|
|
362
|
+
*
|
|
363
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-post-template-get
|
|
364
|
+
*/
|
|
365
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/posts/{identifier}/template", "get">) => Promise<OperationResponse<"/v1/instagram/posts/{identifier}/template", "get">>;
|
|
366
|
+
}
|
|
367
|
+
export interface InstagramProfileResource {
|
|
368
|
+
readonly about: InstagramProfileAboutResource;
|
|
369
|
+
readonly businessRecommendations: InstagramProfileBusinessRecommendationsResource;
|
|
370
|
+
readonly followers: InstagramProfileFollowersResource;
|
|
371
|
+
readonly following: InstagramProfileFollowingResource;
|
|
372
|
+
readonly highlights: InstagramProfileHighlightsResource;
|
|
373
|
+
readonly pinnedPosts: InstagramProfilePinnedPostsResource;
|
|
374
|
+
readonly posts: InstagramProfilePostsResource;
|
|
375
|
+
readonly reels: InstagramProfileReelsResource;
|
|
376
|
+
readonly related: InstagramProfileRelatedResource;
|
|
377
|
+
readonly reposts: InstagramProfileRepostsResource;
|
|
378
|
+
readonly stories: InstagramProfileStoriesResource;
|
|
379
|
+
readonly suggested: InstagramProfileSuggestedResource;
|
|
380
|
+
readonly taggedPosts: InstagramProfileTaggedPostsResource;
|
|
381
|
+
readonly videos: InstagramProfileVideosResource;
|
|
382
|
+
/**
|
|
383
|
+
* Get a profile
|
|
384
|
+
*
|
|
385
|
+
* Return one public profile. Use @username or a platform ID as the identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
386
|
+
*
|
|
387
|
+
* @example
|
|
388
|
+
* await openhandle.instagram.profile("@northstar_forge_test").get({ freshness: "24h" });
|
|
389
|
+
*
|
|
390
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-get
|
|
391
|
+
*/
|
|
392
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}", "get">) => Promise<OperationResponse<"/v1/instagram/profiles/{identifier}", "get">>;
|
|
393
|
+
}
|
|
394
|
+
export interface InstagramProfileAboutResource {
|
|
395
|
+
/**
|
|
396
|
+
* Get profile about information
|
|
397
|
+
*
|
|
398
|
+
* Get profile about information from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
399
|
+
*
|
|
400
|
+
* @example
|
|
401
|
+
* await openhandle.instagram.profile("@northstar_forge_test").about.get({ freshness: "24h" });
|
|
402
|
+
*
|
|
403
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-about-get
|
|
404
|
+
*/
|
|
405
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/about", "get">) => Promise<OperationResponse<"/v1/instagram/profiles/{identifier}/about", "get">>;
|
|
406
|
+
}
|
|
407
|
+
export interface InstagramProfileBusinessRecommendationsResource {
|
|
408
|
+
/**
|
|
409
|
+
* List business recommendations
|
|
410
|
+
*
|
|
411
|
+
* List business recommendations from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
412
|
+
*
|
|
413
|
+
* @example
|
|
414
|
+
* await openhandle.instagram.profile("@northstar_forge_test").businessRecommendations.list({ freshness: "24h" });
|
|
415
|
+
*
|
|
416
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-business-recommendations-list
|
|
417
|
+
*/
|
|
418
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/business-recommendations", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/business-recommendations", "get">>;
|
|
419
|
+
}
|
|
420
|
+
export interface InstagramProfileFollowersResource {
|
|
421
|
+
/**
|
|
422
|
+
* List profile followers
|
|
423
|
+
*
|
|
424
|
+
* Return a cursor-paginated collection of Instagram profiles. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
425
|
+
*
|
|
426
|
+
* @example
|
|
427
|
+
* await openhandle.instagram.profile("@northstar_forge_test").followers.list({ freshness: "24h" });
|
|
428
|
+
*
|
|
429
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-followers-list
|
|
430
|
+
*/
|
|
431
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/followers", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/followers", "get">>;
|
|
432
|
+
/**
|
|
433
|
+
* Search profile followers
|
|
434
|
+
*
|
|
435
|
+
* Search within a public profile's followers collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
436
|
+
*
|
|
437
|
+
* @example
|
|
438
|
+
* await openhandle.instagram.profile("@northstar_forge_test").followers.search({ q: "synthetic", freshness: "24h" });
|
|
439
|
+
*
|
|
440
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-followers-search
|
|
441
|
+
*/
|
|
442
|
+
readonly search: (options: OperationOptions<"/v1/instagram/profiles/{identifier}/followers/search", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/followers/search", "get">>;
|
|
443
|
+
}
|
|
444
|
+
export interface InstagramProfileFollowingResource {
|
|
445
|
+
/**
|
|
446
|
+
* List profile following
|
|
447
|
+
*
|
|
448
|
+
* Return a cursor-paginated collection of Instagram profiles. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
449
|
+
*
|
|
450
|
+
* @example
|
|
451
|
+
* await openhandle.instagram.profile("@northstar_forge_test").following.list({ freshness: "24h" });
|
|
452
|
+
*
|
|
453
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-following-list
|
|
454
|
+
*/
|
|
455
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/following", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/following", "get">>;
|
|
456
|
+
/**
|
|
457
|
+
* Search profile following
|
|
458
|
+
*
|
|
459
|
+
* Search within a public profile's following collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
460
|
+
*
|
|
461
|
+
* @example
|
|
462
|
+
* await openhandle.instagram.profile("@northstar_forge_test").following.search({ q: "synthetic", freshness: "24h" });
|
|
463
|
+
*
|
|
464
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-following-search
|
|
465
|
+
*/
|
|
466
|
+
readonly search: (options: OperationOptions<"/v1/instagram/profiles/{identifier}/following/search", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/following/search", "get">>;
|
|
467
|
+
}
|
|
468
|
+
export interface InstagramProfileHighlightsResource {
|
|
469
|
+
/**
|
|
470
|
+
* List profile highlights
|
|
471
|
+
*
|
|
472
|
+
* List profile highlights from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
473
|
+
*
|
|
474
|
+
* @example
|
|
475
|
+
* await openhandle.instagram.profile("@northstar_forge_test").highlights.list({ freshness: "24h" });
|
|
476
|
+
*
|
|
477
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-highlights-list
|
|
478
|
+
*/
|
|
479
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/highlights", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/highlights", "get">>;
|
|
480
|
+
}
|
|
481
|
+
export interface InstagramProfilePinnedPostsResource {
|
|
482
|
+
/**
|
|
483
|
+
* List profile pinned posts
|
|
484
|
+
*
|
|
485
|
+
* Return a cursor-paginated Instagram profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
486
|
+
*
|
|
487
|
+
* @example
|
|
488
|
+
* await openhandle.instagram.profile("@northstar_forge_test").pinnedPosts.list({ freshness: "24h" });
|
|
489
|
+
*
|
|
490
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-pinned-posts-list
|
|
491
|
+
*/
|
|
492
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/pinned-posts", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/pinned-posts", "get">>;
|
|
493
|
+
}
|
|
494
|
+
export interface InstagramProfilePostsResource {
|
|
495
|
+
/**
|
|
496
|
+
* List profile posts
|
|
497
|
+
*
|
|
498
|
+
* Return a stable page of posts for one public profile. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
499
|
+
*
|
|
500
|
+
* @example
|
|
501
|
+
* await openhandle.instagram.profile("@northstar_forge_test").posts.list({ freshness: "24h" });
|
|
502
|
+
*
|
|
503
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-posts-list
|
|
504
|
+
*/
|
|
505
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/posts", "get">>;
|
|
506
|
+
}
|
|
507
|
+
export interface InstagramProfileReelsResource {
|
|
508
|
+
/**
|
|
509
|
+
* List profile reels
|
|
510
|
+
*
|
|
511
|
+
* Return a cursor-paginated Instagram profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
512
|
+
*
|
|
513
|
+
* @example
|
|
514
|
+
* await openhandle.instagram.profile("@northstar_forge_test").reels.list({ freshness: "24h" });
|
|
515
|
+
*
|
|
516
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-reels-list
|
|
517
|
+
*/
|
|
518
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/reels", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/reels", "get">>;
|
|
519
|
+
}
|
|
520
|
+
export interface InstagramProfileRelatedResource {
|
|
521
|
+
/**
|
|
522
|
+
* List profile related
|
|
523
|
+
*
|
|
524
|
+
* Return a cursor-paginated collection of Instagram profiles. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
525
|
+
*
|
|
526
|
+
* @example
|
|
527
|
+
* await openhandle.instagram.profile("@northstar_forge_test").related.list({ freshness: "24h" });
|
|
528
|
+
*
|
|
529
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-related-list
|
|
530
|
+
*/
|
|
531
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/related", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/related", "get">>;
|
|
532
|
+
}
|
|
533
|
+
export interface InstagramProfileRepostsResource {
|
|
534
|
+
/**
|
|
535
|
+
* List profile reposts
|
|
536
|
+
*
|
|
537
|
+
* Return a cursor-paginated Instagram profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
538
|
+
*
|
|
539
|
+
* @example
|
|
540
|
+
* await openhandle.instagram.profile("@northstar_forge_test").reposts.list({ freshness: "24h" });
|
|
541
|
+
*
|
|
542
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-reposts-list
|
|
543
|
+
*/
|
|
544
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/reposts", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/reposts", "get">>;
|
|
545
|
+
}
|
|
546
|
+
export interface InstagramProfileStoriesResource {
|
|
547
|
+
/**
|
|
548
|
+
* List profile stories
|
|
549
|
+
*
|
|
550
|
+
* List profile stories from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
551
|
+
*
|
|
552
|
+
* @example
|
|
553
|
+
* await openhandle.instagram.profile("@northstar_forge_test").stories.list({ freshness: "24h" });
|
|
554
|
+
*
|
|
555
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-stories-list
|
|
556
|
+
*/
|
|
557
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/stories", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/stories", "get">>;
|
|
558
|
+
}
|
|
559
|
+
export interface InstagramProfileSuggestedResource {
|
|
560
|
+
/**
|
|
561
|
+
* List profile suggested
|
|
562
|
+
*
|
|
563
|
+
* Return the current collection of Instagram profiles. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
564
|
+
*
|
|
565
|
+
* @example
|
|
566
|
+
* await openhandle.instagram.profile("@northstar_forge_test").suggested.list({ freshness: "24h" });
|
|
567
|
+
*
|
|
568
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-suggested-list
|
|
569
|
+
*/
|
|
570
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/suggested", "get">) => Promise<OperationResponse<"/v1/instagram/profiles/{identifier}/suggested", "get">>;
|
|
571
|
+
}
|
|
572
|
+
export interface InstagramProfileTaggedPostsResource {
|
|
573
|
+
/**
|
|
574
|
+
* List profile tagged posts
|
|
575
|
+
*
|
|
576
|
+
* Return a cursor-paginated Instagram profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
577
|
+
*
|
|
578
|
+
* @example
|
|
579
|
+
* await openhandle.instagram.profile("@northstar_forge_test").taggedPosts.list({ freshness: "24h" });
|
|
580
|
+
*
|
|
581
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-tagged-posts-list
|
|
582
|
+
*/
|
|
583
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/tagged-posts", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/tagged-posts", "get">>;
|
|
584
|
+
}
|
|
585
|
+
export interface InstagramProfileVideosResource {
|
|
586
|
+
/**
|
|
587
|
+
* List profile videos
|
|
588
|
+
*
|
|
589
|
+
* Return a cursor-paginated Instagram profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
590
|
+
*
|
|
591
|
+
* @example
|
|
592
|
+
* await openhandle.instagram.profile("@northstar_forge_test").videos.list({ freshness: "24h" });
|
|
593
|
+
*
|
|
594
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-profile-videos-list
|
|
595
|
+
*/
|
|
596
|
+
readonly list: (options?: OperationOptions<"/v1/instagram/profiles/{identifier}/videos", "get">) => Promise<OperationPage<"/v1/instagram/profiles/{identifier}/videos", "get">>;
|
|
597
|
+
}
|
|
598
|
+
export interface InstagramSearchResource {
|
|
599
|
+
readonly hashtags: InstagramSearchHashtagsResource;
|
|
600
|
+
readonly music: InstagramSearchMusicResource;
|
|
601
|
+
readonly places: InstagramSearchPlacesResource;
|
|
602
|
+
readonly profiles: InstagramSearchProfilesResource;
|
|
603
|
+
readonly reels: InstagramSearchReelsResource;
|
|
604
|
+
readonly top: InstagramSearchTopResource;
|
|
605
|
+
}
|
|
606
|
+
export interface InstagramSearchHashtagsResource {
|
|
607
|
+
/**
|
|
608
|
+
* Search Instagram hashtags
|
|
609
|
+
*
|
|
610
|
+
* Search public Instagram hashtags with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
611
|
+
*
|
|
612
|
+
* @example
|
|
613
|
+
* await openhandle.instagram.search.hashtags.list({ q: "synthetic", freshness: "24h" });
|
|
614
|
+
*
|
|
615
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-search-hashtags-list
|
|
616
|
+
*/
|
|
617
|
+
readonly list: (options: OperationOptions<"/v1/instagram/search/hashtags", "get">) => Promise<OperationPage<"/v1/instagram/search/hashtags", "get">>;
|
|
618
|
+
}
|
|
619
|
+
export interface InstagramSearchMusicResource {
|
|
620
|
+
/**
|
|
621
|
+
* Search Instagram music
|
|
622
|
+
*
|
|
623
|
+
* Search public Instagram music with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
624
|
+
*
|
|
625
|
+
* @example
|
|
626
|
+
* await openhandle.instagram.search.music.list({ q: "synthetic", freshness: "24h" });
|
|
627
|
+
*
|
|
628
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-search-music-list
|
|
629
|
+
*/
|
|
630
|
+
readonly list: (options: OperationOptions<"/v1/instagram/search/music", "get">) => Promise<OperationPage<"/v1/instagram/search/music", "get">>;
|
|
631
|
+
}
|
|
632
|
+
export interface InstagramSearchPlacesResource {
|
|
633
|
+
/**
|
|
634
|
+
* Search Instagram places
|
|
635
|
+
*
|
|
636
|
+
* Search public Instagram places with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
637
|
+
*
|
|
638
|
+
* @example
|
|
639
|
+
* await openhandle.instagram.search.places.list({ q: "synthetic", freshness: "24h" });
|
|
640
|
+
*
|
|
641
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-search-places-list
|
|
642
|
+
*/
|
|
643
|
+
readonly list: (options: OperationOptions<"/v1/instagram/search/places", "get">) => Promise<OperationPage<"/v1/instagram/search/places", "get">>;
|
|
644
|
+
}
|
|
645
|
+
export interface InstagramSearchProfilesResource {
|
|
646
|
+
/**
|
|
647
|
+
* Search Instagram profiles
|
|
648
|
+
*
|
|
649
|
+
* Search public Instagram profiles with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
650
|
+
*
|
|
651
|
+
* @example
|
|
652
|
+
* await openhandle.instagram.search.profiles.list({ q: "synthetic", freshness: "24h" });
|
|
653
|
+
*
|
|
654
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-search-profiles-list
|
|
655
|
+
*/
|
|
656
|
+
readonly list: (options: OperationOptions<"/v1/instagram/search/profiles", "get">) => Promise<OperationPage<"/v1/instagram/search/profiles", "get">>;
|
|
657
|
+
}
|
|
658
|
+
export interface InstagramSearchReelsResource {
|
|
659
|
+
/**
|
|
660
|
+
* Search Instagram reels
|
|
661
|
+
*
|
|
662
|
+
* Search public Instagram reels with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
663
|
+
*
|
|
664
|
+
* @example
|
|
665
|
+
* await openhandle.instagram.search.reels.list({ q: "synthetic", freshness: "24h" });
|
|
666
|
+
*
|
|
667
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-search-reels-list
|
|
668
|
+
*/
|
|
669
|
+
readonly list: (options: OperationOptions<"/v1/instagram/search/reels", "get">) => Promise<OperationPage<"/v1/instagram/search/reels", "get">>;
|
|
670
|
+
}
|
|
671
|
+
export interface InstagramSearchTopResource {
|
|
672
|
+
/**
|
|
673
|
+
* Search all Instagram results
|
|
674
|
+
*
|
|
675
|
+
* Search all Instagram results from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
676
|
+
*
|
|
677
|
+
* @example
|
|
678
|
+
* await openhandle.instagram.search.top.list({ q: "synthetic", freshness: "24h" });
|
|
679
|
+
*
|
|
680
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-search-top-list
|
|
681
|
+
*/
|
|
682
|
+
readonly list: (options: OperationOptions<"/v1/instagram/search/top", "get">) => Promise<OperationPage<"/v1/instagram/search/top", "get">>;
|
|
683
|
+
}
|
|
684
|
+
export interface InstagramStoryResource {
|
|
685
|
+
/**
|
|
686
|
+
* Get a story
|
|
687
|
+
*
|
|
688
|
+
* Get a story from public Instagram data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
689
|
+
*
|
|
690
|
+
* @example
|
|
691
|
+
* await openhandle.instagram.story("910100000001").get({ freshness: "24h" });
|
|
692
|
+
*
|
|
693
|
+
* @see https://openhandle.dev/docs/api-reference/instagram-story-get
|
|
694
|
+
*/
|
|
695
|
+
readonly get: (options?: OperationOptions<"/v1/instagram/stories/{identifier}", "get">) => Promise<OperationResponse<"/v1/instagram/stories/{identifier}", "get">>;
|
|
696
|
+
}
|
|
697
|
+
export interface TestDataResource {
|
|
698
|
+
/**
|
|
699
|
+
* Select the testDataEntry resource using a supported string shorthand or an explicit ID or URL reference.
|
|
700
|
+
*
|
|
701
|
+
* Resource selection is synchronous and does not perform a request.
|
|
702
|
+
*/
|
|
703
|
+
readonly entry: (reference: ResourceReference) => TestDataEntryResource;
|
|
704
|
+
/**
|
|
705
|
+
* Search the synthetic test-data catalog
|
|
706
|
+
*
|
|
707
|
+
* Public, unmetered discovery. Filter by platform, resource, operation, traits, expected status, error code, or text.
|
|
708
|
+
*
|
|
709
|
+
* @example
|
|
710
|
+
* await openhandle.testData.list();
|
|
711
|
+
*/
|
|
712
|
+
readonly list: (options?: OperationOptions<"/v1/test-data", "get">) => Promise<OperationResponse<"/v1/test-data", "get">>;
|
|
713
|
+
}
|
|
714
|
+
export interface TestDataEntryResource {
|
|
715
|
+
/**
|
|
716
|
+
* Get one synthetic catalog entry
|
|
717
|
+
*
|
|
718
|
+
* @example
|
|
719
|
+
* await openhandle.testData.entry("<id>").get();
|
|
720
|
+
*/
|
|
721
|
+
readonly get: (options?: OperationOptions<"/v1/test-data/{id}", "get">) => Promise<OperationResponse<"/v1/test-data/{id}", "get">>;
|
|
722
|
+
}
|
|
723
|
+
export interface TikTokResource {
|
|
724
|
+
/**
|
|
725
|
+
* Select the effect resource using a supported string shorthand or an explicit ID or URL reference.
|
|
726
|
+
*
|
|
727
|
+
* Resource selection is synchronous and does not perform a request.
|
|
728
|
+
*/
|
|
729
|
+
readonly effect: (reference: ResourceReference) => TikTokEffectResource;
|
|
730
|
+
readonly effects: TikTokEffectsResource;
|
|
731
|
+
/**
|
|
732
|
+
* Select the hashtag resource using a supported string shorthand or an explicit ID or URL reference.
|
|
733
|
+
*
|
|
734
|
+
* Resource selection is synchronous and does not perform a request.
|
|
735
|
+
*/
|
|
736
|
+
readonly hashtag: (reference: ResourceReference) => TikTokHashtagResource;
|
|
737
|
+
readonly live: TikTokLiveResource;
|
|
738
|
+
/**
|
|
739
|
+
* Select the location resource using a supported string shorthand or an explicit ID or URL reference.
|
|
740
|
+
*
|
|
741
|
+
* Resource selection is synchronous and does not perform a request.
|
|
742
|
+
*/
|
|
743
|
+
readonly location: (reference: ResourceReference) => TikTokLocationResource;
|
|
744
|
+
/**
|
|
745
|
+
* Select the music resource using a supported string shorthand or an explicit ID or URL reference.
|
|
746
|
+
*
|
|
747
|
+
* Resource selection is synchronous and does not perform a request.
|
|
748
|
+
*/
|
|
749
|
+
readonly music: (reference: ResourceReference) => TikTokMusicResource;
|
|
750
|
+
/**
|
|
751
|
+
* Select the post resource using a supported string shorthand or an explicit ID or URL reference.
|
|
752
|
+
*
|
|
753
|
+
* Resource selection is synchronous and does not perform a request.
|
|
754
|
+
*/
|
|
755
|
+
readonly post: (reference: ResourceReference) => TikTokPostResource;
|
|
756
|
+
/**
|
|
757
|
+
* Select the profile resource using a username shorthand or an explicit ID or URL reference.
|
|
758
|
+
*
|
|
759
|
+
* Resource selection is synchronous and does not perform a request.
|
|
760
|
+
*/
|
|
761
|
+
readonly profile: (reference: ProfileReference) => TikTokProfileResource;
|
|
762
|
+
readonly search: TikTokSearchResource;
|
|
763
|
+
readonly shop: TikTokShopResource;
|
|
764
|
+
/**
|
|
765
|
+
* Select the story resource using a supported string shorthand or an explicit ID or URL reference.
|
|
766
|
+
*
|
|
767
|
+
* Resource selection is synchronous and does not perform a request.
|
|
768
|
+
*/
|
|
769
|
+
readonly story: (reference: ResourceReference) => TikTokStoryResource;
|
|
770
|
+
readonly trending: TikTokTrendingResource;
|
|
771
|
+
}
|
|
772
|
+
export interface TikTokEffectResource {
|
|
773
|
+
readonly posts: TikTokEffectPostsResource;
|
|
774
|
+
/**
|
|
775
|
+
* Get an effect
|
|
776
|
+
*
|
|
777
|
+
* Get an effect from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
778
|
+
*
|
|
779
|
+
* @example
|
|
780
|
+
* await openhandle.tiktok.effect("920100000000000001").get({ freshness: "24h" });
|
|
781
|
+
*
|
|
782
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-effect-get
|
|
783
|
+
*/
|
|
784
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/effects/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/effects/{identifier}", "get">>;
|
|
785
|
+
}
|
|
786
|
+
export interface TikTokEffectPostsResource {
|
|
787
|
+
/**
|
|
788
|
+
* List effect posts
|
|
789
|
+
*
|
|
790
|
+
* Return a cursor-paginated collection of TikTok posts that use an effect. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
791
|
+
*
|
|
792
|
+
* @example
|
|
793
|
+
* await openhandle.tiktok.effect("920100000000000001").posts.list({ freshness: "24h" });
|
|
794
|
+
*
|
|
795
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-effect-posts-list
|
|
796
|
+
*/
|
|
797
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/effects/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/tiktok/effects/{identifier}/posts", "get">>;
|
|
798
|
+
}
|
|
799
|
+
export interface TikTokEffectsResource {
|
|
800
|
+
/**
|
|
801
|
+
* Get effects in a batch
|
|
802
|
+
*
|
|
803
|
+
* Get effects in a batch from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
804
|
+
*
|
|
805
|
+
* @example
|
|
806
|
+
* await openhandle.tiktok.effects.list({ ids: "950000000007", freshness: "24h" });
|
|
807
|
+
*
|
|
808
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-effects-list
|
|
809
|
+
*/
|
|
810
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/effects", "get">) => Promise<OperationPage<"/v1/tiktok/effects", "get">>;
|
|
811
|
+
}
|
|
812
|
+
export interface TikTokHashtagResource {
|
|
813
|
+
readonly posts: TikTokHashtagPostsResource;
|
|
814
|
+
/**
|
|
815
|
+
* Get a hashtag
|
|
816
|
+
*
|
|
817
|
+
* Return one public hashtag by its native identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
818
|
+
*
|
|
819
|
+
* @example
|
|
820
|
+
* await openhandle.tiktok.hashtag("950000000001").get({ freshness: "24h" });
|
|
821
|
+
*
|
|
822
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-hashtag-get
|
|
823
|
+
*/
|
|
824
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/hashtags/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/hashtags/{identifier}", "get">>;
|
|
825
|
+
}
|
|
826
|
+
export interface TikTokHashtagPostsResource {
|
|
827
|
+
/**
|
|
828
|
+
* List hashtag posts
|
|
829
|
+
*
|
|
830
|
+
* Return a cursor-paginated collection of public posts. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
831
|
+
*
|
|
832
|
+
* @example
|
|
833
|
+
* await openhandle.tiktok.hashtag("950000000001").posts.list({ freshness: "24h" });
|
|
834
|
+
*
|
|
835
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-hashtag-posts-list
|
|
836
|
+
*/
|
|
837
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/hashtags/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/tiktok/hashtags/{identifier}/posts", "get">>;
|
|
838
|
+
}
|
|
839
|
+
export interface TikTokLiveResource {
|
|
840
|
+
/**
|
|
841
|
+
* Select the event resource using a supported string shorthand or an explicit ID or URL reference.
|
|
842
|
+
*
|
|
843
|
+
* Resource selection is synchronous and does not perform a request.
|
|
844
|
+
*/
|
|
845
|
+
readonly event: (reference: ResourceReference) => TikTokLiveEventResource;
|
|
846
|
+
readonly feed: TikTokLiveFeedResource;
|
|
847
|
+
/**
|
|
848
|
+
* Select the room resource using a supported string shorthand or an explicit ID or URL reference.
|
|
849
|
+
*
|
|
850
|
+
* Resource selection is synchronous and does not perform a request.
|
|
851
|
+
*/
|
|
852
|
+
readonly room: (reference: ResourceReference) => TikTokLiveRoomResource;
|
|
853
|
+
}
|
|
854
|
+
export interface TikTokLiveEventResource {
|
|
855
|
+
/**
|
|
856
|
+
* Get a live event
|
|
857
|
+
*
|
|
858
|
+
* Get a live event from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
859
|
+
*
|
|
860
|
+
* @example
|
|
861
|
+
* await openhandle.tiktok.live.event("920100000000000001").get({ freshness: "24h" });
|
|
862
|
+
*
|
|
863
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-live-event-get
|
|
864
|
+
*/
|
|
865
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/live/events/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/live/events/{identifier}", "get">>;
|
|
866
|
+
}
|
|
867
|
+
export interface TikTokLiveFeedResource {
|
|
868
|
+
/**
|
|
869
|
+
* List live feed
|
|
870
|
+
*
|
|
871
|
+
* List live feed from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
872
|
+
*
|
|
873
|
+
* @example
|
|
874
|
+
* await openhandle.tiktok.live.feed.list({ freshness: "24h" });
|
|
875
|
+
*
|
|
876
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-live-feed-list
|
|
877
|
+
*/
|
|
878
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/live/feed", "get">) => Promise<OperationPage<"/v1/tiktok/live/feed", "get">>;
|
|
879
|
+
}
|
|
880
|
+
export interface TikTokLiveRoomResource {
|
|
881
|
+
readonly rankings: TikTokLiveRoomRankingsResource;
|
|
882
|
+
readonly rankingTypes: TikTokLiveRoomRankingTypesResource;
|
|
883
|
+
/**
|
|
884
|
+
* Get live room info
|
|
885
|
+
*
|
|
886
|
+
* Get live room info from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
887
|
+
*
|
|
888
|
+
* @example
|
|
889
|
+
* await openhandle.tiktok.live.room("920100000000000001").get({ userId: "920000000001", freshness: "24h" });
|
|
890
|
+
*
|
|
891
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-live-info-get
|
|
892
|
+
*/
|
|
893
|
+
readonly get: (options: OperationOptions<"/v1/tiktok/live/rooms/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/live/rooms/{identifier}", "get">>;
|
|
894
|
+
}
|
|
895
|
+
export interface TikTokLiveRoomRankingsResource {
|
|
896
|
+
/**
|
|
897
|
+
* Get a live ranking
|
|
898
|
+
*
|
|
899
|
+
* Get a live ranking from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
900
|
+
*
|
|
901
|
+
* @example
|
|
902
|
+
* await openhandle.tiktok.live.room("920100000000000001").rankings.list({ userId: "920000000001", rankType: "daily", freshness: "24h" });
|
|
903
|
+
*
|
|
904
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-live-ranking-list
|
|
905
|
+
*/
|
|
906
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/live/rooms/{identifier}/rankings", "get">) => Promise<OperationPage<"/v1/tiktok/live/rooms/{identifier}/rankings", "get">>;
|
|
907
|
+
}
|
|
908
|
+
export interface TikTokLiveRoomRankingTypesResource {
|
|
909
|
+
/**
|
|
910
|
+
* List live ranking types
|
|
911
|
+
*
|
|
912
|
+
* List live ranking types from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
913
|
+
*
|
|
914
|
+
* @example
|
|
915
|
+
* await openhandle.tiktok.live.room("920100000000000001").rankingTypes.list({ userId: "920000000001", freshness: "24h" });
|
|
916
|
+
*
|
|
917
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-live-ranking-types-list
|
|
918
|
+
*/
|
|
919
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/live/rooms/{identifier}/ranking-types", "get">) => Promise<OperationPage<"/v1/tiktok/live/rooms/{identifier}/ranking-types", "get">>;
|
|
920
|
+
}
|
|
921
|
+
export interface TikTokLocationResource {
|
|
922
|
+
readonly posts: TikTokLocationPostsResource;
|
|
923
|
+
/**
|
|
924
|
+
* Get a location
|
|
925
|
+
*
|
|
926
|
+
* Return one public location by its native identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
927
|
+
*
|
|
928
|
+
* @example
|
|
929
|
+
* await openhandle.tiktok.location("950000000002").get({ freshness: "24h" });
|
|
930
|
+
*
|
|
931
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-location-get
|
|
932
|
+
*/
|
|
933
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/locations/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/locations/{identifier}", "get">>;
|
|
934
|
+
}
|
|
935
|
+
export interface TikTokLocationPostsResource {
|
|
936
|
+
/**
|
|
937
|
+
* List location posts
|
|
938
|
+
*
|
|
939
|
+
* Return a cursor-paginated collection of public posts. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
940
|
+
*
|
|
941
|
+
* @example
|
|
942
|
+
* await openhandle.tiktok.location("950000000002").posts.list({ freshness: "24h" });
|
|
943
|
+
*
|
|
944
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-location-posts-list
|
|
945
|
+
*/
|
|
946
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/locations/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/tiktok/locations/{identifier}/posts", "get">>;
|
|
947
|
+
}
|
|
948
|
+
export interface TikTokMusicResource {
|
|
949
|
+
readonly posts: TikTokMusicPostsResource;
|
|
950
|
+
/**
|
|
951
|
+
* Get a music
|
|
952
|
+
*
|
|
953
|
+
* Return one public music by its native identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
954
|
+
*
|
|
955
|
+
* @example
|
|
956
|
+
* await openhandle.tiktok.music("950000000003").get({ freshness: "24h" });
|
|
957
|
+
*
|
|
958
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-music-get
|
|
959
|
+
*/
|
|
960
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/music/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/music/{identifier}", "get">>;
|
|
961
|
+
}
|
|
962
|
+
export interface TikTokMusicPostsResource {
|
|
963
|
+
/**
|
|
964
|
+
* List music posts
|
|
965
|
+
*
|
|
966
|
+
* Return a cursor-paginated collection of public posts. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
967
|
+
*
|
|
968
|
+
* @example
|
|
969
|
+
* await openhandle.tiktok.music("950000000003").posts.list({ freshness: "24h" });
|
|
970
|
+
*
|
|
971
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-music-posts-list
|
|
972
|
+
*/
|
|
973
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/music/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/tiktok/music/{identifier}/posts", "get">>;
|
|
974
|
+
}
|
|
975
|
+
export interface TikTokPostResource {
|
|
976
|
+
/**
|
|
977
|
+
* Select the comment resource using a supported string shorthand or an explicit ID or URL reference.
|
|
978
|
+
*
|
|
979
|
+
* Resource selection is synchronous and does not perform a request.
|
|
980
|
+
*/
|
|
981
|
+
readonly comment: (reference: ResourceReference) => TikTokPostCommentResource;
|
|
982
|
+
readonly comments: TikTokPostCommentsResource;
|
|
983
|
+
/**
|
|
984
|
+
* Get a post
|
|
985
|
+
*
|
|
986
|
+
* Get a post by a canonical platform identifier. URLs must be converted before calling a data endpoint. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
987
|
+
*
|
|
988
|
+
* @example
|
|
989
|
+
* await openhandle.tiktok.post("920100000000000001").get({ freshness: "24h" });
|
|
990
|
+
*
|
|
991
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-post-get
|
|
992
|
+
*/
|
|
993
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/posts/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/posts/{identifier}", "get">>;
|
|
994
|
+
}
|
|
995
|
+
export interface TikTokPostCommentResource {
|
|
996
|
+
readonly replies: TikTokPostCommentRepliesResource;
|
|
997
|
+
/**
|
|
998
|
+
* Get a comment
|
|
999
|
+
*
|
|
1000
|
+
* Get a comment from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1001
|
+
*
|
|
1002
|
+
* @example
|
|
1003
|
+
* await openhandle.tiktok.post("920100000000000001").comment("920200000000000001").get({ freshness: "24h" });
|
|
1004
|
+
*
|
|
1005
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-comment-get
|
|
1006
|
+
*/
|
|
1007
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/posts/{identifier}/comments/{comment_id}", "get">) => Promise<OperationResponse<"/v1/tiktok/posts/{identifier}/comments/{comment_id}", "get">>;
|
|
1008
|
+
}
|
|
1009
|
+
export interface TikTokPostCommentRepliesResource {
|
|
1010
|
+
/**
|
|
1011
|
+
* List comment replies
|
|
1012
|
+
*
|
|
1013
|
+
* Return a stable page of replies for one comment. Use find_test_data to discover compatible post and comment IDs. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1014
|
+
*
|
|
1015
|
+
* @example
|
|
1016
|
+
* await openhandle.tiktok.post("920100000000000001").comment("920200000000000001").replies.list({ freshness: "24h" });
|
|
1017
|
+
*
|
|
1018
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-comment-replies-list
|
|
1019
|
+
*/
|
|
1020
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/posts/{identifier}/comments/{comment_id}/replies", "get">) => Promise<OperationPage<"/v1/tiktok/posts/{identifier}/comments/{comment_id}/replies", "get">>;
|
|
1021
|
+
}
|
|
1022
|
+
export interface TikTokPostCommentsResource {
|
|
1023
|
+
/**
|
|
1024
|
+
* List post comments
|
|
1025
|
+
*
|
|
1026
|
+
* List post comments by a canonical platform identifier. URLs must be converted before calling a data endpoint. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1027
|
+
*
|
|
1028
|
+
* @example
|
|
1029
|
+
* await openhandle.tiktok.post("920100000000000001").comments.list({ freshness: "24h" });
|
|
1030
|
+
*
|
|
1031
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-post-comments-list
|
|
1032
|
+
*/
|
|
1033
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/posts/{identifier}/comments", "get">) => Promise<OperationPage<"/v1/tiktok/posts/{identifier}/comments", "get">>;
|
|
1034
|
+
}
|
|
1035
|
+
export interface TikTokProfileResource {
|
|
1036
|
+
readonly followers: TikTokProfileFollowersResource;
|
|
1037
|
+
readonly following: TikTokProfileFollowingResource;
|
|
1038
|
+
readonly likedPosts: TikTokProfileLikedPostsResource;
|
|
1039
|
+
readonly music: TikTokProfileMusicResource;
|
|
1040
|
+
/**
|
|
1041
|
+
* Select the playlist resource using a supported string shorthand or an explicit ID or URL reference.
|
|
1042
|
+
*
|
|
1043
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1044
|
+
*/
|
|
1045
|
+
readonly playlist: (reference: ResourceReference) => TikTokProfilePlaylistResource;
|
|
1046
|
+
readonly playlists: TikTokProfilePlaylistsResource;
|
|
1047
|
+
readonly posts: TikTokProfilePostsResource;
|
|
1048
|
+
readonly qrCode: TikTokProfileQRCodeResource;
|
|
1049
|
+
readonly stories: TikTokProfileStoriesResource;
|
|
1050
|
+
/**
|
|
1051
|
+
* Get a profile
|
|
1052
|
+
*
|
|
1053
|
+
* Return one public profile. Use @username or a platform ID as the identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1054
|
+
*
|
|
1055
|
+
* @example
|
|
1056
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").get({ freshness: "24h" });
|
|
1057
|
+
*
|
|
1058
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-get
|
|
1059
|
+
*/
|
|
1060
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/profiles/{identifier}", "get">>;
|
|
1061
|
+
}
|
|
1062
|
+
export interface TikTokProfileFollowersResource {
|
|
1063
|
+
/**
|
|
1064
|
+
* List profile followers
|
|
1065
|
+
*
|
|
1066
|
+
* Return a cursor-paginated collection of Tiktok profiles. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1067
|
+
*
|
|
1068
|
+
* @example
|
|
1069
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").followers.list({ freshness: "24h" });
|
|
1070
|
+
*
|
|
1071
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-followers-list
|
|
1072
|
+
*/
|
|
1073
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/followers", "get">) => Promise<OperationPage<"/v1/tiktok/profiles/{identifier}/followers", "get">>;
|
|
1074
|
+
}
|
|
1075
|
+
export interface TikTokProfileFollowingResource {
|
|
1076
|
+
/**
|
|
1077
|
+
* List profile following
|
|
1078
|
+
*
|
|
1079
|
+
* Return a cursor-paginated collection of Tiktok profiles. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1080
|
+
*
|
|
1081
|
+
* @example
|
|
1082
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").following.list({ freshness: "24h" });
|
|
1083
|
+
*
|
|
1084
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-following-list
|
|
1085
|
+
*/
|
|
1086
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/following", "get">) => Promise<OperationPage<"/v1/tiktok/profiles/{identifier}/following", "get">>;
|
|
1087
|
+
}
|
|
1088
|
+
export interface TikTokProfileLikedPostsResource {
|
|
1089
|
+
/**
|
|
1090
|
+
* List profile liked posts
|
|
1091
|
+
*
|
|
1092
|
+
* Return a cursor-paginated Tiktok profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1093
|
+
*
|
|
1094
|
+
* @example
|
|
1095
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").likedPosts.list({ freshness: "24h" });
|
|
1096
|
+
*
|
|
1097
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-liked-posts-list
|
|
1098
|
+
*/
|
|
1099
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/liked-posts", "get">) => Promise<OperationPage<"/v1/tiktok/profiles/{identifier}/liked-posts", "get">>;
|
|
1100
|
+
}
|
|
1101
|
+
export interface TikTokProfileMusicResource {
|
|
1102
|
+
/**
|
|
1103
|
+
* List profile music
|
|
1104
|
+
*
|
|
1105
|
+
* Return sounds published by a public TikTok profile. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1106
|
+
*
|
|
1107
|
+
* @example
|
|
1108
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").music.list({ freshness: "24h" });
|
|
1109
|
+
*
|
|
1110
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-music-list
|
|
1111
|
+
*/
|
|
1112
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/music", "get">) => Promise<OperationPage<"/v1/tiktok/profiles/{identifier}/music", "get">>;
|
|
1113
|
+
}
|
|
1114
|
+
export interface TikTokProfilePlaylistResource {
|
|
1115
|
+
readonly posts: TikTokProfilePlaylistPostsResource;
|
|
1116
|
+
/**
|
|
1117
|
+
* Get a playlist
|
|
1118
|
+
*
|
|
1119
|
+
* Get a playlist from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1120
|
+
*
|
|
1121
|
+
* @example
|
|
1122
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").playlist("950000000006").get({ freshness: "24h" });
|
|
1123
|
+
*
|
|
1124
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-playlist-get
|
|
1125
|
+
*/
|
|
1126
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/playlists/{playlist_id}", "get">) => Promise<OperationResponse<"/v1/tiktok/profiles/{identifier}/playlists/{playlist_id}", "get">>;
|
|
1127
|
+
}
|
|
1128
|
+
export interface TikTokProfilePlaylistPostsResource {
|
|
1129
|
+
/**
|
|
1130
|
+
* List playlist posts
|
|
1131
|
+
*
|
|
1132
|
+
* Return a cursor-paginated collection of posts in a public TikTok profile playlist. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1133
|
+
*
|
|
1134
|
+
* @example
|
|
1135
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").playlist("950000000006").posts.list({ freshness: "24h" });
|
|
1136
|
+
*
|
|
1137
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-playlist-posts-list
|
|
1138
|
+
*/
|
|
1139
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/playlists/{playlist_id}/posts", "get">) => Promise<OperationPage<"/v1/tiktok/profiles/{identifier}/playlists/{playlist_id}/posts", "get">>;
|
|
1140
|
+
}
|
|
1141
|
+
export interface TikTokProfilePlaylistsResource {
|
|
1142
|
+
/**
|
|
1143
|
+
* List profile playlists
|
|
1144
|
+
*
|
|
1145
|
+
* List profile playlists from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1146
|
+
*
|
|
1147
|
+
* @example
|
|
1148
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").playlists.list({ freshness: "24h" });
|
|
1149
|
+
*
|
|
1150
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-playlists-list
|
|
1151
|
+
*/
|
|
1152
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/playlists", "get">) => Promise<OperationPage<"/v1/tiktok/profiles/{identifier}/playlists", "get">>;
|
|
1153
|
+
}
|
|
1154
|
+
export interface TikTokProfilePostsResource {
|
|
1155
|
+
/**
|
|
1156
|
+
* List profile posts
|
|
1157
|
+
*
|
|
1158
|
+
* Return a stable page of posts for one public profile. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1159
|
+
*
|
|
1160
|
+
* @example
|
|
1161
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").posts.list({ freshness: "24h" });
|
|
1162
|
+
*
|
|
1163
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-posts-list
|
|
1164
|
+
*/
|
|
1165
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/tiktok/profiles/{identifier}/posts", "get">>;
|
|
1166
|
+
}
|
|
1167
|
+
export interface TikTokProfileQRCodeResource {
|
|
1168
|
+
/**
|
|
1169
|
+
* Get a profile QR code
|
|
1170
|
+
*
|
|
1171
|
+
* Get a profile QR code from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1172
|
+
*
|
|
1173
|
+
* @example
|
|
1174
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").qrCode.get({ freshness: "24h" });
|
|
1175
|
+
*
|
|
1176
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-qr-code-get
|
|
1177
|
+
*/
|
|
1178
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/qr-code", "get">) => Promise<OperationResponse<"/v1/tiktok/profiles/{identifier}/qr-code", "get">>;
|
|
1179
|
+
}
|
|
1180
|
+
export interface TikTokProfileStoriesResource {
|
|
1181
|
+
/**
|
|
1182
|
+
* List profile stories
|
|
1183
|
+
*
|
|
1184
|
+
* Return a cursor-paginated Tiktok profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1185
|
+
*
|
|
1186
|
+
* @example
|
|
1187
|
+
* await openhandle.tiktok.profile("@pixel_orchard_tt_test").stories.list({ freshness: "24h" });
|
|
1188
|
+
*
|
|
1189
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-profile-stories-list
|
|
1190
|
+
*/
|
|
1191
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/profiles/{identifier}/stories", "get">) => Promise<OperationPage<"/v1/tiktok/profiles/{identifier}/stories", "get">>;
|
|
1192
|
+
}
|
|
1193
|
+
export interface TikTokSearchResource {
|
|
1194
|
+
readonly commentSuggestions: TikTokSearchCommentSuggestionsResource;
|
|
1195
|
+
readonly hashtags: TikTokSearchHashtagsResource;
|
|
1196
|
+
readonly insights: TikTokSearchInsightsResource;
|
|
1197
|
+
readonly live: TikTokSearchLiveResource;
|
|
1198
|
+
readonly locations: TikTokSearchLocationsResource;
|
|
1199
|
+
readonly music: TikTokSearchMusicResource;
|
|
1200
|
+
readonly posts: TikTokSearchPostsResource;
|
|
1201
|
+
readonly profiles: TikTokSearchProfilesResource;
|
|
1202
|
+
readonly top: TikTokSearchTopResource;
|
|
1203
|
+
}
|
|
1204
|
+
export interface TikTokSearchCommentSuggestionsResource {
|
|
1205
|
+
/**
|
|
1206
|
+
* Search comment suggestions
|
|
1207
|
+
*
|
|
1208
|
+
* Search comment suggestions from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1209
|
+
*
|
|
1210
|
+
* @example
|
|
1211
|
+
* await openhandle.tiktok.search.commentSuggestions.list({ q: "synthetic", freshness: "24h" });
|
|
1212
|
+
*
|
|
1213
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-comment-suggestions-list
|
|
1214
|
+
*/
|
|
1215
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/comment-suggestions", "get">) => Promise<OperationPage<"/v1/tiktok/search/comment-suggestions", "get">>;
|
|
1216
|
+
}
|
|
1217
|
+
export interface TikTokSearchHashtagsResource {
|
|
1218
|
+
/**
|
|
1219
|
+
* Search Tiktok hashtags
|
|
1220
|
+
*
|
|
1221
|
+
* Search public Tiktok hashtags with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1222
|
+
*
|
|
1223
|
+
* @example
|
|
1224
|
+
* await openhandle.tiktok.search.hashtags.list({ q: "synthetic", freshness: "24h" });
|
|
1225
|
+
*
|
|
1226
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-hashtags-list
|
|
1227
|
+
*/
|
|
1228
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/hashtags", "get">) => Promise<OperationPage<"/v1/tiktok/search/hashtags", "get">>;
|
|
1229
|
+
}
|
|
1230
|
+
export interface TikTokSearchInsightsResource {
|
|
1231
|
+
/**
|
|
1232
|
+
* Search insights
|
|
1233
|
+
*
|
|
1234
|
+
* Search insights from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1235
|
+
*
|
|
1236
|
+
* @example
|
|
1237
|
+
* await openhandle.tiktok.search.insights.list({ q: "synthetic", freshness: "24h" });
|
|
1238
|
+
*
|
|
1239
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-insights-list
|
|
1240
|
+
*/
|
|
1241
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/insights", "get">) => Promise<OperationPage<"/v1/tiktok/search/insights", "get">>;
|
|
1242
|
+
}
|
|
1243
|
+
export interface TikTokSearchLiveResource {
|
|
1244
|
+
/**
|
|
1245
|
+
* Search live streams
|
|
1246
|
+
*
|
|
1247
|
+
* Search live streams from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1248
|
+
*
|
|
1249
|
+
* @example
|
|
1250
|
+
* await openhandle.tiktok.search.live.list({ q: "synthetic", freshness: "24h" });
|
|
1251
|
+
*
|
|
1252
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-live-list
|
|
1253
|
+
*/
|
|
1254
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/live", "get">) => Promise<OperationPage<"/v1/tiktok/search/live", "get">>;
|
|
1255
|
+
}
|
|
1256
|
+
export interface TikTokSearchLocationsResource {
|
|
1257
|
+
/**
|
|
1258
|
+
* Search Tiktok locations
|
|
1259
|
+
*
|
|
1260
|
+
* Search public Tiktok locations with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1261
|
+
*
|
|
1262
|
+
* @example
|
|
1263
|
+
* await openhandle.tiktok.search.locations.list({ q: "synthetic", freshness: "24h" });
|
|
1264
|
+
*
|
|
1265
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-locations-list
|
|
1266
|
+
*/
|
|
1267
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/locations", "get">) => Promise<OperationPage<"/v1/tiktok/search/locations", "get">>;
|
|
1268
|
+
}
|
|
1269
|
+
export interface TikTokSearchMusicResource {
|
|
1270
|
+
/**
|
|
1271
|
+
* Search Tiktok music
|
|
1272
|
+
*
|
|
1273
|
+
* Search public Tiktok music with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1274
|
+
*
|
|
1275
|
+
* @example
|
|
1276
|
+
* await openhandle.tiktok.search.music.list({ q: "synthetic", freshness: "24h" });
|
|
1277
|
+
*
|
|
1278
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-music-list
|
|
1279
|
+
*/
|
|
1280
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/music", "get">) => Promise<OperationPage<"/v1/tiktok/search/music", "get">>;
|
|
1281
|
+
}
|
|
1282
|
+
export interface TikTokSearchPostsResource {
|
|
1283
|
+
/**
|
|
1284
|
+
* Search Tiktok posts
|
|
1285
|
+
*
|
|
1286
|
+
* Search public Tiktok posts with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1287
|
+
*
|
|
1288
|
+
* @example
|
|
1289
|
+
* await openhandle.tiktok.search.posts.list({ q: "synthetic", freshness: "24h" });
|
|
1290
|
+
*
|
|
1291
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-posts-list
|
|
1292
|
+
*/
|
|
1293
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/posts", "get">) => Promise<OperationPage<"/v1/tiktok/search/posts", "get">>;
|
|
1294
|
+
}
|
|
1295
|
+
export interface TikTokSearchProfilesResource {
|
|
1296
|
+
/**
|
|
1297
|
+
* Search Tiktok profiles
|
|
1298
|
+
*
|
|
1299
|
+
* Search public Tiktok profiles with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1300
|
+
*
|
|
1301
|
+
* @example
|
|
1302
|
+
* await openhandle.tiktok.search.profiles.list({ q: "synthetic", freshness: "24h" });
|
|
1303
|
+
*
|
|
1304
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-profiles-list
|
|
1305
|
+
*/
|
|
1306
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/profiles", "get">) => Promise<OperationPage<"/v1/tiktok/search/profiles", "get">>;
|
|
1307
|
+
}
|
|
1308
|
+
export interface TikTokSearchTopResource {
|
|
1309
|
+
/**
|
|
1310
|
+
* Search all TikTok results
|
|
1311
|
+
*
|
|
1312
|
+
* Search all TikTok results from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1313
|
+
*
|
|
1314
|
+
* @example
|
|
1315
|
+
* await openhandle.tiktok.search.top.list({ q: "synthetic", freshness: "24h" });
|
|
1316
|
+
*
|
|
1317
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-search-top-list
|
|
1318
|
+
*/
|
|
1319
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/search/top", "get">) => Promise<OperationPage<"/v1/tiktok/search/top", "get">>;
|
|
1320
|
+
}
|
|
1321
|
+
export interface TikTokShopResource {
|
|
1322
|
+
readonly deals: TikTokShopDealsResource;
|
|
1323
|
+
readonly home: TikTokShopHomeResource;
|
|
1324
|
+
/**
|
|
1325
|
+
* Select the live resource using a supported string shorthand or an explicit ID or URL reference.
|
|
1326
|
+
*
|
|
1327
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1328
|
+
*/
|
|
1329
|
+
readonly live: (reference: ResourceReference) => TikTokShopLiveResource;
|
|
1330
|
+
/**
|
|
1331
|
+
* Select the product resource using a supported string shorthand or an explicit ID or URL reference.
|
|
1332
|
+
*
|
|
1333
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1334
|
+
*/
|
|
1335
|
+
readonly product: (reference: ResourceReference) => TikTokShopProductResource;
|
|
1336
|
+
/**
|
|
1337
|
+
* Select the profile resource using a username shorthand or an explicit ID or URL reference.
|
|
1338
|
+
*
|
|
1339
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1340
|
+
*/
|
|
1341
|
+
readonly profile: (reference: ProfileReference) => TikTokShopProfileResource;
|
|
1342
|
+
readonly recommendations: TikTokShopRecommendationsResource;
|
|
1343
|
+
readonly search: TikTokShopSearchResource;
|
|
1344
|
+
/**
|
|
1345
|
+
* Select the seller resource using a supported string shorthand or an explicit ID or URL reference.
|
|
1346
|
+
*
|
|
1347
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1348
|
+
*/
|
|
1349
|
+
readonly seller: (reference: ResourceReference) => TikTokShopSellerResource;
|
|
1350
|
+
}
|
|
1351
|
+
export interface TikTokShopDealsResource {
|
|
1352
|
+
readonly flashSale: TikTokShopDealsFlashSaleResource;
|
|
1353
|
+
readonly newUser: TikTokShopDealsNewUserResource;
|
|
1354
|
+
}
|
|
1355
|
+
export interface TikTokShopDealsFlashSaleResource {
|
|
1356
|
+
/**
|
|
1357
|
+
* List flash-sale products
|
|
1358
|
+
*
|
|
1359
|
+
* List flash-sale products from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1360
|
+
*
|
|
1361
|
+
* @example
|
|
1362
|
+
* await openhandle.tiktok.shop.deals.flashSale.list({ freshness: "24h" });
|
|
1363
|
+
*
|
|
1364
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-flash-sale-list
|
|
1365
|
+
*/
|
|
1366
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/deals/flash-sale", "get">) => Promise<OperationPage<"/v1/tiktok/shop/deals/flash-sale", "get">>;
|
|
1367
|
+
}
|
|
1368
|
+
export interface TikTokShopDealsNewUserResource {
|
|
1369
|
+
/**
|
|
1370
|
+
* List new-user deals
|
|
1371
|
+
*
|
|
1372
|
+
* List new-user deals from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1373
|
+
*
|
|
1374
|
+
* @example
|
|
1375
|
+
* await openhandle.tiktok.shop.deals.newUser.list({ freshness: "24h" });
|
|
1376
|
+
*
|
|
1377
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-new-user-deals-list
|
|
1378
|
+
*/
|
|
1379
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/deals/new-user", "get">) => Promise<OperationPage<"/v1/tiktok/shop/deals/new-user", "get">>;
|
|
1380
|
+
}
|
|
1381
|
+
export interface TikTokShopHomeResource {
|
|
1382
|
+
/**
|
|
1383
|
+
* List shop home sections
|
|
1384
|
+
*
|
|
1385
|
+
* List shop home sections from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1386
|
+
*
|
|
1387
|
+
* @example
|
|
1388
|
+
* await openhandle.tiktok.shop.home.list({ freshness: "24h" });
|
|
1389
|
+
*
|
|
1390
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-home-list
|
|
1391
|
+
*/
|
|
1392
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/home", "get">) => Promise<OperationPage<"/v1/tiktok/shop/home", "get">>;
|
|
1393
|
+
}
|
|
1394
|
+
export interface TikTokShopLiveResource {
|
|
1395
|
+
readonly products: TikTokShopLiveProductsResource;
|
|
1396
|
+
}
|
|
1397
|
+
export interface TikTokShopLiveProductsResource {
|
|
1398
|
+
/**
|
|
1399
|
+
* List livestream products
|
|
1400
|
+
*
|
|
1401
|
+
* List livestream products from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1402
|
+
*
|
|
1403
|
+
* @example
|
|
1404
|
+
* await openhandle.tiktok.shop.live("920100000000000001").products.list({ roomId: "950000000009", freshness: "24h" });
|
|
1405
|
+
*
|
|
1406
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-live-products-list
|
|
1407
|
+
*/
|
|
1408
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/shop/live/{identifier}/products", "get">) => Promise<OperationPage<"/v1/tiktok/shop/live/{identifier}/products", "get">>;
|
|
1409
|
+
}
|
|
1410
|
+
export interface TikTokShopProductResource {
|
|
1411
|
+
readonly reviews: TikTokShopProductReviewsResource;
|
|
1412
|
+
/**
|
|
1413
|
+
* Get a shop product
|
|
1414
|
+
*
|
|
1415
|
+
* Get a shop product from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1416
|
+
*
|
|
1417
|
+
* @example
|
|
1418
|
+
* await openhandle.tiktok.shop.product("920100000000000001").get({ freshness: "24h" });
|
|
1419
|
+
*
|
|
1420
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-product-get
|
|
1421
|
+
*/
|
|
1422
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/shop/products/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/shop/products/{identifier}", "get">>;
|
|
1423
|
+
}
|
|
1424
|
+
export interface TikTokShopProductReviewsResource {
|
|
1425
|
+
/**
|
|
1426
|
+
* List product reviews
|
|
1427
|
+
*
|
|
1428
|
+
* List product reviews from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1429
|
+
*
|
|
1430
|
+
* @example
|
|
1431
|
+
* await openhandle.tiktok.shop.product("920100000000000001").reviews.list({ freshness: "24h" });
|
|
1432
|
+
*
|
|
1433
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-product-reviews-list
|
|
1434
|
+
*/
|
|
1435
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/products/{identifier}/reviews", "get">) => Promise<OperationPage<"/v1/tiktok/shop/products/{identifier}/reviews", "get">>;
|
|
1436
|
+
}
|
|
1437
|
+
export interface TikTokShopProfileResource {
|
|
1438
|
+
readonly page: TikTokShopProfilePageResource;
|
|
1439
|
+
readonly products: TikTokShopProfileProductsResource;
|
|
1440
|
+
readonly tabs: TikTokShopProfileTabsResource;
|
|
1441
|
+
}
|
|
1442
|
+
export interface TikTokShopProfilePageResource {
|
|
1443
|
+
/**
|
|
1444
|
+
* List seller page products
|
|
1445
|
+
*
|
|
1446
|
+
* List seller page products from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1447
|
+
*
|
|
1448
|
+
* @example
|
|
1449
|
+
* await openhandle.tiktok.shop.profile("@pixel_orchard_tt_test").page.list({ freshness: "24h" });
|
|
1450
|
+
*
|
|
1451
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-profile-page-list
|
|
1452
|
+
*/
|
|
1453
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/profiles/{identifier}/page", "get">) => Promise<OperationPage<"/v1/tiktok/shop/profiles/{identifier}/page", "get">>;
|
|
1454
|
+
}
|
|
1455
|
+
export interface TikTokShopProfileProductsResource {
|
|
1456
|
+
/**
|
|
1457
|
+
* List profile shop products
|
|
1458
|
+
*
|
|
1459
|
+
* List profile shop products from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1460
|
+
*
|
|
1461
|
+
* @example
|
|
1462
|
+
* await openhandle.tiktok.shop.profile("@pixel_orchard_tt_test").products.list({ freshness: "24h" });
|
|
1463
|
+
*
|
|
1464
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-profile-products-list
|
|
1465
|
+
*/
|
|
1466
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/profiles/{identifier}/products", "get">) => Promise<OperationPage<"/v1/tiktok/shop/profiles/{identifier}/products", "get">>;
|
|
1467
|
+
}
|
|
1468
|
+
export interface TikTokShopProfileTabsResource {
|
|
1469
|
+
/**
|
|
1470
|
+
* List seller tabs
|
|
1471
|
+
*
|
|
1472
|
+
* List seller tabs from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1473
|
+
*
|
|
1474
|
+
* @example
|
|
1475
|
+
* await openhandle.tiktok.shop.profile("@pixel_orchard_tt_test").tabs.list({ freshness: "24h" });
|
|
1476
|
+
*
|
|
1477
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-profile-tabs-list
|
|
1478
|
+
*/
|
|
1479
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/profiles/{identifier}/tabs", "get">) => Promise<OperationPage<"/v1/tiktok/shop/profiles/{identifier}/tabs", "get">>;
|
|
1480
|
+
}
|
|
1481
|
+
export interface TikTokShopRecommendationsResource {
|
|
1482
|
+
/**
|
|
1483
|
+
* List recommended shop products
|
|
1484
|
+
*
|
|
1485
|
+
* List recommended shop products from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1486
|
+
*
|
|
1487
|
+
* @example
|
|
1488
|
+
* await openhandle.tiktok.shop.recommendations.list({ categoryId: "950000000008", freshness: "24h" });
|
|
1489
|
+
*
|
|
1490
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-recommendations-list
|
|
1491
|
+
*/
|
|
1492
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/shop/recommendations", "get">) => Promise<OperationPage<"/v1/tiktok/shop/recommendations", "get">>;
|
|
1493
|
+
}
|
|
1494
|
+
export interface TikTokShopSearchResource {
|
|
1495
|
+
/**
|
|
1496
|
+
* Search shop products
|
|
1497
|
+
*
|
|
1498
|
+
* Search shop products from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1499
|
+
*
|
|
1500
|
+
* @example
|
|
1501
|
+
* await openhandle.tiktok.shop.search.list({ q: "synthetic", freshness: "24h" });
|
|
1502
|
+
*
|
|
1503
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-search-list
|
|
1504
|
+
*/
|
|
1505
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/shop/search", "get">) => Promise<OperationPage<"/v1/tiktok/shop/search", "get">>;
|
|
1506
|
+
}
|
|
1507
|
+
export interface TikTokShopSellerResource {
|
|
1508
|
+
readonly categories: TikTokShopSellerCategoriesResource;
|
|
1509
|
+
/**
|
|
1510
|
+
* Select the category resource using a supported string shorthand or an explicit ID or URL reference.
|
|
1511
|
+
*
|
|
1512
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1513
|
+
*/
|
|
1514
|
+
readonly category: (reference: ResourceReference) => TikTokShopSellerCategoryResource;
|
|
1515
|
+
readonly products: TikTokShopSellerProductsResource;
|
|
1516
|
+
readonly sortTypes: TikTokShopSellerSortTypesResource;
|
|
1517
|
+
/**
|
|
1518
|
+
* Get a seller
|
|
1519
|
+
*
|
|
1520
|
+
* Get a seller from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1521
|
+
*
|
|
1522
|
+
* @example
|
|
1523
|
+
* await openhandle.tiktok.shop.seller("920100000000000001").get({ freshness: "24h" });
|
|
1524
|
+
*
|
|
1525
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-seller-get
|
|
1526
|
+
*/
|
|
1527
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/shop/sellers/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/shop/sellers/{identifier}", "get">>;
|
|
1528
|
+
}
|
|
1529
|
+
export interface TikTokShopSellerCategoriesResource {
|
|
1530
|
+
/**
|
|
1531
|
+
* List seller categories
|
|
1532
|
+
*
|
|
1533
|
+
* List seller categories from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1534
|
+
*
|
|
1535
|
+
* @example
|
|
1536
|
+
* await openhandle.tiktok.shop.seller("920100000000000001").categories.list({ freshness: "24h" });
|
|
1537
|
+
*
|
|
1538
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-seller-categories-list
|
|
1539
|
+
*/
|
|
1540
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/sellers/{identifier}/categories", "get">) => Promise<OperationPage<"/v1/tiktok/shop/sellers/{identifier}/categories", "get">>;
|
|
1541
|
+
}
|
|
1542
|
+
export interface TikTokShopSellerCategoryResource {
|
|
1543
|
+
readonly products: TikTokShopSellerCategoryProductsResource;
|
|
1544
|
+
}
|
|
1545
|
+
export interface TikTokShopSellerCategoryProductsResource {
|
|
1546
|
+
/**
|
|
1547
|
+
* List seller category products
|
|
1548
|
+
*
|
|
1549
|
+
* List seller category products from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1550
|
+
*
|
|
1551
|
+
* @example
|
|
1552
|
+
* await openhandle.tiktok.shop.seller("920100000000000001").category("950000000008").products.list({ productSourceType: "0", freshness: "24h" });
|
|
1553
|
+
*
|
|
1554
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-seller-category-products-list
|
|
1555
|
+
*/
|
|
1556
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/shop/sellers/{identifier}/categories/{category_id}/products", "get">) => Promise<OperationPage<"/v1/tiktok/shop/sellers/{identifier}/categories/{category_id}/products", "get">>;
|
|
1557
|
+
}
|
|
1558
|
+
export interface TikTokShopSellerProductsResource {
|
|
1559
|
+
/**
|
|
1560
|
+
* List seller products
|
|
1561
|
+
*
|
|
1562
|
+
* List seller products from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1563
|
+
*
|
|
1564
|
+
* @example
|
|
1565
|
+
* await openhandle.tiktok.shop.seller("920100000000000001").products.list({ freshness: "24h" });
|
|
1566
|
+
*
|
|
1567
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-seller-products-list
|
|
1568
|
+
*/
|
|
1569
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/sellers/{identifier}/products", "get">) => Promise<OperationPage<"/v1/tiktok/shop/sellers/{identifier}/products", "get">>;
|
|
1570
|
+
}
|
|
1571
|
+
export interface TikTokShopSellerSortTypesResource {
|
|
1572
|
+
/**
|
|
1573
|
+
* List seller product sort types
|
|
1574
|
+
*
|
|
1575
|
+
* List seller product sort types from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1576
|
+
*
|
|
1577
|
+
* @example
|
|
1578
|
+
* await openhandle.tiktok.shop.seller("920100000000000001").sortTypes.list({ freshness: "24h" });
|
|
1579
|
+
*
|
|
1580
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-shop-seller-sort-types-list
|
|
1581
|
+
*/
|
|
1582
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/shop/sellers/{identifier}/sort-types", "get">) => Promise<OperationPage<"/v1/tiktok/shop/sellers/{identifier}/sort-types", "get">>;
|
|
1583
|
+
}
|
|
1584
|
+
export interface TikTokStoryResource {
|
|
1585
|
+
/**
|
|
1586
|
+
* Get a story
|
|
1587
|
+
*
|
|
1588
|
+
* Return one public TikTok story by its native identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1589
|
+
*
|
|
1590
|
+
* @example
|
|
1591
|
+
* await openhandle.tiktok.story("920100000000000001").get({ freshness: "24h" });
|
|
1592
|
+
*
|
|
1593
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-story-get
|
|
1594
|
+
*/
|
|
1595
|
+
readonly get: (options?: OperationOptions<"/v1/tiktok/stories/{identifier}", "get">) => Promise<OperationResponse<"/v1/tiktok/stories/{identifier}", "get">>;
|
|
1596
|
+
}
|
|
1597
|
+
export interface TikTokTrendingResource {
|
|
1598
|
+
readonly categories: TikTokTrendingCategoriesResource;
|
|
1599
|
+
readonly insights: TikTokTrendingInsightsResource;
|
|
1600
|
+
readonly music: TikTokTrendingMusicResource;
|
|
1601
|
+
readonly posts: TikTokTrendingPostsResource;
|
|
1602
|
+
}
|
|
1603
|
+
export interface TikTokTrendingCategoriesResource {
|
|
1604
|
+
/**
|
|
1605
|
+
* List trending categories
|
|
1606
|
+
*
|
|
1607
|
+
* Return TikTok trending categories. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1608
|
+
*
|
|
1609
|
+
* @example
|
|
1610
|
+
* await openhandle.tiktok.trending.categories.list({ freshness: "24h" });
|
|
1611
|
+
*
|
|
1612
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-trending-categories-list
|
|
1613
|
+
*/
|
|
1614
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/trending/categories", "get">) => Promise<OperationPage<"/v1/tiktok/trending/categories", "get">>;
|
|
1615
|
+
}
|
|
1616
|
+
export interface TikTokTrendingInsightsResource {
|
|
1617
|
+
/**
|
|
1618
|
+
* List trending insights
|
|
1619
|
+
*
|
|
1620
|
+
* List trending insights from public Tiktok data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1621
|
+
*
|
|
1622
|
+
* @example
|
|
1623
|
+
* await openhandle.tiktok.trending.insights.list({ tab: "synthetic", freshness: "24h" });
|
|
1624
|
+
*
|
|
1625
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-trending-insights-list
|
|
1626
|
+
*/
|
|
1627
|
+
readonly list: (options: OperationOptions<"/v1/tiktok/trending/insights", "get">) => Promise<OperationPage<"/v1/tiktok/trending/insights", "get">>;
|
|
1628
|
+
}
|
|
1629
|
+
export interface TikTokTrendingMusicResource {
|
|
1630
|
+
/**
|
|
1631
|
+
* List trending music
|
|
1632
|
+
*
|
|
1633
|
+
* Return TikTok's public Top 50 music chart for the configured provider region. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1634
|
+
*
|
|
1635
|
+
* @example
|
|
1636
|
+
* await openhandle.tiktok.trending.music.list({ freshness: "24h" });
|
|
1637
|
+
*
|
|
1638
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-trending-music-list
|
|
1639
|
+
*/
|
|
1640
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/trending/music", "get">) => Promise<OperationResponse<"/v1/tiktok/trending/music", "get">>;
|
|
1641
|
+
}
|
|
1642
|
+
export interface TikTokTrendingPostsResource {
|
|
1643
|
+
/**
|
|
1644
|
+
* List trending posts
|
|
1645
|
+
*
|
|
1646
|
+
* Return TikTok's public recommended feed. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1647
|
+
*
|
|
1648
|
+
* @example
|
|
1649
|
+
* await openhandle.tiktok.trending.posts.list({ freshness: "24h" });
|
|
1650
|
+
*
|
|
1651
|
+
* @see https://openhandle.dev/docs/api-reference/tiktok-trending-posts-list
|
|
1652
|
+
*/
|
|
1653
|
+
readonly list: (options?: OperationOptions<"/v1/tiktok/trending/posts", "get">) => Promise<OperationPage<"/v1/tiktok/trending/posts", "get">>;
|
|
1654
|
+
}
|
|
1655
|
+
export interface TwitterResource {
|
|
1656
|
+
/**
|
|
1657
|
+
* Select the list resource using a supported string shorthand or an explicit ID or URL reference.
|
|
1658
|
+
*
|
|
1659
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1660
|
+
*/
|
|
1661
|
+
readonly list: (reference: ResourceReference) => TwitterListResource;
|
|
1662
|
+
/**
|
|
1663
|
+
* Select the post resource using a supported string shorthand or an explicit ID or URL reference.
|
|
1664
|
+
*
|
|
1665
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1666
|
+
*/
|
|
1667
|
+
readonly post: (reference: ResourceReference) => TwitterPostResource;
|
|
1668
|
+
/**
|
|
1669
|
+
* Select the profile resource using a username shorthand or an explicit ID or URL reference.
|
|
1670
|
+
*
|
|
1671
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1672
|
+
*/
|
|
1673
|
+
readonly profile: (reference: ProfileReference) => TwitterProfileResource;
|
|
1674
|
+
readonly search: TwitterSearchResource;
|
|
1675
|
+
}
|
|
1676
|
+
export interface TwitterListResource {
|
|
1677
|
+
readonly members: TwitterListMembersResource;
|
|
1678
|
+
readonly posts: TwitterListPostsResource;
|
|
1679
|
+
/**
|
|
1680
|
+
* Get a Twitter list
|
|
1681
|
+
*
|
|
1682
|
+
* Return one public Twitter list by its native identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1683
|
+
*
|
|
1684
|
+
* @example
|
|
1685
|
+
* await openhandle.twitter.list("950000000005").get({ freshness: "24h" });
|
|
1686
|
+
*
|
|
1687
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-list-get
|
|
1688
|
+
*/
|
|
1689
|
+
readonly get: (options?: OperationOptions<"/v1/twitter/lists/{identifier}", "get">) => Promise<OperationResponse<"/v1/twitter/lists/{identifier}", "get">>;
|
|
1690
|
+
}
|
|
1691
|
+
export interface TwitterListMembersResource {
|
|
1692
|
+
/**
|
|
1693
|
+
* List Twitter list members
|
|
1694
|
+
*
|
|
1695
|
+
* Return a cursor-paginated collection of Twitter list members. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1696
|
+
*
|
|
1697
|
+
* @example
|
|
1698
|
+
* await openhandle.twitter.list("950000000005").members.list({ freshness: "24h" });
|
|
1699
|
+
*
|
|
1700
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-list-members-list
|
|
1701
|
+
*/
|
|
1702
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/lists/{identifier}/members", "get">) => Promise<OperationPage<"/v1/twitter/lists/{identifier}/members", "get">>;
|
|
1703
|
+
}
|
|
1704
|
+
export interface TwitterListPostsResource {
|
|
1705
|
+
/**
|
|
1706
|
+
* List Twitter list posts
|
|
1707
|
+
*
|
|
1708
|
+
* Return the cursor-paginated timeline for a Twitter list. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1709
|
+
*
|
|
1710
|
+
* @example
|
|
1711
|
+
* await openhandle.twitter.list("950000000005").posts.list({ freshness: "24h" });
|
|
1712
|
+
*
|
|
1713
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-list-posts-list
|
|
1714
|
+
*/
|
|
1715
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/lists/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/twitter/lists/{identifier}/posts", "get">>;
|
|
1716
|
+
}
|
|
1717
|
+
export interface TwitterPostResource {
|
|
1718
|
+
/**
|
|
1719
|
+
* Select the comment resource using a supported string shorthand or an explicit ID or URL reference.
|
|
1720
|
+
*
|
|
1721
|
+
* Resource selection is synchronous and does not perform a request.
|
|
1722
|
+
*/
|
|
1723
|
+
readonly comment: (reference: ResourceReference) => TwitterPostCommentResource;
|
|
1724
|
+
readonly comments: TwitterPostCommentsResource;
|
|
1725
|
+
readonly likers: TwitterPostLikersResource;
|
|
1726
|
+
readonly reposters: TwitterPostRepostersResource;
|
|
1727
|
+
/**
|
|
1728
|
+
* Get a post
|
|
1729
|
+
*
|
|
1730
|
+
* Get a post by a canonical platform identifier. URLs must be converted before calling a data endpoint. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1731
|
+
*
|
|
1732
|
+
* @example
|
|
1733
|
+
* await openhandle.twitter.post("940100000000000001").get({ freshness: "24h" });
|
|
1734
|
+
*
|
|
1735
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-post-get
|
|
1736
|
+
*/
|
|
1737
|
+
readonly get: (options?: OperationOptions<"/v1/twitter/posts/{identifier}", "get">) => Promise<OperationResponse<"/v1/twitter/posts/{identifier}", "get">>;
|
|
1738
|
+
}
|
|
1739
|
+
export interface TwitterPostCommentResource {
|
|
1740
|
+
readonly replies: TwitterPostCommentRepliesResource;
|
|
1741
|
+
}
|
|
1742
|
+
export interface TwitterPostCommentRepliesResource {
|
|
1743
|
+
/**
|
|
1744
|
+
* List comment replies
|
|
1745
|
+
*
|
|
1746
|
+
* Return a stable page of replies for one comment. Use find_test_data to discover compatible post and comment IDs. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1747
|
+
*
|
|
1748
|
+
* @example
|
|
1749
|
+
* await openhandle.twitter.post("940100000000000001").comment("940200000000000001").replies.list({ freshness: "24h" });
|
|
1750
|
+
*
|
|
1751
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-comment-replies-list
|
|
1752
|
+
*/
|
|
1753
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/posts/{identifier}/comments/{comment_id}/replies", "get">) => Promise<OperationPage<"/v1/twitter/posts/{identifier}/comments/{comment_id}/replies", "get">>;
|
|
1754
|
+
}
|
|
1755
|
+
export interface TwitterPostCommentsResource {
|
|
1756
|
+
/**
|
|
1757
|
+
* List post comments
|
|
1758
|
+
*
|
|
1759
|
+
* List post comments by a canonical platform identifier. URLs must be converted before calling a data endpoint. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1760
|
+
*
|
|
1761
|
+
* @example
|
|
1762
|
+
* await openhandle.twitter.post("940100000000000001").comments.list({ freshness: "24h" });
|
|
1763
|
+
*
|
|
1764
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-post-comments-list
|
|
1765
|
+
*/
|
|
1766
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/posts/{identifier}/comments", "get">) => Promise<OperationPage<"/v1/twitter/posts/{identifier}/comments", "get">>;
|
|
1767
|
+
}
|
|
1768
|
+
export interface TwitterPostLikersResource {
|
|
1769
|
+
/**
|
|
1770
|
+
* List post likers
|
|
1771
|
+
*
|
|
1772
|
+
* Return public profiles that interacted with a Twitter post. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1773
|
+
*
|
|
1774
|
+
* @example
|
|
1775
|
+
* await openhandle.twitter.post("940100000000000001").likers.list({ freshness: "24h" });
|
|
1776
|
+
*
|
|
1777
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-post-likers-list
|
|
1778
|
+
*/
|
|
1779
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/posts/{identifier}/likers", "get">) => Promise<OperationPage<"/v1/twitter/posts/{identifier}/likers", "get">>;
|
|
1780
|
+
}
|
|
1781
|
+
export interface TwitterPostRepostersResource {
|
|
1782
|
+
/**
|
|
1783
|
+
* List post reposters
|
|
1784
|
+
*
|
|
1785
|
+
* Return public profiles that interacted with a Twitter post. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1786
|
+
*
|
|
1787
|
+
* @example
|
|
1788
|
+
* await openhandle.twitter.post("940100000000000001").reposters.list({ freshness: "24h" });
|
|
1789
|
+
*
|
|
1790
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-post-reposters-list
|
|
1791
|
+
*/
|
|
1792
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/posts/{identifier}/reposters", "get">) => Promise<OperationPage<"/v1/twitter/posts/{identifier}/reposters", "get">>;
|
|
1793
|
+
}
|
|
1794
|
+
export interface TwitterProfileResource {
|
|
1795
|
+
readonly followers: TwitterProfileFollowersResource;
|
|
1796
|
+
readonly following: TwitterProfileFollowingResource;
|
|
1797
|
+
readonly lists: TwitterProfileListsResource;
|
|
1798
|
+
readonly media: TwitterProfileMediaResource;
|
|
1799
|
+
readonly posts: TwitterProfilePostsResource;
|
|
1800
|
+
readonly replies: TwitterProfileRepliesResource;
|
|
1801
|
+
/**
|
|
1802
|
+
* Get a profile
|
|
1803
|
+
*
|
|
1804
|
+
* Return one public profile. Use @username or a platform ID as the identifier. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1805
|
+
*
|
|
1806
|
+
* @example
|
|
1807
|
+
* await openhandle.twitter.profile("@copperfield_lab_x_test").get({ freshness: "24h" });
|
|
1808
|
+
*
|
|
1809
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-profile-get
|
|
1810
|
+
*/
|
|
1811
|
+
readonly get: (options?: OperationOptions<"/v1/twitter/profiles/{identifier}", "get">) => Promise<OperationResponse<"/v1/twitter/profiles/{identifier}", "get">>;
|
|
1812
|
+
}
|
|
1813
|
+
export interface TwitterProfileFollowersResource {
|
|
1814
|
+
/**
|
|
1815
|
+
* List profile followers
|
|
1816
|
+
*
|
|
1817
|
+
* Return a cursor-paginated collection of Twitter profiles. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1818
|
+
*
|
|
1819
|
+
* @example
|
|
1820
|
+
* await openhandle.twitter.profile("@copperfield_lab_x_test").followers.list({ freshness: "24h" });
|
|
1821
|
+
*
|
|
1822
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-profile-followers-list
|
|
1823
|
+
*/
|
|
1824
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/profiles/{identifier}/followers", "get">) => Promise<OperationPage<"/v1/twitter/profiles/{identifier}/followers", "get">>;
|
|
1825
|
+
}
|
|
1826
|
+
export interface TwitterProfileFollowingResource {
|
|
1827
|
+
/**
|
|
1828
|
+
* List profile following
|
|
1829
|
+
*
|
|
1830
|
+
* Return a cursor-paginated collection of Twitter profiles. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1831
|
+
*
|
|
1832
|
+
* @example
|
|
1833
|
+
* await openhandle.twitter.profile("@copperfield_lab_x_test").following.list({ freshness: "24h" });
|
|
1834
|
+
*
|
|
1835
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-profile-following-list
|
|
1836
|
+
*/
|
|
1837
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/profiles/{identifier}/following", "get">) => Promise<OperationPage<"/v1/twitter/profiles/{identifier}/following", "get">>;
|
|
1838
|
+
}
|
|
1839
|
+
export interface TwitterProfileListsResource {
|
|
1840
|
+
/**
|
|
1841
|
+
* List profile lists
|
|
1842
|
+
*
|
|
1843
|
+
* Return a cursor-paginated collection of public Twitter lists owned by a profile. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1844
|
+
*
|
|
1845
|
+
* @example
|
|
1846
|
+
* await openhandle.twitter.profile("@copperfield_lab_x_test").lists.list({ freshness: "24h" });
|
|
1847
|
+
*
|
|
1848
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-profile-lists-list
|
|
1849
|
+
*/
|
|
1850
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/profiles/{identifier}/lists", "get">) => Promise<OperationPage<"/v1/twitter/profiles/{identifier}/lists", "get">>;
|
|
1851
|
+
}
|
|
1852
|
+
export interface TwitterProfileMediaResource {
|
|
1853
|
+
/**
|
|
1854
|
+
* List profile media
|
|
1855
|
+
*
|
|
1856
|
+
* Return a cursor-paginated Twitter profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1857
|
+
*
|
|
1858
|
+
* @example
|
|
1859
|
+
* await openhandle.twitter.profile("@copperfield_lab_x_test").media.list({ freshness: "24h" });
|
|
1860
|
+
*
|
|
1861
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-profile-media-list
|
|
1862
|
+
*/
|
|
1863
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/profiles/{identifier}/media", "get">) => Promise<OperationPage<"/v1/twitter/profiles/{identifier}/media", "get">>;
|
|
1864
|
+
}
|
|
1865
|
+
export interface TwitterProfilePostsResource {
|
|
1866
|
+
/**
|
|
1867
|
+
* List profile posts
|
|
1868
|
+
*
|
|
1869
|
+
* Return a stable page of posts for one public profile. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1870
|
+
*
|
|
1871
|
+
* @example
|
|
1872
|
+
* await openhandle.twitter.profile("@copperfield_lab_x_test").posts.list({ freshness: "24h" });
|
|
1873
|
+
*
|
|
1874
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-profile-posts-list
|
|
1875
|
+
*/
|
|
1876
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/profiles/{identifier}/posts", "get">) => Promise<OperationPage<"/v1/twitter/profiles/{identifier}/posts", "get">>;
|
|
1877
|
+
}
|
|
1878
|
+
export interface TwitterProfileRepliesResource {
|
|
1879
|
+
/**
|
|
1880
|
+
* List profile replies
|
|
1881
|
+
*
|
|
1882
|
+
* Return a cursor-paginated Twitter profile collection. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1883
|
+
*
|
|
1884
|
+
* @example
|
|
1885
|
+
* await openhandle.twitter.profile("@copperfield_lab_x_test").replies.list({ freshness: "24h" });
|
|
1886
|
+
*
|
|
1887
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-profile-replies-list
|
|
1888
|
+
*/
|
|
1889
|
+
readonly list: (options?: OperationOptions<"/v1/twitter/profiles/{identifier}/replies", "get">) => Promise<OperationPage<"/v1/twitter/profiles/{identifier}/replies", "get">>;
|
|
1890
|
+
}
|
|
1891
|
+
export interface TwitterSearchResource {
|
|
1892
|
+
readonly media: TwitterSearchMediaResource;
|
|
1893
|
+
readonly posts: TwitterSearchPostsResource;
|
|
1894
|
+
readonly suggestions: TwitterSearchSuggestionsResource;
|
|
1895
|
+
readonly users: TwitterSearchUsersResource;
|
|
1896
|
+
}
|
|
1897
|
+
export interface TwitterSearchMediaResource {
|
|
1898
|
+
/**
|
|
1899
|
+
* Search Twitter media
|
|
1900
|
+
*
|
|
1901
|
+
* Search public Twitter media with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1902
|
+
*
|
|
1903
|
+
* @example
|
|
1904
|
+
* await openhandle.twitter.search.media.list({ q: "synthetic", type: "image", freshness: "24h" });
|
|
1905
|
+
*
|
|
1906
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-search-media-list
|
|
1907
|
+
*/
|
|
1908
|
+
readonly list: (options: OperationOptions<"/v1/twitter/search/media", "get">) => Promise<OperationPage<"/v1/twitter/search/media", "get">>;
|
|
1909
|
+
}
|
|
1910
|
+
export interface TwitterSearchPostsResource {
|
|
1911
|
+
/**
|
|
1912
|
+
* Search Twitter posts
|
|
1913
|
+
*
|
|
1914
|
+
* Search public Twitter posts with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1915
|
+
*
|
|
1916
|
+
* @example
|
|
1917
|
+
* await openhandle.twitter.search.posts.list({ q: "synthetic", freshness: "24h" });
|
|
1918
|
+
*
|
|
1919
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-search-posts-list
|
|
1920
|
+
*/
|
|
1921
|
+
readonly list: (options: OperationOptions<"/v1/twitter/search/posts", "get">) => Promise<OperationPage<"/v1/twitter/search/posts", "get">>;
|
|
1922
|
+
}
|
|
1923
|
+
export interface TwitterSearchSuggestionsResource {
|
|
1924
|
+
/**
|
|
1925
|
+
* Search suggestions
|
|
1926
|
+
*
|
|
1927
|
+
* Search suggestions from public Twitter data. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1928
|
+
*
|
|
1929
|
+
* @example
|
|
1930
|
+
* await openhandle.twitter.search.suggestions.list({ q: "synthetic", freshness: "24h" });
|
|
1931
|
+
*
|
|
1932
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-search-suggestions-list
|
|
1933
|
+
*/
|
|
1934
|
+
readonly list: (options: OperationOptions<"/v1/twitter/search/suggestions", "get">) => Promise<OperationPage<"/v1/twitter/search/suggestions", "get">>;
|
|
1935
|
+
}
|
|
1936
|
+
export interface TwitterSearchUsersResource {
|
|
1937
|
+
/**
|
|
1938
|
+
* Search Twitter users
|
|
1939
|
+
*
|
|
1940
|
+
* Search public Twitter users with cursor pagination. Test and Live use the same route, parameters, response schema, pagination, and errors. In Test, null means unavailable, not zero.
|
|
1941
|
+
*
|
|
1942
|
+
* @example
|
|
1943
|
+
* await openhandle.twitter.search.users.list({ q: "synthetic", freshness: "24h" });
|
|
1944
|
+
*
|
|
1945
|
+
* @see https://openhandle.dev/docs/api-reference/twitter-search-users-list
|
|
1946
|
+
*/
|
|
1947
|
+
readonly list: (options: OperationOptions<"/v1/twitter/search/users", "get">) => Promise<OperationPage<"/v1/twitter/search/users", "get">>;
|
|
1948
|
+
}
|
|
1949
|
+
//# sourceMappingURL=resources.d.ts.map
|