dub 0.28.1 → 0.29.2

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 (347) hide show
  1. package/README.md +49 -12
  2. package/docs/sdks/analytics/README.md +59 -93
  3. package/docs/sdks/clicks/README.md +579 -0
  4. package/docs/sdks/domains/README.md +5 -15
  5. package/docs/sdks/links/README.md +58 -9
  6. package/docs/sdks/qrcodes/README.md +3 -1
  7. package/lib/config.d.ts +3 -3
  8. package/lib/config.js +3 -3
  9. package/models/components/domainschema.d.ts +14 -16
  10. package/models/components/domainschema.d.ts.map +1 -1
  11. package/models/components/domainschema.js +7 -3
  12. package/models/components/domainschema.js.map +1 -1
  13. package/models/components/linkschema.d.ts +7 -291
  14. package/models/components/linkschema.d.ts.map +1 -1
  15. package/models/components/linkschema.js +4 -0
  16. package/models/components/linkschema.js.map +1 -1
  17. package/models/components/security.d.ts +1 -4
  18. package/models/components/security.d.ts.map +1 -1
  19. package/models/components/security.js.map +1 -1
  20. package/models/components/tagschema.d.ts +24 -9
  21. package/models/components/tagschema.d.ts.map +1 -1
  22. package/models/components/tagschema.js +7 -3
  23. package/models/components/tagschema.js.map +1 -1
  24. package/models/components/workspaceschema.d.ts +38 -36
  25. package/models/components/workspaceschema.d.ts.map +1 -1
  26. package/models/components/workspaceschema.js +14 -6
  27. package/models/components/workspaceschema.js.map +1 -1
  28. package/models/errors/badrequest.d.ts +13 -13
  29. package/models/errors/badrequest.d.ts.map +1 -1
  30. package/models/errors/badrequest.js +7 -3
  31. package/models/errors/badrequest.js.map +1 -1
  32. package/models/errors/conflict.d.ts +13 -13
  33. package/models/errors/conflict.d.ts.map +1 -1
  34. package/models/errors/conflict.js +7 -3
  35. package/models/errors/conflict.js.map +1 -1
  36. package/models/errors/forbidden.d.ts +13 -13
  37. package/models/errors/forbidden.d.ts.map +1 -1
  38. package/models/errors/forbidden.js +7 -3
  39. package/models/errors/forbidden.js.map +1 -1
  40. package/models/errors/internalservererror.d.ts +13 -13
  41. package/models/errors/internalservererror.d.ts.map +1 -1
  42. package/models/errors/internalservererror.js +7 -3
  43. package/models/errors/internalservererror.js.map +1 -1
  44. package/models/errors/inviteexpired.d.ts +13 -13
  45. package/models/errors/inviteexpired.d.ts.map +1 -1
  46. package/models/errors/inviteexpired.js +7 -3
  47. package/models/errors/inviteexpired.js.map +1 -1
  48. package/models/errors/notfound.d.ts +13 -13
  49. package/models/errors/notfound.d.ts.map +1 -1
  50. package/models/errors/notfound.js +7 -3
  51. package/models/errors/notfound.js.map +1 -1
  52. package/models/errors/ratelimitexceeded.d.ts +13 -13
  53. package/models/errors/ratelimitexceeded.d.ts.map +1 -1
  54. package/models/errors/ratelimitexceeded.js +7 -3
  55. package/models/errors/ratelimitexceeded.js.map +1 -1
  56. package/models/errors/unauthorized.d.ts +13 -13
  57. package/models/errors/unauthorized.d.ts.map +1 -1
  58. package/models/errors/unauthorized.js +7 -3
  59. package/models/errors/unauthorized.js.map +1 -1
  60. package/models/errors/unprocessableentity.d.ts +13 -13
  61. package/models/errors/unprocessableentity.d.ts.map +1 -1
  62. package/models/errors/unprocessableentity.js +7 -3
  63. package/models/errors/unprocessableentity.js.map +1 -1
  64. package/models/operations/adddomain.d.ts +14 -12
  65. package/models/operations/adddomain.d.ts.map +1 -1
  66. package/models/operations/adddomain.js +7 -3
  67. package/models/operations/adddomain.js.map +1 -1
  68. package/models/operations/bulkcreatelinks.d.ts +4 -282
  69. package/models/operations/bulkcreatelinks.d.ts.map +1 -1
  70. package/models/operations/bulkcreatelinks.js.map +1 -1
  71. package/models/operations/createlink.d.ts +4 -282
  72. package/models/operations/createlink.d.ts.map +1 -1
  73. package/models/operations/createlink.js.map +1 -1
  74. package/models/operations/createtag.d.ts +24 -8
  75. package/models/operations/createtag.d.ts.map +1 -1
  76. package/models/operations/createtag.js +7 -3
  77. package/models/operations/createtag.js.map +1 -1
  78. package/models/operations/createworkspace.d.ts +1 -6
  79. package/models/operations/createworkspace.d.ts.map +1 -1
  80. package/models/operations/createworkspace.js.map +1 -1
  81. package/models/operations/deletedomain.d.ts +2 -8
  82. package/models/operations/deletedomain.d.ts.map +1 -1
  83. package/models/operations/deletedomain.js.map +1 -1
  84. package/models/operations/deletelink.d.ts +2 -8
  85. package/models/operations/deletelink.d.ts.map +1 -1
  86. package/models/operations/deletelink.js.map +1 -1
  87. package/models/operations/getbrowsersbyclicks.d.ts +922 -0
  88. package/models/operations/getbrowsersbyclicks.d.ts.map +1 -0
  89. package/models/operations/{getbrowseranalytics.js → getbrowsersbyclicks.js} +41 -23
  90. package/models/operations/getbrowsersbyclicks.js.map +1 -0
  91. package/models/operations/getbrowsersbyclicksdeprecated.d.ts +922 -0
  92. package/models/operations/getbrowsersbyclicksdeprecated.d.ts.map +1 -0
  93. package/models/operations/getbrowsersbyclicksdeprecated.js +423 -0
  94. package/models/operations/getbrowsersbyclicksdeprecated.js.map +1 -0
  95. package/models/operations/getcitiesbyclicks.d.ts +1693 -0
  96. package/models/operations/getcitiesbyclicks.d.ts.map +1 -0
  97. package/models/operations/{getcityanalytics.js → getcitiesbyclicks.js} +49 -27
  98. package/models/operations/getcitiesbyclicks.js.map +1 -0
  99. package/models/operations/getcitiesbyclicksdeprecated.d.ts +1693 -0
  100. package/models/operations/getcitiesbyclicksdeprecated.d.ts.map +1 -0
  101. package/models/operations/getcitiesbyclicksdeprecated.js +688 -0
  102. package/models/operations/{getcountryanalytics.js.map → getcitiesbyclicksdeprecated.js.map} +1 -1
  103. package/models/operations/getclickscount.d.ts +903 -0
  104. package/models/operations/getclickscount.d.ts.map +1 -0
  105. package/models/operations/{getclicksanalytics.js → getclickscount.js} +34 -16
  106. package/models/operations/getclickscount.js.map +1 -0
  107. package/models/operations/getclickscountdeprecated.d.ts +903 -0
  108. package/models/operations/getclickscountdeprecated.d.ts.map +1 -0
  109. package/models/operations/getclickscountdeprecated.js +397 -0
  110. package/models/operations/{getdeviceanalytics.js.map → getclickscountdeprecated.js.map} +1 -1
  111. package/models/operations/getcountriesbyclicks.d.ts +1688 -0
  112. package/models/operations/getcountriesbyclicks.d.ts.map +1 -0
  113. package/models/operations/{getcountryanalytics.js → getcountriesbyclicks.js} +49 -27
  114. package/models/operations/getcountriesbyclicks.js.map +1 -0
  115. package/models/operations/getcountriesbyclicksdeprecated.d.ts +1688 -0
  116. package/models/operations/getcountriesbyclicksdeprecated.d.ts.map +1 -0
  117. package/models/operations/getcountriesbyclicksdeprecated.js +684 -0
  118. package/models/operations/{getcityanalytics.js.map → getcountriesbyclicksdeprecated.js.map} +1 -1
  119. package/models/operations/getdevicesbyclicks.d.ts +922 -0
  120. package/models/operations/getdevicesbyclicks.d.ts.map +1 -0
  121. package/models/operations/{getdeviceanalytics.js → getdevicesbyclicks.js} +41 -23
  122. package/models/operations/getdevicesbyclicks.js.map +1 -0
  123. package/models/operations/getdevicesbyclicksdeprecated.d.ts +922 -0
  124. package/models/operations/getdevicesbyclicksdeprecated.d.ts.map +1 -0
  125. package/models/operations/getdevicesbyclicksdeprecated.js +423 -0
  126. package/models/operations/getdevicesbyclicksdeprecated.js.map +1 -0
  127. package/models/operations/getlinkinfo.d.ts +1 -7
  128. package/models/operations/getlinkinfo.d.ts.map +1 -1
  129. package/models/operations/getlinkinfo.js.map +1 -1
  130. package/models/operations/getlinks.d.ts +18 -20
  131. package/models/operations/getlinks.d.ts.map +1 -1
  132. package/models/operations/getlinks.js +7 -3
  133. package/models/operations/getlinks.js.map +1 -1
  134. package/models/operations/getlinkscount.d.ts +25 -24
  135. package/models/operations/getlinkscount.d.ts.map +1 -1
  136. package/models/operations/getlinkscount.js +20 -6
  137. package/models/operations/getlinkscount.js.map +1 -1
  138. package/models/operations/getmetatags.d.ts +2 -10
  139. package/models/operations/getmetatags.d.ts.map +1 -1
  140. package/models/operations/getmetatags.js.map +1 -1
  141. package/models/operations/getosbyclicks.d.ts +922 -0
  142. package/models/operations/getosbyclicks.d.ts.map +1 -0
  143. package/models/operations/{getosanalytics.js → getosbyclicks.js} +41 -23
  144. package/models/operations/getosbyclicks.js.map +1 -0
  145. package/models/operations/getosbyclicksdeprecated.d.ts +922 -0
  146. package/models/operations/getosbyclicksdeprecated.d.ts.map +1 -0
  147. package/models/operations/getosbyclicksdeprecated.js +423 -0
  148. package/models/operations/getosbyclicksdeprecated.js.map +1 -0
  149. package/models/operations/getqrcode.d.ts +20 -14
  150. package/models/operations/getqrcode.d.ts.map +1 -1
  151. package/models/operations/getqrcode.js +9 -5
  152. package/models/operations/getqrcode.js.map +1 -1
  153. package/models/operations/getreferersbyclicks.d.ts +922 -0
  154. package/models/operations/getreferersbyclicks.d.ts.map +1 -0
  155. package/models/operations/{getrefereranalytics.js → getreferersbyclicks.js} +41 -23
  156. package/models/operations/getreferersbyclicks.js.map +1 -0
  157. package/models/operations/getreferersbyclicksdeprecated.d.ts +922 -0
  158. package/models/operations/getreferersbyclicksdeprecated.d.ts.map +1 -0
  159. package/models/operations/getreferersbyclicksdeprecated.js +423 -0
  160. package/models/operations/getreferersbyclicksdeprecated.js.map +1 -0
  161. package/models/operations/gettags.d.ts +1 -2
  162. package/models/operations/gettags.d.ts.map +1 -1
  163. package/models/operations/gettags.js.map +1 -1
  164. package/models/operations/gettimeseriesbyclicks.d.ts +922 -0
  165. package/models/operations/gettimeseriesbyclicks.d.ts.map +1 -0
  166. package/models/operations/{gettimeseriesanalytics.js → gettimeseriesbyclicks.js} +34 -16
  167. package/models/operations/gettimeseriesbyclicks.js.map +1 -0
  168. package/models/operations/gettimeseriesbyclicksdeprecated.d.ts +922 -0
  169. package/models/operations/gettimeseriesbyclicksdeprecated.d.ts.map +1 -0
  170. package/models/operations/gettimeseriesbyclicksdeprecated.js +423 -0
  171. package/models/operations/gettimeseriesbyclicksdeprecated.js.map +1 -0
  172. package/models/operations/gettoplinksbyclicks.d.ts +922 -0
  173. package/models/operations/gettoplinksbyclicks.d.ts.map +1 -0
  174. package/models/operations/{gettoplinks.js → gettoplinksbyclicks.js} +41 -23
  175. package/models/operations/gettoplinksbyclicks.js.map +1 -0
  176. package/models/operations/gettoplinksbyclicksdeprecated.d.ts +922 -0
  177. package/models/operations/gettoplinksbyclicksdeprecated.d.ts.map +1 -0
  178. package/models/operations/gettoplinksbyclicksdeprecated.js +423 -0
  179. package/models/operations/gettoplinksbyclicksdeprecated.js.map +1 -0
  180. package/models/operations/gettopurlsbyclicks.d.ts +922 -0
  181. package/models/operations/gettopurlsbyclicks.d.ts.map +1 -0
  182. package/models/operations/{gettopurls.js → gettopurlsbyclicks.js} +41 -23
  183. package/models/operations/gettopurlsbyclicks.js.map +1 -0
  184. package/models/operations/gettopurlsbyclicksdeprecated.d.ts +922 -0
  185. package/models/operations/gettopurlsbyclicksdeprecated.d.ts.map +1 -0
  186. package/models/operations/gettopurlsbyclicksdeprecated.js +423 -0
  187. package/models/operations/{getclicksanalytics.js.map → gettopurlsbyclicksdeprecated.js.map} +1 -1
  188. package/models/operations/getworkspace.d.ts +1 -4
  189. package/models/operations/getworkspace.d.ts.map +1 -1
  190. package/models/operations/getworkspace.js.map +1 -1
  191. package/models/operations/index.d.ts +21 -10
  192. package/models/operations/index.d.ts.map +1 -1
  193. package/models/operations/index.js +21 -10
  194. package/models/operations/index.js.map +1 -1
  195. package/models/operations/listdomains.d.ts +1 -2
  196. package/models/operations/listdomains.d.ts.map +1 -1
  197. package/models/operations/listdomains.js.map +1 -1
  198. package/models/operations/setprimarydomain.d.ts +1 -4
  199. package/models/operations/setprimarydomain.d.ts.map +1 -1
  200. package/models/operations/setprimarydomain.js.map +1 -1
  201. package/models/operations/transferdomain.d.ts +2 -9
  202. package/models/operations/transferdomain.d.ts.map +1 -1
  203. package/models/operations/transferdomain.js.map +1 -1
  204. package/models/operations/updatedomain.d.ts +15 -17
  205. package/models/operations/updatedomain.d.ts.map +1 -1
  206. package/models/operations/updatedomain.js +7 -3
  207. package/models/operations/updatedomain.js.map +1 -1
  208. package/models/operations/updatelink.d.ts +5 -287
  209. package/models/operations/updatelink.d.ts.map +1 -1
  210. package/models/operations/updatelink.js.map +1 -1
  211. package/models/operations/upsertlink.d.ts +655 -0
  212. package/models/operations/upsertlink.d.ts.map +1 -0
  213. package/models/operations/upsertlink.js +1179 -0
  214. package/models/operations/upsertlink.js.map +1 -0
  215. package/package.json +1 -1
  216. package/sdk/analytics.d.ts +39 -25
  217. package/sdk/analytics.d.ts.map +1 -1
  218. package/sdk/analytics.js +128 -276
  219. package/sdk/analytics.js.map +1 -1
  220. package/sdk/clicks.d.ts +87 -0
  221. package/sdk/clicks.d.ts.map +1 -0
  222. package/sdk/clicks.js +2355 -0
  223. package/sdk/clicks.js.map +1 -0
  224. package/sdk/domains.d.ts +2 -2
  225. package/sdk/domains.d.ts.map +1 -1
  226. package/sdk/domains.js +24 -21
  227. package/sdk/domains.js.map +1 -1
  228. package/sdk/links.d.ts +13 -6
  229. package/sdk/links.d.ts.map +1 -1
  230. package/sdk/links.js +213 -32
  231. package/sdk/links.js.map +1 -1
  232. package/sdk/metatags.d.ts +1 -1
  233. package/sdk/metatags.d.ts.map +1 -1
  234. package/sdk/metatags.js +5 -4
  235. package/sdk/metatags.js.map +1 -1
  236. package/sdk/qrcodes.d.ts +1 -1
  237. package/sdk/qrcodes.d.ts.map +1 -1
  238. package/sdk/qrcodes.js +6 -5
  239. package/sdk/qrcodes.js.map +1 -1
  240. package/sdk/tags.d.ts +2 -2
  241. package/sdk/tags.d.ts.map +1 -1
  242. package/sdk/tags.js +12 -9
  243. package/sdk/tags.js.map +1 -1
  244. package/sdk/workspaces.d.ts +2 -2
  245. package/sdk/workspaces.d.ts.map +1 -1
  246. package/sdk/workspaces.js +15 -13
  247. package/sdk/workspaces.js.map +1 -1
  248. package/src/lib/config.ts +3 -3
  249. package/src/models/components/domainschema.ts +10 -19
  250. package/src/models/components/linkschema.ts +11 -293
  251. package/src/models/components/security.ts +1 -5
  252. package/src/models/components/tagschema.ts +10 -12
  253. package/src/models/components/workspaceschema.ts +20 -43
  254. package/src/models/errors/badrequest.ts +11 -17
  255. package/src/models/errors/conflict.ts +11 -17
  256. package/src/models/errors/forbidden.ts +11 -17
  257. package/src/models/errors/internalservererror.ts +11 -19
  258. package/src/models/errors/inviteexpired.ts +11 -18
  259. package/src/models/errors/notfound.ts +11 -17
  260. package/src/models/errors/ratelimitexceeded.ts +11 -19
  261. package/src/models/errors/unauthorized.ts +11 -18
  262. package/src/models/errors/unprocessableentity.ts +11 -19
  263. package/src/models/operations/adddomain.ts +10 -15
  264. package/src/models/operations/bulkcreatelinks.ts +8 -288
  265. package/src/models/operations/createlink.ts +8 -288
  266. package/src/models/operations/createtag.ts +10 -11
  267. package/src/models/operations/createworkspace.ts +1 -7
  268. package/src/models/operations/deletedomain.ts +2 -10
  269. package/src/models/operations/deletelink.ts +2 -10
  270. package/src/models/operations/{getbrowseranalytics.ts → getbrowsersbyclicks.ts} +59 -57
  271. package/src/models/operations/getbrowsersbyclicksdeprecated.ts +538 -0
  272. package/src/models/operations/{getcityanalytics.ts → getcitiesbyclicks.ts} +81 -78
  273. package/src/models/operations/getcitiesbyclicksdeprecated.ts +814 -0
  274. package/src/models/operations/{getclicksanalytics.ts → getclickscount.ts} +47 -38
  275. package/src/models/operations/{gettimeseriesanalytics.ts → getclickscountdeprecated.ts} +95 -128
  276. package/src/models/operations/{getcountryanalytics.ts → getcountriesbyclicks.ts} +69 -66
  277. package/src/models/operations/getcountriesbyclicksdeprecated.ts +807 -0
  278. package/src/models/operations/{getdeviceanalytics.ts → getdevicesbyclicks.ts} +59 -57
  279. package/src/models/operations/getdevicesbyclicksdeprecated.ts +537 -0
  280. package/src/models/operations/getlinkinfo.ts +1 -8
  281. package/src/models/operations/getlinks.ts +16 -27
  282. package/src/models/operations/getlinkscount.ts +29 -31
  283. package/src/models/operations/getmetatags.ts +2 -12
  284. package/src/models/operations/{getosanalytics.ts → getosbyclicks.ts} +55 -57
  285. package/src/models/operations/getosbyclicksdeprecated.ts +530 -0
  286. package/src/models/operations/getqrcode.ts +14 -19
  287. package/src/models/operations/{getrefereranalytics.ts → getreferersbyclicks.ts} +59 -57
  288. package/src/models/operations/getreferersbyclicksdeprecated.ts +538 -0
  289. package/src/models/operations/gettags.ts +1 -3
  290. package/src/models/operations/{gettopurls.ts → gettimeseriesbyclicks.ts} +63 -63
  291. package/src/models/operations/gettimeseriesbyclicksdeprecated.ts +539 -0
  292. package/src/models/operations/{gettoplinks.ts → gettoplinksbyclicks.ts} +74 -65
  293. package/src/models/operations/gettoplinksbyclicksdeprecated.ts +538 -0
  294. package/src/models/operations/gettopurlsbyclicks.ts +522 -0
  295. package/src/models/operations/gettopurlsbyclicksdeprecated.ts +537 -0
  296. package/src/models/operations/getworkspace.ts +1 -5
  297. package/src/models/operations/index.ts +21 -10
  298. package/src/models/operations/listdomains.ts +1 -3
  299. package/src/models/operations/setprimarydomain.ts +1 -5
  300. package/src/models/operations/transferdomain.ts +2 -11
  301. package/src/models/operations/updatedomain.ts +11 -22
  302. package/src/models/operations/updatelink.ts +9 -294
  303. package/src/models/operations/upsertlink.ts +1796 -0
  304. package/src/sdk/analytics.ts +160 -350
  305. package/src/sdk/clicks.ts +2906 -0
  306. package/src/sdk/domains.ts +24 -21
  307. package/src/sdk/links.ts +269 -32
  308. package/src/sdk/metatags.ts +5 -4
  309. package/src/sdk/qrcodes.ts +6 -5
  310. package/src/sdk/tags.ts +12 -9
  311. package/src/sdk/workspaces.ts +15 -13
  312. package/src/types/enums.ts +16 -0
  313. package/src/types/index.ts +2 -0
  314. package/types/enums.d.ts +12 -0
  315. package/types/enums.d.ts.map +1 -0
  316. package/types/enums.js +11 -0
  317. package/types/enums.js.map +1 -0
  318. package/types/index.d.ts +2 -0
  319. package/types/index.d.ts.map +1 -1
  320. package/types/index.js +3 -1
  321. package/types/index.js.map +1 -1
  322. package/models/operations/getbrowseranalytics.d.ts +0 -404
  323. package/models/operations/getbrowseranalytics.d.ts.map +0 -1
  324. package/models/operations/getbrowseranalytics.js.map +0 -1
  325. package/models/operations/getcityanalytics.d.ts +0 -671
  326. package/models/operations/getcityanalytics.d.ts.map +0 -1
  327. package/models/operations/getclicksanalytics.d.ts +0 -381
  328. package/models/operations/getclicksanalytics.d.ts.map +0 -1
  329. package/models/operations/getcountryanalytics.d.ts +0 -665
  330. package/models/operations/getcountryanalytics.d.ts.map +0 -1
  331. package/models/operations/getdeviceanalytics.d.ts +0 -404
  332. package/models/operations/getdeviceanalytics.d.ts.map +0 -1
  333. package/models/operations/getosanalytics.d.ts +0 -404
  334. package/models/operations/getosanalytics.d.ts.map +0 -1
  335. package/models/operations/getosanalytics.js.map +0 -1
  336. package/models/operations/getrefereranalytics.d.ts +0 -404
  337. package/models/operations/getrefereranalytics.d.ts.map +0 -1
  338. package/models/operations/getrefereranalytics.js.map +0 -1
  339. package/models/operations/gettimeseriesanalytics.d.ts +0 -404
  340. package/models/operations/gettimeseriesanalytics.d.ts.map +0 -1
  341. package/models/operations/gettimeseriesanalytics.js.map +0 -1
  342. package/models/operations/gettoplinks.d.ts +0 -404
  343. package/models/operations/gettoplinks.d.ts.map +0 -1
  344. package/models/operations/gettoplinks.js.map +0 -1
  345. package/models/operations/gettopurls.d.ts +0 -404
  346. package/models/operations/gettopurls.d.ts.map +0 -1
  347. package/models/operations/gettopurls.js.map +0 -1
@@ -2,29 +2,33 @@
2
2
  * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
3
3
  */
4
4
 
5
+ import { ClosedEnum } from "../../types";
5
6
  import * as z from "zod";
6
7
 
7
8
  /**
8
- * The interval to retrieve analytics for.
9
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
9
10
  */
10
- export const GetTopLinksQueryParamInterval = {
11
+ export const GetTopLinksByClicksQueryParamInterval = {
11
12
  Oneh: "1h",
12
13
  TwentyFourh: "24h",
13
14
  Sevend: "7d",
14
15
  Thirtyd: "30d",
15
16
  Ninetyd: "90d",
17
+ Ytd: "ytd",
18
+ Oney: "1y",
16
19
  All: "all",
17
20
  } as const;
18
21
  /**
19
- * The interval to retrieve analytics for.
22
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
20
23
  */
21
- export type GetTopLinksQueryParamInterval =
22
- (typeof GetTopLinksQueryParamInterval)[keyof typeof GetTopLinksQueryParamInterval];
24
+ export type GetTopLinksByClicksQueryParamInterval = ClosedEnum<
25
+ typeof GetTopLinksByClicksQueryParamInterval
26
+ >;
23
27
 
24
28
  /**
25
29
  * The country to retrieve analytics for.
26
30
  */
27
- export const GetTopLinksQueryParamCountry = {
31
+ export const GetTopLinksByClicksQueryParamCountry = {
28
32
  Af: "AF",
29
33
  Al: "AL",
30
34
  Dz: "DZ",
@@ -279,12 +283,13 @@ export const GetTopLinksQueryParamCountry = {
279
283
  /**
280
284
  * The country to retrieve analytics for.
281
285
  */
282
- export type GetTopLinksQueryParamCountry =
283
- (typeof GetTopLinksQueryParamCountry)[keyof typeof GetTopLinksQueryParamCountry];
286
+ export type GetTopLinksByClicksQueryParamCountry = ClosedEnum<
287
+ typeof GetTopLinksByClicksQueryParamCountry
288
+ >;
284
289
 
285
- export type GetTopLinksRequest = {
290
+ export type GetTopLinksByClicksRequest = {
286
291
  /**
287
- * The domain of the short link.
292
+ * The domain to filter analytics for.
288
293
  */
289
294
  domain?: string | undefined;
290
295
  /**
@@ -300,13 +305,21 @@ export type GetTopLinksRequest = {
300
305
  */
301
306
  externalId?: string | undefined;
302
307
  /**
303
- * The interval to retrieve analytics for.
308
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
304
309
  */
305
- interval?: GetTopLinksQueryParamInterval | undefined;
310
+ interval?: GetTopLinksByClicksQueryParamInterval | undefined;
311
+ /**
312
+ * The start date and time when to retrieve analytics from.
313
+ */
314
+ start?: string | undefined;
315
+ /**
316
+ * The end date and time when to retrieve analytics from. If not provided, defaults to the current date.
317
+ */
318
+ end?: string | undefined;
306
319
  /**
307
320
  * The country to retrieve analytics for.
308
321
  */
309
- country?: GetTopLinksQueryParamCountry | undefined;
322
+ country?: GetTopLinksByClicksQueryParamCountry | undefined;
310
323
  /**
311
324
  * The city to retrieve analytics for.
312
325
  */
@@ -345,7 +358,7 @@ export type GetTopLinksRequest = {
345
358
  root?: boolean | undefined;
346
359
  };
347
360
 
348
- export type GetTopLinksResponseBody = {
361
+ export type GetTopLinksByClicksResponseBody = {
349
362
  /**
350
363
  * The unique ID of the short link
351
364
  */
@@ -357,41 +370,29 @@ export type GetTopLinksResponseBody = {
357
370
  };
358
371
 
359
372
  /** @internal */
360
- export const GetTopLinksQueryParamInterval$: z.ZodNativeEnum<typeof GetTopLinksQueryParamInterval> =
361
- z.nativeEnum(GetTopLinksQueryParamInterval);
373
+ export namespace GetTopLinksByClicksQueryParamInterval$ {
374
+ export const inboundSchema = z.nativeEnum(GetTopLinksByClicksQueryParamInterval);
375
+ export const outboundSchema = inboundSchema;
376
+ }
362
377
 
363
378
  /** @internal */
364
- export const GetTopLinksQueryParamCountry$: z.ZodNativeEnum<typeof GetTopLinksQueryParamCountry> =
365
- z.nativeEnum(GetTopLinksQueryParamCountry);
379
+ export namespace GetTopLinksByClicksQueryParamCountry$ {
380
+ export const inboundSchema = z.nativeEnum(GetTopLinksByClicksQueryParamCountry);
381
+ export const outboundSchema = inboundSchema;
382
+ }
366
383
 
367
384
  /** @internal */
368
- export namespace GetTopLinksRequest$ {
369
- export type Inbound = {
370
- domain?: string | undefined;
371
- key?: string | undefined;
372
- linkId?: string | undefined;
373
- externalId?: string | undefined;
374
- interval?: GetTopLinksQueryParamInterval | undefined;
375
- country?: GetTopLinksQueryParamCountry | undefined;
376
- city?: string | undefined;
377
- device?: string | undefined;
378
- browser?: string | undefined;
379
- os?: string | undefined;
380
- referer?: string | undefined;
381
- url?: string | undefined;
382
- tagId?: string | undefined;
383
- qr?: boolean | undefined;
384
- root?: boolean | undefined;
385
- };
386
-
387
- export const inboundSchema: z.ZodType<GetTopLinksRequest, z.ZodTypeDef, Inbound> = z
385
+ export namespace GetTopLinksByClicksRequest$ {
386
+ export const inboundSchema: z.ZodType<GetTopLinksByClicksRequest, z.ZodTypeDef, unknown> = z
388
387
  .object({
389
388
  domain: z.string().optional(),
390
389
  key: z.string().optional(),
391
390
  linkId: z.string().optional(),
392
391
  externalId: z.string().optional(),
393
- interval: GetTopLinksQueryParamInterval$.optional(),
394
- country: GetTopLinksQueryParamCountry$.optional(),
392
+ interval: GetTopLinksByClicksQueryParamInterval$.inboundSchema.default("24h"),
393
+ start: z.string().optional(),
394
+ end: z.string().optional(),
395
+ country: GetTopLinksByClicksQueryParamCountry$.inboundSchema.optional(),
395
396
  city: z.string().optional(),
396
397
  device: z.string().optional(),
397
398
  browser: z.string().optional(),
@@ -408,7 +409,9 @@ export namespace GetTopLinksRequest$ {
408
409
  ...(v.key === undefined ? null : { key: v.key }),
409
410
  ...(v.linkId === undefined ? null : { linkId: v.linkId }),
410
411
  ...(v.externalId === undefined ? null : { externalId: v.externalId }),
411
- ...(v.interval === undefined ? null : { interval: v.interval }),
412
+ interval: v.interval,
413
+ ...(v.start === undefined ? null : { start: v.start }),
414
+ ...(v.end === undefined ? null : { end: v.end }),
412
415
  ...(v.country === undefined ? null : { country: v.country }),
413
416
  ...(v.city === undefined ? null : { city: v.city }),
414
417
  ...(v.device === undefined ? null : { device: v.device }),
@@ -427,8 +430,10 @@ export namespace GetTopLinksRequest$ {
427
430
  key?: string | undefined;
428
431
  linkId?: string | undefined;
429
432
  externalId?: string | undefined;
430
- interval?: GetTopLinksQueryParamInterval | undefined;
431
- country?: GetTopLinksQueryParamCountry | undefined;
433
+ interval: string;
434
+ start?: string | undefined;
435
+ end?: string | undefined;
436
+ country?: string | undefined;
432
437
  city?: string | undefined;
433
438
  device?: string | undefined;
434
439
  browser?: string | undefined;
@@ -440,14 +445,16 @@ export namespace GetTopLinksRequest$ {
440
445
  root?: boolean | undefined;
441
446
  };
442
447
 
443
- export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTopLinksRequest> = z
448
+ export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTopLinksByClicksRequest> = z
444
449
  .object({
445
450
  domain: z.string().optional(),
446
451
  key: z.string().optional(),
447
452
  linkId: z.string().optional(),
448
453
  externalId: z.string().optional(),
449
- interval: GetTopLinksQueryParamInterval$.optional(),
450
- country: GetTopLinksQueryParamCountry$.optional(),
454
+ interval: GetTopLinksByClicksQueryParamInterval$.outboundSchema.default("24h"),
455
+ start: z.string().optional(),
456
+ end: z.string().optional(),
457
+ country: GetTopLinksByClicksQueryParamCountry$.outboundSchema.optional(),
451
458
  city: z.string().optional(),
452
459
  device: z.string().optional(),
453
460
  browser: z.string().optional(),
@@ -464,7 +471,9 @@ export namespace GetTopLinksRequest$ {
464
471
  ...(v.key === undefined ? null : { key: v.key }),
465
472
  ...(v.linkId === undefined ? null : { linkId: v.linkId }),
466
473
  ...(v.externalId === undefined ? null : { externalId: v.externalId }),
467
- ...(v.interval === undefined ? null : { interval: v.interval }),
474
+ interval: v.interval,
475
+ ...(v.start === undefined ? null : { start: v.start }),
476
+ ...(v.end === undefined ? null : { end: v.end }),
468
477
  ...(v.country === undefined ? null : { country: v.country }),
469
478
  ...(v.city === undefined ? null : { city: v.city }),
470
479
  ...(v.device === undefined ? null : { device: v.device }),
@@ -480,30 +489,30 @@ export namespace GetTopLinksRequest$ {
480
489
  }
481
490
 
482
491
  /** @internal */
483
- export namespace GetTopLinksResponseBody$ {
484
- export type Inbound = {
485
- link: string;
486
- clicks: number;
487
- };
488
-
489
- export const inboundSchema: z.ZodType<GetTopLinksResponseBody, z.ZodTypeDef, Inbound> = z
490
- .object({
491
- link: z.string(),
492
- clicks: z.number(),
493
- })
494
- .transform((v) => {
495
- return {
496
- link: v.link,
497
- clicks: v.clicks,
498
- };
499
- });
492
+ export namespace GetTopLinksByClicksResponseBody$ {
493
+ export const inboundSchema: z.ZodType<GetTopLinksByClicksResponseBody, z.ZodTypeDef, unknown> =
494
+ z
495
+ .object({
496
+ link: z.string(),
497
+ clicks: z.number(),
498
+ })
499
+ .transform((v) => {
500
+ return {
501
+ link: v.link,
502
+ clicks: v.clicks,
503
+ };
504
+ });
500
505
 
501
506
  export type Outbound = {
502
507
  link: string;
503
508
  clicks: number;
504
509
  };
505
510
 
506
- export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTopLinksResponseBody> = z
511
+ export const outboundSchema: z.ZodType<
512
+ Outbound,
513
+ z.ZodTypeDef,
514
+ GetTopLinksByClicksResponseBody
515
+ > = z
507
516
  .object({
508
517
  link: z.string(),
509
518
  clicks: z.number(),