@short.io/client-node 2.0.0 → 2.1.1

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 (25) hide show
  1. package/dist/client/index.d.ts +4 -0
  2. package/dist/client/index.js +115 -0
  3. package/dist/client/index.js.map +1 -0
  4. package/dist/client/types.d.ts +78 -0
  5. package/dist/client/types.js +2 -0
  6. package/dist/client/types.js.map +1 -0
  7. package/dist/client/utils.d.ts +57 -0
  8. package/dist/client/utils.js +383 -0
  9. package/dist/client/utils.js.map +1 -0
  10. package/dist/index.d.ts +2 -0
  11. package/dist/index.js +3 -0
  12. package/dist/index.js.map +1 -0
  13. package/dist/sdk.gen.d.ts +474 -0
  14. package/dist/sdk.gen.js +323 -0
  15. package/dist/sdk.gen.js.map +1 -0
  16. package/dist/types.gen.d.ts +1198 -0
  17. package/dist/types.gen.js +2 -0
  18. package/dist/types.gen.js.map +1 -0
  19. package/package.json +7 -5
  20. package/renovate.json +0 -6
  21. package/src/index.ts +0 -3
  22. package/src/sdk.gen.ts +0 -688
  23. package/src/types.gen.ts +0 -4560
  24. package/tsconfig.json +0 -24
  25. package/tsconfig.tsbuildinfo +0 -1
package/src/types.gen.ts DELETED
@@ -1,4560 +0,0 @@
1
- // This file is auto-generated by @hey-api/openapi-ts
2
-
3
- export type GetLinksOpengraphByDomainIdByLinkIdData = {
4
- body?: never;
5
- path: {
6
- domainId: number;
7
- linkId: string;
8
- };
9
- query?: never;
10
- url: "/links/opengraph/{domainId}/{linkId}";
11
- };
12
-
13
- export type GetLinksOpengraphByDomainIdByLinkIdResponses = {
14
- /**
15
- * Default Response
16
- */
17
- 200: unknown;
18
- };
19
-
20
- export type PutLinksOpengraphByDomainIdByLinkIdData = {
21
- body?: Array<
22
- [
23
- (
24
- | "title"
25
- | "type"
26
- | "image"
27
- | "url"
28
- | "audio"
29
- | "description"
30
- | "determiner"
31
- | "locale"
32
- | "locale:alternate"
33
- | "site_name"
34
- | "video"
35
- | "image:url"
36
- | "image:secure_url"
37
- | "image:type"
38
- | "image:width"
39
- | "image:height"
40
- | "image:alt"
41
- | "music:duration"
42
- | "music:album"
43
- | "music:album:disc"
44
- | "music:album:track"
45
- | "music:musician"
46
- | "music:song"
47
- | "music:song:disc"
48
- | "music:song:track"
49
- | "music:release_date"
50
- | "music:creator"
51
- | "video:actor"
52
- | "video:actor:role"
53
- | "video:director"
54
- | "video:writer"
55
- | "video:duration"
56
- | "video:release_date"
57
- | "video:tag"
58
- | "video:series"
59
- | "book:author"
60
- | "book:isbn"
61
- | "book:release_date"
62
- | "book:tag"
63
- | "profile:first_name"
64
- | "profile:last_name"
65
- | "profile:username"
66
- | "profile:gender"
67
- | "twitter:card"
68
- | "twitter:site"
69
- | "twitter:site:id"
70
- | "twitter:creator"
71
- | "twitter:creator:id"
72
- | "twitter:description"
73
- | "twitter:title"
74
- | "twitter:image"
75
- | "twitter:image:alt"
76
- | "twitter:player"
77
- | "twitter:player:width"
78
- | "twitter:player:height"
79
- | "twitter:player:stream"
80
- | "twitter:app:name:iphone"
81
- | "twitter:app:id:iphone"
82
- | "twitter:app:url:iphone"
83
- | "twitter:app:name:ipad"
84
- | "twitter:app:id:ipad"
85
- | "twitter:app:url:ipad"
86
- | "twitter:app:name:googleplay"
87
- | "twitter:app:id:googleplay"
88
- | "twitter:app:url:googleplay"
89
- | "twitter:app:country"
90
- ),
91
- string,
92
- ]
93
- >;
94
- path: {
95
- domainId: number;
96
- linkId: string;
97
- };
98
- query?: never;
99
- url: "/links/opengraph/{domainId}/{linkId}";
100
- };
101
-
102
- export type PutLinksOpengraphByDomainIdByLinkIdResponses = {
103
- /**
104
- * Default Response
105
- */
106
- 200: unknown;
107
- };
108
-
109
- export type GetLinkCountryByLinkIdData = {
110
- body?: never;
111
- path: {
112
- linkId: string;
113
- };
114
- query?: {
115
- domainId?: string;
116
- };
117
- url: "/link_country/{linkId}";
118
- };
119
-
120
- export type GetLinkCountryByLinkIdResponses = {
121
- /**
122
- * Default Response
123
- */
124
- 200: unknown;
125
- };
126
-
127
- export type PostLinkCountryByLinkIdData = {
128
- body: {
129
- /**
130
- * Country code
131
- */
132
- country:
133
- | "AD"
134
- | "AE"
135
- | "AF"
136
- | "AG"
137
- | "AI"
138
- | "AL"
139
- | "AM"
140
- | "AO"
141
- | "AQ"
142
- | "AR"
143
- | "AS"
144
- | "AT"
145
- | "AU"
146
- | "AW"
147
- | "AX"
148
- | "AZ"
149
- | "BA"
150
- | "BB"
151
- | "BD"
152
- | "BE"
153
- | "BF"
154
- | "BG"
155
- | "BH"
156
- | "BI"
157
- | "BJ"
158
- | "BL"
159
- | "BM"
160
- | "BN"
161
- | "BO"
162
- | "BQ"
163
- | "BR"
164
- | "BS"
165
- | "BT"
166
- | "BV"
167
- | "BW"
168
- | "BY"
169
- | "BZ"
170
- | "CA"
171
- | "CC"
172
- | "CD"
173
- | "CF"
174
- | "CG"
175
- | "CH"
176
- | "CI"
177
- | "CK"
178
- | "CL"
179
- | "CM"
180
- | "CN"
181
- | "CO"
182
- | "CR"
183
- | "CU"
184
- | "CV"
185
- | "CW"
186
- | "CX"
187
- | "CY"
188
- | "CZ"
189
- | "DE"
190
- | "DJ"
191
- | "DK"
192
- | "DM"
193
- | "DO"
194
- | "DZ"
195
- | "EC"
196
- | "EE"
197
- | "EG"
198
- | "EH"
199
- | "ER"
200
- | "ES"
201
- | "ET"
202
- | "FI"
203
- | "FJ"
204
- | "FK"
205
- | "FM"
206
- | "FO"
207
- | "FR"
208
- | "GA"
209
- | "GB"
210
- | "GD"
211
- | "GE"
212
- | "GF"
213
- | "GG"
214
- | "GH"
215
- | "GI"
216
- | "GL"
217
- | "GM"
218
- | "GN"
219
- | "GP"
220
- | "GQ"
221
- | "GR"
222
- | "GS"
223
- | "GT"
224
- | "GU"
225
- | "GW"
226
- | "GY"
227
- | "HK"
228
- | "HM"
229
- | "HN"
230
- | "HR"
231
- | "HT"
232
- | "HU"
233
- | "ID"
234
- | "IE"
235
- | "IL"
236
- | "IM"
237
- | "IN"
238
- | "IO"
239
- | "IQ"
240
- | "IR"
241
- | "IS"
242
- | "IT"
243
- | "JE"
244
- | "JM"
245
- | "JO"
246
- | "JP"
247
- | "KE"
248
- | "KG"
249
- | "KH"
250
- | "KI"
251
- | "KM"
252
- | "KN"
253
- | "KP"
254
- | "KR"
255
- | "KW"
256
- | "KY"
257
- | "KZ"
258
- | "LA"
259
- | "LB"
260
- | "LC"
261
- | "LI"
262
- | "LK"
263
- | "LR"
264
- | "LS"
265
- | "LT"
266
- | "LU"
267
- | "LV"
268
- | "LY"
269
- | "MA"
270
- | "MC"
271
- | "MD"
272
- | "ME"
273
- | "MF"
274
- | "MG"
275
- | "MH"
276
- | "MK"
277
- | "ML"
278
- | "MM"
279
- | "MN"
280
- | "MO"
281
- | "MP"
282
- | "MQ"
283
- | "MR"
284
- | "MS"
285
- | "MT"
286
- | "MU"
287
- | "MV"
288
- | "MW"
289
- | "MX"
290
- | "MY"
291
- | "MZ"
292
- | "NA"
293
- | "NC"
294
- | "NE"
295
- | "NF"
296
- | "NG"
297
- | "NI"
298
- | "NL"
299
- | "NO"
300
- | "NP"
301
- | "NR"
302
- | "NU"
303
- | "NZ"
304
- | "OM"
305
- | "PA"
306
- | "PE"
307
- | "PF"
308
- | "PG"
309
- | "PH"
310
- | "PK"
311
- | "PL"
312
- | "PM"
313
- | "PN"
314
- | "PR"
315
- | "PS"
316
- | "PT"
317
- | "PW"
318
- | "PY"
319
- | "QA"
320
- | "RE"
321
- | "RO"
322
- | "RS"
323
- | "RU"
324
- | "RW"
325
- | "SA"
326
- | "SB"
327
- | "SC"
328
- | "SD"
329
- | "SE"
330
- | "SG"
331
- | "SH"
332
- | "SI"
333
- | "SJ"
334
- | "SK"
335
- | "SL"
336
- | "SM"
337
- | "SN"
338
- | "SO"
339
- | "SR"
340
- | "SS"
341
- | "ST"
342
- | "SV"
343
- | "SX"
344
- | "SY"
345
- | "SZ"
346
- | "TC"
347
- | "TD"
348
- | "TF"
349
- | "TG"
350
- | "TH"
351
- | "TJ"
352
- | "TK"
353
- | "TL"
354
- | "TM"
355
- | "TN"
356
- | "TO"
357
- | "TR"
358
- | "TT"
359
- | "TV"
360
- | "TW"
361
- | "TZ"
362
- | "UA"
363
- | "UG"
364
- | "UM"
365
- | "US"
366
- | "UY"
367
- | "UZ"
368
- | "VA"
369
- | "VC"
370
- | "VE"
371
- | "VG"
372
- | "VI"
373
- | "VN"
374
- | "VU"
375
- | "WF"
376
- | "WS"
377
- | "YE"
378
- | "YT"
379
- | "ZA"
380
- | "ZM"
381
- | "ZW"
382
- | "XK";
383
- originalURL: string;
384
- };
385
- path: {
386
- linkId: string;
387
- };
388
- query?: {
389
- domainId?: string;
390
- };
391
- url: "/link_country/{linkId}";
392
- };
393
-
394
- export type PostLinkCountryByLinkIdResponses = {
395
- /**
396
- * Default Response
397
- */
398
- 200: unknown;
399
- };
400
-
401
- export type PostLinkCountryBulkByLinkIdData = {
402
- body?: Array<{
403
- /**
404
- * Country code
405
- */
406
- country:
407
- | "AD"
408
- | "AE"
409
- | "AF"
410
- | "AG"
411
- | "AI"
412
- | "AL"
413
- | "AM"
414
- | "AO"
415
- | "AQ"
416
- | "AR"
417
- | "AS"
418
- | "AT"
419
- | "AU"
420
- | "AW"
421
- | "AX"
422
- | "AZ"
423
- | "BA"
424
- | "BB"
425
- | "BD"
426
- | "BE"
427
- | "BF"
428
- | "BG"
429
- | "BH"
430
- | "BI"
431
- | "BJ"
432
- | "BL"
433
- | "BM"
434
- | "BN"
435
- | "BO"
436
- | "BQ"
437
- | "BR"
438
- | "BS"
439
- | "BT"
440
- | "BV"
441
- | "BW"
442
- | "BY"
443
- | "BZ"
444
- | "CA"
445
- | "CC"
446
- | "CD"
447
- | "CF"
448
- | "CG"
449
- | "CH"
450
- | "CI"
451
- | "CK"
452
- | "CL"
453
- | "CM"
454
- | "CN"
455
- | "CO"
456
- | "CR"
457
- | "CU"
458
- | "CV"
459
- | "CW"
460
- | "CX"
461
- | "CY"
462
- | "CZ"
463
- | "DE"
464
- | "DJ"
465
- | "DK"
466
- | "DM"
467
- | "DO"
468
- | "DZ"
469
- | "EC"
470
- | "EE"
471
- | "EG"
472
- | "EH"
473
- | "ER"
474
- | "ES"
475
- | "ET"
476
- | "FI"
477
- | "FJ"
478
- | "FK"
479
- | "FM"
480
- | "FO"
481
- | "FR"
482
- | "GA"
483
- | "GB"
484
- | "GD"
485
- | "GE"
486
- | "GF"
487
- | "GG"
488
- | "GH"
489
- | "GI"
490
- | "GL"
491
- | "GM"
492
- | "GN"
493
- | "GP"
494
- | "GQ"
495
- | "GR"
496
- | "GS"
497
- | "GT"
498
- | "GU"
499
- | "GW"
500
- | "GY"
501
- | "HK"
502
- | "HM"
503
- | "HN"
504
- | "HR"
505
- | "HT"
506
- | "HU"
507
- | "ID"
508
- | "IE"
509
- | "IL"
510
- | "IM"
511
- | "IN"
512
- | "IO"
513
- | "IQ"
514
- | "IR"
515
- | "IS"
516
- | "IT"
517
- | "JE"
518
- | "JM"
519
- | "JO"
520
- | "JP"
521
- | "KE"
522
- | "KG"
523
- | "KH"
524
- | "KI"
525
- | "KM"
526
- | "KN"
527
- | "KP"
528
- | "KR"
529
- | "KW"
530
- | "KY"
531
- | "KZ"
532
- | "LA"
533
- | "LB"
534
- | "LC"
535
- | "LI"
536
- | "LK"
537
- | "LR"
538
- | "LS"
539
- | "LT"
540
- | "LU"
541
- | "LV"
542
- | "LY"
543
- | "MA"
544
- | "MC"
545
- | "MD"
546
- | "ME"
547
- | "MF"
548
- | "MG"
549
- | "MH"
550
- | "MK"
551
- | "ML"
552
- | "MM"
553
- | "MN"
554
- | "MO"
555
- | "MP"
556
- | "MQ"
557
- | "MR"
558
- | "MS"
559
- | "MT"
560
- | "MU"
561
- | "MV"
562
- | "MW"
563
- | "MX"
564
- | "MY"
565
- | "MZ"
566
- | "NA"
567
- | "NC"
568
- | "NE"
569
- | "NF"
570
- | "NG"
571
- | "NI"
572
- | "NL"
573
- | "NO"
574
- | "NP"
575
- | "NR"
576
- | "NU"
577
- | "NZ"
578
- | "OM"
579
- | "PA"
580
- | "PE"
581
- | "PF"
582
- | "PG"
583
- | "PH"
584
- | "PK"
585
- | "PL"
586
- | "PM"
587
- | "PN"
588
- | "PR"
589
- | "PS"
590
- | "PT"
591
- | "PW"
592
- | "PY"
593
- | "QA"
594
- | "RE"
595
- | "RO"
596
- | "RS"
597
- | "RU"
598
- | "RW"
599
- | "SA"
600
- | "SB"
601
- | "SC"
602
- | "SD"
603
- | "SE"
604
- | "SG"
605
- | "SH"
606
- | "SI"
607
- | "SJ"
608
- | "SK"
609
- | "SL"
610
- | "SM"
611
- | "SN"
612
- | "SO"
613
- | "SR"
614
- | "SS"
615
- | "ST"
616
- | "SV"
617
- | "SX"
618
- | "SY"
619
- | "SZ"
620
- | "TC"
621
- | "TD"
622
- | "TF"
623
- | "TG"
624
- | "TH"
625
- | "TJ"
626
- | "TK"
627
- | "TL"
628
- | "TM"
629
- | "TN"
630
- | "TO"
631
- | "TR"
632
- | "TT"
633
- | "TV"
634
- | "TW"
635
- | "TZ"
636
- | "UA"
637
- | "UG"
638
- | "UM"
639
- | "US"
640
- | "UY"
641
- | "UZ"
642
- | "VA"
643
- | "VC"
644
- | "VE"
645
- | "VG"
646
- | "VI"
647
- | "VN"
648
- | "VU"
649
- | "WF"
650
- | "WS"
651
- | "YE"
652
- | "YT"
653
- | "ZA"
654
- | "ZM"
655
- | "ZW"
656
- | "XK";
657
- originalURL: string;
658
- }>;
659
- path: {
660
- linkId: string;
661
- };
662
- query?: {
663
- domainId?: string;
664
- };
665
- url: "/link_country/bulk/{linkId}";
666
- };
667
-
668
- export type PostLinkCountryBulkByLinkIdResponses = {
669
- /**
670
- * Default Response
671
- */
672
- 200: unknown;
673
- };
674
-
675
- export type DeleteLinkCountryByLinkIdByCountryData = {
676
- body?: never;
677
- path: {
678
- linkId: string;
679
- /**
680
- * Country code
681
- */
682
- country:
683
- | "AD"
684
- | "AE"
685
- | "AF"
686
- | "AG"
687
- | "AI"
688
- | "AL"
689
- | "AM"
690
- | "AO"
691
- | "AQ"
692
- | "AR"
693
- | "AS"
694
- | "AT"
695
- | "AU"
696
- | "AW"
697
- | "AX"
698
- | "AZ"
699
- | "BA"
700
- | "BB"
701
- | "BD"
702
- | "BE"
703
- | "BF"
704
- | "BG"
705
- | "BH"
706
- | "BI"
707
- | "BJ"
708
- | "BL"
709
- | "BM"
710
- | "BN"
711
- | "BO"
712
- | "BQ"
713
- | "BR"
714
- | "BS"
715
- | "BT"
716
- | "BV"
717
- | "BW"
718
- | "BY"
719
- | "BZ"
720
- | "CA"
721
- | "CC"
722
- | "CD"
723
- | "CF"
724
- | "CG"
725
- | "CH"
726
- | "CI"
727
- | "CK"
728
- | "CL"
729
- | "CM"
730
- | "CN"
731
- | "CO"
732
- | "CR"
733
- | "CU"
734
- | "CV"
735
- | "CW"
736
- | "CX"
737
- | "CY"
738
- | "CZ"
739
- | "DE"
740
- | "DJ"
741
- | "DK"
742
- | "DM"
743
- | "DO"
744
- | "DZ"
745
- | "EC"
746
- | "EE"
747
- | "EG"
748
- | "EH"
749
- | "ER"
750
- | "ES"
751
- | "ET"
752
- | "FI"
753
- | "FJ"
754
- | "FK"
755
- | "FM"
756
- | "FO"
757
- | "FR"
758
- | "GA"
759
- | "GB"
760
- | "GD"
761
- | "GE"
762
- | "GF"
763
- | "GG"
764
- | "GH"
765
- | "GI"
766
- | "GL"
767
- | "GM"
768
- | "GN"
769
- | "GP"
770
- | "GQ"
771
- | "GR"
772
- | "GS"
773
- | "GT"
774
- | "GU"
775
- | "GW"
776
- | "GY"
777
- | "HK"
778
- | "HM"
779
- | "HN"
780
- | "HR"
781
- | "HT"
782
- | "HU"
783
- | "ID"
784
- | "IE"
785
- | "IL"
786
- | "IM"
787
- | "IN"
788
- | "IO"
789
- | "IQ"
790
- | "IR"
791
- | "IS"
792
- | "IT"
793
- | "JE"
794
- | "JM"
795
- | "JO"
796
- | "JP"
797
- | "KE"
798
- | "KG"
799
- | "KH"
800
- | "KI"
801
- | "KM"
802
- | "KN"
803
- | "KP"
804
- | "KR"
805
- | "KW"
806
- | "KY"
807
- | "KZ"
808
- | "LA"
809
- | "LB"
810
- | "LC"
811
- | "LI"
812
- | "LK"
813
- | "LR"
814
- | "LS"
815
- | "LT"
816
- | "LU"
817
- | "LV"
818
- | "LY"
819
- | "MA"
820
- | "MC"
821
- | "MD"
822
- | "ME"
823
- | "MF"
824
- | "MG"
825
- | "MH"
826
- | "MK"
827
- | "ML"
828
- | "MM"
829
- | "MN"
830
- | "MO"
831
- | "MP"
832
- | "MQ"
833
- | "MR"
834
- | "MS"
835
- | "MT"
836
- | "MU"
837
- | "MV"
838
- | "MW"
839
- | "MX"
840
- | "MY"
841
- | "MZ"
842
- | "NA"
843
- | "NC"
844
- | "NE"
845
- | "NF"
846
- | "NG"
847
- | "NI"
848
- | "NL"
849
- | "NO"
850
- | "NP"
851
- | "NR"
852
- | "NU"
853
- | "NZ"
854
- | "OM"
855
- | "PA"
856
- | "PE"
857
- | "PF"
858
- | "PG"
859
- | "PH"
860
- | "PK"
861
- | "PL"
862
- | "PM"
863
- | "PN"
864
- | "PR"
865
- | "PS"
866
- | "PT"
867
- | "PW"
868
- | "PY"
869
- | "QA"
870
- | "RE"
871
- | "RO"
872
- | "RS"
873
- | "RU"
874
- | "RW"
875
- | "SA"
876
- | "SB"
877
- | "SC"
878
- | "SD"
879
- | "SE"
880
- | "SG"
881
- | "SH"
882
- | "SI"
883
- | "SJ"
884
- | "SK"
885
- | "SL"
886
- | "SM"
887
- | "SN"
888
- | "SO"
889
- | "SR"
890
- | "SS"
891
- | "ST"
892
- | "SV"
893
- | "SX"
894
- | "SY"
895
- | "SZ"
896
- | "TC"
897
- | "TD"
898
- | "TF"
899
- | "TG"
900
- | "TH"
901
- | "TJ"
902
- | "TK"
903
- | "TL"
904
- | "TM"
905
- | "TN"
906
- | "TO"
907
- | "TR"
908
- | "TT"
909
- | "TV"
910
- | "TW"
911
- | "TZ"
912
- | "UA"
913
- | "UG"
914
- | "UM"
915
- | "US"
916
- | "UY"
917
- | "UZ"
918
- | "VA"
919
- | "VC"
920
- | "VE"
921
- | "VG"
922
- | "VI"
923
- | "VN"
924
- | "VU"
925
- | "WF"
926
- | "WS"
927
- | "YE"
928
- | "YT"
929
- | "ZA"
930
- | "ZM"
931
- | "ZW"
932
- | "XK";
933
- };
934
- query?: {
935
- domainId?: string;
936
- };
937
- url: "/link_country/{linkId}/{country}";
938
- };
939
-
940
- export type DeleteLinkCountryByLinkIdByCountryResponses = {
941
- /**
942
- * Default Response
943
- */
944
- 200: unknown;
945
- };
946
-
947
- export type GetLinkRegionByLinkIdData = {
948
- body?: never;
949
- path: {
950
- linkId: string;
951
- };
952
- query?: {
953
- domainId?: string;
954
- };
955
- url: "/link_region/{linkId}";
956
- };
957
-
958
- export type GetLinkRegionByLinkIdResponses = {
959
- /**
960
- * Default Response
961
- */
962
- 200: unknown;
963
- };
964
-
965
- export type PostLinkRegionByLinkIdData = {
966
- body: {
967
- /**
968
- * Country code
969
- */
970
- country:
971
- | "AD"
972
- | "AE"
973
- | "AF"
974
- | "AG"
975
- | "AI"
976
- | "AL"
977
- | "AM"
978
- | "AO"
979
- | "AQ"
980
- | "AR"
981
- | "AS"
982
- | "AT"
983
- | "AU"
984
- | "AW"
985
- | "AX"
986
- | "AZ"
987
- | "BA"
988
- | "BB"
989
- | "BD"
990
- | "BE"
991
- | "BF"
992
- | "BG"
993
- | "BH"
994
- | "BI"
995
- | "BJ"
996
- | "BL"
997
- | "BM"
998
- | "BN"
999
- | "BO"
1000
- | "BQ"
1001
- | "BR"
1002
- | "BS"
1003
- | "BT"
1004
- | "BV"
1005
- | "BW"
1006
- | "BY"
1007
- | "BZ"
1008
- | "CA"
1009
- | "CC"
1010
- | "CD"
1011
- | "CF"
1012
- | "CG"
1013
- | "CH"
1014
- | "CI"
1015
- | "CK"
1016
- | "CL"
1017
- | "CM"
1018
- | "CN"
1019
- | "CO"
1020
- | "CR"
1021
- | "CU"
1022
- | "CV"
1023
- | "CW"
1024
- | "CX"
1025
- | "CY"
1026
- | "CZ"
1027
- | "DE"
1028
- | "DJ"
1029
- | "DK"
1030
- | "DM"
1031
- | "DO"
1032
- | "DZ"
1033
- | "EC"
1034
- | "EE"
1035
- | "EG"
1036
- | "EH"
1037
- | "ER"
1038
- | "ES"
1039
- | "ET"
1040
- | "FI"
1041
- | "FJ"
1042
- | "FK"
1043
- | "FM"
1044
- | "FO"
1045
- | "FR"
1046
- | "GA"
1047
- | "GB"
1048
- | "GD"
1049
- | "GE"
1050
- | "GF"
1051
- | "GG"
1052
- | "GH"
1053
- | "GI"
1054
- | "GL"
1055
- | "GM"
1056
- | "GN"
1057
- | "GP"
1058
- | "GQ"
1059
- | "GR"
1060
- | "GS"
1061
- | "GT"
1062
- | "GU"
1063
- | "GW"
1064
- | "GY"
1065
- | "HK"
1066
- | "HM"
1067
- | "HN"
1068
- | "HR"
1069
- | "HT"
1070
- | "HU"
1071
- | "ID"
1072
- | "IE"
1073
- | "IL"
1074
- | "IM"
1075
- | "IN"
1076
- | "IO"
1077
- | "IQ"
1078
- | "IR"
1079
- | "IS"
1080
- | "IT"
1081
- | "JE"
1082
- | "JM"
1083
- | "JO"
1084
- | "JP"
1085
- | "KE"
1086
- | "KG"
1087
- | "KH"
1088
- | "KI"
1089
- | "KM"
1090
- | "KN"
1091
- | "KP"
1092
- | "KR"
1093
- | "KW"
1094
- | "KY"
1095
- | "KZ"
1096
- | "LA"
1097
- | "LB"
1098
- | "LC"
1099
- | "LI"
1100
- | "LK"
1101
- | "LR"
1102
- | "LS"
1103
- | "LT"
1104
- | "LU"
1105
- | "LV"
1106
- | "LY"
1107
- | "MA"
1108
- | "MC"
1109
- | "MD"
1110
- | "ME"
1111
- | "MF"
1112
- | "MG"
1113
- | "MH"
1114
- | "MK"
1115
- | "ML"
1116
- | "MM"
1117
- | "MN"
1118
- | "MO"
1119
- | "MP"
1120
- | "MQ"
1121
- | "MR"
1122
- | "MS"
1123
- | "MT"
1124
- | "MU"
1125
- | "MV"
1126
- | "MW"
1127
- | "MX"
1128
- | "MY"
1129
- | "MZ"
1130
- | "NA"
1131
- | "NC"
1132
- | "NE"
1133
- | "NF"
1134
- | "NG"
1135
- | "NI"
1136
- | "NL"
1137
- | "NO"
1138
- | "NP"
1139
- | "NR"
1140
- | "NU"
1141
- | "NZ"
1142
- | "OM"
1143
- | "PA"
1144
- | "PE"
1145
- | "PF"
1146
- | "PG"
1147
- | "PH"
1148
- | "PK"
1149
- | "PL"
1150
- | "PM"
1151
- | "PN"
1152
- | "PR"
1153
- | "PS"
1154
- | "PT"
1155
- | "PW"
1156
- | "PY"
1157
- | "QA"
1158
- | "RE"
1159
- | "RO"
1160
- | "RS"
1161
- | "RU"
1162
- | "RW"
1163
- | "SA"
1164
- | "SB"
1165
- | "SC"
1166
- | "SD"
1167
- | "SE"
1168
- | "SG"
1169
- | "SH"
1170
- | "SI"
1171
- | "SJ"
1172
- | "SK"
1173
- | "SL"
1174
- | "SM"
1175
- | "SN"
1176
- | "SO"
1177
- | "SR"
1178
- | "SS"
1179
- | "ST"
1180
- | "SV"
1181
- | "SX"
1182
- | "SY"
1183
- | "SZ"
1184
- | "TC"
1185
- | "TD"
1186
- | "TF"
1187
- | "TG"
1188
- | "TH"
1189
- | "TJ"
1190
- | "TK"
1191
- | "TL"
1192
- | "TM"
1193
- | "TN"
1194
- | "TO"
1195
- | "TR"
1196
- | "TT"
1197
- | "TV"
1198
- | "TW"
1199
- | "TZ"
1200
- | "UA"
1201
- | "UG"
1202
- | "UM"
1203
- | "US"
1204
- | "UY"
1205
- | "UZ"
1206
- | "VA"
1207
- | "VC"
1208
- | "VE"
1209
- | "VG"
1210
- | "VI"
1211
- | "VN"
1212
- | "VU"
1213
- | "WF"
1214
- | "WS"
1215
- | "YE"
1216
- | "YT"
1217
- | "ZA"
1218
- | "ZM"
1219
- | "ZW"
1220
- | "XK";
1221
- /**
1222
- * ISO 3166-2 region code
1223
- */
1224
- region: string;
1225
- originalURL: string;
1226
- };
1227
- path: {
1228
- linkId: string;
1229
- };
1230
- query?: {
1231
- /**
1232
- * Domain ID
1233
- */
1234
- domainId?: number;
1235
- };
1236
- url: "/link_region/{linkId}";
1237
- };
1238
-
1239
- export type PostLinkRegionByLinkIdResponses = {
1240
- /**
1241
- * Default Response
1242
- */
1243
- 200: unknown;
1244
- };
1245
-
1246
- export type GetLinkRegionListByCountryData = {
1247
- body?: never;
1248
- path: {
1249
- /**
1250
- * Country code
1251
- */
1252
- country:
1253
- | "AD"
1254
- | "AE"
1255
- | "AF"
1256
- | "AG"
1257
- | "AI"
1258
- | "AL"
1259
- | "AM"
1260
- | "AO"
1261
- | "AQ"
1262
- | "AR"
1263
- | "AS"
1264
- | "AT"
1265
- | "AU"
1266
- | "AW"
1267
- | "AX"
1268
- | "AZ"
1269
- | "BA"
1270
- | "BB"
1271
- | "BD"
1272
- | "BE"
1273
- | "BF"
1274
- | "BG"
1275
- | "BH"
1276
- | "BI"
1277
- | "BJ"
1278
- | "BL"
1279
- | "BM"
1280
- | "BN"
1281
- | "BO"
1282
- | "BQ"
1283
- | "BR"
1284
- | "BS"
1285
- | "BT"
1286
- | "BV"
1287
- | "BW"
1288
- | "BY"
1289
- | "BZ"
1290
- | "CA"
1291
- | "CC"
1292
- | "CD"
1293
- | "CF"
1294
- | "CG"
1295
- | "CH"
1296
- | "CI"
1297
- | "CK"
1298
- | "CL"
1299
- | "CM"
1300
- | "CN"
1301
- | "CO"
1302
- | "CR"
1303
- | "CU"
1304
- | "CV"
1305
- | "CW"
1306
- | "CX"
1307
- | "CY"
1308
- | "CZ"
1309
- | "DE"
1310
- | "DJ"
1311
- | "DK"
1312
- | "DM"
1313
- | "DO"
1314
- | "DZ"
1315
- | "EC"
1316
- | "EE"
1317
- | "EG"
1318
- | "EH"
1319
- | "ER"
1320
- | "ES"
1321
- | "ET"
1322
- | "FI"
1323
- | "FJ"
1324
- | "FK"
1325
- | "FM"
1326
- | "FO"
1327
- | "FR"
1328
- | "GA"
1329
- | "GB"
1330
- | "GD"
1331
- | "GE"
1332
- | "GF"
1333
- | "GG"
1334
- | "GH"
1335
- | "GI"
1336
- | "GL"
1337
- | "GM"
1338
- | "GN"
1339
- | "GP"
1340
- | "GQ"
1341
- | "GR"
1342
- | "GS"
1343
- | "GT"
1344
- | "GU"
1345
- | "GW"
1346
- | "GY"
1347
- | "HK"
1348
- | "HM"
1349
- | "HN"
1350
- | "HR"
1351
- | "HT"
1352
- | "HU"
1353
- | "ID"
1354
- | "IE"
1355
- | "IL"
1356
- | "IM"
1357
- | "IN"
1358
- | "IO"
1359
- | "IQ"
1360
- | "IR"
1361
- | "IS"
1362
- | "IT"
1363
- | "JE"
1364
- | "JM"
1365
- | "JO"
1366
- | "JP"
1367
- | "KE"
1368
- | "KG"
1369
- | "KH"
1370
- | "KI"
1371
- | "KM"
1372
- | "KN"
1373
- | "KP"
1374
- | "KR"
1375
- | "KW"
1376
- | "KY"
1377
- | "KZ"
1378
- | "LA"
1379
- | "LB"
1380
- | "LC"
1381
- | "LI"
1382
- | "LK"
1383
- | "LR"
1384
- | "LS"
1385
- | "LT"
1386
- | "LU"
1387
- | "LV"
1388
- | "LY"
1389
- | "MA"
1390
- | "MC"
1391
- | "MD"
1392
- | "ME"
1393
- | "MF"
1394
- | "MG"
1395
- | "MH"
1396
- | "MK"
1397
- | "ML"
1398
- | "MM"
1399
- | "MN"
1400
- | "MO"
1401
- | "MP"
1402
- | "MQ"
1403
- | "MR"
1404
- | "MS"
1405
- | "MT"
1406
- | "MU"
1407
- | "MV"
1408
- | "MW"
1409
- | "MX"
1410
- | "MY"
1411
- | "MZ"
1412
- | "NA"
1413
- | "NC"
1414
- | "NE"
1415
- | "NF"
1416
- | "NG"
1417
- | "NI"
1418
- | "NL"
1419
- | "NO"
1420
- | "NP"
1421
- | "NR"
1422
- | "NU"
1423
- | "NZ"
1424
- | "OM"
1425
- | "PA"
1426
- | "PE"
1427
- | "PF"
1428
- | "PG"
1429
- | "PH"
1430
- | "PK"
1431
- | "PL"
1432
- | "PM"
1433
- | "PN"
1434
- | "PR"
1435
- | "PS"
1436
- | "PT"
1437
- | "PW"
1438
- | "PY"
1439
- | "QA"
1440
- | "RE"
1441
- | "RO"
1442
- | "RS"
1443
- | "RU"
1444
- | "RW"
1445
- | "SA"
1446
- | "SB"
1447
- | "SC"
1448
- | "SD"
1449
- | "SE"
1450
- | "SG"
1451
- | "SH"
1452
- | "SI"
1453
- | "SJ"
1454
- | "SK"
1455
- | "SL"
1456
- | "SM"
1457
- | "SN"
1458
- | "SO"
1459
- | "SR"
1460
- | "SS"
1461
- | "ST"
1462
- | "SV"
1463
- | "SX"
1464
- | "SY"
1465
- | "SZ"
1466
- | "TC"
1467
- | "TD"
1468
- | "TF"
1469
- | "TG"
1470
- | "TH"
1471
- | "TJ"
1472
- | "TK"
1473
- | "TL"
1474
- | "TM"
1475
- | "TN"
1476
- | "TO"
1477
- | "TR"
1478
- | "TT"
1479
- | "TV"
1480
- | "TW"
1481
- | "TZ"
1482
- | "UA"
1483
- | "UG"
1484
- | "UM"
1485
- | "US"
1486
- | "UY"
1487
- | "UZ"
1488
- | "VA"
1489
- | "VC"
1490
- | "VE"
1491
- | "VG"
1492
- | "VI"
1493
- | "VN"
1494
- | "VU"
1495
- | "WF"
1496
- | "WS"
1497
- | "YE"
1498
- | "YT"
1499
- | "ZA"
1500
- | "ZM"
1501
- | "ZW"
1502
- | "XK";
1503
- };
1504
- query?: never;
1505
- url: "/link_region/list/{country}";
1506
- };
1507
-
1508
- export type GetLinkRegionListByCountryResponses = {
1509
- /**
1510
- * Default Response
1511
- */
1512
- 200: unknown;
1513
- };
1514
-
1515
- export type PostLinkRegionBulkByLinkIdData = {
1516
- body?: Array<{
1517
- /**
1518
- * Country code
1519
- */
1520
- country:
1521
- | "AD"
1522
- | "AE"
1523
- | "AF"
1524
- | "AG"
1525
- | "AI"
1526
- | "AL"
1527
- | "AM"
1528
- | "AO"
1529
- | "AQ"
1530
- | "AR"
1531
- | "AS"
1532
- | "AT"
1533
- | "AU"
1534
- | "AW"
1535
- | "AX"
1536
- | "AZ"
1537
- | "BA"
1538
- | "BB"
1539
- | "BD"
1540
- | "BE"
1541
- | "BF"
1542
- | "BG"
1543
- | "BH"
1544
- | "BI"
1545
- | "BJ"
1546
- | "BL"
1547
- | "BM"
1548
- | "BN"
1549
- | "BO"
1550
- | "BQ"
1551
- | "BR"
1552
- | "BS"
1553
- | "BT"
1554
- | "BV"
1555
- | "BW"
1556
- | "BY"
1557
- | "BZ"
1558
- | "CA"
1559
- | "CC"
1560
- | "CD"
1561
- | "CF"
1562
- | "CG"
1563
- | "CH"
1564
- | "CI"
1565
- | "CK"
1566
- | "CL"
1567
- | "CM"
1568
- | "CN"
1569
- | "CO"
1570
- | "CR"
1571
- | "CU"
1572
- | "CV"
1573
- | "CW"
1574
- | "CX"
1575
- | "CY"
1576
- | "CZ"
1577
- | "DE"
1578
- | "DJ"
1579
- | "DK"
1580
- | "DM"
1581
- | "DO"
1582
- | "DZ"
1583
- | "EC"
1584
- | "EE"
1585
- | "EG"
1586
- | "EH"
1587
- | "ER"
1588
- | "ES"
1589
- | "ET"
1590
- | "FI"
1591
- | "FJ"
1592
- | "FK"
1593
- | "FM"
1594
- | "FO"
1595
- | "FR"
1596
- | "GA"
1597
- | "GB"
1598
- | "GD"
1599
- | "GE"
1600
- | "GF"
1601
- | "GG"
1602
- | "GH"
1603
- | "GI"
1604
- | "GL"
1605
- | "GM"
1606
- | "GN"
1607
- | "GP"
1608
- | "GQ"
1609
- | "GR"
1610
- | "GS"
1611
- | "GT"
1612
- | "GU"
1613
- | "GW"
1614
- | "GY"
1615
- | "HK"
1616
- | "HM"
1617
- | "HN"
1618
- | "HR"
1619
- | "HT"
1620
- | "HU"
1621
- | "ID"
1622
- | "IE"
1623
- | "IL"
1624
- | "IM"
1625
- | "IN"
1626
- | "IO"
1627
- | "IQ"
1628
- | "IR"
1629
- | "IS"
1630
- | "IT"
1631
- | "JE"
1632
- | "JM"
1633
- | "JO"
1634
- | "JP"
1635
- | "KE"
1636
- | "KG"
1637
- | "KH"
1638
- | "KI"
1639
- | "KM"
1640
- | "KN"
1641
- | "KP"
1642
- | "KR"
1643
- | "KW"
1644
- | "KY"
1645
- | "KZ"
1646
- | "LA"
1647
- | "LB"
1648
- | "LC"
1649
- | "LI"
1650
- | "LK"
1651
- | "LR"
1652
- | "LS"
1653
- | "LT"
1654
- | "LU"
1655
- | "LV"
1656
- | "LY"
1657
- | "MA"
1658
- | "MC"
1659
- | "MD"
1660
- | "ME"
1661
- | "MF"
1662
- | "MG"
1663
- | "MH"
1664
- | "MK"
1665
- | "ML"
1666
- | "MM"
1667
- | "MN"
1668
- | "MO"
1669
- | "MP"
1670
- | "MQ"
1671
- | "MR"
1672
- | "MS"
1673
- | "MT"
1674
- | "MU"
1675
- | "MV"
1676
- | "MW"
1677
- | "MX"
1678
- | "MY"
1679
- | "MZ"
1680
- | "NA"
1681
- | "NC"
1682
- | "NE"
1683
- | "NF"
1684
- | "NG"
1685
- | "NI"
1686
- | "NL"
1687
- | "NO"
1688
- | "NP"
1689
- | "NR"
1690
- | "NU"
1691
- | "NZ"
1692
- | "OM"
1693
- | "PA"
1694
- | "PE"
1695
- | "PF"
1696
- | "PG"
1697
- | "PH"
1698
- | "PK"
1699
- | "PL"
1700
- | "PM"
1701
- | "PN"
1702
- | "PR"
1703
- | "PS"
1704
- | "PT"
1705
- | "PW"
1706
- | "PY"
1707
- | "QA"
1708
- | "RE"
1709
- | "RO"
1710
- | "RS"
1711
- | "RU"
1712
- | "RW"
1713
- | "SA"
1714
- | "SB"
1715
- | "SC"
1716
- | "SD"
1717
- | "SE"
1718
- | "SG"
1719
- | "SH"
1720
- | "SI"
1721
- | "SJ"
1722
- | "SK"
1723
- | "SL"
1724
- | "SM"
1725
- | "SN"
1726
- | "SO"
1727
- | "SR"
1728
- | "SS"
1729
- | "ST"
1730
- | "SV"
1731
- | "SX"
1732
- | "SY"
1733
- | "SZ"
1734
- | "TC"
1735
- | "TD"
1736
- | "TF"
1737
- | "TG"
1738
- | "TH"
1739
- | "TJ"
1740
- | "TK"
1741
- | "TL"
1742
- | "TM"
1743
- | "TN"
1744
- | "TO"
1745
- | "TR"
1746
- | "TT"
1747
- | "TV"
1748
- | "TW"
1749
- | "TZ"
1750
- | "UA"
1751
- | "UG"
1752
- | "UM"
1753
- | "US"
1754
- | "UY"
1755
- | "UZ"
1756
- | "VA"
1757
- | "VC"
1758
- | "VE"
1759
- | "VG"
1760
- | "VI"
1761
- | "VN"
1762
- | "VU"
1763
- | "WF"
1764
- | "WS"
1765
- | "YE"
1766
- | "YT"
1767
- | "ZA"
1768
- | "ZM"
1769
- | "ZW"
1770
- | "XK";
1771
- /**
1772
- * ISO 3166-2 region code
1773
- */
1774
- region: string;
1775
- originalURL: string;
1776
- }>;
1777
- path: {
1778
- linkId: string;
1779
- };
1780
- query?: {
1781
- domainId?: number;
1782
- };
1783
- url: "/link_region/bulk/{linkId}";
1784
- };
1785
-
1786
- export type PostLinkRegionBulkByLinkIdResponses = {
1787
- /**
1788
- * Default Response
1789
- */
1790
- 200: unknown;
1791
- };
1792
-
1793
- export type DeleteLinkRegionByLinkIdByCountryByRegionData = {
1794
- body?: never;
1795
- path: {
1796
- linkId: string;
1797
- /**
1798
- * Country code
1799
- */
1800
- country:
1801
- | "AD"
1802
- | "AE"
1803
- | "AF"
1804
- | "AG"
1805
- | "AI"
1806
- | "AL"
1807
- | "AM"
1808
- | "AO"
1809
- | "AQ"
1810
- | "AR"
1811
- | "AS"
1812
- | "AT"
1813
- | "AU"
1814
- | "AW"
1815
- | "AX"
1816
- | "AZ"
1817
- | "BA"
1818
- | "BB"
1819
- | "BD"
1820
- | "BE"
1821
- | "BF"
1822
- | "BG"
1823
- | "BH"
1824
- | "BI"
1825
- | "BJ"
1826
- | "BL"
1827
- | "BM"
1828
- | "BN"
1829
- | "BO"
1830
- | "BQ"
1831
- | "BR"
1832
- | "BS"
1833
- | "BT"
1834
- | "BV"
1835
- | "BW"
1836
- | "BY"
1837
- | "BZ"
1838
- | "CA"
1839
- | "CC"
1840
- | "CD"
1841
- | "CF"
1842
- | "CG"
1843
- | "CH"
1844
- | "CI"
1845
- | "CK"
1846
- | "CL"
1847
- | "CM"
1848
- | "CN"
1849
- | "CO"
1850
- | "CR"
1851
- | "CU"
1852
- | "CV"
1853
- | "CW"
1854
- | "CX"
1855
- | "CY"
1856
- | "CZ"
1857
- | "DE"
1858
- | "DJ"
1859
- | "DK"
1860
- | "DM"
1861
- | "DO"
1862
- | "DZ"
1863
- | "EC"
1864
- | "EE"
1865
- | "EG"
1866
- | "EH"
1867
- | "ER"
1868
- | "ES"
1869
- | "ET"
1870
- | "FI"
1871
- | "FJ"
1872
- | "FK"
1873
- | "FM"
1874
- | "FO"
1875
- | "FR"
1876
- | "GA"
1877
- | "GB"
1878
- | "GD"
1879
- | "GE"
1880
- | "GF"
1881
- | "GG"
1882
- | "GH"
1883
- | "GI"
1884
- | "GL"
1885
- | "GM"
1886
- | "GN"
1887
- | "GP"
1888
- | "GQ"
1889
- | "GR"
1890
- | "GS"
1891
- | "GT"
1892
- | "GU"
1893
- | "GW"
1894
- | "GY"
1895
- | "HK"
1896
- | "HM"
1897
- | "HN"
1898
- | "HR"
1899
- | "HT"
1900
- | "HU"
1901
- | "ID"
1902
- | "IE"
1903
- | "IL"
1904
- | "IM"
1905
- | "IN"
1906
- | "IO"
1907
- | "IQ"
1908
- | "IR"
1909
- | "IS"
1910
- | "IT"
1911
- | "JE"
1912
- | "JM"
1913
- | "JO"
1914
- | "JP"
1915
- | "KE"
1916
- | "KG"
1917
- | "KH"
1918
- | "KI"
1919
- | "KM"
1920
- | "KN"
1921
- | "KP"
1922
- | "KR"
1923
- | "KW"
1924
- | "KY"
1925
- | "KZ"
1926
- | "LA"
1927
- | "LB"
1928
- | "LC"
1929
- | "LI"
1930
- | "LK"
1931
- | "LR"
1932
- | "LS"
1933
- | "LT"
1934
- | "LU"
1935
- | "LV"
1936
- | "LY"
1937
- | "MA"
1938
- | "MC"
1939
- | "MD"
1940
- | "ME"
1941
- | "MF"
1942
- | "MG"
1943
- | "MH"
1944
- | "MK"
1945
- | "ML"
1946
- | "MM"
1947
- | "MN"
1948
- | "MO"
1949
- | "MP"
1950
- | "MQ"
1951
- | "MR"
1952
- | "MS"
1953
- | "MT"
1954
- | "MU"
1955
- | "MV"
1956
- | "MW"
1957
- | "MX"
1958
- | "MY"
1959
- | "MZ"
1960
- | "NA"
1961
- | "NC"
1962
- | "NE"
1963
- | "NF"
1964
- | "NG"
1965
- | "NI"
1966
- | "NL"
1967
- | "NO"
1968
- | "NP"
1969
- | "NR"
1970
- | "NU"
1971
- | "NZ"
1972
- | "OM"
1973
- | "PA"
1974
- | "PE"
1975
- | "PF"
1976
- | "PG"
1977
- | "PH"
1978
- | "PK"
1979
- | "PL"
1980
- | "PM"
1981
- | "PN"
1982
- | "PR"
1983
- | "PS"
1984
- | "PT"
1985
- | "PW"
1986
- | "PY"
1987
- | "QA"
1988
- | "RE"
1989
- | "RO"
1990
- | "RS"
1991
- | "RU"
1992
- | "RW"
1993
- | "SA"
1994
- | "SB"
1995
- | "SC"
1996
- | "SD"
1997
- | "SE"
1998
- | "SG"
1999
- | "SH"
2000
- | "SI"
2001
- | "SJ"
2002
- | "SK"
2003
- | "SL"
2004
- | "SM"
2005
- | "SN"
2006
- | "SO"
2007
- | "SR"
2008
- | "SS"
2009
- | "ST"
2010
- | "SV"
2011
- | "SX"
2012
- | "SY"
2013
- | "SZ"
2014
- | "TC"
2015
- | "TD"
2016
- | "TF"
2017
- | "TG"
2018
- | "TH"
2019
- | "TJ"
2020
- | "TK"
2021
- | "TL"
2022
- | "TM"
2023
- | "TN"
2024
- | "TO"
2025
- | "TR"
2026
- | "TT"
2027
- | "TV"
2028
- | "TW"
2029
- | "TZ"
2030
- | "UA"
2031
- | "UG"
2032
- | "UM"
2033
- | "US"
2034
- | "UY"
2035
- | "UZ"
2036
- | "VA"
2037
- | "VC"
2038
- | "VE"
2039
- | "VG"
2040
- | "VI"
2041
- | "VN"
2042
- | "VU"
2043
- | "WF"
2044
- | "WS"
2045
- | "YE"
2046
- | "YT"
2047
- | "ZA"
2048
- | "ZM"
2049
- | "ZW"
2050
- | "XK";
2051
- region: string;
2052
- };
2053
- query?: {
2054
- domainId?: string;
2055
- };
2056
- url: "/link_region/{linkId}/{country}/{region}";
2057
- };
2058
-
2059
- export type DeleteLinkRegionByLinkIdByCountryByRegionResponses = {
2060
- /**
2061
- * Default Response
2062
- */
2063
- 200: unknown;
2064
- };
2065
-
2066
- export type GetLinksPermissionsByDomainIdByLinkIdData = {
2067
- body?: never;
2068
- path: {
2069
- domainId: string;
2070
- linkId: string;
2071
- };
2072
- query?: never;
2073
- url: "/links/permissions/{domainId}/{linkId}";
2074
- };
2075
-
2076
- export type GetLinksPermissionsByDomainIdByLinkIdErrors = {
2077
- /**
2078
- * Default Response
2079
- */
2080
- 403: {
2081
- error: string;
2082
- };
2083
- };
2084
-
2085
- export type GetLinksPermissionsByDomainIdByLinkIdError =
2086
- GetLinksPermissionsByDomainIdByLinkIdErrors[keyof GetLinksPermissionsByDomainIdByLinkIdErrors];
2087
-
2088
- export type GetLinksPermissionsByDomainIdByLinkIdResponses = {
2089
- /**
2090
- * Default Response
2091
- */
2092
- 200: Array<{
2093
- id: string;
2094
- DomainId: number;
2095
- UserId: number;
2096
- LinkIdString: string;
2097
- }>;
2098
- };
2099
-
2100
- export type GetLinksPermissionsByDomainIdByLinkIdResponse =
2101
- GetLinksPermissionsByDomainIdByLinkIdResponses[keyof GetLinksPermissionsByDomainIdByLinkIdResponses];
2102
-
2103
- export type DeleteLinksPermissionsByDomainIdByLinkIdByUserIdData = {
2104
- body?: never;
2105
- path: {
2106
- domainId: number;
2107
- linkId: string;
2108
- userId: string;
2109
- };
2110
- query?: never;
2111
- url: "/links/permissions/{domainId}/{linkId}/{userId}";
2112
- };
2113
-
2114
- export type DeleteLinksPermissionsByDomainIdByLinkIdByUserIdErrors = {
2115
- /**
2116
- * Default Response
2117
- */
2118
- 403: {
2119
- error: string;
2120
- };
2121
- /**
2122
- * Default Response
2123
- */
2124
- 404: {
2125
- error: string;
2126
- };
2127
- };
2128
-
2129
- export type DeleteLinksPermissionsByDomainIdByLinkIdByUserIdError =
2130
- DeleteLinksPermissionsByDomainIdByLinkIdByUserIdErrors[keyof DeleteLinksPermissionsByDomainIdByLinkIdByUserIdErrors];
2131
-
2132
- export type DeleteLinksPermissionsByDomainIdByLinkIdByUserIdResponses = {
2133
- /**
2134
- * Default Response
2135
- */
2136
- 201: {
2137
- success: boolean;
2138
- };
2139
- };
2140
-
2141
- export type DeleteLinksPermissionsByDomainIdByLinkIdByUserIdResponse =
2142
- DeleteLinksPermissionsByDomainIdByLinkIdByUserIdResponses[keyof DeleteLinksPermissionsByDomainIdByLinkIdByUserIdResponses];
2143
-
2144
- export type PostLinksPermissionsByDomainIdByLinkIdByUserIdData = {
2145
- body?: never;
2146
- path: {
2147
- domainId: string;
2148
- /**
2149
- * Link ID
2150
- */
2151
- linkId: string;
2152
- userId: string;
2153
- };
2154
- query?: never;
2155
- url: "/links/permissions/{domainId}/{linkId}/{userId}";
2156
- };
2157
-
2158
- export type PostLinksPermissionsByDomainIdByLinkIdByUserIdErrors = {
2159
- /**
2160
- * Default Response
2161
- */
2162
- 402: {
2163
- error: string;
2164
- };
2165
- /**
2166
- * Default Response
2167
- */
2168
- 403: {
2169
- error: string;
2170
- };
2171
- /**
2172
- * Default Response
2173
- */
2174
- 404: {
2175
- error: string;
2176
- };
2177
- };
2178
-
2179
- export type PostLinksPermissionsByDomainIdByLinkIdByUserIdError =
2180
- PostLinksPermissionsByDomainIdByLinkIdByUserIdErrors[keyof PostLinksPermissionsByDomainIdByLinkIdByUserIdErrors];
2181
-
2182
- export type PostLinksPermissionsByDomainIdByLinkIdByUserIdResponses = {
2183
- /**
2184
- * Default Response
2185
- */
2186
- 201: {
2187
- id: string;
2188
- DomainId: number;
2189
- UserId: number;
2190
- /**
2191
- * Link ID
2192
- */
2193
- LinkIdString: string;
2194
- };
2195
- };
2196
-
2197
- export type PostLinksPermissionsByDomainIdByLinkIdByUserIdResponse =
2198
- PostLinksPermissionsByDomainIdByLinkIdByUserIdResponses[keyof PostLinksPermissionsByDomainIdByLinkIdByUserIdResponses];
2199
-
2200
- export type GetApiLinksData = {
2201
- body?: never;
2202
- path?: never;
2203
- query: {
2204
- /**
2205
- * Domain ID
2206
- */
2207
- domain_id: number;
2208
- limit?: number;
2209
- idString?: string;
2210
- createdAt?: string;
2211
- beforeDate?: string;
2212
- afterDate?: string;
2213
- dateSortOrder?: "asc" | "desc";
2214
- pageToken?: string;
2215
- folderId?: string;
2216
- };
2217
- url: "/api/links";
2218
- };
2219
-
2220
- export type GetApiLinksErrors = {
2221
- /**
2222
- * Default Response
2223
- */
2224
- 403: {
2225
- error: string;
2226
- };
2227
- };
2228
-
2229
- export type GetApiLinksError = GetApiLinksErrors[keyof GetApiLinksErrors];
2230
-
2231
- export type GetApiLinksResponses = {
2232
- /**
2233
- * Default Response
2234
- */
2235
- 200: {
2236
- count: number;
2237
- links: Array<{
2238
- /**
2239
- * Original URL
2240
- */
2241
- originalURL: string;
2242
- /**
2243
- * Cloaking
2244
- */
2245
- cloaking?: boolean;
2246
- /**
2247
- * Link password
2248
- */
2249
- password?: string;
2250
- /**
2251
- * Link expiration date in milliseconds or ISO string
2252
- */
2253
- expiresAt?: number | string;
2254
- /**
2255
- * Expired URL
2256
- */
2257
- expiredURL?: string;
2258
- /**
2259
- * Link title
2260
- */
2261
- title?: string;
2262
- /**
2263
- * Array of link tags
2264
- */
2265
- tags?: Array<string>;
2266
- /**
2267
- * set utm_source parameter to destination link
2268
- */
2269
- utmSource?: string;
2270
- /**
2271
- * set utm_medium parameter to destination link
2272
- */
2273
- utmMedium?: string;
2274
- /**
2275
- * set utm_campaign parameter to destination link
2276
- */
2277
- utmCampaign?: string;
2278
- /**
2279
- * set utm_term parameter to destination link
2280
- */
2281
- utmTerm?: string;
2282
- /**
2283
- * set utm_content parameter to destination link
2284
- */
2285
- utmContent?: string;
2286
- /**
2287
- * Time to live in milliseconds or ISO string
2288
- */
2289
- ttl?: string | number;
2290
- path: string;
2291
- /**
2292
- * Android URL
2293
- */
2294
- androidURL?: string;
2295
- /**
2296
- * iPhone URL
2297
- */
2298
- iphoneURL?: string;
2299
- /**
2300
- * Link creation date in milliseconds
2301
- */
2302
- createdAt?: number | string;
2303
- /**
2304
- * disable link after specified number of clicks
2305
- */
2306
- clicksLimit?: number;
2307
- /**
2308
- * Provide your email to users to get a password
2309
- */
2310
- passwordContact?: boolean;
2311
- /**
2312
- * Skip query string merging
2313
- */
2314
- skipQS?: boolean;
2315
- /**
2316
- * Link is archived
2317
- */
2318
- archived?: boolean;
2319
- /**
2320
- * Split URL
2321
- */
2322
- splitURL?: string;
2323
- /**
2324
- * Split URL percentage
2325
- */
2326
- splitPercent?: number;
2327
- /**
2328
- * Adroll integration
2329
- */
2330
- integrationAdroll?: string;
2331
- /**
2332
- * Facebook integration
2333
- */
2334
- integrationFB?: string;
2335
- /**
2336
- * Google Analytics integration
2337
- */
2338
- integrationGA?: string;
2339
- /**
2340
- * Google Tag Manager integration
2341
- */
2342
- integrationGTM?: string;
2343
- /**
2344
- * Link ID
2345
- */
2346
- idString: string;
2347
- /**
2348
- * Link ID
2349
- */
2350
- id: string;
2351
- /**
2352
- * Short URL
2353
- */
2354
- shortURL: string;
2355
- /**
2356
- * Secure short URL
2357
- */
2358
- secureShortURL: string;
2359
- /**
2360
- * HTTP code for redirect
2361
- */
2362
- redirectType?: "301" | "302" | "307" | "308";
2363
- /**
2364
- * Folder ID
2365
- */
2366
- FolderId?: string;
2367
- /**
2368
- * Domain ID
2369
- */
2370
- DomainId?: number;
2371
- /**
2372
- * Owner ID
2373
- */
2374
- OwnerId?: number;
2375
- /**
2376
- * Link has password
2377
- */
2378
- hasPassword?: boolean;
2379
- /**
2380
- * Link source
2381
- */
2382
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
2383
- User?: {
2384
- /**
2385
- * Creator user ID
2386
- */
2387
- id: number;
2388
- /**
2389
- * Creator name
2390
- */
2391
- name: string;
2392
- /**
2393
- * Creator email
2394
- */
2395
- email: string;
2396
- /**
2397
- * User photo URL
2398
- */
2399
- photoURL: string;
2400
- };
2401
- }>;
2402
- nextPageToken?: string;
2403
- };
2404
- };
2405
-
2406
- export type GetApiLinksResponse = GetApiLinksResponses[keyof GetApiLinksResponses];
2407
-
2408
- export type PostLinksQrByLinkIdStringData = {
2409
- body: {
2410
- color?: string;
2411
- backgroundColor?: string;
2412
- size?: number;
2413
- type?: "png" | "svg";
2414
- useDomainSettings: boolean;
2415
- };
2416
- path: {
2417
- /**
2418
- * Link ID
2419
- */
2420
- linkIdString: string;
2421
- };
2422
- query?: never;
2423
- url: "/links/qr/{linkIdString}";
2424
- };
2425
-
2426
- export type PostLinksQrByLinkIdStringResponses = {
2427
- /**
2428
- * Default Response
2429
- */
2430
- 200: unknown;
2431
- };
2432
-
2433
- export type PostLinksQrBulkData = {
2434
- body: {
2435
- color?: string;
2436
- backgroundColor?: string;
2437
- size?: number;
2438
- type: "png" | "svg";
2439
- useDomainSettings: boolean;
2440
- noExcavate?: boolean;
2441
- linkIds: Array<string>;
2442
- domainId?: string;
2443
- };
2444
- url: "/links/qr/bulk";
2445
- };
2446
-
2447
- export type PostLinksQrBulkResponses = {
2448
- /**
2449
- * Zip file with QR codes
2450
- */
2451
- 201: Blob | File;
2452
- };
2453
-
2454
- export type PostLinksQrBulkResponse = PostLinksQrBulkResponses[keyof PostLinksQrBulkResponses];
2455
-
2456
- export type DeleteLinksByLinkIdData = {
2457
- body?: never;
2458
- path: {
2459
- /**
2460
- * Link ID
2461
- */
2462
- link_id: string;
2463
- };
2464
- query?: never;
2465
- url: "/links/{link_id}";
2466
- };
2467
-
2468
- export type DeleteLinksByLinkIdResponses = {
2469
- /**
2470
- * Default Response
2471
- */
2472
- 200: {
2473
- success: boolean;
2474
- /**
2475
- * Link ID
2476
- */
2477
- idString?: string;
2478
- error?: string;
2479
- };
2480
- };
2481
-
2482
- export type DeleteLinksByLinkIdResponse = DeleteLinksByLinkIdResponses[keyof DeleteLinksByLinkIdResponses];
2483
-
2484
- export type DeleteLinksDeleteBulkData = {
2485
- body: {
2486
- link_ids: Array<string>;
2487
- };
2488
- url: "/links/delete_bulk";
2489
- };
2490
-
2491
- export type DeleteLinksDeleteBulkResponses = {
2492
- /**
2493
- * Default Response
2494
- */
2495
- 200: {
2496
- success: boolean;
2497
- error?: string;
2498
- };
2499
- };
2500
-
2501
- export type DeleteLinksDeleteBulkResponse = DeleteLinksDeleteBulkResponses[keyof DeleteLinksDeleteBulkResponses];
2502
-
2503
- export type PostLinksArchiveData = {
2504
- body: {
2505
- link_id: string;
2506
- domain_id?: string;
2507
- };
2508
- url: "/links/archive";
2509
- };
2510
-
2511
- export type PostLinksArchiveErrors = {
2512
- /**
2513
- * Default Response
2514
- */
2515
- 400: {
2516
- error: string;
2517
- message?: string;
2518
- };
2519
- };
2520
-
2521
- export type PostLinksArchiveError = PostLinksArchiveErrors[keyof PostLinksArchiveErrors];
2522
-
2523
- export type PostLinksArchiveResponses = {
2524
- /**
2525
- * Default Response
2526
- */
2527
- 200: {
2528
- success: boolean;
2529
- error?: string;
2530
- };
2531
- };
2532
-
2533
- export type PostLinksArchiveResponse = PostLinksArchiveResponses[keyof PostLinksArchiveResponses];
2534
-
2535
- export type PostLinksArchiveBulkData = {
2536
- body: {
2537
- link_ids: Array<string>;
2538
- domain_id?: string;
2539
- };
2540
- url: "/links/archive_bulk";
2541
- };
2542
-
2543
- export type PostLinksArchiveBulkErrors = {
2544
- /**
2545
- * Default Response
2546
- */
2547
- 400: {
2548
- error: string;
2549
- message?: string;
2550
- };
2551
- };
2552
-
2553
- export type PostLinksArchiveBulkError = PostLinksArchiveBulkErrors[keyof PostLinksArchiveBulkErrors];
2554
-
2555
- export type PostLinksArchiveBulkResponses = {
2556
- /**
2557
- * Default Response
2558
- */
2559
- 200: {
2560
- success: boolean;
2561
- error?: string;
2562
- };
2563
- };
2564
-
2565
- export type PostLinksArchiveBulkResponse = PostLinksArchiveBulkResponses[keyof PostLinksArchiveBulkResponses];
2566
-
2567
- export type PostLinksUnarchiveData = {
2568
- body: {
2569
- link_id: string;
2570
- domain_id?: string;
2571
- };
2572
- url: "/links/unarchive";
2573
- };
2574
-
2575
- export type PostLinksUnarchiveErrors = {
2576
- /**
2577
- * Default Response
2578
- */
2579
- 400: {
2580
- error: string;
2581
- message?: string;
2582
- };
2583
- };
2584
-
2585
- export type PostLinksUnarchiveError = PostLinksUnarchiveErrors[keyof PostLinksUnarchiveErrors];
2586
-
2587
- export type PostLinksUnarchiveResponses = {
2588
- /**
2589
- * Default Response
2590
- */
2591
- 200: {
2592
- success: boolean;
2593
- error?: string;
2594
- };
2595
- };
2596
-
2597
- export type PostLinksUnarchiveResponse = PostLinksUnarchiveResponses[keyof PostLinksUnarchiveResponses];
2598
-
2599
- export type PostLinksUnarchiveBulkData = {
2600
- body: {
2601
- link_ids: Array<string>;
2602
- domain_id?: string;
2603
- };
2604
- url: "/links/unarchive_bulk";
2605
- };
2606
-
2607
- export type PostLinksUnarchiveBulkErrors = {
2608
- /**
2609
- * Default Response
2610
- */
2611
- 400: {
2612
- error: string;
2613
- message?: string;
2614
- };
2615
- };
2616
-
2617
- export type PostLinksUnarchiveBulkError = PostLinksUnarchiveBulkErrors[keyof PostLinksUnarchiveBulkErrors];
2618
-
2619
- export type PostLinksUnarchiveBulkResponses = {
2620
- /**
2621
- * Default Response
2622
- */
2623
- 200: {
2624
- success: boolean;
2625
- error?: string;
2626
- };
2627
- };
2628
-
2629
- export type PostLinksUnarchiveBulkResponse = PostLinksUnarchiveBulkResponses[keyof PostLinksUnarchiveBulkResponses];
2630
-
2631
- export type GetLinksByLinkIdData = {
2632
- body?: never;
2633
- path: {
2634
- linkId: string;
2635
- };
2636
- query?: {
2637
- /**
2638
- * [DEPRECATED] Domain ID
2639
- */
2640
- domainId?: string;
2641
- };
2642
- url: "/links/{linkId}";
2643
- };
2644
-
2645
- export type GetLinksByLinkIdErrors = {
2646
- /**
2647
- * Default Response
2648
- */
2649
- 404: {
2650
- error: string;
2651
- };
2652
- };
2653
-
2654
- export type GetLinksByLinkIdError = GetLinksByLinkIdErrors[keyof GetLinksByLinkIdErrors];
2655
-
2656
- export type GetLinksByLinkIdResponses = {
2657
- /**
2658
- * Default Response
2659
- */
2660
- 200: {
2661
- /**
2662
- * Original URL
2663
- */
2664
- originalURL: string;
2665
- /**
2666
- * Cloaking
2667
- */
2668
- cloaking?: boolean;
2669
- /**
2670
- * Link password
2671
- */
2672
- password?: string;
2673
- /**
2674
- * Link expiration date in milliseconds or ISO string
2675
- */
2676
- expiresAt?: number | string;
2677
- /**
2678
- * Expired URL
2679
- */
2680
- expiredURL?: string;
2681
- /**
2682
- * Link title
2683
- */
2684
- title?: string;
2685
- /**
2686
- * Array of link tags
2687
- */
2688
- tags?: Array<string>;
2689
- /**
2690
- * set utm_source parameter to destination link
2691
- */
2692
- utmSource?: string;
2693
- /**
2694
- * set utm_medium parameter to destination link
2695
- */
2696
- utmMedium?: string;
2697
- /**
2698
- * set utm_campaign parameter to destination link
2699
- */
2700
- utmCampaign?: string;
2701
- /**
2702
- * set utm_term parameter to destination link
2703
- */
2704
- utmTerm?: string;
2705
- /**
2706
- * set utm_content parameter to destination link
2707
- */
2708
- utmContent?: string;
2709
- /**
2710
- * Time to live in milliseconds or ISO string
2711
- */
2712
- ttl?: string | number;
2713
- path: string;
2714
- /**
2715
- * Android URL
2716
- */
2717
- androidURL?: string;
2718
- /**
2719
- * iPhone URL
2720
- */
2721
- iphoneURL?: string;
2722
- /**
2723
- * Link creation date in milliseconds
2724
- */
2725
- createdAt?: number | string;
2726
- /**
2727
- * disable link after specified number of clicks
2728
- */
2729
- clicksLimit?: number;
2730
- /**
2731
- * Provide your email to users to get a password
2732
- */
2733
- passwordContact?: boolean;
2734
- /**
2735
- * Skip query string merging
2736
- */
2737
- skipQS?: boolean;
2738
- /**
2739
- * Link is archived
2740
- */
2741
- archived?: boolean;
2742
- /**
2743
- * Split URL
2744
- */
2745
- splitURL?: string;
2746
- /**
2747
- * Split URL percentage
2748
- */
2749
- splitPercent?: number;
2750
- /**
2751
- * Adroll integration
2752
- */
2753
- integrationAdroll?: string;
2754
- /**
2755
- * Facebook integration
2756
- */
2757
- integrationFB?: string;
2758
- /**
2759
- * Google Analytics integration
2760
- */
2761
- integrationGA?: string;
2762
- /**
2763
- * Google Tag Manager integration
2764
- */
2765
- integrationGTM?: string;
2766
- /**
2767
- * Link ID
2768
- */
2769
- idString: string;
2770
- /**
2771
- * Link ID
2772
- */
2773
- id: string;
2774
- /**
2775
- * Short URL
2776
- */
2777
- shortURL: string;
2778
- /**
2779
- * Secure short URL
2780
- */
2781
- secureShortURL: string;
2782
- /**
2783
- * HTTP code for redirect
2784
- */
2785
- redirectType?: "301" | "302" | "307" | "308";
2786
- /**
2787
- * Folder ID
2788
- */
2789
- FolderId?: string;
2790
- /**
2791
- * Domain ID
2792
- */
2793
- DomainId?: number;
2794
- /**
2795
- * Owner ID
2796
- */
2797
- OwnerId?: number;
2798
- /**
2799
- * Link has password
2800
- */
2801
- hasPassword?: boolean;
2802
- /**
2803
- * Link source
2804
- */
2805
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
2806
- User?: {
2807
- /**
2808
- * Creator user ID
2809
- */
2810
- id: number;
2811
- /**
2812
- * Creator name
2813
- */
2814
- name: string;
2815
- /**
2816
- * Creator email
2817
- */
2818
- email: string;
2819
- /**
2820
- * User photo URL
2821
- */
2822
- photoURL: string;
2823
- };
2824
- };
2825
- };
2826
-
2827
- export type GetLinksByLinkIdResponse = GetLinksByLinkIdResponses[keyof GetLinksByLinkIdResponses];
2828
-
2829
- export type PostLinksByLinkIdData = {
2830
- body?: {
2831
- /**
2832
- * Cloaking
2833
- */
2834
- cloaking?: boolean;
2835
- /**
2836
- * Link password
2837
- */
2838
- password?: string;
2839
- /**
2840
- * HTTP code for redirect
2841
- */
2842
- redirectType?: 301 | 302 | 307 | 308;
2843
- /**
2844
- * Link expiration date in milliseconds or ISO string
2845
- */
2846
- expiresAt?: number | string;
2847
- /**
2848
- * Expired URL
2849
- */
2850
- expiredURL?: string;
2851
- /**
2852
- * Link title
2853
- */
2854
- title?: string;
2855
- /**
2856
- * Array of link tags
2857
- */
2858
- tags?: Array<string>;
2859
- /**
2860
- * set utm_source parameter to destination link
2861
- */
2862
- utmSource?: string;
2863
- /**
2864
- * set utm_medium parameter to destination link
2865
- */
2866
- utmMedium?: string;
2867
- /**
2868
- * set utm_campaign parameter to destination link
2869
- */
2870
- utmCampaign?: string;
2871
- /**
2872
- * set utm_term parameter to destination link
2873
- */
2874
- utmTerm?: string;
2875
- /**
2876
- * set utm_content parameter to destination link
2877
- */
2878
- utmContent?: string;
2879
- /**
2880
- * Time to live in milliseconds or ISO string
2881
- */
2882
- ttl?: string | number;
2883
- /**
2884
- * Link slug
2885
- */
2886
- path?: string;
2887
- /**
2888
- * Android URL
2889
- */
2890
- androidURL?: string;
2891
- /**
2892
- * iPhone URL
2893
- */
2894
- iphoneURL?: string;
2895
- /**
2896
- * Link creation date in milliseconds
2897
- */
2898
- createdAt?: number | string;
2899
- /**
2900
- * disable link after specified number of clicks
2901
- */
2902
- clicksLimit?: number;
2903
- /**
2904
- * Provide your email to users to get a password
2905
- */
2906
- passwordContact?: boolean;
2907
- skipQS?: boolean;
2908
- /**
2909
- * Link is archived
2910
- */
2911
- archived?: boolean;
2912
- /**
2913
- * Split URL
2914
- */
2915
- splitURL?: string;
2916
- /**
2917
- * Split URL percentage
2918
- */
2919
- splitPercent?: number;
2920
- /**
2921
- * Adroll integration
2922
- */
2923
- integrationAdroll?: string;
2924
- /**
2925
- * Facebook integration
2926
- */
2927
- integrationFB?: string;
2928
- /**
2929
- * Google Analytics integration
2930
- */
2931
- integrationGA?: string;
2932
- /**
2933
- * Google Tag Manager integration
2934
- */
2935
- integrationGTM?: string;
2936
- /**
2937
- * Original URL
2938
- */
2939
- originalURL?: string;
2940
- };
2941
- path: {
2942
- linkId: string;
2943
- };
2944
- query?: {
2945
- domain_id?: string;
2946
- };
2947
- url: "/links/{linkId}";
2948
- };
2949
-
2950
- export type PostLinksByLinkIdErrors = {
2951
- /**
2952
- * Default Response
2953
- */
2954
- 400: {
2955
- message: string;
2956
- field?: string;
2957
- };
2958
- /**
2959
- * Default Response
2960
- */
2961
- 404: {
2962
- message: string;
2963
- };
2964
- };
2965
-
2966
- export type PostLinksByLinkIdError = PostLinksByLinkIdErrors[keyof PostLinksByLinkIdErrors];
2967
-
2968
- export type PostLinksByLinkIdResponses = {
2969
- /**
2970
- * Default Response
2971
- */
2972
- 200: {
2973
- /**
2974
- * Original URL
2975
- */
2976
- originalURL: string;
2977
- /**
2978
- * Cloaking
2979
- */
2980
- cloaking?: boolean;
2981
- /**
2982
- * Link password
2983
- */
2984
- password?: string;
2985
- /**
2986
- * Link expiration date in milliseconds or ISO string
2987
- */
2988
- expiresAt?: number | string;
2989
- /**
2990
- * Expired URL
2991
- */
2992
- expiredURL?: string;
2993
- /**
2994
- * Link title
2995
- */
2996
- title?: string;
2997
- /**
2998
- * Array of link tags
2999
- */
3000
- tags?: Array<string>;
3001
- /**
3002
- * set utm_source parameter to destination link
3003
- */
3004
- utmSource?: string;
3005
- /**
3006
- * set utm_medium parameter to destination link
3007
- */
3008
- utmMedium?: string;
3009
- /**
3010
- * set utm_campaign parameter to destination link
3011
- */
3012
- utmCampaign?: string;
3013
- /**
3014
- * set utm_term parameter to destination link
3015
- */
3016
- utmTerm?: string;
3017
- /**
3018
- * set utm_content parameter to destination link
3019
- */
3020
- utmContent?: string;
3021
- /**
3022
- * Time to live in milliseconds or ISO string
3023
- */
3024
- ttl?: string | number;
3025
- path: string;
3026
- /**
3027
- * Android URL
3028
- */
3029
- androidURL?: string;
3030
- /**
3031
- * iPhone URL
3032
- */
3033
- iphoneURL?: string;
3034
- /**
3035
- * Link creation date in milliseconds
3036
- */
3037
- createdAt?: number | string;
3038
- /**
3039
- * disable link after specified number of clicks
3040
- */
3041
- clicksLimit?: number;
3042
- /**
3043
- * Provide your email to users to get a password
3044
- */
3045
- passwordContact?: boolean;
3046
- /**
3047
- * Skip query string merging
3048
- */
3049
- skipQS?: boolean;
3050
- /**
3051
- * Link is archived
3052
- */
3053
- archived?: boolean;
3054
- /**
3055
- * Split URL
3056
- */
3057
- splitURL?: string;
3058
- /**
3059
- * Split URL percentage
3060
- */
3061
- splitPercent?: number;
3062
- /**
3063
- * Adroll integration
3064
- */
3065
- integrationAdroll?: string;
3066
- /**
3067
- * Facebook integration
3068
- */
3069
- integrationFB?: string;
3070
- /**
3071
- * Google Analytics integration
3072
- */
3073
- integrationGA?: string;
3074
- /**
3075
- * Google Tag Manager integration
3076
- */
3077
- integrationGTM?: string;
3078
- /**
3079
- * Link ID
3080
- */
3081
- idString: string;
3082
- /**
3083
- * Link ID
3084
- */
3085
- id: string;
3086
- /**
3087
- * Short URL
3088
- */
3089
- shortURL: string;
3090
- /**
3091
- * Secure short URL
3092
- */
3093
- secureShortURL: string;
3094
- /**
3095
- * HTTP code for redirect
3096
- */
3097
- redirectType?: "301" | "302" | "307" | "308";
3098
- /**
3099
- * Folder ID
3100
- */
3101
- FolderId?: string;
3102
- /**
3103
- * Domain ID
3104
- */
3105
- DomainId?: number;
3106
- /**
3107
- * Owner ID
3108
- */
3109
- OwnerId?: number;
3110
- /**
3111
- * Link has password
3112
- */
3113
- hasPassword?: boolean;
3114
- /**
3115
- * Link source
3116
- */
3117
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
3118
- User?: {
3119
- /**
3120
- * Creator user ID
3121
- */
3122
- id: number;
3123
- /**
3124
- * Creator name
3125
- */
3126
- name: string;
3127
- /**
3128
- * Creator email
3129
- */
3130
- email: string;
3131
- /**
3132
- * User photo URL
3133
- */
3134
- photoURL: string;
3135
- };
3136
- };
3137
- };
3138
-
3139
- export type PostLinksByLinkIdResponse = PostLinksByLinkIdResponses[keyof PostLinksByLinkIdResponses];
3140
-
3141
- export type GetLinksExpandData = {
3142
- body?: never;
3143
- path?: never;
3144
- query: {
3145
- /**
3146
- * Domain hostname
3147
- */
3148
- domain: string;
3149
- /**
3150
- * Link path
3151
- */
3152
- path: string;
3153
- };
3154
- url: "/links/expand";
3155
- };
3156
-
3157
- export type GetLinksExpandErrors = {
3158
- /**
3159
- * Default Response
3160
- */
3161
- 404: {
3162
- error: string;
3163
- };
3164
- };
3165
-
3166
- export type GetLinksExpandError = GetLinksExpandErrors[keyof GetLinksExpandErrors];
3167
-
3168
- export type GetLinksExpandResponses = {
3169
- /**
3170
- * Default Response
3171
- */
3172
- 200: {
3173
- /**
3174
- * Original URL
3175
- */
3176
- originalURL: string;
3177
- /**
3178
- * Cloaking
3179
- */
3180
- cloaking?: boolean;
3181
- /**
3182
- * Link password
3183
- */
3184
- password?: string;
3185
- /**
3186
- * Link expiration date in milliseconds or ISO string
3187
- */
3188
- expiresAt?: number | string;
3189
- /**
3190
- * Expired URL
3191
- */
3192
- expiredURL?: string;
3193
- /**
3194
- * Link title
3195
- */
3196
- title?: string;
3197
- /**
3198
- * Array of link tags
3199
- */
3200
- tags?: Array<string>;
3201
- /**
3202
- * set utm_source parameter to destination link
3203
- */
3204
- utmSource?: string;
3205
- /**
3206
- * set utm_medium parameter to destination link
3207
- */
3208
- utmMedium?: string;
3209
- /**
3210
- * set utm_campaign parameter to destination link
3211
- */
3212
- utmCampaign?: string;
3213
- /**
3214
- * set utm_term parameter to destination link
3215
- */
3216
- utmTerm?: string;
3217
- /**
3218
- * set utm_content parameter to destination link
3219
- */
3220
- utmContent?: string;
3221
- /**
3222
- * Time to live in milliseconds or ISO string
3223
- */
3224
- ttl?: string | number;
3225
- path: string;
3226
- /**
3227
- * Android URL
3228
- */
3229
- androidURL?: string;
3230
- /**
3231
- * iPhone URL
3232
- */
3233
- iphoneURL?: string;
3234
- /**
3235
- * Link creation date in milliseconds
3236
- */
3237
- createdAt?: number | string;
3238
- /**
3239
- * disable link after specified number of clicks
3240
- */
3241
- clicksLimit?: number;
3242
- /**
3243
- * Provide your email to users to get a password
3244
- */
3245
- passwordContact?: boolean;
3246
- /**
3247
- * Skip query string merging
3248
- */
3249
- skipQS?: boolean;
3250
- /**
3251
- * Link is archived
3252
- */
3253
- archived?: boolean;
3254
- /**
3255
- * Split URL
3256
- */
3257
- splitURL?: string;
3258
- /**
3259
- * Split URL percentage
3260
- */
3261
- splitPercent?: number;
3262
- /**
3263
- * Adroll integration
3264
- */
3265
- integrationAdroll?: string;
3266
- /**
3267
- * Facebook integration
3268
- */
3269
- integrationFB?: string;
3270
- /**
3271
- * Google Analytics integration
3272
- */
3273
- integrationGA?: string;
3274
- /**
3275
- * Google Tag Manager integration
3276
- */
3277
- integrationGTM?: string;
3278
- /**
3279
- * Link ID
3280
- */
3281
- idString: string;
3282
- /**
3283
- * Link ID
3284
- */
3285
- id: string;
3286
- /**
3287
- * Short URL
3288
- */
3289
- shortURL: string;
3290
- /**
3291
- * Secure short URL
3292
- */
3293
- secureShortURL: string;
3294
- /**
3295
- * HTTP code for redirect
3296
- */
3297
- redirectType?: "301" | "302" | "307" | "308";
3298
- /**
3299
- * Folder ID
3300
- */
3301
- FolderId?: string;
3302
- /**
3303
- * Domain ID
3304
- */
3305
- DomainId?: number;
3306
- /**
3307
- * Owner ID
3308
- */
3309
- OwnerId?: number;
3310
- /**
3311
- * Link has password
3312
- */
3313
- hasPassword?: boolean;
3314
- /**
3315
- * Link source
3316
- */
3317
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
3318
- User?: {
3319
- /**
3320
- * Creator user ID
3321
- */
3322
- id: number;
3323
- /**
3324
- * Creator name
3325
- */
3326
- name: string;
3327
- /**
3328
- * Creator email
3329
- */
3330
- email: string;
3331
- /**
3332
- * User photo URL
3333
- */
3334
- photoURL: string;
3335
- };
3336
- };
3337
- };
3338
-
3339
- export type GetLinksExpandResponse = GetLinksExpandResponses[keyof GetLinksExpandResponses];
3340
-
3341
- export type GetLinksByOriginalUrlData = {
3342
- body?: never;
3343
- path?: never;
3344
- query: {
3345
- /**
3346
- * Domain hostname
3347
- */
3348
- domain: string;
3349
- /**
3350
- * Link original URL
3351
- */
3352
- originalURL: string;
3353
- };
3354
- url: "/links/by-original-url";
3355
- };
3356
-
3357
- export type GetLinksByOriginalUrlResponses = {
3358
- /**
3359
- * Default Response
3360
- */
3361
- 200: unknown;
3362
- };
3363
-
3364
- export type GetLinksMultipleByUrlData = {
3365
- body?: never;
3366
- path?: never;
3367
- query: {
3368
- /**
3369
- * Domain hostname
3370
- */
3371
- domain: string;
3372
- /**
3373
- * Link original URL
3374
- */
3375
- originalURL: string;
3376
- };
3377
- url: "/links/multiple-by-url";
3378
- };
3379
-
3380
- export type GetLinksMultipleByUrlResponses = {
3381
- /**
3382
- * Default Response
3383
- */
3384
- 200: unknown;
3385
- };
3386
-
3387
- export type PostLinksData = {
3388
- body: {
3389
- /**
3390
- * Original URL
3391
- */
3392
- originalURL: string;
3393
- /**
3394
- * Cloaking
3395
- */
3396
- cloaking?: boolean;
3397
- /**
3398
- * Link password
3399
- */
3400
- password?: string;
3401
- /**
3402
- * HTTP code for redirect
3403
- */
3404
- redirectType?: 301 | 302 | 307 | 308;
3405
- /**
3406
- * Link expiration date in milliseconds or ISO string
3407
- */
3408
- expiresAt?: number | string;
3409
- /**
3410
- * Expired URL
3411
- */
3412
- expiredURL?: string;
3413
- /**
3414
- * Link title
3415
- */
3416
- title?: string;
3417
- /**
3418
- * Array of link tags
3419
- */
3420
- tags?: Array<string>;
3421
- /**
3422
- * set utm_source parameter to destination link
3423
- */
3424
- utmSource?: string;
3425
- /**
3426
- * set utm_medium parameter to destination link
3427
- */
3428
- utmMedium?: string;
3429
- /**
3430
- * set utm_campaign parameter to destination link
3431
- */
3432
- utmCampaign?: string;
3433
- /**
3434
- * set utm_term parameter to destination link
3435
- */
3436
- utmTerm?: string;
3437
- /**
3438
- * set utm_content parameter to destination link
3439
- */
3440
- utmContent?: string;
3441
- /**
3442
- * Time to live in milliseconds or ISO string
3443
- */
3444
- ttl?: string | number;
3445
- /**
3446
- * Link slug
3447
- */
3448
- path?: string;
3449
- /**
3450
- * Android URL
3451
- */
3452
- androidURL?: string;
3453
- /**
3454
- * iPhone URL
3455
- */
3456
- iphoneURL?: string;
3457
- /**
3458
- * Link creation date in milliseconds
3459
- */
3460
- createdAt?: number | string;
3461
- /**
3462
- * disable link after specified number of clicks
3463
- */
3464
- clicksLimit?: number;
3465
- /**
3466
- * Provide your email to users to get a password
3467
- */
3468
- passwordContact?: boolean;
3469
- skipQS?: boolean;
3470
- /**
3471
- * Link is archived
3472
- */
3473
- archived?: boolean;
3474
- /**
3475
- * Split URL
3476
- */
3477
- splitURL?: string;
3478
- /**
3479
- * Split URL percentage
3480
- */
3481
- splitPercent?: number;
3482
- /**
3483
- * Adroll integration
3484
- */
3485
- integrationAdroll?: string;
3486
- /**
3487
- * Facebook integration
3488
- */
3489
- integrationFB?: string;
3490
- /**
3491
- * Google Analytics integration
3492
- */
3493
- integrationGA?: string;
3494
- /**
3495
- * Google Tag Manager integration
3496
- */
3497
- integrationGTM?: string;
3498
- /**
3499
- * Domain hostname
3500
- */
3501
- domain: string;
3502
- /**
3503
- * Allow duplicates
3504
- */
3505
- allowDuplicates?: boolean;
3506
- /**
3507
- * Folder ID
3508
- */
3509
- folderId?: string;
3510
- };
3511
- url: "/links";
3512
- };
3513
-
3514
- export type PostLinksErrors = {
3515
- /**
3516
- * Default Response
3517
- */
3518
- 400: {
3519
- code?: string;
3520
- message: string;
3521
- success?: boolean;
3522
- statusCode: number;
3523
- };
3524
- };
3525
-
3526
- export type PostLinksError = PostLinksErrors[keyof PostLinksErrors];
3527
-
3528
- export type PostLinksResponses = {
3529
- /**
3530
- * Default Response
3531
- */
3532
- 200: {
3533
- /**
3534
- * Original URL
3535
- */
3536
- originalURL: string;
3537
- /**
3538
- * Cloaking
3539
- */
3540
- cloaking?: boolean;
3541
- /**
3542
- * Link password
3543
- */
3544
- password?: string;
3545
- /**
3546
- * Link expiration date in milliseconds or ISO string
3547
- */
3548
- expiresAt?: number | string;
3549
- /**
3550
- * Expired URL
3551
- */
3552
- expiredURL?: string;
3553
- /**
3554
- * Link title
3555
- */
3556
- title?: string;
3557
- /**
3558
- * Array of link tags
3559
- */
3560
- tags?: Array<string>;
3561
- /**
3562
- * set utm_source parameter to destination link
3563
- */
3564
- utmSource?: string;
3565
- /**
3566
- * set utm_medium parameter to destination link
3567
- */
3568
- utmMedium?: string;
3569
- /**
3570
- * set utm_campaign parameter to destination link
3571
- */
3572
- utmCampaign?: string;
3573
- /**
3574
- * set utm_term parameter to destination link
3575
- */
3576
- utmTerm?: string;
3577
- /**
3578
- * set utm_content parameter to destination link
3579
- */
3580
- utmContent?: string;
3581
- /**
3582
- * Time to live in milliseconds or ISO string
3583
- */
3584
- ttl?: string | number;
3585
- path: string;
3586
- /**
3587
- * Android URL
3588
- */
3589
- androidURL?: string;
3590
- /**
3591
- * iPhone URL
3592
- */
3593
- iphoneURL?: string;
3594
- /**
3595
- * Link creation date in milliseconds
3596
- */
3597
- createdAt?: number | string;
3598
- /**
3599
- * disable link after specified number of clicks
3600
- */
3601
- clicksLimit?: number;
3602
- /**
3603
- * Provide your email to users to get a password
3604
- */
3605
- passwordContact?: boolean;
3606
- /**
3607
- * Skip query string merging
3608
- */
3609
- skipQS?: boolean;
3610
- /**
3611
- * Link is archived
3612
- */
3613
- archived?: boolean;
3614
- /**
3615
- * Split URL
3616
- */
3617
- splitURL?: string;
3618
- /**
3619
- * Split URL percentage
3620
- */
3621
- splitPercent?: number;
3622
- /**
3623
- * Adroll integration
3624
- */
3625
- integrationAdroll?: string;
3626
- /**
3627
- * Facebook integration
3628
- */
3629
- integrationFB?: string;
3630
- /**
3631
- * Google Analytics integration
3632
- */
3633
- integrationGA?: string;
3634
- /**
3635
- * Google Tag Manager integration
3636
- */
3637
- integrationGTM?: string;
3638
- /**
3639
- * Link ID
3640
- */
3641
- idString: string;
3642
- /**
3643
- * Link ID
3644
- */
3645
- id: string;
3646
- /**
3647
- * Short URL
3648
- */
3649
- shortURL: string;
3650
- /**
3651
- * Secure short URL
3652
- */
3653
- secureShortURL: string;
3654
- /**
3655
- * HTTP code for redirect
3656
- */
3657
- redirectType?: "301" | "302" | "307" | "308";
3658
- /**
3659
- * Folder ID
3660
- */
3661
- FolderId?: string;
3662
- /**
3663
- * Domain ID
3664
- */
3665
- DomainId?: number;
3666
- /**
3667
- * Owner ID
3668
- */
3669
- OwnerId?: number;
3670
- /**
3671
- * Link has password
3672
- */
3673
- hasPassword?: boolean;
3674
- /**
3675
- * Link source
3676
- */
3677
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
3678
- User?: {
3679
- /**
3680
- * Creator user ID
3681
- */
3682
- id: number;
3683
- /**
3684
- * Creator name
3685
- */
3686
- name: string;
3687
- /**
3688
- * Creator email
3689
- */
3690
- email: string;
3691
- /**
3692
- * User photo URL
3693
- */
3694
- photoURL: string;
3695
- };
3696
- success?: boolean;
3697
- duplicate?: boolean;
3698
- };
3699
- };
3700
-
3701
- export type PostLinksResponse = PostLinksResponses[keyof PostLinksResponses];
3702
-
3703
- export type GetLinksTweetbotData = {
3704
- body?: never;
3705
- path?: never;
3706
- query: {
3707
- /**
3708
- * Domain hostname
3709
- */
3710
- domain: string;
3711
- /**
3712
- * Link path
3713
- */
3714
- path?: string;
3715
- /**
3716
- * Link original URL
3717
- */
3718
- originalURL: string;
3719
- /**
3720
- * Link title
3721
- */
3722
- title?: string;
3723
- /**
3724
- * Return only URL
3725
- */
3726
- urlOnly?: boolean;
3727
- /**
3728
- * API key
3729
- */
3730
- apiKey: string;
3731
- };
3732
- url: "/links/tweetbot";
3733
- };
3734
-
3735
- export type GetLinksTweetbotResponses = {
3736
- /**
3737
- * Default Response
3738
- */
3739
- 200: unknown;
3740
- };
3741
-
3742
- export type PostLinksPublicData = {
3743
- body: {
3744
- /**
3745
- * Original URL
3746
- */
3747
- originalURL: string;
3748
- /**
3749
- * Cloaking
3750
- */
3751
- cloaking?: boolean;
3752
- /**
3753
- * Link password
3754
- */
3755
- password?: string;
3756
- /**
3757
- * HTTP code for redirect
3758
- */
3759
- redirectType?: 301 | 302 | 307 | 308;
3760
- /**
3761
- * Link expiration date in milliseconds or ISO string
3762
- */
3763
- expiresAt?: number | string;
3764
- /**
3765
- * Expired URL
3766
- */
3767
- expiredURL?: string;
3768
- /**
3769
- * Link title
3770
- */
3771
- title?: string;
3772
- /**
3773
- * Array of link tags
3774
- */
3775
- tags?: Array<string>;
3776
- /**
3777
- * set utm_source parameter to destination link
3778
- */
3779
- utmSource?: string;
3780
- /**
3781
- * set utm_medium parameter to destination link
3782
- */
3783
- utmMedium?: string;
3784
- /**
3785
- * set utm_campaign parameter to destination link
3786
- */
3787
- utmCampaign?: string;
3788
- /**
3789
- * set utm_term parameter to destination link
3790
- */
3791
- utmTerm?: string;
3792
- /**
3793
- * set utm_content parameter to destination link
3794
- */
3795
- utmContent?: string;
3796
- /**
3797
- * Time to live in milliseconds or ISO string
3798
- */
3799
- ttl?: string | number;
3800
- /**
3801
- * Link slug
3802
- */
3803
- path?: string;
3804
- /**
3805
- * Android URL
3806
- */
3807
- androidURL?: string;
3808
- /**
3809
- * iPhone URL
3810
- */
3811
- iphoneURL?: string;
3812
- /**
3813
- * Link creation date in milliseconds
3814
- */
3815
- createdAt?: number | string;
3816
- /**
3817
- * disable link after specified number of clicks
3818
- */
3819
- clicksLimit?: number;
3820
- /**
3821
- * Provide your email to users to get a password
3822
- */
3823
- passwordContact?: boolean;
3824
- /**
3825
- * Skip query string merging
3826
- */
3827
- skipQS?: boolean;
3828
- /**
3829
- * Link is archived
3830
- */
3831
- archived?: boolean;
3832
- /**
3833
- * Split URL
3834
- */
3835
- splitURL?: string;
3836
- /**
3837
- * Split URL percentage
3838
- */
3839
- splitPercent?: number;
3840
- /**
3841
- * Adroll integration
3842
- */
3843
- integrationAdroll?: string;
3844
- /**
3845
- * Facebook integration
3846
- */
3847
- integrationFB?: string;
3848
- /**
3849
- * Google Analytics integration
3850
- */
3851
- integrationGA?: string;
3852
- /**
3853
- * Google Tag Manager integration
3854
- */
3855
- integrationGTM?: string;
3856
- domain: string;
3857
- folderId?: string;
3858
- };
3859
- url: "/links/public";
3860
- };
3861
-
3862
- export type PostLinksPublicErrors = {
3863
- /**
3864
- * Default Response
3865
- */
3866
- 400: {
3867
- code?: string;
3868
- message: string;
3869
- success?: boolean;
3870
- statusCode: number;
3871
- };
3872
- };
3873
-
3874
- export type PostLinksPublicError = PostLinksPublicErrors[keyof PostLinksPublicErrors];
3875
-
3876
- export type PostLinksPublicResponses = {
3877
- /**
3878
- * Default Response
3879
- */
3880
- 200: {
3881
- /**
3882
- * Original URL
3883
- */
3884
- originalURL: string;
3885
- /**
3886
- * Cloaking
3887
- */
3888
- cloaking?: boolean;
3889
- /**
3890
- * Link password
3891
- */
3892
- password?: string;
3893
- /**
3894
- * Link expiration date in milliseconds or ISO string
3895
- */
3896
- expiresAt?: number | string;
3897
- /**
3898
- * Expired URL
3899
- */
3900
- expiredURL?: string;
3901
- /**
3902
- * Link title
3903
- */
3904
- title?: string;
3905
- /**
3906
- * Array of link tags
3907
- */
3908
- tags?: Array<string>;
3909
- /**
3910
- * set utm_source parameter to destination link
3911
- */
3912
- utmSource?: string;
3913
- /**
3914
- * set utm_medium parameter to destination link
3915
- */
3916
- utmMedium?: string;
3917
- /**
3918
- * set utm_campaign parameter to destination link
3919
- */
3920
- utmCampaign?: string;
3921
- /**
3922
- * set utm_term parameter to destination link
3923
- */
3924
- utmTerm?: string;
3925
- /**
3926
- * set utm_content parameter to destination link
3927
- */
3928
- utmContent?: string;
3929
- /**
3930
- * Time to live in milliseconds or ISO string
3931
- */
3932
- ttl?: string | number;
3933
- path: string;
3934
- /**
3935
- * Android URL
3936
- */
3937
- androidURL?: string;
3938
- /**
3939
- * iPhone URL
3940
- */
3941
- iphoneURL?: string;
3942
- /**
3943
- * Link creation date in milliseconds
3944
- */
3945
- createdAt?: number | string;
3946
- /**
3947
- * disable link after specified number of clicks
3948
- */
3949
- clicksLimit?: number;
3950
- /**
3951
- * Provide your email to users to get a password
3952
- */
3953
- passwordContact?: boolean;
3954
- /**
3955
- * Skip query string merging
3956
- */
3957
- skipQS?: boolean;
3958
- /**
3959
- * Link is archived
3960
- */
3961
- archived?: boolean;
3962
- /**
3963
- * Split URL
3964
- */
3965
- splitURL?: string;
3966
- /**
3967
- * Split URL percentage
3968
- */
3969
- splitPercent?: number;
3970
- /**
3971
- * Adroll integration
3972
- */
3973
- integrationAdroll?: string;
3974
- /**
3975
- * Facebook integration
3976
- */
3977
- integrationFB?: string;
3978
- /**
3979
- * Google Analytics integration
3980
- */
3981
- integrationGA?: string;
3982
- /**
3983
- * Google Tag Manager integration
3984
- */
3985
- integrationGTM?: string;
3986
- /**
3987
- * Link ID
3988
- */
3989
- idString: string;
3990
- /**
3991
- * Link ID
3992
- */
3993
- id: string;
3994
- /**
3995
- * Short URL
3996
- */
3997
- shortURL: string;
3998
- /**
3999
- * Secure short URL
4000
- */
4001
- secureShortURL: string;
4002
- /**
4003
- * HTTP code for redirect
4004
- */
4005
- redirectType?: "301" | "302" | "307" | "308";
4006
- /**
4007
- * Folder ID
4008
- */
4009
- FolderId?: string;
4010
- /**
4011
- * Domain ID
4012
- */
4013
- DomainId?: number;
4014
- /**
4015
- * Owner ID
4016
- */
4017
- OwnerId?: number;
4018
- /**
4019
- * Link has password
4020
- */
4021
- hasPassword?: boolean;
4022
- /**
4023
- * Link source
4024
- */
4025
- source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
4026
- User?: {
4027
- /**
4028
- * Creator user ID
4029
- */
4030
- id: number;
4031
- /**
4032
- * Creator name
4033
- */
4034
- name: string;
4035
- /**
4036
- * Creator email
4037
- */
4038
- email: string;
4039
- /**
4040
- * User photo URL
4041
- */
4042
- photoURL: string;
4043
- };
4044
- success?: boolean;
4045
- duplicate?: boolean;
4046
- };
4047
- };
4048
-
4049
- export type PostLinksPublicResponse = PostLinksPublicResponses[keyof PostLinksPublicResponses];
4050
-
4051
- export type PostLinksBulkData = {
4052
- body: {
4053
- domain: string;
4054
- allowDuplicates?: boolean;
4055
- links: Array<{
4056
- allowDuplicates?: boolean;
4057
- /**
4058
- * Original URL
4059
- */
4060
- originalURL: string;
4061
- /**
4062
- * Cloaking
4063
- */
4064
- cloaking?: boolean;
4065
- /**
4066
- * Link password
4067
- */
4068
- password?: string;
4069
- /**
4070
- * HTTP code for redirect
4071
- */
4072
- redirectType?: 301 | 302 | 307 | 308;
4073
- /**
4074
- * Link expiration date in milliseconds or ISO string
4075
- */
4076
- expiresAt?: number | string;
4077
- /**
4078
- * Expired URL
4079
- */
4080
- expiredURL?: string;
4081
- /**
4082
- * Link title
4083
- */
4084
- title?: string;
4085
- /**
4086
- * Array of link tags
4087
- */
4088
- tags?: Array<string>;
4089
- /**
4090
- * set utm_source parameter to destination link
4091
- */
4092
- utmSource?: string;
4093
- /**
4094
- * set utm_medium parameter to destination link
4095
- */
4096
- utmMedium?: string;
4097
- /**
4098
- * set utm_campaign parameter to destination link
4099
- */
4100
- utmCampaign?: string;
4101
- /**
4102
- * set utm_term parameter to destination link
4103
- */
4104
- utmTerm?: string;
4105
- /**
4106
- * set utm_content parameter to destination link
4107
- */
4108
- utmContent?: string;
4109
- /**
4110
- * Time to live in milliseconds or ISO string
4111
- */
4112
- ttl?: string | number;
4113
- /**
4114
- * Link slug
4115
- */
4116
- path?: string;
4117
- /**
4118
- * Android URL
4119
- */
4120
- androidURL?: string;
4121
- /**
4122
- * iPhone URL
4123
- */
4124
- iphoneURL?: string;
4125
- /**
4126
- * Link creation date in milliseconds
4127
- */
4128
- createdAt?: number | string;
4129
- /**
4130
- * disable link after specified number of clicks
4131
- */
4132
- clicksLimit?: number;
4133
- /**
4134
- * Provide your email to users to get a password
4135
- */
4136
- passwordContact?: boolean;
4137
- /**
4138
- * Skip query string merging
4139
- */
4140
- skipQS?: boolean;
4141
- /**
4142
- * Link is archived
4143
- */
4144
- archived?: boolean;
4145
- /**
4146
- * Split URL
4147
- */
4148
- splitURL?: string;
4149
- /**
4150
- * Split URL percentage
4151
- */
4152
- splitPercent?: number;
4153
- /**
4154
- * Adroll integration
4155
- */
4156
- integrationAdroll?: string;
4157
- /**
4158
- * Facebook integration
4159
- */
4160
- integrationFB?: string;
4161
- /**
4162
- * Google Analytics integration
4163
- */
4164
- integrationGA?: string;
4165
- /**
4166
- * Google Tag Manager integration
4167
- */
4168
- integrationGTM?: string;
4169
- }>;
4170
- /**
4171
- * Folder ID
4172
- */
4173
- folderId?: string;
4174
- };
4175
- url: "/links/bulk";
4176
- };
4177
-
4178
- export type PostLinksBulkResponses = {
4179
- /**
4180
- * Default Response
4181
- */
4182
- 200: unknown;
4183
- };
4184
-
4185
- export type GetApiDomainsData = {
4186
- body?: never;
4187
- path?: never;
4188
- query?: {
4189
- limit?: number;
4190
- offset?: number;
4191
- noTeamId?: boolean;
4192
- pattern?: string;
4193
- teamId?: number;
4194
- };
4195
- url: "/api/domains";
4196
- };
4197
-
4198
- export type GetApiDomainsResponses = {
4199
- /**
4200
- * Default Response
4201
- */
4202
- 200: Array<{
4203
- /**
4204
- * Domain ID
4205
- */
4206
- id: number;
4207
- hostname: string;
4208
- unicodeHostname: string;
4209
- state:
4210
- | "extra_records"
4211
- | "not_registered"
4212
- | "configured"
4213
- | "not_configured"
4214
- | "registration_pending"
4215
- | "not_verified";
4216
- createdAt: string;
4217
- updatedAt: string;
4218
- TeamId?: number;
4219
- hasFavicon: boolean;
4220
- segmentKey?: string;
4221
- hideReferer: boolean;
4222
- linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
4223
- /**
4224
- * Enable cloaking for all links on the domain
4225
- */
4226
- cloaking: boolean;
4227
- /**
4228
- * Don't store visitor IPs in our database
4229
- */
4230
- hideVisitorIp: boolean;
4231
- /**
4232
- * Enable AI for all links on the domain
4233
- */
4234
- enableAI: boolean;
4235
- httpsLevel: "none" | "redirect" | "hsts";
4236
- httpsLinks: boolean;
4237
- webhookURL?: string;
4238
- integrationGA?: string;
4239
- integrationFB?: string;
4240
- integrationAdroll?: string;
4241
- integrationGTM?: string;
4242
- clientStorage: {};
4243
- caseSensitive: boolean;
4244
- incrementCounter: string;
4245
- robots: "allow" | "disallow" | "noindex";
4246
- sslCertExpirationDate?: string;
4247
- sslCertInstalledSuccess?: boolean;
4248
- domainRegistrationId?: number;
4249
- UserId?: number;
4250
- exportEnabled: boolean;
4251
- isFavorite: boolean;
4252
- }>;
4253
- };
4254
-
4255
- export type GetApiDomainsResponse = GetApiDomainsResponses[keyof GetApiDomainsResponses];
4256
-
4257
- export type GetDomainsByDomainIdData = {
4258
- body?: never;
4259
- path: {
4260
- domainId: number;
4261
- };
4262
- query?: never;
4263
- url: "/domains/{domainId}";
4264
- };
4265
-
4266
- export type GetDomainsByDomainIdErrors = {
4267
- /**
4268
- * Default Response
4269
- */
4270
- 403: {
4271
- error: string;
4272
- };
4273
- };
4274
-
4275
- export type GetDomainsByDomainIdError = GetDomainsByDomainIdErrors[keyof GetDomainsByDomainIdErrors];
4276
-
4277
- export type GetDomainsByDomainIdResponses = {
4278
- /**
4279
- * Default Response
4280
- */
4281
- 200: {
4282
- /**
4283
- * Domain ID
4284
- */
4285
- id: number;
4286
- hostname: string;
4287
- unicodeHostname: string;
4288
- state:
4289
- | "extra_records"
4290
- | "not_registered"
4291
- | "configured"
4292
- | "not_configured"
4293
- | "registration_pending"
4294
- | "not_verified";
4295
- createdAt: string;
4296
- updatedAt: string;
4297
- TeamId?: number;
4298
- hasFavicon: boolean;
4299
- segmentKey?: string;
4300
- hideReferer: boolean;
4301
- linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
4302
- /**
4303
- * Enable cloaking for all links on the domain
4304
- */
4305
- cloaking: boolean;
4306
- /**
4307
- * Don't store visitor IPs in our database
4308
- */
4309
- hideVisitorIp: boolean;
4310
- /**
4311
- * Enable AI for all links on the domain
4312
- */
4313
- enableAI: boolean;
4314
- httpsLevel: "none" | "redirect" | "hsts";
4315
- httpsLinks: boolean;
4316
- webhookURL?: string;
4317
- integrationGA?: string;
4318
- integrationFB?: string;
4319
- integrationAdroll?: string;
4320
- integrationGTM?: string;
4321
- clientStorage: {};
4322
- caseSensitive: boolean;
4323
- incrementCounter: string;
4324
- robots: "allow" | "disallow" | "noindex";
4325
- sslCertExpirationDate?: string;
4326
- sslCertInstalledSuccess?: boolean;
4327
- domainRegistrationId?: number;
4328
- UserId?: number;
4329
- exportEnabled: boolean;
4330
- ipExclusions: Array<string>;
4331
- userPlan: "tiny" | "hobby" | "small" | "standard" | "large";
4332
- };
4333
- };
4334
-
4335
- export type GetDomainsByDomainIdResponse = GetDomainsByDomainIdResponses[keyof GetDomainsByDomainIdResponses];
4336
-
4337
- export type PostDomainsData = {
4338
- body: {
4339
- /**
4340
- * Domain hostname
4341
- */
4342
- hostname: string;
4343
- hideReferer?: boolean;
4344
- linkType?: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
4345
- };
4346
- url: "/domains";
4347
- };
4348
-
4349
- export type PostDomainsErrors = {
4350
- /**
4351
- * Default Response
4352
- */
4353
- 402: {
4354
- error: string;
4355
- };
4356
- /**
4357
- * Default Response
4358
- */
4359
- 403: {
4360
- error: string;
4361
- };
4362
- /**
4363
- * Default Response
4364
- */
4365
- 409: {
4366
- error: string;
4367
- };
4368
- };
4369
-
4370
- export type PostDomainsError = PostDomainsErrors[keyof PostDomainsErrors];
4371
-
4372
- export type PostDomainsResponses = {
4373
- /**
4374
- * Default Response
4375
- */
4376
- 200: {
4377
- /**
4378
- * Domain ID
4379
- */
4380
- id: number;
4381
- hostname: string;
4382
- unicodeHostname: string;
4383
- state:
4384
- | "extra_records"
4385
- | "not_registered"
4386
- | "configured"
4387
- | "not_configured"
4388
- | "registration_pending"
4389
- | "not_verified";
4390
- createdAt: string;
4391
- updatedAt: string;
4392
- TeamId?: number;
4393
- hasFavicon: boolean;
4394
- segmentKey?: string;
4395
- hideReferer: boolean;
4396
- linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
4397
- /**
4398
- * Enable cloaking for all links on the domain
4399
- */
4400
- cloaking: boolean;
4401
- /**
4402
- * Don't store visitor IPs in our database
4403
- */
4404
- hideVisitorIp: boolean;
4405
- /**
4406
- * Enable AI for all links on the domain
4407
- */
4408
- enableAI: boolean;
4409
- httpsLevel: "none" | "redirect" | "hsts";
4410
- httpsLinks: boolean;
4411
- webhookURL?: string;
4412
- integrationGA?: string;
4413
- integrationFB?: string;
4414
- integrationAdroll?: string;
4415
- integrationGTM?: string;
4416
- clientStorage: {};
4417
- caseSensitive: boolean;
4418
- incrementCounter: string;
4419
- robots: "allow" | "disallow" | "noindex";
4420
- sslCertExpirationDate?: string;
4421
- sslCertInstalledSuccess?: boolean;
4422
- domainRegistrationId?: number;
4423
- UserId?: number;
4424
- exportEnabled: boolean;
4425
- };
4426
- };
4427
-
4428
- export type PostDomainsResponse = PostDomainsResponses[keyof PostDomainsResponses];
4429
-
4430
- export type PostDomainsSettingsByDomainIdData = {
4431
- body?: {
4432
- httpsLevel?: "none" | "redirect" | "hsts";
4433
- robots?: "allow" | "disallow" | "noindex";
4434
- segmentKey?: string;
4435
- linkType?: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
4436
- /**
4437
- * Enable cloaking for all links on the domain
4438
- */
4439
- cloaking?: boolean;
4440
- hideReferer?: boolean;
4441
- /**
4442
- * Don't store visitor IPs in our database
4443
- */
4444
- hideVisitorIp?: boolean;
4445
- /**
4446
- * Set to null to reissue a certificate
4447
- */
4448
- httpsLinks?: boolean;
4449
- webhookURL?: string;
4450
- integrationGA?: string;
4451
- integrationFB?: string;
4452
- integrationAdroll?: string;
4453
- integrationGTM?: string;
4454
- /**
4455
- * For internal use
4456
- */
4457
- clientStorage?: {};
4458
- /**
4459
- * [DEPRECATED] do not use
4460
- */
4461
- purgeExpiredLinks?: boolean;
4462
- enableAI?: boolean;
4463
- /**
4464
- * Enable case sensitivity for short links
4465
- */
4466
- caseSensitive?: boolean;
4467
- };
4468
- path: {
4469
- domainId: number;
4470
- };
4471
- query?: never;
4472
- url: "/domains/settings/{domainId}";
4473
- };
4474
-
4475
- export type PostDomainsSettingsByDomainIdResponses = {
4476
- /**
4477
- * Default Response
4478
- */
4479
- 200: unknown;
4480
- };
4481
-
4482
- export type PostTagsBulkData = {
4483
- body: {
4484
- tag: string;
4485
- link_ids: Array<string>;
4486
- };
4487
- url: "/tags/bulk";
4488
- };
4489
-
4490
- export type PostTagsBulkResponses = {
4491
- /**
4492
- * Default Response
4493
- */
4494
- 200: unknown;
4495
- };
4496
-
4497
- export type GetLinksFoldersByDomainIdData = {
4498
- body?: never;
4499
- path: {
4500
- domainId: number;
4501
- };
4502
- query?: never;
4503
- url: "/links/folders/{domainId}";
4504
- };
4505
-
4506
- export type GetLinksFoldersByDomainIdResponses = {
4507
- /**
4508
- * Default Response
4509
- */
4510
- 200: unknown;
4511
- };
4512
-
4513
- export type GetLinksFoldersByDomainIdByFolderIdData = {
4514
- body?: never;
4515
- path: {
4516
- domainId: number;
4517
- folderId: string;
4518
- };
4519
- query?: never;
4520
- url: "/links/folders/{domainId}/{folderId}";
4521
- };
4522
-
4523
- export type GetLinksFoldersByDomainIdByFolderIdResponses = {
4524
- /**
4525
- * Default Response
4526
- */
4527
- 200: unknown;
4528
- };
4529
-
4530
- export type PostLinksFoldersData = {
4531
- body: {
4532
- domainId: number;
4533
- name: string;
4534
- color?: string;
4535
- backgroundColor?: string;
4536
- logoUrl?: string;
4537
- logoHeight?: number;
4538
- logoWidth?: number;
4539
- ecLevel?: string;
4540
- integrationFB?: string;
4541
- integrationGA?: string;
4542
- integrationGTM?: string;
4543
- integrationAdroll?: string;
4544
- utmCampaign?: string;
4545
- utmMedium?: string;
4546
- utmSource?: string;
4547
- redirectType?: number;
4548
- expiresAtDays?: number;
4549
- icon?: string;
4550
- prefix?: string;
4551
- };
4552
- url: "/links/folders";
4553
- };
4554
-
4555
- export type PostLinksFoldersResponses = {
4556
- /**
4557
- * Default Response
4558
- */
4559
- 200: unknown;
4560
- };