@codeqr/ts 0.9.0 → 0.19.3

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 (141) hide show
  1. package/CHANGELOG.md +231 -0
  2. package/LICENSE +1 -1
  3. package/README.md +12 -1
  4. package/client.d.mts +6 -5
  5. package/client.d.mts.map +1 -1
  6. package/client.d.ts +6 -5
  7. package/client.d.ts.map +1 -1
  8. package/client.js +23 -9
  9. package/client.js.map +1 -1
  10. package/client.mjs +23 -9
  11. package/client.mjs.map +1 -1
  12. package/internal/parse.d.mts.map +1 -1
  13. package/internal/parse.d.ts.map +1 -1
  14. package/internal/parse.js +5 -0
  15. package/internal/parse.js.map +1 -1
  16. package/internal/parse.mjs +5 -0
  17. package/internal/parse.mjs.map +1 -1
  18. package/internal/utils/query.d.mts +2 -0
  19. package/internal/utils/query.d.mts.map +1 -0
  20. package/internal/utils/query.d.ts +2 -0
  21. package/internal/utils/query.d.ts.map +1 -0
  22. package/internal/utils/query.js +10 -0
  23. package/internal/utils/query.js.map +1 -0
  24. package/internal/utils/query.mjs +6 -0
  25. package/internal/utils/query.mjs.map +1 -0
  26. package/internal/utils.d.mts +1 -0
  27. package/internal/utils.d.ts +1 -0
  28. package/internal/utils.js +1 -0
  29. package/internal/utils.js.map +1 -1
  30. package/internal/utils.mjs +1 -0
  31. package/package.json +12 -1
  32. package/resources/analytics.d.mts +1 -1
  33. package/resources/analytics.d.ts +1 -1
  34. package/resources/domains.d.mts +2 -2
  35. package/resources/domains.d.mts.map +1 -1
  36. package/resources/domains.d.ts +2 -2
  37. package/resources/domains.d.ts.map +1 -1
  38. package/resources/domains.js +2 -2
  39. package/resources/domains.js.map +1 -1
  40. package/resources/domains.mjs +2 -2
  41. package/resources/domains.mjs.map +1 -1
  42. package/resources/events.d.mts +8 -138
  43. package/resources/events.d.mts.map +1 -1
  44. package/resources/events.d.ts +8 -138
  45. package/resources/events.d.ts.map +1 -1
  46. package/resources/index.d.mts +2 -2
  47. package/resources/index.d.mts.map +1 -1
  48. package/resources/index.d.ts +2 -2
  49. package/resources/index.d.ts.map +1 -1
  50. package/resources/index.js.map +1 -1
  51. package/resources/index.mjs.map +1 -1
  52. package/resources/links/bulk.d.mts +6 -26
  53. package/resources/links/bulk.d.mts.map +1 -1
  54. package/resources/links/bulk.d.ts +6 -26
  55. package/resources/links/bulk.d.ts.map +1 -1
  56. package/resources/links/bulk.js +0 -14
  57. package/resources/links/bulk.js.map +1 -1
  58. package/resources/links/bulk.mjs +0 -14
  59. package/resources/links/bulk.mjs.map +1 -1
  60. package/resources/links/index.d.mts +2 -2
  61. package/resources/links/index.d.mts.map +1 -1
  62. package/resources/links/index.d.ts +2 -2
  63. package/resources/links/index.d.ts.map +1 -1
  64. package/resources/links/index.js.map +1 -1
  65. package/resources/links/index.mjs +1 -1
  66. package/resources/links/index.mjs.map +1 -1
  67. package/resources/links/links.d.mts +27 -839
  68. package/resources/links/links.d.mts.map +1 -1
  69. package/resources/links/links.d.ts +27 -839
  70. package/resources/links/links.d.ts.map +1 -1
  71. package/resources/links/links.js +0 -26
  72. package/resources/links/links.js.map +1 -1
  73. package/resources/links/links.mjs +0 -26
  74. package/resources/links/links.mjs.map +1 -1
  75. package/resources/projects.d.mts +0 -4
  76. package/resources/projects.d.mts.map +1 -1
  77. package/resources/projects.d.ts +0 -4
  78. package/resources/projects.d.ts.map +1 -1
  79. package/resources/projects.js +0 -7
  80. package/resources/projects.js.map +1 -1
  81. package/resources/projects.mjs +0 -7
  82. package/resources/projects.mjs.map +1 -1
  83. package/resources/qrcodes/bulk.d.mts +31 -34
  84. package/resources/qrcodes/bulk.d.mts.map +1 -1
  85. package/resources/qrcodes/bulk.d.ts +31 -34
  86. package/resources/qrcodes/bulk.d.ts.map +1 -1
  87. package/resources/qrcodes/bulk.js +0 -14
  88. package/resources/qrcodes/bulk.js.map +1 -1
  89. package/resources/qrcodes/bulk.mjs +0 -14
  90. package/resources/qrcodes/bulk.mjs.map +1 -1
  91. package/resources/qrcodes/index.d.mts +2 -2
  92. package/resources/qrcodes/index.d.mts.map +1 -1
  93. package/resources/qrcodes/index.d.ts +2 -2
  94. package/resources/qrcodes/index.d.ts.map +1 -1
  95. package/resources/qrcodes/index.js.map +1 -1
  96. package/resources/qrcodes/index.mjs +1 -1
  97. package/resources/qrcodes/index.mjs.map +1 -1
  98. package/resources/qrcodes/qrcodes.d.mts +67 -696
  99. package/resources/qrcodes/qrcodes.d.mts.map +1 -1
  100. package/resources/qrcodes/qrcodes.d.ts +67 -696
  101. package/resources/qrcodes/qrcodes.d.ts.map +1 -1
  102. package/resources/qrcodes/qrcodes.js +1 -31
  103. package/resources/qrcodes/qrcodes.js.map +1 -1
  104. package/resources/qrcodes/qrcodes.mjs +1 -31
  105. package/resources/qrcodes/qrcodes.mjs.map +1 -1
  106. package/resources/tags.d.mts +9 -5
  107. package/resources/tags.d.mts.map +1 -1
  108. package/resources/tags.d.ts +9 -5
  109. package/resources/tags.d.ts.map +1 -1
  110. package/resources/tags.js +1 -1
  111. package/resources/tags.js.map +1 -1
  112. package/resources/tags.mjs +1 -1
  113. package/resources/tags.mjs.map +1 -1
  114. package/resources/track.d.mts +2 -2
  115. package/resources/track.d.ts +2 -2
  116. package/src/client.ts +28 -24
  117. package/src/internal/parse.ts +6 -0
  118. package/src/internal/utils/query.ts +7 -0
  119. package/src/internal/utils.ts +1 -0
  120. package/src/resources/analytics.ts +1 -1
  121. package/src/resources/domains.ts +3 -3
  122. package/src/resources/events.ts +14 -144
  123. package/src/resources/index.ts +0 -6
  124. package/src/resources/links/bulk.ts +8 -37
  125. package/src/resources/links/index.ts +1 -10
  126. package/src/resources/links/links.ts +29 -1417
  127. package/src/resources/projects.ts +0 -8
  128. package/src/resources/qrcodes/bulk.ts +36 -46
  129. package/src/resources/qrcodes/index.ts +1 -10
  130. package/src/resources/qrcodes/qrcodes.ts +73 -1045
  131. package/src/resources/tags.ts +10 -5
  132. package/src/resources/track.ts +2 -2
  133. package/src/version.ts +1 -1
  134. package/version.d.mts +1 -1
  135. package/version.d.mts.map +1 -1
  136. package/version.d.ts +1 -1
  137. package/version.d.ts.map +1 -1
  138. package/version.js +1 -1
  139. package/version.js.map +1 -1
  140. package/version.mjs +1 -1
  141. package/version.mjs.map +1 -1
@@ -3,7 +3,7 @@
3
3
  import { APIResource } from '../../core/resource';
4
4
  import * as TagsAPI from '../tags';
5
5
  import * as BulkAPI from './bulk';
6
- import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from './bulk';
6
+ import { Bulk, BulkCreateParams, BulkCreateResponse } from './bulk';
7
7
  import { APIPromise } from '../../core/api-promise';
8
8
  import { RequestOptions } from '../../internal/request-options';
9
9
  import { path } from '../../internal/utils/path';
@@ -69,21 +69,6 @@ export class Links extends APIResource {
69
69
  return this._client.delete(path`/links/${linkID}`, options);
70
70
  }
71
71
 
72
- /**
73
- * Retrieve the number of links for the authenticated workspace.
74
- *
75
- * @example
76
- * ```ts
77
- * const response = await client.links.count();
78
- * ```
79
- */
80
- count(
81
- query: LinkCountParams | null | undefined = {},
82
- options?: RequestOptions,
83
- ): APIPromise<LinkCountResponse> {
84
- return this._client.get('/links/count', { query, ...options });
85
- }
86
-
87
72
  /**
88
73
  * Retrieve the info for a link.
89
74
  *
@@ -99,22 +84,6 @@ export class Links extends APIResource {
99
84
  retrieveInfo(query: LinkRetrieveInfoParams, options?: RequestOptions): APIPromise<Link> {
100
85
  return this._client.get('/links/info', { query, ...options });
101
86
  }
102
-
103
- /**
104
- * Upsert a link for the authenticated workspace by its URL. If a link with the
105
- * same URL already exists, return it (or update it if there are any changes).
106
- * Otherwise, a new link will be created.
107
- *
108
- * @example
109
- * ```ts
110
- * const link = await client.links.upsert({
111
- * url: 'https://google.com',
112
- * });
113
- * ```
114
- */
115
- upsert(body: LinkUpsertParams, options?: RequestOptions): APIPromise<Link> {
116
- return this._client.patch('/links/update', { body, ...options });
117
- }
118
87
  }
119
88
 
120
89
  export interface Link {
@@ -378,11 +347,6 @@ export interface LinkDeleteResponse {
378
347
  id: string;
379
348
  }
380
349
 
381
- /**
382
- * The number of links matching the query.
383
- */
384
- export type LinkCountResponse = number;
385
-
386
350
  export interface LinkCreateParams {
387
351
  /**
388
352
  * The destination URL of the short link.
@@ -547,6 +511,11 @@ export interface LinkCreateParams {
547
511
  */
548
512
  trackConversion?: boolean;
549
513
 
514
+ /**
515
+ * Whether this link should be used as a reusable template.
516
+ */
517
+ useAsTemplate?: boolean;
518
+
550
519
  /**
551
520
  * The video of the short link.
552
521
  */
@@ -1231,6 +1200,11 @@ export interface LinkUpdateParams {
1231
1200
  */
1232
1201
  url?: string;
1233
1202
 
1203
+ /**
1204
+ * Whether this link should be used as a reusable template.
1205
+ */
1206
+ useAsTemplate?: boolean;
1207
+
1234
1208
  /**
1235
1209
  * The video of the short link.
1236
1210
  */
@@ -1926,6 +1900,11 @@ export interface LinkListParams {
1926
1900
  */
1927
1901
  trackConversion?: boolean;
1928
1902
 
1903
+ /**
1904
+ * Filter links marked as templates.
1905
+ */
1906
+ useAsTemplate?: boolean;
1907
+
1929
1908
  /**
1930
1909
  * The ID of the user to filter by.
1931
1910
  */
@@ -2445,1397 +2424,35 @@ export namespace LinkListParams {
2445
2424
  }
2446
2425
  }
2447
2426
 
2448
- export interface LinkCountParams {
2449
- /**
2450
- * The Android device to filter by.
2451
- */
2452
- android?: string;
2453
-
2454
- /**
2455
- * Maximum number of clicks
2456
- */
2457
- clicksMax?: number;
2458
-
2459
- /**
2460
- * Minimum number of clicks
2461
- */
2462
- clicksMin?: number;
2463
-
2464
- /**
2465
- * The comments to filter by.
2466
- */
2467
- comments?: string;
2468
-
2469
- /**
2470
- * Created after date (ISO string)
2471
- */
2472
- createdAfter?: string;
2473
-
2474
- /**
2475
- * Created before date (ISO string)
2476
- */
2477
- createdBefore?: string;
2478
-
2479
- /**
2480
- * The domain to filter the links. For example, `ac.me`. If not provided, all links
2481
- * of the project will be returned.
2482
- */
2483
- domain?: string;
2484
-
2485
- /**
2486
- * Expires after date (ISO string)
2487
- */
2488
- expiresAfter?: string;
2489
-
2490
- /**
2491
- * The date and time the short link will expire in ISO-8601 format. Must be in the
2492
- * future.
2493
- */
2494
- expiresAt?: string | null;
2495
-
2496
- /**
2497
- * Expires before date (ISO string)
2498
- */
2499
- expiresBefore?: string;
2500
-
2501
- /**
2502
- * The folder ID to filter the links by.
2503
- */
2504
- folderId?: string;
2505
-
2506
- /**
2507
- * Geographic segmentation information for the short link in JSON format
2508
- * `{[COUNTRY]: https://example.com }`.
2509
- */
2510
- geo?: LinkCountParams.Geo | null;
2511
-
2512
- /**
2513
- * The field to group the links by.
2514
- */
2515
- groupBy?: 'domain' | 'tagId' | 'userId' | 'folderId';
2516
-
2517
- /**
2518
- * Filter links that have comments (any comments)
2519
- */
2520
- hasComments?: boolean;
2521
-
2522
- /**
2523
- * Filter links that have custom social media cards
2524
- */
2525
- hasCustomSocial?: boolean;
2526
-
2527
- /**
2528
- * Filter links that have device targeting
2529
- */
2530
- hasDevice?: boolean;
2531
-
2532
- /**
2533
- * Filter links that have expiration date (any expiration)
2534
- */
2535
- hasExpiration?: boolean;
2536
-
2537
- /**
2538
- * Filter links that have geo-targeting
2539
- */
2540
- hasGeo?: boolean;
2541
-
2542
- /**
2543
- * Filter links that have password protection (any password)
2544
- */
2545
- hasPassword?: boolean;
2546
-
2547
- /**
2548
- * Filter links that have tags (any tags)
2549
- */
2550
- hasTags?: boolean;
2551
-
2552
- /**
2553
- * Filter links that have UTM parameters
2554
- */
2555
- hasUTM?: boolean;
2556
-
2427
+ export interface LinkRetrieveInfoParams {
2557
2428
  /**
2558
- * The iOS device to filter by.
2429
+ * The domain of the link to be retrieved. For example, for `codeqr.link/github`,
2430
+ * the domain is `codeqr.link`.
2559
2431
  */
2560
- ios?: string;
2432
+ domain: string;
2561
2433
 
2562
2434
  /**
2563
- * The password to filter by.
2435
+ * The key of the link to be retrieved. For example, for `codeqr.link/github`, the
2436
+ * key is `github`.
2564
2437
  */
2565
- password?: string;
2438
+ key: string;
2566
2439
 
2567
2440
  /**
2568
2441
  * The slug of the project to which the link belongs. For example, for
2569
2442
  * `app.codeqr.io/acme`, the projectSlug is `acme`.
2570
2443
  */
2571
- projectSlug?: string;
2572
-
2573
- /**
2574
- * The search term to filter the links. The search term will be matched against the
2575
- * short link slug and the destination URL.
2576
- */
2577
- search?: string;
2578
-
2579
- /**
2580
- * If should include archived links in the response. The default is `false` if not
2581
- * provided.
2582
- */
2583
- showArchived?: boolean;
2584
-
2585
- /**
2586
- * @deprecated [OBSOLETO (use tagIds em vez disso)]: The unique ID of the tag
2587
- * assigned to the short link.
2588
- */
2589
- tagId?: string;
2590
-
2591
- /**
2592
- * The IDs of the tags to filter the links.
2593
- */
2594
- tagIds?: string | Array<string>;
2595
-
2596
- /**
2597
- * The unique name of the tags assigned to the short link (case insensitive).
2598
- */
2599
- tagNames?: string | Array<string>;
2600
-
2601
- /**
2602
- * If should include links with conversion tracking enabled. The default is `false`
2603
- * if not provided.
2604
- */
2605
- trackConversion?: boolean;
2606
-
2607
- /**
2608
- * The ID of the user to filter by.
2609
- */
2610
- userId?: string;
2444
+ projectSlug: string;
2611
2445
 
2612
2446
  /**
2613
- * If should include tags in the response. The default is `false` if not provided.
2447
+ * This is the ID of the link in your database. Must be prefixed with `ext_` when
2448
+ * passed as a query parameter.
2614
2449
  */
2615
- withTags?: boolean;
2616
- }
2450
+ externalId?: string;
2617
2451
 
2618
- export namespace LinkCountParams {
2619
2452
  /**
2620
- * Geographic segmentation information for the short link in JSON format
2621
- * `{[COUNTRY]: https://example.com }`.
2453
+ * The unique ID of the short link.
2622
2454
  */
2623
- export interface Geo {
2624
- AD?: string;
2625
-
2626
- AE?: string;
2627
-
2628
- AF?: string;
2629
-
2630
- AG?: string;
2631
-
2632
- AI?: string;
2633
-
2634
- AL?: string;
2635
-
2636
- AM?: string;
2637
-
2638
- AO?: string;
2639
-
2640
- AQ?: string;
2641
-
2642
- AR?: string;
2643
-
2644
- AS?: string;
2645
-
2646
- AT?: string;
2647
-
2648
- AU?: string;
2649
-
2650
- AW?: string;
2651
-
2652
- AX?: string;
2653
-
2654
- AZ?: string;
2655
-
2656
- BA?: string;
2657
-
2658
- BB?: string;
2659
-
2660
- BD?: string;
2661
-
2662
- BE?: string;
2663
-
2664
- BF?: string;
2665
-
2666
- BG?: string;
2667
-
2668
- BH?: string;
2669
-
2670
- BI?: string;
2671
-
2672
- BJ?: string;
2673
-
2674
- BL?: string;
2675
-
2676
- BM?: string;
2677
-
2678
- BN?: string;
2679
-
2680
- BO?: string;
2681
-
2682
- BQ?: string;
2683
-
2684
- BR?: string;
2685
-
2686
- BS?: string;
2687
-
2688
- BT?: string;
2689
-
2690
- BV?: string;
2691
-
2692
- BW?: string;
2693
-
2694
- BY?: string;
2695
-
2696
- BZ?: string;
2697
-
2698
- CA?: string;
2699
-
2700
- CC?: string;
2701
-
2702
- CD?: string;
2703
-
2704
- CF?: string;
2705
-
2706
- CG?: string;
2707
-
2708
- CH?: string;
2709
-
2710
- CI?: string;
2711
-
2712
- CK?: string;
2713
-
2714
- CL?: string;
2715
-
2716
- CM?: string;
2717
-
2718
- CN?: string;
2719
-
2720
- CO?: string;
2721
-
2722
- CR?: string;
2723
-
2724
- CU?: string;
2725
-
2726
- CV?: string;
2727
-
2728
- CW?: string;
2729
-
2730
- CX?: string;
2731
-
2732
- CY?: string;
2733
-
2734
- CZ?: string;
2735
-
2736
- DE?: string;
2737
-
2738
- DJ?: string;
2739
-
2740
- DK?: string;
2741
-
2742
- DM?: string;
2743
-
2744
- DO?: string;
2745
-
2746
- DZ?: string;
2747
-
2748
- EC?: string;
2749
-
2750
- EE?: string;
2751
-
2752
- EG?: string;
2753
-
2754
- EH?: string;
2755
-
2756
- ER?: string;
2757
-
2758
- ES?: string;
2759
-
2760
- ET?: string;
2761
-
2762
- FI?: string;
2763
-
2764
- FJ?: string;
2765
-
2766
- FK?: string;
2767
-
2768
- FM?: string;
2769
-
2770
- FO?: string;
2771
-
2772
- FR?: string;
2773
-
2774
- GA?: string;
2775
-
2776
- GB?: string;
2777
-
2778
- GD?: string;
2779
-
2780
- GE?: string;
2781
-
2782
- GF?: string;
2783
-
2784
- GG?: string;
2785
-
2786
- GH?: string;
2787
-
2788
- GI?: string;
2789
-
2790
- GL?: string;
2791
-
2792
- GM?: string;
2793
-
2794
- GN?: string;
2795
-
2796
- GP?: string;
2797
-
2798
- GQ?: string;
2799
-
2800
- GR?: string;
2801
-
2802
- GS?: string;
2803
-
2804
- GT?: string;
2805
-
2806
- GU?: string;
2807
-
2808
- GW?: string;
2809
-
2810
- GY?: string;
2811
-
2812
- HK?: string;
2813
-
2814
- HM?: string;
2815
-
2816
- HN?: string;
2817
-
2818
- HR?: string;
2819
-
2820
- HT?: string;
2821
-
2822
- HU?: string;
2823
-
2824
- ID?: string;
2825
-
2826
- IE?: string;
2827
-
2828
- IL?: string;
2829
-
2830
- IM?: string;
2831
-
2832
- IN?: string;
2833
-
2834
- IO?: string;
2835
-
2836
- IQ?: string;
2837
-
2838
- IR?: string;
2839
-
2840
- IS?: string;
2841
-
2842
- IT?: string;
2843
-
2844
- JE?: string;
2845
-
2846
- JM?: string;
2847
-
2848
- JO?: string;
2849
-
2850
- JP?: string;
2851
-
2852
- KE?: string;
2853
-
2854
- KG?: string;
2855
-
2856
- KH?: string;
2857
-
2858
- KI?: string;
2859
-
2860
- KM?: string;
2861
-
2862
- KN?: string;
2863
-
2864
- KP?: string;
2865
-
2866
- KR?: string;
2867
-
2868
- KW?: string;
2869
-
2870
- KY?: string;
2871
-
2872
- KZ?: string;
2873
-
2874
- LA?: string;
2875
-
2876
- LB?: string;
2877
-
2878
- LC?: string;
2879
-
2880
- LI?: string;
2881
-
2882
- LK?: string;
2883
-
2884
- LR?: string;
2885
-
2886
- LS?: string;
2887
-
2888
- LT?: string;
2889
-
2890
- LU?: string;
2891
-
2892
- LV?: string;
2893
-
2894
- LY?: string;
2895
-
2896
- MA?: string;
2897
-
2898
- MC?: string;
2899
-
2900
- MD?: string;
2901
-
2902
- ME?: string;
2903
-
2904
- MF?: string;
2905
-
2906
- MG?: string;
2907
-
2908
- MH?: string;
2909
-
2910
- MK?: string;
2911
-
2912
- ML?: string;
2913
-
2914
- MM?: string;
2915
-
2916
- MN?: string;
2917
-
2918
- MO?: string;
2919
-
2920
- MP?: string;
2921
-
2922
- MQ?: string;
2923
-
2924
- MR?: string;
2925
-
2926
- MS?: string;
2927
-
2928
- MT?: string;
2929
-
2930
- MU?: string;
2931
-
2932
- MV?: string;
2933
-
2934
- MW?: string;
2935
-
2936
- MX?: string;
2937
-
2938
- MY?: string;
2939
-
2940
- MZ?: string;
2941
-
2942
- NA?: string;
2943
-
2944
- NC?: string;
2945
-
2946
- NE?: string;
2947
-
2948
- NF?: string;
2949
-
2950
- NG?: string;
2951
-
2952
- NI?: string;
2953
-
2954
- NL?: string;
2955
-
2956
- NO?: string;
2957
-
2958
- NP?: string;
2959
-
2960
- NR?: string;
2961
-
2962
- NU?: string;
2963
-
2964
- NZ?: string;
2965
-
2966
- OM?: string;
2967
-
2968
- PA?: string;
2969
-
2970
- PE?: string;
2971
-
2972
- PF?: string;
2973
-
2974
- PG?: string;
2975
-
2976
- PH?: string;
2977
-
2978
- PK?: string;
2979
-
2980
- PL?: string;
2981
-
2982
- PM?: string;
2983
-
2984
- PN?: string;
2985
-
2986
- PR?: string;
2987
-
2988
- PS?: string;
2989
-
2990
- PT?: string;
2991
-
2992
- PW?: string;
2993
-
2994
- PY?: string;
2995
-
2996
- QA?: string;
2997
-
2998
- RE?: string;
2999
-
3000
- RO?: string;
3001
-
3002
- RS?: string;
3003
-
3004
- RU?: string;
3005
-
3006
- RW?: string;
3007
-
3008
- SA?: string;
3009
-
3010
- SB?: string;
3011
-
3012
- SC?: string;
3013
-
3014
- SD?: string;
3015
-
3016
- SE?: string;
3017
-
3018
- SG?: string;
3019
-
3020
- SH?: string;
3021
-
3022
- SI?: string;
3023
-
3024
- SJ?: string;
3025
-
3026
- SK?: string;
3027
-
3028
- SL?: string;
3029
-
3030
- SM?: string;
3031
-
3032
- SN?: string;
3033
-
3034
- SO?: string;
3035
-
3036
- SR?: string;
3037
-
3038
- SS?: string;
3039
-
3040
- ST?: string;
3041
-
3042
- SV?: string;
3043
-
3044
- SX?: string;
3045
-
3046
- SY?: string;
3047
-
3048
- SZ?: string;
3049
-
3050
- TC?: string;
3051
-
3052
- TD?: string;
3053
-
3054
- TF?: string;
3055
-
3056
- TG?: string;
3057
-
3058
- TH?: string;
3059
-
3060
- TJ?: string;
3061
-
3062
- TK?: string;
3063
-
3064
- TL?: string;
3065
-
3066
- TM?: string;
3067
-
3068
- TN?: string;
3069
-
3070
- TO?: string;
3071
-
3072
- TR?: string;
3073
-
3074
- TT?: string;
3075
-
3076
- TV?: string;
3077
-
3078
- TW?: string;
3079
-
3080
- TZ?: string;
3081
-
3082
- UA?: string;
3083
-
3084
- UG?: string;
3085
-
3086
- UM?: string;
3087
-
3088
- US?: string;
3089
-
3090
- UY?: string;
3091
-
3092
- UZ?: string;
3093
-
3094
- VA?: string;
3095
-
3096
- VC?: string;
3097
-
3098
- VE?: string;
3099
-
3100
- VG?: string;
3101
-
3102
- VI?: string;
3103
-
3104
- VN?: string;
3105
-
3106
- VU?: string;
3107
-
3108
- WF?: string;
3109
-
3110
- WS?: string;
3111
-
3112
- XK?: string;
3113
-
3114
- YE?: string;
3115
-
3116
- YT?: string;
3117
-
3118
- ZA?: string;
3119
-
3120
- ZM?: string;
3121
-
3122
- ZW?: string;
3123
- }
3124
- }
3125
-
3126
- export interface LinkRetrieveInfoParams {
3127
- /**
3128
- * The domain of the link to be retrieved. For example, for `codeqr.link/github`,
3129
- * the domain is `codeqr.link`.
3130
- */
3131
- domain: string;
3132
-
3133
- /**
3134
- * The key of the link to be retrieved. For example, for `codeqr.link/github`, the
3135
- * key is `github`.
3136
- */
3137
- key: string;
3138
-
3139
- /**
3140
- * The slug of the project to which the link belongs. For example, for
3141
- * `app.codeqr.io/acme`, the projectSlug is `acme`.
3142
- */
3143
- projectSlug: string;
3144
-
3145
- /**
3146
- * This is the ID of the link in your database. Must be prefixed with `ext_` when
3147
- * passed as a query parameter.
3148
- */
3149
- externalId?: string;
3150
-
3151
- /**
3152
- * The unique ID of the short link.
3153
- */
3154
- linkId?: string;
3155
- }
3156
-
3157
- export interface LinkUpsertParams {
3158
- /**
3159
- * The destination URL of the short link.
3160
- */
3161
- url: string;
3162
-
3163
- /**
3164
- * The Android destination URL for the short link for Android device targeting.
3165
- */
3166
- android?: string | null;
3167
-
3168
- /**
3169
- * Whether the short link is archived.
3170
- */
3171
- archived?: boolean;
3172
-
3173
- /**
3174
- * The comments for the short link.
3175
- */
3176
- comments?: string | null;
3177
-
3178
- /**
3179
- * The description of the short link generated via `api.codeqr.io/metatags`. Will
3180
- * be used for custom link preview if `proxy` is true.
3181
- */
3182
- description?: string | null;
3183
-
3184
- /**
3185
- * Allow search engines to index your short link. Default is `false` if not
3186
- * provided. Learn more: https://codeqr.link/noindex
3187
- */
3188
- doIndex?: boolean;
3189
-
3190
- /**
3191
- * The domain of the short link. If not provided, the main domain of the project
3192
- * will be used (or `codeqr.link` if the project has no domains).
3193
- */
3194
- domain?: string;
3195
-
3196
- /**
3197
- * The URL to redirect to when the short link expires.
3198
- */
3199
- expiredUrl?: string | null;
3200
-
3201
- /**
3202
- * The date and time when the short link will expire in ISO-8601 format. Must be in
3203
- * the future.
3204
- */
3205
- expiresAt?: string | null;
3206
-
3207
- /**
3208
- * This is the ID of the link in your database. If set, it can be used to identify
3209
- * the link in the future. Must be prefixed with `ext_` when passed as a query
3210
- * parameter.
3211
- */
3212
- externalId?: string | null;
3213
-
3214
- /**
3215
- * Whether the short link is flexible.
3216
- */
3217
- flexible?: boolean;
3218
-
3219
- /**
3220
- * The unique ID existing folder to assign the short link to.
3221
- */
3222
- folderId?: string | null;
3223
-
3224
- /**
3225
- * Geographic targeting information for the short link in JSON format
3226
- * `{[COUNTRY]: https://example.com }`.
3227
- */
3228
- geo?: LinkUpsertParams.Geo | null;
3229
-
3230
- /**
3231
- * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
3232
- * for custom link preview if `proxy` is true.
3233
- */
3234
- image?: string | null;
3235
-
3236
- /**
3237
- * The iOS destination URL for the short link for iOS device targeting.
3238
- */
3239
- ios?: string | null;
3240
-
3241
- /**
3242
- * If the form is mandatory for the page.
3243
- */
3244
- isFormMandatory?: boolean;
3245
-
3246
- /**
3247
- * The slug of the short link. If not provided, a random 7-character slug will be
3248
- * generated.
3249
- */
3250
- key?: string;
3251
-
3252
- /**
3253
- * The ID of the page to redirect to before the link destination.
3254
- */
3255
- pageId?: string | null;
3256
-
3257
- /**
3258
- * The URL of the page to redirect to before the link destination.
3259
- */
3260
- pageUrl?: string | null;
3261
-
3262
- /**
3263
- * The password required to access the short link destination URL.
3264
- */
3265
- password?: string | null;
3266
-
3267
- /**
3268
- * The prefix of the short link slug for randomly generated keys (for example, if
3269
- * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
3270
- * be ignored if `key` is provided.
3271
- */
3272
- prefix?: string;
3273
-
3274
- /**
3275
- * Whether the short link has pre-redirection.
3276
- */
3277
- preRedirection?: boolean;
3278
-
3279
- /**
3280
- * Whether the short link uses the custom link preview feature.
3281
- */
3282
- proxy?: boolean;
3283
-
3284
- /**
3285
- * Whether the short link statistics are publicly accessible.
3286
- */
3287
- publicStats?: boolean;
3288
-
3289
- /**
3290
- * Whether the short link uses link cloaking.
3291
- */
3292
- rewrite?: boolean;
3293
-
3294
- /**
3295
- * @deprecated The unique ID of the tag assigned to the short link. This field is
3296
- * deprecated – use `tagIds` instead.
3297
- */
3298
- tagId?: string | null;
3299
-
3300
- /**
3301
- * The unique IDs of the tags assigned to the short link.
3302
- */
3303
- tagIds?: string | Array<string>;
3304
-
3305
- /**
3306
- * The unique name of the tags assigned to the short link (case insensitive).
3307
- */
3308
- tagNames?: string | Array<string>;
3309
-
3310
- /**
3311
- * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
3312
- * for custom link preview if `proxy` is true.
3313
- */
3314
- title?: string | null;
3315
-
3316
- /**
3317
- * Whether to track conversions for the short link.
3318
- */
3319
- trackConversion?: boolean;
3320
-
3321
- /**
3322
- * The video of the short link.
3323
- */
3324
- video?: string | null;
3325
-
3326
- /**
3327
- * An array of webhook IDs to trigger when the link is clicked. These webhooks will
3328
- * receive click event data.
3329
- */
3330
- webhookIds?: Array<string> | null;
3331
- }
3332
-
3333
- export namespace LinkUpsertParams {
3334
- /**
3335
- * Geographic targeting information for the short link in JSON format
3336
- * `{[COUNTRY]: https://example.com }`.
3337
- */
3338
- export interface Geo {
3339
- AD?: string;
3340
-
3341
- AE?: string;
3342
-
3343
- AF?: string;
3344
-
3345
- AG?: string;
3346
-
3347
- AI?: string;
3348
-
3349
- AL?: string;
3350
-
3351
- AM?: string;
3352
-
3353
- AO?: string;
3354
-
3355
- AQ?: string;
3356
-
3357
- AR?: string;
3358
-
3359
- AS?: string;
3360
-
3361
- AT?: string;
3362
-
3363
- AU?: string;
3364
-
3365
- AW?: string;
3366
-
3367
- AX?: string;
3368
-
3369
- AZ?: string;
3370
-
3371
- BA?: string;
3372
-
3373
- BB?: string;
3374
-
3375
- BD?: string;
3376
-
3377
- BE?: string;
3378
-
3379
- BF?: string;
3380
-
3381
- BG?: string;
3382
-
3383
- BH?: string;
3384
-
3385
- BI?: string;
3386
-
3387
- BJ?: string;
3388
-
3389
- BL?: string;
3390
-
3391
- BM?: string;
3392
-
3393
- BN?: string;
3394
-
3395
- BO?: string;
3396
-
3397
- BQ?: string;
3398
-
3399
- BR?: string;
3400
-
3401
- BS?: string;
3402
-
3403
- BT?: string;
3404
-
3405
- BV?: string;
3406
-
3407
- BW?: string;
3408
-
3409
- BY?: string;
3410
-
3411
- BZ?: string;
3412
-
3413
- CA?: string;
3414
-
3415
- CC?: string;
3416
-
3417
- CD?: string;
3418
-
3419
- CF?: string;
3420
-
3421
- CG?: string;
3422
-
3423
- CH?: string;
3424
-
3425
- CI?: string;
3426
-
3427
- CK?: string;
3428
-
3429
- CL?: string;
3430
-
3431
- CM?: string;
3432
-
3433
- CN?: string;
3434
-
3435
- CO?: string;
3436
-
3437
- CR?: string;
3438
-
3439
- CU?: string;
3440
-
3441
- CV?: string;
3442
-
3443
- CW?: string;
3444
-
3445
- CX?: string;
3446
-
3447
- CY?: string;
3448
-
3449
- CZ?: string;
3450
-
3451
- DE?: string;
3452
-
3453
- DJ?: string;
3454
-
3455
- DK?: string;
3456
-
3457
- DM?: string;
3458
-
3459
- DO?: string;
3460
-
3461
- DZ?: string;
3462
-
3463
- EC?: string;
3464
-
3465
- EE?: string;
3466
-
3467
- EG?: string;
3468
-
3469
- EH?: string;
3470
-
3471
- ER?: string;
3472
-
3473
- ES?: string;
3474
-
3475
- ET?: string;
3476
-
3477
- FI?: string;
3478
-
3479
- FJ?: string;
3480
-
3481
- FK?: string;
3482
-
3483
- FM?: string;
3484
-
3485
- FO?: string;
3486
-
3487
- FR?: string;
3488
-
3489
- GA?: string;
3490
-
3491
- GB?: string;
3492
-
3493
- GD?: string;
3494
-
3495
- GE?: string;
3496
-
3497
- GF?: string;
3498
-
3499
- GG?: string;
3500
-
3501
- GH?: string;
3502
-
3503
- GI?: string;
3504
-
3505
- GL?: string;
3506
-
3507
- GM?: string;
3508
-
3509
- GN?: string;
3510
-
3511
- GP?: string;
3512
-
3513
- GQ?: string;
3514
-
3515
- GR?: string;
3516
-
3517
- GS?: string;
3518
-
3519
- GT?: string;
3520
-
3521
- GU?: string;
3522
-
3523
- GW?: string;
3524
-
3525
- GY?: string;
3526
-
3527
- HK?: string;
3528
-
3529
- HM?: string;
3530
-
3531
- HN?: string;
3532
-
3533
- HR?: string;
3534
-
3535
- HT?: string;
3536
-
3537
- HU?: string;
3538
-
3539
- ID?: string;
3540
-
3541
- IE?: string;
3542
-
3543
- IL?: string;
3544
-
3545
- IM?: string;
3546
-
3547
- IN?: string;
3548
-
3549
- IO?: string;
3550
-
3551
- IQ?: string;
3552
-
3553
- IR?: string;
3554
-
3555
- IS?: string;
3556
-
3557
- IT?: string;
3558
-
3559
- JE?: string;
3560
-
3561
- JM?: string;
3562
-
3563
- JO?: string;
3564
-
3565
- JP?: string;
3566
-
3567
- KE?: string;
3568
-
3569
- KG?: string;
3570
-
3571
- KH?: string;
3572
-
3573
- KI?: string;
3574
-
3575
- KM?: string;
3576
-
3577
- KN?: string;
3578
-
3579
- KP?: string;
3580
-
3581
- KR?: string;
3582
-
3583
- KW?: string;
3584
-
3585
- KY?: string;
3586
-
3587
- KZ?: string;
3588
-
3589
- LA?: string;
3590
-
3591
- LB?: string;
3592
-
3593
- LC?: string;
3594
-
3595
- LI?: string;
3596
-
3597
- LK?: string;
3598
-
3599
- LR?: string;
3600
-
3601
- LS?: string;
3602
-
3603
- LT?: string;
3604
-
3605
- LU?: string;
3606
-
3607
- LV?: string;
3608
-
3609
- LY?: string;
3610
-
3611
- MA?: string;
3612
-
3613
- MC?: string;
3614
-
3615
- MD?: string;
3616
-
3617
- ME?: string;
3618
-
3619
- MF?: string;
3620
-
3621
- MG?: string;
3622
-
3623
- MH?: string;
3624
-
3625
- MK?: string;
3626
-
3627
- ML?: string;
3628
-
3629
- MM?: string;
3630
-
3631
- MN?: string;
3632
-
3633
- MO?: string;
3634
-
3635
- MP?: string;
3636
-
3637
- MQ?: string;
3638
-
3639
- MR?: string;
3640
-
3641
- MS?: string;
3642
-
3643
- MT?: string;
3644
-
3645
- MU?: string;
3646
-
3647
- MV?: string;
3648
-
3649
- MW?: string;
3650
-
3651
- MX?: string;
3652
-
3653
- MY?: string;
3654
-
3655
- MZ?: string;
3656
-
3657
- NA?: string;
3658
-
3659
- NC?: string;
3660
-
3661
- NE?: string;
3662
-
3663
- NF?: string;
3664
-
3665
- NG?: string;
3666
-
3667
- NI?: string;
3668
-
3669
- NL?: string;
3670
-
3671
- NO?: string;
3672
-
3673
- NP?: string;
3674
-
3675
- NR?: string;
3676
-
3677
- NU?: string;
3678
-
3679
- NZ?: string;
3680
-
3681
- OM?: string;
3682
-
3683
- PA?: string;
3684
-
3685
- PE?: string;
3686
-
3687
- PF?: string;
3688
-
3689
- PG?: string;
3690
-
3691
- PH?: string;
3692
-
3693
- PK?: string;
3694
-
3695
- PL?: string;
3696
-
3697
- PM?: string;
3698
-
3699
- PN?: string;
3700
-
3701
- PR?: string;
3702
-
3703
- PS?: string;
3704
-
3705
- PT?: string;
3706
-
3707
- PW?: string;
3708
-
3709
- PY?: string;
3710
-
3711
- QA?: string;
3712
-
3713
- RE?: string;
3714
-
3715
- RO?: string;
3716
-
3717
- RS?: string;
3718
-
3719
- RU?: string;
3720
-
3721
- RW?: string;
3722
-
3723
- SA?: string;
3724
-
3725
- SB?: string;
3726
-
3727
- SC?: string;
3728
-
3729
- SD?: string;
3730
-
3731
- SE?: string;
3732
-
3733
- SG?: string;
3734
-
3735
- SH?: string;
3736
-
3737
- SI?: string;
3738
-
3739
- SJ?: string;
3740
-
3741
- SK?: string;
3742
-
3743
- SL?: string;
3744
-
3745
- SM?: string;
3746
-
3747
- SN?: string;
3748
-
3749
- SO?: string;
3750
-
3751
- SR?: string;
3752
-
3753
- SS?: string;
3754
-
3755
- ST?: string;
3756
-
3757
- SV?: string;
3758
-
3759
- SX?: string;
3760
-
3761
- SY?: string;
3762
-
3763
- SZ?: string;
3764
-
3765
- TC?: string;
3766
-
3767
- TD?: string;
3768
-
3769
- TF?: string;
3770
-
3771
- TG?: string;
3772
-
3773
- TH?: string;
3774
-
3775
- TJ?: string;
3776
-
3777
- TK?: string;
3778
-
3779
- TL?: string;
3780
-
3781
- TM?: string;
3782
-
3783
- TN?: string;
3784
-
3785
- TO?: string;
3786
-
3787
- TR?: string;
3788
-
3789
- TT?: string;
3790
-
3791
- TV?: string;
3792
-
3793
- TW?: string;
3794
-
3795
- TZ?: string;
3796
-
3797
- UA?: string;
3798
-
3799
- UG?: string;
3800
-
3801
- UM?: string;
3802
-
3803
- US?: string;
3804
-
3805
- UY?: string;
3806
-
3807
- UZ?: string;
3808
-
3809
- VA?: string;
3810
-
3811
- VC?: string;
3812
-
3813
- VE?: string;
3814
-
3815
- VG?: string;
3816
-
3817
- VI?: string;
3818
-
3819
- VN?: string;
3820
-
3821
- VU?: string;
3822
-
3823
- WF?: string;
3824
-
3825
- WS?: string;
3826
-
3827
- XK?: string;
3828
-
3829
- YE?: string;
3830
-
3831
- YT?: string;
3832
-
3833
- ZA?: string;
3834
-
3835
- ZM?: string;
3836
-
3837
- ZW?: string;
3838
- }
2455
+ linkId?: string;
3839
2456
  }
3840
2457
 
3841
2458
  Links.Bulk = Bulk;
@@ -3845,20 +2462,15 @@ export declare namespace Links {
3845
2462
  type Link as Link,
3846
2463
  type LinkListResponse as LinkListResponse,
3847
2464
  type LinkDeleteResponse as LinkDeleteResponse,
3848
- type LinkCountResponse as LinkCountResponse,
3849
2465
  type LinkCreateParams as LinkCreateParams,
3850
2466
  type LinkUpdateParams as LinkUpdateParams,
3851
2467
  type LinkListParams as LinkListParams,
3852
- type LinkCountParams as LinkCountParams,
3853
2468
  type LinkRetrieveInfoParams as LinkRetrieveInfoParams,
3854
- type LinkUpsertParams as LinkUpsertParams,
3855
2469
  };
3856
2470
 
3857
2471
  export {
3858
2472
  Bulk as Bulk,
3859
2473
  type BulkCreateResponse as BulkCreateResponse,
3860
- type BulkDeleteResponse as BulkDeleteResponse,
3861
2474
  type BulkCreateParams as BulkCreateParams,
3862
- type BulkDeleteParams as BulkDeleteParams,
3863
2475
  };
3864
2476
  }