dub 0.41.2 → 0.43.0

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 (253) hide show
  1. package/README.md +17 -6
  2. package/dist/commonjs/funcs/analyticsRetrieve.d.ts.map +1 -1
  3. package/dist/commonjs/funcs/analyticsRetrieve.js +1 -2
  4. package/dist/commonjs/funcs/analyticsRetrieve.js.map +1 -1
  5. package/dist/commonjs/funcs/domainsCreate.d.ts.map +1 -1
  6. package/dist/commonjs/funcs/domainsCreate.js +1 -2
  7. package/dist/commonjs/funcs/domainsCreate.js.map +1 -1
  8. package/dist/commonjs/funcs/domainsList.d.ts.map +1 -1
  9. package/dist/commonjs/funcs/domainsList.js +4 -5
  10. package/dist/commonjs/funcs/domainsList.js.map +1 -1
  11. package/dist/commonjs/funcs/eventsList.d.ts.map +1 -1
  12. package/dist/commonjs/funcs/eventsList.js +1 -2
  13. package/dist/commonjs/funcs/eventsList.js.map +1 -1
  14. package/dist/commonjs/funcs/linksCount.d.ts.map +1 -1
  15. package/dist/commonjs/funcs/linksCount.js +1 -2
  16. package/dist/commonjs/funcs/linksCount.js.map +1 -1
  17. package/dist/commonjs/funcs/linksCreate.d.ts.map +1 -1
  18. package/dist/commonjs/funcs/linksCreate.js +1 -2
  19. package/dist/commonjs/funcs/linksCreate.js.map +1 -1
  20. package/dist/commonjs/funcs/linksCreateMany.d.ts.map +1 -1
  21. package/dist/commonjs/funcs/linksCreateMany.js +1 -2
  22. package/dist/commonjs/funcs/linksCreateMany.js.map +1 -1
  23. package/dist/commonjs/funcs/linksDeleteMany.d.ts.map +1 -1
  24. package/dist/commonjs/funcs/linksDeleteMany.js +1 -2
  25. package/dist/commonjs/funcs/linksDeleteMany.js.map +1 -1
  26. package/dist/commonjs/funcs/linksGet.d.ts.map +1 -1
  27. package/dist/commonjs/funcs/linksGet.js +1 -2
  28. package/dist/commonjs/funcs/linksGet.js.map +1 -1
  29. package/dist/commonjs/funcs/linksList.d.ts.map +1 -1
  30. package/dist/commonjs/funcs/linksList.js +4 -5
  31. package/dist/commonjs/funcs/linksList.js.map +1 -1
  32. package/dist/commonjs/funcs/linksUpdateMany.d.ts.map +1 -1
  33. package/dist/commonjs/funcs/linksUpdateMany.js +1 -2
  34. package/dist/commonjs/funcs/linksUpdateMany.js.map +1 -1
  35. package/dist/commonjs/funcs/linksUpsert.d.ts.map +1 -1
  36. package/dist/commonjs/funcs/linksUpsert.js +1 -2
  37. package/dist/commonjs/funcs/linksUpsert.js.map +1 -1
  38. package/dist/commonjs/funcs/metatagsGet.d.ts.map +1 -1
  39. package/dist/commonjs/funcs/metatagsGet.js +1 -2
  40. package/dist/commonjs/funcs/metatagsGet.js.map +1 -1
  41. package/dist/commonjs/funcs/qrCodesGet.d.ts.map +1 -1
  42. package/dist/commonjs/funcs/qrCodesGet.js +1 -2
  43. package/dist/commonjs/funcs/qrCodesGet.js.map +1 -1
  44. package/dist/commonjs/funcs/tagsCreate.d.ts.map +1 -1
  45. package/dist/commonjs/funcs/tagsCreate.js +1 -2
  46. package/dist/commonjs/funcs/tagsCreate.js.map +1 -1
  47. package/dist/commonjs/funcs/trackCustomer.d.ts.map +1 -1
  48. package/dist/commonjs/funcs/trackCustomer.js +1 -2
  49. package/dist/commonjs/funcs/trackCustomer.js.map +1 -1
  50. package/dist/commonjs/funcs/trackLead.d.ts.map +1 -1
  51. package/dist/commonjs/funcs/trackLead.js +1 -2
  52. package/dist/commonjs/funcs/trackLead.js.map +1 -1
  53. package/dist/commonjs/funcs/trackSale.d.ts.map +1 -1
  54. package/dist/commonjs/funcs/trackSale.js +1 -2
  55. package/dist/commonjs/funcs/trackSale.js.map +1 -1
  56. package/dist/commonjs/funcs/workspacesGet.d.ts.map +1 -1
  57. package/dist/commonjs/funcs/workspacesGet.js +1 -2
  58. package/dist/commonjs/funcs/workspacesGet.js.map +1 -1
  59. package/dist/commonjs/lib/config.d.ts +3 -3
  60. package/dist/commonjs/lib/config.js +3 -3
  61. package/dist/commonjs/lib/config.js.map +1 -1
  62. package/dist/commonjs/models/components/clickevent.d.ts +9 -4
  63. package/dist/commonjs/models/components/clickevent.d.ts.map +1 -1
  64. package/dist/commonjs/models/components/clickevent.js +4 -2
  65. package/dist/commonjs/models/components/clickevent.js.map +1 -1
  66. package/dist/commonjs/models/components/leadevent.d.ts +9 -4
  67. package/dist/commonjs/models/components/leadevent.d.ts.map +1 -1
  68. package/dist/commonjs/models/components/leadevent.js +4 -2
  69. package/dist/commonjs/models/components/leadevent.js.map +1 -1
  70. package/dist/commonjs/models/components/linkschema.d.ts +10 -5
  71. package/dist/commonjs/models/components/linkschema.d.ts.map +1 -1
  72. package/dist/commonjs/models/components/linkschema.js +4 -2
  73. package/dist/commonjs/models/components/linkschema.js.map +1 -1
  74. package/dist/commonjs/models/components/saleevent.d.ts +9 -4
  75. package/dist/commonjs/models/components/saleevent.d.ts.map +1 -1
  76. package/dist/commonjs/models/components/saleevent.js +4 -2
  77. package/dist/commonjs/models/components/saleevent.js.map +1 -1
  78. package/dist/commonjs/models/components/webhookevent.d.ts +36 -16
  79. package/dist/commonjs/models/components/webhookevent.d.ts.map +1 -1
  80. package/dist/commonjs/models/components/webhookevent.js +16 -8
  81. package/dist/commonjs/models/components/webhookevent.js.map +1 -1
  82. package/dist/commonjs/models/components/workspaceschema.d.ts +5 -0
  83. package/dist/commonjs/models/components/workspaceschema.d.ts.map +1 -1
  84. package/dist/commonjs/models/components/workspaceschema.js +2 -0
  85. package/dist/commonjs/models/components/workspaceschema.js.map +1 -1
  86. package/dist/commonjs/models/operations/bulkcreatelinks.d.ts +5 -0
  87. package/dist/commonjs/models/operations/bulkcreatelinks.d.ts.map +1 -1
  88. package/dist/commonjs/models/operations/bulkcreatelinks.js +2 -0
  89. package/dist/commonjs/models/operations/bulkcreatelinks.js.map +1 -1
  90. package/dist/commonjs/models/operations/bulkupdatelinks.d.ts +10 -2
  91. package/dist/commonjs/models/operations/bulkupdatelinks.d.ts.map +1 -1
  92. package/dist/commonjs/models/operations/bulkupdatelinks.js +4 -2
  93. package/dist/commonjs/models/operations/bulkupdatelinks.js.map +1 -1
  94. package/dist/commonjs/models/operations/createlink.d.ts +5 -0
  95. package/dist/commonjs/models/operations/createlink.d.ts.map +1 -1
  96. package/dist/commonjs/models/operations/createlink.js +2 -0
  97. package/dist/commonjs/models/operations/createlink.js.map +1 -1
  98. package/dist/commonjs/models/operations/getlinkinfo.d.ts +1 -1
  99. package/dist/commonjs/models/operations/updatelink.d.ts +5 -0
  100. package/dist/commonjs/models/operations/updatelink.d.ts.map +1 -1
  101. package/dist/commonjs/models/operations/updatelink.js +2 -0
  102. package/dist/commonjs/models/operations/updatelink.js.map +1 -1
  103. package/dist/commonjs/models/operations/upsertlink.d.ts +5 -0
  104. package/dist/commonjs/models/operations/upsertlink.d.ts.map +1 -1
  105. package/dist/commonjs/models/operations/upsertlink.js +2 -0
  106. package/dist/commonjs/models/operations/upsertlink.js.map +1 -1
  107. package/dist/esm/funcs/analyticsRetrieve.d.ts.map +1 -1
  108. package/dist/esm/funcs/analyticsRetrieve.js +1 -2
  109. package/dist/esm/funcs/analyticsRetrieve.js.map +1 -1
  110. package/dist/esm/funcs/domainsCreate.d.ts.map +1 -1
  111. package/dist/esm/funcs/domainsCreate.js +1 -2
  112. package/dist/esm/funcs/domainsCreate.js.map +1 -1
  113. package/dist/esm/funcs/domainsList.d.ts.map +1 -1
  114. package/dist/esm/funcs/domainsList.js +4 -5
  115. package/dist/esm/funcs/domainsList.js.map +1 -1
  116. package/dist/esm/funcs/eventsList.d.ts.map +1 -1
  117. package/dist/esm/funcs/eventsList.js +1 -2
  118. package/dist/esm/funcs/eventsList.js.map +1 -1
  119. package/dist/esm/funcs/linksCount.d.ts.map +1 -1
  120. package/dist/esm/funcs/linksCount.js +1 -2
  121. package/dist/esm/funcs/linksCount.js.map +1 -1
  122. package/dist/esm/funcs/linksCreate.d.ts.map +1 -1
  123. package/dist/esm/funcs/linksCreate.js +1 -2
  124. package/dist/esm/funcs/linksCreate.js.map +1 -1
  125. package/dist/esm/funcs/linksCreateMany.d.ts.map +1 -1
  126. package/dist/esm/funcs/linksCreateMany.js +1 -2
  127. package/dist/esm/funcs/linksCreateMany.js.map +1 -1
  128. package/dist/esm/funcs/linksDeleteMany.d.ts.map +1 -1
  129. package/dist/esm/funcs/linksDeleteMany.js +1 -2
  130. package/dist/esm/funcs/linksDeleteMany.js.map +1 -1
  131. package/dist/esm/funcs/linksGet.d.ts.map +1 -1
  132. package/dist/esm/funcs/linksGet.js +1 -2
  133. package/dist/esm/funcs/linksGet.js.map +1 -1
  134. package/dist/esm/funcs/linksList.d.ts.map +1 -1
  135. package/dist/esm/funcs/linksList.js +4 -5
  136. package/dist/esm/funcs/linksList.js.map +1 -1
  137. package/dist/esm/funcs/linksUpdateMany.d.ts.map +1 -1
  138. package/dist/esm/funcs/linksUpdateMany.js +1 -2
  139. package/dist/esm/funcs/linksUpdateMany.js.map +1 -1
  140. package/dist/esm/funcs/linksUpsert.d.ts.map +1 -1
  141. package/dist/esm/funcs/linksUpsert.js +1 -2
  142. package/dist/esm/funcs/linksUpsert.js.map +1 -1
  143. package/dist/esm/funcs/metatagsGet.d.ts.map +1 -1
  144. package/dist/esm/funcs/metatagsGet.js +1 -2
  145. package/dist/esm/funcs/metatagsGet.js.map +1 -1
  146. package/dist/esm/funcs/qrCodesGet.d.ts.map +1 -1
  147. package/dist/esm/funcs/qrCodesGet.js +1 -2
  148. package/dist/esm/funcs/qrCodesGet.js.map +1 -1
  149. package/dist/esm/funcs/tagsCreate.d.ts.map +1 -1
  150. package/dist/esm/funcs/tagsCreate.js +1 -2
  151. package/dist/esm/funcs/tagsCreate.js.map +1 -1
  152. package/dist/esm/funcs/trackCustomer.d.ts.map +1 -1
  153. package/dist/esm/funcs/trackCustomer.js +1 -2
  154. package/dist/esm/funcs/trackCustomer.js.map +1 -1
  155. package/dist/esm/funcs/trackLead.d.ts.map +1 -1
  156. package/dist/esm/funcs/trackLead.js +1 -2
  157. package/dist/esm/funcs/trackLead.js.map +1 -1
  158. package/dist/esm/funcs/trackSale.d.ts.map +1 -1
  159. package/dist/esm/funcs/trackSale.js +1 -2
  160. package/dist/esm/funcs/trackSale.js.map +1 -1
  161. package/dist/esm/funcs/workspacesGet.d.ts.map +1 -1
  162. package/dist/esm/funcs/workspacesGet.js +1 -2
  163. package/dist/esm/funcs/workspacesGet.js.map +1 -1
  164. package/dist/esm/lib/config.d.ts +3 -3
  165. package/dist/esm/lib/config.js +3 -3
  166. package/dist/esm/lib/config.js.map +1 -1
  167. package/dist/esm/models/components/clickevent.d.ts +9 -4
  168. package/dist/esm/models/components/clickevent.d.ts.map +1 -1
  169. package/dist/esm/models/components/clickevent.js +4 -2
  170. package/dist/esm/models/components/clickevent.js.map +1 -1
  171. package/dist/esm/models/components/leadevent.d.ts +9 -4
  172. package/dist/esm/models/components/leadevent.d.ts.map +1 -1
  173. package/dist/esm/models/components/leadevent.js +4 -2
  174. package/dist/esm/models/components/leadevent.js.map +1 -1
  175. package/dist/esm/models/components/linkschema.d.ts +10 -5
  176. package/dist/esm/models/components/linkschema.d.ts.map +1 -1
  177. package/dist/esm/models/components/linkschema.js +4 -2
  178. package/dist/esm/models/components/linkschema.js.map +1 -1
  179. package/dist/esm/models/components/saleevent.d.ts +9 -4
  180. package/dist/esm/models/components/saleevent.d.ts.map +1 -1
  181. package/dist/esm/models/components/saleevent.js +4 -2
  182. package/dist/esm/models/components/saleevent.js.map +1 -1
  183. package/dist/esm/models/components/webhookevent.d.ts +36 -16
  184. package/dist/esm/models/components/webhookevent.d.ts.map +1 -1
  185. package/dist/esm/models/components/webhookevent.js +16 -8
  186. package/dist/esm/models/components/webhookevent.js.map +1 -1
  187. package/dist/esm/models/components/workspaceschema.d.ts +5 -0
  188. package/dist/esm/models/components/workspaceschema.d.ts.map +1 -1
  189. package/dist/esm/models/components/workspaceschema.js +2 -0
  190. package/dist/esm/models/components/workspaceschema.js.map +1 -1
  191. package/dist/esm/models/operations/bulkcreatelinks.d.ts +5 -0
  192. package/dist/esm/models/operations/bulkcreatelinks.d.ts.map +1 -1
  193. package/dist/esm/models/operations/bulkcreatelinks.js +2 -0
  194. package/dist/esm/models/operations/bulkcreatelinks.js.map +1 -1
  195. package/dist/esm/models/operations/bulkupdatelinks.d.ts +10 -2
  196. package/dist/esm/models/operations/bulkupdatelinks.d.ts.map +1 -1
  197. package/dist/esm/models/operations/bulkupdatelinks.js +4 -2
  198. package/dist/esm/models/operations/bulkupdatelinks.js.map +1 -1
  199. package/dist/esm/models/operations/createlink.d.ts +5 -0
  200. package/dist/esm/models/operations/createlink.d.ts.map +1 -1
  201. package/dist/esm/models/operations/createlink.js +2 -0
  202. package/dist/esm/models/operations/createlink.js.map +1 -1
  203. package/dist/esm/models/operations/getlinkinfo.d.ts +1 -1
  204. package/dist/esm/models/operations/updatelink.d.ts +5 -0
  205. package/dist/esm/models/operations/updatelink.d.ts.map +1 -1
  206. package/dist/esm/models/operations/updatelink.js +2 -0
  207. package/dist/esm/models/operations/updatelink.js.map +1 -1
  208. package/dist/esm/models/operations/upsertlink.d.ts +5 -0
  209. package/dist/esm/models/operations/upsertlink.d.ts.map +1 -1
  210. package/dist/esm/models/operations/upsertlink.js +2 -0
  211. package/dist/esm/models/operations/upsertlink.js.map +1 -1
  212. package/docs/sdks/analytics/README.md +2 -2
  213. package/docs/sdks/domains/README.md +8 -11
  214. package/docs/sdks/events/README.md +2 -2
  215. package/docs/sdks/links/README.md +20 -29
  216. package/docs/sdks/metatags/README.md +2 -2
  217. package/docs/sdks/qrcodes/README.md +2 -2
  218. package/docs/sdks/tags/README.md +8 -11
  219. package/docs/sdks/track/README.md +6 -8
  220. package/docs/sdks/workspaces/README.md +4 -5
  221. package/package.json +1 -1
  222. package/src/funcs/analyticsRetrieve.ts +1 -3
  223. package/src/funcs/domainsCreate.ts +1 -3
  224. package/src/funcs/domainsList.ts +4 -6
  225. package/src/funcs/eventsList.ts +1 -3
  226. package/src/funcs/linksCount.ts +1 -3
  227. package/src/funcs/linksCreate.ts +1 -3
  228. package/src/funcs/linksCreateMany.ts +1 -3
  229. package/src/funcs/linksDeleteMany.ts +1 -3
  230. package/src/funcs/linksGet.ts +1 -3
  231. package/src/funcs/linksList.ts +4 -6
  232. package/src/funcs/linksUpdateMany.ts +1 -3
  233. package/src/funcs/linksUpsert.ts +1 -3
  234. package/src/funcs/metatagsGet.ts +1 -3
  235. package/src/funcs/qrCodesGet.ts +1 -3
  236. package/src/funcs/tagsCreate.ts +1 -3
  237. package/src/funcs/trackCustomer.ts +1 -3
  238. package/src/funcs/trackLead.ts +1 -3
  239. package/src/funcs/trackSale.ts +1 -3
  240. package/src/funcs/workspacesGet.ts +1 -3
  241. package/src/lib/config.ts +3 -3
  242. package/src/models/components/clickevent.ts +13 -6
  243. package/src/models/components/leadevent.ts +13 -6
  244. package/src/models/components/linkschema.ts +14 -7
  245. package/src/models/components/saleevent.ts +13 -6
  246. package/src/models/components/webhookevent.ts +52 -24
  247. package/src/models/components/workspaceschema.ts +7 -0
  248. package/src/models/operations/bulkcreatelinks.ts +7 -0
  249. package/src/models/operations/bulkupdatelinks.ts +14 -4
  250. package/src/models/operations/createlink.ts +7 -0
  251. package/src/models/operations/getlinkinfo.ts +1 -1
  252. package/src/models/operations/updatelink.ts +7 -0
  253. package/src/models/operations/upsertlink.ts +7 -0
@@ -61,10 +61,8 @@ export async function linksList(
61
61
  >
62
62
  >
63
63
  > {
64
- const input = request;
65
-
66
64
  const parsed = safeParse(
67
- input,
65
+ request,
68
66
  (value) =>
69
67
  operations.GetLinksRequest$outboundSchema.optional().parse(value),
70
68
  "Input validation failed",
@@ -204,7 +202,7 @@ export async function linksList(
204
202
  | ConnectionError
205
203
  >
206
204
  > => {
207
- const page = input?.page || 0;
205
+ const page = request?.page || 0;
208
206
  const nextPage = page + 1;
209
207
 
210
208
  if (!responseData) {
@@ -216,7 +214,7 @@ export async function linksList(
216
214
  if (!Array.isArray(results) || !results.length) {
217
215
  return () => null;
218
216
  }
219
- const limit = input?.pageSize || 0;
217
+ const limit = request?.pageSize || 0;
220
218
  if (results.length < limit) {
221
219
  return () => null;
222
220
  }
@@ -225,7 +223,7 @@ export async function linksList(
225
223
  linksList(
226
224
  client,
227
225
  {
228
- ...input,
226
+ ...request,
229
227
  page: nextPage,
230
228
  },
231
229
  options,
@@ -55,10 +55,8 @@ export async function linksUpdateMany(
55
55
  | ConnectionError
56
56
  >
57
57
  > {
58
- const input = request;
59
-
60
58
  const parsed = safeParse(
61
- input,
59
+ request,
62
60
  (value) =>
63
61
  operations.BulkUpdateLinksRequestBody$outboundSchema.optional().parse(
64
62
  value,
@@ -54,10 +54,8 @@ export async function linksUpsert(
54
54
  | ConnectionError
55
55
  >
56
56
  > {
57
- const input = request;
58
-
59
57
  const parsed = safeParse(
60
- input,
58
+ request,
61
59
  (value) =>
62
60
  operations.UpsertLinkRequestBody$outboundSchema.optional().parse(value),
63
61
  "Input validation failed",
@@ -43,10 +43,8 @@ export async function metatagsGet(
43
43
  | ConnectionError
44
44
  >
45
45
  > {
46
- const input = request;
47
-
48
46
  const parsed = safeParse(
49
- input,
47
+ request,
50
48
  (value) => operations.GetMetatagsRequest$outboundSchema.parse(value),
51
49
  "Input validation failed",
52
50
  );
@@ -54,10 +54,8 @@ export async function qrCodesGet(
54
54
  | ConnectionError
55
55
  >
56
56
  > {
57
- const input = request;
58
-
59
57
  const parsed = safeParse(
60
- input,
58
+ request,
61
59
  (value) => operations.GetQRCodeRequest$outboundSchema.parse(value),
62
60
  "Input validation failed",
63
61
  );
@@ -54,10 +54,8 @@ export async function tagsCreate(
54
54
  | ConnectionError
55
55
  >
56
56
  > {
57
- const input = request;
58
-
59
57
  const parsed = safeParse(
60
- input,
58
+ request,
61
59
  (value) =>
62
60
  operations.CreateTagRequestBody$outboundSchema.optional().parse(value),
63
61
  "Input validation failed",
@@ -53,10 +53,8 @@ export async function trackCustomer(
53
53
  | ConnectionError
54
54
  >
55
55
  > {
56
- const input = request;
57
-
58
56
  const parsed = safeParse(
59
- input,
57
+ request,
60
58
  (value) =>
61
59
  operations.TrackCustomerRequestBody$outboundSchema.optional().parse(
62
60
  value,
@@ -53,10 +53,8 @@ export async function trackLead(
53
53
  | ConnectionError
54
54
  >
55
55
  > {
56
- const input = request;
57
-
58
56
  const parsed = safeParse(
59
- input,
57
+ request,
60
58
  (value) =>
61
59
  operations.TrackLeadRequestBody$outboundSchema.optional().parse(value),
62
60
  "Input validation failed",
@@ -53,10 +53,8 @@ export async function trackSale(
53
53
  | ConnectionError
54
54
  >
55
55
  > {
56
- const input = request;
57
-
58
56
  const parsed = safeParse(
59
- input,
57
+ request,
60
58
  (value) =>
61
59
  operations.TrackSaleRequestBody$outboundSchema.optional().parse(value),
62
60
  "Input validation failed",
@@ -54,10 +54,8 @@ export async function workspacesGet(
54
54
  | ConnectionError
55
55
  >
56
56
  > {
57
- const input = request;
58
-
59
57
  const parsed = safeParse(
60
- input,
58
+ request,
61
59
  (value) => operations.GetWorkspaceRequest$outboundSchema.parse(value),
62
60
  "Input validation failed",
63
61
  );
package/src/lib/config.ts CHANGED
@@ -57,7 +57,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
57
57
  export const SDK_METADATA = {
58
58
  language: "typescript",
59
59
  openapiDocVersion: "0.0.1",
60
- sdkVersion: "0.41.2",
61
- genVersion: "2.422.22",
62
- userAgent: "speakeasy-sdk/typescript 0.41.2 2.422.22 0.0.1 dub",
60
+ sdkVersion: "0.43.0",
61
+ genVersion: "2.429.0",
62
+ userAgent: "speakeasy-sdk/typescript 0.43.0 2.429.0 0.0.1 dub",
63
63
  } as const;
@@ -301,12 +301,16 @@ export type Link = {
301
301
  * The short link slug. If not provided, a random 7-character slug will be generated.
302
302
  */
303
303
  key: string;
304
+ url: string;
305
+ trackConversion?: boolean | undefined;
304
306
  /**
305
- * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
307
+ * This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
306
308
  */
307
309
  externalId: string | null;
308
- url: string;
309
- trackConversion?: boolean | undefined;
310
+ /**
311
+ * The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
312
+ */
313
+ identifier: string | null;
310
314
  archived?: boolean | undefined;
311
315
  expiresAt: string;
312
316
  /**
@@ -1889,9 +1893,10 @@ export const Link$inboundSchema: z.ZodType<Link, z.ZodTypeDef, unknown> = z
1889
1893
  id: z.string(),
1890
1894
  domain: z.string(),
1891
1895
  key: z.string(),
1892
- externalId: z.nullable(z.string()),
1893
1896
  url: z.string(),
1894
1897
  trackConversion: z.boolean().optional(),
1898
+ externalId: z.nullable(z.string()),
1899
+ identifier: z.nullable(z.string()),
1895
1900
  archived: z.boolean().optional(),
1896
1901
  expiresAt: z.string(),
1897
1902
  expiredUrl: z.nullable(z.string()),
@@ -1942,9 +1947,10 @@ export type Link$Outbound = {
1942
1947
  id: string;
1943
1948
  domain: string;
1944
1949
  key: string;
1945
- externalId: string | null;
1946
1950
  url: string;
1947
1951
  trackConversion?: boolean | undefined;
1952
+ externalId: string | null;
1953
+ identifier: string | null;
1948
1954
  archived?: boolean | undefined;
1949
1955
  expiresAt: string;
1950
1956
  expiredUrl: string | null;
@@ -1988,9 +1994,10 @@ export const Link$outboundSchema: z.ZodType<Link$Outbound, z.ZodTypeDef, Link> =
1988
1994
  id: z.string(),
1989
1995
  domain: z.string(),
1990
1996
  key: z.string(),
1991
- externalId: z.nullable(z.string()),
1992
1997
  url: z.string(),
1993
1998
  trackConversion: z.boolean().optional(),
1999
+ externalId: z.nullable(z.string()),
2000
+ identifier: z.nullable(z.string()),
1994
2001
  archived: z.boolean().optional(),
1995
2002
  expiresAt: z.string(),
1996
2003
  expiredUrl: z.nullable(z.string()),
@@ -301,12 +301,16 @@ export type LeadEventLink = {
301
301
  * The short link slug. If not provided, a random 7-character slug will be generated.
302
302
  */
303
303
  key: string;
304
+ url: string;
305
+ trackConversion?: boolean | undefined;
304
306
  /**
305
- * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
307
+ * This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
306
308
  */
307
309
  externalId: string | null;
308
- url: string;
309
- trackConversion?: boolean | undefined;
310
+ /**
311
+ * The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
312
+ */
313
+ identifier: string | null;
310
314
  archived?: boolean | undefined;
311
315
  expiresAt: string;
312
316
  /**
@@ -1906,9 +1910,10 @@ export const LeadEventLink$inboundSchema: z.ZodType<
1906
1910
  id: z.string(),
1907
1911
  domain: z.string(),
1908
1912
  key: z.string(),
1909
- externalId: z.nullable(z.string()),
1910
1913
  url: z.string(),
1911
1914
  trackConversion: z.boolean().optional(),
1915
+ externalId: z.nullable(z.string()),
1916
+ identifier: z.nullable(z.string()),
1912
1917
  archived: z.boolean().optional(),
1913
1918
  expiresAt: z.string(),
1914
1919
  expiredUrl: z.nullable(z.string()),
@@ -1959,9 +1964,10 @@ export type LeadEventLink$Outbound = {
1959
1964
  id: string;
1960
1965
  domain: string;
1961
1966
  key: string;
1962
- externalId: string | null;
1963
1967
  url: string;
1964
1968
  trackConversion?: boolean | undefined;
1969
+ externalId: string | null;
1970
+ identifier: string | null;
1965
1971
  archived?: boolean | undefined;
1966
1972
  expiresAt: string;
1967
1973
  expiredUrl: string | null;
@@ -2008,9 +2014,10 @@ export const LeadEventLink$outboundSchema: z.ZodType<
2008
2014
  id: z.string(),
2009
2015
  domain: z.string(),
2010
2016
  key: z.string(),
2011
- externalId: z.nullable(z.string()),
2012
2017
  url: z.string(),
2013
2018
  trackConversion: z.boolean().optional(),
2019
+ externalId: z.nullable(z.string()),
2020
+ identifier: z.nullable(z.string()),
2014
2021
  archived: z.boolean().optional(),
2015
2022
  expiresAt: z.string(),
2016
2023
  expiredUrl: z.nullable(z.string()),
@@ -280,10 +280,6 @@ export type LinkSchema = {
280
280
  * The short link slug. If not provided, a random 7-character slug will be generated.
281
281
  */
282
282
  key: string;
283
- /**
284
- * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
285
- */
286
- externalId: string | null;
287
283
  /**
288
284
  * The destination URL of the short link.
289
285
  */
@@ -292,6 +288,14 @@ export type LinkSchema = {
292
288
  * [BETA] Whether to track conversions for the short link.
293
289
  */
294
290
  trackConversion?: boolean | undefined;
291
+ /**
292
+ * This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
293
+ */
294
+ externalId: string | null;
295
+ /**
296
+ * The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
297
+ */
298
+ identifier: string | null;
295
299
  /**
296
300
  * Whether the short link is archived.
297
301
  */
@@ -1730,9 +1734,10 @@ export const LinkSchema$inboundSchema: z.ZodType<
1730
1734
  id: z.string(),
1731
1735
  domain: z.string(),
1732
1736
  key: z.string(),
1733
- externalId: z.nullable(z.string()),
1734
1737
  url: z.string(),
1735
1738
  trackConversion: z.boolean().default(false),
1739
+ externalId: z.nullable(z.string()),
1740
+ identifier: z.nullable(z.string()),
1736
1741
  archived: z.boolean().default(false),
1737
1742
  expiresAt: z.nullable(z.string()),
1738
1743
  expiredUrl: z.nullable(z.string()),
@@ -1783,9 +1788,10 @@ export type LinkSchema$Outbound = {
1783
1788
  id: string;
1784
1789
  domain: string;
1785
1790
  key: string;
1786
- externalId: string | null;
1787
1791
  url: string;
1788
1792
  trackConversion: boolean;
1793
+ externalId: string | null;
1794
+ identifier: string | null;
1789
1795
  archived: boolean;
1790
1796
  expiresAt: string | null;
1791
1797
  expiredUrl: string | null;
@@ -1832,9 +1838,10 @@ export const LinkSchema$outboundSchema: z.ZodType<
1832
1838
  id: z.string(),
1833
1839
  domain: z.string(),
1834
1840
  key: z.string(),
1835
- externalId: z.nullable(z.string()),
1836
1841
  url: z.string(),
1837
1842
  trackConversion: z.boolean().default(false),
1843
+ externalId: z.nullable(z.string()),
1844
+ identifier: z.nullable(z.string()),
1838
1845
  archived: z.boolean().default(false),
1839
1846
  expiresAt: z.nullable(z.string()),
1840
1847
  expiredUrl: z.nullable(z.string()),
@@ -286,12 +286,16 @@ export type SaleEventLink = {
286
286
  * The short link slug. If not provided, a random 7-character slug will be generated.
287
287
  */
288
288
  key: string;
289
+ url: string;
290
+ trackConversion?: boolean | undefined;
289
291
  /**
290
- * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
292
+ * This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
291
293
  */
292
294
  externalId: string | null;
293
- url: string;
294
- trackConversion?: boolean | undefined;
295
+ /**
296
+ * The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
297
+ */
298
+ identifier: string | null;
295
299
  archived?: boolean | undefined;
296
300
  expiresAt: string;
297
301
  /**
@@ -1882,9 +1886,10 @@ export const SaleEventLink$inboundSchema: z.ZodType<
1882
1886
  id: z.string(),
1883
1887
  domain: z.string(),
1884
1888
  key: z.string(),
1885
- externalId: z.nullable(z.string()),
1886
1889
  url: z.string(),
1887
1890
  trackConversion: z.boolean().optional(),
1891
+ externalId: z.nullable(z.string()),
1892
+ identifier: z.nullable(z.string()),
1888
1893
  archived: z.boolean().optional(),
1889
1894
  expiresAt: z.string(),
1890
1895
  expiredUrl: z.nullable(z.string()),
@@ -1935,9 +1940,10 @@ export type SaleEventLink$Outbound = {
1935
1940
  id: string;
1936
1941
  domain: string;
1937
1942
  key: string;
1938
- externalId: string | null;
1939
1943
  url: string;
1940
1944
  trackConversion?: boolean | undefined;
1945
+ externalId: string | null;
1946
+ identifier: string | null;
1941
1947
  archived?: boolean | undefined;
1942
1948
  expiresAt: string;
1943
1949
  expiredUrl: string | null;
@@ -1984,9 +1990,10 @@ export const SaleEventLink$outboundSchema: z.ZodType<
1984
1990
  id: z.string(),
1985
1991
  domain: z.string(),
1986
1992
  key: z.string(),
1987
- externalId: z.nullable(z.string()),
1988
1993
  url: z.string(),
1989
1994
  trackConversion: z.boolean().optional(),
1995
+ externalId: z.nullable(z.string()),
1996
+ identifier: z.nullable(z.string()),
1990
1997
  archived: z.boolean().optional(),
1991
1998
  expiresAt: z.string(),
1992
1999
  expiredUrl: z.nullable(z.string()),
@@ -308,12 +308,16 @@ export type WebhookEvent4Link = {
308
308
  * The short link slug. If not provided, a random 7-character slug will be generated.
309
309
  */
310
310
  key: string;
311
+ url: string;
312
+ trackConversion?: boolean | undefined;
311
313
  /**
312
- * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
314
+ * This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
313
315
  */
314
316
  externalId: string | null;
315
- url: string;
316
- trackConversion?: boolean | undefined;
317
+ /**
318
+ * The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
319
+ */
320
+ identifier: string | null;
317
321
  archived?: boolean | undefined;
318
322
  expiresAt: string;
319
323
  /**
@@ -748,12 +752,16 @@ export type WebhookEvent3Link = {
748
752
  * The short link slug. If not provided, a random 7-character slug will be generated.
749
753
  */
750
754
  key: string;
755
+ url: string;
756
+ trackConversion?: boolean | undefined;
751
757
  /**
752
- * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
758
+ * This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
753
759
  */
754
760
  externalId: string | null;
755
- url: string;
756
- trackConversion?: boolean | undefined;
761
+ /**
762
+ * The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
763
+ */
764
+ identifier: string | null;
757
765
  archived?: boolean | undefined;
758
766
  expiresAt: string;
759
767
  /**
@@ -1173,12 +1181,16 @@ export type WebhookEventLink = {
1173
1181
  * The short link slug. If not provided, a random 7-character slug will be generated.
1174
1182
  */
1175
1183
  key: string;
1184
+ url: string;
1185
+ trackConversion?: boolean | undefined;
1176
1186
  /**
1177
- * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
1187
+ * This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
1178
1188
  */
1179
1189
  externalId: string | null;
1180
- url: string;
1181
- trackConversion?: boolean | undefined;
1190
+ /**
1191
+ * The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
1192
+ */
1193
+ identifier: string | null;
1182
1194
  archived?: boolean | undefined;
1183
1195
  expiresAt: string;
1184
1196
  /**
@@ -1593,12 +1605,16 @@ export type Data = {
1593
1605
  * The short link slug. If not provided, a random 7-character slug will be generated.
1594
1606
  */
1595
1607
  key: string;
1608
+ url: string;
1609
+ trackConversion?: boolean | undefined;
1596
1610
  /**
1597
- * This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
1611
+ * This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
1598
1612
  */
1599
1613
  externalId: string | null;
1600
- url: string;
1601
- trackConversion?: boolean | undefined;
1614
+ /**
1615
+ * The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
1616
+ */
1617
+ identifier: string | null;
1602
1618
  archived?: boolean | undefined;
1603
1619
  expiresAt: string;
1604
1620
  /**
@@ -3160,9 +3176,10 @@ export const WebhookEvent4Link$inboundSchema: z.ZodType<
3160
3176
  id: z.string(),
3161
3177
  domain: z.string(),
3162
3178
  key: z.string(),
3163
- externalId: z.nullable(z.string()),
3164
3179
  url: z.string(),
3165
3180
  trackConversion: z.boolean().optional(),
3181
+ externalId: z.nullable(z.string()),
3182
+ identifier: z.nullable(z.string()),
3166
3183
  archived: z.boolean().optional(),
3167
3184
  expiresAt: z.string(),
3168
3185
  expiredUrl: z.nullable(z.string()),
@@ -3213,9 +3230,10 @@ export type WebhookEvent4Link$Outbound = {
3213
3230
  id: string;
3214
3231
  domain: string;
3215
3232
  key: string;
3216
- externalId: string | null;
3217
3233
  url: string;
3218
3234
  trackConversion?: boolean | undefined;
3235
+ externalId: string | null;
3236
+ identifier: string | null;
3219
3237
  archived?: boolean | undefined;
3220
3238
  expiresAt: string;
3221
3239
  expiredUrl: string | null;
@@ -3262,9 +3280,10 @@ export const WebhookEvent4Link$outboundSchema: z.ZodType<
3262
3280
  id: z.string(),
3263
3281
  domain: z.string(),
3264
3282
  key: z.string(),
3265
- externalId: z.nullable(z.string()),
3266
3283
  url: z.string(),
3267
3284
  trackConversion: z.boolean().optional(),
3285
+ externalId: z.nullable(z.string()),
3286
+ identifier: z.nullable(z.string()),
3268
3287
  archived: z.boolean().optional(),
3269
3288
  expiresAt: z.string(),
3270
3289
  expiredUrl: z.nullable(z.string()),
@@ -4888,9 +4907,10 @@ export const WebhookEvent3Link$inboundSchema: z.ZodType<
4888
4907
  id: z.string(),
4889
4908
  domain: z.string(),
4890
4909
  key: z.string(),
4891
- externalId: z.nullable(z.string()),
4892
4910
  url: z.string(),
4893
4911
  trackConversion: z.boolean().optional(),
4912
+ externalId: z.nullable(z.string()),
4913
+ identifier: z.nullable(z.string()),
4894
4914
  archived: z.boolean().optional(),
4895
4915
  expiresAt: z.string(),
4896
4916
  expiredUrl: z.nullable(z.string()),
@@ -4941,9 +4961,10 @@ export type WebhookEvent3Link$Outbound = {
4941
4961
  id: string;
4942
4962
  domain: string;
4943
4963
  key: string;
4944
- externalId: string | null;
4945
4964
  url: string;
4946
4965
  trackConversion?: boolean | undefined;
4966
+ externalId: string | null;
4967
+ identifier: string | null;
4947
4968
  archived?: boolean | undefined;
4948
4969
  expiresAt: string;
4949
4970
  expiredUrl: string | null;
@@ -4990,9 +5011,10 @@ export const WebhookEvent3Link$outboundSchema: z.ZodType<
4990
5011
  id: z.string(),
4991
5012
  domain: z.string(),
4992
5013
  key: z.string(),
4993
- externalId: z.nullable(z.string()),
4994
5014
  url: z.string(),
4995
5015
  trackConversion: z.boolean().optional(),
5016
+ externalId: z.nullable(z.string()),
5017
+ identifier: z.nullable(z.string()),
4996
5018
  archived: z.boolean().optional(),
4997
5019
  expiresAt: z.string(),
4998
5020
  expiredUrl: z.nullable(z.string()),
@@ -6526,9 +6548,10 @@ export const WebhookEventLink$inboundSchema: z.ZodType<
6526
6548
  id: z.string(),
6527
6549
  domain: z.string(),
6528
6550
  key: z.string(),
6529
- externalId: z.nullable(z.string()),
6530
6551
  url: z.string(),
6531
6552
  trackConversion: z.boolean().optional(),
6553
+ externalId: z.nullable(z.string()),
6554
+ identifier: z.nullable(z.string()),
6532
6555
  archived: z.boolean().optional(),
6533
6556
  expiresAt: z.string(),
6534
6557
  expiredUrl: z.nullable(z.string()),
@@ -6579,9 +6602,10 @@ export type WebhookEventLink$Outbound = {
6579
6602
  id: string;
6580
6603
  domain: string;
6581
6604
  key: string;
6582
- externalId: string | null;
6583
6605
  url: string;
6584
6606
  trackConversion?: boolean | undefined;
6607
+ externalId: string | null;
6608
+ identifier: string | null;
6585
6609
  archived?: boolean | undefined;
6586
6610
  expiresAt: string;
6587
6611
  expiredUrl: string | null;
@@ -6628,9 +6652,10 @@ export const WebhookEventLink$outboundSchema: z.ZodType<
6628
6652
  id: z.string(),
6629
6653
  domain: z.string(),
6630
6654
  key: z.string(),
6631
- externalId: z.nullable(z.string()),
6632
6655
  url: z.string(),
6633
6656
  trackConversion: z.boolean().optional(),
6657
+ externalId: z.nullable(z.string()),
6658
+ identifier: z.nullable(z.string()),
6634
6659
  archived: z.boolean().optional(),
6635
6660
  expiresAt: z.string(),
6636
6661
  expiredUrl: z.nullable(z.string()),
@@ -8153,9 +8178,10 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
8153
8178
  id: z.string(),
8154
8179
  domain: z.string(),
8155
8180
  key: z.string(),
8156
- externalId: z.nullable(z.string()),
8157
8181
  url: z.string(),
8158
8182
  trackConversion: z.boolean().optional(),
8183
+ externalId: z.nullable(z.string()),
8184
+ identifier: z.nullable(z.string()),
8159
8185
  archived: z.boolean().optional(),
8160
8186
  expiresAt: z.string(),
8161
8187
  expiredUrl: z.nullable(z.string()),
@@ -8206,9 +8232,10 @@ export type Data$Outbound = {
8206
8232
  id: string;
8207
8233
  domain: string;
8208
8234
  key: string;
8209
- externalId: string | null;
8210
8235
  url: string;
8211
8236
  trackConversion?: boolean | undefined;
8237
+ externalId: string | null;
8238
+ identifier: string | null;
8212
8239
  archived?: boolean | undefined;
8213
8240
  expiresAt: string;
8214
8241
  expiredUrl: string | null;
@@ -8252,9 +8279,10 @@ export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
8252
8279
  id: z.string(),
8253
8280
  domain: z.string(),
8254
8281
  key: z.string(),
8255
- externalId: z.nullable(z.string()),
8256
8282
  url: z.string(),
8257
8283
  trackConversion: z.boolean().optional(),
8284
+ externalId: z.nullable(z.string()),
8285
+ identifier: z.nullable(z.string()),
8258
8286
  archived: z.boolean().optional(),
8259
8287
  expiresAt: z.string(),
8260
8288
  expiredUrl: z.nullable(z.string()),
@@ -165,6 +165,10 @@ export type WorkspaceSchema = {
165
165
  * The feature flags of the workspace, indicating which features are enabled.
166
166
  */
167
167
  flags?: { [k: string]: boolean } | undefined;
168
+ /**
169
+ * The publishable key of the workspace.
170
+ */
171
+ publishableKey: string | null;
168
172
  };
169
173
 
170
174
  /** @internal */
@@ -312,6 +316,7 @@ export const WorkspaceSchema$inboundSchema: z.ZodType<
312
316
  users: z.array(z.lazy(() => Users$inboundSchema)),
313
317
  domains: z.array(z.lazy(() => Domains$inboundSchema)),
314
318
  flags: z.record(z.boolean()).optional(),
319
+ publishableKey: z.nullable(z.string()),
315
320
  });
316
321
 
317
322
  /** @internal */
@@ -343,6 +348,7 @@ export type WorkspaceSchema$Outbound = {
343
348
  users: Array<Users$Outbound>;
344
349
  domains: Array<Domains$Outbound>;
345
350
  flags?: { [k: string]: boolean } | undefined;
351
+ publishableKey: string | null;
346
352
  };
347
353
 
348
354
  /** @internal */
@@ -378,6 +384,7 @@ export const WorkspaceSchema$outboundSchema: z.ZodType<
378
384
  users: z.array(z.lazy(() => Users$outboundSchema)),
379
385
  domains: z.array(z.lazy(() => Domains$outboundSchema)),
380
386
  flags: z.record(z.boolean()).optional(),
387
+ publishableKey: z.nullable(z.string()),
381
388
  });
382
389
 
383
390
  /**