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
package/README.md CHANGED
@@ -36,7 +36,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
36
36
  <!-- Start SDK Example Usage [usage] -->
37
37
  ## SDK Example Usage
38
38
 
39
- ### Example
39
+ ### Example 1
40
40
 
41
41
  ```typescript
42
42
  import { Dub } from "dub";
@@ -57,6 +57,29 @@ async function run() {
57
57
 
58
58
  run();
59
59
 
60
+ ```
61
+
62
+ ### Example 2
63
+
64
+ ```typescript
65
+ import { Dub } from "dub";
66
+
67
+ const dub = new Dub({
68
+ token: "DUB_API_KEY",
69
+ workspaceId: "<value>",
70
+ });
71
+
72
+ async function run() {
73
+ const result = await dub.links.upsert({
74
+ url: "https://google/com",
75
+ });
76
+
77
+ // Handle the result
78
+ console.log(result);
79
+ }
80
+
81
+ run();
82
+
60
83
  ```
61
84
  <!-- End SDK Example Usage [usage] -->
62
85
 
@@ -72,6 +95,7 @@ run();
72
95
  * [delete](docs/sdks/links/README.md#delete) - Delete a link
73
96
  * [update](docs/sdks/links/README.md#update) - Update a link
74
97
  * [createMany](docs/sdks/links/README.md#createmany) - Bulk create links
98
+ * [upsert](docs/sdks/links/README.md#upsert) - Upsert a link
75
99
 
76
100
  ### [qrCodes](docs/sdks/qrcodes/README.md)
77
101
 
@@ -79,16 +103,29 @@ run();
79
103
 
80
104
  ### [analytics](docs/sdks/analytics/README.md)
81
105
 
82
- * [clicks](docs/sdks/analytics/README.md#clicks) - Retrieve clicks analytics
83
- * [timeseries](docs/sdks/analytics/README.md#timeseries) - Retrieve timeseries analytics
84
- * [countries](docs/sdks/analytics/README.md#countries) - Retrieve country analytics
85
- * [cities](docs/sdks/analytics/README.md#cities) - Retrieve city analytics
86
- * [devices](docs/sdks/analytics/README.md#devices) - Retrieve device analytics
87
- * [browsers](docs/sdks/analytics/README.md#browsers) - Retrieve browser analytics
88
- * [os](docs/sdks/analytics/README.md#os) - Retrieve OS analytics
89
- * [referers](docs/sdks/analytics/README.md#referers) - Retrieve referer analytics
90
- * [topLinks](docs/sdks/analytics/README.md#toplinks) - Retrieve top links
91
- * [topUrls](docs/sdks/analytics/README.md#topurls) - Retrieve top URLs
106
+ * [~~timeseries~~](docs/sdks/analytics/README.md#timeseries) - Retrieve timeseries click analytics :warning: **Deprecated** Use `timeseries` instead.
107
+ * [~~country~~](docs/sdks/analytics/README.md#country) - Retrieve top countries by clicks :warning: **Deprecated** Use `countries` instead.
108
+ * [~~city~~](docs/sdks/analytics/README.md#city) - Retrieve top cities by clicks :warning: **Deprecated** Use `cities` instead.
109
+ * [~~device~~](docs/sdks/analytics/README.md#device) - Retrieve top devices by clicks :warning: **Deprecated** Use `devices` instead.
110
+ * [~~browser~~](docs/sdks/analytics/README.md#browser) - Retrieve top browsers by clicks :warning: **Deprecated** Use `browsers` instead.
111
+ * [~~os~~](docs/sdks/analytics/README.md#os) - Retrieve top OS by clicks :warning: **Deprecated** Use `os` instead.
112
+ * [~~referer~~](docs/sdks/analytics/README.md#referer) - Retrieve top referers by clicks :warning: **Deprecated** Use `referers` instead.
113
+ * [~~topLinks~~](docs/sdks/analytics/README.md#toplinks) - Retrieve top links by clicks :warning: **Deprecated** Use `topLinks` instead.
114
+ * [~~topUrls~~](docs/sdks/analytics/README.md#topurls) - Retrieve top URLs by clicks :warning: **Deprecated** Use `topUrls` instead.
115
+
116
+ ### [analytics.clicks](docs/sdks/clicks/README.md)
117
+
118
+ * [count](docs/sdks/clicks/README.md#count) - Retrieve the total clicks count
119
+ * [timeseries](docs/sdks/clicks/README.md#timeseries) - Retrieve timeseries click analytics
120
+ * [countries](docs/sdks/clicks/README.md#countries) - Retrieve top countries by clicks
121
+ * [cities](docs/sdks/clicks/README.md#cities) - Retrieve top cities by clicks
122
+ * [devices](docs/sdks/clicks/README.md#devices) - Retrieve top devices by clicks
123
+ * [browsers](docs/sdks/clicks/README.md#browsers) - Retrieve top browsers by clicks
124
+ * [os](docs/sdks/clicks/README.md#os) - Retrieve top OS by clicks
125
+ * [referers](docs/sdks/clicks/README.md#referers) - Retrieve top referers by clicks
126
+ * [topLinks](docs/sdks/clicks/README.md#toplinks) - Retrieve top links by clicks
127
+ * [topUrls](docs/sdks/clicks/README.md#topurls) - Retrieve top URLs by clicks
128
+ * [~~getClicksCountDeprecated~~](docs/sdks/clicks/README.md#getclickscountdeprecated) - Retrieve the total clicks count :warning: **Deprecated** Use `count` instead.
92
129
 
93
130
  ### [workspaces](docs/sdks/workspaces/README.md)
94
131
 
@@ -296,7 +333,7 @@ const httpClient = new HTTPClient({
296
333
 
297
334
  httpClient.addHook("beforeRequest", (request) => {
298
335
  const nextRequest = new Request(request, {
299
- signal: request.signal || AbortSignal.timeout(5000);
336
+ signal: request.signal || AbortSignal.timeout(5000)
300
337
  });
301
338
 
302
339
  nextRequest.headers.set("x-custom-header", "custom value");
package/docs/sdks/analytics/README.md CHANGED
@@ -3,71 +3,21 @@
3
3
 
4
4
  ### Available Operations
5
5
 
6
- * [clicks](#clicks) - Retrieve clicks analytics
7
- * [timeseries](#timeseries) - Retrieve timeseries analytics
8
- * [countries](#countries) - Retrieve country analytics
9
- * [cities](#cities) - Retrieve city analytics
10
- * [devices](#devices) - Retrieve device analytics
11
- * [browsers](#browsers) - Retrieve browser analytics
12
- * [os](#os) - Retrieve OS analytics
13
- * [referers](#referers) - Retrieve referer analytics
14
- * [topLinks](#toplinks) - Retrieve top links
15
- * [topUrls](#topurls) - Retrieve top URLs
6
+ * [~~timeseries~~](#timeseries) - Retrieve timeseries click analytics :warning: **Deprecated** Use `timeseries` instead.
7
+ * [~~country~~](#country) - Retrieve top countries by clicks :warning: **Deprecated** Use `countries` instead.
8
+ * [~~city~~](#city) - Retrieve top cities by clicks :warning: **Deprecated** Use `cities` instead.
9
+ * [~~device~~](#device) - Retrieve top devices by clicks :warning: **Deprecated** Use `devices` instead.
10
+ * [~~browser~~](#browser) - Retrieve top browsers by clicks :warning: **Deprecated** Use `browsers` instead.
11
+ * [~~os~~](#os) - Retrieve top OS by clicks :warning: **Deprecated** Use `os` instead.
12
+ * [~~referer~~](#referer) - Retrieve top referers by clicks :warning: **Deprecated** Use `referers` instead.
13
+ * [~~topLinks~~](#toplinks) - Retrieve top links by clicks :warning: **Deprecated** Use `topLinks` instead.
14
+ * [~~topUrls~~](#topurls) - Retrieve top URLs by clicks :warning: **Deprecated** Use `topUrls` instead.
16
15
 
17
- ## clicks
16
+ ## ~~timeseries~~
18
17
 
19
- Retrieve the number of clicks for a link, a domain, or the authenticated workspace.
18
+ Retrieve timeseries click analytics for a link, a domain, or the authenticated workspace over a period of time.
20
19
 
21
- ### Example Usage
22
-
23
- ```typescript
24
- import { Dub } from "dub";
25
-
26
- const dub = new Dub({
27
- token: "DUB_API_KEY",
28
- workspaceId: "<value>",
29
- });
30
-
31
- async function run() {
32
- const result = await dub.analytics.clicks({});
33
-
34
- // Handle the result
35
- console.log(result)
36
- }
37
-
38
- run();
39
- ```
40
-
41
- ### Parameters
42
-
43
- | Parameter | Type | Required | Description |
44
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
45
- | `request` | [operations.GetClicksAnalyticsRequest](../../models/operations/getclicksanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
46
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
47
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
48
-
49
-
50
- ### Response
51
-
52
- **Promise<[number](../../models/.md)>**
53
- ### Errors
54
-
55
- | Error Object | Status Code | Content Type |
56
- | -------------------------- | -------------------------- | -------------------------- |
57
- | errors.BadRequest | 400 | application/json |
58
- | errors.Unauthorized | 401 | application/json |
59
- | errors.Forbidden | 403 | application/json |
60
- | errors.NotFound | 404 | application/json |
61
- | errors.Conflict | 409 | application/json |
62
- | errors.InviteExpired | 410 | application/json |
63
- | errors.UnprocessableEntity | 422 | application/json |
64
- | errors.RateLimitExceeded | 429 | application/json |
65
- | errors.InternalServerError | 500 | application/json |
66
- | errors.SDKError | 4xx-5xx | */* |
67
-
68
- ## timeseries
69
-
70
- Retrieve the number of clicks for a link, a domain, or the authenticated workspace over a period of time.
20
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.timeseries instead.. Use `timeseries` instead.
71
21
 
72
22
  ### Example Usage
73
23
 
@@ -93,14 +43,14 @@ run();
93
43
 
94
44
  | Parameter | Type | Required | Description |
95
45
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
96
- | `request` | [operations.GetTimeseriesAnalyticsRequest](../../models/operations/gettimeseriesanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
46
+ | `request` | [operations.GetTimeseriesByClicksDeprecatedRequest](../../models/operations/gettimeseriesbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
97
47
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
98
48
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
99
49
 
100
50
 
101
51
  ### Response
102
52
 
103
- **Promise<[operations.ResponseBody[]](../../models/.md)>**
53
+ **Promise<[operations.GetTimeseriesByClicksDeprecatedResponseBody[]](../../models/.md)>**
104
54
  ### Errors
105
55
 
106
56
  | Error Object | Status Code | Content Type |
@@ -116,10 +66,12 @@ run();
116
66
  | errors.InternalServerError | 500 | application/json |
117
67
  | errors.SDKError | 4xx-5xx | */* |
118
68
 
119
- ## countries
69
+ ## ~~country~~
120
70
 
121
71
  Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
122
72
 
73
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.countries instead.. Use `countries` instead.
74
+
123
75
  ### Example Usage
124
76
 
125
77
  ```typescript
@@ -131,7 +83,7 @@ const dub = new Dub({
131
83
  });
132
84
 
133
85
  async function run() {
134
- const result = await dub.analytics.countries({});
86
+ const result = await dub.analytics.country({});
135
87
 
136
88
  // Handle the result
137
89
  console.log(result)
@@ -144,14 +96,14 @@ run();
144
96
 
145
97
  | Parameter | Type | Required | Description |
146
98
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
147
- | `request` | [operations.GetCountryAnalyticsRequest](../../models/operations/getcountryanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
99
+ | `request` | [operations.GetCountriesByClicksDeprecatedRequest](../../models/operations/getcountriesbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
148
100
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
149
101
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
150
102
 
151
103
 
152
104
  ### Response
153
105
 
154
- **Promise<[operations.GetCountryAnalyticsResponseBody[]](../../models/.md)>**
106
+ **Promise<[operations.GetCountriesByClicksDeprecatedResponseBody[]](../../models/.md)>**
155
107
  ### Errors
156
108
 
157
109
  | Error Object | Status Code | Content Type |
@@ -167,10 +119,12 @@ run();
167
119
  | errors.InternalServerError | 500 | application/json |
168
120
  | errors.SDKError | 4xx-5xx | */* |
169
121
 
170
- ## cities
122
+ ## ~~city~~
171
123
 
172
124
  Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
173
125
 
126
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.cities instead.. Use `cities` instead.
127
+
174
128
  ### Example Usage
175
129
 
176
130
  ```typescript
@@ -182,7 +136,7 @@ const dub = new Dub({
182
136
  });
183
137
 
184
138
  async function run() {
185
- const result = await dub.analytics.cities({});
139
+ const result = await dub.analytics.city({});
186
140
 
187
141
  // Handle the result
188
142
  console.log(result)
@@ -195,14 +149,14 @@ run();
195
149
 
196
150
  | Parameter | Type | Required | Description |
197
151
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
198
- | `request` | [operations.GetCityAnalyticsRequest](../../models/operations/getcityanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
152
+ | `request` | [operations.GetCitiesByClicksDeprecatedRequest](../../models/operations/getcitiesbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
199
153
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
200
154
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
201
155
 
202
156
 
203
157
  ### Response
204
158
 
205
- **Promise<[operations.GetCityAnalyticsResponseBody[]](../../models/.md)>**
159
+ **Promise<[operations.GetCitiesByClicksDeprecatedResponseBody[]](../../models/.md)>**
206
160
  ### Errors
207
161
 
208
162
  | Error Object | Status Code | Content Type |
@@ -218,10 +172,12 @@ run();
218
172
  | errors.InternalServerError | 500 | application/json |
219
173
  | errors.SDKError | 4xx-5xx | */* |
220
174
 
221
- ## devices
175
+ ## ~~device~~
222
176
 
223
177
  Retrieve the top devices by number of clicks for a link, a domain, or the authenticated workspace.
224
178
 
179
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.devices instead.. Use `devices` instead.
180
+
225
181
  ### Example Usage
226
182
 
227
183
  ```typescript
@@ -233,7 +189,7 @@ const dub = new Dub({
233
189
  });
234
190
 
235
191
  async function run() {
236
- const result = await dub.analytics.devices({});
192
+ const result = await dub.analytics.device({});
237
193
 
238
194
  // Handle the result
239
195
  console.log(result)
@@ -246,14 +202,14 @@ run();
246
202
 
247
203
  | Parameter | Type | Required | Description |
248
204
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
249
- | `request` | [operations.GetDeviceAnalyticsRequest](../../models/operations/getdeviceanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
205
+ | `request` | [operations.GetDevicesByClicksDeprecatedRequest](../../models/operations/getdevicesbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
250
206
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
251
207
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
252
208
 
253
209
 
254
210
  ### Response
255
211
 
256
- **Promise<[operations.GetDeviceAnalyticsResponseBody[]](../../models/.md)>**
212
+ **Promise<[operations.GetDevicesByClicksDeprecatedResponseBody[]](../../models/.md)>**
257
213
  ### Errors
258
214
 
259
215
  | Error Object | Status Code | Content Type |
@@ -269,10 +225,12 @@ run();
269
225
  | errors.InternalServerError | 500 | application/json |
270
226
  | errors.SDKError | 4xx-5xx | */* |
271
227
 
272
- ## browsers
228
+ ## ~~browser~~
273
229
 
274
230
  Retrieve the top browsers by number of clicks for a link, a domain, or the authenticated workspace.
275
231
 
232
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.browsers instead.. Use `browsers` instead.
233
+
276
234
  ### Example Usage
277
235
 
278
236
  ```typescript
@@ -284,7 +242,7 @@ const dub = new Dub({
284
242
  });
285
243
 
286
244
  async function run() {
287
- const result = await dub.analytics.browsers({});
245
+ const result = await dub.analytics.browser({});
288
246
 
289
247
  // Handle the result
290
248
  console.log(result)
@@ -297,14 +255,14 @@ run();
297
255
 
298
256
  | Parameter | Type | Required | Description |
299
257
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
300
- | `request` | [operations.GetBrowserAnalyticsRequest](../../models/operations/getbrowseranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
258
+ | `request` | [operations.GetBrowsersByClicksDeprecatedRequest](../../models/operations/getbrowsersbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
301
259
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
302
260
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
303
261
 
304
262
 
305
263
  ### Response
306
264
 
307
- **Promise<[operations.GetBrowserAnalyticsResponseBody[]](../../models/.md)>**
265
+ **Promise<[operations.GetBrowsersByClicksDeprecatedResponseBody[]](../../models/.md)>**
308
266
  ### Errors
309
267
 
310
268
  | Error Object | Status Code | Content Type |
@@ -320,10 +278,12 @@ run();
320
278
  | errors.InternalServerError | 500 | application/json |
321
279
  | errors.SDKError | 4xx-5xx | */* |
322
280
 
323
- ## os
281
+ ## ~~os~~
324
282
 
325
283
  Retrieve the top OS by number of clicks for a link, a domain, or the authenticated workspace.
326
284
 
285
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.os instead.. Use `os` instead.
286
+
327
287
  ### Example Usage
328
288
 
329
289
  ```typescript
@@ -348,14 +308,14 @@ run();
348
308
 
349
309
  | Parameter | Type | Required | Description |
350
310
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
351
- | `request` | [operations.GetOSAnalyticsRequest](../../models/operations/getosanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
311
+ | `request` | [operations.GetOSByClicksDeprecatedRequest](../../models/operations/getosbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
352
312
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
353
313
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
354
314
 
355
315
 
356
316
  ### Response
357
317
 
358
- **Promise<[operations.GetOSAnalyticsResponseBody[]](../../models/.md)>**
318
+ **Promise<[operations.GetOSByClicksDeprecatedResponseBody[]](../../models/.md)>**
359
319
  ### Errors
360
320
 
361
321
  | Error Object | Status Code | Content Type |
@@ -371,10 +331,12 @@ run();
371
331
  | errors.InternalServerError | 500 | application/json |
372
332
  | errors.SDKError | 4xx-5xx | */* |
373
333
 
374
- ## referers
334
+ ## ~~referer~~
375
335
 
376
336
  Retrieve the top referers by number of clicks for a link, a domain, or the authenticated workspace.
377
337
 
338
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.referers instead.. Use `referers` instead.
339
+
378
340
  ### Example Usage
379
341
 
380
342
  ```typescript
@@ -386,7 +348,7 @@ const dub = new Dub({
386
348
  });
387
349
 
388
350
  async function run() {
389
- const result = await dub.analytics.referers({});
351
+ const result = await dub.analytics.referer({});
390
352
 
391
353
  // Handle the result
392
354
  console.log(result)
@@ -399,14 +361,14 @@ run();
399
361
 
400
362
  | Parameter | Type | Required | Description |
401
363
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
402
- | `request` | [operations.GetRefererAnalyticsRequest](../../models/operations/getrefereranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
364
+ | `request` | [operations.GetReferersByClicksDeprecatedRequest](../../models/operations/getreferersbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
403
365
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
404
366
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
405
367
 
406
368
 
407
369
  ### Response
408
370
 
409
- **Promise<[operations.GetRefererAnalyticsResponseBody[]](../../models/.md)>**
371
+ **Promise<[operations.GetReferersByClicksDeprecatedResponseBody[]](../../models/.md)>**
410
372
  ### Errors
411
373
 
412
374
  | Error Object | Status Code | Content Type |
@@ -422,10 +384,12 @@ run();
422
384
  | errors.InternalServerError | 500 | application/json |
423
385
  | errors.SDKError | 4xx-5xx | */* |
424
386
 
425
- ## topLinks
387
+ ## ~~topLinks~~
426
388
 
427
389
  Retrieve the top links by number of clicks for a domain or the authenticated workspace.
428
390
 
391
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.topLinks instead.. Use `topLinks` instead.
392
+
429
393
  ### Example Usage
430
394
 
431
395
  ```typescript
@@ -450,14 +414,14 @@ run();
450
414
 
451
415
  | Parameter | Type | Required | Description |
452
416
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
453
- | `request` | [operations.GetTopLinksRequest](../../models/operations/gettoplinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
417
+ | `request` | [operations.GetTopLinksByClicksDeprecatedRequest](../../models/operations/gettoplinksbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
454
418
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
455
419
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
456
420
 
457
421
 
458
422
  ### Response
459
423
 
460
- **Promise<[operations.GetTopLinksResponseBody[]](../../models/.md)>**
424
+ **Promise<[operations.GetTopLinksByClicksDeprecatedResponseBody[]](../../models/.md)>**
461
425
  ### Errors
462
426
 
463
427
  | Error Object | Status Code | Content Type |
@@ -473,10 +437,12 @@ run();
473
437
  | errors.InternalServerError | 500 | application/json |
474
438
  | errors.SDKError | 4xx-5xx | */* |
475
439
 
476
- ## topUrls
440
+ ## ~~topUrls~~
477
441
 
478
442
  Retrieve the top URLs by number of clicks for a given short link.
479
443
 
444
+ > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.topUrls instead.. Use `topUrls` instead.
445
+
480
446
  ### Example Usage
481
447
 
482
448
  ```typescript
@@ -501,14 +467,14 @@ run();
501
467
 
502
468
  | Parameter | Type | Required | Description |
503
469
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
504
- | `request` | [operations.GetTopURLsRequest](../../models/operations/gettopurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
470
+ | `request` | [operations.GetTopURLsByClicksDeprecatedRequest](../../models/operations/gettopurlsbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
505
471
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
506
472
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
507
473
 
508
474
 
509
475
  ### Response
510
476
 
511
- **Promise<[operations.GetTopURLsResponseBody[]](../../models/.md)>**
477
+ **Promise<[operations.GetTopURLsByClicksDeprecatedResponseBody[]](../../models/.md)>**
512
478
  ### Errors
513
479
 
514
480
  | Error Object | Status Code | Content Type |