dub 0.64.2 → 0.64.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 (194) hide show
  1. package/README.md +1 -1
  2. package/bin/mcp-server.js +137 -99
  3. package/bin/mcp-server.js.map +28 -28
  4. package/dist/commonjs/funcs/analyticsRetrieve.js +1 -0
  5. package/dist/commonjs/funcs/analyticsRetrieve.js.map +1 -1
  6. package/dist/commonjs/funcs/eventsList.js +1 -0
  7. package/dist/commonjs/funcs/eventsList.js.map +1 -1
  8. package/dist/commonjs/lib/config.d.ts +3 -3
  9. package/dist/commonjs/lib/config.js +3 -3
  10. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  11. package/dist/commonjs/mcp-server/server.js +1 -1
  12. package/dist/commonjs/models/components/clickevent.d.ts +33 -26
  13. package/dist/commonjs/models/components/clickevent.d.ts.map +1 -1
  14. package/dist/commonjs/models/components/clickevent.js +8 -4
  15. package/dist/commonjs/models/components/clickevent.js.map +1 -1
  16. package/dist/commonjs/models/components/leadcreatedevent.d.ts +20 -13
  17. package/dist/commonjs/models/components/leadcreatedevent.d.ts.map +1 -1
  18. package/dist/commonjs/models/components/leadcreatedevent.js +8 -4
  19. package/dist/commonjs/models/components/leadcreatedevent.js.map +1 -1
  20. package/dist/commonjs/models/components/leadevent.d.ts +35 -26
  21. package/dist/commonjs/models/components/leadevent.d.ts.map +1 -1
  22. package/dist/commonjs/models/components/leadevent.js +10 -4
  23. package/dist/commonjs/models/components/leadevent.js.map +1 -1
  24. package/dist/commonjs/models/components/linkclickedevent.d.ts +20 -13
  25. package/dist/commonjs/models/components/linkclickedevent.d.ts.map +1 -1
  26. package/dist/commonjs/models/components/linkclickedevent.js +8 -4
  27. package/dist/commonjs/models/components/linkclickedevent.js.map +1 -1
  28. package/dist/commonjs/models/components/linkschema.d.ts +20 -15
  29. package/dist/commonjs/models/components/linkschema.d.ts.map +1 -1
  30. package/dist/commonjs/models/components/linkschema.js +6 -4
  31. package/dist/commonjs/models/components/linkschema.js.map +1 -1
  32. package/dist/commonjs/models/components/linkwebhookevent.d.ts +18 -13
  33. package/dist/commonjs/models/components/linkwebhookevent.d.ts.map +1 -1
  34. package/dist/commonjs/models/components/linkwebhookevent.js +6 -4
  35. package/dist/commonjs/models/components/linkwebhookevent.js.map +1 -1
  36. package/dist/commonjs/models/components/partnerenrolledevent.d.ts +3 -3
  37. package/dist/commonjs/models/components/salecreatedevent.d.ts +20 -13
  38. package/dist/commonjs/models/components/salecreatedevent.d.ts.map +1 -1
  39. package/dist/commonjs/models/components/salecreatedevent.js +8 -4
  40. package/dist/commonjs/models/components/salecreatedevent.js.map +1 -1
  41. package/dist/commonjs/models/components/saleevent.d.ts +123 -112
  42. package/dist/commonjs/models/components/saleevent.d.ts.map +1 -1
  43. package/dist/commonjs/models/components/saleevent.js +60 -54
  44. package/dist/commonjs/models/components/saleevent.js.map +1 -1
  45. package/dist/commonjs/models/operations/bulkcreatelinks.d.ts +14 -14
  46. package/dist/commonjs/models/operations/bulkcreatelinks.d.ts.map +1 -1
  47. package/dist/commonjs/models/operations/bulkcreatelinks.js +4 -4
  48. package/dist/commonjs/models/operations/bulkcreatelinks.js.map +1 -1
  49. package/dist/commonjs/models/operations/bulkupdatelinks.d.ts +14 -14
  50. package/dist/commonjs/models/operations/bulkupdatelinks.d.ts.map +1 -1
  51. package/dist/commonjs/models/operations/bulkupdatelinks.js +4 -4
  52. package/dist/commonjs/models/operations/bulkupdatelinks.js.map +1 -1
  53. package/dist/commonjs/models/operations/createlink.d.ts +14 -14
  54. package/dist/commonjs/models/operations/createlink.d.ts.map +1 -1
  55. package/dist/commonjs/models/operations/createlink.js +4 -4
  56. package/dist/commonjs/models/operations/createlink.js.map +1 -1
  57. package/dist/commonjs/models/operations/createpartner.d.ts +3 -3
  58. package/dist/commonjs/models/operations/getlinks.d.ts +1 -1
  59. package/dist/commonjs/models/operations/getlinkscount.d.ts +1 -1
  60. package/dist/commonjs/models/operations/listevents.d.ts +18 -13
  61. package/dist/commonjs/models/operations/listevents.d.ts.map +1 -1
  62. package/dist/commonjs/models/operations/listevents.js +7 -5
  63. package/dist/commonjs/models/operations/listevents.js.map +1 -1
  64. package/dist/commonjs/models/operations/listpartners.d.ts +3 -3
  65. package/dist/commonjs/models/operations/retrieveanalytics.d.ts +18 -13
  66. package/dist/commonjs/models/operations/retrieveanalytics.d.ts.map +1 -1
  67. package/dist/commonjs/models/operations/retrieveanalytics.js +7 -5
  68. package/dist/commonjs/models/operations/retrieveanalytics.js.map +1 -1
  69. package/dist/commonjs/models/operations/retrievelinks.d.ts +3 -3
  70. package/dist/commonjs/models/operations/updatelink.d.ts +14 -14
  71. package/dist/commonjs/models/operations/updatelink.d.ts.map +1 -1
  72. package/dist/commonjs/models/operations/updatelink.js +4 -4
  73. package/dist/commonjs/models/operations/updatelink.js.map +1 -1
  74. package/dist/commonjs/models/operations/upsertlink.d.ts +14 -14
  75. package/dist/commonjs/models/operations/upsertlink.d.ts.map +1 -1
  76. package/dist/commonjs/models/operations/upsertlink.js +4 -4
  77. package/dist/commonjs/models/operations/upsertlink.js.map +1 -1
  78. package/dist/esm/funcs/analyticsRetrieve.js +1 -0
  79. package/dist/esm/funcs/analyticsRetrieve.js.map +1 -1
  80. package/dist/esm/funcs/eventsList.js +1 -0
  81. package/dist/esm/funcs/eventsList.js.map +1 -1
  82. package/dist/esm/lib/config.d.ts +3 -3
  83. package/dist/esm/lib/config.js +3 -3
  84. package/dist/esm/mcp-server/mcp-server.js +1 -1
  85. package/dist/esm/mcp-server/server.js +1 -1
  86. package/dist/esm/models/components/clickevent.d.ts +33 -26
  87. package/dist/esm/models/components/clickevent.d.ts.map +1 -1
  88. package/dist/esm/models/components/clickevent.js +8 -4
  89. package/dist/esm/models/components/clickevent.js.map +1 -1
  90. package/dist/esm/models/components/leadcreatedevent.d.ts +20 -13
  91. package/dist/esm/models/components/leadcreatedevent.d.ts.map +1 -1
  92. package/dist/esm/models/components/leadcreatedevent.js +8 -4
  93. package/dist/esm/models/components/leadcreatedevent.js.map +1 -1
  94. package/dist/esm/models/components/leadevent.d.ts +35 -26
  95. package/dist/esm/models/components/leadevent.d.ts.map +1 -1
  96. package/dist/esm/models/components/leadevent.js +10 -4
  97. package/dist/esm/models/components/leadevent.js.map +1 -1
  98. package/dist/esm/models/components/linkclickedevent.d.ts +20 -13
  99. package/dist/esm/models/components/linkclickedevent.d.ts.map +1 -1
  100. package/dist/esm/models/components/linkclickedevent.js +8 -4
  101. package/dist/esm/models/components/linkclickedevent.js.map +1 -1
  102. package/dist/esm/models/components/linkschema.d.ts +20 -15
  103. package/dist/esm/models/components/linkschema.d.ts.map +1 -1
  104. package/dist/esm/models/components/linkschema.js +6 -4
  105. package/dist/esm/models/components/linkschema.js.map +1 -1
  106. package/dist/esm/models/components/linkwebhookevent.d.ts +18 -13
  107. package/dist/esm/models/components/linkwebhookevent.d.ts.map +1 -1
  108. package/dist/esm/models/components/linkwebhookevent.js +6 -4
  109. package/dist/esm/models/components/linkwebhookevent.js.map +1 -1
  110. package/dist/esm/models/components/partnerenrolledevent.d.ts +3 -3
  111. package/dist/esm/models/components/salecreatedevent.d.ts +20 -13
  112. package/dist/esm/models/components/salecreatedevent.d.ts.map +1 -1
  113. package/dist/esm/models/components/salecreatedevent.js +8 -4
  114. package/dist/esm/models/components/salecreatedevent.js.map +1 -1
  115. package/dist/esm/models/components/saleevent.d.ts +123 -112
  116. package/dist/esm/models/components/saleevent.d.ts.map +1 -1
  117. package/dist/esm/models/components/saleevent.js +57 -51
  118. package/dist/esm/models/components/saleevent.js.map +1 -1
  119. package/dist/esm/models/operations/bulkcreatelinks.d.ts +14 -14
  120. package/dist/esm/models/operations/bulkcreatelinks.d.ts.map +1 -1
  121. package/dist/esm/models/operations/bulkcreatelinks.js +4 -4
  122. package/dist/esm/models/operations/bulkcreatelinks.js.map +1 -1
  123. package/dist/esm/models/operations/bulkupdatelinks.d.ts +14 -14
  124. package/dist/esm/models/operations/bulkupdatelinks.d.ts.map +1 -1
  125. package/dist/esm/models/operations/bulkupdatelinks.js +4 -4
  126. package/dist/esm/models/operations/bulkupdatelinks.js.map +1 -1
  127. package/dist/esm/models/operations/createlink.d.ts +14 -14
  128. package/dist/esm/models/operations/createlink.d.ts.map +1 -1
  129. package/dist/esm/models/operations/createlink.js +4 -4
  130. package/dist/esm/models/operations/createlink.js.map +1 -1
  131. package/dist/esm/models/operations/createpartner.d.ts +3 -3
  132. package/dist/esm/models/operations/getlinks.d.ts +1 -1
  133. package/dist/esm/models/operations/getlinkscount.d.ts +1 -1
  134. package/dist/esm/models/operations/listevents.d.ts +18 -13
  135. package/dist/esm/models/operations/listevents.d.ts.map +1 -1
  136. package/dist/esm/models/operations/listevents.js +7 -5
  137. package/dist/esm/models/operations/listevents.js.map +1 -1
  138. package/dist/esm/models/operations/listpartners.d.ts +3 -3
  139. package/dist/esm/models/operations/retrieveanalytics.d.ts +18 -13
  140. package/dist/esm/models/operations/retrieveanalytics.d.ts.map +1 -1
  141. package/dist/esm/models/operations/retrieveanalytics.js +7 -5
  142. package/dist/esm/models/operations/retrieveanalytics.js.map +1 -1
  143. package/dist/esm/models/operations/retrievelinks.d.ts +3 -3
  144. package/dist/esm/models/operations/updatelink.d.ts +14 -14
  145. package/dist/esm/models/operations/updatelink.d.ts.map +1 -1
  146. package/dist/esm/models/operations/updatelink.js +4 -4
  147. package/dist/esm/models/operations/updatelink.js.map +1 -1
  148. package/dist/esm/models/operations/upsertlink.d.ts +14 -14
  149. package/dist/esm/models/operations/upsertlink.d.ts.map +1 -1
  150. package/dist/esm/models/operations/upsertlink.js +4 -4
  151. package/dist/esm/models/operations/upsertlink.js.map +1 -1
  152. package/docs/sdks/analytics/README.md +1 -0
  153. package/docs/sdks/commissions/README.md +2 -0
  154. package/docs/sdks/customers/README.md +5 -0
  155. package/docs/sdks/domains/README.md +6 -0
  156. package/docs/sdks/dub/README.md +1 -1
  157. package/docs/sdks/embedtokens/README.md +1 -0
  158. package/docs/sdks/events/README.md +1 -0
  159. package/docs/sdks/folders/README.md +4 -0
  160. package/docs/sdks/links/README.md +10 -0
  161. package/docs/sdks/partners/README.md +6 -0
  162. package/docs/sdks/qrcodes/README.md +1 -0
  163. package/docs/sdks/tags/README.md +4 -0
  164. package/docs/sdks/track/README.md +2 -0
  165. package/docs/sdks/workspaces/README.md +2 -0
  166. package/examples/package-lock.json +6 -5
  167. package/jsr.json +1 -1
  168. package/package.json +6 -6
  169. package/src/funcs/analyticsRetrieve.ts +1 -0
  170. package/src/funcs/eventsList.ts +1 -0
  171. package/src/lib/config.ts +3 -3
  172. package/src/mcp-server/mcp-server.ts +1 -1
  173. package/src/mcp-server/server.ts +1 -1
  174. package/src/models/components/clickevent.ts +41 -30
  175. package/src/models/components/leadcreatedevent.ts +28 -17
  176. package/src/models/components/leadevent.ts +45 -30
  177. package/src/models/components/linkclickedevent.ts +28 -17
  178. package/src/models/components/linkschema.ts +26 -19
  179. package/src/models/components/linkwebhookevent.ts +24 -17
  180. package/src/models/components/partnerenrolledevent.ts +3 -3
  181. package/src/models/components/salecreatedevent.ts +28 -17
  182. package/src/models/components/saleevent.ts +156 -139
  183. package/src/models/operations/bulkcreatelinks.ts +18 -18
  184. package/src/models/operations/bulkupdatelinks.ts +18 -18
  185. package/src/models/operations/createlink.ts +18 -18
  186. package/src/models/operations/createpartner.ts +3 -3
  187. package/src/models/operations/getlinks.ts +1 -1
  188. package/src/models/operations/getlinkscount.ts +1 -1
  189. package/src/models/operations/listevents.ts +24 -17
  190. package/src/models/operations/listpartners.ts +3 -3
  191. package/src/models/operations/retrieveanalytics.ts +24 -17
  192. package/src/models/operations/retrievelinks.ts +3 -3
  193. package/src/models/operations/updatelink.ts +18 -18
  194. package/src/models/operations/upsertlink.ts +18 -18
@@ -49,18 +49,6 @@ export type Data = {
49
49
  * Whether the short link is archived. Defaults to `false` if not provided.
50
50
  */
51
51
  archived?: boolean | undefined;
52
- /**
53
- * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
54
- *
55
- * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
56
- */
57
- publicStats?: boolean | undefined;
58
- /**
59
- * The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
60
- *
61
- * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
62
- */
63
- tagId?: string | null | undefined;
64
52
  /**
65
53
  * The unique IDs of the tags assigned to the short link.
66
54
  */
@@ -169,6 +157,18 @@ export type Data = {
169
157
  * The date and time when the tests were or will be completed.
170
158
  */
171
159
  testCompletedAt?: string | null | undefined;
160
+ /**
161
+ * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
162
+ *
163
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
164
+ */
165
+ publicStats?: boolean | undefined;
166
+ /**
167
+ * Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link.
168
+ *
169
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
170
+ */
171
+ tagId?: string | null | undefined;
172
172
  };
173
173
 
174
174
  export type BulkUpdateLinksRequestBody = {
@@ -347,8 +347,6 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
347
347
  partnerId: z.nullable(z.string()).optional(),
348
348
  trackConversion: z.boolean().optional(),
349
349
  archived: z.boolean().optional(),
350
- publicStats: z.boolean().optional(),
351
- tagId: z.nullable(z.string()).optional(),
352
350
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
353
351
  tagNames: z.union([z.string(), z.array(z.string())]).optional(),
354
352
  folderId: z.nullable(z.string()).optional(),
@@ -378,6 +376,8 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
378
376
  ).optional(),
379
377
  testStartedAt: z.nullable(z.string()).optional(),
380
378
  testCompletedAt: z.nullable(z.string()).optional(),
379
+ publicStats: z.boolean().optional(),
380
+ tagId: z.nullable(z.string()).optional(),
381
381
  }).transform((v) => {
382
382
  return remap$(v, {
383
383
  "utm_source": "utmSource",
@@ -396,8 +396,6 @@ export type Data$Outbound = {
396
396
  partnerId?: string | null | undefined;
397
397
  trackConversion?: boolean | undefined;
398
398
  archived?: boolean | undefined;
399
- publicStats?: boolean | undefined;
400
- tagId?: string | null | undefined;
401
399
  tagIds?: string | Array<string> | undefined;
402
400
  tagNames?: string | Array<string> | undefined;
403
401
  folderId?: string | null | undefined;
@@ -425,6 +423,8 @@ export type Data$Outbound = {
425
423
  testVariants?: Array<BulkUpdateLinksTestVariants$Outbound> | null | undefined;
426
424
  testStartedAt?: string | null | undefined;
427
425
  testCompletedAt?: string | null | undefined;
426
+ publicStats?: boolean | undefined;
427
+ tagId?: string | null | undefined;
428
428
  };
429
429
 
430
430
  /** @internal */
@@ -436,8 +436,6 @@ export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
436
436
  partnerId: z.nullable(z.string()).optional(),
437
437
  trackConversion: z.boolean().optional(),
438
438
  archived: z.boolean().optional(),
439
- publicStats: z.boolean().optional(),
440
- tagId: z.nullable(z.string()).optional(),
441
439
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
442
440
  tagNames: z.union([z.string(), z.array(z.string())]).optional(),
443
441
  folderId: z.nullable(z.string()).optional(),
@@ -467,6 +465,8 @@ export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
467
465
  ).optional(),
468
466
  testStartedAt: z.nullable(z.string()).optional(),
469
467
  testCompletedAt: z.nullable(z.string()).optional(),
468
+ publicStats: z.boolean().optional(),
469
+ tagId: z.nullable(z.string()).optional(),
470
470
  }).transform((v) => {
471
471
  return remap$(v, {
472
472
  utmSource: "utm_source",
@@ -69,18 +69,6 @@ export type CreateLinkRequestBody = {
69
69
  * Whether the short link is archived. Defaults to `false` if not provided.
70
70
  */
71
71
  archived?: boolean | undefined;
72
- /**
73
- * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
74
- *
75
- * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
76
- */
77
- publicStats?: boolean | undefined;
78
- /**
79
- * The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
80
- *
81
- * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
82
- */
83
- tagId?: string | null | undefined;
84
72
  /**
85
73
  * The unique IDs of the tags assigned to the short link.
86
74
  */
@@ -189,6 +177,18 @@ export type CreateLinkRequestBody = {
189
177
  * The date and time when the tests were or will be completed.
190
178
  */
191
179
  testCompletedAt?: string | null | undefined;
180
+ /**
181
+ * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
182
+ *
183
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
184
+ */
185
+ publicStats?: boolean | undefined;
186
+ /**
187
+ * Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link.
188
+ *
189
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
190
+ */
191
+ tagId?: string | null | undefined;
192
192
  };
193
193
 
194
194
  /** @internal */
@@ -346,8 +346,6 @@ export const CreateLinkRequestBody$inboundSchema: z.ZodType<
346
346
  prefix: z.string().optional(),
347
347
  trackConversion: z.boolean().optional(),
348
348
  archived: z.boolean().optional(),
349
- publicStats: z.boolean().optional(),
350
- tagId: z.nullable(z.string()).optional(),
351
349
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
352
350
  tagNames: z.union([z.string(), z.array(z.string())]).optional(),
353
351
  folderId: z.nullable(z.string()).optional(),
@@ -376,6 +374,8 @@ export const CreateLinkRequestBody$inboundSchema: z.ZodType<
376
374
  .optional(),
377
375
  testStartedAt: z.nullable(z.string()).optional(),
378
376
  testCompletedAt: z.nullable(z.string()).optional(),
377
+ publicStats: z.boolean().optional(),
378
+ tagId: z.nullable(z.string()).optional(),
379
379
  }).transform((v) => {
380
380
  return remap$(v, {
381
381
  "utm_source": "utmSource",
@@ -399,8 +399,6 @@ export type CreateLinkRequestBody$Outbound = {
399
399
  prefix?: string | undefined;
400
400
  trackConversion?: boolean | undefined;
401
401
  archived?: boolean | undefined;
402
- publicStats?: boolean | undefined;
403
- tagId?: string | null | undefined;
404
402
  tagIds?: string | Array<string> | undefined;
405
403
  tagNames?: string | Array<string> | undefined;
406
404
  folderId?: string | null | undefined;
@@ -428,6 +426,8 @@ export type CreateLinkRequestBody$Outbound = {
428
426
  testVariants?: Array<TestVariants$Outbound> | null | undefined;
429
427
  testStartedAt?: string | null | undefined;
430
428
  testCompletedAt?: string | null | undefined;
429
+ publicStats?: boolean | undefined;
430
+ tagId?: string | null | undefined;
431
431
  };
432
432
 
433
433
  /** @internal */
@@ -447,8 +447,6 @@ export const CreateLinkRequestBody$outboundSchema: z.ZodType<
447
447
  prefix: z.string().optional(),
448
448
  trackConversion: z.boolean().optional(),
449
449
  archived: z.boolean().optional(),
450
- publicStats: z.boolean().optional(),
451
- tagId: z.nullable(z.string()).optional(),
452
450
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
453
451
  tagNames: z.union([z.string(), z.array(z.string())]).optional(),
454
452
  folderId: z.nullable(z.string()).optional(),
@@ -477,6 +475,8 @@ export const CreateLinkRequestBody$outboundSchema: z.ZodType<
477
475
  .optional(),
478
476
  testStartedAt: z.nullable(z.string()).optional(),
479
477
  testCompletedAt: z.nullable(z.string()).optional(),
478
+ publicStats: z.boolean().optional(),
479
+ tagId: z.nullable(z.string()).optional(),
480
480
  }).transform((v) => {
481
481
  return remap$(v, {
482
482
  utmSource: "utm_source",
@@ -488,15 +488,15 @@ export type CreatePartnerLink = {
488
488
  */
489
489
  clicks?: number | undefined;
490
490
  /**
491
- * The number of leads the short links has generated.
491
+ * The number of leads the short link has generated.
492
492
  */
493
493
  leads?: number | undefined;
494
494
  /**
495
- * The number of sales the short links has generated.
495
+ * The total number of sales (includes recurring sales) generated by the short link.
496
496
  */
497
497
  sales?: number | undefined;
498
498
  /**
499
- * The total dollar amount of sales the short links has generated (in cents).
499
+ * The total dollar value of sales (in cents) generated by the short link.
500
500
  */
501
501
  saleAmount?: number | undefined;
502
502
  };
@@ -70,7 +70,7 @@ export type GetLinksRequest = {
70
70
  */
71
71
  domain?: string | undefined;
72
72
  /**
73
- * Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
73
+ * Deprecated: Use `tagIds` instead. The tag ID to filter the links by.
74
74
  */
75
75
  tagId?: string | undefined;
76
76
  /**
@@ -49,7 +49,7 @@ export type GetLinksCountRequest = {
49
49
  */
50
50
  domain?: string | undefined;
51
51
  /**
52
- * Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
52
+ * Deprecated: Use `tagIds` instead. The tag ID to filter the links by.
53
53
  */
54
54
  tagId?: string | undefined;
55
55
  /**
@@ -43,7 +43,7 @@ export const QueryParamInterval = {
43
43
  export type QueryParamInterval = ClosedEnum<typeof QueryParamInterval>;
44
44
 
45
45
  /**
46
- * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
46
+ * The trigger to retrieve analytics for. If undefined, returns all trigger types.
47
47
  */
48
48
  export const QueryParamTrigger = {
49
49
  Qr: "qr",
@@ -52,7 +52,7 @@ export const QueryParamTrigger = {
52
52
  Deeplink: "deeplink",
53
53
  } as const;
54
54
  /**
55
- * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
55
+ * The trigger to retrieve analytics for. If undefined, returns all trigger types.
56
56
  */
57
57
  export type QueryParamTrigger = ClosedEnum<typeof QueryParamTrigger>;
58
58
 
@@ -194,7 +194,7 @@ export type ListEventsRequest = {
194
194
  */
195
195
  os?: string | undefined;
196
196
  /**
197
- * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
197
+ * The trigger to retrieve analytics for. If undefined, returns all trigger types.
198
198
  */
199
199
  trigger?: QueryParamTrigger | undefined;
200
200
  /**
@@ -209,10 +209,6 @@ export type ListEventsRequest = {
209
209
  * The URL to retrieve analytics for.
210
210
  */
211
211
  url?: string | undefined;
212
- /**
213
- * Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
214
- */
215
- tagId?: string | undefined;
216
212
  /**
217
213
  * The tag IDs to retrieve analytics for.
218
214
  */
@@ -221,10 +217,6 @@ export type ListEventsRequest = {
221
217
  * The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links.
222
218
  */
223
219
  folderId?: string | undefined;
224
- /**
225
- * Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
226
- */
227
- qr?: boolean | undefined;
228
220
  /**
229
221
  * Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
230
222
  */
@@ -233,6 +225,18 @@ export type ListEventsRequest = {
233
225
  * Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
234
226
  */
235
227
  saleType?: QueryParamSaleType | undefined;
228
+ /**
229
+ * Search the events by a custom metadata value. Only available for lead and sale events.
230
+ */
231
+ query?: string | undefined;
232
+ /**
233
+ * Deprecated: Use `tagIds` instead. The tag ID to retrieve analytics for.
234
+ */
235
+ tagId?: string | undefined;
236
+ /**
237
+ * Deprecated: Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
238
+ */
239
+ qr?: boolean | undefined;
236
240
  /**
237
241
  * The UTM source of the short link.
238
242
  */
@@ -498,12 +502,13 @@ export const ListEventsRequest$inboundSchema: z.ZodType<
498
502
  referer: z.string().optional(),
499
503
  refererUrl: z.string().optional(),
500
504
  url: z.string().optional(),
501
- tagId: z.string().optional(),
502
505
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
503
506
  folderId: z.string().optional(),
504
- qr: z.boolean().optional(),
505
507
  root: z.boolean().optional(),
506
508
  saleType: QueryParamSaleType$inboundSchema.optional(),
509
+ query: z.string().optional(),
510
+ tagId: z.string().optional(),
511
+ qr: z.boolean().optional(),
507
512
  utm_source: z.nullable(z.string()).optional(),
508
513
  utm_medium: z.nullable(z.string()).optional(),
509
514
  utm_campaign: z.nullable(z.string()).optional(),
@@ -550,12 +555,13 @@ export type ListEventsRequest$Outbound = {
550
555
  referer?: string | undefined;
551
556
  refererUrl?: string | undefined;
552
557
  url?: string | undefined;
553
- tagId?: string | undefined;
554
558
  tagIds?: string | Array<string> | undefined;
555
559
  folderId?: string | undefined;
556
- qr?: boolean | undefined;
557
560
  root?: boolean | undefined;
558
561
  saleType?: string | undefined;
562
+ query?: string | undefined;
563
+ tagId?: string | undefined;
564
+ qr?: boolean | undefined;
559
565
  utm_source?: string | null | undefined;
560
566
  utm_medium?: string | null | undefined;
561
567
  utm_campaign?: string | null | undefined;
@@ -598,12 +604,13 @@ export const ListEventsRequest$outboundSchema: z.ZodType<
598
604
  referer: z.string().optional(),
599
605
  refererUrl: z.string().optional(),
600
606
  url: z.string().optional(),
601
- tagId: z.string().optional(),
602
607
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
603
608
  folderId: z.string().optional(),
604
- qr: z.boolean().optional(),
605
609
  root: z.boolean().optional(),
606
610
  saleType: QueryParamSaleType$outboundSchema.optional(),
611
+ query: z.string().optional(),
612
+ tagId: z.string().optional(),
613
+ qr: z.boolean().optional(),
607
614
  utmSource: z.nullable(z.string()).optional(),
608
615
  utmMedium: z.nullable(z.string()).optional(),
609
616
  utmCampaign: z.nullable(z.string()).optional(),
@@ -142,15 +142,15 @@ export type ListPartnersLink = {
142
142
  */
143
143
  clicks?: number | undefined;
144
144
  /**
145
- * The number of leads the short links has generated.
145
+ * The number of leads the short link has generated.
146
146
  */
147
147
  leads?: number | undefined;
148
148
  /**
149
- * The number of sales the short links has generated.
149
+ * The total number of sales (includes recurring sales) generated by the short link.
150
150
  */
151
151
  sales?: number | undefined;
152
152
  /**
153
- * The total dollar amount of sales the short links has generated (in cents).
153
+ * The total dollar value of sales (in cents) generated by the short link.
154
154
  */
155
155
  saleAmount?: number | undefined;
156
156
  };
@@ -75,7 +75,7 @@ export const Interval = {
75
75
  export type Interval = ClosedEnum<typeof Interval>;
76
76
 
77
77
  /**
78
- * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
78
+ * The trigger to retrieve analytics for. If undefined, returns all trigger types.
79
79
  */
80
80
  export const Trigger = {
81
81
  Qr: "qr",
@@ -84,7 +84,7 @@ export const Trigger = {
84
84
  Deeplink: "deeplink",
85
85
  } as const;
86
86
  /**
87
- * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
87
+ * The trigger to retrieve analytics for. If undefined, returns all trigger types.
88
88
  */
89
89
  export type Trigger = ClosedEnum<typeof Trigger>;
90
90
 
@@ -191,7 +191,7 @@ export type RetrieveAnalyticsRequest = {
191
191
  */
192
192
  os?: string | undefined;
193
193
  /**
194
- * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
194
+ * The trigger to retrieve analytics for. If undefined, returns all trigger types.
195
195
  */
196
196
  trigger?: Trigger | undefined;
197
197
  /**
@@ -206,10 +206,6 @@ export type RetrieveAnalyticsRequest = {
206
206
  * The URL to retrieve analytics for.
207
207
  */
208
208
  url?: string | undefined;
209
- /**
210
- * Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
211
- */
212
- tagId?: string | undefined;
213
209
  /**
214
210
  * The tag IDs to retrieve analytics for.
215
211
  */
@@ -218,10 +214,6 @@ export type RetrieveAnalyticsRequest = {
218
214
  * The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links.
219
215
  */
220
216
  folderId?: string | undefined;
221
- /**
222
- * Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
223
- */
224
- qr?: boolean | undefined;
225
217
  /**
226
218
  * Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
227
219
  */
@@ -230,6 +222,18 @@ export type RetrieveAnalyticsRequest = {
230
222
  * Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
231
223
  */
232
224
  saleType?: SaleType | undefined;
225
+ /**
226
+ * Search the events by a custom metadata value. Only available for lead and sale events.
227
+ */
228
+ query?: string | undefined;
229
+ /**
230
+ * Deprecated: Use `tagIds` instead. The tag ID to retrieve analytics for.
231
+ */
232
+ tagId?: string | undefined;
233
+ /**
234
+ * Deprecated: Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
235
+ */
236
+ qr?: boolean | undefined;
233
237
  /**
234
238
  * The UTM source of the short link.
235
239
  */
@@ -451,12 +455,13 @@ export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
451
455
  referer: z.string().optional(),
452
456
  refererUrl: z.string().optional(),
453
457
  url: z.string().optional(),
454
- tagId: z.string().optional(),
455
458
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
456
459
  folderId: z.string().optional(),
457
- qr: z.boolean().optional(),
458
460
  root: z.boolean().optional(),
459
461
  saleType: SaleType$inboundSchema.optional(),
462
+ query: z.string().optional(),
463
+ tagId: z.string().optional(),
464
+ qr: z.boolean().optional(),
460
465
  utm_source: z.nullable(z.string()).optional(),
461
466
  utm_medium: z.nullable(z.string()).optional(),
462
467
  utm_campaign: z.nullable(z.string()).optional(),
@@ -499,12 +504,13 @@ export type RetrieveAnalyticsRequest$Outbound = {
499
504
  referer?: string | undefined;
500
505
  refererUrl?: string | undefined;
501
506
  url?: string | undefined;
502
- tagId?: string | undefined;
503
507
  tagIds?: string | Array<string> | undefined;
504
508
  folderId?: string | undefined;
505
- qr?: boolean | undefined;
506
509
  root?: boolean | undefined;
507
510
  saleType?: string | undefined;
511
+ query?: string | undefined;
512
+ tagId?: string | undefined;
513
+ qr?: boolean | undefined;
508
514
  utm_source?: string | null | undefined;
509
515
  utm_medium?: string | null | undefined;
510
516
  utm_campaign?: string | null | undefined;
@@ -543,12 +549,13 @@ export const RetrieveAnalyticsRequest$outboundSchema: z.ZodType<
543
549
  referer: z.string().optional(),
544
550
  refererUrl: z.string().optional(),
545
551
  url: z.string().optional(),
546
- tagId: z.string().optional(),
547
552
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
548
553
  folderId: z.string().optional(),
549
- qr: z.boolean().optional(),
550
554
  root: z.boolean().optional(),
551
555
  saleType: SaleType$outboundSchema.optional(),
556
+ query: z.string().optional(),
557
+ tagId: z.string().optional(),
558
+ qr: z.boolean().optional(),
552
559
  utmSource: z.nullable(z.string()).optional(),
553
560
  utmMedium: z.nullable(z.string()).optional(),
554
561
  utmCampaign: z.nullable(z.string()).optional(),
@@ -38,15 +38,15 @@ export type Link = {
38
38
  */
39
39
  clicks?: number | undefined;
40
40
  /**
41
- * The number of leads the short links has generated.
41
+ * The number of leads the short link has generated.
42
42
  */
43
43
  leads?: number | undefined;
44
44
  /**
45
- * The number of sales the short links has generated.
45
+ * The total number of sales (includes recurring sales) generated by the short link.
46
46
  */
47
47
  sales?: number | undefined;
48
48
  /**
49
- * The total dollar amount of sales the short links has generated (in cents).
49
+ * The total dollar value of sales (in cents) generated by the short link.
50
50
  */
51
51
  saleAmount?: number | undefined;
52
52
  };
@@ -61,18 +61,6 @@ export type UpdateLinkRequestBody = {
61
61
  * Whether the short link is archived. Defaults to `false` if not provided.
62
62
  */
63
63
  archived?: boolean | undefined;
64
- /**
65
- * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
66
- *
67
- * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
68
- */
69
- publicStats?: boolean | undefined;
70
- /**
71
- * The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
72
- *
73
- * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
74
- */
75
- tagId?: string | null | undefined;
76
64
  /**
77
65
  * The unique IDs of the tags assigned to the short link.
78
66
  */
@@ -178,6 +166,18 @@ export type UpdateLinkRequestBody = {
178
166
  * The date and time when the tests were or will be completed.
179
167
  */
180
168
  testCompletedAt?: string | null | undefined;
169
+ /**
170
+ * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
171
+ *
172
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
173
+ */
174
+ publicStats?: boolean | undefined;
175
+ /**
176
+ * Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link.
177
+ *
178
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
179
+ */
180
+ tagId?: string | null | undefined;
181
181
  };
182
182
 
183
183
  export type UpdateLinkRequest = {
@@ -356,8 +356,6 @@ export const UpdateLinkRequestBody$inboundSchema: z.ZodType<
356
356
  partnerId: z.nullable(z.string()).optional(),
357
357
  trackConversion: z.boolean().optional(),
358
358
  archived: z.boolean().optional(),
359
- publicStats: z.boolean().optional(),
360
- tagId: z.nullable(z.string()).optional(),
361
359
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
362
360
  tagNames: z.union([z.string(), z.array(z.string())]).optional(),
363
361
  folderId: z.nullable(z.string()).optional(),
@@ -387,6 +385,8 @@ export const UpdateLinkRequestBody$inboundSchema: z.ZodType<
387
385
  ).optional(),
388
386
  testStartedAt: z.nullable(z.string()).optional(),
389
387
  testCompletedAt: z.nullable(z.string()).optional(),
388
+ publicStats: z.boolean().optional(),
389
+ tagId: z.nullable(z.string()).optional(),
390
390
  }).transform((v) => {
391
391
  return remap$(v, {
392
392
  "utm_source": "utmSource",
@@ -408,8 +408,6 @@ export type UpdateLinkRequestBody$Outbound = {
408
408
  partnerId?: string | null | undefined;
409
409
  trackConversion?: boolean | undefined;
410
410
  archived?: boolean | undefined;
411
- publicStats?: boolean | undefined;
412
- tagId?: string | null | undefined;
413
411
  tagIds?: string | Array<string> | undefined;
414
412
  tagNames?: string | Array<string> | undefined;
415
413
  folderId?: string | null | undefined;
@@ -437,6 +435,8 @@ export type UpdateLinkRequestBody$Outbound = {
437
435
  testVariants?: Array<UpdateLinkTestVariants$Outbound> | null | undefined;
438
436
  testStartedAt?: string | null | undefined;
439
437
  testCompletedAt?: string | null | undefined;
438
+ publicStats?: boolean | undefined;
439
+ tagId?: string | null | undefined;
440
440
  };
441
441
 
442
442
  /** @internal */
@@ -454,8 +454,6 @@ export const UpdateLinkRequestBody$outboundSchema: z.ZodType<
454
454
  partnerId: z.nullable(z.string()).optional(),
455
455
  trackConversion: z.boolean().optional(),
456
456
  archived: z.boolean().optional(),
457
- publicStats: z.boolean().optional(),
458
- tagId: z.nullable(z.string()).optional(),
459
457
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
460
458
  tagNames: z.union([z.string(), z.array(z.string())]).optional(),
461
459
  folderId: z.nullable(z.string()).optional(),
@@ -485,6 +483,8 @@ export const UpdateLinkRequestBody$outboundSchema: z.ZodType<
485
483
  ).optional(),
486
484
  testStartedAt: z.nullable(z.string()).optional(),
487
485
  testCompletedAt: z.nullable(z.string()).optional(),
486
+ publicStats: z.boolean().optional(),
487
+ tagId: z.nullable(z.string()).optional(),
488
488
  }).transform((v) => {
489
489
  return remap$(v, {
490
490
  utmSource: "utm_source",
@@ -69,18 +69,6 @@ export type UpsertLinkRequestBody = {
69
69
  * Whether the short link is archived. Defaults to `false` if not provided.
70
70
  */
71
71
  archived?: boolean | undefined;
72
- /**
73
- * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
74
- *
75
- * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
76
- */
77
- publicStats?: boolean | undefined;
78
- /**
79
- * The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
80
- *
81
- * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
82
- */
83
- tagId?: string | null | undefined;
84
72
  /**
85
73
  * The unique IDs of the tags assigned to the short link.
86
74
  */
@@ -189,6 +177,18 @@ export type UpsertLinkRequestBody = {
189
177
  * The date and time when the tests were or will be completed.
190
178
  */
191
179
  testCompletedAt?: string | null | undefined;
180
+ /**
181
+ * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
182
+ *
183
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
184
+ */
185
+ publicStats?: boolean | undefined;
186
+ /**
187
+ * Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link.
188
+ *
189
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
190
+ */
191
+ tagId?: string | null | undefined;
192
192
  };
193
193
 
194
194
  /** @internal */
@@ -361,8 +361,6 @@ export const UpsertLinkRequestBody$inboundSchema: z.ZodType<
361
361
  prefix: z.string().optional(),
362
362
  trackConversion: z.boolean().optional(),
363
363
  archived: z.boolean().optional(),
364
- publicStats: z.boolean().optional(),
365
- tagId: z.nullable(z.string()).optional(),
366
364
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
367
365
  tagNames: z.union([z.string(), z.array(z.string())]).optional(),
368
366
  folderId: z.nullable(z.string()).optional(),
@@ -392,6 +390,8 @@ export const UpsertLinkRequestBody$inboundSchema: z.ZodType<
392
390
  ).optional(),
393
391
  testStartedAt: z.nullable(z.string()).optional(),
394
392
  testCompletedAt: z.nullable(z.string()).optional(),
393
+ publicStats: z.boolean().optional(),
394
+ tagId: z.nullable(z.string()).optional(),
395
395
  }).transform((v) => {
396
396
  return remap$(v, {
397
397
  "utm_source": "utmSource",
@@ -415,8 +415,6 @@ export type UpsertLinkRequestBody$Outbound = {
415
415
  prefix?: string | undefined;
416
416
  trackConversion?: boolean | undefined;
417
417
  archived?: boolean | undefined;
418
- publicStats?: boolean | undefined;
419
- tagId?: string | null | undefined;
420
418
  tagIds?: string | Array<string> | undefined;
421
419
  tagNames?: string | Array<string> | undefined;
422
420
  folderId?: string | null | undefined;
@@ -444,6 +442,8 @@ export type UpsertLinkRequestBody$Outbound = {
444
442
  testVariants?: Array<UpsertLinkTestVariants$Outbound> | null | undefined;
445
443
  testStartedAt?: string | null | undefined;
446
444
  testCompletedAt?: string | null | undefined;
445
+ publicStats?: boolean | undefined;
446
+ tagId?: string | null | undefined;
447
447
  };
448
448
 
449
449
  /** @internal */
@@ -463,8 +463,6 @@ export const UpsertLinkRequestBody$outboundSchema: z.ZodType<
463
463
  prefix: z.string().optional(),
464
464
  trackConversion: z.boolean().optional(),
465
465
  archived: z.boolean().optional(),
466
- publicStats: z.boolean().optional(),
467
- tagId: z.nullable(z.string()).optional(),
468
466
  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
469
467
  tagNames: z.union([z.string(), z.array(z.string())]).optional(),
470
468
  folderId: z.nullable(z.string()).optional(),
@@ -494,6 +492,8 @@ export const UpsertLinkRequestBody$outboundSchema: z.ZodType<
494
492
  ).optional(),
495
493
  testStartedAt: z.nullable(z.string()).optional(),
496
494
  testCompletedAt: z.nullable(z.string()).optional(),
495
+ publicStats: z.boolean().optional(),
496
+ tagId: z.nullable(z.string()).optional(),
497
497
  }).transform((v) => {
498
498
  return remap$(v, {
499
499
  utmSource: "utm_source",