@codeqr/ts 0.1.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 (480) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/LICENSE +201 -0
  3. package/README.md +359 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +198 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +198 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +469 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +465 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +35 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +32 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/qs/formats.d.mts +7 -0
  109. package/internal/qs/formats.d.mts.map +1 -0
  110. package/internal/qs/formats.d.ts +7 -0
  111. package/internal/qs/formats.d.ts.map +1 -0
  112. package/internal/qs/formats.js +13 -0
  113. package/internal/qs/formats.js.map +1 -0
  114. package/internal/qs/formats.mjs +9 -0
  115. package/internal/qs/formats.mjs.map +1 -0
  116. package/internal/qs/index.d.mts +10 -0
  117. package/internal/qs/index.d.mts.map +1 -0
  118. package/internal/qs/index.d.ts +10 -0
  119. package/internal/qs/index.d.ts.map +1 -0
  120. package/internal/qs/index.js +14 -0
  121. package/internal/qs/index.js.map +1 -0
  122. package/internal/qs/index.mjs +10 -0
  123. package/internal/qs/index.mjs.map +1 -0
  124. package/internal/qs/stringify.d.mts +3 -0
  125. package/internal/qs/stringify.d.mts.map +1 -0
  126. package/internal/qs/stringify.d.ts +3 -0
  127. package/internal/qs/stringify.d.ts.map +1 -0
  128. package/internal/qs/stringify.js +277 -0
  129. package/internal/qs/stringify.js.map +1 -0
  130. package/internal/qs/stringify.mjs +274 -0
  131. package/internal/qs/stringify.mjs.map +1 -0
  132. package/internal/qs/types.d.mts +57 -0
  133. package/internal/qs/types.d.mts.map +1 -0
  134. package/internal/qs/types.d.ts +57 -0
  135. package/internal/qs/types.d.ts.map +1 -0
  136. package/internal/qs/types.js +3 -0
  137. package/internal/qs/types.js.map +1 -0
  138. package/internal/qs/types.mjs +2 -0
  139. package/internal/qs/types.mjs.map +1 -0
  140. package/internal/qs/utils.d.mts +15 -0
  141. package/internal/qs/utils.d.mts.map +1 -0
  142. package/internal/qs/utils.d.ts +15 -0
  143. package/internal/qs/utils.d.ts.map +1 -0
  144. package/internal/qs/utils.js +230 -0
  145. package/internal/qs/utils.js.map +1 -0
  146. package/internal/qs/utils.mjs +217 -0
  147. package/internal/qs/utils.mjs.map +1 -0
  148. package/internal/request-options.d.mts +75 -0
  149. package/internal/request-options.d.mts.map +1 -0
  150. package/internal/request-options.d.ts +75 -0
  151. package/internal/request-options.d.ts.map +1 -0
  152. package/internal/request-options.js +14 -0
  153. package/internal/request-options.js.map +1 -0
  154. package/internal/request-options.mjs +10 -0
  155. package/internal/request-options.mjs.map +1 -0
  156. package/internal/shim-types.d.mts +17 -0
  157. package/internal/shim-types.d.mts.map +1 -0
  158. package/internal/shim-types.d.ts +17 -0
  159. package/internal/shim-types.d.ts.map +1 -0
  160. package/internal/shim-types.js +4 -0
  161. package/internal/shim-types.js.map +1 -0
  162. package/internal/shim-types.mjs +3 -0
  163. package/internal/shim-types.mjs.map +1 -0
  164. package/internal/shims.d.mts +20 -0
  165. package/internal/shims.d.mts.map +1 -0
  166. package/internal/shims.d.ts +20 -0
  167. package/internal/shims.d.ts.map +1 -0
  168. package/internal/shims.js +92 -0
  169. package/internal/shims.js.map +1 -0
  170. package/internal/shims.mjs +85 -0
  171. package/internal/shims.mjs.map +1 -0
  172. package/internal/to-file.d.mts +45 -0
  173. package/internal/to-file.d.mts.map +1 -0
  174. package/internal/to-file.d.ts +45 -0
  175. package/internal/to-file.d.ts.map +1 -0
  176. package/internal/to-file.js +91 -0
  177. package/internal/to-file.js.map +1 -0
  178. package/internal/to-file.mjs +88 -0
  179. package/internal/to-file.mjs.map +1 -0
  180. package/internal/tslib.js +81 -0
  181. package/internal/tslib.mjs +17 -0
  182. package/internal/types.d.mts +69 -0
  183. package/internal/types.d.mts.map +1 -0
  184. package/internal/types.d.ts +69 -0
  185. package/internal/types.d.ts.map +1 -0
  186. package/internal/types.js +4 -0
  187. package/internal/types.js.map +1 -0
  188. package/internal/types.mjs +3 -0
  189. package/internal/types.mjs.map +1 -0
  190. package/internal/uploads.d.mts +42 -0
  191. package/internal/uploads.d.mts.map +1 -0
  192. package/internal/uploads.d.ts +42 -0
  193. package/internal/uploads.d.ts.map +1 -0
  194. package/internal/uploads.js +141 -0
  195. package/internal/uploads.js.map +1 -0
  196. package/internal/uploads.mjs +131 -0
  197. package/internal/uploads.mjs.map +1 -0
  198. package/internal/utils/base64.d.mts +3 -0
  199. package/internal/utils/base64.d.mts.map +1 -0
  200. package/internal/utils/base64.d.ts +3 -0
  201. package/internal/utils/base64.d.ts.map +1 -0
  202. package/internal/utils/base64.js +38 -0
  203. package/internal/utils/base64.js.map +1 -0
  204. package/internal/utils/base64.mjs +33 -0
  205. package/internal/utils/base64.mjs.map +1 -0
  206. package/internal/utils/bytes.d.mts +4 -0
  207. package/internal/utils/bytes.d.mts.map +1 -0
  208. package/internal/utils/bytes.d.ts +4 -0
  209. package/internal/utils/bytes.d.ts.map +1 -0
  210. package/internal/utils/bytes.js +31 -0
  211. package/internal/utils/bytes.js.map +1 -0
  212. package/internal/utils/bytes.mjs +26 -0
  213. package/internal/utils/bytes.mjs.map +1 -0
  214. package/internal/utils/env.d.mts +9 -0
  215. package/internal/utils/env.d.mts.map +1 -0
  216. package/internal/utils/env.d.ts +9 -0
  217. package/internal/utils/env.d.ts.map +1 -0
  218. package/internal/utils/env.js +22 -0
  219. package/internal/utils/env.js.map +1 -0
  220. package/internal/utils/env.mjs +18 -0
  221. package/internal/utils/env.mjs.map +1 -0
  222. package/internal/utils/log.d.mts +37 -0
  223. package/internal/utils/log.d.mts.map +1 -0
  224. package/internal/utils/log.d.ts +37 -0
  225. package/internal/utils/log.d.ts.map +1 -0
  226. package/internal/utils/log.js +85 -0
  227. package/internal/utils/log.js.map +1 -0
  228. package/internal/utils/log.mjs +79 -0
  229. package/internal/utils/log.mjs.map +1 -0
  230. package/internal/utils/path.d.mts +15 -0
  231. package/internal/utils/path.d.mts.map +1 -0
  232. package/internal/utils/path.d.ts +15 -0
  233. package/internal/utils/path.d.ts.map +1 -0
  234. package/internal/utils/path.js +79 -0
  235. package/internal/utils/path.js.map +1 -0
  236. package/internal/utils/path.mjs +74 -0
  237. package/internal/utils/path.mjs.map +1 -0
  238. package/internal/utils/sleep.d.mts +2 -0
  239. package/internal/utils/sleep.d.mts.map +1 -0
  240. package/internal/utils/sleep.d.ts +2 -0
  241. package/internal/utils/sleep.d.ts.map +1 -0
  242. package/internal/utils/sleep.js +7 -0
  243. package/internal/utils/sleep.js.map +1 -0
  244. package/internal/utils/sleep.mjs +3 -0
  245. package/internal/utils/sleep.mjs.map +1 -0
  246. package/internal/utils/uuid.d.mts +5 -0
  247. package/internal/utils/uuid.d.mts.map +1 -0
  248. package/internal/utils/uuid.d.ts +5 -0
  249. package/internal/utils/uuid.d.ts.map +1 -0
  250. package/internal/utils/uuid.js +19 -0
  251. package/internal/utils/uuid.js.map +1 -0
  252. package/internal/utils/uuid.mjs +15 -0
  253. package/internal/utils/uuid.mjs.map +1 -0
  254. package/internal/utils/values.d.mts +18 -0
  255. package/internal/utils/values.d.mts.map +1 -0
  256. package/internal/utils/values.d.ts +18 -0
  257. package/internal/utils/values.d.ts.map +1 -0
  258. package/internal/utils/values.js +112 -0
  259. package/internal/utils/values.js.map +1 -0
  260. package/internal/utils/values.mjs +94 -0
  261. package/internal/utils/values.mjs.map +1 -0
  262. package/internal/utils.d.mts +7 -0
  263. package/internal/utils.d.mts.map +1 -0
  264. package/internal/utils.d.ts +7 -0
  265. package/internal/utils.d.ts.map +1 -0
  266. package/internal/utils.js +11 -0
  267. package/internal/utils.js.map +1 -0
  268. package/internal/utils.mjs +8 -0
  269. package/internal/utils.mjs.map +1 -0
  270. package/package.json +138 -0
  271. package/resource.d.mts +2 -0
  272. package/resource.d.mts.map +1 -0
  273. package/resource.d.ts +2 -0
  274. package/resource.d.ts.map +1 -0
  275. package/resource.js +6 -0
  276. package/resource.js.map +1 -0
  277. package/resource.mjs +2 -0
  278. package/resource.mjs.map +1 -0
  279. package/resources/analytics.d.mts +459 -0
  280. package/resources/analytics.d.mts.map +1 -0
  281. package/resources/analytics.d.ts +459 -0
  282. package/resources/analytics.d.ts.map +1 -0
  283. package/resources/analytics.js +16 -0
  284. package/resources/analytics.js.map +1 -0
  285. package/resources/analytics.mjs +12 -0
  286. package/resources/analytics.mjs.map +1 -0
  287. package/resources/domains.d.mts +153 -0
  288. package/resources/domains.d.mts.map +1 -0
  289. package/resources/domains.d.ts +153 -0
  290. package/resources/domains.d.ts.map +1 -0
  291. package/resources/domains.js +57 -0
  292. package/resources/domains.js.map +1 -0
  293. package/resources/domains.mjs +53 -0
  294. package/resources/domains.mjs.map +1 -0
  295. package/resources/events.d.mts +781 -0
  296. package/resources/events.d.mts.map +1 -0
  297. package/resources/events.d.ts +781 -0
  298. package/resources/events.d.ts.map +1 -0
  299. package/resources/events.js +15 -0
  300. package/resources/events.js.map +1 -0
  301. package/resources/events.mjs +11 -0
  302. package/resources/events.mjs.map +1 -0
  303. package/resources/index.d.mts +9 -0
  304. package/resources/index.d.mts.map +1 -0
  305. package/resources/index.d.ts +9 -0
  306. package/resources/index.d.ts.map +1 -0
  307. package/resources/index.js +21 -0
  308. package/resources/index.js.map +1 -0
  309. package/resources/index.mjs +10 -0
  310. package/resources/index.mjs.map +1 -0
  311. package/resources/links/bulk.d.mts +465 -0
  312. package/resources/links/bulk.d.mts.map +1 -0
  313. package/resources/links/bulk.d.ts +465 -0
  314. package/resources/links/bulk.d.ts.map +1 -0
  315. package/resources/links/bulk.js +35 -0
  316. package/resources/links/bulk.js.map +1 -0
  317. package/resources/links/bulk.mjs +31 -0
  318. package/resources/links/bulk.mjs.map +1 -0
  319. package/resources/links/index.d.mts +3 -0
  320. package/resources/links/index.d.mts.map +1 -0
  321. package/resources/links/index.d.ts +3 -0
  322. package/resources/links/index.d.ts.map +1 -0
  323. package/resources/links/index.js +9 -0
  324. package/resources/links/index.js.map +1 -0
  325. package/resources/links/index.mjs +4 -0
  326. package/resources/links/index.mjs.map +1 -0
  327. package/resources/links/links.d.mts +2325 -0
  328. package/resources/links/links.d.mts.map +1 -0
  329. package/resources/links/links.d.ts +2325 -0
  330. package/resources/links/links.d.ts.map +1 -0
  331. package/resources/links/links.js +106 -0
  332. package/resources/links/links.js.map +1 -0
  333. package/resources/links/links.mjs +101 -0
  334. package/resources/links/links.mjs.map +1 -0
  335. package/resources/links.d.mts +2 -0
  336. package/resources/links.d.mts.map +1 -0
  337. package/resources/links.d.ts +2 -0
  338. package/resources/links.d.ts.map +1 -0
  339. package/resources/links.js +6 -0
  340. package/resources/links.js.map +1 -0
  341. package/resources/links.mjs +3 -0
  342. package/resources/links.mjs.map +1 -0
  343. package/resources/projects.d.mts +110 -0
  344. package/resources/projects.d.mts.map +1 -0
  345. package/resources/projects.d.ts +110 -0
  346. package/resources/projects.d.ts.map +1 -0
  347. package/resources/projects.js +22 -0
  348. package/resources/projects.js.map +1 -0
  349. package/resources/projects.mjs +18 -0
  350. package/resources/projects.mjs.map +1 -0
  351. package/resources/qrcodes/bulk.d.mts +579 -0
  352. package/resources/qrcodes/bulk.d.mts.map +1 -0
  353. package/resources/qrcodes/bulk.d.ts +579 -0
  354. package/resources/qrcodes/bulk.d.ts.map +1 -0
  355. package/resources/qrcodes/bulk.js +35 -0
  356. package/resources/qrcodes/bulk.js.map +1 -0
  357. package/resources/qrcodes/bulk.mjs +31 -0
  358. package/resources/qrcodes/bulk.mjs.map +1 -0
  359. package/resources/qrcodes/index.d.mts +3 -0
  360. package/resources/qrcodes/index.d.mts.map +1 -0
  361. package/resources/qrcodes/index.d.ts +3 -0
  362. package/resources/qrcodes/index.d.ts.map +1 -0
  363. package/resources/qrcodes/index.js +9 -0
  364. package/resources/qrcodes/index.js.map +1 -0
  365. package/resources/qrcodes/index.mjs +4 -0
  366. package/resources/qrcodes/index.mjs.map +1 -0
  367. package/resources/qrcodes/qrcodes.d.mts +2220 -0
  368. package/resources/qrcodes/qrcodes.d.mts.map +1 -0
  369. package/resources/qrcodes/qrcodes.d.ts +2220 -0
  370. package/resources/qrcodes/qrcodes.d.ts.map +1 -0
  371. package/resources/qrcodes/qrcodes.js +102 -0
  372. package/resources/qrcodes/qrcodes.js.map +1 -0
  373. package/resources/qrcodes/qrcodes.mjs +97 -0
  374. package/resources/qrcodes/qrcodes.mjs.map +1 -0
  375. package/resources/qrcodes.d.mts +2 -0
  376. package/resources/qrcodes.d.mts.map +1 -0
  377. package/resources/qrcodes.d.ts +2 -0
  378. package/resources/qrcodes.d.ts.map +1 -0
  379. package/resources/qrcodes.js +6 -0
  380. package/resources/qrcodes.js.map +1 -0
  381. package/resources/qrcodes.mjs +3 -0
  382. package/resources/qrcodes.mjs.map +1 -0
  383. package/resources/tags.d.mts +91 -0
  384. package/resources/tags.d.mts.map +1 -0
  385. package/resources/tags.d.ts +91 -0
  386. package/resources/tags.d.ts.map +1 -0
  387. package/resources/tags.js +35 -0
  388. package/resources/tags.js.map +1 -0
  389. package/resources/tags.mjs +31 -0
  390. package/resources/tags.mjs.map +1 -0
  391. package/resources/track.d.mts +128 -0
  392. package/resources/track.d.mts.map +1 -0
  393. package/resources/track.d.ts +128 -0
  394. package/resources/track.d.ts.map +1 -0
  395. package/resources/track.js +39 -0
  396. package/resources/track.js.map +1 -0
  397. package/resources/track.mjs +35 -0
  398. package/resources/track.mjs.map +1 -0
  399. package/resources.d.mts +2 -0
  400. package/resources.d.mts.map +1 -0
  401. package/resources.d.ts +2 -0
  402. package/resources.d.ts.map +1 -0
  403. package/resources.js +5 -0
  404. package/resources.js.map +1 -0
  405. package/resources.mjs +2 -0
  406. package/resources.mjs.map +1 -0
  407. package/src/api-promise.ts +2 -0
  408. package/src/client.ts +854 -0
  409. package/src/core/README.md +3 -0
  410. package/src/core/api-promise.ts +92 -0
  411. package/src/core/error.ts +130 -0
  412. package/src/core/resource.ts +11 -0
  413. package/src/core/uploads.ts +2 -0
  414. package/src/error.ts +2 -0
  415. package/src/index.ts +22 -0
  416. package/src/internal/README.md +3 -0
  417. package/src/internal/builtin-types.ts +93 -0
  418. package/src/internal/detect-platform.ts +196 -0
  419. package/src/internal/errors.ts +33 -0
  420. package/src/internal/headers.ts +97 -0
  421. package/src/internal/parse.ts +50 -0
  422. package/src/internal/qs/LICENSE.md +13 -0
  423. package/src/internal/qs/README.md +3 -0
  424. package/src/internal/qs/formats.ts +10 -0
  425. package/src/internal/qs/index.ts +13 -0
  426. package/src/internal/qs/stringify.ts +385 -0
  427. package/src/internal/qs/types.ts +71 -0
  428. package/src/internal/qs/utils.ts +265 -0
  429. package/src/internal/request-options.ts +91 -0
  430. package/src/internal/shim-types.ts +26 -0
  431. package/src/internal/shims.ts +107 -0
  432. package/src/internal/to-file.ts +154 -0
  433. package/src/internal/types.ts +95 -0
  434. package/src/internal/uploads.ts +187 -0
  435. package/src/internal/utils/base64.ts +40 -0
  436. package/src/internal/utils/bytes.ts +32 -0
  437. package/src/internal/utils/env.ts +18 -0
  438. package/src/internal/utils/log.ts +126 -0
  439. package/src/internal/utils/path.ts +88 -0
  440. package/src/internal/utils/sleep.ts +3 -0
  441. package/src/internal/utils/uuid.ts +17 -0
  442. package/src/internal/utils/values.ts +105 -0
  443. package/src/internal/utils.ts +8 -0
  444. package/src/lib/.keep +4 -0
  445. package/src/resource.ts +2 -0
  446. package/src/resources/analytics.ts +1617 -0
  447. package/src/resources/domains.ts +205 -0
  448. package/src/resources/events.ts +1026 -0
  449. package/src/resources/index.ts +62 -0
  450. package/src/resources/links/bulk.ts +782 -0
  451. package/src/resources/links/index.ts +22 -0
  452. package/src/resources/links/links.ts +3841 -0
  453. package/src/resources/links.ts +3 -0
  454. package/src/resources/projects.ts +150 -0
  455. package/src/resources/qrcodes/bulk.ts +908 -0
  456. package/src/resources/qrcodes/index.ts +22 -0
  457. package/src/resources/qrcodes/qrcodes.ts +3307 -0
  458. package/src/resources/qrcodes.ts +3 -0
  459. package/src/resources/tags.ts +128 -0
  460. package/src/resources/track.ts +163 -0
  461. package/src/resources.ts +1 -0
  462. package/src/tsconfig.json +11 -0
  463. package/src/uploads.ts +2 -0
  464. package/src/version.ts +1 -0
  465. package/uploads.d.mts +2 -0
  466. package/uploads.d.mts.map +1 -0
  467. package/uploads.d.ts +2 -0
  468. package/uploads.d.ts.map +1 -0
  469. package/uploads.js +6 -0
  470. package/uploads.js.map +1 -0
  471. package/uploads.mjs +2 -0
  472. package/uploads.mjs.map +1 -0
  473. package/version.d.mts +2 -0
  474. package/version.d.mts.map +1 -0
  475. package/version.d.ts +2 -0
  476. package/version.d.ts.map +1 -0
  477. package/version.js +5 -0
  478. package/version.js.map +1 -0
  479. package/version.mjs +2 -0
  480. package/version.mjs.map +1 -0
@@ -0,0 +1,2220 @@
1
+ import { APIResource } from "../../core/resource.js";
2
+ import * as TagsAPI from "../tags.js";
3
+ import * as BulkAPI from "./bulk.js";
4
+ import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from "./bulk.js";
5
+ import { APIPromise } from "../../core/api-promise.js";
6
+ import { RequestOptions } from "../../internal/request-options.js";
7
+ export declare class Qrcodes extends APIResource {
8
+ bulk: BulkAPI.Bulk;
9
+ /**
10
+ * Create a new QR Code for the authenticated workspace.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const qrCode = await client.qrcodes.create({ type: 'url' });
15
+ * ```
16
+ */
17
+ create(body: QrcodeCreateParams, options?: RequestOptions): APIPromise<QrCode>;
18
+ /**
19
+ * Retrieve the info for a QR Code.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const qrCode = await client.qrcodes.retrieve({
24
+ * domain: 'x',
25
+ * key: 'x',
26
+ * projectSlug: 'x',
27
+ * });
28
+ * ```
29
+ */
30
+ retrieve(query: QrcodeRetrieveParams, options?: RequestOptions): APIPromise<QrCode>;
31
+ /**
32
+ * Update a QR Code for the authenticated workspace. If there's no change, returns
33
+ * it as it is.
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * const qrCode = await client.qrcodes.update('qrcodeId');
38
+ * ```
39
+ */
40
+ update(qrcodeID: string, body?: QrcodeUpdateParams | null | undefined, options?: RequestOptions): APIPromise<QrCode>;
41
+ /**
42
+ * Retrieve a paginated list of QR Codes for the authenticated workspace.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * const qrCodes = await client.qrcodes.list();
47
+ * ```
48
+ */
49
+ list(query?: QrcodeListParams | null | undefined, options?: RequestOptions): APIPromise<QrcodeListResponse>;
50
+ /**
51
+ * Delete a QR Code for the authenticated workspace.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * const qrcode = await client.qrcodes.delete('qrcodeId');
56
+ * ```
57
+ */
58
+ delete(qrcodeID: string, options?: RequestOptions): APIPromise<QrcodeDeleteResponse>;
59
+ /**
60
+ * Retrieve the number of QR Codes for the authenticated workspace.
61
+ *
62
+ * @example
63
+ * ```ts
64
+ * const response = await client.qrcodes.count();
65
+ * ```
66
+ */
67
+ count(query?: QrcodeCountParams | null | undefined, options?: RequestOptions): APIPromise<QrcodeCountResponse>;
68
+ /**
69
+ * Upsert a QR Code for the authenticated workspace by its URL. If a QR Code with
70
+ * the same URL already exists, return it (or update it if there are any changes).
71
+ * Otherwise, a new QR Code will be created.
72
+ *
73
+ * @example
74
+ * ```ts
75
+ * const qrCode = await client.qrcodes.upsert({ type: 'url' });
76
+ * ```
77
+ */
78
+ upsert(body: QrcodeUpsertParams, options?: RequestOptions): APIPromise<QrCode>;
79
+ }
80
+ export interface QrCode {
81
+ /**
82
+ * The unique ID of the QR code.
83
+ */
84
+ id: string;
85
+ /**
86
+ * The destination URL for Android for the QR code for device targeting Android.
87
+ */
88
+ android: string | null;
89
+ /**
90
+ * If the QR code is archived.
91
+ */
92
+ archived: boolean;
93
+ /**
94
+ * The background color of the QR code.
95
+ */
96
+ bgColor: string;
97
+ /**
98
+ * The comments for the QR code.
99
+ */
100
+ comments: string | null;
101
+ /**
102
+ * The static content of the QR code.
103
+ */
104
+ contentStatic: string | null;
105
+ /**
106
+ * The date and time the QR code was created.
107
+ */
108
+ createdAt: string;
109
+ /**
110
+ * The cryptocurrency information of the QR code.
111
+ */
112
+ crypto: {
113
+ [key: string]: string;
114
+ } | null;
115
+ /**
116
+ * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
117
+ * used for custom link preview if `proxy` is true.
118
+ */
119
+ description: string | null;
120
+ /**
121
+ * If the QR code should be indexed.
122
+ */
123
+ doIndex: boolean;
124
+ /**
125
+ * The domain of the QR code. If not provided, the main domain of the project will
126
+ * be used (or `codeqr.link` if the project does not have domains).
127
+ */
128
+ domain: string;
129
+ /**
130
+ * The email information of the QR code.
131
+ */
132
+ email: {
133
+ [key: string]: string;
134
+ } | null;
135
+ /**
136
+ * If the QR code should be excavated.
137
+ */
138
+ excavate: boolean;
139
+ /**
140
+ * The destination URL when the QR code expires.
141
+ */
142
+ expiredUrl: string | null;
143
+ /**
144
+ * The date and time the QR code will expire in ISO-8601 format. Must be in the
145
+ * future.
146
+ */
147
+ expiresAt: string | null;
148
+ /**
149
+ * The external ID associated with the QR code.
150
+ */
151
+ externalId: string | null;
152
+ /**
153
+ * The FaceTime information of the QR code.
154
+ */
155
+ facetime: {
156
+ [key: string]: string;
157
+ } | null;
158
+ /**
159
+ * The foreground color of the QR code.
160
+ */
161
+ fgColor: string;
162
+ /**
163
+ * If the QR code is filled.
164
+ */
165
+ filled: boolean;
166
+ /**
167
+ * If the QR code is flexible.
168
+ */
169
+ flexible: boolean;
170
+ /**
171
+ * Geographic segmentation information for the QR code in the JSON format
172
+ * `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
173
+ */
174
+ geo: {
175
+ [key: string]: string;
176
+ } | null;
177
+ /**
178
+ * The height of the QR code.
179
+ */
180
+ height: number;
181
+ /**
182
+ * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
183
+ * for custom link preview if `proxy` is true.
184
+ */
185
+ image: string | null;
186
+ /**
187
+ * The destination URL for iOS for the QR code for device targeting iOS.
188
+ */
189
+ ios: string | null;
190
+ /**
191
+ * If the form is mandatory for the page.
192
+ */
193
+ isFormMandatory: boolean;
194
+ /**
195
+ * The slug of the QR code. If not provided, a random slug of 7 characters will be
196
+ * generated.
197
+ */
198
+ key: string;
199
+ /**
200
+ * The date and time the QR code was scanned last.
201
+ */
202
+ lastClicked: string | null;
203
+ /**
204
+ * The latitude and longitude information of the QR code.
205
+ */
206
+ latlog: {
207
+ [key: string]: string;
208
+ } | null;
209
+ /**
210
+ * The number of leads generated by the QR code.
211
+ */
212
+ leads: number;
213
+ /**
214
+ * The level of error correction of the QR code.
215
+ */
216
+ level: string;
217
+ /**
218
+ * The logo of the QR code.
219
+ */
220
+ logo: string | null;
221
+ /**
222
+ * The notification token of the QR code.
223
+ */
224
+ notificationToken: string | null;
225
+ /**
226
+ * The password required to access the destination URL of the QR code.
227
+ */
228
+ password: string | null;
229
+ /**
230
+ * The phone number of the QR code.
231
+ */
232
+ phone: string | null;
233
+ /**
234
+ * If the QR code has pre-redirection.
235
+ */
236
+ preRedirection: boolean;
237
+ /**
238
+ * The ID of the project of the QR code.
239
+ */
240
+ projectId: string | null;
241
+ /**
242
+ * If the QR code uses the custom link preview feature.
243
+ */
244
+ proxy: boolean;
245
+ /**
246
+ * If the statistics of the QR code are publicly accessible.
247
+ */
248
+ publicStats: boolean;
249
+ /**
250
+ * If the QR code uses link cloaking.
251
+ */
252
+ rewrite: boolean;
253
+ /**
254
+ * The amount of the sale generated by the link.
255
+ */
256
+ saleAmount: number;
257
+ /**
258
+ * The number of sales generated by the QR code.
259
+ */
260
+ sales: number;
261
+ /**
262
+ * The number of scans of the QR code.
263
+ */
264
+ scans: number;
265
+ /**
266
+ * If the logo should be displayed in the QR code.
267
+ */
268
+ showLogo: boolean;
269
+ /**
270
+ * The size of the QR code.
271
+ */
272
+ size: number;
273
+ /**
274
+ * The SMS information of the QR code.
275
+ */
276
+ sms: {
277
+ [key: string]: string;
278
+ } | null;
279
+ /**
280
+ * The source of the QR code.
281
+ */
282
+ src: string | null;
283
+ /**
284
+ * If the QR code is static.
285
+ */
286
+ static: boolean;
287
+ /**
288
+ * @deprecated [DEPRECATED (use `tags` instead)]: The unique ID of the tag assigned
289
+ * to the QR code.
290
+ */
291
+ tagId: string | null;
292
+ /**
293
+ * The tags assigned to the QR code.
294
+ */
295
+ tags: Array<TagsAPI.Tag> | null;
296
+ /**
297
+ * The text of the QR code.
298
+ */
299
+ text: string | null;
300
+ /**
301
+ * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
302
+ * for custom link preview if `proxy` is true.
303
+ */
304
+ title: string | null;
305
+ /**
306
+ * [BETA] If should track conversions for the QR code.
307
+ */
308
+ trackConversion: boolean;
309
+ /**
310
+ * The type of the QR code.
311
+ */
312
+ type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog' | 'pix';
313
+ /**
314
+ * The date and time the QR code was updated last.
315
+ */
316
+ updatedAt: string;
317
+ /**
318
+ * The URL of the QR code.
319
+ */
320
+ url: string | null;
321
+ /**
322
+ * The ID of the user that created the QR code.
323
+ */
324
+ userId: string | null;
325
+ /**
326
+ * The campaign UTM of the QR code.
327
+ */
328
+ utm_campaign: string | null;
329
+ /**
330
+ * The content UTM of the QR code.
331
+ */
332
+ utm_content: string | null;
333
+ /**
334
+ * The medium UTM of the QR code.
335
+ */
336
+ utm_medium: string | null;
337
+ /**
338
+ * The source UTM of the QR code.
339
+ */
340
+ utm_source: string | null;
341
+ /**
342
+ * The term UTM of the QR code.
343
+ */
344
+ utm_term: string | null;
345
+ /**
346
+ * The vCard information of the QR code.
347
+ */
348
+ vcard: {
349
+ [key: string]: string;
350
+ } | null;
351
+ /**
352
+ * The width of the QR code.
353
+ */
354
+ width: number;
355
+ /**
356
+ * The WiFi information of the QR code.
357
+ */
358
+ wifi: {
359
+ [key: string]: string;
360
+ } | null;
361
+ /**
362
+ * The ID of the page to redirect to before the QR code destination.
363
+ */
364
+ pageId?: string | null;
365
+ /**
366
+ * The URL of the page to redirect to before the QR code destination.
367
+ */
368
+ pageUrl?: string | null;
369
+ }
370
+ export type QrcodeListResponse = Array<QrCode>;
371
+ export interface QrcodeDeleteResponse {
372
+ /**
373
+ * The ID of the QR Code.
374
+ */
375
+ id: string;
376
+ }
377
+ /**
378
+ * The number of QR Codes matching the query.
379
+ */
380
+ export type QrcodeCountResponse = number;
381
+ export interface QrcodeCreateParams {
382
+ /**
383
+ * The type of content of the QR code.
384
+ */
385
+ type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
386
+ /**
387
+ * The destination URL for Android for the QR code for device targeting Android.
388
+ */
389
+ android?: string | null;
390
+ /**
391
+ * If the QR code is archived.
392
+ */
393
+ archived?: boolean;
394
+ /**
395
+ * The background color of the QR code.
396
+ */
397
+ bgColor?: string;
398
+ /**
399
+ * The comments for the QR code.
400
+ */
401
+ comments?: string | null;
402
+ /**
403
+ * The static content of the QR code.
404
+ */
405
+ contentStatic?: string | null;
406
+ /**
407
+ * The cryptocurrency information of the QR code.
408
+ */
409
+ crypto?: {
410
+ [key: string]: string;
411
+ } | null;
412
+ /**
413
+ * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
414
+ * used for custom link preview if `proxy` is true.
415
+ */
416
+ description?: string | null;
417
+ /**
418
+ * Allow search engines to index your QR code. The default is `false` if not
419
+ * provided. Learn more: https://codeqr.link/noindex
420
+ */
421
+ doIndex?: boolean;
422
+ /**
423
+ * The domain of the QR code. If not provided, the main domain of the project will
424
+ * be used (or `codeqr.link` if the project does not have domains).
425
+ */
426
+ domain?: string;
427
+ /**
428
+ * The email information of the QR code.
429
+ */
430
+ email?: {
431
+ [key: string]: string;
432
+ } | null;
433
+ /**
434
+ * If the QR code should have excavated areas.
435
+ */
436
+ excavate?: boolean;
437
+ /**
438
+ * The URL to redirect when the QR code expires.
439
+ */
440
+ expiredUrl?: string | null;
441
+ /**
442
+ * The date and time the QR code will expire in ISO-8601 format. Must be in the
443
+ * future.
444
+ */
445
+ expiresAt?: string | null;
446
+ /**
447
+ * This is the ID of the QR code in your database. If defined, it can be used to
448
+ * identify the QR code in the future. It must be prefixed with `ext_` when passed
449
+ * as a query parameter.
450
+ */
451
+ externalId?: string | null;
452
+ /**
453
+ * The FaceTime information of the QR code.
454
+ */
455
+ facetime?: {
456
+ [key: string]: string;
457
+ } | null;
458
+ /**
459
+ * The foreground color of the QR code.
460
+ */
461
+ fgColor?: string;
462
+ /**
463
+ * If the QR code is filled.
464
+ */
465
+ filled?: boolean;
466
+ /**
467
+ * If the QR code is flexible.
468
+ */
469
+ flexible?: boolean;
470
+ /**
471
+ * The type of frame of the QR code.
472
+ */
473
+ frame?: string;
474
+ /**
475
+ * The color of the frame of the QR code.
476
+ */
477
+ frameColor?: string;
478
+ /**
479
+ * The text of the frame of the QR code.
480
+ */
481
+ frameText?: string;
482
+ /**
483
+ * Geographic segmentation information for the QR code in the JSON format
484
+ * `{[COUNTRY]: https://example.com }`.
485
+ */
486
+ geo?: QrcodeCreateParams.Geo | null;
487
+ /**
488
+ * The height of the QR code.
489
+ */
490
+ height?: number;
491
+ /**
492
+ * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
493
+ * for custom link preview if `proxy` is true.
494
+ */
495
+ image?: string | null;
496
+ /**
497
+ * The destination URL for iOS for the QR code for device targeting iOS.
498
+ */
499
+ ios?: string | null;
500
+ /**
501
+ * If the form is mandatory for the page.
502
+ */
503
+ isFormMandatory?: boolean;
504
+ /**
505
+ * The slug of the QR code. If not provided, a random slug of 7 characters will be
506
+ * generated.
507
+ */
508
+ key?: string;
509
+ /**
510
+ * The latitude and longitude information of the QR code.
511
+ */
512
+ latlog?: {
513
+ [key: string]: string;
514
+ } | null;
515
+ /**
516
+ * The level of error correction of the QR code.
517
+ */
518
+ level?: string;
519
+ /**
520
+ * The logo of the QR code.
521
+ */
522
+ logo?: string | null;
523
+ /**
524
+ * The ID of the page to redirect to before the QR code destination.
525
+ */
526
+ pageId?: string | null;
527
+ /**
528
+ * The URL of the page to redirect to before the QR code destination.
529
+ */
530
+ pageUrl?: string | null;
531
+ /**
532
+ * The password required to access the destination URL of the QR code.
533
+ */
534
+ password?: string | null;
535
+ /**
536
+ * The pattern of the modules of the QR code.
537
+ */
538
+ pattern?: string;
539
+ /**
540
+ * The phone number of the QR code.
541
+ */
542
+ phone?: string | null;
543
+ /**
544
+ * If the QR code has pre-redirection.
545
+ */
546
+ preRedirection?: boolean;
547
+ /**
548
+ * If the QR code uses the custom link preview feature.
549
+ */
550
+ proxy?: boolean;
551
+ /**
552
+ * If the statistics of the QR code are publicly accessible.
553
+ */
554
+ publicStats?: boolean;
555
+ /**
556
+ * If the QR code uses link cloaking.
557
+ */
558
+ rewrite?: boolean;
559
+ /**
560
+ * The shape of the design around the QR code (none, square, circle).
561
+ */
562
+ shape?: string;
563
+ /**
564
+ * If the logo should be displayed in the QR code.
565
+ */
566
+ showLogo?: boolean;
567
+ /**
568
+ * The size of the QR code.
569
+ */
570
+ size?: number;
571
+ /**
572
+ * The SMS information of the QR code.
573
+ */
574
+ sms?: {
575
+ [key: string]: string;
576
+ } | null;
577
+ /**
578
+ * The image URL of the QR code.
579
+ */
580
+ src?: string | null;
581
+ /**
582
+ * If the QR code is static.
583
+ */
584
+ static?: boolean;
585
+ /**
586
+ * @deprecated The unique ID of the tag assigned to the QR code. This field is
587
+ * deprecated – use `tagIds` instead.
588
+ */
589
+ tagId?: string | null;
590
+ /**
591
+ * The unique IDs of the tags assigned to the QR code.
592
+ */
593
+ tagIds?: string | Array<string>;
594
+ /**
595
+ * The unique name of the tags assigned to the QR code (case insensitive).
596
+ */
597
+ tagNames?: string | Array<string>;
598
+ /**
599
+ * The text of the QR code.
600
+ */
601
+ text?: string | null;
602
+ /**
603
+ * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
604
+ * for custom link preview if `proxy` is true.
605
+ */
606
+ title?: string | null;
607
+ /**
608
+ * If should track conversions for the QR code.
609
+ */
610
+ trackConversion?: boolean;
611
+ /**
612
+ * The destination URL of the QR code.
613
+ */
614
+ url?: string | null;
615
+ /**
616
+ * The vCard information of the QR code.
617
+ */
618
+ vcard?: {
619
+ [key: string]: string;
620
+ } | null;
621
+ /**
622
+ * An array of webhook IDs to trigger when the link is clicked. These webhooks will
623
+ * receive click event data.
624
+ */
625
+ webhookIds?: Array<string> | null;
626
+ /**
627
+ * The width of the QR code.
628
+ */
629
+ width?: number;
630
+ /**
631
+ * The WiFi information of the QR code.
632
+ */
633
+ wifi?: {
634
+ [key: string]: string;
635
+ } | null;
636
+ }
637
+ export declare namespace QrcodeCreateParams {
638
+ /**
639
+ * Geographic segmentation information for the QR code in the JSON format
640
+ * `{[COUNTRY]: https://example.com }`.
641
+ */
642
+ interface Geo {
643
+ AD?: string;
644
+ AE?: string;
645
+ AF?: string;
646
+ AG?: string;
647
+ AI?: string;
648
+ AL?: string;
649
+ AM?: string;
650
+ AO?: string;
651
+ AQ?: string;
652
+ AR?: string;
653
+ AS?: string;
654
+ AT?: string;
655
+ AU?: string;
656
+ AW?: string;
657
+ AX?: string;
658
+ AZ?: string;
659
+ BA?: string;
660
+ BB?: string;
661
+ BD?: string;
662
+ BE?: string;
663
+ BF?: string;
664
+ BG?: string;
665
+ BH?: string;
666
+ BI?: string;
667
+ BJ?: string;
668
+ BL?: string;
669
+ BM?: string;
670
+ BN?: string;
671
+ BO?: string;
672
+ BQ?: string;
673
+ BR?: string;
674
+ BS?: string;
675
+ BT?: string;
676
+ BV?: string;
677
+ BW?: string;
678
+ BY?: string;
679
+ BZ?: string;
680
+ CA?: string;
681
+ CC?: string;
682
+ CD?: string;
683
+ CF?: string;
684
+ CG?: string;
685
+ CH?: string;
686
+ CI?: string;
687
+ CK?: string;
688
+ CL?: string;
689
+ CM?: string;
690
+ CN?: string;
691
+ CO?: string;
692
+ CR?: string;
693
+ CU?: string;
694
+ CV?: string;
695
+ CW?: string;
696
+ CX?: string;
697
+ CY?: string;
698
+ CZ?: string;
699
+ DE?: string;
700
+ DJ?: string;
701
+ DK?: string;
702
+ DM?: string;
703
+ DO?: string;
704
+ DZ?: string;
705
+ EC?: string;
706
+ EE?: string;
707
+ EG?: string;
708
+ EH?: string;
709
+ ER?: string;
710
+ ES?: string;
711
+ ET?: string;
712
+ FI?: string;
713
+ FJ?: string;
714
+ FK?: string;
715
+ FM?: string;
716
+ FO?: string;
717
+ FR?: string;
718
+ GA?: string;
719
+ GB?: string;
720
+ GD?: string;
721
+ GE?: string;
722
+ GF?: string;
723
+ GG?: string;
724
+ GH?: string;
725
+ GI?: string;
726
+ GL?: string;
727
+ GM?: string;
728
+ GN?: string;
729
+ GP?: string;
730
+ GQ?: string;
731
+ GR?: string;
732
+ GS?: string;
733
+ GT?: string;
734
+ GU?: string;
735
+ GW?: string;
736
+ GY?: string;
737
+ HK?: string;
738
+ HM?: string;
739
+ HN?: string;
740
+ HR?: string;
741
+ HT?: string;
742
+ HU?: string;
743
+ ID?: string;
744
+ IE?: string;
745
+ IL?: string;
746
+ IM?: string;
747
+ IN?: string;
748
+ IO?: string;
749
+ IQ?: string;
750
+ IR?: string;
751
+ IS?: string;
752
+ IT?: string;
753
+ JE?: string;
754
+ JM?: string;
755
+ JO?: string;
756
+ JP?: string;
757
+ KE?: string;
758
+ KG?: string;
759
+ KH?: string;
760
+ KI?: string;
761
+ KM?: string;
762
+ KN?: string;
763
+ KP?: string;
764
+ KR?: string;
765
+ KW?: string;
766
+ KY?: string;
767
+ KZ?: string;
768
+ LA?: string;
769
+ LB?: string;
770
+ LC?: string;
771
+ LI?: string;
772
+ LK?: string;
773
+ LR?: string;
774
+ LS?: string;
775
+ LT?: string;
776
+ LU?: string;
777
+ LV?: string;
778
+ LY?: string;
779
+ MA?: string;
780
+ MC?: string;
781
+ MD?: string;
782
+ ME?: string;
783
+ MF?: string;
784
+ MG?: string;
785
+ MH?: string;
786
+ MK?: string;
787
+ ML?: string;
788
+ MM?: string;
789
+ MN?: string;
790
+ MO?: string;
791
+ MP?: string;
792
+ MQ?: string;
793
+ MR?: string;
794
+ MS?: string;
795
+ MT?: string;
796
+ MU?: string;
797
+ MV?: string;
798
+ MW?: string;
799
+ MX?: string;
800
+ MY?: string;
801
+ MZ?: string;
802
+ NA?: string;
803
+ NC?: string;
804
+ NE?: string;
805
+ NF?: string;
806
+ NG?: string;
807
+ NI?: string;
808
+ NL?: string;
809
+ NO?: string;
810
+ NP?: string;
811
+ NR?: string;
812
+ NU?: string;
813
+ NZ?: string;
814
+ OM?: string;
815
+ PA?: string;
816
+ PE?: string;
817
+ PF?: string;
818
+ PG?: string;
819
+ PH?: string;
820
+ PK?: string;
821
+ PL?: string;
822
+ PM?: string;
823
+ PN?: string;
824
+ PR?: string;
825
+ PS?: string;
826
+ PT?: string;
827
+ PW?: string;
828
+ PY?: string;
829
+ QA?: string;
830
+ RE?: string;
831
+ RO?: string;
832
+ RS?: string;
833
+ RU?: string;
834
+ RW?: string;
835
+ SA?: string;
836
+ SB?: string;
837
+ SC?: string;
838
+ SD?: string;
839
+ SE?: string;
840
+ SG?: string;
841
+ SH?: string;
842
+ SI?: string;
843
+ SJ?: string;
844
+ SK?: string;
845
+ SL?: string;
846
+ SM?: string;
847
+ SN?: string;
848
+ SO?: string;
849
+ SR?: string;
850
+ SS?: string;
851
+ ST?: string;
852
+ SV?: string;
853
+ SX?: string;
854
+ SY?: string;
855
+ SZ?: string;
856
+ TC?: string;
857
+ TD?: string;
858
+ TF?: string;
859
+ TG?: string;
860
+ TH?: string;
861
+ TJ?: string;
862
+ TK?: string;
863
+ TL?: string;
864
+ TM?: string;
865
+ TN?: string;
866
+ TO?: string;
867
+ TR?: string;
868
+ TT?: string;
869
+ TV?: string;
870
+ TW?: string;
871
+ TZ?: string;
872
+ UA?: string;
873
+ UG?: string;
874
+ UM?: string;
875
+ US?: string;
876
+ UY?: string;
877
+ UZ?: string;
878
+ VA?: string;
879
+ VC?: string;
880
+ VE?: string;
881
+ VG?: string;
882
+ VI?: string;
883
+ VN?: string;
884
+ VU?: string;
885
+ WF?: string;
886
+ WS?: string;
887
+ XK?: string;
888
+ YE?: string;
889
+ YT?: string;
890
+ ZA?: string;
891
+ ZM?: string;
892
+ ZW?: string;
893
+ }
894
+ }
895
+ export interface QrcodeRetrieveParams {
896
+ /**
897
+ * The domain of the QR code to be retrieved. For example, for
898
+ * `codeqr.link/github`, the domain is `codeqr.link`.
899
+ */
900
+ domain: string;
901
+ /**
902
+ * The key of the QR code to be retrieved. For example, for `codeqr.link/github`,
903
+ * the key is `github`.
904
+ */
905
+ key: string;
906
+ /**
907
+ * The slug of the project to which the QR code belongs. For example, for
908
+ * `app.codeqr.io/acme`, the projectSlug is `acme`.
909
+ */
910
+ projectSlug: string;
911
+ /**
912
+ * This is the ID of the QR code in your database. It must be prefixed with `ext_`
913
+ * when passed as a query parameter.
914
+ */
915
+ externalId?: string;
916
+ /**
917
+ * The unique ID of the QR code.
918
+ */
919
+ qrCodeId?: string;
920
+ }
921
+ export interface QrcodeUpdateParams {
922
+ /**
923
+ * The destination URL for Android for the QR code for device targeting Android.
924
+ */
925
+ android?: string | null;
926
+ /**
927
+ * If the QR code is archived.
928
+ */
929
+ archived?: boolean;
930
+ /**
931
+ * The background color of the QR code.
932
+ */
933
+ bgColor?: string;
934
+ /**
935
+ * The comments for the QR code.
936
+ */
937
+ comments?: string | null;
938
+ /**
939
+ * The static content of the QR code.
940
+ */
941
+ contentStatic?: string | null;
942
+ /**
943
+ * The cryptocurrency information of the QR code.
944
+ */
945
+ crypto?: {
946
+ [key: string]: string;
947
+ } | null;
948
+ /**
949
+ * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
950
+ * used for custom link preview if `proxy` is true.
951
+ */
952
+ description?: string | null;
953
+ /**
954
+ * Allow search engines to index your QR code. The default is `false` if not
955
+ * provided. Learn more: https://codeqr.link/noindex
956
+ */
957
+ doIndex?: boolean;
958
+ /**
959
+ * The domain of the QR code. If not provided, the main domain of the project will
960
+ * be used (or `codeqr.link` if the project does not have domains).
961
+ */
962
+ domain?: string;
963
+ /**
964
+ * The email information of the QR code.
965
+ */
966
+ email?: {
967
+ [key: string]: string;
968
+ } | null;
969
+ /**
970
+ * If the QR code should have excavated areas.
971
+ */
972
+ excavate?: boolean;
973
+ /**
974
+ * The URL to redirect when the QR code expires.
975
+ */
976
+ expiredUrl?: string | null;
977
+ /**
978
+ * The date and time the QR code will expire in ISO-8601 format. Must be in the
979
+ * future.
980
+ */
981
+ expiresAt?: string | null;
982
+ /**
983
+ * This is the ID of the QR code in your database. If defined, it can be used to
984
+ * identify the QR code in the future. It must be prefixed with `ext_` when passed
985
+ * as a query parameter.
986
+ */
987
+ externalId?: string | null;
988
+ /**
989
+ * The FaceTime information of the QR code.
990
+ */
991
+ facetime?: {
992
+ [key: string]: string;
993
+ } | null;
994
+ /**
995
+ * The foreground color of the QR code.
996
+ */
997
+ fgColor?: string;
998
+ /**
999
+ * If the QR code is filled.
1000
+ */
1001
+ filled?: boolean;
1002
+ /**
1003
+ * If the QR code is flexible.
1004
+ */
1005
+ flexible?: boolean;
1006
+ /**
1007
+ * The type of frame of the QR code.
1008
+ */
1009
+ frame?: string;
1010
+ /**
1011
+ * The color of the frame of the QR code.
1012
+ */
1013
+ frameColor?: string;
1014
+ /**
1015
+ * The text of the frame of the QR code.
1016
+ */
1017
+ frameText?: string;
1018
+ /**
1019
+ * Geographic segmentation information for the QR code in the JSON format
1020
+ * `{[COUNTRY]: https://example.com }`.
1021
+ */
1022
+ geo?: QrcodeUpdateParams.Geo | null;
1023
+ /**
1024
+ * The height of the QR code.
1025
+ */
1026
+ height?: number;
1027
+ /**
1028
+ * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
1029
+ * for custom link preview if `proxy` is true.
1030
+ */
1031
+ image?: string | null;
1032
+ /**
1033
+ * The destination URL for iOS for the QR code for device targeting iOS.
1034
+ */
1035
+ ios?: string | null;
1036
+ /**
1037
+ * If the form is mandatory for the page.
1038
+ */
1039
+ isFormMandatory?: boolean;
1040
+ /**
1041
+ * The slug of the QR code. If not provided, a random slug of 7 characters will be
1042
+ * generated.
1043
+ */
1044
+ key?: string;
1045
+ /**
1046
+ * The latitude and longitude information of the QR code.
1047
+ */
1048
+ latlog?: {
1049
+ [key: string]: string;
1050
+ } | null;
1051
+ /**
1052
+ * The level of error correction of the QR code.
1053
+ */
1054
+ level?: string;
1055
+ /**
1056
+ * The logo of the QR code.
1057
+ */
1058
+ logo?: string | null;
1059
+ /**
1060
+ * The ID of the page to redirect to before the QR code destination.
1061
+ */
1062
+ pageId?: string | null;
1063
+ /**
1064
+ * The URL of the page to redirect to before the QR code destination.
1065
+ */
1066
+ pageUrl?: string | null;
1067
+ /**
1068
+ * The password required to access the destination URL of the QR code.
1069
+ */
1070
+ password?: string | null;
1071
+ /**
1072
+ * The pattern of the modules of the QR code.
1073
+ */
1074
+ pattern?: string;
1075
+ /**
1076
+ * The phone number of the QR code.
1077
+ */
1078
+ phone?: string | null;
1079
+ /**
1080
+ * If the QR code has pre-redirection.
1081
+ */
1082
+ preRedirection?: boolean;
1083
+ /**
1084
+ * If the QR code uses the custom link preview feature.
1085
+ */
1086
+ proxy?: boolean;
1087
+ /**
1088
+ * If the statistics of the QR code are publicly accessible.
1089
+ */
1090
+ publicStats?: boolean;
1091
+ /**
1092
+ * If the QR code uses link cloaking.
1093
+ */
1094
+ rewrite?: boolean;
1095
+ /**
1096
+ * The shape of the design around the QR code (none, square, circle).
1097
+ */
1098
+ shape?: string;
1099
+ /**
1100
+ * If the logo should be displayed in the QR code.
1101
+ */
1102
+ showLogo?: boolean;
1103
+ /**
1104
+ * The size of the QR code.
1105
+ */
1106
+ size?: number;
1107
+ /**
1108
+ * The SMS information of the QR code.
1109
+ */
1110
+ sms?: {
1111
+ [key: string]: string;
1112
+ } | null;
1113
+ /**
1114
+ * The image URL of the QR code.
1115
+ */
1116
+ src?: string | null;
1117
+ /**
1118
+ * If the QR code is static.
1119
+ */
1120
+ static?: boolean;
1121
+ /**
1122
+ * @deprecated The unique ID of the tag assigned to the QR code. This field is
1123
+ * deprecated – use `tagIds` instead.
1124
+ */
1125
+ tagId?: string | null;
1126
+ /**
1127
+ * The unique IDs of the tags assigned to the QR code.
1128
+ */
1129
+ tagIds?: string | Array<string>;
1130
+ /**
1131
+ * The unique name of the tags assigned to the QR code (case insensitive).
1132
+ */
1133
+ tagNames?: string | Array<string>;
1134
+ /**
1135
+ * The text of the QR code.
1136
+ */
1137
+ text?: string | null;
1138
+ /**
1139
+ * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
1140
+ * for custom link preview if `proxy` is true.
1141
+ */
1142
+ title?: string | null;
1143
+ /**
1144
+ * If should track conversions for the QR code.
1145
+ */
1146
+ trackConversion?: boolean;
1147
+ /**
1148
+ * The type of content of the QR code.
1149
+ */
1150
+ type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
1151
+ /**
1152
+ * The destination URL of the QR code.
1153
+ */
1154
+ url?: string | null;
1155
+ /**
1156
+ * The vCard information of the QR code.
1157
+ */
1158
+ vcard?: {
1159
+ [key: string]: string;
1160
+ } | null;
1161
+ /**
1162
+ * An array of webhook IDs to trigger when the link is clicked. These webhooks will
1163
+ * receive click event data.
1164
+ */
1165
+ webhookIds?: Array<string> | null;
1166
+ /**
1167
+ * The width of the QR code.
1168
+ */
1169
+ width?: number;
1170
+ /**
1171
+ * The WiFi information of the QR code.
1172
+ */
1173
+ wifi?: {
1174
+ [key: string]: string;
1175
+ } | null;
1176
+ }
1177
+ export declare namespace QrcodeUpdateParams {
1178
+ /**
1179
+ * Geographic segmentation information for the QR code in the JSON format
1180
+ * `{[COUNTRY]: https://example.com }`.
1181
+ */
1182
+ interface Geo {
1183
+ AD?: string;
1184
+ AE?: string;
1185
+ AF?: string;
1186
+ AG?: string;
1187
+ AI?: string;
1188
+ AL?: string;
1189
+ AM?: string;
1190
+ AO?: string;
1191
+ AQ?: string;
1192
+ AR?: string;
1193
+ AS?: string;
1194
+ AT?: string;
1195
+ AU?: string;
1196
+ AW?: string;
1197
+ AX?: string;
1198
+ AZ?: string;
1199
+ BA?: string;
1200
+ BB?: string;
1201
+ BD?: string;
1202
+ BE?: string;
1203
+ BF?: string;
1204
+ BG?: string;
1205
+ BH?: string;
1206
+ BI?: string;
1207
+ BJ?: string;
1208
+ BL?: string;
1209
+ BM?: string;
1210
+ BN?: string;
1211
+ BO?: string;
1212
+ BQ?: string;
1213
+ BR?: string;
1214
+ BS?: string;
1215
+ BT?: string;
1216
+ BV?: string;
1217
+ BW?: string;
1218
+ BY?: string;
1219
+ BZ?: string;
1220
+ CA?: string;
1221
+ CC?: string;
1222
+ CD?: string;
1223
+ CF?: string;
1224
+ CG?: string;
1225
+ CH?: string;
1226
+ CI?: string;
1227
+ CK?: string;
1228
+ CL?: string;
1229
+ CM?: string;
1230
+ CN?: string;
1231
+ CO?: string;
1232
+ CR?: string;
1233
+ CU?: string;
1234
+ CV?: string;
1235
+ CW?: string;
1236
+ CX?: string;
1237
+ CY?: string;
1238
+ CZ?: string;
1239
+ DE?: string;
1240
+ DJ?: string;
1241
+ DK?: string;
1242
+ DM?: string;
1243
+ DO?: string;
1244
+ DZ?: string;
1245
+ EC?: string;
1246
+ EE?: string;
1247
+ EG?: string;
1248
+ EH?: string;
1249
+ ER?: string;
1250
+ ES?: string;
1251
+ ET?: string;
1252
+ FI?: string;
1253
+ FJ?: string;
1254
+ FK?: string;
1255
+ FM?: string;
1256
+ FO?: string;
1257
+ FR?: string;
1258
+ GA?: string;
1259
+ GB?: string;
1260
+ GD?: string;
1261
+ GE?: string;
1262
+ GF?: string;
1263
+ GG?: string;
1264
+ GH?: string;
1265
+ GI?: string;
1266
+ GL?: string;
1267
+ GM?: string;
1268
+ GN?: string;
1269
+ GP?: string;
1270
+ GQ?: string;
1271
+ GR?: string;
1272
+ GS?: string;
1273
+ GT?: string;
1274
+ GU?: string;
1275
+ GW?: string;
1276
+ GY?: string;
1277
+ HK?: string;
1278
+ HM?: string;
1279
+ HN?: string;
1280
+ HR?: string;
1281
+ HT?: string;
1282
+ HU?: string;
1283
+ ID?: string;
1284
+ IE?: string;
1285
+ IL?: string;
1286
+ IM?: string;
1287
+ IN?: string;
1288
+ IO?: string;
1289
+ IQ?: string;
1290
+ IR?: string;
1291
+ IS?: string;
1292
+ IT?: string;
1293
+ JE?: string;
1294
+ JM?: string;
1295
+ JO?: string;
1296
+ JP?: string;
1297
+ KE?: string;
1298
+ KG?: string;
1299
+ KH?: string;
1300
+ KI?: string;
1301
+ KM?: string;
1302
+ KN?: string;
1303
+ KP?: string;
1304
+ KR?: string;
1305
+ KW?: string;
1306
+ KY?: string;
1307
+ KZ?: string;
1308
+ LA?: string;
1309
+ LB?: string;
1310
+ LC?: string;
1311
+ LI?: string;
1312
+ LK?: string;
1313
+ LR?: string;
1314
+ LS?: string;
1315
+ LT?: string;
1316
+ LU?: string;
1317
+ LV?: string;
1318
+ LY?: string;
1319
+ MA?: string;
1320
+ MC?: string;
1321
+ MD?: string;
1322
+ ME?: string;
1323
+ MF?: string;
1324
+ MG?: string;
1325
+ MH?: string;
1326
+ MK?: string;
1327
+ ML?: string;
1328
+ MM?: string;
1329
+ MN?: string;
1330
+ MO?: string;
1331
+ MP?: string;
1332
+ MQ?: string;
1333
+ MR?: string;
1334
+ MS?: string;
1335
+ MT?: string;
1336
+ MU?: string;
1337
+ MV?: string;
1338
+ MW?: string;
1339
+ MX?: string;
1340
+ MY?: string;
1341
+ MZ?: string;
1342
+ NA?: string;
1343
+ NC?: string;
1344
+ NE?: string;
1345
+ NF?: string;
1346
+ NG?: string;
1347
+ NI?: string;
1348
+ NL?: string;
1349
+ NO?: string;
1350
+ NP?: string;
1351
+ NR?: string;
1352
+ NU?: string;
1353
+ NZ?: string;
1354
+ OM?: string;
1355
+ PA?: string;
1356
+ PE?: string;
1357
+ PF?: string;
1358
+ PG?: string;
1359
+ PH?: string;
1360
+ PK?: string;
1361
+ PL?: string;
1362
+ PM?: string;
1363
+ PN?: string;
1364
+ PR?: string;
1365
+ PS?: string;
1366
+ PT?: string;
1367
+ PW?: string;
1368
+ PY?: string;
1369
+ QA?: string;
1370
+ RE?: string;
1371
+ RO?: string;
1372
+ RS?: string;
1373
+ RU?: string;
1374
+ RW?: string;
1375
+ SA?: string;
1376
+ SB?: string;
1377
+ SC?: string;
1378
+ SD?: string;
1379
+ SE?: string;
1380
+ SG?: string;
1381
+ SH?: string;
1382
+ SI?: string;
1383
+ SJ?: string;
1384
+ SK?: string;
1385
+ SL?: string;
1386
+ SM?: string;
1387
+ SN?: string;
1388
+ SO?: string;
1389
+ SR?: string;
1390
+ SS?: string;
1391
+ ST?: string;
1392
+ SV?: string;
1393
+ SX?: string;
1394
+ SY?: string;
1395
+ SZ?: string;
1396
+ TC?: string;
1397
+ TD?: string;
1398
+ TF?: string;
1399
+ TG?: string;
1400
+ TH?: string;
1401
+ TJ?: string;
1402
+ TK?: string;
1403
+ TL?: string;
1404
+ TM?: string;
1405
+ TN?: string;
1406
+ TO?: string;
1407
+ TR?: string;
1408
+ TT?: string;
1409
+ TV?: string;
1410
+ TW?: string;
1411
+ TZ?: string;
1412
+ UA?: string;
1413
+ UG?: string;
1414
+ UM?: string;
1415
+ US?: string;
1416
+ UY?: string;
1417
+ UZ?: string;
1418
+ VA?: string;
1419
+ VC?: string;
1420
+ VE?: string;
1421
+ VG?: string;
1422
+ VI?: string;
1423
+ VN?: string;
1424
+ VU?: string;
1425
+ WF?: string;
1426
+ WS?: string;
1427
+ XK?: string;
1428
+ YE?: string;
1429
+ YT?: string;
1430
+ ZA?: string;
1431
+ ZM?: string;
1432
+ ZW?: string;
1433
+ }
1434
+ }
1435
+ export interface QrcodeListParams {
1436
+ /**
1437
+ * The comments to filter by.
1438
+ */
1439
+ comments?: string;
1440
+ /**
1441
+ * Filter QR codes created after this date
1442
+ */
1443
+ createdAfter?: string;
1444
+ /**
1445
+ * Filter QR codes created before this date
1446
+ */
1447
+ createdBefore?: string;
1448
+ /**
1449
+ * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
1450
+ * codes of the project will be returned.
1451
+ */
1452
+ domain?: string;
1453
+ /**
1454
+ * Filter QR codes expiring after this date
1455
+ */
1456
+ expiresAfter?: string;
1457
+ /**
1458
+ * The date and time the QR code will expire in ISO-8601 format. Must be in the
1459
+ * future.
1460
+ */
1461
+ expiresAt?: string | null;
1462
+ /**
1463
+ * Filter QR codes expiring before this date
1464
+ */
1465
+ expiresBefore?: string;
1466
+ /**
1467
+ * Filter by QR code format - static or dynamic
1468
+ */
1469
+ format?: 'static' | 'dynamic';
1470
+ /**
1471
+ * Filter QR codes with/without comments
1472
+ */
1473
+ hasComments?: boolean;
1474
+ /**
1475
+ * Filter QR codes with/without custom social media cards
1476
+ */
1477
+ hasCustomSocial?: boolean;
1478
+ /**
1479
+ * Filter QR codes with/without device targeting
1480
+ */
1481
+ hasDevice?: boolean;
1482
+ /**
1483
+ * Filter QR codes with/without expiration date
1484
+ */
1485
+ hasExpiration?: boolean;
1486
+ /**
1487
+ * Filter QR codes with/without geo-targeting
1488
+ */
1489
+ hasGeo?: boolean;
1490
+ /**
1491
+ * Filter QR codes with/without password protection
1492
+ */
1493
+ hasPassword?: boolean;
1494
+ /**
1495
+ * Filter QR codes with/without tags
1496
+ */
1497
+ hasTags?: boolean;
1498
+ /**
1499
+ * Filter QR codes with/without UTM parameters
1500
+ */
1501
+ hasUTM?: boolean;
1502
+ /**
1503
+ * The page number for pagination.
1504
+ */
1505
+ page?: number;
1506
+ /**
1507
+ * The number of items per page.
1508
+ */
1509
+ pageSize?: number;
1510
+ /**
1511
+ * The password to filter by.
1512
+ */
1513
+ password?: string;
1514
+ /**
1515
+ * The slug of the project to which the QR code belongs. For example, for
1516
+ * `app.codeqr.io/acme`, the projectSlug is `acme`.
1517
+ */
1518
+ projectSlug?: string;
1519
+ /**
1520
+ * Maximum number of scans
1521
+ */
1522
+ scansMax?: number;
1523
+ /**
1524
+ * Minimum number of scans
1525
+ */
1526
+ scansMin?: number;
1527
+ /**
1528
+ * The search term to filter the QR codes. The search term will be matched against
1529
+ * the QR code slug and the destination URL.
1530
+ */
1531
+ search?: string;
1532
+ /**
1533
+ * If should include archived QR codes in the response. The default is `false` if
1534
+ * not provided.
1535
+ */
1536
+ showArchived?: boolean;
1537
+ /**
1538
+ * The field to order the QR codes. The default is `createdAt`, and the order of
1539
+ * sorting is always descending.
1540
+ */
1541
+ sort?: 'createdAt' | 'scans' | 'lastClicked';
1542
+ /**
1543
+ * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
1544
+ * to the QR code.
1545
+ */
1546
+ tagId?: string;
1547
+ /**
1548
+ * The IDs of the tags to filter the QR codes.
1549
+ */
1550
+ tagIds?: string | Array<string>;
1551
+ /**
1552
+ * The unique name of the tags assigned to the QR code (case insensitive).
1553
+ */
1554
+ tagNames?: string | Array<string>;
1555
+ /**
1556
+ * If should include QR codes with conversion tracking enabled. The default is
1557
+ * `false` if not provided.
1558
+ */
1559
+ trackConversion?: boolean;
1560
+ /**
1561
+ * Filter by QR code type
1562
+ */
1563
+ type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog' | 'pix';
1564
+ /**
1565
+ * The ID of the user to filter by.
1566
+ */
1567
+ userId?: string;
1568
+ /**
1569
+ * If should include tags in the response. The default is `false` if not provided.
1570
+ */
1571
+ withTags?: boolean;
1572
+ }
1573
+ export interface QrcodeCountParams {
1574
+ /**
1575
+ * The comments to filter by.
1576
+ */
1577
+ comments?: string;
1578
+ /**
1579
+ * Filter QR codes created after this date
1580
+ */
1581
+ createdAfter?: string;
1582
+ /**
1583
+ * Filter QR codes created before this date
1584
+ */
1585
+ createdBefore?: string;
1586
+ /**
1587
+ * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
1588
+ * codes of the project will be returned.
1589
+ */
1590
+ domain?: string;
1591
+ /**
1592
+ * Filter QR codes expiring after this date
1593
+ */
1594
+ expiresAfter?: string;
1595
+ /**
1596
+ * The date and time the QR code will expire in ISO-8601 format. Must be in the
1597
+ * future.
1598
+ */
1599
+ expiresAt?: string | null;
1600
+ /**
1601
+ * Filter QR codes expiring before this date
1602
+ */
1603
+ expiresBefore?: string;
1604
+ /**
1605
+ * Filter by QR code format - static or dynamic
1606
+ */
1607
+ format?: 'static' | 'dynamic';
1608
+ /**
1609
+ * The field to group the QR codes.
1610
+ */
1611
+ groupBy?: 'domain' | 'tagId' | 'userId';
1612
+ /**
1613
+ * Filter QR codes with/without comments
1614
+ */
1615
+ hasComments?: boolean;
1616
+ /**
1617
+ * Filter QR codes with/without custom social media cards
1618
+ */
1619
+ hasCustomSocial?: boolean;
1620
+ /**
1621
+ * Filter QR codes with/without device targeting
1622
+ */
1623
+ hasDevice?: boolean;
1624
+ /**
1625
+ * Filter QR codes with/without expiration date
1626
+ */
1627
+ hasExpiration?: boolean;
1628
+ /**
1629
+ * Filter QR codes with/without geo-targeting
1630
+ */
1631
+ hasGeo?: boolean;
1632
+ /**
1633
+ * Filter QR codes with/without password protection
1634
+ */
1635
+ hasPassword?: boolean;
1636
+ /**
1637
+ * Filter QR codes with/without tags
1638
+ */
1639
+ hasTags?: boolean;
1640
+ /**
1641
+ * Filter QR codes with/without UTM parameters
1642
+ */
1643
+ hasUTM?: boolean;
1644
+ /**
1645
+ * The password to filter by.
1646
+ */
1647
+ password?: string;
1648
+ /**
1649
+ * The slug of the project to which the QR code belongs. For example, for
1650
+ * `app.codeqr.io/acme`, the projectSlug is `acme`.
1651
+ */
1652
+ projectSlug?: string;
1653
+ /**
1654
+ * Maximum number of scans
1655
+ */
1656
+ scansMax?: number;
1657
+ /**
1658
+ * Minimum number of scans
1659
+ */
1660
+ scansMin?: number;
1661
+ /**
1662
+ * The search term to filter the QR codes. The search term will be matched against
1663
+ * the QR code slug and the destination URL.
1664
+ */
1665
+ search?: string;
1666
+ /**
1667
+ * If should include archived QR codes in the response. The default is `false` if
1668
+ * not provided.
1669
+ */
1670
+ showArchived?: boolean;
1671
+ /**
1672
+ * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
1673
+ * to the QR code.
1674
+ */
1675
+ tagId?: string;
1676
+ /**
1677
+ * The IDs of the tags to filter the QR codes.
1678
+ */
1679
+ tagIds?: string | Array<string>;
1680
+ /**
1681
+ * The unique name of the tags assigned to the QR code (case insensitive).
1682
+ */
1683
+ tagNames?: string | Array<string>;
1684
+ /**
1685
+ * If should include QR codes with conversion tracking enabled. The default is
1686
+ * `false` if not provided.
1687
+ */
1688
+ trackConversion?: boolean;
1689
+ /**
1690
+ * Filter by QR code type
1691
+ */
1692
+ type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog' | 'pix';
1693
+ /**
1694
+ * The ID of the user to filter by.
1695
+ */
1696
+ userId?: string;
1697
+ /**
1698
+ * If should include tags in the response. The default is `false` if not provided.
1699
+ */
1700
+ withTags?: boolean;
1701
+ }
1702
+ export interface QrcodeUpsertParams {
1703
+ /**
1704
+ * The type of content of the QR code.
1705
+ */
1706
+ type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
1707
+ /**
1708
+ * The destination URL for Android for the QR code for device targeting Android.
1709
+ */
1710
+ android?: string | null;
1711
+ /**
1712
+ * If the QR code is archived.
1713
+ */
1714
+ archived?: boolean;
1715
+ /**
1716
+ * The background color of the QR code.
1717
+ */
1718
+ bgColor?: string;
1719
+ /**
1720
+ * The comments for the QR code.
1721
+ */
1722
+ comments?: string | null;
1723
+ /**
1724
+ * The static content of the QR code.
1725
+ */
1726
+ contentStatic?: string | null;
1727
+ /**
1728
+ * The cryptocurrency information of the QR code.
1729
+ */
1730
+ crypto?: {
1731
+ [key: string]: string;
1732
+ } | null;
1733
+ /**
1734
+ * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
1735
+ * used for custom link preview if `proxy` is true.
1736
+ */
1737
+ description?: string | null;
1738
+ /**
1739
+ * Allow search engines to index your QR code. The default is `false` if not
1740
+ * provided. Learn more: https://codeqr.link/noindex
1741
+ */
1742
+ doIndex?: boolean;
1743
+ /**
1744
+ * The domain of the QR code. If not provided, the main domain of the project will
1745
+ * be used (or `codeqr.link` if the project does not have domains).
1746
+ */
1747
+ domain?: string;
1748
+ /**
1749
+ * The email information of the QR code.
1750
+ */
1751
+ email?: {
1752
+ [key: string]: string;
1753
+ } | null;
1754
+ /**
1755
+ * If the QR code should have excavated areas.
1756
+ */
1757
+ excavate?: boolean;
1758
+ /**
1759
+ * The URL to redirect when the QR code expires.
1760
+ */
1761
+ expiredUrl?: string | null;
1762
+ /**
1763
+ * The date and time the QR code will expire in ISO-8601 format. Must be in the
1764
+ * future.
1765
+ */
1766
+ expiresAt?: string | null;
1767
+ /**
1768
+ * This is the ID of the QR code in your database. If defined, it can be used to
1769
+ * identify the QR code in the future. It must be prefixed with `ext_` when passed
1770
+ * as a query parameter.
1771
+ */
1772
+ externalId?: string | null;
1773
+ /**
1774
+ * The FaceTime information of the QR code.
1775
+ */
1776
+ facetime?: {
1777
+ [key: string]: string;
1778
+ } | null;
1779
+ /**
1780
+ * The foreground color of the QR code.
1781
+ */
1782
+ fgColor?: string;
1783
+ /**
1784
+ * If the QR code is filled.
1785
+ */
1786
+ filled?: boolean;
1787
+ /**
1788
+ * If the QR code is flexible.
1789
+ */
1790
+ flexible?: boolean;
1791
+ /**
1792
+ * The type of frame of the QR code.
1793
+ */
1794
+ frame?: string;
1795
+ /**
1796
+ * The color of the frame of the QR code.
1797
+ */
1798
+ frameColor?: string;
1799
+ /**
1800
+ * The text of the frame of the QR code.
1801
+ */
1802
+ frameText?: string;
1803
+ /**
1804
+ * Geographic segmentation information for the QR code in the JSON format
1805
+ * `{[COUNTRY]: https://example.com }`.
1806
+ */
1807
+ geo?: QrcodeUpsertParams.Geo | null;
1808
+ /**
1809
+ * The height of the QR code.
1810
+ */
1811
+ height?: number;
1812
+ /**
1813
+ * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
1814
+ * for custom link preview if `proxy` is true.
1815
+ */
1816
+ image?: string | null;
1817
+ /**
1818
+ * The destination URL for iOS for the QR code for device targeting iOS.
1819
+ */
1820
+ ios?: string | null;
1821
+ /**
1822
+ * If the form is mandatory for the page.
1823
+ */
1824
+ isFormMandatory?: boolean;
1825
+ /**
1826
+ * The slug of the QR code. If not provided, a random slug of 7 characters will be
1827
+ * generated.
1828
+ */
1829
+ key?: string;
1830
+ /**
1831
+ * The latitude and longitude information of the QR code.
1832
+ */
1833
+ latlog?: {
1834
+ [key: string]: string;
1835
+ } | null;
1836
+ /**
1837
+ * The level of error correction of the QR code.
1838
+ */
1839
+ level?: string;
1840
+ /**
1841
+ * The logo of the QR code.
1842
+ */
1843
+ logo?: string | null;
1844
+ /**
1845
+ * The ID of the page to redirect to before the QR code destination.
1846
+ */
1847
+ pageId?: string | null;
1848
+ /**
1849
+ * The URL of the page to redirect to before the QR code destination.
1850
+ */
1851
+ pageUrl?: string | null;
1852
+ /**
1853
+ * The password required to access the destination URL of the QR code.
1854
+ */
1855
+ password?: string | null;
1856
+ /**
1857
+ * The pattern of the modules of the QR code.
1858
+ */
1859
+ pattern?: string;
1860
+ /**
1861
+ * The phone number of the QR code.
1862
+ */
1863
+ phone?: string | null;
1864
+ /**
1865
+ * If the QR code has pre-redirection.
1866
+ */
1867
+ preRedirection?: boolean;
1868
+ /**
1869
+ * If the QR code uses the custom link preview feature.
1870
+ */
1871
+ proxy?: boolean;
1872
+ /**
1873
+ * If the statistics of the QR code are publicly accessible.
1874
+ */
1875
+ publicStats?: boolean;
1876
+ /**
1877
+ * If the QR code uses link cloaking.
1878
+ */
1879
+ rewrite?: boolean;
1880
+ /**
1881
+ * The shape of the design around the QR code (none, square, circle).
1882
+ */
1883
+ shape?: string;
1884
+ /**
1885
+ * If the logo should be displayed in the QR code.
1886
+ */
1887
+ showLogo?: boolean;
1888
+ /**
1889
+ * The size of the QR code.
1890
+ */
1891
+ size?: number;
1892
+ /**
1893
+ * The SMS information of the QR code.
1894
+ */
1895
+ sms?: {
1896
+ [key: string]: string;
1897
+ } | null;
1898
+ /**
1899
+ * The image URL of the QR code.
1900
+ */
1901
+ src?: string | null;
1902
+ /**
1903
+ * If the QR code is static.
1904
+ */
1905
+ static?: boolean;
1906
+ /**
1907
+ * @deprecated The unique ID of the tag assigned to the QR code. This field is
1908
+ * deprecated – use `tagIds` instead.
1909
+ */
1910
+ tagId?: string | null;
1911
+ /**
1912
+ * The unique IDs of the tags assigned to the QR code.
1913
+ */
1914
+ tagIds?: string | Array<string>;
1915
+ /**
1916
+ * The unique name of the tags assigned to the QR code (case insensitive).
1917
+ */
1918
+ tagNames?: string | Array<string>;
1919
+ /**
1920
+ * The text of the QR code.
1921
+ */
1922
+ text?: string | null;
1923
+ /**
1924
+ * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
1925
+ * for custom link preview if `proxy` is true.
1926
+ */
1927
+ title?: string | null;
1928
+ /**
1929
+ * If should track conversions for the QR code.
1930
+ */
1931
+ trackConversion?: boolean;
1932
+ /**
1933
+ * The destination URL of the QR code.
1934
+ */
1935
+ url?: string | null;
1936
+ /**
1937
+ * The vCard information of the QR code.
1938
+ */
1939
+ vcard?: {
1940
+ [key: string]: string;
1941
+ } | null;
1942
+ /**
1943
+ * An array of webhook IDs to trigger when the link is clicked. These webhooks will
1944
+ * receive click event data.
1945
+ */
1946
+ webhookIds?: Array<string> | null;
1947
+ /**
1948
+ * The width of the QR code.
1949
+ */
1950
+ width?: number;
1951
+ /**
1952
+ * The WiFi information of the QR code.
1953
+ */
1954
+ wifi?: {
1955
+ [key: string]: string;
1956
+ } | null;
1957
+ }
1958
+ export declare namespace QrcodeUpsertParams {
1959
+ /**
1960
+ * Geographic segmentation information for the QR code in the JSON format
1961
+ * `{[COUNTRY]: https://example.com }`.
1962
+ */
1963
+ interface Geo {
1964
+ AD?: string;
1965
+ AE?: string;
1966
+ AF?: string;
1967
+ AG?: string;
1968
+ AI?: string;
1969
+ AL?: string;
1970
+ AM?: string;
1971
+ AO?: string;
1972
+ AQ?: string;
1973
+ AR?: string;
1974
+ AS?: string;
1975
+ AT?: string;
1976
+ AU?: string;
1977
+ AW?: string;
1978
+ AX?: string;
1979
+ AZ?: string;
1980
+ BA?: string;
1981
+ BB?: string;
1982
+ BD?: string;
1983
+ BE?: string;
1984
+ BF?: string;
1985
+ BG?: string;
1986
+ BH?: string;
1987
+ BI?: string;
1988
+ BJ?: string;
1989
+ BL?: string;
1990
+ BM?: string;
1991
+ BN?: string;
1992
+ BO?: string;
1993
+ BQ?: string;
1994
+ BR?: string;
1995
+ BS?: string;
1996
+ BT?: string;
1997
+ BV?: string;
1998
+ BW?: string;
1999
+ BY?: string;
2000
+ BZ?: string;
2001
+ CA?: string;
2002
+ CC?: string;
2003
+ CD?: string;
2004
+ CF?: string;
2005
+ CG?: string;
2006
+ CH?: string;
2007
+ CI?: string;
2008
+ CK?: string;
2009
+ CL?: string;
2010
+ CM?: string;
2011
+ CN?: string;
2012
+ CO?: string;
2013
+ CR?: string;
2014
+ CU?: string;
2015
+ CV?: string;
2016
+ CW?: string;
2017
+ CX?: string;
2018
+ CY?: string;
2019
+ CZ?: string;
2020
+ DE?: string;
2021
+ DJ?: string;
2022
+ DK?: string;
2023
+ DM?: string;
2024
+ DO?: string;
2025
+ DZ?: string;
2026
+ EC?: string;
2027
+ EE?: string;
2028
+ EG?: string;
2029
+ EH?: string;
2030
+ ER?: string;
2031
+ ES?: string;
2032
+ ET?: string;
2033
+ FI?: string;
2034
+ FJ?: string;
2035
+ FK?: string;
2036
+ FM?: string;
2037
+ FO?: string;
2038
+ FR?: string;
2039
+ GA?: string;
2040
+ GB?: string;
2041
+ GD?: string;
2042
+ GE?: string;
2043
+ GF?: string;
2044
+ GG?: string;
2045
+ GH?: string;
2046
+ GI?: string;
2047
+ GL?: string;
2048
+ GM?: string;
2049
+ GN?: string;
2050
+ GP?: string;
2051
+ GQ?: string;
2052
+ GR?: string;
2053
+ GS?: string;
2054
+ GT?: string;
2055
+ GU?: string;
2056
+ GW?: string;
2057
+ GY?: string;
2058
+ HK?: string;
2059
+ HM?: string;
2060
+ HN?: string;
2061
+ HR?: string;
2062
+ HT?: string;
2063
+ HU?: string;
2064
+ ID?: string;
2065
+ IE?: string;
2066
+ IL?: string;
2067
+ IM?: string;
2068
+ IN?: string;
2069
+ IO?: string;
2070
+ IQ?: string;
2071
+ IR?: string;
2072
+ IS?: string;
2073
+ IT?: string;
2074
+ JE?: string;
2075
+ JM?: string;
2076
+ JO?: string;
2077
+ JP?: string;
2078
+ KE?: string;
2079
+ KG?: string;
2080
+ KH?: string;
2081
+ KI?: string;
2082
+ KM?: string;
2083
+ KN?: string;
2084
+ KP?: string;
2085
+ KR?: string;
2086
+ KW?: string;
2087
+ KY?: string;
2088
+ KZ?: string;
2089
+ LA?: string;
2090
+ LB?: string;
2091
+ LC?: string;
2092
+ LI?: string;
2093
+ LK?: string;
2094
+ LR?: string;
2095
+ LS?: string;
2096
+ LT?: string;
2097
+ LU?: string;
2098
+ LV?: string;
2099
+ LY?: string;
2100
+ MA?: string;
2101
+ MC?: string;
2102
+ MD?: string;
2103
+ ME?: string;
2104
+ MF?: string;
2105
+ MG?: string;
2106
+ MH?: string;
2107
+ MK?: string;
2108
+ ML?: string;
2109
+ MM?: string;
2110
+ MN?: string;
2111
+ MO?: string;
2112
+ MP?: string;
2113
+ MQ?: string;
2114
+ MR?: string;
2115
+ MS?: string;
2116
+ MT?: string;
2117
+ MU?: string;
2118
+ MV?: string;
2119
+ MW?: string;
2120
+ MX?: string;
2121
+ MY?: string;
2122
+ MZ?: string;
2123
+ NA?: string;
2124
+ NC?: string;
2125
+ NE?: string;
2126
+ NF?: string;
2127
+ NG?: string;
2128
+ NI?: string;
2129
+ NL?: string;
2130
+ NO?: string;
2131
+ NP?: string;
2132
+ NR?: string;
2133
+ NU?: string;
2134
+ NZ?: string;
2135
+ OM?: string;
2136
+ PA?: string;
2137
+ PE?: string;
2138
+ PF?: string;
2139
+ PG?: string;
2140
+ PH?: string;
2141
+ PK?: string;
2142
+ PL?: string;
2143
+ PM?: string;
2144
+ PN?: string;
2145
+ PR?: string;
2146
+ PS?: string;
2147
+ PT?: string;
2148
+ PW?: string;
2149
+ PY?: string;
2150
+ QA?: string;
2151
+ RE?: string;
2152
+ RO?: string;
2153
+ RS?: string;
2154
+ RU?: string;
2155
+ RW?: string;
2156
+ SA?: string;
2157
+ SB?: string;
2158
+ SC?: string;
2159
+ SD?: string;
2160
+ SE?: string;
2161
+ SG?: string;
2162
+ SH?: string;
2163
+ SI?: string;
2164
+ SJ?: string;
2165
+ SK?: string;
2166
+ SL?: string;
2167
+ SM?: string;
2168
+ SN?: string;
2169
+ SO?: string;
2170
+ SR?: string;
2171
+ SS?: string;
2172
+ ST?: string;
2173
+ SV?: string;
2174
+ SX?: string;
2175
+ SY?: string;
2176
+ SZ?: string;
2177
+ TC?: string;
2178
+ TD?: string;
2179
+ TF?: string;
2180
+ TG?: string;
2181
+ TH?: string;
2182
+ TJ?: string;
2183
+ TK?: string;
2184
+ TL?: string;
2185
+ TM?: string;
2186
+ TN?: string;
2187
+ TO?: string;
2188
+ TR?: string;
2189
+ TT?: string;
2190
+ TV?: string;
2191
+ TW?: string;
2192
+ TZ?: string;
2193
+ UA?: string;
2194
+ UG?: string;
2195
+ UM?: string;
2196
+ US?: string;
2197
+ UY?: string;
2198
+ UZ?: string;
2199
+ VA?: string;
2200
+ VC?: string;
2201
+ VE?: string;
2202
+ VG?: string;
2203
+ VI?: string;
2204
+ VN?: string;
2205
+ VU?: string;
2206
+ WF?: string;
2207
+ WS?: string;
2208
+ XK?: string;
2209
+ YE?: string;
2210
+ YT?: string;
2211
+ ZA?: string;
2212
+ ZM?: string;
2213
+ ZW?: string;
2214
+ }
2215
+ }
2216
+ export declare namespace Qrcodes {
2217
+ export { type QrCode as QrCode, type QrcodeListResponse as QrcodeListResponse, type QrcodeDeleteResponse as QrcodeDeleteResponse, type QrcodeCountResponse as QrcodeCountResponse, type QrcodeCreateParams as QrcodeCreateParams, type QrcodeRetrieveParams as QrcodeRetrieveParams, type QrcodeUpdateParams as QrcodeUpdateParams, type QrcodeListParams as QrcodeListParams, type QrcodeCountParams as QrcodeCountParams, type QrcodeUpsertParams as QrcodeUpsertParams, };
2218
+ export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkDeleteResponse as BulkDeleteResponse, type BulkCreateParams as BulkCreateParams, type BulkDeleteParams as BulkDeleteParams, };
2219
+ }
2220
+ //# sourceMappingURL=qrcodes.d.ts.map