@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
@@ -1,7 +1,7 @@
1
1
  import { APIResource } from "../../core/resource.js";
2
2
  import * as TagsAPI from "../tags.js";
3
3
  import * as BulkAPI from "./bulk.js";
4
- import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from "./bulk.js";
4
+ import { Bulk, BulkCreateParams, BulkCreateResponse } from "./bulk.js";
5
5
  import { APIPromise } from "../../core/api-promise.js";
6
6
  import { RequestOptions } from "../../internal/request-options.js";
7
7
  export declare class Qrcodes extends APIResource {
@@ -11,10 +11,7 @@ export declare class Qrcodes extends APIResource {
11
11
  *
12
12
  * @example
13
13
  * ```ts
14
- * const qrCode = await client.qrcodes.create({
15
- * folderId: 'folderId',
16
- * type: 'url',
17
- * });
14
+ * const qrCode = await client.qrcodes.create({ type: 'url' });
18
15
  * ```
19
16
  */
20
17
  create(body: QrcodeCreateParams, options?: RequestOptions): APIPromise<QrCode>;
@@ -59,29 +56,6 @@ export declare class Qrcodes extends APIResource {
59
56
  * ```
60
57
  */
61
58
  delete(qrcodeID: string, options?: RequestOptions): APIPromise<QrcodeDeleteResponse>;
62
- /**
63
- * Retrieve the number of QR Codes for the authenticated workspace.
64
- *
65
- * @example
66
- * ```ts
67
- * const response = await client.qrcodes.count();
68
- * ```
69
- */
70
- count(query?: QrcodeCountParams | null | undefined, options?: RequestOptions): APIPromise<QrcodeCountResponse>;
71
- /**
72
- * Upsert a QR Code for the authenticated workspace by its URL. If a QR Code with
73
- * the same URL already exists, return it (or update it if there are any changes).
74
- * Otherwise, a new QR Code will be created.
75
- *
76
- * @example
77
- * ```ts
78
- * const qrCode = await client.qrcodes.upsert({
79
- * folderId: 'folderId',
80
- * type: 'url',
81
- * });
82
- * ```
83
- */
84
- upsert(body: QrcodeUpsertParams, options?: RequestOptions): APIPromise<QrCode>;
85
59
  }
86
60
  export interface QrCode {
87
61
  /**
@@ -328,6 +302,12 @@ export interface QrCode {
328
302
  * The URL of the QR code.
329
303
  */
330
304
  url: string | null;
305
+ /**
306
+ * For dynamic QR codes with phone, email, or sms types: if true (default), shows
307
+ * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
308
+ * URI.
309
+ */
310
+ useDisplayPage: boolean;
331
311
  /**
332
312
  * The ID of the user that created the QR code.
333
313
  */
@@ -384,15 +364,7 @@ export interface QrcodeDeleteResponse {
384
364
  */
385
365
  id: string;
386
366
  }
387
- /**
388
- * The number of QR Codes matching the query.
389
- */
390
- export type QrcodeCountResponse = number;
391
367
  export interface QrcodeCreateParams {
392
- /**
393
- * The unique ID of the folder assigned to the QR code.
394
- */
395
- folderId: string | null;
396
368
  /**
397
369
  * The type of content of the QR code.
398
370
  */
@@ -482,24 +454,38 @@ export interface QrcodeCreateParams {
482
454
  */
483
455
  flexible?: boolean;
484
456
  /**
485
- * The type of frame of the QR code.
457
+ * The unique ID of the folder assigned to the QR code. Omit or set to null for no
458
+ * folder.
459
+ */
460
+ folderId?: string | null;
461
+ /**
462
+ * The type of frame of the QR code (e.g. none, frame-1, frame-2, frame-3, frame-5,
463
+ * frame-6). frame-5/6 are top-bar variants. Unknown ids fall back to no frame at
464
+ * render.
486
465
  */
487
466
  frame?: string;
488
467
  /**
489
- * The color of the frame of the QR code.
468
+ * The color of the frame (hex or CSS keyword). Invalid values are coerced to
469
+ * default.
490
470
  */
491
471
  frameColor?: string;
492
472
  /**
493
473
  * The text of the frame of the QR code.
494
474
  */
495
475
  frameText?: string;
476
+ /**
477
+ * The color of the text inside the frame (hex or CSS keyword). When not set, a
478
+ * contrasting color is derived from the frame color.
479
+ */
480
+ frameTextColor?: string;
496
481
  /**
497
482
  * Geographic segmentation information for the QR code in the JSON format
498
483
  * `{[COUNTRY]: https://example.com }`.
499
484
  */
500
485
  geo?: QrcodeCreateParams.Geo | null;
501
486
  /**
502
- * The height of the QR code.
487
+ * Logo height in pixels. When omitted, a proportional size is used based on the QR
488
+ * code size (about 10–20% depending on size).
503
489
  */
504
490
  height?: number;
505
491
  /**
@@ -626,6 +612,16 @@ export interface QrcodeCreateParams {
626
612
  * The destination URL of the QR code.
627
613
  */
628
614
  url?: string | null;
615
+ /**
616
+ * Whether this QR code should be used as a reusable template.
617
+ */
618
+ useAsTemplate?: boolean;
619
+ /**
620
+ * For dynamic QR codes with phone, email, or sms types: if true (default), shows
621
+ * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
622
+ * URI.
623
+ */
624
+ useDisplayPage?: boolean;
629
625
  /**
630
626
  * The vCard information of the QR code.
631
627
  */
@@ -638,7 +634,8 @@ export interface QrcodeCreateParams {
638
634
  */
639
635
  webhookIds?: Array<string> | null;
640
636
  /**
641
- * The width of the QR code.
637
+ * Logo width in pixels. When omitted, a proportional size is used based on the QR
638
+ * code size (about 10–20% depending on size).
642
639
  */
643
640
  width?: number;
644
641
  /**
@@ -1018,28 +1015,38 @@ export interface QrcodeUpdateParams {
1018
1015
  */
1019
1016
  flexible?: boolean;
1020
1017
  /**
1021
- * The unique ID of the folder assigned to the QR code.
1018
+ * The unique ID of the folder assigned to the QR code. Omit or set to null for no
1019
+ * folder.
1022
1020
  */
1023
1021
  folderId?: string | null;
1024
1022
  /**
1025
- * The type of frame of the QR code.
1023
+ * The type of frame of the QR code (e.g. none, frame-1, frame-2, frame-3, frame-5,
1024
+ * frame-6). frame-5/6 are top-bar variants. Unknown ids fall back to no frame at
1025
+ * render.
1026
1026
  */
1027
1027
  frame?: string;
1028
1028
  /**
1029
- * The color of the frame of the QR code.
1029
+ * The color of the frame (hex or CSS keyword). Invalid values are coerced to
1030
+ * default.
1030
1031
  */
1031
1032
  frameColor?: string;
1032
1033
  /**
1033
1034
  * The text of the frame of the QR code.
1034
1035
  */
1035
1036
  frameText?: string;
1037
+ /**
1038
+ * The color of the text inside the frame (hex or CSS keyword). When not set, a
1039
+ * contrasting color is derived from the frame color.
1040
+ */
1041
+ frameTextColor?: string;
1036
1042
  /**
1037
1043
  * Geographic segmentation information for the QR code in the JSON format
1038
1044
  * `{[COUNTRY]: https://example.com }`.
1039
1045
  */
1040
1046
  geo?: QrcodeUpdateParams.Geo | null;
1041
1047
  /**
1042
- * The height of the QR code.
1048
+ * Logo height in pixels. When omitted, a proportional size is used based on the QR
1049
+ * code size (about 10–20% depending on size).
1043
1050
  */
1044
1051
  height?: number;
1045
1052
  /**
@@ -1170,6 +1177,16 @@ export interface QrcodeUpdateParams {
1170
1177
  * The destination URL of the QR code.
1171
1178
  */
1172
1179
  url?: string | null;
1180
+ /**
1181
+ * Whether this QR code should be used as a reusable template.
1182
+ */
1183
+ useAsTemplate?: boolean;
1184
+ /**
1185
+ * For dynamic QR codes with phone, email, or sms types: if true (default), shows
1186
+ * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
1187
+ * URI.
1188
+ */
1189
+ useDisplayPage?: boolean;
1173
1190
  /**
1174
1191
  * The vCard information of the QR code.
1175
1192
  */
@@ -1182,7 +1199,8 @@ export interface QrcodeUpdateParams {
1182
1199
  */
1183
1200
  webhookIds?: Array<string> | null;
1184
1201
  /**
1185
- * The width of the QR code.
1202
+ * Logo width in pixels. When omitted, a proportional size is used based on the QR
1203
+ * code size (about 10–20% depending on size).
1186
1204
  */
1187
1205
  width?: number;
1188
1206
  /**
@@ -1584,138 +1602,9 @@ export interface QrcodeListParams {
1584
1602
  */
1585
1603
  type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog' | 'pix';
1586
1604
  /**
1587
- * The ID of the user to filter by.
1588
- */
1589
- userId?: string;
1590
- /**
1591
- * If should include tags in the response. The default is `false` if not provided.
1592
- */
1593
- withTags?: boolean;
1594
- }
1595
- export interface QrcodeCountParams {
1596
- /**
1597
- * The comments to filter by.
1598
- */
1599
- comments?: string;
1600
- /**
1601
- * Filter QR codes created after this date
1602
- */
1603
- createdAfter?: string;
1604
- /**
1605
- * Filter QR codes created before this date
1606
- */
1607
- createdBefore?: string;
1608
- /**
1609
- * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
1610
- * codes of the project will be returned.
1611
- */
1612
- domain?: string;
1613
- /**
1614
- * Filter QR codes expiring after this date
1615
- */
1616
- expiresAfter?: string;
1617
- /**
1618
- * The date and time the QR code will expire in ISO-8601 format. Must be in the
1619
- * future.
1620
- */
1621
- expiresAt?: string | null;
1622
- /**
1623
- * Filter QR codes expiring before this date
1624
- */
1625
- expiresBefore?: string;
1626
- /**
1627
- * The folder ID to filter the QR codes by.
1628
- */
1629
- folderId?: string;
1630
- /**
1631
- * Filter by QR code format - static or dynamic
1632
- */
1633
- format?: 'static' | 'dynamic';
1634
- /**
1635
- * The field to group the QR codes.
1636
- */
1637
- groupBy?: 'domain' | 'tagId' | 'userId' | 'folderId';
1638
- /**
1639
- * Filter QR codes with/without comments
1640
- */
1641
- hasComments?: boolean;
1642
- /**
1643
- * Filter QR codes with/without custom social media cards
1644
- */
1645
- hasCustomSocial?: boolean;
1646
- /**
1647
- * Filter QR codes with/without device targeting
1648
- */
1649
- hasDevice?: boolean;
1650
- /**
1651
- * Filter QR codes with/without expiration date
1652
- */
1653
- hasExpiration?: boolean;
1654
- /**
1655
- * Filter QR codes with/without geo-targeting
1656
- */
1657
- hasGeo?: boolean;
1658
- /**
1659
- * Filter QR codes with/without password protection
1660
- */
1661
- hasPassword?: boolean;
1662
- /**
1663
- * Filter QR codes with/without tags
1664
- */
1665
- hasTags?: boolean;
1666
- /**
1667
- * Filter QR codes with/without UTM parameters
1668
- */
1669
- hasUTM?: boolean;
1670
- /**
1671
- * The password to filter by.
1672
- */
1673
- password?: string;
1674
- /**
1675
- * The slug of the project to which the QR code belongs. For example, for
1676
- * `app.codeqr.io/acme`, the projectSlug is `acme`.
1677
- */
1678
- projectSlug?: string;
1679
- /**
1680
- * Maximum number of scans
1681
- */
1682
- scansMax?: number;
1683
- /**
1684
- * Minimum number of scans
1685
- */
1686
- scansMin?: number;
1687
- /**
1688
- * The search term to filter the QR codes. The search term will be matched against
1689
- * the QR code slug and the destination URL.
1690
- */
1691
- search?: string;
1692
- /**
1693
- * If should include archived QR codes in the response. The default is `false` if
1694
- * not provided.
1695
- */
1696
- showArchived?: boolean;
1697
- /**
1698
- * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
1699
- * to the QR code.
1700
- */
1701
- tagId?: string;
1702
- /**
1703
- * The IDs of the tags to filter the QR codes.
1704
- */
1705
- tagIds?: string | Array<string>;
1706
- /**
1707
- * The unique name of the tags assigned to the QR code (case insensitive).
1708
- */
1709
- tagNames?: string | Array<string>;
1710
- /**
1711
- * If should include QR codes with conversion tracking enabled. The default is
1712
- * `false` if not provided.
1713
- */
1714
- trackConversion?: boolean;
1715
- /**
1716
- * Filter by QR code type
1605
+ * Filter QR codes marked as templates.
1717
1606
  */
1718
- type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog' | 'pix';
1607
+ useAsTemplate?: boolean;
1719
1608
  /**
1720
1609
  * The ID of the user to filter by.
1721
1610
  */
@@ -1725,526 +1614,8 @@ export interface QrcodeCountParams {
1725
1614
  */
1726
1615
  withTags?: boolean;
1727
1616
  }
1728
- export interface QrcodeUpsertParams {
1729
- /**
1730
- * The unique ID of the folder assigned to the QR code.
1731
- */
1732
- folderId: string | null;
1733
- /**
1734
- * The type of content of the QR code.
1735
- */
1736
- type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
1737
- /**
1738
- * The destination URL for Android for the QR code for device targeting Android.
1739
- */
1740
- android?: string | null;
1741
- /**
1742
- * If the QR code is archived.
1743
- */
1744
- archived?: boolean;
1745
- /**
1746
- * The background color of the QR code.
1747
- */
1748
- bgColor?: string;
1749
- /**
1750
- * The comments for the QR code.
1751
- */
1752
- comments?: string | null;
1753
- /**
1754
- * The static content of the QR code.
1755
- */
1756
- contentStatic?: string | null;
1757
- /**
1758
- * The cryptocurrency information of the QR code.
1759
- */
1760
- crypto?: {
1761
- [key: string]: string;
1762
- } | null;
1763
- /**
1764
- * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
1765
- * used for custom link preview if `proxy` is true.
1766
- */
1767
- description?: string | null;
1768
- /**
1769
- * Allow search engines to index your QR code. The default is `false` if not
1770
- * provided. Learn more: https://codeqr.link/noindex
1771
- */
1772
- doIndex?: boolean;
1773
- /**
1774
- * The domain of the QR code. If not provided, the main domain of the project will
1775
- * be used (or `codeqr.link` if the project does not have domains).
1776
- */
1777
- domain?: string;
1778
- /**
1779
- * The email information of the QR code.
1780
- */
1781
- email?: {
1782
- [key: string]: string;
1783
- } | null;
1784
- /**
1785
- * If the QR code should have excavated areas.
1786
- */
1787
- excavate?: boolean;
1788
- /**
1789
- * The URL to redirect when the QR code expires.
1790
- */
1791
- expiredUrl?: string | null;
1792
- /**
1793
- * The date and time the QR code will expire in ISO-8601 format. Must be in the
1794
- * future.
1795
- */
1796
- expiresAt?: string | null;
1797
- /**
1798
- * This is the ID of the QR code in your database. If defined, it can be used to
1799
- * identify the QR code in the future. It must be prefixed with `ext_` when passed
1800
- * as a query parameter.
1801
- */
1802
- externalId?: string | null;
1803
- /**
1804
- * The FaceTime information of the QR code.
1805
- */
1806
- facetime?: {
1807
- [key: string]: string;
1808
- } | null;
1809
- /**
1810
- * The foreground color of the QR code.
1811
- */
1812
- fgColor?: string;
1813
- /**
1814
- * If the QR code is filled.
1815
- */
1816
- filled?: boolean;
1817
- /**
1818
- * If the QR code is flexible.
1819
- */
1820
- flexible?: boolean;
1821
- /**
1822
- * The type of frame of the QR code.
1823
- */
1824
- frame?: string;
1825
- /**
1826
- * The color of the frame of the QR code.
1827
- */
1828
- frameColor?: string;
1829
- /**
1830
- * The text of the frame of the QR code.
1831
- */
1832
- frameText?: string;
1833
- /**
1834
- * Geographic segmentation information for the QR code in the JSON format
1835
- * `{[COUNTRY]: https://example.com }`.
1836
- */
1837
- geo?: QrcodeUpsertParams.Geo | null;
1838
- /**
1839
- * The height of the QR code.
1840
- */
1841
- height?: number;
1842
- /**
1843
- * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
1844
- * for custom link preview if `proxy` is true.
1845
- */
1846
- image?: string | null;
1847
- /**
1848
- * The destination URL for iOS for the QR code for device targeting iOS.
1849
- */
1850
- ios?: string | null;
1851
- /**
1852
- * If the form is mandatory for the page.
1853
- */
1854
- isFormMandatory?: boolean;
1855
- /**
1856
- * The slug of the QR code. If not provided, a random slug of 7 characters will be
1857
- * generated.
1858
- */
1859
- key?: string;
1860
- /**
1861
- * The latitude and longitude information of the QR code.
1862
- */
1863
- latlog?: {
1864
- [key: string]: string;
1865
- } | null;
1866
- /**
1867
- * The level of error correction of the QR code.
1868
- */
1869
- level?: string;
1870
- /**
1871
- * The logo of the QR code.
1872
- */
1873
- logo?: string | null;
1874
- /**
1875
- * The ID of the page to redirect to before the QR code destination.
1876
- */
1877
- pageId?: string | null;
1878
- /**
1879
- * The URL of the page to redirect to before the QR code destination.
1880
- */
1881
- pageUrl?: string | null;
1882
- /**
1883
- * The password required to access the destination URL of the QR code.
1884
- */
1885
- password?: string | null;
1886
- /**
1887
- * The pattern of the modules of the QR code.
1888
- */
1889
- pattern?: string;
1890
- /**
1891
- * The phone number of the QR code.
1892
- */
1893
- phone?: string | null;
1894
- /**
1895
- * If the QR code has pre-redirection.
1896
- */
1897
- preRedirection?: boolean;
1898
- /**
1899
- * If the QR code uses the custom link preview feature.
1900
- */
1901
- proxy?: boolean;
1902
- /**
1903
- * If the statistics of the QR code are publicly accessible.
1904
- */
1905
- publicStats?: boolean;
1906
- /**
1907
- * If the QR code uses link cloaking.
1908
- */
1909
- rewrite?: boolean;
1910
- /**
1911
- * The shape of the design around the QR code (none, square, circle).
1912
- */
1913
- shape?: string;
1914
- /**
1915
- * If the logo should be displayed in the QR code.
1916
- */
1917
- showLogo?: boolean;
1918
- /**
1919
- * The size of the QR code.
1920
- */
1921
- size?: number;
1922
- /**
1923
- * The SMS information of the QR code.
1924
- */
1925
- sms?: {
1926
- [key: string]: string;
1927
- } | null;
1928
- /**
1929
- * The image URL of the QR code.
1930
- */
1931
- src?: string | null;
1932
- /**
1933
- * If the QR code is static.
1934
- */
1935
- static?: boolean;
1936
- /**
1937
- * @deprecated The unique ID of the tag assigned to the QR code. This field is
1938
- * deprecated – use `tagIds` instead.
1939
- */
1940
- tagId?: string | null;
1941
- /**
1942
- * The unique IDs of the tags assigned to the QR code.
1943
- */
1944
- tagIds?: string | Array<string>;
1945
- /**
1946
- * The unique name of the tags assigned to the QR code (case insensitive).
1947
- */
1948
- tagNames?: string | Array<string>;
1949
- /**
1950
- * The text of the QR code.
1951
- */
1952
- text?: string | null;
1953
- /**
1954
- * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
1955
- * for custom link preview if `proxy` is true.
1956
- */
1957
- title?: string | null;
1958
- /**
1959
- * If should track conversions for the QR code.
1960
- */
1961
- trackConversion?: boolean;
1962
- /**
1963
- * The destination URL of the QR code.
1964
- */
1965
- url?: string | null;
1966
- /**
1967
- * The vCard information of the QR code.
1968
- */
1969
- vcard?: {
1970
- [key: string]: string;
1971
- } | null;
1972
- /**
1973
- * An array of webhook IDs to trigger when the link is clicked. These webhooks will
1974
- * receive click event data.
1975
- */
1976
- webhookIds?: Array<string> | null;
1977
- /**
1978
- * The width of the QR code.
1979
- */
1980
- width?: number;
1981
- /**
1982
- * The WiFi information of the QR code.
1983
- */
1984
- wifi?: {
1985
- [key: string]: string;
1986
- } | null;
1987
- }
1988
- export declare namespace QrcodeUpsertParams {
1989
- /**
1990
- * Geographic segmentation information for the QR code in the JSON format
1991
- * `{[COUNTRY]: https://example.com }`.
1992
- */
1993
- interface Geo {
1994
- AD?: string;
1995
- AE?: string;
1996
- AF?: string;
1997
- AG?: string;
1998
- AI?: string;
1999
- AL?: string;
2000
- AM?: string;
2001
- AO?: string;
2002
- AQ?: string;
2003
- AR?: string;
2004
- AS?: string;
2005
- AT?: string;
2006
- AU?: string;
2007
- AW?: string;
2008
- AX?: string;
2009
- AZ?: string;
2010
- BA?: string;
2011
- BB?: string;
2012
- BD?: string;
2013
- BE?: string;
2014
- BF?: string;
2015
- BG?: string;
2016
- BH?: string;
2017
- BI?: string;
2018
- BJ?: string;
2019
- BL?: string;
2020
- BM?: string;
2021
- BN?: string;
2022
- BO?: string;
2023
- BQ?: string;
2024
- BR?: string;
2025
- BS?: string;
2026
- BT?: string;
2027
- BV?: string;
2028
- BW?: string;
2029
- BY?: string;
2030
- BZ?: string;
2031
- CA?: string;
2032
- CC?: string;
2033
- CD?: string;
2034
- CF?: string;
2035
- CG?: string;
2036
- CH?: string;
2037
- CI?: string;
2038
- CK?: string;
2039
- CL?: string;
2040
- CM?: string;
2041
- CN?: string;
2042
- CO?: string;
2043
- CR?: string;
2044
- CU?: string;
2045
- CV?: string;
2046
- CW?: string;
2047
- CX?: string;
2048
- CY?: string;
2049
- CZ?: string;
2050
- DE?: string;
2051
- DJ?: string;
2052
- DK?: string;
2053
- DM?: string;
2054
- DO?: string;
2055
- DZ?: string;
2056
- EC?: string;
2057
- EE?: string;
2058
- EG?: string;
2059
- EH?: string;
2060
- ER?: string;
2061
- ES?: string;
2062
- ET?: string;
2063
- FI?: string;
2064
- FJ?: string;
2065
- FK?: string;
2066
- FM?: string;
2067
- FO?: string;
2068
- FR?: string;
2069
- GA?: string;
2070
- GB?: string;
2071
- GD?: string;
2072
- GE?: string;
2073
- GF?: string;
2074
- GG?: string;
2075
- GH?: string;
2076
- GI?: string;
2077
- GL?: string;
2078
- GM?: string;
2079
- GN?: string;
2080
- GP?: string;
2081
- GQ?: string;
2082
- GR?: string;
2083
- GS?: string;
2084
- GT?: string;
2085
- GU?: string;
2086
- GW?: string;
2087
- GY?: string;
2088
- HK?: string;
2089
- HM?: string;
2090
- HN?: string;
2091
- HR?: string;
2092
- HT?: string;
2093
- HU?: string;
2094
- ID?: string;
2095
- IE?: string;
2096
- IL?: string;
2097
- IM?: string;
2098
- IN?: string;
2099
- IO?: string;
2100
- IQ?: string;
2101
- IR?: string;
2102
- IS?: string;
2103
- IT?: string;
2104
- JE?: string;
2105
- JM?: string;
2106
- JO?: string;
2107
- JP?: string;
2108
- KE?: string;
2109
- KG?: string;
2110
- KH?: string;
2111
- KI?: string;
2112
- KM?: string;
2113
- KN?: string;
2114
- KP?: string;
2115
- KR?: string;
2116
- KW?: string;
2117
- KY?: string;
2118
- KZ?: string;
2119
- LA?: string;
2120
- LB?: string;
2121
- LC?: string;
2122
- LI?: string;
2123
- LK?: string;
2124
- LR?: string;
2125
- LS?: string;
2126
- LT?: string;
2127
- LU?: string;
2128
- LV?: string;
2129
- LY?: string;
2130
- MA?: string;
2131
- MC?: string;
2132
- MD?: string;
2133
- ME?: string;
2134
- MF?: string;
2135
- MG?: string;
2136
- MH?: string;
2137
- MK?: string;
2138
- ML?: string;
2139
- MM?: string;
2140
- MN?: string;
2141
- MO?: string;
2142
- MP?: string;
2143
- MQ?: string;
2144
- MR?: string;
2145
- MS?: string;
2146
- MT?: string;
2147
- MU?: string;
2148
- MV?: string;
2149
- MW?: string;
2150
- MX?: string;
2151
- MY?: string;
2152
- MZ?: string;
2153
- NA?: string;
2154
- NC?: string;
2155
- NE?: string;
2156
- NF?: string;
2157
- NG?: string;
2158
- NI?: string;
2159
- NL?: string;
2160
- NO?: string;
2161
- NP?: string;
2162
- NR?: string;
2163
- NU?: string;
2164
- NZ?: string;
2165
- OM?: string;
2166
- PA?: string;
2167
- PE?: string;
2168
- PF?: string;
2169
- PG?: string;
2170
- PH?: string;
2171
- PK?: string;
2172
- PL?: string;
2173
- PM?: string;
2174
- PN?: string;
2175
- PR?: string;
2176
- PS?: string;
2177
- PT?: string;
2178
- PW?: string;
2179
- PY?: string;
2180
- QA?: string;
2181
- RE?: string;
2182
- RO?: string;
2183
- RS?: string;
2184
- RU?: string;
2185
- RW?: string;
2186
- SA?: string;
2187
- SB?: string;
2188
- SC?: string;
2189
- SD?: string;
2190
- SE?: string;
2191
- SG?: string;
2192
- SH?: string;
2193
- SI?: string;
2194
- SJ?: string;
2195
- SK?: string;
2196
- SL?: string;
2197
- SM?: string;
2198
- SN?: string;
2199
- SO?: string;
2200
- SR?: string;
2201
- SS?: string;
2202
- ST?: string;
2203
- SV?: string;
2204
- SX?: string;
2205
- SY?: string;
2206
- SZ?: string;
2207
- TC?: string;
2208
- TD?: string;
2209
- TF?: string;
2210
- TG?: string;
2211
- TH?: string;
2212
- TJ?: string;
2213
- TK?: string;
2214
- TL?: string;
2215
- TM?: string;
2216
- TN?: string;
2217
- TO?: string;
2218
- TR?: string;
2219
- TT?: string;
2220
- TV?: string;
2221
- TW?: string;
2222
- TZ?: string;
2223
- UA?: string;
2224
- UG?: string;
2225
- UM?: string;
2226
- US?: string;
2227
- UY?: string;
2228
- UZ?: string;
2229
- VA?: string;
2230
- VC?: string;
2231
- VE?: string;
2232
- VG?: string;
2233
- VI?: string;
2234
- VN?: string;
2235
- VU?: string;
2236
- WF?: string;
2237
- WS?: string;
2238
- XK?: string;
2239
- YE?: string;
2240
- YT?: string;
2241
- ZA?: string;
2242
- ZM?: string;
2243
- ZW?: string;
2244
- }
2245
- }
2246
1617
  export declare namespace Qrcodes {
2247
- export { type QrCode as QrCode, type QrcodeListResponse as QrcodeListResponse, type QrcodeDeleteResponse as QrcodeDeleteResponse, type QrcodeCountResponse as QrcodeCountResponse, type QrcodeCreateParams as QrcodeCreateParams, type QrcodeRetrieveParams as QrcodeRetrieveParams, type QrcodeUpdateParams as QrcodeUpdateParams, type QrcodeListParams as QrcodeListParams, type QrcodeCountParams as QrcodeCountParams, type QrcodeUpsertParams as QrcodeUpsertParams, };
2248
- export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkDeleteResponse as BulkDeleteResponse, type BulkCreateParams as BulkCreateParams, type BulkDeleteParams as BulkDeleteParams, };
1618
+ export { type QrCode as QrCode, type QrcodeListResponse as QrcodeListResponse, type QrcodeDeleteResponse as QrcodeDeleteResponse, type QrcodeCreateParams as QrcodeCreateParams, type QrcodeRetrieveParams as QrcodeRetrieveParams, type QrcodeUpdateParams as QrcodeUpdateParams, type QrcodeListParams as QrcodeListParams, };
1619
+ export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkCreateParams as BulkCreateParams, };
2249
1620
  }
2250
1621
  //# sourceMappingURL=qrcodes.d.ts.map