@short.io/client-node 2.2.0 → 3.0.4

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.
Files changed (74) hide show
  1. package/README.md +747 -28
  2. package/dist/generated/client/client.gen.d.ts +2 -0
  3. package/dist/generated/client/client.gen.js +225 -0
  4. package/dist/generated/client/client.gen.js.map +1 -0
  5. package/dist/generated/client/index.d.ts +8 -4
  6. package/dist/generated/client/index.js +5 -115
  7. package/dist/generated/client/index.js.map +1 -1
  8. package/dist/generated/client/types.gen.d.ts +68 -0
  9. package/dist/generated/client/types.gen.js.map +1 -0
  10. package/dist/generated/client/utils.gen.d.ts +30 -0
  11. package/dist/generated/client/utils.gen.js +224 -0
  12. package/dist/generated/client/utils.gen.js.map +1 -0
  13. package/dist/generated/client.gen.d.ts +4 -0
  14. package/dist/generated/client.gen.js +3 -0
  15. package/dist/generated/client.gen.js.map +1 -0
  16. package/dist/generated/core/auth.gen.d.ts +8 -0
  17. package/dist/generated/core/auth.gen.js +14 -0
  18. package/dist/generated/core/auth.gen.js.map +1 -0
  19. package/dist/generated/core/bodySerializer.gen.d.ts +21 -0
  20. package/dist/generated/core/bodySerializer.gen.js +57 -0
  21. package/dist/generated/core/bodySerializer.gen.js.map +1 -0
  22. package/dist/generated/core/params.gen.d.ts +26 -0
  23. package/dist/generated/core/params.gen.js +100 -0
  24. package/dist/generated/core/params.gen.js.map +1 -0
  25. package/dist/generated/core/pathSerializer.gen.d.ts +30 -0
  26. package/dist/generated/core/pathSerializer.gen.js +114 -0
  27. package/dist/generated/core/pathSerializer.gen.js.map +1 -0
  28. package/dist/generated/core/queryKeySerializer.gen.d.ts +6 -0
  29. package/dist/generated/core/queryKeySerializer.gen.js +84 -0
  30. package/dist/generated/core/queryKeySerializer.gen.js.map +1 -0
  31. package/dist/generated/core/serverSentEvents.gen.d.ts +23 -0
  32. package/dist/generated/core/serverSentEvents.gen.js +131 -0
  33. package/dist/generated/core/serverSentEvents.gen.js.map +1 -0
  34. package/dist/generated/core/types.gen.d.ts +32 -0
  35. package/dist/generated/core/types.gen.js +2 -0
  36. package/dist/generated/core/types.gen.js.map +1 -0
  37. package/dist/generated/core/utils.gen.d.ts +19 -0
  38. package/dist/generated/core/utils.gen.js +84 -0
  39. package/dist/generated/core/utils.gen.js.map +1 -0
  40. package/dist/generated/index.d.ts +2 -2
  41. package/dist/generated/index.js +1 -2
  42. package/dist/generated/index.js.map +1 -1
  43. package/dist/generated/sdk.gen.d.ts +48 -474
  44. package/dist/generated/sdk.gen.js +299 -322
  45. package/dist/generated/sdk.gen.js.map +1 -1
  46. package/dist/generated/types.gen.d.ts +699 -190
  47. package/dist/generated/types.gen.js.map +1 -1
  48. package/dist/index.js +1 -1
  49. package/dist/index.js.map +1 -1
  50. package/package.json +14 -15
  51. package/dist/client/index.d.ts +0 -4
  52. package/dist/client/index.js +0 -115
  53. package/dist/client/index.js.map +0 -1
  54. package/dist/client/types.d.ts +0 -78
  55. package/dist/client/types.js +0 -2
  56. package/dist/client/types.js.map +0 -1
  57. package/dist/client/utils.d.ts +0 -57
  58. package/dist/client/utils.js +0 -383
  59. package/dist/client/utils.js.map +0 -1
  60. package/dist/example.d.ts +0 -0
  61. package/dist/example.js +0 -1
  62. package/dist/example.js.map +0 -1
  63. package/dist/generated/client/types.d.ts +0 -78
  64. package/dist/generated/client/types.js +0 -2
  65. package/dist/generated/client/types.js.map +0 -1
  66. package/dist/generated/client/utils.d.ts +0 -57
  67. package/dist/generated/client/utils.js +0 -382
  68. package/dist/generated/client/utils.js.map +0 -1
  69. package/dist/sdk.gen.d.ts +0 -474
  70. package/dist/sdk.gen.js +0 -323
  71. package/dist/sdk.gen.js.map +0 -1
  72. package/dist/types.gen.d.ts +0 -1198
  73. package/dist/types.gen.js.map +0 -1
  74. /package/dist/{types.gen.js → generated/client/types.gen.js} +0 -0
@@ -1,474 +1,48 @@
1
- import { type Options } from './client/index.js';
2
- import type { GetLinksOpengraphByDomainIdByLinkIdData, PutLinksOpengraphByDomainIdByLinkIdData, GetLinkCountryByLinkIdData, PostLinkCountryByLinkIdData, PostLinkCountryBulkByLinkIdData, DeleteLinkCountryByLinkIdByCountryData, GetLinkRegionByLinkIdData, PostLinkRegionByLinkIdData, GetLinkRegionListByCountryData, PostLinkRegionBulkByLinkIdData, DeleteLinkRegionByLinkIdByCountryByRegionData, GetLinksPermissionsByDomainIdByLinkIdData, DeleteLinksPermissionsByDomainIdByLinkIdByUserIdData, DeleteLinksPermissionsByDomainIdByLinkIdByUserIdError, PostLinksPermissionsByDomainIdByLinkIdByUserIdData, PostLinksPermissionsByDomainIdByLinkIdByUserIdError, GetApiLinksData, PostLinksQrByLinkIdStringData, PostLinksQrBulkData, DeleteLinksByLinkIdData, DeleteLinksDeleteBulkData, PostLinksArchiveData, PostLinksArchiveBulkData, PostLinksUnarchiveData, PostLinksUnarchiveBulkData, GetLinksByLinkIdData, PostLinksByLinkIdData, PostLinksByLinkIdError, GetLinksExpandData, GetLinksByOriginalUrlData, GetLinksMultipleByUrlData, PostLinksData, GetLinksTweetbotData, PostLinksPublicData, PostLinksBulkData, GetApiDomainsData, GetDomainsByDomainIdData, PostDomainsData, PostDomainsError, PostDomainsSettingsByDomainIdData, PostTagsBulkData, GetLinksFoldersByDomainIdData, GetLinksFoldersByDomainIdByFolderIdData, PostLinksFoldersData } from './types.gen.js';
3
- export declare const client: import("./client/index.js").Client<Request, Response, unknown, import("./client/types.js").RequestOptions>;
4
- export declare const getLinksOpengraphByDomainIdByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinksOpengraphByDomainIdByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
5
- export declare const putLinksOpengraphByDomainIdByLinkId: <ThrowOnError extends boolean = false>(options: Options<PutLinksOpengraphByDomainIdByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
6
- export declare const getLinkCountryByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinkCountryByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
7
- export declare const postLinkCountryByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinkCountryByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
8
- export declare const postLinkCountryBulkByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinkCountryBulkByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
9
- export declare const deleteLinkCountryByLinkIdByCountry: <ThrowOnError extends boolean = false>(options: Options<DeleteLinkCountryByLinkIdByCountryData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
10
- export declare const getLinkRegionByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinkRegionByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
11
- export declare const postLinkRegionByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinkRegionByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
12
- export declare const getLinkRegionListByCountry: <ThrowOnError extends boolean = false>(options: Options<GetLinkRegionListByCountryData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
13
- export declare const postLinkRegionBulkByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinkRegionBulkByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
14
- export declare const deleteLinkRegionByLinkIdByCountryByRegion: <ThrowOnError extends boolean = false>(options: Options<DeleteLinkRegionByLinkIdByCountryByRegionData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
15
- export declare const getLinksPermissionsByDomainIdByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinksPermissionsByDomainIdByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
16
- id: string;
17
- DomainId: number;
18
- UserId: number;
19
- LinkIdString: string;
20
- }[], {
21
- error: string;
22
- }, ThrowOnError>;
23
- export declare const deleteLinksPermissionsByDomainIdByLinkIdByUserId: <ThrowOnError extends boolean = false>(options: Options<DeleteLinksPermissionsByDomainIdByLinkIdByUserIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
24
- success: boolean;
25
- }, DeleteLinksPermissionsByDomainIdByLinkIdByUserIdError, ThrowOnError>;
26
- export declare const postLinksPermissionsByDomainIdByLinkIdByUserId: <ThrowOnError extends boolean = false>(options: Options<PostLinksPermissionsByDomainIdByLinkIdByUserIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
27
- id: string;
28
- DomainId: number;
29
- UserId: number;
30
- LinkIdString: string;
31
- }, PostLinksPermissionsByDomainIdByLinkIdByUserIdError, ThrowOnError>;
32
- export declare const getApiLinks: <ThrowOnError extends boolean = false>(options: Options<GetApiLinksData, ThrowOnError>) => import("./client/index.js").RequestResult<{
33
- count: number;
34
- links: Array<{
35
- originalURL: string;
36
- cloaking?: boolean;
37
- password?: string;
38
- expiresAt?: number | string;
39
- expiredURL?: string;
40
- title?: string;
41
- tags?: Array<string>;
42
- utmSource?: string;
43
- utmMedium?: string;
44
- utmCampaign?: string;
45
- utmTerm?: string;
46
- utmContent?: string;
47
- ttl?: string | number;
48
- path: string;
49
- androidURL?: string;
50
- iphoneURL?: string;
51
- createdAt?: number | string;
52
- clicksLimit?: number;
53
- passwordContact?: boolean;
54
- skipQS?: boolean;
55
- archived?: boolean;
56
- splitURL?: string;
57
- splitPercent?: number;
58
- integrationAdroll?: string;
59
- integrationFB?: string;
60
- integrationGA?: string;
61
- integrationGTM?: string;
62
- idString: string;
63
- id: string;
64
- shortURL: string;
65
- secureShortURL: string;
66
- redirectType?: "301" | "302" | "307" | "308";
67
- FolderId?: string;
68
- DomainId?: number;
69
- OwnerId?: number;
70
- hasPassword?: boolean;
71
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
72
- User?: {
73
- id: number;
74
- name: string;
75
- email: string;
76
- photoURL: string;
77
- };
78
- }>;
79
- nextPageToken?: string;
80
- }, {
81
- error: string;
82
- }, ThrowOnError>;
83
- export declare const postLinksQrByLinkIdString: <ThrowOnError extends boolean = false>(options: Options<PostLinksQrByLinkIdStringData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
84
- export declare const postLinksQrBulk: <ThrowOnError extends boolean = false>(options: Options<PostLinksQrBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<Blob | File, unknown, ThrowOnError>;
85
- export declare const deleteLinksByLinkId: <ThrowOnError extends boolean = false>(options: Options<DeleteLinksByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
86
- success: boolean;
87
- idString?: string;
88
- error?: string;
89
- }, unknown, ThrowOnError>;
90
- export declare const deleteLinksDeleteBulk: <ThrowOnError extends boolean = false>(options: Options<DeleteLinksDeleteBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<{
91
- success: boolean;
92
- error?: string;
93
- }, unknown, ThrowOnError>;
94
- export declare const postLinksArchive: <ThrowOnError extends boolean = false>(options: Options<PostLinksArchiveData, ThrowOnError>) => import("./client/index.js").RequestResult<{
95
- success: boolean;
96
- error?: string;
97
- }, {
98
- error: string;
99
- message?: string;
100
- }, ThrowOnError>;
101
- export declare const postLinksArchiveBulk: <ThrowOnError extends boolean = false>(options: Options<PostLinksArchiveBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<{
102
- success: boolean;
103
- error?: string;
104
- }, {
105
- error: string;
106
- message?: string;
107
- }, ThrowOnError>;
108
- export declare const postLinksUnarchive: <ThrowOnError extends boolean = false>(options: Options<PostLinksUnarchiveData, ThrowOnError>) => import("./client/index.js").RequestResult<{
109
- success: boolean;
110
- error?: string;
111
- }, {
112
- error: string;
113
- message?: string;
114
- }, ThrowOnError>;
115
- export declare const postLinksUnarchiveBulk: <ThrowOnError extends boolean = false>(options: Options<PostLinksUnarchiveBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<{
116
- success: boolean;
117
- error?: string;
118
- }, {
119
- error: string;
120
- message?: string;
121
- }, ThrowOnError>;
122
- export declare const getLinksByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinksByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
123
- originalURL: string;
124
- cloaking?: boolean;
125
- password?: string;
126
- expiresAt?: number | string;
127
- expiredURL?: string;
128
- title?: string;
129
- tags?: Array<string>;
130
- utmSource?: string;
131
- utmMedium?: string;
132
- utmCampaign?: string;
133
- utmTerm?: string;
134
- utmContent?: string;
135
- ttl?: string | number;
136
- path: string;
137
- androidURL?: string;
138
- iphoneURL?: string;
139
- createdAt?: number | string;
140
- clicksLimit?: number;
141
- passwordContact?: boolean;
142
- skipQS?: boolean;
143
- archived?: boolean;
144
- splitURL?: string;
145
- splitPercent?: number;
146
- integrationAdroll?: string;
147
- integrationFB?: string;
148
- integrationGA?: string;
149
- integrationGTM?: string;
150
- idString: string;
151
- id: string;
152
- shortURL: string;
153
- secureShortURL: string;
154
- redirectType?: "301" | "302" | "307" | "308";
155
- FolderId?: string;
156
- DomainId?: number;
157
- OwnerId?: number;
158
- hasPassword?: boolean;
159
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
160
- User?: {
161
- id: number;
162
- name: string;
163
- email: string;
164
- photoURL: string;
165
- };
166
- }, {
167
- error: string;
168
- }, ThrowOnError>;
169
- export declare const postLinksByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinksByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
170
- originalURL: string;
171
- cloaking?: boolean;
172
- password?: string;
173
- expiresAt?: number | string;
174
- expiredURL?: string;
175
- title?: string;
176
- tags?: Array<string>;
177
- utmSource?: string;
178
- utmMedium?: string;
179
- utmCampaign?: string;
180
- utmTerm?: string;
181
- utmContent?: string;
182
- ttl?: string | number;
183
- path: string;
184
- androidURL?: string;
185
- iphoneURL?: string;
186
- createdAt?: number | string;
187
- clicksLimit?: number;
188
- passwordContact?: boolean;
189
- skipQS?: boolean;
190
- archived?: boolean;
191
- splitURL?: string;
192
- splitPercent?: number;
193
- integrationAdroll?: string;
194
- integrationFB?: string;
195
- integrationGA?: string;
196
- integrationGTM?: string;
197
- idString: string;
198
- id: string;
199
- shortURL: string;
200
- secureShortURL: string;
201
- redirectType?: "301" | "302" | "307" | "308";
202
- FolderId?: string;
203
- DomainId?: number;
204
- OwnerId?: number;
205
- hasPassword?: boolean;
206
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
207
- User?: {
208
- id: number;
209
- name: string;
210
- email: string;
211
- photoURL: string;
212
- };
213
- }, PostLinksByLinkIdError, ThrowOnError>;
214
- export declare const getLinksExpand: <ThrowOnError extends boolean = false>(options: Options<GetLinksExpandData, ThrowOnError>) => import("./client/index.js").RequestResult<{
215
- originalURL: string;
216
- cloaking?: boolean;
217
- password?: string;
218
- expiresAt?: number | string;
219
- expiredURL?: string;
220
- title?: string;
221
- tags?: Array<string>;
222
- utmSource?: string;
223
- utmMedium?: string;
224
- utmCampaign?: string;
225
- utmTerm?: string;
226
- utmContent?: string;
227
- ttl?: string | number;
228
- path: string;
229
- androidURL?: string;
230
- iphoneURL?: string;
231
- createdAt?: number | string;
232
- clicksLimit?: number;
233
- passwordContact?: boolean;
234
- skipQS?: boolean;
235
- archived?: boolean;
236
- splitURL?: string;
237
- splitPercent?: number;
238
- integrationAdroll?: string;
239
- integrationFB?: string;
240
- integrationGA?: string;
241
- integrationGTM?: string;
242
- idString: string;
243
- id: string;
244
- shortURL: string;
245
- secureShortURL: string;
246
- redirectType?: "301" | "302" | "307" | "308";
247
- FolderId?: string;
248
- DomainId?: number;
249
- OwnerId?: number;
250
- hasPassword?: boolean;
251
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
252
- User?: {
253
- id: number;
254
- name: string;
255
- email: string;
256
- photoURL: string;
257
- };
258
- }, {
259
- error: string;
260
- }, ThrowOnError>;
261
- export declare const getLinksByOriginalUrl: <ThrowOnError extends boolean = false>(options: Options<GetLinksByOriginalUrlData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
262
- export declare const getLinksMultipleByUrl: <ThrowOnError extends boolean = false>(options: Options<GetLinksMultipleByUrlData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
263
- export declare const postLinks: <ThrowOnError extends boolean = false>(options: Options<PostLinksData, ThrowOnError>) => import("./client/index.js").RequestResult<{
264
- originalURL: string;
265
- cloaking?: boolean;
266
- password?: string;
267
- expiresAt?: number | string;
268
- expiredURL?: string;
269
- title?: string;
270
- tags?: Array<string>;
271
- utmSource?: string;
272
- utmMedium?: string;
273
- utmCampaign?: string;
274
- utmTerm?: string;
275
- utmContent?: string;
276
- ttl?: string | number;
277
- path: string;
278
- androidURL?: string;
279
- iphoneURL?: string;
280
- createdAt?: number | string;
281
- clicksLimit?: number;
282
- passwordContact?: boolean;
283
- skipQS?: boolean;
284
- archived?: boolean;
285
- splitURL?: string;
286
- splitPercent?: number;
287
- integrationAdroll?: string;
288
- integrationFB?: string;
289
- integrationGA?: string;
290
- integrationGTM?: string;
291
- idString: string;
292
- id: string;
293
- shortURL: string;
294
- secureShortURL: string;
295
- redirectType?: "301" | "302" | "307" | "308";
296
- FolderId?: string;
297
- DomainId?: number;
298
- OwnerId?: number;
299
- hasPassword?: boolean;
300
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
301
- User?: {
302
- id: number;
303
- name: string;
304
- email: string;
305
- photoURL: string;
306
- };
307
- success?: boolean;
308
- duplicate?: boolean;
309
- }, {
310
- code?: string;
311
- message: string;
312
- success?: boolean;
313
- statusCode: number;
314
- }, ThrowOnError>;
315
- export declare const getLinksTweetbot: <ThrowOnError extends boolean = false>(options: Options<GetLinksTweetbotData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
316
- export declare const postLinksPublic: <ThrowOnError extends boolean = false>(options: Options<PostLinksPublicData, ThrowOnError>) => import("./client/index.js").RequestResult<{
317
- originalURL: string;
318
- cloaking?: boolean;
319
- password?: string;
320
- expiresAt?: number | string;
321
- expiredURL?: string;
322
- title?: string;
323
- tags?: Array<string>;
324
- utmSource?: string;
325
- utmMedium?: string;
326
- utmCampaign?: string;
327
- utmTerm?: string;
328
- utmContent?: string;
329
- ttl?: string | number;
330
- path: string;
331
- androidURL?: string;
332
- iphoneURL?: string;
333
- createdAt?: number | string;
334
- clicksLimit?: number;
335
- passwordContact?: boolean;
336
- skipQS?: boolean;
337
- archived?: boolean;
338
- splitURL?: string;
339
- splitPercent?: number;
340
- integrationAdroll?: string;
341
- integrationFB?: string;
342
- integrationGA?: string;
343
- integrationGTM?: string;
344
- idString: string;
345
- id: string;
346
- shortURL: string;
347
- secureShortURL: string;
348
- redirectType?: "301" | "302" | "307" | "308";
349
- FolderId?: string;
350
- DomainId?: number;
351
- OwnerId?: number;
352
- hasPassword?: boolean;
353
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
354
- User?: {
355
- id: number;
356
- name: string;
357
- email: string;
358
- photoURL: string;
359
- };
360
- success?: boolean;
361
- duplicate?: boolean;
362
- }, {
363
- code?: string;
364
- message: string;
365
- success?: boolean;
366
- statusCode: number;
367
- }, ThrowOnError>;
368
- export declare const postLinksBulk: <ThrowOnError extends boolean = false>(options: Options<PostLinksBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
369
- export declare const getApiDomains: <ThrowOnError extends boolean = false>(options?: Options<GetApiDomainsData, ThrowOnError>) => import("./client/index.js").RequestResult<{
370
- id: number;
371
- hostname: string;
372
- unicodeHostname: string;
373
- state: "extra_records" | "not_registered" | "configured" | "not_configured" | "registration_pending" | "not_verified";
374
- createdAt: string;
375
- updatedAt: string;
376
- TeamId?: number;
377
- hasFavicon: boolean;
378
- segmentKey?: string;
379
- hideReferer: boolean;
380
- linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
381
- cloaking: boolean;
382
- hideVisitorIp: boolean;
383
- enableAI: boolean;
384
- httpsLevel: "none" | "redirect" | "hsts";
385
- httpsLinks: boolean;
386
- webhookURL?: string;
387
- integrationGA?: string;
388
- integrationFB?: string;
389
- integrationAdroll?: string;
390
- integrationGTM?: string;
391
- clientStorage: {};
392
- caseSensitive: boolean;
393
- incrementCounter: string;
394
- robots: "allow" | "disallow" | "noindex";
395
- sslCertExpirationDate?: string;
396
- sslCertInstalledSuccess?: boolean;
397
- domainRegistrationId?: number;
398
- UserId?: number;
399
- exportEnabled: boolean;
400
- isFavorite: boolean;
401
- }[], unknown, ThrowOnError>;
402
- export declare const getDomainsByDomainId: <ThrowOnError extends boolean = false>(options: Options<GetDomainsByDomainIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
403
- id: number;
404
- hostname: string;
405
- unicodeHostname: string;
406
- state: "extra_records" | "not_registered" | "configured" | "not_configured" | "registration_pending" | "not_verified";
407
- createdAt: string;
408
- updatedAt: string;
409
- TeamId?: number;
410
- hasFavicon: boolean;
411
- segmentKey?: string;
412
- hideReferer: boolean;
413
- linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
414
- cloaking: boolean;
415
- hideVisitorIp: boolean;
416
- enableAI: boolean;
417
- httpsLevel: "none" | "redirect" | "hsts";
418
- httpsLinks: boolean;
419
- webhookURL?: string;
420
- integrationGA?: string;
421
- integrationFB?: string;
422
- integrationAdroll?: string;
423
- integrationGTM?: string;
424
- clientStorage: {};
425
- caseSensitive: boolean;
426
- incrementCounter: string;
427
- robots: "allow" | "disallow" | "noindex";
428
- sslCertExpirationDate?: string;
429
- sslCertInstalledSuccess?: boolean;
430
- domainRegistrationId?: number;
431
- UserId?: number;
432
- exportEnabled: boolean;
433
- ipExclusions: Array<string>;
434
- userPlan: "tiny" | "hobby" | "small" | "standard" | "large";
435
- }, {
436
- error: string;
437
- }, ThrowOnError>;
438
- export declare const postDomains: <ThrowOnError extends boolean = false>(options: Options<PostDomainsData, ThrowOnError>) => import("./client/index.js").RequestResult<{
439
- id: number;
440
- hostname: string;
441
- unicodeHostname: string;
442
- state: "extra_records" | "not_registered" | "configured" | "not_configured" | "registration_pending" | "not_verified";
443
- createdAt: string;
444
- updatedAt: string;
445
- TeamId?: number;
446
- hasFavicon: boolean;
447
- segmentKey?: string;
448
- hideReferer: boolean;
449
- linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
450
- cloaking: boolean;
451
- hideVisitorIp: boolean;
452
- enableAI: boolean;
453
- httpsLevel: "none" | "redirect" | "hsts";
454
- httpsLinks: boolean;
455
- webhookURL?: string;
456
- integrationGA?: string;
457
- integrationFB?: string;
458
- integrationAdroll?: string;
459
- integrationGTM?: string;
460
- clientStorage: {};
461
- caseSensitive: boolean;
462
- incrementCounter: string;
463
- robots: "allow" | "disallow" | "noindex";
464
- sslCertExpirationDate?: string;
465
- sslCertInstalledSuccess?: boolean;
466
- domainRegistrationId?: number;
467
- UserId?: number;
468
- exportEnabled: boolean;
469
- }, PostDomainsError, ThrowOnError>;
470
- export declare const postDomainsSettingsByDomainId: <ThrowOnError extends boolean = false>(options: Options<PostDomainsSettingsByDomainIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
471
- export declare const postTagsBulk: <ThrowOnError extends boolean = false>(options: Options<PostTagsBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
472
- export declare const getLinksFoldersByDomainId: <ThrowOnError extends boolean = false>(options: Options<GetLinksFoldersByDomainIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
473
- export declare const getLinksFoldersByDomainIdByFolderId: <ThrowOnError extends boolean = false>(options: Options<GetLinksFoldersByDomainIdByFolderIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
474
- export declare const postLinksFolders: <ThrowOnError extends boolean = false>(options: Options<PostLinksFoldersData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
1
+ import type { Client, Options as Options2, TDataShape } from './client/index.js';
2
+ import type { AddLinkPermissionData, AddLinkPermissionErrors, AddLinkPermissionResponses, AddTagsBulkData, AddTagsBulkResponses, ArchiveLinkData, ArchiveLinkErrors, ArchiveLinkResponses, ArchiveLinksBulkData, ArchiveLinksBulkErrors, ArchiveLinksBulkResponses, CreateDomainData, CreateDomainErrors, CreateDomainResponses, CreateExampleLinksData, CreateExampleLinksErrors, CreateExampleLinksResponses, CreateFolderData, CreateFolderResponses, CreateLinkCountriesBulkData, CreateLinkCountriesBulkResponses, CreateLinkCountryData, CreateLinkCountryResponses, CreateLinkData, CreateLinkErrors, CreateLinkPublicData, CreateLinkPublicErrors, CreateLinkPublicResponses, CreateLinkRegionData, CreateLinkRegionResponses, CreateLinkRegionsBulkData, CreateLinkRegionsBulkResponses, CreateLinkResponses, CreateLinksBulkData, CreateLinksBulkResponses, CreateLinkSimpleData, CreateLinkSimpleResponses, DeleteLinkCountryData, DeleteLinkCountryResponses, DeleteLinkData, DeleteLinkErrors, DeleteLinkPermissionData, DeleteLinkPermissionErrors, DeleteLinkPermissionResponses, DeleteLinkRegionData, DeleteLinkRegionResponses, DeleteLinkResponses, DeleteLinksBulkData, DeleteLinksBulkResponses, DuplicateLinkData, DuplicateLinkErrors, DuplicateLinkResponses, ExpandLinkData, ExpandLinkErrors, ExpandLinkResponses, GenerateQrCodeData, GenerateQrCodeResponses, GenerateQrCodesBulkData, GenerateQrCodesBulkResponses, GetDomainData, GetDomainErrors, GetDomainResponses, GetFolderData, GetFolderResponses, GetLinkByOriginalUrlData, GetLinkByOriginalUrlResponses, GetLinkCountriesData, GetLinkCountriesResponses, GetLinkData, GetLinkErrors, GetLinkOpengraphData, GetLinkOpengraphResponses, GetLinkPermissionsData, GetLinkPermissionsErrors, GetLinkPermissionsResponses, GetLinkRegionsData, GetLinkRegionsResponses, GetLinkResponses, GetLinksByUrlData, GetLinksByUrlResponses, GetRegionsByCountryData, GetRegionsByCountryResponses, ListDomainsData, ListDomainsResponses, ListFoldersData, ListFoldersResponses, ListLinksData, ListLinksErrors, ListLinksResponses, UnarchiveLinkData, UnarchiveLinkErrors, UnarchiveLinkResponses, UnarchiveLinksBulkData, UnarchiveLinksBulkErrors, UnarchiveLinksBulkResponses, UpdateDomainSettingsData, UpdateDomainSettingsErrors, UpdateDomainSettingsResponses, UpdateLinkData, UpdateLinkErrors, UpdateLinkOpengraphData, UpdateLinkOpengraphResponses, UpdateLinkResponses } from './types.gen.js';
3
+ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
4
+ client?: Client;
5
+ meta?: Record<string, unknown>;
6
+ };
7
+ export declare const getLinkOpengraph: <ThrowOnError extends boolean = false>(options: Options<GetLinkOpengraphData, ThrowOnError>) => import("./client/index.js").RequestResult<GetLinkOpengraphResponses, unknown, ThrowOnError, "fields">;
8
+ export declare const updateLinkOpengraph: <ThrowOnError extends boolean = false>(options: Options<UpdateLinkOpengraphData, ThrowOnError>) => import("./client/index.js").RequestResult<UpdateLinkOpengraphResponses, unknown, ThrowOnError, "fields">;
9
+ export declare const getLinkCountries: <ThrowOnError extends boolean = false>(options: Options<GetLinkCountriesData, ThrowOnError>) => import("./client/index.js").RequestResult<GetLinkCountriesResponses, unknown, ThrowOnError, "fields">;
10
+ export declare const createLinkCountry: <ThrowOnError extends boolean = false>(options: Options<CreateLinkCountryData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateLinkCountryResponses, unknown, ThrowOnError, "fields">;
11
+ export declare const createLinkCountriesBulk: <ThrowOnError extends boolean = false>(options: Options<CreateLinkCountriesBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateLinkCountriesBulkResponses, unknown, ThrowOnError, "fields">;
12
+ export declare const deleteLinkCountry: <ThrowOnError extends boolean = false>(options: Options<DeleteLinkCountryData, ThrowOnError>) => import("./client/index.js").RequestResult<DeleteLinkCountryResponses, unknown, ThrowOnError, "fields">;
13
+ export declare const getLinkRegions: <ThrowOnError extends boolean = false>(options: Options<GetLinkRegionsData, ThrowOnError>) => import("./client/index.js").RequestResult<GetLinkRegionsResponses, unknown, ThrowOnError, "fields">;
14
+ export declare const createLinkRegion: <ThrowOnError extends boolean = false>(options: Options<CreateLinkRegionData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateLinkRegionResponses, unknown, ThrowOnError, "fields">;
15
+ export declare const getRegionsByCountry: <ThrowOnError extends boolean = false>(options: Options<GetRegionsByCountryData, ThrowOnError>) => import("./client/index.js").RequestResult<GetRegionsByCountryResponses, unknown, ThrowOnError, "fields">;
16
+ export declare const createLinkRegionsBulk: <ThrowOnError extends boolean = false>(options: Options<CreateLinkRegionsBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateLinkRegionsBulkResponses, unknown, ThrowOnError, "fields">;
17
+ export declare const deleteLinkRegion: <ThrowOnError extends boolean = false>(options: Options<DeleteLinkRegionData, ThrowOnError>) => import("./client/index.js").RequestResult<DeleteLinkRegionResponses, unknown, ThrowOnError, "fields">;
18
+ export declare const getLinkPermissions: <ThrowOnError extends boolean = false>(options: Options<GetLinkPermissionsData, ThrowOnError>) => import("./client/index.js").RequestResult<GetLinkPermissionsResponses, GetLinkPermissionsErrors, ThrowOnError, "fields">;
19
+ export declare const deleteLinkPermission: <ThrowOnError extends boolean = false>(options: Options<DeleteLinkPermissionData, ThrowOnError>) => import("./client/index.js").RequestResult<DeleteLinkPermissionResponses, DeleteLinkPermissionErrors, ThrowOnError, "fields">;
20
+ export declare const addLinkPermission: <ThrowOnError extends boolean = false>(options: Options<AddLinkPermissionData, ThrowOnError>) => import("./client/index.js").RequestResult<AddLinkPermissionResponses, AddLinkPermissionErrors, ThrowOnError, "fields">;
21
+ export declare const listLinks: <ThrowOnError extends boolean = false>(options: Options<ListLinksData, ThrowOnError>) => import("./client/index.js").RequestResult<ListLinksResponses, ListLinksErrors, ThrowOnError, "fields">;
22
+ export declare const generateQrCode: <ThrowOnError extends boolean = false>(options: Options<GenerateQrCodeData, ThrowOnError>) => import("./client/index.js").RequestResult<GenerateQrCodeResponses, unknown, ThrowOnError, "fields">;
23
+ export declare const generateQrCodesBulk: <ThrowOnError extends boolean = false>(options: Options<GenerateQrCodesBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<GenerateQrCodesBulkResponses, unknown, ThrowOnError, "fields">;
24
+ export declare const deleteLink: <ThrowOnError extends boolean = false>(options: Options<DeleteLinkData, ThrowOnError>) => import("./client/index.js").RequestResult<DeleteLinkResponses, DeleteLinkErrors, ThrowOnError, "fields">;
25
+ export declare const deleteLinksBulk: <ThrowOnError extends boolean = false>(options: Options<DeleteLinksBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<DeleteLinksBulkResponses, unknown, ThrowOnError, "fields">;
26
+ export declare const archiveLink: <ThrowOnError extends boolean = false>(options: Options<ArchiveLinkData, ThrowOnError>) => import("./client/index.js").RequestResult<ArchiveLinkResponses, ArchiveLinkErrors, ThrowOnError, "fields">;
27
+ export declare const archiveLinksBulk: <ThrowOnError extends boolean = false>(options: Options<ArchiveLinksBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<ArchiveLinksBulkResponses, ArchiveLinksBulkErrors, ThrowOnError, "fields">;
28
+ export declare const unarchiveLink: <ThrowOnError extends boolean = false>(options: Options<UnarchiveLinkData, ThrowOnError>) => import("./client/index.js").RequestResult<UnarchiveLinkResponses, UnarchiveLinkErrors, ThrowOnError, "fields">;
29
+ export declare const unarchiveLinksBulk: <ThrowOnError extends boolean = false>(options: Options<UnarchiveLinksBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<UnarchiveLinksBulkResponses, UnarchiveLinksBulkErrors, ThrowOnError, "fields">;
30
+ export declare const getLink: <ThrowOnError extends boolean = false>(options: Options<GetLinkData, ThrowOnError>) => import("./client/index.js").RequestResult<GetLinkResponses, GetLinkErrors, ThrowOnError, "fields">;
31
+ export declare const updateLink: <ThrowOnError extends boolean = false>(options: Options<UpdateLinkData, ThrowOnError>) => import("./client/index.js").RequestResult<UpdateLinkResponses, UpdateLinkErrors, ThrowOnError, "fields">;
32
+ export declare const expandLink: <ThrowOnError extends boolean = false>(options: Options<ExpandLinkData, ThrowOnError>) => import("./client/index.js").RequestResult<ExpandLinkResponses, ExpandLinkErrors, ThrowOnError, "fields">;
33
+ export declare const getLinkByOriginalUrl: <ThrowOnError extends boolean = false>(options: Options<GetLinkByOriginalUrlData, ThrowOnError>) => import("./client/index.js").RequestResult<GetLinkByOriginalUrlResponses, unknown, ThrowOnError, "fields">;
34
+ export declare const getLinksByUrl: <ThrowOnError extends boolean = false>(options: Options<GetLinksByUrlData, ThrowOnError>) => import("./client/index.js").RequestResult<GetLinksByUrlResponses, unknown, ThrowOnError, "fields">;
35
+ export declare const createLink: <ThrowOnError extends boolean = false>(options?: Options<CreateLinkData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateLinkResponses, CreateLinkErrors, ThrowOnError, "fields">;
36
+ export declare const createLinkSimple: <ThrowOnError extends boolean = false>(options: Options<CreateLinkSimpleData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateLinkSimpleResponses, unknown, ThrowOnError, "fields">;
37
+ export declare const createLinkPublic: <ThrowOnError extends boolean = false>(options: Options<CreateLinkPublicData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateLinkPublicResponses, CreateLinkPublicErrors, ThrowOnError, "fields">;
38
+ export declare const createLinksBulk: <ThrowOnError extends boolean = false>(options: Options<CreateLinksBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateLinksBulkResponses, unknown, ThrowOnError, "fields">;
39
+ export declare const createExampleLinks: <ThrowOnError extends boolean = false>(options: Options<CreateExampleLinksData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateExampleLinksResponses, CreateExampleLinksErrors, ThrowOnError, "fields">;
40
+ export declare const duplicateLink: <ThrowOnError extends boolean = false>(options: Options<DuplicateLinkData, ThrowOnError>) => import("./client/index.js").RequestResult<DuplicateLinkResponses, DuplicateLinkErrors, ThrowOnError, "fields">;
41
+ export declare const listDomains: <ThrowOnError extends boolean = false>(options?: Options<ListDomainsData, ThrowOnError>) => import("./client/index.js").RequestResult<ListDomainsResponses, unknown, ThrowOnError, "fields">;
42
+ export declare const getDomain: <ThrowOnError extends boolean = false>(options: Options<GetDomainData, ThrowOnError>) => import("./client/index.js").RequestResult<GetDomainResponses, GetDomainErrors, ThrowOnError, "fields">;
43
+ export declare const updateDomainSettings: <ThrowOnError extends boolean = false>(options: Options<UpdateDomainSettingsData, ThrowOnError>) => import("./client/index.js").RequestResult<UpdateDomainSettingsResponses, UpdateDomainSettingsErrors, ThrowOnError, "fields">;
44
+ export declare const addTagsBulk: <ThrowOnError extends boolean = false>(options: Options<AddTagsBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<AddTagsBulkResponses, unknown, ThrowOnError, "fields">;
45
+ export declare const createDomain: <ThrowOnError extends boolean = false>(options: Options<CreateDomainData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateDomainResponses, CreateDomainErrors, ThrowOnError, "fields">;
46
+ export declare const listFolders: <ThrowOnError extends boolean = false>(options: Options<ListFoldersData, ThrowOnError>) => import("./client/index.js").RequestResult<ListFoldersResponses, unknown, ThrowOnError, "fields">;
47
+ export declare const getFolder: <ThrowOnError extends boolean = false>(options: Options<GetFolderData, ThrowOnError>) => import("./client/index.js").RequestResult<GetFolderResponses, unknown, ThrowOnError, "fields">;
48
+ export declare const createFolder: <ThrowOnError extends boolean = false>(options: Options<CreateFolderData, ThrowOnError>) => import("./client/index.js").RequestResult<CreateFolderResponses, unknown, ThrowOnError, "fields">;