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,415 @@
1
+ # Links
2
+ (*links*)
3
+
4
+ ### Available Operations
5
+
6
+ * [list](#list) - Retrieve a list of links
7
+ * [create](#create) - Create a new link
8
+ * [count](#count) - Retrieve the number of links
9
+ * [get](#get) - Retrieve a link
10
+ * [update](#update) - Edit a link
11
+ * [delete](#delete) - Delete a link
12
+ * [createMany](#createmany) - Bulk create links
13
+
14
+ ## list
15
+
16
+ Retrieve a list of links for the authenticated workspace. The list will be paginated and the provided query parameters allow filtering the returned links.
17
+
18
+ ### Example Usage
19
+
20
+ ```typescript
21
+ import { Dub } from "dub";
22
+
23
+ async function run() {
24
+ const sdk = new Dub({
25
+ token: "<YOUR_BEARER_TOKEN_HERE>",
26
+ workspaceId: "<value>",
27
+ projectSlug: "<value>",
28
+ });
29
+
30
+ const result = await sdk.links.list({
31
+ tagIds: [
32
+ "<value>",
33
+ ],
34
+ });
35
+
36
+ // Handle the result
37
+ console.log(result)
38
+ }
39
+
40
+ run();
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+ | Parameter | Type | Required | Description |
46
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
47
+ | `request` | [operations.GetLinksRequest](../../models/operations/getlinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
48
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
49
+ | `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. |
50
+
51
+
52
+ ### Response
53
+
54
+ **Promise<[components.LinkSchema[]](../../models/.md)>**
55
+ ### Errors
56
+
57
+ | Error Object | Status Code | Content Type |
58
+ | -------------------------- | -------------------------- | -------------------------- |
59
+ | errors.BadRequest | 400 | application/json |
60
+ | errors.Unauthorized | 401 | application/json |
61
+ | errors.Forbidden | 403 | application/json |
62
+ | errors.NotFound | 404 | application/json |
63
+ | errors.Conflict | 409 | application/json |
64
+ | errors.InviteExpired | 410 | application/json |
65
+ | errors.UnprocessableEntity | 422 | application/json |
66
+ | errors.RateLimitExceeded | 429 | application/json |
67
+ | errors.InternalServerError | 500 | application/json |
68
+ | errors.SDKError | 4xx-5xx | */* |
69
+
70
+ ## create
71
+
72
+ Create a new link for the authenticated workspace.
73
+
74
+ ### Example Usage
75
+
76
+ ```typescript
77
+ import { Dub } from "dub";
78
+
79
+ async function run() {
80
+ const sdk = new Dub({
81
+ token: "<YOUR_BEARER_TOKEN_HERE>",
82
+ workspaceId: "<value>",
83
+ projectSlug: "<value>",
84
+ });
85
+
86
+ const result = await sdk.links.create({
87
+ url: "http://limp-pastry.org",
88
+ geo: {
89
+ "key": "<value>",
90
+ },
91
+ tagIds: "<value>",
92
+ });
93
+
94
+ // Handle the result
95
+ console.log(result)
96
+ }
97
+
98
+ run();
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ | Parameter | Type | Required | Description |
104
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
105
+ | `request` | [operations.CreateLinkRequestBody](../../models/operations/createlinkrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
106
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
107
+ | `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. |
108
+
109
+
110
+ ### Response
111
+
112
+ **Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
113
+ ### Errors
114
+
115
+ | Error Object | Status Code | Content Type |
116
+ | -------------------------- | -------------------------- | -------------------------- |
117
+ | errors.BadRequest | 400 | application/json |
118
+ | errors.Unauthorized | 401 | application/json |
119
+ | errors.Forbidden | 403 | application/json |
120
+ | errors.NotFound | 404 | application/json |
121
+ | errors.Conflict | 409 | application/json |
122
+ | errors.InviteExpired | 410 | application/json |
123
+ | errors.UnprocessableEntity | 422 | application/json |
124
+ | errors.RateLimitExceeded | 429 | application/json |
125
+ | errors.InternalServerError | 500 | application/json |
126
+ | errors.SDKError | 4xx-5xx | */* |
127
+
128
+ ## count
129
+
130
+ Retrieve the number of links for the authenticated workspace. The provided query parameters allow filtering the returned links.
131
+
132
+ ### Example Usage
133
+
134
+ ```typescript
135
+ import { Dub } from "dub";
136
+ import { One } from "dub/models/operations";
137
+
138
+ async function run() {
139
+ const sdk = new Dub({
140
+ token: "<YOUR_BEARER_TOKEN_HERE>",
141
+ workspaceId: "<value>",
142
+ projectSlug: "<value>",
143
+ });
144
+
145
+ const result = await sdk.links.count({
146
+ tagIds: "<value>",
147
+ groupBy: One.Domain,
148
+ });
149
+
150
+ // Handle the result
151
+ console.log(result)
152
+ }
153
+
154
+ run();
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Parameter | Type | Required | Description |
160
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
161
+ | `request` | [operations.GetLinksCountRequest](../../models/operations/getlinkscountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
162
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
163
+ | `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. |
164
+
165
+
166
+ ### Response
167
+
168
+ **Promise<[number](../../models/.md)>**
169
+ ### Errors
170
+
171
+ | Error Object | Status Code | Content Type |
172
+ | -------------------------- | -------------------------- | -------------------------- |
173
+ | errors.BadRequest | 400 | application/json |
174
+ | errors.Unauthorized | 401 | application/json |
175
+ | errors.Forbidden | 403 | application/json |
176
+ | errors.NotFound | 404 | application/json |
177
+ | errors.Conflict | 409 | application/json |
178
+ | errors.InviteExpired | 410 | application/json |
179
+ | errors.UnprocessableEntity | 422 | application/json |
180
+ | errors.RateLimitExceeded | 429 | application/json |
181
+ | errors.InternalServerError | 500 | application/json |
182
+ | errors.SDKError | 4xx-5xx | */* |
183
+
184
+ ## get
185
+
186
+ Retrieve the info for a link from their domain and key.
187
+
188
+ ### Example Usage
189
+
190
+ ```typescript
191
+ import { Dub } from "dub";
192
+
193
+ async function run() {
194
+ const sdk = new Dub({
195
+ token: "<YOUR_BEARER_TOKEN_HERE>",
196
+ workspaceId: "<value>",
197
+ projectSlug: "<value>",
198
+ });
199
+
200
+ const result = await sdk.links.get({
201
+ domain: "ringed-blow.name",
202
+ key: "<key>",
203
+ });
204
+
205
+ // Handle the result
206
+ console.log(result)
207
+ }
208
+
209
+ run();
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ | Parameter | Type | Required | Description |
215
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
216
+ | `request` | [operations.GetLinkInfoRequest](../../models/operations/getlinkinforequest.md) | :heavy_check_mark: | The request object to use for the request. |
217
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
218
+ | `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. |
219
+
220
+
221
+ ### Response
222
+
223
+ **Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
224
+ ### Errors
225
+
226
+ | Error Object | Status Code | Content Type |
227
+ | -------------------------- | -------------------------- | -------------------------- |
228
+ | errors.BadRequest | 400 | application/json |
229
+ | errors.Unauthorized | 401 | application/json |
230
+ | errors.Forbidden | 403 | application/json |
231
+ | errors.NotFound | 404 | application/json |
232
+ | errors.Conflict | 409 | application/json |
233
+ | errors.InviteExpired | 410 | application/json |
234
+ | errors.UnprocessableEntity | 422 | application/json |
235
+ | errors.RateLimitExceeded | 429 | application/json |
236
+ | errors.InternalServerError | 500 | application/json |
237
+ | errors.SDKError | 4xx-5xx | */* |
238
+
239
+ ## update
240
+
241
+ Edit a link for the authenticated workspace.
242
+
243
+ ### Example Usage
244
+
245
+ ```typescript
246
+ import { Dub } from "dub";
247
+
248
+ async function run() {
249
+ const sdk = new Dub({
250
+ token: "<YOUR_BEARER_TOKEN_HERE>",
251
+ workspaceId: "<value>",
252
+ projectSlug: "<value>",
253
+ });
254
+
255
+ const linkId = "<value>";
256
+ const requestBody = {
257
+ url: "https://alarming-nondisclosure.com",
258
+ geo: {
259
+ "key": "<value>",
260
+ },
261
+ tagIds: "<value>",
262
+ };
263
+
264
+ const result = await sdk.links.update(linkId, requestBody);
265
+
266
+ // Handle the result
267
+ console.log(result)
268
+ }
269
+
270
+ run();
271
+ ```
272
+
273
+ ### Parameters
274
+
275
+ | Parameter | Type | Required | Description |
276
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
277
+ | `linkId` | *string* | :heavy_check_mark: | The id of the link to edit. You can get this via the `getLinkInfo` endpoint. |
278
+ | `requestBody` | [operations.EditLinkRequestBody](../../models/operations/editlinkrequestbody.md) | :heavy_minus_sign: | N/A |
279
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
280
+ | `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. |
281
+
282
+
283
+ ### Response
284
+
285
+ **Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
286
+ ### Errors
287
+
288
+ | Error Object | Status Code | Content Type |
289
+ | -------------------------- | -------------------------- | -------------------------- |
290
+ | errors.BadRequest | 400 | application/json |
291
+ | errors.Unauthorized | 401 | application/json |
292
+ | errors.Forbidden | 403 | application/json |
293
+ | errors.NotFound | 404 | application/json |
294
+ | errors.Conflict | 409 | application/json |
295
+ | errors.InviteExpired | 410 | application/json |
296
+ | errors.UnprocessableEntity | 422 | application/json |
297
+ | errors.RateLimitExceeded | 429 | application/json |
298
+ | errors.InternalServerError | 500 | application/json |
299
+ | errors.SDKError | 4xx-5xx | */* |
300
+
301
+ ## delete
302
+
303
+ Delete a link for the authenticated workspace.
304
+
305
+ ### Example Usage
306
+
307
+ ```typescript
308
+ import { Dub } from "dub";
309
+
310
+ async function run() {
311
+ const sdk = new Dub({
312
+ token: "<YOUR_BEARER_TOKEN_HERE>",
313
+ workspaceId: "<value>",
314
+ projectSlug: "<value>",
315
+ });
316
+
317
+ const linkId = "<value>";
318
+
319
+ const result = await sdk.links.delete(linkId);
320
+
321
+ // Handle the result
322
+ console.log(result)
323
+ }
324
+
325
+ run();
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+ | Parameter | Type | Required | Description |
331
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
332
+ | `linkId` | *string* | :heavy_check_mark: | The id of the link to delete. You can get this via the `getLinkInfo` endpoint. |
333
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
334
+ | `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. |
335
+
336
+
337
+ ### Response
338
+
339
+ **Promise<[operations.DeleteLinkResponseBody](../../models/operations/deletelinkresponsebody.md)>**
340
+ ### Errors
341
+
342
+ | Error Object | Status Code | Content Type |
343
+ | -------------------------- | -------------------------- | -------------------------- |
344
+ | errors.BadRequest | 400 | application/json |
345
+ | errors.Unauthorized | 401 | application/json |
346
+ | errors.Forbidden | 403 | application/json |
347
+ | errors.NotFound | 404 | application/json |
348
+ | errors.Conflict | 409 | application/json |
349
+ | errors.InviteExpired | 410 | application/json |
350
+ | errors.UnprocessableEntity | 422 | application/json |
351
+ | errors.RateLimitExceeded | 429 | application/json |
352
+ | errors.InternalServerError | 500 | application/json |
353
+ | errors.SDKError | 4xx-5xx | */* |
354
+
355
+ ## createMany
356
+
357
+ Bulk create up to 100 links for the authenticated workspace.
358
+
359
+ ### Example Usage
360
+
361
+ ```typescript
362
+ import { Dub } from "dub";
363
+
364
+ async function run() {
365
+ const sdk = new Dub({
366
+ token: "<YOUR_BEARER_TOKEN_HERE>",
367
+ workspaceId: "<value>",
368
+ projectSlug: "<value>",
369
+ });
370
+
371
+ const result = await sdk.links.createMany([
372
+ {
373
+ url: "https://positive-plane.info",
374
+ geo: {
375
+ "key": "<value>",
376
+ },
377
+ tagIds: [
378
+ "<value>",
379
+ ],
380
+ },
381
+ ]);
382
+
383
+ // Handle the result
384
+ console.log(result)
385
+ }
386
+
387
+ run();
388
+ ```
389
+
390
+ ### Parameters
391
+
392
+ | Parameter | Type | Required | Description |
393
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
394
+ | `request` | [operations.RequestBody[]](../../models/.md) | :heavy_check_mark: | The request object to use for the request. |
395
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
396
+ | `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. |
397
+
398
+
399
+ ### Response
400
+
401
+ **Promise<[components.LinkSchema[]](../../models/.md)>**
402
+ ### Errors
403
+
404
+ | Error Object | Status Code | Content Type |
405
+ | -------------------------- | -------------------------- | -------------------------- |
406
+ | errors.BadRequest | 400 | application/json |
407
+ | errors.Unauthorized | 401 | application/json |
408
+ | errors.Forbidden | 403 | application/json |
409
+ | errors.NotFound | 404 | application/json |
410
+ | errors.Conflict | 409 | application/json |
411
+ | errors.InviteExpired | 410 | application/json |
412
+ | errors.UnprocessableEntity | 422 | application/json |
413
+ | errors.RateLimitExceeded | 429 | application/json |
414
+ | errors.InternalServerError | 500 | application/json |
415
+ | errors.SDKError | 4xx-5xx | */* |
@@ -0,0 +1,58 @@
1
+ # QRCodes
2
+ (*qrCodes*)
3
+
4
+ ### Available Operations
5
+
6
+ * [get](#get) - Retrieve a QR code
7
+
8
+ ## get
9
+
10
+ Retrieve a QR code for a link.
11
+
12
+ ### Example Usage
13
+
14
+ ```typescript
15
+ import { Dub } from "dub";
16
+
17
+ async function run() {
18
+ const sdk = new Dub({
19
+ token: "<YOUR_BEARER_TOKEN_HERE>",
20
+ workspaceId: "<value>",
21
+ projectSlug: "<value>",
22
+ });
23
+
24
+ const result = await sdk.qrCodes.get({});
25
+
26
+ // Handle the result
27
+ console.log(result)
28
+ }
29
+
30
+ run();
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ | Parameter | Type | Required | Description |
36
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
37
+ | `request` | [operations.GetQRCodeRequest](../../models/operations/getqrcoderequest.md) | :heavy_check_mark: | The request object to use for the request. |
38
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
39
+ | `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. |
40
+
41
+
42
+ ### Response
43
+
44
+ **Promise<[string](../../models/.md)>**
45
+ ### Errors
46
+
47
+ | Error Object | Status Code | Content Type |
48
+ | -------------------------- | -------------------------- | -------------------------- |
49
+ | errors.BadRequest | 400 | application/json |
50
+ | errors.Unauthorized | 401 | application/json |
51
+ | errors.Forbidden | 403 | application/json |
52
+ | errors.NotFound | 404 | application/json |
53
+ | errors.Conflict | 409 | application/json |
54
+ | errors.InviteExpired | 410 | application/json |
55
+ | errors.UnprocessableEntity | 422 | application/json |
56
+ | errors.RateLimitExceeded | 429 | application/json |
57
+ | errors.InternalServerError | 500 | application/json |
58
+ | errors.SDKError | 4xx-5xx | */* |
@@ -0,0 +1,113 @@
1
+ # Tags
2
+ (*tags*)
3
+
4
+ ### Available Operations
5
+
6
+ * [list](#list) - Retrieve a list of tags
7
+ * [create](#create) - Create a new tag
8
+
9
+ ## list
10
+
11
+ Retrieve a list of tags for the authenticated workspace.
12
+
13
+ ### Example Usage
14
+
15
+ ```typescript
16
+ import { Dub } from "dub";
17
+
18
+ async function run() {
19
+ const sdk = new Dub({
20
+ token: "<YOUR_BEARER_TOKEN_HERE>",
21
+ workspaceId: "<value>",
22
+ projectSlug: "<value>",
23
+ });
24
+
25
+ const result = await sdk.tags.list({});
26
+
27
+ // Handle the result
28
+ console.log(result)
29
+ }
30
+
31
+ run();
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ | Parameter | Type | Required | Description |
37
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
38
+ | `request` | [operations.GetTagsRequest](../../models/operations/gettagsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
39
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
40
+ | `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. |
41
+
42
+
43
+ ### Response
44
+
45
+ **Promise<[components.TagSchema[]](../../models/.md)>**
46
+ ### Errors
47
+
48
+ | Error Object | Status Code | Content Type |
49
+ | -------------------------- | -------------------------- | -------------------------- |
50
+ | errors.BadRequest | 400 | application/json |
51
+ | errors.Unauthorized | 401 | application/json |
52
+ | errors.Forbidden | 403 | application/json |
53
+ | errors.NotFound | 404 | application/json |
54
+ | errors.Conflict | 409 | application/json |
55
+ | errors.InviteExpired | 410 | application/json |
56
+ | errors.UnprocessableEntity | 422 | application/json |
57
+ | errors.RateLimitExceeded | 429 | application/json |
58
+ | errors.InternalServerError | 500 | application/json |
59
+ | errors.SDKError | 4xx-5xx | */* |
60
+
61
+ ## create
62
+
63
+ Create a new tag for the authenticated workspace.
64
+
65
+ ### Example Usage
66
+
67
+ ```typescript
68
+ import { Dub } from "dub";
69
+
70
+ async function run() {
71
+ const sdk = new Dub({
72
+ token: "<YOUR_BEARER_TOKEN_HERE>",
73
+ workspaceId: "<value>",
74
+ projectSlug: "<value>",
75
+ });
76
+
77
+ const result = await sdk.tags.create({
78
+ tag: "<value>",
79
+ });
80
+
81
+ // Handle the result
82
+ console.log(result)
83
+ }
84
+
85
+ run();
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+ | Parameter | Type | Required | Description |
91
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
92
+ | `request` | [operations.CreateTagRequestBody](../../models/operations/createtagrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
93
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
94
+ | `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. |
95
+
96
+
97
+ ### Response
98
+
99
+ **Promise<[components.TagSchema](../../models/components/tagschema.md)>**
100
+ ### Errors
101
+
102
+ | Error Object | Status Code | Content Type |
103
+ | -------------------------- | -------------------------- | -------------------------- |
104
+ | errors.BadRequest | 400 | application/json |
105
+ | errors.Unauthorized | 401 | application/json |
106
+ | errors.Forbidden | 403 | application/json |
107
+ | errors.NotFound | 404 | application/json |
108
+ | errors.Conflict | 409 | application/json |
109
+ | errors.InviteExpired | 410 | application/json |
110
+ | errors.UnprocessableEntity | 422 | application/json |
111
+ | errors.RateLimitExceeded | 429 | application/json |
112
+ | errors.InternalServerError | 500 | application/json |
113
+ | errors.SDKError | 4xx-5xx | */* |