@codeqr/ts 0.8.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 +255 -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';
@@ -16,10 +16,7 @@ export class Qrcodes extends APIResource {
16
16
  *
17
17
  * @example
18
18
  * ```ts
19
- * const qrCode = await client.qrcodes.create({
20
- * folderId: 'folderId',
21
- * type: 'url',
22
- * });
19
+ * const qrCode = await client.qrcodes.create({ type: 'url' });
23
20
  * ```
24
21
  */
25
22
  create(body: QrcodeCreateParams, options?: RequestOptions): APIPromise<QrCode> {
@@ -85,38 +82,6 @@ export class Qrcodes extends APIResource {
85
82
  delete(qrcodeID: string, options?: RequestOptions): APIPromise<QrcodeDeleteResponse> {
86
83
  return this._client.delete(path`/qrcodes/${qrcodeID}`, options);
87
84
  }
88
-
89
- /**
90
- * Retrieve the number of QR Codes for the authenticated workspace.
91
- *
92
- * @example
93
- * ```ts
94
- * const response = await client.qrcodes.count();
95
- * ```
96
- */
97
- count(
98
- query: QrcodeCountParams | null | undefined = {},
99
- options?: RequestOptions,
100
- ): APIPromise<QrcodeCountResponse> {
101
- return this._client.get('/qrcodes/count', { query, ...options });
102
- }
103
-
104
- /**
105
- * Upsert a QR Code for the authenticated workspace by its URL. If a QR Code with
106
- * the same URL already exists, return it (or update it if there are any changes).
107
- * Otherwise, a new QR Code will be created.
108
- *
109
- * @example
110
- * ```ts
111
- * const qrCode = await client.qrcodes.upsert({
112
- * folderId: 'folderId',
113
- * type: 'url',
114
- * });
115
- * ```
116
- */
117
- upsert(body: QrcodeUpsertParams, options?: RequestOptions): APIPromise<QrCode> {
118
- return this._client.patch('/qrcodes/upsert', { body, ...options });
119
- }
120
85
  }
121
86
 
122
87
  export interface QrCode {
@@ -419,6 +384,13 @@ export interface QrCode {
419
384
  */
420
385
  url: string | null;
421
386
 
387
+ /**
388
+ * For dynamic QR codes with phone, email, or sms types: if true (default), shows
389
+ * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
390
+ * URI.
391
+ */
392
+ useDisplayPage: boolean;
393
+
422
394
  /**
423
395
  * The ID of the user that created the QR code.
424
396
  */
@@ -484,17 +456,7 @@ export interface QrcodeDeleteResponse {
484
456
  id: string;
485
457
  }
486
458
 
487
- /**
488
- * The number of QR Codes matching the query.
489
- */
490
- export type QrcodeCountResponse = number;
491
-
492
459
  export interface QrcodeCreateParams {
493
- /**
494
- * The unique ID of the folder assigned to the QR code.
495
- */
496
- folderId: string | null;
497
-
498
460
  /**
499
461
  * The type of content of the QR code.
500
462
  */
@@ -597,12 +559,21 @@ export interface QrcodeCreateParams {
597
559
  flexible?: boolean;
598
560
 
599
561
  /**
600
- * The type of frame of the QR code.
562
+ * The unique ID of the folder assigned to the QR code. Omit or set to null for no
563
+ * folder.
564
+ */
565
+ folderId?: string | null;
566
+
567
+ /**
568
+ * The type of frame of the QR code (e.g. none, frame-1, frame-2, frame-3, frame-5,
569
+ * frame-6). frame-5/6 are top-bar variants. Unknown ids fall back to no frame at
570
+ * render.
601
571
  */
602
572
  frame?: string;
603
573
 
604
574
  /**
605
- * The color of the frame of the QR code.
575
+ * The color of the frame (hex or CSS keyword). Invalid values are coerced to
576
+ * default.
606
577
  */
607
578
  frameColor?: string;
608
579
 
@@ -611,6 +582,12 @@ export interface QrcodeCreateParams {
611
582
  */
612
583
  frameText?: string;
613
584
 
585
+ /**
586
+ * The color of the text inside the frame (hex or CSS keyword). When not set, a
587
+ * contrasting color is derived from the frame color.
588
+ */
589
+ frameTextColor?: string;
590
+
614
591
  /**
615
592
  * Geographic segmentation information for the QR code in the JSON format
616
593
  * `{[COUNTRY]: https://example.com }`.
@@ -618,7 +595,8 @@ export interface QrcodeCreateParams {
618
595
  geo?: QrcodeCreateParams.Geo | null;
619
596
 
620
597
  /**
621
- * The height of the QR code.
598
+ * Logo height in pixels. When omitted, a proportional size is used based on the QR
599
+ * code size (about 10–20% depending on size).
622
600
  */
623
601
  height?: number;
624
602
 
@@ -771,6 +749,18 @@ export interface QrcodeCreateParams {
771
749
  */
772
750
  url?: string | null;
773
751
 
752
+ /**
753
+ * Whether this QR code should be used as a reusable template.
754
+ */
755
+ useAsTemplate?: boolean;
756
+
757
+ /**
758
+ * For dynamic QR codes with phone, email, or sms types: if true (default), shows
759
+ * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
760
+ * URI.
761
+ */
762
+ useDisplayPage?: boolean;
763
+
774
764
  /**
775
765
  * The vCard information of the QR code.
776
766
  */
@@ -783,7 +773,8 @@ export interface QrcodeCreateParams {
783
773
  webhookIds?: Array<string> | null;
784
774
 
785
775
  /**
786
- * The width of the QR code.
776
+ * Logo width in pixels. When omitted, a proportional size is used based on the QR
777
+ * code size (about 10–20% depending on size).
787
778
  */
788
779
  width?: number;
789
780
 
@@ -1430,17 +1421,21 @@ export interface QrcodeUpdateParams {
1430
1421
  flexible?: boolean;
1431
1422
 
1432
1423
  /**
1433
- * The unique ID of the folder assigned to the QR code.
1424
+ * The unique ID of the folder assigned to the QR code. Omit or set to null for no
1425
+ * folder.
1434
1426
  */
1435
1427
  folderId?: string | null;
1436
1428
 
1437
1429
  /**
1438
- * The type of frame of the QR code.
1430
+ * The type of frame of the QR code (e.g. none, frame-1, frame-2, frame-3, frame-5,
1431
+ * frame-6). frame-5/6 are top-bar variants. Unknown ids fall back to no frame at
1432
+ * render.
1439
1433
  */
1440
1434
  frame?: string;
1441
1435
 
1442
1436
  /**
1443
- * The color of the frame of the QR code.
1437
+ * The color of the frame (hex or CSS keyword). Invalid values are coerced to
1438
+ * default.
1444
1439
  */
1445
1440
  frameColor?: string;
1446
1441
 
@@ -1449,6 +1444,12 @@ export interface QrcodeUpdateParams {
1449
1444
  */
1450
1445
  frameText?: string;
1451
1446
 
1447
+ /**
1448
+ * The color of the text inside the frame (hex or CSS keyword). When not set, a
1449
+ * contrasting color is derived from the frame color.
1450
+ */
1451
+ frameTextColor?: string;
1452
+
1452
1453
  /**
1453
1454
  * Geographic segmentation information for the QR code in the JSON format
1454
1455
  * `{[COUNTRY]: https://example.com }`.
@@ -1456,7 +1457,8 @@ export interface QrcodeUpdateParams {
1456
1457
  geo?: QrcodeUpdateParams.Geo | null;
1457
1458
 
1458
1459
  /**
1459
- * The height of the QR code.
1460
+ * Logo height in pixels. When omitted, a proportional size is used based on the QR
1461
+ * code size (about 10–20% depending on size).
1460
1462
  */
1461
1463
  height?: number;
1462
1464
 
@@ -1614,6 +1616,18 @@ export interface QrcodeUpdateParams {
1614
1616
  */
1615
1617
  url?: string | null;
1616
1618
 
1619
+ /**
1620
+ * Whether this QR code should be used as a reusable template.
1621
+ */
1622
+ useAsTemplate?: boolean;
1623
+
1624
+ /**
1625
+ * For dynamic QR codes with phone, email, or sms types: if true (default), shows
1626
+ * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
1627
+ * URI.
1628
+ */
1629
+ useDisplayPage?: boolean;
1630
+
1617
1631
  /**
1618
1632
  * The vCard information of the QR code.
1619
1633
  */
@@ -1626,7 +1640,8 @@ export interface QrcodeUpdateParams {
1626
1640
  webhookIds?: Array<string> | null;
1627
1641
 
1628
1642
  /**
1629
- * The width of the QR code.
1643
+ * Logo width in pixels. When omitted, a proportional size is used based on the QR
1644
+ * code size (about 10–20% depending on size).
1630
1645
  */
1631
1646
  width?: number;
1632
1647
 
@@ -2320,179 +2335,9 @@ export interface QrcodeListParams {
2320
2335
  | 'pix';
2321
2336
 
2322
2337
  /**
2323
- * The ID of the user to filter by.
2324
- */
2325
- userId?: string;
2326
-
2327
- /**
2328
- * If should include tags in the response. The default is `false` if not provided.
2329
- */
2330
- withTags?: boolean;
2331
- }
2332
-
2333
- export interface QrcodeCountParams {
2334
- /**
2335
- * The comments to filter by.
2336
- */
2337
- comments?: string;
2338
-
2339
- /**
2340
- * Filter QR codes created after this date
2341
- */
2342
- createdAfter?: string;
2343
-
2344
- /**
2345
- * Filter QR codes created before this date
2346
- */
2347
- createdBefore?: string;
2348
-
2349
- /**
2350
- * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
2351
- * codes of the project will be returned.
2352
- */
2353
- domain?: string;
2354
-
2355
- /**
2356
- * Filter QR codes expiring after this date
2357
- */
2358
- expiresAfter?: string;
2359
-
2360
- /**
2361
- * The date and time the QR code will expire in ISO-8601 format. Must be in the
2362
- * future.
2363
- */
2364
- expiresAt?: string | null;
2365
-
2366
- /**
2367
- * Filter QR codes expiring before this date
2368
- */
2369
- expiresBefore?: string;
2370
-
2371
- /**
2372
- * The folder ID to filter the QR codes by.
2373
- */
2374
- folderId?: string;
2375
-
2376
- /**
2377
- * Filter by QR code format - static or dynamic
2378
- */
2379
- format?: 'static' | 'dynamic';
2380
-
2381
- /**
2382
- * The field to group the QR codes.
2383
- */
2384
- groupBy?: 'domain' | 'tagId' | 'userId' | 'folderId';
2385
-
2386
- /**
2387
- * Filter QR codes with/without comments
2388
- */
2389
- hasComments?: boolean;
2390
-
2391
- /**
2392
- * Filter QR codes with/without custom social media cards
2393
- */
2394
- hasCustomSocial?: boolean;
2395
-
2396
- /**
2397
- * Filter QR codes with/without device targeting
2398
- */
2399
- hasDevice?: boolean;
2400
-
2401
- /**
2402
- * Filter QR codes with/without expiration date
2403
- */
2404
- hasExpiration?: boolean;
2405
-
2406
- /**
2407
- * Filter QR codes with/without geo-targeting
2408
- */
2409
- hasGeo?: boolean;
2410
-
2411
- /**
2412
- * Filter QR codes with/without password protection
2413
- */
2414
- hasPassword?: boolean;
2415
-
2416
- /**
2417
- * Filter QR codes with/without tags
2418
- */
2419
- hasTags?: boolean;
2420
-
2421
- /**
2422
- * Filter QR codes with/without UTM parameters
2423
- */
2424
- hasUTM?: boolean;
2425
-
2426
- /**
2427
- * The password to filter by.
2428
- */
2429
- password?: string;
2430
-
2431
- /**
2432
- * The slug of the project to which the QR code belongs. For example, for
2433
- * `app.codeqr.io/acme`, the projectSlug is `acme`.
2434
- */
2435
- projectSlug?: string;
2436
-
2437
- /**
2438
- * Maximum number of scans
2439
- */
2440
- scansMax?: number;
2441
-
2442
- /**
2443
- * Minimum number of scans
2444
- */
2445
- scansMin?: number;
2446
-
2447
- /**
2448
- * The search term to filter the QR codes. The search term will be matched against
2449
- * the QR code slug and the destination URL.
2450
- */
2451
- search?: string;
2452
-
2453
- /**
2454
- * If should include archived QR codes in the response. The default is `false` if
2455
- * not provided.
2456
- */
2457
- showArchived?: boolean;
2458
-
2459
- /**
2460
- * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
2461
- * to the QR code.
2462
- */
2463
- tagId?: string;
2464
-
2465
- /**
2466
- * The IDs of the tags to filter the QR codes.
2467
- */
2468
- tagIds?: string | Array<string>;
2469
-
2470
- /**
2471
- * The unique name of the tags assigned to the QR code (case insensitive).
2472
- */
2473
- tagNames?: string | Array<string>;
2474
-
2475
- /**
2476
- * If should include QR codes with conversion tracking enabled. The default is
2477
- * `false` if not provided.
2478
- */
2479
- trackConversion?: boolean;
2480
-
2481
- /**
2482
- * Filter by QR code type
2338
+ * Filter QR codes marked as templates.
2483
2339
  */
2484
- type?:
2485
- | 'url'
2486
- | 'text'
2487
- | 'email'
2488
- | 'wifi'
2489
- | 'phone'
2490
- | 'vcard'
2491
- | 'crypto'
2492
- | 'sms'
2493
- | 'facetime'
2494
- | 'latlog'
2495
- | 'pix';
2340
+ useAsTemplate?: boolean;
2496
2341
 
2497
2342
  /**
2498
2343
  * The ID of the user to filter by.
@@ -2505,818 +2350,6 @@ export interface QrcodeCountParams {
2505
2350
  withTags?: boolean;
2506
2351
  }
2507
2352
 
2508
- export interface QrcodeUpsertParams {
2509
- /**
2510
- * The unique ID of the folder assigned to the QR code.
2511
- */
2512
- folderId: string | null;
2513
-
2514
- /**
2515
- * The type of content of the QR code.
2516
- */
2517
- type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
2518
-
2519
- /**
2520
- * The destination URL for Android for the QR code for device targeting Android.
2521
- */
2522
- android?: string | null;
2523
-
2524
- /**
2525
- * If the QR code is archived.
2526
- */
2527
- archived?: boolean;
2528
-
2529
- /**
2530
- * The background color of the QR code.
2531
- */
2532
- bgColor?: string;
2533
-
2534
- /**
2535
- * The comments for the QR code.
2536
- */
2537
- comments?: string | null;
2538
-
2539
- /**
2540
- * The static content of the QR code.
2541
- */
2542
- contentStatic?: string | null;
2543
-
2544
- /**
2545
- * The cryptocurrency information of the QR code.
2546
- */
2547
- crypto?: { [key: string]: string } | null;
2548
-
2549
- /**
2550
- * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
2551
- * used for custom link preview if `proxy` is true.
2552
- */
2553
- description?: string | null;
2554
-
2555
- /**
2556
- * Allow search engines to index your QR code. The default is `false` if not
2557
- * provided. Learn more: https://codeqr.link/noindex
2558
- */
2559
- doIndex?: boolean;
2560
-
2561
- /**
2562
- * The domain of the QR code. If not provided, the main domain of the project will
2563
- * be used (or `codeqr.link` if the project does not have domains).
2564
- */
2565
- domain?: string;
2566
-
2567
- /**
2568
- * The email information of the QR code.
2569
- */
2570
- email?: { [key: string]: string } | null;
2571
-
2572
- /**
2573
- * If the QR code should have excavated areas.
2574
- */
2575
- excavate?: boolean;
2576
-
2577
- /**
2578
- * The URL to redirect when the QR code expires.
2579
- */
2580
- expiredUrl?: string | null;
2581
-
2582
- /**
2583
- * The date and time the QR code will expire in ISO-8601 format. Must be in the
2584
- * future.
2585
- */
2586
- expiresAt?: string | null;
2587
-
2588
- /**
2589
- * This is the ID of the QR code in your database. If defined, it can be used to
2590
- * identify the QR code in the future. It must be prefixed with `ext_` when passed
2591
- * as a query parameter.
2592
- */
2593
- externalId?: string | null;
2594
-
2595
- /**
2596
- * The FaceTime information of the QR code.
2597
- */
2598
- facetime?: { [key: string]: string } | null;
2599
-
2600
- /**
2601
- * The foreground color of the QR code.
2602
- */
2603
- fgColor?: string;
2604
-
2605
- /**
2606
- * If the QR code is filled.
2607
- */
2608
- filled?: boolean;
2609
-
2610
- /**
2611
- * If the QR code is flexible.
2612
- */
2613
- flexible?: boolean;
2614
-
2615
- /**
2616
- * The type of frame of the QR code.
2617
- */
2618
- frame?: string;
2619
-
2620
- /**
2621
- * The color of the frame of the QR code.
2622
- */
2623
- frameColor?: string;
2624
-
2625
- /**
2626
- * The text of the frame of the QR code.
2627
- */
2628
- frameText?: string;
2629
-
2630
- /**
2631
- * Geographic segmentation information for the QR code in the JSON format
2632
- * `{[COUNTRY]: https://example.com }`.
2633
- */
2634
- geo?: QrcodeUpsertParams.Geo | null;
2635
-
2636
- /**
2637
- * The height of the QR code.
2638
- */
2639
- height?: number;
2640
-
2641
- /**
2642
- * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
2643
- * for custom link preview if `proxy` is true.
2644
- */
2645
- image?: string | null;
2646
-
2647
- /**
2648
- * The destination URL for iOS for the QR code for device targeting iOS.
2649
- */
2650
- ios?: string | null;
2651
-
2652
- /**
2653
- * If the form is mandatory for the page.
2654
- */
2655
- isFormMandatory?: boolean;
2656
-
2657
- /**
2658
- * The slug of the QR code. If not provided, a random slug of 7 characters will be
2659
- * generated.
2660
- */
2661
- key?: string;
2662
-
2663
- /**
2664
- * The latitude and longitude information of the QR code.
2665
- */
2666
- latlog?: { [key: string]: string } | null;
2667
-
2668
- /**
2669
- * The level of error correction of the QR code.
2670
- */
2671
- level?: string;
2672
-
2673
- /**
2674
- * The logo of the QR code.
2675
- */
2676
- logo?: string | null;
2677
-
2678
- /**
2679
- * The ID of the page to redirect to before the QR code destination.
2680
- */
2681
- pageId?: string | null;
2682
-
2683
- /**
2684
- * The URL of the page to redirect to before the QR code destination.
2685
- */
2686
- pageUrl?: string | null;
2687
-
2688
- /**
2689
- * The password required to access the destination URL of the QR code.
2690
- */
2691
- password?: string | null;
2692
-
2693
- /**
2694
- * The pattern of the modules of the QR code.
2695
- */
2696
- pattern?: string;
2697
-
2698
- /**
2699
- * The phone number of the QR code.
2700
- */
2701
- phone?: string | null;
2702
-
2703
- /**
2704
- * If the QR code has pre-redirection.
2705
- */
2706
- preRedirection?: boolean;
2707
-
2708
- /**
2709
- * If the QR code uses the custom link preview feature.
2710
- */
2711
- proxy?: boolean;
2712
-
2713
- /**
2714
- * If the statistics of the QR code are publicly accessible.
2715
- */
2716
- publicStats?: boolean;
2717
-
2718
- /**
2719
- * If the QR code uses link cloaking.
2720
- */
2721
- rewrite?: boolean;
2722
-
2723
- /**
2724
- * The shape of the design around the QR code (none, square, circle).
2725
- */
2726
- shape?: string;
2727
-
2728
- /**
2729
- * If the logo should be displayed in the QR code.
2730
- */
2731
- showLogo?: boolean;
2732
-
2733
- /**
2734
- * The size of the QR code.
2735
- */
2736
- size?: number;
2737
-
2738
- /**
2739
- * The SMS information of the QR code.
2740
- */
2741
- sms?: { [key: string]: string } | null;
2742
-
2743
- /**
2744
- * The image URL of the QR code.
2745
- */
2746
- src?: string | null;
2747
-
2748
- /**
2749
- * If the QR code is static.
2750
- */
2751
- static?: boolean;
2752
-
2753
- /**
2754
- * @deprecated The unique ID of the tag assigned to the QR code. This field is
2755
- * deprecated – use `tagIds` instead.
2756
- */
2757
- tagId?: string | null;
2758
-
2759
- /**
2760
- * The unique IDs of the tags assigned to the QR code.
2761
- */
2762
- tagIds?: string | Array<string>;
2763
-
2764
- /**
2765
- * The unique name of the tags assigned to the QR code (case insensitive).
2766
- */
2767
- tagNames?: string | Array<string>;
2768
-
2769
- /**
2770
- * The text of the QR code.
2771
- */
2772
- text?: string | null;
2773
-
2774
- /**
2775
- * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
2776
- * for custom link preview if `proxy` is true.
2777
- */
2778
- title?: string | null;
2779
-
2780
- /**
2781
- * If should track conversions for the QR code.
2782
- */
2783
- trackConversion?: boolean;
2784
-
2785
- /**
2786
- * The destination URL of the QR code.
2787
- */
2788
- url?: string | null;
2789
-
2790
- /**
2791
- * The vCard information of the QR code.
2792
- */
2793
- vcard?: { [key: string]: string } | null;
2794
-
2795
- /**
2796
- * An array of webhook IDs to trigger when the link is clicked. These webhooks will
2797
- * receive click event data.
2798
- */
2799
- webhookIds?: Array<string> | null;
2800
-
2801
- /**
2802
- * The width of the QR code.
2803
- */
2804
- width?: number;
2805
-
2806
- /**
2807
- * The WiFi information of the QR code.
2808
- */
2809
- wifi?: { [key: string]: string } | null;
2810
- }
2811
-
2812
- export namespace QrcodeUpsertParams {
2813
- /**
2814
- * Geographic segmentation information for the QR code in the JSON format
2815
- * `{[COUNTRY]: https://example.com }`.
2816
- */
2817
- export interface Geo {
2818
- AD?: string;
2819
-
2820
- AE?: string;
2821
-
2822
- AF?: string;
2823
-
2824
- AG?: string;
2825
-
2826
- AI?: string;
2827
-
2828
- AL?: string;
2829
-
2830
- AM?: string;
2831
-
2832
- AO?: string;
2833
-
2834
- AQ?: string;
2835
-
2836
- AR?: string;
2837
-
2838
- AS?: string;
2839
-
2840
- AT?: string;
2841
-
2842
- AU?: string;
2843
-
2844
- AW?: string;
2845
-
2846
- AX?: string;
2847
-
2848
- AZ?: string;
2849
-
2850
- BA?: string;
2851
-
2852
- BB?: string;
2853
-
2854
- BD?: string;
2855
-
2856
- BE?: string;
2857
-
2858
- BF?: string;
2859
-
2860
- BG?: string;
2861
-
2862
- BH?: string;
2863
-
2864
- BI?: string;
2865
-
2866
- BJ?: string;
2867
-
2868
- BL?: string;
2869
-
2870
- BM?: string;
2871
-
2872
- BN?: string;
2873
-
2874
- BO?: string;
2875
-
2876
- BQ?: string;
2877
-
2878
- BR?: string;
2879
-
2880
- BS?: string;
2881
-
2882
- BT?: string;
2883
-
2884
- BV?: string;
2885
-
2886
- BW?: string;
2887
-
2888
- BY?: string;
2889
-
2890
- BZ?: string;
2891
-
2892
- CA?: string;
2893
-
2894
- CC?: string;
2895
-
2896
- CD?: string;
2897
-
2898
- CF?: string;
2899
-
2900
- CG?: string;
2901
-
2902
- CH?: string;
2903
-
2904
- CI?: string;
2905
-
2906
- CK?: string;
2907
-
2908
- CL?: string;
2909
-
2910
- CM?: string;
2911
-
2912
- CN?: string;
2913
-
2914
- CO?: string;
2915
-
2916
- CR?: string;
2917
-
2918
- CU?: string;
2919
-
2920
- CV?: string;
2921
-
2922
- CW?: string;
2923
-
2924
- CX?: string;
2925
-
2926
- CY?: string;
2927
-
2928
- CZ?: string;
2929
-
2930
- DE?: string;
2931
-
2932
- DJ?: string;
2933
-
2934
- DK?: string;
2935
-
2936
- DM?: string;
2937
-
2938
- DO?: string;
2939
-
2940
- DZ?: string;
2941
-
2942
- EC?: string;
2943
-
2944
- EE?: string;
2945
-
2946
- EG?: string;
2947
-
2948
- EH?: string;
2949
-
2950
- ER?: string;
2951
-
2952
- ES?: string;
2953
-
2954
- ET?: string;
2955
-
2956
- FI?: string;
2957
-
2958
- FJ?: string;
2959
-
2960
- FK?: string;
2961
-
2962
- FM?: string;
2963
-
2964
- FO?: string;
2965
-
2966
- FR?: string;
2967
-
2968
- GA?: string;
2969
-
2970
- GB?: string;
2971
-
2972
- GD?: string;
2973
-
2974
- GE?: string;
2975
-
2976
- GF?: string;
2977
-
2978
- GG?: string;
2979
-
2980
- GH?: string;
2981
-
2982
- GI?: string;
2983
-
2984
- GL?: string;
2985
-
2986
- GM?: string;
2987
-
2988
- GN?: string;
2989
-
2990
- GP?: string;
2991
-
2992
- GQ?: string;
2993
-
2994
- GR?: string;
2995
-
2996
- GS?: string;
2997
-
2998
- GT?: string;
2999
-
3000
- GU?: string;
3001
-
3002
- GW?: string;
3003
-
3004
- GY?: string;
3005
-
3006
- HK?: string;
3007
-
3008
- HM?: string;
3009
-
3010
- HN?: string;
3011
-
3012
- HR?: string;
3013
-
3014
- HT?: string;
3015
-
3016
- HU?: string;
3017
-
3018
- ID?: string;
3019
-
3020
- IE?: string;
3021
-
3022
- IL?: string;
3023
-
3024
- IM?: string;
3025
-
3026
- IN?: string;
3027
-
3028
- IO?: string;
3029
-
3030
- IQ?: string;
3031
-
3032
- IR?: string;
3033
-
3034
- IS?: string;
3035
-
3036
- IT?: string;
3037
-
3038
- JE?: string;
3039
-
3040
- JM?: string;
3041
-
3042
- JO?: string;
3043
-
3044
- JP?: string;
3045
-
3046
- KE?: string;
3047
-
3048
- KG?: string;
3049
-
3050
- KH?: string;
3051
-
3052
- KI?: string;
3053
-
3054
- KM?: string;
3055
-
3056
- KN?: string;
3057
-
3058
- KP?: string;
3059
-
3060
- KR?: string;
3061
-
3062
- KW?: string;
3063
-
3064
- KY?: string;
3065
-
3066
- KZ?: string;
3067
-
3068
- LA?: string;
3069
-
3070
- LB?: string;
3071
-
3072
- LC?: string;
3073
-
3074
- LI?: string;
3075
-
3076
- LK?: string;
3077
-
3078
- LR?: string;
3079
-
3080
- LS?: string;
3081
-
3082
- LT?: string;
3083
-
3084
- LU?: string;
3085
-
3086
- LV?: string;
3087
-
3088
- LY?: string;
3089
-
3090
- MA?: string;
3091
-
3092
- MC?: string;
3093
-
3094
- MD?: string;
3095
-
3096
- ME?: string;
3097
-
3098
- MF?: string;
3099
-
3100
- MG?: string;
3101
-
3102
- MH?: string;
3103
-
3104
- MK?: string;
3105
-
3106
- ML?: string;
3107
-
3108
- MM?: string;
3109
-
3110
- MN?: string;
3111
-
3112
- MO?: string;
3113
-
3114
- MP?: string;
3115
-
3116
- MQ?: string;
3117
-
3118
- MR?: string;
3119
-
3120
- MS?: string;
3121
-
3122
- MT?: string;
3123
-
3124
- MU?: string;
3125
-
3126
- MV?: string;
3127
-
3128
- MW?: string;
3129
-
3130
- MX?: string;
3131
-
3132
- MY?: string;
3133
-
3134
- MZ?: string;
3135
-
3136
- NA?: string;
3137
-
3138
- NC?: string;
3139
-
3140
- NE?: string;
3141
-
3142
- NF?: string;
3143
-
3144
- NG?: string;
3145
-
3146
- NI?: string;
3147
-
3148
- NL?: string;
3149
-
3150
- NO?: string;
3151
-
3152
- NP?: string;
3153
-
3154
- NR?: string;
3155
-
3156
- NU?: string;
3157
-
3158
- NZ?: string;
3159
-
3160
- OM?: string;
3161
-
3162
- PA?: string;
3163
-
3164
- PE?: string;
3165
-
3166
- PF?: string;
3167
-
3168
- PG?: string;
3169
-
3170
- PH?: string;
3171
-
3172
- PK?: string;
3173
-
3174
- PL?: string;
3175
-
3176
- PM?: string;
3177
-
3178
- PN?: string;
3179
-
3180
- PR?: string;
3181
-
3182
- PS?: string;
3183
-
3184
- PT?: string;
3185
-
3186
- PW?: string;
3187
-
3188
- PY?: string;
3189
-
3190
- QA?: string;
3191
-
3192
- RE?: string;
3193
-
3194
- RO?: string;
3195
-
3196
- RS?: string;
3197
-
3198
- RU?: string;
3199
-
3200
- RW?: string;
3201
-
3202
- SA?: string;
3203
-
3204
- SB?: string;
3205
-
3206
- SC?: string;
3207
-
3208
- SD?: string;
3209
-
3210
- SE?: string;
3211
-
3212
- SG?: string;
3213
-
3214
- SH?: string;
3215
-
3216
- SI?: string;
3217
-
3218
- SJ?: string;
3219
-
3220
- SK?: string;
3221
-
3222
- SL?: string;
3223
-
3224
- SM?: string;
3225
-
3226
- SN?: string;
3227
-
3228
- SO?: string;
3229
-
3230
- SR?: string;
3231
-
3232
- SS?: string;
3233
-
3234
- ST?: string;
3235
-
3236
- SV?: string;
3237
-
3238
- SX?: string;
3239
-
3240
- SY?: string;
3241
-
3242
- SZ?: string;
3243
-
3244
- TC?: string;
3245
-
3246
- TD?: string;
3247
-
3248
- TF?: string;
3249
-
3250
- TG?: string;
3251
-
3252
- TH?: string;
3253
-
3254
- TJ?: string;
3255
-
3256
- TK?: string;
3257
-
3258
- TL?: string;
3259
-
3260
- TM?: string;
3261
-
3262
- TN?: string;
3263
-
3264
- TO?: string;
3265
-
3266
- TR?: string;
3267
-
3268
- TT?: string;
3269
-
3270
- TV?: string;
3271
-
3272
- TW?: string;
3273
-
3274
- TZ?: string;
3275
-
3276
- UA?: string;
3277
-
3278
- UG?: string;
3279
-
3280
- UM?: string;
3281
-
3282
- US?: string;
3283
-
3284
- UY?: string;
3285
-
3286
- UZ?: string;
3287
-
3288
- VA?: string;
3289
-
3290
- VC?: string;
3291
-
3292
- VE?: string;
3293
-
3294
- VG?: string;
3295
-
3296
- VI?: string;
3297
-
3298
- VN?: string;
3299
-
3300
- VU?: string;
3301
-
3302
- WF?: string;
3303
-
3304
- WS?: string;
3305
-
3306
- XK?: string;
3307
-
3308
- YE?: string;
3309
-
3310
- YT?: string;
3311
-
3312
- ZA?: string;
3313
-
3314
- ZM?: string;
3315
-
3316
- ZW?: string;
3317
- }
3318
- }
3319
-
3320
2353
  Qrcodes.Bulk = Bulk;
3321
2354
 
3322
2355
  export declare namespace Qrcodes {
@@ -3324,20 +2357,15 @@ export declare namespace Qrcodes {
3324
2357
  type QrCode as QrCode,
3325
2358
  type QrcodeListResponse as QrcodeListResponse,
3326
2359
  type QrcodeDeleteResponse as QrcodeDeleteResponse,
3327
- type QrcodeCountResponse as QrcodeCountResponse,
3328
2360
  type QrcodeCreateParams as QrcodeCreateParams,
3329
2361
  type QrcodeRetrieveParams as QrcodeRetrieveParams,
3330
2362
  type QrcodeUpdateParams as QrcodeUpdateParams,
3331
2363
  type QrcodeListParams as QrcodeListParams,
3332
- type QrcodeCountParams as QrcodeCountParams,
3333
- type QrcodeUpsertParams as QrcodeUpsertParams,
3334
2364
  };
3335
2365
 
3336
2366
  export {
3337
2367
  Bulk as Bulk,
3338
2368
  type BulkCreateResponse as BulkCreateResponse,
3339
- type BulkDeleteResponse as BulkDeleteResponse,
3340
2369
  type BulkCreateParams as BulkCreateParams,
3341
- type BulkDeleteParams as BulkDeleteParams,
3342
2370
  };
3343
2371
  }