dub 0.10.0 → 0.20.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 (540) hide show
  1. package/.github/workflows/sdk_generation.yaml +26 -0
  2. package/.github/workflows/sdk_publish.yaml +15 -0
  3. package/.speakeasy/gen.lock +205 -0
  4. package/.speakeasy/gen.yaml +37 -0
  5. package/.speakeasy/workflow.yaml +12 -0
  6. package/README.md +292 -182
  7. package/docs/sdks/analytics/README.md +535 -0
  8. package/docs/sdks/dub/README.md +9 -0
  9. package/docs/sdks/links/README.md +415 -0
  10. package/docs/sdks/qrcodes/README.md +58 -0
  11. package/docs/sdks/tags/README.md +113 -0
  12. package/docs/sdks/workspaces/README.md +168 -0
  13. package/hooks/hooks.d.ts +20 -0
  14. package/hooks/hooks.d.ts.map +1 -0
  15. package/hooks/hooks.js +55 -0
  16. package/hooks/hooks.js.map +1 -0
  17. package/hooks/index.d.ts +3 -0
  18. package/hooks/index.d.ts.map +1 -0
  19. package/{_shims/auto/runtime-bun.js → hooks/index.js} +6 -5
  20. package/hooks/index.js.map +1 -0
  21. package/hooks/types.d.ts +59 -0
  22. package/hooks/types.d.ts.map +1 -0
  23. package/hooks/types.js +6 -0
  24. package/hooks/types.js.map +1 -0
  25. package/index.d.ts +4 -125
  26. package/index.d.ts.map +1 -1
  27. package/index.js +10 -103
  28. package/index.js.map +1 -1
  29. package/lib/base64.d.ts +10 -0
  30. package/lib/base64.d.ts.map +1 -0
  31. package/lib/base64.js +61 -0
  32. package/lib/base64.js.map +1 -0
  33. package/lib/config.d.ts +39 -0
  34. package/lib/config.d.ts.map +1 -0
  35. package/lib/config.js +39 -0
  36. package/lib/config.js.map +1 -0
  37. package/lib/encodings.d.ts +39 -0
  38. package/lib/encodings.d.ts.map +1 -0
  39. package/lib/encodings.js +311 -0
  40. package/lib/encodings.js.map +1 -0
  41. package/lib/http.d.ts +46 -0
  42. package/lib/http.d.ts.map +1 -0
  43. package/lib/http.js +143 -0
  44. package/lib/http.js.map +1 -0
  45. package/lib/retries.d.ts +18 -0
  46. package/lib/retries.d.ts.map +1 -0
  47. package/lib/retries.js +157 -0
  48. package/lib/retries.js.map +1 -0
  49. package/lib/schemas.d.ts +7 -0
  50. package/lib/schemas.d.ts.map +1 -0
  51. package/{shims/web.js → lib/schemas.js} +24 -6
  52. package/lib/schemas.js.map +1 -0
  53. package/lib/sdks.d.ts +39 -0
  54. package/lib/sdks.d.ts.map +1 -0
  55. package/lib/sdks.js +98 -0
  56. package/lib/sdks.js.map +1 -0
  57. package/lib/security.d.ts +57 -0
  58. package/lib/security.d.ts.map +1 -0
  59. package/lib/security.js +115 -0
  60. package/lib/security.js.map +1 -0
  61. package/lib/url.d.ts +4 -0
  62. package/lib/url.d.ts.map +1 -0
  63. package/lib/url.js +26 -0
  64. package/lib/url.js.map +1 -0
  65. package/models/components/index.d.ts +5 -0
  66. package/models/components/index.d.ts.map +1 -0
  67. package/{_shims/auto/runtime-node.js → models/components/index.js} +8 -5
  68. package/models/components/index.js.map +1 -0
  69. package/models/components/linkschema.d.ts +222 -0
  70. package/models/components/linkschema.d.ts.map +1 -0
  71. package/models/components/linkschema.js +189 -0
  72. package/models/components/linkschema.js.map +1 -0
  73. package/models/components/security.d.ts +16 -0
  74. package/models/components/security.d.ts.map +1 -0
  75. package/models/components/security.js +53 -0
  76. package/models/components/security.js.map +1 -0
  77. package/models/components/tagschema.d.ts +45 -0
  78. package/models/components/tagschema.d.ts.map +1 -0
  79. package/models/components/tagschema.js +76 -0
  80. package/models/components/tagschema.js.map +1 -0
  81. package/models/components/workspaceschema.d.ts +178 -0
  82. package/models/components/workspaceschema.d.ts.map +1 -0
  83. package/models/components/workspaceschema.js +190 -0
  84. package/models/components/workspaceschema.js.map +1 -0
  85. package/models/errors/badrequest.d.ts +65 -0
  86. package/models/errors/badrequest.d.ts.map +1 -0
  87. package/models/errors/badrequest.js +111 -0
  88. package/models/errors/badrequest.js.map +1 -0
  89. package/models/errors/conflict.d.ts +65 -0
  90. package/models/errors/conflict.d.ts.map +1 -0
  91. package/models/errors/conflict.js +111 -0
  92. package/models/errors/conflict.js.map +1 -0
  93. package/models/errors/forbidden.d.ts +65 -0
  94. package/models/errors/forbidden.d.ts.map +1 -0
  95. package/models/errors/forbidden.js +111 -0
  96. package/models/errors/forbidden.js.map +1 -0
  97. package/models/errors/index.d.ts +12 -0
  98. package/models/errors/index.d.ts.map +1 -0
  99. package/{_shims/auto/types-node.js → models/errors/index.js} +15 -5
  100. package/models/errors/index.js.map +1 -0
  101. package/models/errors/internalservererror.d.ts +65 -0
  102. package/models/errors/internalservererror.d.ts.map +1 -0
  103. package/models/errors/internalservererror.js +111 -0
  104. package/models/errors/internalservererror.js.map +1 -0
  105. package/models/errors/inviteexpired.d.ts +65 -0
  106. package/models/errors/inviteexpired.d.ts.map +1 -0
  107. package/models/errors/inviteexpired.js +111 -0
  108. package/models/errors/inviteexpired.js.map +1 -0
  109. package/models/errors/notfound.d.ts +65 -0
  110. package/models/errors/notfound.d.ts.map +1 -0
  111. package/models/errors/notfound.js +111 -0
  112. package/models/errors/notfound.js.map +1 -0
  113. package/models/errors/ratelimitexceeded.d.ts +65 -0
  114. package/models/errors/ratelimitexceeded.d.ts.map +1 -0
  115. package/models/errors/ratelimitexceeded.js +111 -0
  116. package/models/errors/ratelimitexceeded.js.map +1 -0
  117. package/models/errors/sdkerror.d.ts +7 -0
  118. package/models/errors/sdkerror.d.ts.map +1 -0
  119. package/models/errors/sdkerror.js +19 -0
  120. package/models/errors/sdkerror.js.map +1 -0
  121. package/models/errors/sdkvalidationerror.d.ts +17 -0
  122. package/models/errors/sdkvalidationerror.d.ts.map +1 -0
  123. package/models/errors/sdkvalidationerror.js +107 -0
  124. package/models/errors/sdkvalidationerror.js.map +1 -0
  125. package/models/errors/unauthorized.d.ts +65 -0
  126. package/models/errors/unauthorized.d.ts.map +1 -0
  127. package/models/errors/unauthorized.js +111 -0
  128. package/models/errors/unauthorized.js.map +1 -0
  129. package/models/errors/unprocessableentity.d.ts +65 -0
  130. package/models/errors/unprocessableentity.d.ts.map +1 -0
  131. package/models/errors/unprocessableentity.js +111 -0
  132. package/models/errors/unprocessableentity.js.map +1 -0
  133. package/models/operations/bulkcreatelinks.d.ts +146 -0
  134. package/models/operations/bulkcreatelinks.d.ts.map +1 -0
  135. package/models/operations/bulkcreatelinks.js +138 -0
  136. package/models/operations/bulkcreatelinks.js.map +1 -0
  137. package/models/operations/createlink.d.ts +146 -0
  138. package/models/operations/createlink.d.ts.map +1 -0
  139. package/models/operations/createlink.js +141 -0
  140. package/models/operations/createlink.js.map +1 -0
  141. package/models/operations/createtag.d.ts +39 -0
  142. package/models/operations/createtag.d.ts.map +1 -0
  143. package/models/operations/createtag.js +72 -0
  144. package/models/operations/createtag.js.map +1 -0
  145. package/models/operations/createworkspace.d.ts +22 -0
  146. package/models/operations/createworkspace.d.ts.map +1 -0
  147. package/models/operations/createworkspace.js +61 -0
  148. package/models/operations/createworkspace.js.map +1 -0
  149. package/models/operations/deletelink.d.ts +39 -0
  150. package/models/operations/deletelink.d.ts.map +1 -0
  151. package/models/operations/deletelink.js +75 -0
  152. package/models/operations/deletelink.js.map +1 -0
  153. package/models/operations/editlink.d.ts +166 -0
  154. package/models/operations/editlink.d.ts.map +1 -0
  155. package/models/operations/editlink.js +167 -0
  156. package/models/operations/editlink.js.map +1 -0
  157. package/models/operations/getbrowseranalytics.d.ts +378 -0
  158. package/models/operations/getbrowseranalytics.d.ts.map +1 -0
  159. package/models/operations/getbrowseranalytics.js +395 -0
  160. package/models/operations/getbrowseranalytics.js.map +1 -0
  161. package/models/operations/getcityanalytics.d.ts +641 -0
  162. package/models/operations/getcityanalytics.d.ts.map +1 -0
  163. package/models/operations/getcityanalytics.js +657 -0
  164. package/models/operations/getcityanalytics.js.map +1 -0
  165. package/models/operations/getclicksanalytics.d.ts +355 -0
  166. package/models/operations/getclicksanalytics.d.ts.map +1 -0
  167. package/models/operations/getclicksanalytics.js +369 -0
  168. package/models/operations/getclicksanalytics.js.map +1 -0
  169. package/models/operations/getcountryanalytics.d.ts +635 -0
  170. package/models/operations/getcountryanalytics.d.ts.map +1 -0
  171. package/models/operations/getcountryanalytics.js +653 -0
  172. package/models/operations/getcountryanalytics.js.map +1 -0
  173. package/models/operations/getdeviceanalytics.d.ts +378 -0
  174. package/models/operations/getdeviceanalytics.d.ts.map +1 -0
  175. package/models/operations/getdeviceanalytics.js +395 -0
  176. package/models/operations/getdeviceanalytics.js.map +1 -0
  177. package/models/operations/getlinkinfo.d.ts +25 -0
  178. package/models/operations/getlinkinfo.d.ts.map +1 -0
  179. package/models/operations/getlinkinfo.js +57 -0
  180. package/models/operations/getlinkinfo.js.map +1 -0
  181. package/models/operations/getlinks.d.ts +88 -0
  182. package/models/operations/getlinks.d.ts.map +1 -0
  183. package/models/operations/getlinks.js +108 -0
  184. package/models/operations/getlinks.js.map +1 -0
  185. package/models/operations/getlinkscount.d.ts +93 -0
  186. package/models/operations/getlinkscount.d.ts.map +1 -0
  187. package/models/operations/getlinkscount.js +105 -0
  188. package/models/operations/getlinkscount.js.map +1 -0
  189. package/models/operations/getosanalytics.d.ts +378 -0
  190. package/models/operations/getosanalytics.d.ts.map +1 -0
  191. package/models/operations/getosanalytics.js +395 -0
  192. package/models/operations/getosanalytics.js.map +1 -0
  193. package/models/operations/getqrcode.d.ts +60 -0
  194. package/models/operations/getqrcode.d.ts.map +1 -0
  195. package/models/operations/getqrcode.js +85 -0
  196. package/models/operations/getqrcode.js.map +1 -0
  197. package/models/operations/getrefereranalytics.d.ts +378 -0
  198. package/models/operations/getrefereranalytics.d.ts.map +1 -0
  199. package/models/operations/getrefereranalytics.js +395 -0
  200. package/models/operations/getrefereranalytics.js.map +1 -0
  201. package/models/operations/gettags.d.ts +10 -0
  202. package/models/operations/gettags.d.ts.map +1 -0
  203. package/{shims/node.js → models/operations/gettags.js} +12 -6
  204. package/models/operations/gettags.js.map +1 -0
  205. package/models/operations/gettimeseriesanalytics.d.ts +378 -0
  206. package/models/operations/gettimeseriesanalytics.d.ts.map +1 -0
  207. package/models/operations/gettimeseriesanalytics.js +395 -0
  208. package/models/operations/gettimeseriesanalytics.js.map +1 -0
  209. package/models/operations/gettoplinks.d.ts +378 -0
  210. package/models/operations/gettoplinks.d.ts.map +1 -0
  211. package/models/operations/gettoplinks.js +395 -0
  212. package/models/operations/gettoplinks.js.map +1 -0
  213. package/models/operations/gettopurls.d.ts +378 -0
  214. package/models/operations/gettopurls.d.ts.map +1 -0
  215. package/models/operations/gettopurls.js +395 -0
  216. package/models/operations/gettopurls.js.map +1 -0
  217. package/models/operations/getworkspace.d.ts +19 -0
  218. package/models/operations/getworkspace.d.ts.map +1 -0
  219. package/models/operations/getworkspace.js +53 -0
  220. package/models/operations/getworkspace.js.map +1 -0
  221. package/models/operations/index.d.ts +23 -0
  222. package/models/operations/index.d.ts.map +1 -0
  223. package/models/operations/index.js +42 -0
  224. package/models/operations/index.js.map +1 -0
  225. package/package.json +25 -98
  226. package/sdk/analytics.d.ts +78 -0
  227. package/sdk/analytics.d.ts.map +1 -0
  228. package/sdk/analytics.js +2044 -0
  229. package/sdk/analytics.js.map +1 -0
  230. package/sdk/index.d.ts +2 -0
  231. package/sdk/index.d.ts.map +1 -0
  232. package/{_shims/auto/runtime.js → sdk/index.js} +5 -5
  233. package/sdk/index.js.map +1 -0
  234. package/sdk/links.d.ts +58 -0
  235. package/sdk/links.d.ts.map +1 -0
  236. package/sdk/links.js +1309 -0
  237. package/sdk/links.js.map +1 -0
  238. package/sdk/qrcodes.d.ts +21 -0
  239. package/sdk/qrcodes.d.ts.map +1 -0
  240. package/sdk/qrcodes.js +249 -0
  241. package/sdk/qrcodes.js.map +1 -0
  242. package/sdk/sdk.d.ts +22 -0
  243. package/sdk/sdk.d.ts.map +1 -0
  244. package/sdk/sdk.js +59 -0
  245. package/sdk/sdk.js.map +1 -0
  246. package/sdk/tags.d.ts +23 -0
  247. package/sdk/tags.d.ts.map +1 -0
  248. package/sdk/tags.js +401 -0
  249. package/sdk/tags.js.map +1 -0
  250. package/sdk/workspaces.d.ts +30 -0
  251. package/sdk/workspaces.d.ts.map +1 -0
  252. package/sdk/workspaces.js +556 -0
  253. package/sdk/workspaces.js.map +1 -0
  254. package/src/hooks/hooks.ts +81 -0
  255. package/src/hooks/index.ts +6 -0
  256. package/src/hooks/types.ts +74 -0
  257. package/src/index.ts +8 -209
  258. package/src/lib/base64.ts +37 -0
  259. package/src/lib/config.ts +70 -0
  260. package/src/lib/encodings.ts +384 -0
  261. package/src/lib/http.ts +215 -0
  262. package/src/lib/retries.ts +226 -0
  263. package/src/lib/schemas.ts +22 -0
  264. package/src/lib/sdks.ts +139 -0
  265. package/src/lib/security.ts +180 -0
  266. package/src/lib/url.ts +31 -0
  267. package/src/models/components/index.ts +8 -0
  268. package/src/models/components/linkschema.ts +383 -0
  269. package/src/models/components/security.ts +40 -0
  270. package/src/models/components/tagschema.ts +79 -0
  271. package/src/models/components/workspaceschema.ts +316 -0
  272. package/src/models/errors/badrequest.ts +140 -0
  273. package/src/models/errors/conflict.ts +140 -0
  274. package/src/models/errors/forbidden.ts +140 -0
  275. package/src/models/errors/index.ts +15 -0
  276. package/src/models/errors/internalservererror.ts +140 -0
  277. package/src/models/errors/inviteexpired.ts +140 -0
  278. package/src/models/errors/notfound.ts +140 -0
  279. package/src/models/errors/ratelimitexceeded.ts +140 -0
  280. package/src/models/errors/sdkerror.ts +22 -0
  281. package/src/models/errors/sdkvalidationerror.ts +95 -0
  282. package/src/models/errors/unauthorized.ts +140 -0
  283. package/src/models/errors/unprocessableentity.ts +140 -0
  284. package/src/models/operations/bulkcreatelinks.ts +254 -0
  285. package/src/models/operations/createlink.ts +255 -0
  286. package/src/models/operations/createtag.ts +69 -0
  287. package/src/models/operations/createworkspace.ts +54 -0
  288. package/src/models/operations/deletelink.ts +84 -0
  289. package/src/models/operations/editlink.ts +300 -0
  290. package/src/models/operations/getbrowseranalytics.ts +484 -0
  291. package/src/models/operations/getcityanalytics.ts +744 -0
  292. package/src/models/operations/getclicksanalytics.ts +427 -0
  293. package/src/models/operations/getcountryanalytics.ts +743 -0
  294. package/src/models/operations/getdeviceanalytics.ts +480 -0
  295. package/src/models/operations/getlinkinfo.ts +53 -0
  296. package/src/models/operations/getlinks.ts +155 -0
  297. package/src/models/operations/getlinkscount.ts +157 -0
  298. package/src/models/operations/getosanalytics.ts +475 -0
  299. package/src/models/operations/getqrcode.ts +106 -0
  300. package/src/models/operations/getrefereranalytics.ts +484 -0
  301. package/src/models/operations/gettags.ts +18 -0
  302. package/src/models/operations/gettimeseriesanalytics.ts +476 -0
  303. package/src/models/operations/gettoplinks.ts +475 -0
  304. package/src/models/operations/gettopurls.ts +475 -0
  305. package/src/models/operations/getworkspace.ts +43 -0
  306. package/src/models/operations/index.ts +26 -0
  307. package/src/sdk/analytics.ts +2493 -0
  308. package/src/sdk/index.ts +5 -0
  309. package/src/sdk/links.ts +1617 -0
  310. package/src/sdk/qrcodes.ts +276 -0
  311. package/src/sdk/sdk.ts +66 -0
  312. package/src/sdk/tags.ts +470 -0
  313. package/src/sdk/workspaces.ts +670 -0
  314. package/src/types/blobs.ts +30 -0
  315. package/src/types/index.ts +8 -0
  316. package/src/types/operations.ts +25 -0
  317. package/src/types/rfcdate.ts +54 -0
  318. package/types/blobs.d.ts +4 -0
  319. package/types/blobs.d.ts.map +1 -0
  320. package/{resources/projects/projects.js → types/blobs.js} +23 -24
  321. package/types/blobs.js.map +1 -0
  322. package/types/index.d.ts +5 -0
  323. package/types/index.d.ts.map +1 -0
  324. package/types/index.js +14 -0
  325. package/types/index.js.map +1 -0
  326. package/types/operations.d.ts +13 -0
  327. package/types/operations.d.ts.map +1 -0
  328. package/types/operations.js +19 -0
  329. package/types/operations.js.map +1 -0
  330. package/types/rfcdate.d.ts +21 -0
  331. package/types/rfcdate.d.ts.map +1 -0
  332. package/types/rfcdate.js +46 -0
  333. package/types/rfcdate.js.map +1 -0
  334. package/CHANGELOG.md +0 -116
  335. package/LICENSE +0 -201
  336. package/_shims/MultipartBody.d.ts +0 -9
  337. package/_shims/MultipartBody.d.ts.map +0 -1
  338. package/_shims/MultipartBody.js +0 -16
  339. package/_shims/MultipartBody.js.map +0 -1
  340. package/_shims/MultipartBody.mjs +0 -12
  341. package/_shims/MultipartBody.mjs.map +0 -1
  342. package/_shims/README.md +0 -46
  343. package/_shims/auto/runtime-bun.d.ts +0 -5
  344. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  345. package/_shims/auto/runtime-bun.js.map +0 -1
  346. package/_shims/auto/runtime-bun.mjs +0 -2
  347. package/_shims/auto/runtime-bun.mjs.map +0 -1
  348. package/_shims/auto/runtime-node.d.ts +0 -5
  349. package/_shims/auto/runtime-node.d.ts.map +0 -1
  350. package/_shims/auto/runtime-node.js.map +0 -1
  351. package/_shims/auto/runtime-node.mjs +0 -2
  352. package/_shims/auto/runtime-node.mjs.map +0 -1
  353. package/_shims/auto/runtime.d.ts +0 -5
  354. package/_shims/auto/runtime.d.ts.map +0 -1
  355. package/_shims/auto/runtime.js.map +0 -1
  356. package/_shims/auto/runtime.mjs +0 -2
  357. package/_shims/auto/runtime.mjs.map +0 -1
  358. package/_shims/auto/types-node.d.ts +0 -5
  359. package/_shims/auto/types-node.d.ts.map +0 -1
  360. package/_shims/auto/types-node.js.map +0 -1
  361. package/_shims/auto/types-node.mjs +0 -2
  362. package/_shims/auto/types-node.mjs.map +0 -1
  363. package/_shims/auto/types.d.ts +0 -101
  364. package/_shims/auto/types.js +0 -3
  365. package/_shims/auto/types.mjs +0 -3
  366. package/_shims/bun-runtime.d.ts +0 -6
  367. package/_shims/bun-runtime.d.ts.map +0 -1
  368. package/_shims/bun-runtime.js +0 -14
  369. package/_shims/bun-runtime.js.map +0 -1
  370. package/_shims/bun-runtime.mjs +0 -10
  371. package/_shims/bun-runtime.mjs.map +0 -1
  372. package/_shims/index.d.ts +0 -81
  373. package/_shims/index.js +0 -13
  374. package/_shims/index.mjs +0 -7
  375. package/_shims/manual-types.d.ts +0 -12
  376. package/_shims/manual-types.js +0 -3
  377. package/_shims/manual-types.mjs +0 -3
  378. package/_shims/node-runtime.d.ts +0 -3
  379. package/_shims/node-runtime.d.ts.map +0 -1
  380. package/_shims/node-runtime.js +0 -90
  381. package/_shims/node-runtime.js.map +0 -1
  382. package/_shims/node-runtime.mjs +0 -56
  383. package/_shims/node-runtime.mjs.map +0 -1
  384. package/_shims/node-types.d.ts +0 -42
  385. package/_shims/node-types.js +0 -3
  386. package/_shims/node-types.mjs +0 -3
  387. package/_shims/registry.d.ts +0 -37
  388. package/_shims/registry.d.ts.map +0 -1
  389. package/_shims/registry.js +0 -41
  390. package/_shims/registry.js.map +0 -1
  391. package/_shims/registry.mjs +0 -37
  392. package/_shims/registry.mjs.map +0 -1
  393. package/_shims/web-runtime.d.ts +0 -5
  394. package/_shims/web-runtime.d.ts.map +0 -1
  395. package/_shims/web-runtime.js +0 -78
  396. package/_shims/web-runtime.js.map +0 -1
  397. package/_shims/web-runtime.mjs +0 -71
  398. package/_shims/web-runtime.mjs.map +0 -1
  399. package/_shims/web-types.d.ts +0 -83
  400. package/_shims/web-types.js +0 -3
  401. package/_shims/web-types.mjs +0 -3
  402. package/core.d.ts +0 -237
  403. package/core.d.ts.map +0 -1
  404. package/core.js +0 -868
  405. package/core.js.map +0 -1
  406. package/core.mjs +0 -837
  407. package/core.mjs.map +0 -1
  408. package/error.d.ts +0 -53
  409. package/error.d.ts.map +0 -1
  410. package/error.js +0 -143
  411. package/error.js.map +0 -1
  412. package/error.mjs +0 -127
  413. package/error.mjs.map +0 -1
  414. package/index.d.mts +0 -127
  415. package/index.mjs +0 -90
  416. package/index.mjs.map +0 -1
  417. package/resource.d.ts +0 -6
  418. package/resource.d.ts.map +0 -1
  419. package/resource.js +0 -11
  420. package/resource.js.map +0 -1
  421. package/resource.mjs +0 -7
  422. package/resource.mjs.map +0 -1
  423. package/resources/index.d.ts +0 -4
  424. package/resources/index.d.ts.map +0 -1
  425. package/resources/index.js +0 -11
  426. package/resources/index.js.map +0 -1
  427. package/resources/index.mjs +0 -5
  428. package/resources/index.mjs.map +0 -1
  429. package/resources/links/bulk.d.ts +0 -274
  430. package/resources/links/bulk.d.ts.map +0 -1
  431. package/resources/links/bulk.js +0 -18
  432. package/resources/links/bulk.js.map +0 -1
  433. package/resources/links/bulk.mjs +0 -14
  434. package/resources/links/bulk.mjs.map +0 -1
  435. package/resources/links/index.d.ts +0 -4
  436. package/resources/links/index.d.ts.map +0 -1
  437. package/resources/links/index.js +0 -11
  438. package/resources/links/index.js.map +0 -1
  439. package/resources/links/index.mjs +0 -5
  440. package/resources/links/index.mjs.map +0 -1
  441. package/resources/links/info.d.ts +0 -186
  442. package/resources/links/info.d.ts.map +0 -1
  443. package/resources/links/info.js +0 -18
  444. package/resources/links/info.js.map +0 -1
  445. package/resources/links/info.mjs +0 -14
  446. package/resources/links/info.mjs.map +0 -1
  447. package/resources/links/links.d.ts +0 -916
  448. package/resources/links/links.d.ts.map +0 -1
  449. package/resources/links/links.js +0 -72
  450. package/resources/links/links.js.map +0 -1
  451. package/resources/links/links.mjs +0 -45
  452. package/resources/links/links.mjs.map +0 -1
  453. package/resources/projects/index.d.ts +0 -3
  454. package/resources/projects/index.d.ts.map +0 -1
  455. package/resources/projects/index.js +0 -9
  456. package/resources/projects/index.js.map +0 -1
  457. package/resources/projects/index.mjs +0 -4
  458. package/resources/projects/index.mjs.map +0 -1
  459. package/resources/projects/projects.d.ts +0 -200
  460. package/resources/projects/projects.d.ts.map +0 -1
  461. package/resources/projects/projects.js.map +0 -1
  462. package/resources/projects/projects.mjs +0 -26
  463. package/resources/projects/projects.mjs.map +0 -1
  464. package/resources/projects/tags.d.ts +0 -4
  465. package/resources/projects/tags.d.ts.map +0 -1
  466. package/resources/projects/tags.js +0 -9
  467. package/resources/projects/tags.js.map +0 -1
  468. package/resources/projects/tags.mjs +0 -5
  469. package/resources/projects/tags.mjs.map +0 -1
  470. package/resources/qr.d.ts +0 -45
  471. package/resources/qr.d.ts.map +0 -1
  472. package/resources/qr.js +0 -18
  473. package/resources/qr.js.map +0 -1
  474. package/resources/qr.mjs +0 -14
  475. package/resources/qr.mjs.map +0 -1
  476. package/shims/node.d.ts +0 -29
  477. package/shims/node.d.ts.map +0 -1
  478. package/shims/node.js.map +0 -1
  479. package/shims/node.mjs +0 -5
  480. package/shims/node.mjs.map +0 -1
  481. package/shims/web.d.ts +0 -26
  482. package/shims/web.d.ts.map +0 -1
  483. package/shims/web.js.map +0 -1
  484. package/shims/web.mjs +0 -5
  485. package/shims/web.mjs.map +0 -1
  486. package/src/_shims/MultipartBody.ts +0 -9
  487. package/src/_shims/README.md +0 -46
  488. package/src/_shims/auto/runtime-bun.ts +0 -4
  489. package/src/_shims/auto/runtime-node.ts +0 -4
  490. package/src/_shims/auto/runtime.ts +0 -4
  491. package/src/_shims/auto/types-node.ts +0 -4
  492. package/src/_shims/auto/types.d.ts +0 -101
  493. package/src/_shims/auto/types.js +0 -3
  494. package/src/_shims/auto/types.mjs +0 -3
  495. package/src/_shims/bun-runtime.ts +0 -14
  496. package/src/_shims/index.d.ts +0 -81
  497. package/src/_shims/index.js +0 -13
  498. package/src/_shims/index.mjs +0 -7
  499. package/src/_shims/manual-types.d.ts +0 -12
  500. package/src/_shims/manual-types.js +0 -3
  501. package/src/_shims/manual-types.mjs +0 -3
  502. package/src/_shims/node-runtime.ts +0 -83
  503. package/src/_shims/node-types.d.ts +0 -42
  504. package/src/_shims/node-types.js +0 -3
  505. package/src/_shims/node-types.mjs +0 -3
  506. package/src/_shims/registry.ts +0 -63
  507. package/src/_shims/web-runtime.ts +0 -103
  508. package/src/_shims/web-types.d.ts +0 -83
  509. package/src/_shims/web-types.js +0 -3
  510. package/src/_shims/web-types.mjs +0 -3
  511. package/src/core.ts +0 -1145
  512. package/src/error.ts +0 -146
  513. package/src/lib/.keep +0 -4
  514. package/src/resource.ts +0 -11
  515. package/src/resources/index.ts +0 -20
  516. package/src/resources/links/bulk.ts +0 -337
  517. package/src/resources/links/index.ts +0 -15
  518. package/src/resources/links/info.ts +0 -230
  519. package/src/resources/links/links.ts +0 -1135
  520. package/src/resources/projects/index.ts +0 -4
  521. package/src/resources/projects/projects.ts +0 -253
  522. package/src/resources/projects/tags.ts +0 -5
  523. package/src/resources/qr.ts +0 -64
  524. package/src/shims/node.ts +0 -50
  525. package/src/shims/web.ts +0 -50
  526. package/src/tsconfig.json +0 -11
  527. package/src/uploads.ts +0 -245
  528. package/src/version.ts +0 -1
  529. package/uploads.d.ts +0 -75
  530. package/uploads.d.ts.map +0 -1
  531. package/uploads.js +0 -163
  532. package/uploads.js.map +0 -1
  533. package/uploads.mjs +0 -150
  534. package/uploads.mjs.map +0 -1
  535. package/version.d.ts +0 -2
  536. package/version.d.ts.map +0 -1
  537. package/version.js +0 -5
  538. package/version.js.map +0 -1
  539. package/version.mjs +0 -2
  540. package/version.mjs.map +0 -1
@@ -0,0 +1,535 @@
1
+ # Analytics
2
+ (*analytics*)
3
+
4
+ ### Available Operations
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
16
+
17
+ ## clicks
18
+
19
+ Retrieve the number of clicks for a link, a domain, or the authenticated workspace.
20
+
21
+ ### Example Usage
22
+
23
+ ```typescript
24
+ import { Dub } from "dub";
25
+
26
+ async function run() {
27
+ const sdk = new Dub({
28
+ token: "<YOUR_BEARER_TOKEN_HERE>",
29
+ workspaceId: "<value>",
30
+ projectSlug: "<value>",
31
+ });
32
+
33
+ const result = await sdk.analytics.clicks({});
34
+
35
+ // Handle the result
36
+ console.log(result)
37
+ }
38
+
39
+ run();
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ | Parameter | Type | Required | Description |
45
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
46
+ | `request` | [operations.GetClicksAnalyticsRequest](../../models/operations/getclicksanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
47
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
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. |
49
+
50
+
51
+ ### Response
52
+
53
+ **Promise<[number](../../models/.md)>**
54
+ ### Errors
55
+
56
+ | Error Object | Status Code | Content Type |
57
+ | -------------------------- | -------------------------- | -------------------------- |
58
+ | errors.BadRequest | 400 | application/json |
59
+ | errors.Unauthorized | 401 | application/json |
60
+ | errors.Forbidden | 403 | application/json |
61
+ | errors.NotFound | 404 | application/json |
62
+ | errors.Conflict | 409 | application/json |
63
+ | errors.InviteExpired | 410 | application/json |
64
+ | errors.UnprocessableEntity | 422 | application/json |
65
+ | errors.RateLimitExceeded | 429 | application/json |
66
+ | errors.InternalServerError | 500 | application/json |
67
+ | errors.SDKError | 4xx-5xx | */* |
68
+
69
+ ## timeseries
70
+
71
+ Retrieve the number of clicks for a link, a domain, or the authenticated workspace over a period of time.
72
+
73
+ ### Example Usage
74
+
75
+ ```typescript
76
+ import { Dub } from "dub";
77
+
78
+ async function run() {
79
+ const sdk = new Dub({
80
+ token: "<YOUR_BEARER_TOKEN_HERE>",
81
+ workspaceId: "<value>",
82
+ projectSlug: "<value>",
83
+ });
84
+
85
+ const result = await sdk.analytics.timeseries({});
86
+
87
+ // Handle the result
88
+ console.log(result)
89
+ }
90
+
91
+ run();
92
+ ```
93
+
94
+ ### Parameters
95
+
96
+ | Parameter | Type | Required | Description |
97
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
98
+ | `request` | [operations.GetTimeseriesAnalyticsRequest](../../models/operations/gettimeseriesanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
99
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
100
+ | `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. |
101
+
102
+
103
+ ### Response
104
+
105
+ **Promise<[operations.ResponseBody[]](../../models/.md)>**
106
+ ### Errors
107
+
108
+ | Error Object | Status Code | Content Type |
109
+ | -------------------------- | -------------------------- | -------------------------- |
110
+ | errors.BadRequest | 400 | application/json |
111
+ | errors.Unauthorized | 401 | application/json |
112
+ | errors.Forbidden | 403 | application/json |
113
+ | errors.NotFound | 404 | application/json |
114
+ | errors.Conflict | 409 | application/json |
115
+ | errors.InviteExpired | 410 | application/json |
116
+ | errors.UnprocessableEntity | 422 | application/json |
117
+ | errors.RateLimitExceeded | 429 | application/json |
118
+ | errors.InternalServerError | 500 | application/json |
119
+ | errors.SDKError | 4xx-5xx | */* |
120
+
121
+ ## countries
122
+
123
+ Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
124
+
125
+ ### Example Usage
126
+
127
+ ```typescript
128
+ import { Dub } from "dub";
129
+
130
+ async function run() {
131
+ const sdk = new Dub({
132
+ token: "<YOUR_BEARER_TOKEN_HERE>",
133
+ workspaceId: "<value>",
134
+ projectSlug: "<value>",
135
+ });
136
+
137
+ const result = await sdk.analytics.countries({});
138
+
139
+ // Handle the result
140
+ console.log(result)
141
+ }
142
+
143
+ run();
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ | Parameter | Type | Required | Description |
149
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
150
+ | `request` | [operations.GetCountryAnalyticsRequest](../../models/operations/getcountryanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
151
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
152
+ | `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. |
153
+
154
+
155
+ ### Response
156
+
157
+ **Promise<[operations.GetCountryAnalyticsResponseBody[]](../../models/.md)>**
158
+ ### Errors
159
+
160
+ | Error Object | Status Code | Content Type |
161
+ | -------------------------- | -------------------------- | -------------------------- |
162
+ | errors.BadRequest | 400 | application/json |
163
+ | errors.Unauthorized | 401 | application/json |
164
+ | errors.Forbidden | 403 | application/json |
165
+ | errors.NotFound | 404 | application/json |
166
+ | errors.Conflict | 409 | application/json |
167
+ | errors.InviteExpired | 410 | application/json |
168
+ | errors.UnprocessableEntity | 422 | application/json |
169
+ | errors.RateLimitExceeded | 429 | application/json |
170
+ | errors.InternalServerError | 500 | application/json |
171
+ | errors.SDKError | 4xx-5xx | */* |
172
+
173
+ ## cities
174
+
175
+ Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
176
+
177
+ ### Example Usage
178
+
179
+ ```typescript
180
+ import { Dub } from "dub";
181
+
182
+ async function run() {
183
+ const sdk = new Dub({
184
+ token: "<YOUR_BEARER_TOKEN_HERE>",
185
+ workspaceId: "<value>",
186
+ projectSlug: "<value>",
187
+ });
188
+
189
+ const result = await sdk.analytics.cities({});
190
+
191
+ // Handle the result
192
+ console.log(result)
193
+ }
194
+
195
+ run();
196
+ ```
197
+
198
+ ### Parameters
199
+
200
+ | Parameter | Type | Required | Description |
201
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
202
+ | `request` | [operations.GetCityAnalyticsRequest](../../models/operations/getcityanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
203
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
204
+ | `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. |
205
+
206
+
207
+ ### Response
208
+
209
+ **Promise<[operations.GetCityAnalyticsResponseBody[]](../../models/.md)>**
210
+ ### Errors
211
+
212
+ | Error Object | Status Code | Content Type |
213
+ | -------------------------- | -------------------------- | -------------------------- |
214
+ | errors.BadRequest | 400 | application/json |
215
+ | errors.Unauthorized | 401 | application/json |
216
+ | errors.Forbidden | 403 | application/json |
217
+ | errors.NotFound | 404 | application/json |
218
+ | errors.Conflict | 409 | application/json |
219
+ | errors.InviteExpired | 410 | application/json |
220
+ | errors.UnprocessableEntity | 422 | application/json |
221
+ | errors.RateLimitExceeded | 429 | application/json |
222
+ | errors.InternalServerError | 500 | application/json |
223
+ | errors.SDKError | 4xx-5xx | */* |
224
+
225
+ ## devices
226
+
227
+ Retrieve the top devices by number of clicks for a link, a domain, or the authenticated workspace.
228
+
229
+ ### Example Usage
230
+
231
+ ```typescript
232
+ import { Dub } from "dub";
233
+
234
+ async function run() {
235
+ const sdk = new Dub({
236
+ token: "<YOUR_BEARER_TOKEN_HERE>",
237
+ workspaceId: "<value>",
238
+ projectSlug: "<value>",
239
+ });
240
+
241
+ const result = await sdk.analytics.devices({});
242
+
243
+ // Handle the result
244
+ console.log(result)
245
+ }
246
+
247
+ run();
248
+ ```
249
+
250
+ ### Parameters
251
+
252
+ | Parameter | Type | Required | Description |
253
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
254
+ | `request` | [operations.GetDeviceAnalyticsRequest](../../models/operations/getdeviceanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
255
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
256
+ | `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. |
257
+
258
+
259
+ ### Response
260
+
261
+ **Promise<[operations.GetDeviceAnalyticsResponseBody[]](../../models/.md)>**
262
+ ### Errors
263
+
264
+ | Error Object | Status Code | Content Type |
265
+ | -------------------------- | -------------------------- | -------------------------- |
266
+ | errors.BadRequest | 400 | application/json |
267
+ | errors.Unauthorized | 401 | application/json |
268
+ | errors.Forbidden | 403 | application/json |
269
+ | errors.NotFound | 404 | application/json |
270
+ | errors.Conflict | 409 | application/json |
271
+ | errors.InviteExpired | 410 | application/json |
272
+ | errors.UnprocessableEntity | 422 | application/json |
273
+ | errors.RateLimitExceeded | 429 | application/json |
274
+ | errors.InternalServerError | 500 | application/json |
275
+ | errors.SDKError | 4xx-5xx | */* |
276
+
277
+ ## browsers
278
+
279
+ Retrieve the top browsers by number of clicks for a link, a domain, or the authenticated workspace.
280
+
281
+ ### Example Usage
282
+
283
+ ```typescript
284
+ import { Dub } from "dub";
285
+
286
+ async function run() {
287
+ const sdk = new Dub({
288
+ token: "<YOUR_BEARER_TOKEN_HERE>",
289
+ workspaceId: "<value>",
290
+ projectSlug: "<value>",
291
+ });
292
+
293
+ const result = await sdk.analytics.browsers({});
294
+
295
+ // Handle the result
296
+ console.log(result)
297
+ }
298
+
299
+ run();
300
+ ```
301
+
302
+ ### Parameters
303
+
304
+ | Parameter | Type | Required | Description |
305
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
306
+ | `request` | [operations.GetBrowserAnalyticsRequest](../../models/operations/getbrowseranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
307
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
308
+ | `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. |
309
+
310
+
311
+ ### Response
312
+
313
+ **Promise<[operations.GetBrowserAnalyticsResponseBody[]](../../models/.md)>**
314
+ ### Errors
315
+
316
+ | Error Object | Status Code | Content Type |
317
+ | -------------------------- | -------------------------- | -------------------------- |
318
+ | errors.BadRequest | 400 | application/json |
319
+ | errors.Unauthorized | 401 | application/json |
320
+ | errors.Forbidden | 403 | application/json |
321
+ | errors.NotFound | 404 | application/json |
322
+ | errors.Conflict | 409 | application/json |
323
+ | errors.InviteExpired | 410 | application/json |
324
+ | errors.UnprocessableEntity | 422 | application/json |
325
+ | errors.RateLimitExceeded | 429 | application/json |
326
+ | errors.InternalServerError | 500 | application/json |
327
+ | errors.SDKError | 4xx-5xx | */* |
328
+
329
+ ## os
330
+
331
+ Retrieve the top OS by number of clicks for a link, a domain, or the authenticated workspace.
332
+
333
+ ### Example Usage
334
+
335
+ ```typescript
336
+ import { Dub } from "dub";
337
+
338
+ async function run() {
339
+ const sdk = new Dub({
340
+ token: "<YOUR_BEARER_TOKEN_HERE>",
341
+ workspaceId: "<value>",
342
+ projectSlug: "<value>",
343
+ });
344
+
345
+ const result = await sdk.analytics.os({});
346
+
347
+ // Handle the result
348
+ console.log(result)
349
+ }
350
+
351
+ run();
352
+ ```
353
+
354
+ ### Parameters
355
+
356
+ | Parameter | Type | Required | Description |
357
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
358
+ | `request` | [operations.GetOSAnalyticsRequest](../../models/operations/getosanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
359
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
360
+ | `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. |
361
+
362
+
363
+ ### Response
364
+
365
+ **Promise<[operations.GetOSAnalyticsResponseBody[]](../../models/.md)>**
366
+ ### Errors
367
+
368
+ | Error Object | Status Code | Content Type |
369
+ | -------------------------- | -------------------------- | -------------------------- |
370
+ | errors.BadRequest | 400 | application/json |
371
+ | errors.Unauthorized | 401 | application/json |
372
+ | errors.Forbidden | 403 | application/json |
373
+ | errors.NotFound | 404 | application/json |
374
+ | errors.Conflict | 409 | application/json |
375
+ | errors.InviteExpired | 410 | application/json |
376
+ | errors.UnprocessableEntity | 422 | application/json |
377
+ | errors.RateLimitExceeded | 429 | application/json |
378
+ | errors.InternalServerError | 500 | application/json |
379
+ | errors.SDKError | 4xx-5xx | */* |
380
+
381
+ ## referers
382
+
383
+ Retrieve the top referers by number of clicks for a link, a domain, or the authenticated workspace.
384
+
385
+ ### Example Usage
386
+
387
+ ```typescript
388
+ import { Dub } from "dub";
389
+
390
+ async function run() {
391
+ const sdk = new Dub({
392
+ token: "<YOUR_BEARER_TOKEN_HERE>",
393
+ workspaceId: "<value>",
394
+ projectSlug: "<value>",
395
+ });
396
+
397
+ const result = await sdk.analytics.referers({});
398
+
399
+ // Handle the result
400
+ console.log(result)
401
+ }
402
+
403
+ run();
404
+ ```
405
+
406
+ ### Parameters
407
+
408
+ | Parameter | Type | Required | Description |
409
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
410
+ | `request` | [operations.GetRefererAnalyticsRequest](../../models/operations/getrefereranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
411
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
412
+ | `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. |
413
+
414
+
415
+ ### Response
416
+
417
+ **Promise<[operations.GetRefererAnalyticsResponseBody[]](../../models/.md)>**
418
+ ### Errors
419
+
420
+ | Error Object | Status Code | Content Type |
421
+ | -------------------------- | -------------------------- | -------------------------- |
422
+ | errors.BadRequest | 400 | application/json |
423
+ | errors.Unauthorized | 401 | application/json |
424
+ | errors.Forbidden | 403 | application/json |
425
+ | errors.NotFound | 404 | application/json |
426
+ | errors.Conflict | 409 | application/json |
427
+ | errors.InviteExpired | 410 | application/json |
428
+ | errors.UnprocessableEntity | 422 | application/json |
429
+ | errors.RateLimitExceeded | 429 | application/json |
430
+ | errors.InternalServerError | 500 | application/json |
431
+ | errors.SDKError | 4xx-5xx | */* |
432
+
433
+ ## topLinks
434
+
435
+ Retrieve the top links by number of clicks for a domain or the authenticated workspace.
436
+
437
+ ### Example Usage
438
+
439
+ ```typescript
440
+ import { Dub } from "dub";
441
+
442
+ async function run() {
443
+ const sdk = new Dub({
444
+ token: "<YOUR_BEARER_TOKEN_HERE>",
445
+ workspaceId: "<value>",
446
+ projectSlug: "<value>",
447
+ });
448
+
449
+ const result = await sdk.analytics.topLinks({});
450
+
451
+ // Handle the result
452
+ console.log(result)
453
+ }
454
+
455
+ run();
456
+ ```
457
+
458
+ ### Parameters
459
+
460
+ | Parameter | Type | Required | Description |
461
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
462
+ | `request` | [operations.GetTopLinksRequest](../../models/operations/gettoplinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
463
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
464
+ | `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. |
465
+
466
+
467
+ ### Response
468
+
469
+ **Promise<[operations.GetTopLinksResponseBody[]](../../models/.md)>**
470
+ ### Errors
471
+
472
+ | Error Object | Status Code | Content Type |
473
+ | -------------------------- | -------------------------- | -------------------------- |
474
+ | errors.BadRequest | 400 | application/json |
475
+ | errors.Unauthorized | 401 | application/json |
476
+ | errors.Forbidden | 403 | application/json |
477
+ | errors.NotFound | 404 | application/json |
478
+ | errors.Conflict | 409 | application/json |
479
+ | errors.InviteExpired | 410 | application/json |
480
+ | errors.UnprocessableEntity | 422 | application/json |
481
+ | errors.RateLimitExceeded | 429 | application/json |
482
+ | errors.InternalServerError | 500 | application/json |
483
+ | errors.SDKError | 4xx-5xx | */* |
484
+
485
+ ## topUrls
486
+
487
+ Retrieve the top URLs by number of clicks for a given short link.
488
+
489
+ ### Example Usage
490
+
491
+ ```typescript
492
+ import { Dub } from "dub";
493
+
494
+ async function run() {
495
+ const sdk = new Dub({
496
+ token: "<YOUR_BEARER_TOKEN_HERE>",
497
+ workspaceId: "<value>",
498
+ projectSlug: "<value>",
499
+ });
500
+
501
+ const result = await sdk.analytics.topUrls({});
502
+
503
+ // Handle the result
504
+ console.log(result)
505
+ }
506
+
507
+ run();
508
+ ```
509
+
510
+ ### Parameters
511
+
512
+ | Parameter | Type | Required | Description |
513
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
514
+ | `request` | [operations.GetTopURLsRequest](../../models/operations/gettopurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
515
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
516
+ | `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. |
517
+
518
+
519
+ ### Response
520
+
521
+ **Promise<[operations.GetTopURLsResponseBody[]](../../models/.md)>**
522
+ ### Errors
523
+
524
+ | Error Object | Status Code | Content Type |
525
+ | -------------------------- | -------------------------- | -------------------------- |
526
+ | errors.BadRequest | 400 | application/json |
527
+ | errors.Unauthorized | 401 | application/json |
528
+ | errors.Forbidden | 403 | application/json |
529
+ | errors.NotFound | 404 | application/json |
530
+ | errors.Conflict | 409 | application/json |
531
+ | errors.InviteExpired | 410 | application/json |
532
+ | errors.UnprocessableEntity | 422 | application/json |
533
+ | errors.RateLimitExceeded | 429 | application/json |
534
+ | errors.InternalServerError | 500 | application/json |
535
+ | errors.SDKError | 4xx-5xx | */* |
@@ -0,0 +1,9 @@
1
+ # Dub SDK
2
+
3
+
4
+ ## Overview
5
+
6
+ Dub.co API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.
7
+
8
+ ### Available Operations
9
+