@payloadcms/figma 0.0.1-alpha.42 → 0.0.1-alpha.6

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 (286) hide show
  1. package/dist/api/control-plane.d.ts +1 -22
  2. package/dist/api/control-plane.d.ts.map +1 -1
  3. package/dist/api/control-plane.js +22 -55
  4. package/dist/api/control-plane.js.map +1 -1
  5. package/dist/api/figma-api.d.ts.map +1 -1
  6. package/dist/api/figma-api.js +21 -45
  7. package/dist/api/figma-api.js.map +1 -1
  8. package/dist/auth/callback-server.d.ts.map +1 -1
  9. package/dist/auth/callback-server.js +1 -2
  10. package/dist/auth/callback-server.js.map +1 -1
  11. package/dist/auth/crypto-utils.d.ts.map +1 -1
  12. package/dist/auth/crypto-utils.js +5 -5
  13. package/dist/auth/crypto-utils.js.map +1 -1
  14. package/dist/auth/jwt-validator.d.ts +1 -2
  15. package/dist/auth/jwt-validator.d.ts.map +1 -1
  16. package/dist/auth/jwt-validator.js +2 -2
  17. package/dist/auth/jwt-validator.js.map +1 -1
  18. package/dist/auth/oauth-flow.d.ts +1 -1
  19. package/dist/auth/oauth-flow.d.ts.map +1 -1
  20. package/dist/auth/oauth-flow.js +11 -15
  21. package/dist/auth/oauth-flow.js.map +1 -1
  22. package/dist/auth/project-token.d.ts.map +1 -1
  23. package/dist/auth/project-token.js +4 -9
  24. package/dist/auth/project-token.js.map +1 -1
  25. package/dist/auth/refresh.d.ts +1 -2
  26. package/dist/auth/refresh.d.ts.map +1 -1
  27. package/dist/auth/refresh.js +12 -25
  28. package/dist/auth/refresh.js.map +1 -1
  29. package/dist/auth/token-store.d.ts +0 -12
  30. package/dist/auth/token-store.d.ts.map +1 -1
  31. package/dist/auth/token-store.js +5 -28
  32. package/dist/auth/token-store.js.map +1 -1
  33. package/dist/auth/types.d.ts +4 -7
  34. package/dist/auth/types.d.ts.map +1 -1
  35. package/dist/auth/types.js.map +1 -1
  36. package/dist/cli.d.ts.map +1 -1
  37. package/dist/cli.js +6 -39
  38. package/dist/cli.js.map +1 -1
  39. package/dist/commands/deploy.d.ts +0 -4
  40. package/dist/commands/deploy.d.ts.map +1 -1
  41. package/dist/commands/deploy.js +129 -72
  42. package/dist/commands/deploy.js.map +1 -1
  43. package/dist/commands/init.d.ts +5 -1
  44. package/dist/commands/init.d.ts.map +1 -1
  45. package/dist/commands/init.js +85 -105
  46. package/dist/commands/init.js.map +1 -1
  47. package/dist/commands/list-tokens.d.ts +3 -3
  48. package/dist/commands/list-tokens.d.ts.map +1 -1
  49. package/dist/commands/list-tokens.js +7 -22
  50. package/dist/commands/list-tokens.js.map +1 -1
  51. package/dist/commands/login.d.ts +1 -8
  52. package/dist/commands/login.d.ts.map +1 -1
  53. package/dist/commands/login.js +12 -30
  54. package/dist/commands/login.js.map +1 -1
  55. package/dist/commands/logout.d.ts +4 -5
  56. package/dist/commands/logout.d.ts.map +1 -1
  57. package/dist/commands/logout.js +13 -56
  58. package/dist/commands/logout.js.map +1 -1
  59. package/dist/config/oauth.d.ts +14 -4
  60. package/dist/config/oauth.d.ts.map +1 -1
  61. package/dist/config/oauth.js +40 -19
  62. package/dist/config/oauth.js.map +1 -1
  63. package/dist/constants.d.ts +18 -26
  64. package/dist/constants.d.ts.map +1 -1
  65. package/dist/constants.js +20 -34
  66. package/dist/constants.js.map +1 -1
  67. package/dist/exports/client.d.ts +0 -1
  68. package/dist/exports/client.d.ts.map +1 -1
  69. package/dist/exports/client.js +0 -1
  70. package/dist/exports/client.js.map +1 -1
  71. package/dist/index.d.ts +1 -2
  72. package/dist/index.d.ts.map +1 -1
  73. package/dist/index.js +1 -3
  74. package/dist/index.js.map +1 -1
  75. package/dist/oauth/components/LoginButton/index.d.ts.map +1 -1
  76. package/dist/oauth/components/LoginButton/index.js +6 -50
  77. package/dist/oauth/components/LoginButton/index.js.map +1 -1
  78. package/dist/oauth/components/LoginButton/index.scss +3 -50
  79. package/dist/oauth/components/LogoutButton/index.d.ts.map +1 -1
  80. package/dist/oauth/components/LogoutButton/index.js +4 -5
  81. package/dist/oauth/components/LogoutButton/index.js.map +1 -1
  82. package/dist/oauth/defaults.d.ts.map +1 -1
  83. package/dist/oauth/defaults.js +5 -29
  84. package/dist/oauth/defaults.js.map +1 -1
  85. package/dist/oauth/endpoints/getLoginEndpoint.d.ts.map +1 -1
  86. package/dist/oauth/endpoints/getLoginEndpoint.js +11 -21
  87. package/dist/oauth/endpoints/getLoginEndpoint.js.map +1 -1
  88. package/dist/oauth/endpoints/getLogoutEndpoint.d.ts.map +1 -1
  89. package/dist/oauth/endpoints/getLogoutEndpoint.js +4 -7
  90. package/dist/oauth/endpoints/getLogoutEndpoint.js.map +1 -1
  91. package/dist/oauth/index.d.ts.map +1 -1
  92. package/dist/oauth/index.js +13 -40
  93. package/dist/oauth/index.js.map +1 -1
  94. package/dist/oauth/strategy/index.d.ts +2 -0
  95. package/dist/oauth/strategy/index.d.ts.map +1 -1
  96. package/dist/oauth/strategy/index.js +15 -38
  97. package/dist/oauth/strategy/index.js.map +1 -1
  98. package/dist/oauth/types.d.ts +6 -6
  99. package/dist/oauth/types.d.ts.map +1 -1
  100. package/dist/oauth/types.js.map +1 -1
  101. package/dist/oauth/utilities/createCookieOptions.d.ts.map +1 -1
  102. package/dist/oauth/utilities/createCookieOptions.js.map +1 -1
  103. package/dist/oauth/utilities/getAdminPath.d.ts +8 -0
  104. package/dist/oauth/utilities/getAdminPath.d.ts.map +1 -0
  105. package/dist/oauth/utilities/getAdminPath.js +9 -0
  106. package/dist/oauth/utilities/getAdminPath.js.map +1 -0
  107. package/dist/oauth/utilities/refreshTokens.d.ts.map +1 -1
  108. package/dist/oauth/utilities/refreshTokens.js +1 -1
  109. package/dist/oauth/utilities/refreshTokens.js.map +1 -1
  110. package/dist/plugin/build-config.d.ts +4 -21
  111. package/dist/plugin/build-config.d.ts.map +1 -1
  112. package/dist/plugin/build-config.js +7 -113
  113. package/dist/plugin/build-config.js.map +1 -1
  114. package/dist/types.d.ts +0 -1
  115. package/dist/types.d.ts.map +1 -1
  116. package/dist/types.js.map +1 -1
  117. package/dist/utils/asset-collection.d.ts +6 -3
  118. package/dist/utils/asset-collection.d.ts.map +1 -1
  119. package/dist/utils/asset-collection.js +34 -10
  120. package/dist/utils/asset-collection.js.map +1 -1
  121. package/dist/utils/config.js +1 -1
  122. package/dist/utils/config.js.map +1 -1
  123. package/dist/utils/env-management.d.ts +8 -9
  124. package/dist/utils/env-management.d.ts.map +1 -1
  125. package/dist/utils/env-management.js +74 -73
  126. package/dist/utils/env-management.js.map +1 -1
  127. package/dist/utils/formatter.d.ts.map +1 -1
  128. package/dist/utils/formatter.js +5 -3
  129. package/dist/utils/formatter.js.map +1 -1
  130. package/dist/utils/lambda-config.d.ts +1 -3
  131. package/dist/utils/lambda-config.d.ts.map +1 -1
  132. package/dist/utils/lambda-config.js +32 -38
  133. package/dist/utils/lambda-config.js.map +1 -1
  134. package/dist/utils/messages.js +8 -8
  135. package/dist/utils/messages.js.map +1 -1
  136. package/dist/utils/payload-config-ast.d.ts +3 -22
  137. package/dist/utils/payload-config-ast.d.ts.map +1 -1
  138. package/dist/utils/payload-config-ast.js +31 -89
  139. package/dist/utils/payload-config-ast.js.map +1 -1
  140. package/dist/utils/payload-config-finder.d.ts +2 -2
  141. package/dist/utils/payload-config-finder.d.ts.map +1 -1
  142. package/dist/utils/payload-config-finder.js +9 -48
  143. package/dist/utils/payload-config-finder.js.map +1 -1
  144. package/dist/utils/payload-config-modifier.d.ts.map +1 -1
  145. package/dist/utils/payload-config-modifier.js +6 -54
  146. package/dist/utils/payload-config-modifier.js.map +1 -1
  147. package/dist/utils/payload-package-check.d.ts +1 -12
  148. package/dist/utils/payload-package-check.d.ts.map +1 -1
  149. package/dist/utils/payload-package-check.js +5 -63
  150. package/dist/utils/payload-package-check.js.map +1 -1
  151. package/dist/utils/project.d.ts.map +1 -1
  152. package/dist/utils/project.js +5 -8
  153. package/dist/utils/project.js.map +1 -1
  154. package/dist/utils/s3-upload.d.ts +1 -0
  155. package/dist/utils/s3-upload.d.ts.map +1 -1
  156. package/dist/utils/s3-upload.js +3 -10
  157. package/dist/utils/s3-upload.js.map +1 -1
  158. package/dist/utils/token-display.d.ts.map +1 -1
  159. package/dist/utils/token-display.js +5 -11
  160. package/dist/utils/token-display.js.map +1 -1
  161. package/dist/utils/typescript-validator.d.ts.map +1 -1
  162. package/dist/utils/typescript-validator.js +6 -4
  163. package/dist/utils/typescript-validator.js.map +1 -1
  164. package/package.json +9 -27
  165. package/dist/commands/build-lambda-zip.d.ts +0 -5
  166. package/dist/commands/build-lambda-zip.d.ts.map +0 -1
  167. package/dist/commands/build-lambda-zip.js +0 -19
  168. package/dist/commands/build-lambda-zip.js.map +0 -1
  169. package/dist/db-content-api/README.md +0 -98
  170. package/dist/db-content-api/generated/content-api-types.d.ts +0 -3914
  171. package/dist/db-content-api/generated/content-api-types.d.ts.map +0 -1
  172. package/dist/db-content-api/generated/content-api-types.js +0 -7
  173. package/dist/db-content-api/generated/content-api-types.js.map +0 -1
  174. package/dist/db-content-api/index.d.ts +0 -18
  175. package/dist/db-content-api/index.d.ts.map +0 -1
  176. package/dist/db-content-api/index.js +0 -586
  177. package/dist/db-content-api/index.js.map +0 -1
  178. package/dist/db-content-api/temp-utilities/slug.d.ts +0 -2
  179. package/dist/db-content-api/temp-utilities/slug.d.ts.map +0 -1
  180. package/dist/db-content-api/temp-utilities/slug.js +0 -3
  181. package/dist/db-content-api/temp-utilities/slug.js.map +0 -1
  182. package/dist/db-content-api/temp-utilities/sorting.d.ts +0 -3
  183. package/dist/db-content-api/temp-utilities/sorting.d.ts.map +0 -1
  184. package/dist/db-content-api/temp-utilities/sorting.js +0 -32
  185. package/dist/db-content-api/temp-utilities/sorting.js.map +0 -1
  186. package/dist/db-content-api/temp-utilities/unwrapDocument.d.ts +0 -34
  187. package/dist/db-content-api/temp-utilities/unwrapDocument.d.ts.map +0 -1
  188. package/dist/db-content-api/temp-utilities/unwrapDocument.js +0 -53
  189. package/dist/db-content-api/temp-utilities/unwrapDocument.js.map +0 -1
  190. package/dist/db-content-api/utilities/auth.d.ts +0 -30
  191. package/dist/db-content-api/utilities/auth.d.ts.map +0 -1
  192. package/dist/db-content-api/utilities/auth.js +0 -81
  193. package/dist/db-content-api/utilities/auth.js.map +0 -1
  194. package/dist/db-content-api/utilities/buildPathTypes.d.ts +0 -12
  195. package/dist/db-content-api/utilities/buildPathTypes.d.ts.map +0 -1
  196. package/dist/db-content-api/utilities/buildPathTypes.js +0 -157
  197. package/dist/db-content-api/utilities/buildPathTypes.js.map +0 -1
  198. package/dist/db-content-api/utilities/data/applyDefaults.d.ts +0 -7
  199. package/dist/db-content-api/utilities/data/applyDefaults.d.ts.map +0 -1
  200. package/dist/db-content-api/utilities/data/applyDefaults.js +0 -59
  201. package/dist/db-content-api/utilities/data/applyDefaults.js.map +0 -1
  202. package/dist/db-content-api/utilities/data/castFieldValue.d.ts +0 -11
  203. package/dist/db-content-api/utilities/data/castFieldValue.d.ts.map +0 -1
  204. package/dist/db-content-api/utilities/data/castFieldValue.js +0 -66
  205. package/dist/db-content-api/utilities/data/castFieldValue.js.map +0 -1
  206. package/dist/db-content-api/utilities/data/index.d.ts +0 -32
  207. package/dist/db-content-api/utilities/data/index.d.ts.map +0 -1
  208. package/dist/db-content-api/utilities/data/index.js +0 -190
  209. package/dist/db-content-api/utilities/data/index.js.map +0 -1
  210. package/dist/db-content-api/utilities/data/removeVirtualFields.d.ts +0 -12
  211. package/dist/db-content-api/utilities/data/removeVirtualFields.d.ts.map +0 -1
  212. package/dist/db-content-api/utilities/data/removeVirtualFields.js +0 -54
  213. package/dist/db-content-api/utilities/data/removeVirtualFields.js.map +0 -1
  214. package/dist/db-content-api/utilities/data/stripFields.d.ts +0 -48
  215. package/dist/db-content-api/utilities/data/stripFields.d.ts.map +0 -1
  216. package/dist/db-content-api/utilities/data/stripFields.js +0 -195
  217. package/dist/db-content-api/utilities/data/stripFields.js.map +0 -1
  218. package/dist/db-content-api/utilities/joins.d.ts +0 -55
  219. package/dist/db-content-api/utilities/joins.d.ts.map +0 -1
  220. package/dist/db-content-api/utilities/joins.js +0 -136
  221. package/dist/db-content-api/utilities/joins.js.map +0 -1
  222. package/dist/db-content-api/utilities/where.d.ts +0 -12
  223. package/dist/db-content-api/utilities/where.d.ts.map +0 -1
  224. package/dist/db-content-api/utilities/where.js +0 -121
  225. package/dist/db-content-api/utilities/where.js.map +0 -1
  226. package/dist/endpoints/health.d.ts +0 -3
  227. package/dist/endpoints/health.d.ts.map +0 -1
  228. package/dist/endpoints/health.js +0 -11
  229. package/dist/endpoints/health.js.map +0 -1
  230. package/dist/oauth/utilities/isDuplicateKeyError.d.ts +0 -7
  231. package/dist/oauth/utilities/isDuplicateKeyError.d.ts.map +0 -1
  232. package/dist/oauth/utilities/isDuplicateKeyError.js +0 -14
  233. package/dist/oauth/utilities/isDuplicateKeyError.js.map +0 -1
  234. package/dist/storage-content-api/api-types.d.ts +0 -168
  235. package/dist/storage-content-api/api-types.d.ts.map +0 -1
  236. package/dist/storage-content-api/api-types.js +0 -6
  237. package/dist/storage-content-api/api-types.js.map +0 -1
  238. package/dist/storage-content-api/client-uploads/ClientUploadHandler.d.ts +0 -9
  239. package/dist/storage-content-api/client-uploads/ClientUploadHandler.d.ts.map +0 -1
  240. package/dist/storage-content-api/client-uploads/ClientUploadHandler.js +0 -42
  241. package/dist/storage-content-api/client-uploads/ClientUploadHandler.js.map +0 -1
  242. package/dist/storage-content-api/client-uploads/generateSignedURL.d.ts +0 -13
  243. package/dist/storage-content-api/client-uploads/generateSignedURL.d.ts.map +0 -1
  244. package/dist/storage-content-api/client-uploads/generateSignedURL.js +0 -32
  245. package/dist/storage-content-api/client-uploads/generateSignedURL.js.map +0 -1
  246. package/dist/storage-content-api/client.d.ts +0 -6
  247. package/dist/storage-content-api/client.d.ts.map +0 -1
  248. package/dist/storage-content-api/client.js +0 -36
  249. package/dist/storage-content-api/client.js.map +0 -1
  250. package/dist/storage-content-api/generateURL.d.ts +0 -7
  251. package/dist/storage-content-api/generateURL.d.ts.map +0 -1
  252. package/dist/storage-content-api/generateURL.js +0 -8
  253. package/dist/storage-content-api/generateURL.js.map +0 -1
  254. package/dist/storage-content-api/handleDelete.d.ts +0 -8
  255. package/dist/storage-content-api/handleDelete.d.ts.map +0 -1
  256. package/dist/storage-content-api/handleDelete.js +0 -17
  257. package/dist/storage-content-api/handleDelete.js.map +0 -1
  258. package/dist/storage-content-api/handleUpload.d.ts +0 -11
  259. package/dist/storage-content-api/handleUpload.d.ts.map +0 -1
  260. package/dist/storage-content-api/handleUpload.js +0 -144
  261. package/dist/storage-content-api/handleUpload.js.map +0 -1
  262. package/dist/storage-content-api/index.d.ts +0 -5
  263. package/dist/storage-content-api/index.d.ts.map +0 -1
  264. package/dist/storage-content-api/index.js +0 -31
  265. package/dist/storage-content-api/index.js.map +0 -1
  266. package/dist/storage-content-api/staticHandler.d.ts +0 -10
  267. package/dist/storage-content-api/staticHandler.d.ts.map +0 -1
  268. package/dist/storage-content-api/staticHandler.js +0 -56
  269. package/dist/storage-content-api/staticHandler.js.map +0 -1
  270. package/dist/storage-content-api/types.d.ts +0 -10
  271. package/dist/storage-content-api/types.d.ts.map +0 -1
  272. package/dist/storage-content-api/types.js +0 -3
  273. package/dist/storage-content-api/types.js.map +0 -1
  274. package/dist/templates/README.md +0 -19
  275. package/dist/utils/build-lambda-zip.d.ts +0 -14
  276. package/dist/utils/build-lambda-zip.d.ts.map +0 -1
  277. package/dist/utils/build-lambda-zip.js +0 -81
  278. package/dist/utils/build-lambda-zip.js.map +0 -1
  279. package/dist/utils/format-env-suffix.d.ts +0 -12
  280. package/dist/utils/format-env-suffix.d.ts.map +0 -1
  281. package/dist/utils/format-env-suffix.js +0 -13
  282. package/dist/utils/format-env-suffix.js.map +0 -1
  283. package/dist/utils/version-check.d.ts +0 -3
  284. package/dist/utils/version-check.d.ts.map +0 -1
  285. package/dist/utils/version-check.js +0 -38
  286. package/dist/utils/version-check.js.map +0 -1
@@ -1,3914 +0,0 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
- export type paths = {
6
- '/api/me': {
7
- parameters: {
8
- query?: never;
9
- header?: never;
10
- path?: never;
11
- cookie?: never;
12
- };
13
- get: {
14
- parameters: {
15
- query?: never;
16
- header?: never;
17
- path?: never;
18
- cookie?: never;
19
- };
20
- requestBody?: never;
21
- responses: {
22
- /** @description Current authentication context */
23
- 200: {
24
- headers: {
25
- [name: string]: unknown;
26
- };
27
- content: {
28
- 'application/json': components['schemas']['AuthContextResponse'];
29
- };
30
- };
31
- /** @description Unauthorized */
32
- 401: {
33
- headers: {
34
- [name: string]: unknown;
35
- };
36
- content: {
37
- 'application/json': {
38
- /** @example Error message describing the issue. */
39
- message: string;
40
- };
41
- };
42
- };
43
- };
44
- };
45
- put?: never;
46
- post?: never;
47
- delete?: never;
48
- options?: never;
49
- head?: never;
50
- patch?: never;
51
- trace?: never;
52
- };
53
- '/health': {
54
- parameters: {
55
- query?: never;
56
- header?: never;
57
- path?: never;
58
- cookie?: never;
59
- };
60
- get: {
61
- parameters: {
62
- query?: never;
63
- header?: never;
64
- path?: never;
65
- cookie?: never;
66
- };
67
- requestBody?: never;
68
- responses: {
69
- /** @description OK */
70
- 200: {
71
- headers: {
72
- [name: string]: unknown;
73
- };
74
- content: {
75
- 'application/json': components['schemas']['HealthResponse'];
76
- };
77
- };
78
- };
79
- };
80
- put?: never;
81
- post?: never;
82
- delete?: never;
83
- options?: never;
84
- head?: never;
85
- patch?: never;
86
- trace?: never;
87
- };
88
- '/api/v0/api_keys': {
89
- parameters: {
90
- query?: never;
91
- header?: never;
92
- path?: never;
93
- cookie?: never;
94
- };
95
- get: {
96
- parameters: {
97
- query: {
98
- contentSystemId: string;
99
- };
100
- header?: never;
101
- path?: never;
102
- cookie?: never;
103
- };
104
- requestBody?: never;
105
- responses: {
106
- /** @description API keys retrieved */
107
- 200: {
108
- headers: {
109
- [name: string]: unknown;
110
- };
111
- content: {
112
- 'application/json': components['schemas']['ListApiKeysResponse'];
113
- };
114
- };
115
- /** @description No content system scope found */
116
- 400: {
117
- headers: {
118
- [name: string]: unknown;
119
- };
120
- content: {
121
- 'application/json': {
122
- /** @example Error message describing the issue. */
123
- message: string;
124
- };
125
- };
126
- };
127
- /** @description Unauthorized */
128
- 401: {
129
- headers: {
130
- [name: string]: unknown;
131
- };
132
- content: {
133
- 'application/json': {
134
- /** @example Error message describing the issue. */
135
- message: string;
136
- };
137
- };
138
- };
139
- /** @description Forbidden */
140
- 403: {
141
- headers: {
142
- [name: string]: unknown;
143
- };
144
- content: {
145
- 'application/json': {
146
- /** @example Error message describing the issue. */
147
- message: string;
148
- };
149
- };
150
- };
151
- };
152
- };
153
- put?: never;
154
- post: {
155
- parameters: {
156
- query?: never;
157
- header?: never;
158
- path?: never;
159
- cookie?: never;
160
- };
161
- requestBody?: {
162
- content: {
163
- 'application/json': components['schemas']['CreateApiKeyRequest'];
164
- };
165
- };
166
- responses: {
167
- /** @description API key created */
168
- 201: {
169
- headers: {
170
- [name: string]: unknown;
171
- };
172
- content: {
173
- 'application/json': components['schemas']['CreateApiKeyResponse'];
174
- };
175
- };
176
- /** @description Bad Request */
177
- 400: {
178
- headers: {
179
- [name: string]: unknown;
180
- };
181
- content: {
182
- 'application/json': {
183
- /** @example Error message describing the issue. */
184
- message: string;
185
- };
186
- };
187
- };
188
- /** @description Unauthorized */
189
- 401: {
190
- headers: {
191
- [name: string]: unknown;
192
- };
193
- content: {
194
- 'application/json': {
195
- /** @example Error message describing the issue. */
196
- message: string;
197
- };
198
- };
199
- };
200
- /** @description Forbidden */
201
- 403: {
202
- headers: {
203
- [name: string]: unknown;
204
- };
205
- content: {
206
- 'application/json': {
207
- /** @example Error message describing the issue. */
208
- message: string;
209
- };
210
- };
211
- };
212
- /** @description Failed to create API key */
213
- 500: {
214
- headers: {
215
- [name: string]: unknown;
216
- };
217
- content: {
218
- 'application/json': {
219
- /** @example Error message describing the issue. */
220
- message: string;
221
- };
222
- };
223
- };
224
- };
225
- };
226
- delete?: never;
227
- options?: never;
228
- head?: never;
229
- patch?: never;
230
- trace?: never;
231
- };
232
- '/api/v0/api_keys/{id}': {
233
- parameters: {
234
- query?: never;
235
- header?: never;
236
- path?: never;
237
- cookie?: never;
238
- };
239
- get?: never;
240
- put?: never;
241
- post?: never;
242
- delete: {
243
- parameters: {
244
- query?: never;
245
- header?: never;
246
- path: {
247
- id: string;
248
- };
249
- cookie?: never;
250
- };
251
- requestBody?: never;
252
- responses: {
253
- /** @description API key deleted successfully */
254
- 204: {
255
- headers: {
256
- [name: string]: unknown;
257
- };
258
- content?: never;
259
- };
260
- /** @description Bad Request */
261
- 400: {
262
- headers: {
263
- [name: string]: unknown;
264
- };
265
- content: {
266
- 'application/json': {
267
- /** @example Error message describing the issue. */
268
- message: string;
269
- };
270
- };
271
- };
272
- /** @description Unauthorized */
273
- 401: {
274
- headers: {
275
- [name: string]: unknown;
276
- };
277
- content: {
278
- 'application/json': {
279
- /** @example Error message describing the issue. */
280
- message: string;
281
- };
282
- };
283
- };
284
- /** @description Forbidden */
285
- 403: {
286
- headers: {
287
- [name: string]: unknown;
288
- };
289
- content: {
290
- 'application/json': {
291
- /** @example Error message describing the issue. */
292
- message: string;
293
- };
294
- };
295
- };
296
- /** @description Not Found */
297
- 404: {
298
- headers: {
299
- [name: string]: unknown;
300
- };
301
- content: {
302
- 'application/json': {
303
- /** @example Error message describing the issue. */
304
- message: string;
305
- };
306
- };
307
- };
308
- /** @description Internal Server Error */
309
- 500: {
310
- headers: {
311
- [name: string]: unknown;
312
- };
313
- content: {
314
- 'application/json': {
315
- /** @example Error message describing the issue. */
316
- message: string;
317
- };
318
- };
319
- };
320
- };
321
- };
322
- options?: never;
323
- head?: never;
324
- patch?: never;
325
- trace?: never;
326
- };
327
- '/api/v0/content_systems': {
328
- parameters: {
329
- query?: never;
330
- header?: never;
331
- path?: never;
332
- cookie?: never;
333
- };
334
- get: {
335
- parameters: {
336
- query?: never;
337
- header?: never;
338
- path?: never;
339
- cookie?: never;
340
- };
341
- requestBody?: never;
342
- responses: {
343
- /** @description Content systems retrieved */
344
- 200: {
345
- headers: {
346
- [name: string]: unknown;
347
- };
348
- content: {
349
- 'application/json': {
350
- data: components['schemas']['ContentSystem'][];
351
- total: number;
352
- };
353
- };
354
- };
355
- /** @description Bad Request */
356
- 400: {
357
- headers: {
358
- [name: string]: unknown;
359
- };
360
- content: {
361
- 'application/json': {
362
- /** @example Error message describing the issue. */
363
- message: string;
364
- };
365
- };
366
- };
367
- /** @description Unauthorized */
368
- 401: {
369
- headers: {
370
- [name: string]: unknown;
371
- };
372
- content: {
373
- 'application/json': {
374
- /** @example Error message describing the issue. */
375
- message: string;
376
- };
377
- };
378
- };
379
- /** @description Forbidden */
380
- 403: {
381
- headers: {
382
- [name: string]: unknown;
383
- };
384
- content: {
385
- 'application/json': {
386
- /** @example Error message describing the issue. */
387
- message: string;
388
- };
389
- };
390
- };
391
- /** @description Internal Server Error */
392
- 500: {
393
- headers: {
394
- [name: string]: unknown;
395
- };
396
- content: {
397
- 'application/json': {
398
- /** @example Error message describing the issue. */
399
- message: string;
400
- };
401
- };
402
- };
403
- };
404
- };
405
- put?: never;
406
- post: {
407
- parameters: {
408
- query?: never;
409
- header?: never;
410
- path?: never;
411
- cookie?: never;
412
- };
413
- requestBody?: {
414
- content: {
415
- 'application/json': components['schemas']['CreateContentSystemRequest'];
416
- };
417
- };
418
- responses: {
419
- /** @description Content system created */
420
- 201: {
421
- headers: {
422
- [name: string]: unknown;
423
- };
424
- content: {
425
- 'application/json': components['schemas']['CreateContentSystemResponse'];
426
- };
427
- };
428
- /** @description Bad Request */
429
- 400: {
430
- headers: {
431
- [name: string]: unknown;
432
- };
433
- content: {
434
- 'application/json': {
435
- /** @example Error message describing the issue. */
436
- message: string;
437
- };
438
- };
439
- };
440
- /** @description Unauthorized */
441
- 401: {
442
- headers: {
443
- [name: string]: unknown;
444
- };
445
- content: {
446
- 'application/json': {
447
- /** @example Error message describing the issue. */
448
- message: string;
449
- };
450
- };
451
- };
452
- /** @description Forbidden */
453
- 403: {
454
- headers: {
455
- [name: string]: unknown;
456
- };
457
- content: {
458
- 'application/json': {
459
- /** @example Error message describing the issue. */
460
- message: string;
461
- };
462
- };
463
- };
464
- /** @description Conflict */
465
- 409: {
466
- headers: {
467
- [name: string]: unknown;
468
- };
469
- content: {
470
- 'application/json': {
471
- /** @example Error message describing the issue. */
472
- message: string;
473
- };
474
- };
475
- };
476
- /** @description Unprocessable Entity */
477
- 422: {
478
- headers: {
479
- [name: string]: unknown;
480
- };
481
- content: {
482
- 'application/json': {
483
- /** @example Error message describing the issue. */
484
- message: string;
485
- };
486
- };
487
- };
488
- /** @description Internal Server Error */
489
- 500: {
490
- headers: {
491
- [name: string]: unknown;
492
- };
493
- content: {
494
- 'application/json': {
495
- /** @example Error message describing the issue. */
496
- message: string;
497
- };
498
- };
499
- };
500
- };
501
- };
502
- delete?: never;
503
- options?: never;
504
- head?: never;
505
- patch?: never;
506
- trace?: never;
507
- };
508
- '/api/v0/content_systems/{id}': {
509
- parameters: {
510
- query?: never;
511
- header?: never;
512
- path?: never;
513
- cookie?: never;
514
- };
515
- get: {
516
- parameters: {
517
- query?: never;
518
- header?: never;
519
- path: {
520
- id: string;
521
- };
522
- cookie?: never;
523
- };
524
- requestBody?: never;
525
- responses: {
526
- /** @description Content system retrieved */
527
- 200: {
528
- headers: {
529
- [name: string]: unknown;
530
- };
531
- content: {
532
- 'application/json': components['schemas']['RetrieveContentSystemResponse'];
533
- };
534
- };
535
- /** @description Bad Request */
536
- 400: {
537
- headers: {
538
- [name: string]: unknown;
539
- };
540
- content: {
541
- 'application/json': {
542
- /** @example Error message describing the issue. */
543
- message: string;
544
- };
545
- };
546
- };
547
- /** @description Unauthorized */
548
- 401: {
549
- headers: {
550
- [name: string]: unknown;
551
- };
552
- content: {
553
- 'application/json': {
554
- /** @example Error message describing the issue. */
555
- message: string;
556
- };
557
- };
558
- };
559
- /** @description Forbidden */
560
- 403: {
561
- headers: {
562
- [name: string]: unknown;
563
- };
564
- content: {
565
- 'application/json': {
566
- /** @example Error message describing the issue. */
567
- message: string;
568
- };
569
- };
570
- };
571
- /** @description Not Found */
572
- 404: {
573
- headers: {
574
- [name: string]: unknown;
575
- };
576
- content: {
577
- 'application/json': {
578
- /** @example Error message describing the issue. */
579
- message: string;
580
- };
581
- };
582
- };
583
- /** @description Internal Server Error */
584
- 500: {
585
- headers: {
586
- [name: string]: unknown;
587
- };
588
- content: {
589
- 'application/json': {
590
- /** @example Error message describing the issue. */
591
- message: string;
592
- };
593
- };
594
- };
595
- };
596
- };
597
- put: {
598
- parameters: {
599
- query?: never;
600
- header?: never;
601
- path: {
602
- id: string;
603
- };
604
- cookie?: never;
605
- };
606
- requestBody?: {
607
- content: {
608
- 'application/json': components['schemas']['UpdateContentSystemRequest'];
609
- };
610
- };
611
- responses: {
612
- /** @description Content system updated */
613
- 200: {
614
- headers: {
615
- [name: string]: unknown;
616
- };
617
- content: {
618
- 'application/json': components['schemas']['UpdateContentSystemResponse'];
619
- };
620
- };
621
- /** @description Bad Request */
622
- 400: {
623
- headers: {
624
- [name: string]: unknown;
625
- };
626
- content: {
627
- 'application/json': {
628
- /** @example Error message describing the issue. */
629
- message: string;
630
- };
631
- };
632
- };
633
- /** @description Unauthorized */
634
- 401: {
635
- headers: {
636
- [name: string]: unknown;
637
- };
638
- content: {
639
- 'application/json': {
640
- /** @example Error message describing the issue. */
641
- message: string;
642
- };
643
- };
644
- };
645
- /** @description Forbidden */
646
- 403: {
647
- headers: {
648
- [name: string]: unknown;
649
- };
650
- content: {
651
- 'application/json': {
652
- /** @example Error message describing the issue. */
653
- message: string;
654
- };
655
- };
656
- };
657
- /** @description Not Found */
658
- 404: {
659
- headers: {
660
- [name: string]: unknown;
661
- };
662
- content: {
663
- 'application/json': {
664
- /** @example Error message describing the issue. */
665
- message: string;
666
- };
667
- };
668
- };
669
- /** @description Conflict */
670
- 409: {
671
- headers: {
672
- [name: string]: unknown;
673
- };
674
- content: {
675
- 'application/json': {
676
- /** @example Error message describing the issue. */
677
- message: string;
678
- };
679
- };
680
- };
681
- /** @description Internal Server Error */
682
- 500: {
683
- headers: {
684
- [name: string]: unknown;
685
- };
686
- content: {
687
- 'application/json': {
688
- /** @example Error message describing the issue. */
689
- message: string;
690
- };
691
- };
692
- };
693
- };
694
- };
695
- post?: never;
696
- delete: {
697
- parameters: {
698
- query?: never;
699
- header?: never;
700
- path: {
701
- id: string;
702
- };
703
- cookie?: never;
704
- };
705
- requestBody?: never;
706
- responses: {
707
- /** @description Content system deleted successfully */
708
- 204: {
709
- headers: {
710
- [name: string]: unknown;
711
- };
712
- content?: never;
713
- };
714
- /** @description Unauthorized */
715
- 401: {
716
- headers: {
717
- [name: string]: unknown;
718
- };
719
- content: {
720
- 'application/json': {
721
- /** @example Error message describing the issue. */
722
- message: string;
723
- };
724
- };
725
- };
726
- /** @description Forbidden */
727
- 403: {
728
- headers: {
729
- [name: string]: unknown;
730
- };
731
- content: {
732
- 'application/json': {
733
- /** @example Error message describing the issue. */
734
- message: string;
735
- };
736
- };
737
- };
738
- /** @description Not Found */
739
- 404: {
740
- headers: {
741
- [name: string]: unknown;
742
- };
743
- content: {
744
- 'application/json': {
745
- /** @example Error message describing the issue. */
746
- message: string;
747
- };
748
- };
749
- };
750
- /** @description Internal Server Error */
751
- 500: {
752
- headers: {
753
- [name: string]: unknown;
754
- };
755
- content: {
756
- 'application/json': {
757
- /** @example Error message describing the issue. */
758
- message: string;
759
- };
760
- };
761
- };
762
- };
763
- };
764
- options?: never;
765
- head?: never;
766
- patch?: never;
767
- trace?: never;
768
- };
769
- '/api/v0/content_systems/{contentSystemId}/collections': {
770
- parameters: {
771
- query?: never;
772
- header?: never;
773
- path?: never;
774
- cookie?: never;
775
- };
776
- get: {
777
- parameters: {
778
- query?: {
779
- id?: string;
780
- };
781
- header?: never;
782
- path: {
783
- contentSystemId: string;
784
- };
785
- cookie?: never;
786
- };
787
- requestBody?: never;
788
- responses: {
789
- /** @description Collections retrieved */
790
- 200: {
791
- headers: {
792
- [name: string]: unknown;
793
- };
794
- content: {
795
- 'application/json': {
796
- data: components['schemas']['Collection'][];
797
- total: number;
798
- };
799
- };
800
- };
801
- /** @description Bad Request */
802
- 400: {
803
- headers: {
804
- [name: string]: unknown;
805
- };
806
- content: {
807
- 'application/json': {
808
- /** @example Error message describing the issue. */
809
- message: string;
810
- };
811
- };
812
- };
813
- /** @description Unauthorized */
814
- 401: {
815
- headers: {
816
- [name: string]: unknown;
817
- };
818
- content: {
819
- 'application/json': {
820
- /** @example Error message describing the issue. */
821
- message: string;
822
- };
823
- };
824
- };
825
- /** @description Forbidden */
826
- 403: {
827
- headers: {
828
- [name: string]: unknown;
829
- };
830
- content: {
831
- 'application/json': {
832
- /** @example Error message describing the issue. */
833
- message: string;
834
- };
835
- };
836
- };
837
- /** @description Internal Server Error */
838
- 500: {
839
- headers: {
840
- [name: string]: unknown;
841
- };
842
- content: {
843
- 'application/json': {
844
- /** @example Error message describing the issue. */
845
- message: string;
846
- };
847
- };
848
- };
849
- };
850
- };
851
- put?: never;
852
- post: {
853
- parameters: {
854
- query?: never;
855
- header?: never;
856
- path: {
857
- contentSystemId: string;
858
- };
859
- cookie?: never;
860
- };
861
- requestBody?: {
862
- content: {
863
- 'application/json': components['schemas']['CreateCollectionRequest'];
864
- };
865
- };
866
- responses: {
867
- /** @description Collection created */
868
- 201: {
869
- headers: {
870
- [name: string]: unknown;
871
- };
872
- content: {
873
- 'application/json': components['schemas']['CreateCollectionResponse'];
874
- };
875
- };
876
- /** @description Bad Request */
877
- 400: {
878
- headers: {
879
- [name: string]: unknown;
880
- };
881
- content: {
882
- 'application/json': {
883
- /** @example Error message describing the issue. */
884
- message: string;
885
- };
886
- };
887
- };
888
- /** @description Unauthorized */
889
- 401: {
890
- headers: {
891
- [name: string]: unknown;
892
- };
893
- content: {
894
- 'application/json': {
895
- /** @example Error message describing the issue. */
896
- message: string;
897
- };
898
- };
899
- };
900
- /** @description Forbidden */
901
- 403: {
902
- headers: {
903
- [name: string]: unknown;
904
- };
905
- content: {
906
- 'application/json': {
907
- /** @example Error message describing the issue. */
908
- message: string;
909
- };
910
- };
911
- };
912
- /** @description Not Found */
913
- 404: {
914
- headers: {
915
- [name: string]: unknown;
916
- };
917
- content: {
918
- 'application/json': {
919
- /** @example Error message describing the issue. */
920
- message: string;
921
- };
922
- };
923
- };
924
- /** @description Conflict */
925
- 409: {
926
- headers: {
927
- [name: string]: unknown;
928
- };
929
- content: {
930
- 'application/json': {
931
- /** @example Error message describing the issue. */
932
- message: string;
933
- };
934
- };
935
- };
936
- /** @description Unprocessable Entity */
937
- 422: {
938
- headers: {
939
- [name: string]: unknown;
940
- };
941
- content: {
942
- 'application/json': {
943
- /** @example Error message describing the issue. */
944
- message: string;
945
- };
946
- };
947
- };
948
- /** @description Internal Server Error */
949
- 500: {
950
- headers: {
951
- [name: string]: unknown;
952
- };
953
- content: {
954
- 'application/json': {
955
- /** @example Error message describing the issue. */
956
- message: string;
957
- };
958
- };
959
- };
960
- };
961
- };
962
- delete?: never;
963
- options?: never;
964
- head?: never;
965
- patch?: never;
966
- trace?: never;
967
- };
968
- '/api/v0/content_systems/{contentSystemId}/collections/{id}': {
969
- parameters: {
970
- query?: never;
971
- header?: never;
972
- path?: never;
973
- cookie?: never;
974
- };
975
- get: {
976
- parameters: {
977
- query?: never;
978
- header?: never;
979
- path: {
980
- contentSystemId: string;
981
- id: string;
982
- };
983
- cookie?: never;
984
- };
985
- requestBody?: never;
986
- responses: {
987
- /** @description Collection retrieved */
988
- 200: {
989
- headers: {
990
- [name: string]: unknown;
991
- };
992
- content: {
993
- 'application/json': components['schemas']['RetrieveCollectionResponse'];
994
- };
995
- };
996
- /** @description Bad Request */
997
- 400: {
998
- headers: {
999
- [name: string]: unknown;
1000
- };
1001
- content: {
1002
- 'application/json': {
1003
- /** @example Error message describing the issue. */
1004
- message: string;
1005
- };
1006
- };
1007
- };
1008
- /** @description Unauthorized */
1009
- 401: {
1010
- headers: {
1011
- [name: string]: unknown;
1012
- };
1013
- content: {
1014
- 'application/json': {
1015
- /** @example Error message describing the issue. */
1016
- message: string;
1017
- };
1018
- };
1019
- };
1020
- /** @description Forbidden */
1021
- 403: {
1022
- headers: {
1023
- [name: string]: unknown;
1024
- };
1025
- content: {
1026
- 'application/json': {
1027
- /** @example Error message describing the issue. */
1028
- message: string;
1029
- };
1030
- };
1031
- };
1032
- /** @description Not Found */
1033
- 404: {
1034
- headers: {
1035
- [name: string]: unknown;
1036
- };
1037
- content: {
1038
- 'application/json': {
1039
- /** @example Error message describing the issue. */
1040
- message: string;
1041
- };
1042
- };
1043
- };
1044
- /** @description Internal Server Error */
1045
- 500: {
1046
- headers: {
1047
- [name: string]: unknown;
1048
- };
1049
- content: {
1050
- 'application/json': {
1051
- /** @example Error message describing the issue. */
1052
- message: string;
1053
- };
1054
- };
1055
- };
1056
- };
1057
- };
1058
- put: {
1059
- parameters: {
1060
- query?: never;
1061
- header?: never;
1062
- path: {
1063
- contentSystemId: string;
1064
- id: string;
1065
- };
1066
- cookie?: never;
1067
- };
1068
- requestBody?: {
1069
- content: {
1070
- 'application/json': components['schemas']['UpdateCollectionRequest'];
1071
- };
1072
- };
1073
- responses: {
1074
- /** @description Collection updated */
1075
- 200: {
1076
- headers: {
1077
- [name: string]: unknown;
1078
- };
1079
- content: {
1080
- 'application/json': components['schemas']['UpdateCollectionResponse'];
1081
- };
1082
- };
1083
- /** @description Bad Request */
1084
- 400: {
1085
- headers: {
1086
- [name: string]: unknown;
1087
- };
1088
- content: {
1089
- 'application/json': {
1090
- /** @example Error message describing the issue. */
1091
- message: string;
1092
- };
1093
- };
1094
- };
1095
- /** @description Unauthorized */
1096
- 401: {
1097
- headers: {
1098
- [name: string]: unknown;
1099
- };
1100
- content: {
1101
- 'application/json': {
1102
- /** @example Error message describing the issue. */
1103
- message: string;
1104
- };
1105
- };
1106
- };
1107
- /** @description Forbidden */
1108
- 403: {
1109
- headers: {
1110
- [name: string]: unknown;
1111
- };
1112
- content: {
1113
- 'application/json': {
1114
- /** @example Error message describing the issue. */
1115
- message: string;
1116
- };
1117
- };
1118
- };
1119
- /** @description Not Found */
1120
- 404: {
1121
- headers: {
1122
- [name: string]: unknown;
1123
- };
1124
- content: {
1125
- 'application/json': {
1126
- /** @example Error message describing the issue. */
1127
- message: string;
1128
- };
1129
- };
1130
- };
1131
- /** @description Conflict */
1132
- 409: {
1133
- headers: {
1134
- [name: string]: unknown;
1135
- };
1136
- content: {
1137
- 'application/json': {
1138
- /** @example Error message describing the issue. */
1139
- message: string;
1140
- };
1141
- };
1142
- };
1143
- /** @description Internal Server Error */
1144
- 500: {
1145
- headers: {
1146
- [name: string]: unknown;
1147
- };
1148
- content: {
1149
- 'application/json': {
1150
- /** @example Error message describing the issue. */
1151
- message: string;
1152
- };
1153
- };
1154
- };
1155
- };
1156
- };
1157
- post?: never;
1158
- delete: {
1159
- parameters: {
1160
- query?: never;
1161
- header?: never;
1162
- path: {
1163
- contentSystemId: string;
1164
- id: string;
1165
- };
1166
- cookie?: never;
1167
- };
1168
- requestBody?: never;
1169
- responses: {
1170
- /** @description Collection deleted successfully */
1171
- 204: {
1172
- headers: {
1173
- [name: string]: unknown;
1174
- };
1175
- content?: never;
1176
- };
1177
- /** @description Bad Request */
1178
- 400: {
1179
- headers: {
1180
- [name: string]: unknown;
1181
- };
1182
- content: {
1183
- 'application/json': {
1184
- /** @example Error message describing the issue. */
1185
- message: string;
1186
- };
1187
- };
1188
- };
1189
- /** @description Unauthorized */
1190
- 401: {
1191
- headers: {
1192
- [name: string]: unknown;
1193
- };
1194
- content: {
1195
- 'application/json': {
1196
- /** @example Error message describing the issue. */
1197
- message: string;
1198
- };
1199
- };
1200
- };
1201
- /** @description Forbidden */
1202
- 403: {
1203
- headers: {
1204
- [name: string]: unknown;
1205
- };
1206
- content: {
1207
- 'application/json': {
1208
- /** @example Error message describing the issue. */
1209
- message: string;
1210
- };
1211
- };
1212
- };
1213
- /** @description Not Found */
1214
- 404: {
1215
- headers: {
1216
- [name: string]: unknown;
1217
- };
1218
- content: {
1219
- 'application/json': {
1220
- /** @example Error message describing the issue. */
1221
- message: string;
1222
- };
1223
- };
1224
- };
1225
- /** @description Internal Server Error */
1226
- 500: {
1227
- headers: {
1228
- [name: string]: unknown;
1229
- };
1230
- content: {
1231
- 'application/json': {
1232
- /** @example Error message describing the issue. */
1233
- message: string;
1234
- };
1235
- };
1236
- };
1237
- };
1238
- };
1239
- options?: never;
1240
- head?: never;
1241
- patch?: never;
1242
- trace?: never;
1243
- };
1244
- '/api/v0/documents:count': {
1245
- parameters: {
1246
- query?: never;
1247
- header?: never;
1248
- path?: never;
1249
- cookie?: never;
1250
- };
1251
- get?: never;
1252
- put?: never;
1253
- post: {
1254
- parameters: {
1255
- query?: never;
1256
- header?: never;
1257
- path?: never;
1258
- cookie?: never;
1259
- };
1260
- requestBody?: {
1261
- content: {
1262
- 'application/json': components['schemas']['CountDocumentRequest'];
1263
- };
1264
- };
1265
- responses: {
1266
- /** @description Document count */
1267
- 200: {
1268
- headers: {
1269
- [name: string]: unknown;
1270
- };
1271
- content: {
1272
- 'application/json': components['schemas']['CountDocumentResponse'];
1273
- };
1274
- };
1275
- /** @description Bad Request */
1276
- 400: {
1277
- headers: {
1278
- [name: string]: unknown;
1279
- };
1280
- content: {
1281
- 'application/json': {
1282
- /** @example Error message describing the issue. */
1283
- message: string;
1284
- };
1285
- };
1286
- };
1287
- /** @description Unauthorized */
1288
- 401: {
1289
- headers: {
1290
- [name: string]: unknown;
1291
- };
1292
- content: {
1293
- 'application/json': {
1294
- /** @example Error message describing the issue. */
1295
- message: string;
1296
- };
1297
- };
1298
- };
1299
- /** @description Forbidden */
1300
- 403: {
1301
- headers: {
1302
- [name: string]: unknown;
1303
- };
1304
- content: {
1305
- 'application/json': {
1306
- /** @example Error message describing the issue. */
1307
- message: string;
1308
- };
1309
- };
1310
- };
1311
- /** @description Not Found */
1312
- 404: {
1313
- headers: {
1314
- [name: string]: unknown;
1315
- };
1316
- content: {
1317
- 'application/json': {
1318
- /** @example Error message describing the issue. */
1319
- message: string;
1320
- };
1321
- };
1322
- };
1323
- /** @description Internal Server Error */
1324
- 500: {
1325
- headers: {
1326
- [name: string]: unknown;
1327
- };
1328
- content: {
1329
- 'application/json': {
1330
- /** @example Error message describing the issue. */
1331
- message: string;
1332
- };
1333
- };
1334
- };
1335
- };
1336
- };
1337
- delete?: never;
1338
- options?: never;
1339
- head?: never;
1340
- patch?: never;
1341
- trace?: never;
1342
- };
1343
- '/api/v0/documents:create': {
1344
- parameters: {
1345
- query?: never;
1346
- header?: never;
1347
- path?: never;
1348
- cookie?: never;
1349
- };
1350
- get?: never;
1351
- put?: never;
1352
- post: {
1353
- parameters: {
1354
- query?: never;
1355
- header?: never;
1356
- path?: never;
1357
- cookie?: never;
1358
- };
1359
- requestBody?: {
1360
- content: {
1361
- 'application/json': components['schemas']['CreateDocumentRequest'];
1362
- };
1363
- };
1364
- responses: {
1365
- /** @description Document created */
1366
- 201: {
1367
- headers: {
1368
- [name: string]: unknown;
1369
- };
1370
- content: {
1371
- 'application/json': components['schemas']['CreateDocumentResponse'];
1372
- };
1373
- };
1374
- /** @description Bad Request */
1375
- 400: {
1376
- headers: {
1377
- [name: string]: unknown;
1378
- };
1379
- content: {
1380
- 'application/json': {
1381
- /** @example Error message describing the issue. */
1382
- message: string;
1383
- };
1384
- };
1385
- };
1386
- /** @description Unauthorized */
1387
- 401: {
1388
- headers: {
1389
- [name: string]: unknown;
1390
- };
1391
- content: {
1392
- 'application/json': {
1393
- /** @example Error message describing the issue. */
1394
- message: string;
1395
- };
1396
- };
1397
- };
1398
- /** @description Forbidden */
1399
- 403: {
1400
- headers: {
1401
- [name: string]: unknown;
1402
- };
1403
- content: {
1404
- 'application/json': {
1405
- /** @example Error message describing the issue. */
1406
- message: string;
1407
- };
1408
- };
1409
- };
1410
- /** @description Not Found */
1411
- 404: {
1412
- headers: {
1413
- [name: string]: unknown;
1414
- };
1415
- content: {
1416
- 'application/json': {
1417
- /** @example Error message describing the issue. */
1418
- message: string;
1419
- };
1420
- };
1421
- };
1422
- /** @description Conflict */
1423
- 409: {
1424
- headers: {
1425
- [name: string]: unknown;
1426
- };
1427
- content: {
1428
- 'application/json': {
1429
- /** @example Error message describing the issue. */
1430
- message: string;
1431
- };
1432
- };
1433
- };
1434
- /** @description Internal Server Error */
1435
- 500: {
1436
- headers: {
1437
- [name: string]: unknown;
1438
- };
1439
- content: {
1440
- 'application/json': {
1441
- /** @example Error message describing the issue. */
1442
- message: string;
1443
- };
1444
- };
1445
- };
1446
- };
1447
- };
1448
- delete?: never;
1449
- options?: never;
1450
- head?: never;
1451
- patch?: never;
1452
- trace?: never;
1453
- };
1454
- '/api/v0/documents:find': {
1455
- parameters: {
1456
- query?: never;
1457
- header?: never;
1458
- path?: never;
1459
- cookie?: never;
1460
- };
1461
- get?: never;
1462
- put?: never;
1463
- post: {
1464
- parameters: {
1465
- query?: never;
1466
- header?: never;
1467
- path?: never;
1468
- cookie?: never;
1469
- };
1470
- requestBody?: {
1471
- content: {
1472
- 'application/json': components['schemas']['FindDocumentsRequest'];
1473
- };
1474
- };
1475
- responses: {
1476
- /** @description Documents found */
1477
- 200: {
1478
- headers: {
1479
- [name: string]: unknown;
1480
- };
1481
- content: {
1482
- 'application/json': components['schemas']['FindDocumentsResponse'];
1483
- };
1484
- };
1485
- /** @description Bad Request */
1486
- 400: {
1487
- headers: {
1488
- [name: string]: unknown;
1489
- };
1490
- content: {
1491
- 'application/json': {
1492
- /** @example Error message describing the issue. */
1493
- message: string;
1494
- };
1495
- };
1496
- };
1497
- /** @description Forbidden */
1498
- 403: {
1499
- headers: {
1500
- [name: string]: unknown;
1501
- };
1502
- content: {
1503
- 'application/json': {
1504
- /** @example Error message describing the issue. */
1505
- message: string;
1506
- };
1507
- };
1508
- };
1509
- /** @description Not Found */
1510
- 404: {
1511
- headers: {
1512
- [name: string]: unknown;
1513
- };
1514
- content: {
1515
- 'application/json': {
1516
- /** @example Error message describing the issue. */
1517
- message: string;
1518
- };
1519
- };
1520
- };
1521
- /** @description Internal Server Error */
1522
- 500: {
1523
- headers: {
1524
- [name: string]: unknown;
1525
- };
1526
- content: {
1527
- 'application/json': {
1528
- /** @example Error message describing the issue. */
1529
- message: string;
1530
- };
1531
- };
1532
- };
1533
- };
1534
- };
1535
- delete?: never;
1536
- options?: never;
1537
- head?: never;
1538
- patch?: never;
1539
- trace?: never;
1540
- };
1541
- '/api/v0/documents:update': {
1542
- parameters: {
1543
- query?: never;
1544
- header?: never;
1545
- path?: never;
1546
- cookie?: never;
1547
- };
1548
- get?: never;
1549
- put?: never;
1550
- post: {
1551
- parameters: {
1552
- query?: never;
1553
- header?: never;
1554
- path?: never;
1555
- cookie?: never;
1556
- };
1557
- requestBody?: {
1558
- content: {
1559
- 'application/json': components['schemas']['UpdateDocumentRequest'];
1560
- };
1561
- };
1562
- responses: {
1563
- /** @description Documents updated */
1564
- 200: {
1565
- headers: {
1566
- [name: string]: unknown;
1567
- };
1568
- content: {
1569
- 'application/json': components['schemas']['UpdateDocumentResponse'];
1570
- };
1571
- };
1572
- /** @description Bad Request */
1573
- 400: {
1574
- headers: {
1575
- [name: string]: unknown;
1576
- };
1577
- content: {
1578
- 'application/json': {
1579
- /** @example Error message describing the issue. */
1580
- message: string;
1581
- };
1582
- };
1583
- };
1584
- /** @description Unauthorized */
1585
- 401: {
1586
- headers: {
1587
- [name: string]: unknown;
1588
- };
1589
- content: {
1590
- 'application/json': {
1591
- /** @example Error message describing the issue. */
1592
- message: string;
1593
- };
1594
- };
1595
- };
1596
- /** @description Forbidden */
1597
- 403: {
1598
- headers: {
1599
- [name: string]: unknown;
1600
- };
1601
- content: {
1602
- 'application/json': {
1603
- /** @example Error message describing the issue. */
1604
- message: string;
1605
- };
1606
- };
1607
- };
1608
- /** @description Not Found */
1609
- 404: {
1610
- headers: {
1611
- [name: string]: unknown;
1612
- };
1613
- content: {
1614
- 'application/json': {
1615
- /** @example Error message describing the issue. */
1616
- message: string;
1617
- };
1618
- };
1619
- };
1620
- /** @description Conflict */
1621
- 409: {
1622
- headers: {
1623
- [name: string]: unknown;
1624
- };
1625
- content: {
1626
- 'application/json': {
1627
- /** @example Error message describing the issue. */
1628
- message: string;
1629
- };
1630
- };
1631
- };
1632
- /** @description Internal Server Error */
1633
- 500: {
1634
- headers: {
1635
- [name: string]: unknown;
1636
- };
1637
- content: {
1638
- 'application/json': {
1639
- /** @example Error message describing the issue. */
1640
- message: string;
1641
- };
1642
- };
1643
- };
1644
- };
1645
- };
1646
- delete?: never;
1647
- options?: never;
1648
- head?: never;
1649
- patch?: never;
1650
- trace?: never;
1651
- };
1652
- '/api/v0/documents:delete': {
1653
- parameters: {
1654
- query?: never;
1655
- header?: never;
1656
- path?: never;
1657
- cookie?: never;
1658
- };
1659
- get?: never;
1660
- put?: never;
1661
- post: {
1662
- parameters: {
1663
- query?: never;
1664
- header?: never;
1665
- path?: never;
1666
- cookie?: never;
1667
- };
1668
- requestBody?: {
1669
- content: {
1670
- 'application/json': components['schemas']['DeleteDocumentRequest'];
1671
- };
1672
- };
1673
- responses: {
1674
- /** @description Documents deleted */
1675
- 200: {
1676
- headers: {
1677
- [name: string]: unknown;
1678
- };
1679
- content: {
1680
- 'application/json': components['schemas']['DeleteDocumentResponse'];
1681
- };
1682
- };
1683
- /** @description Bad Request */
1684
- 400: {
1685
- headers: {
1686
- [name: string]: unknown;
1687
- };
1688
- content: {
1689
- 'application/json': {
1690
- /** @example Error message describing the issue. */
1691
- message: string;
1692
- };
1693
- };
1694
- };
1695
- /** @description Unauthorized */
1696
- 401: {
1697
- headers: {
1698
- [name: string]: unknown;
1699
- };
1700
- content: {
1701
- 'application/json': {
1702
- /** @example Error message describing the issue. */
1703
- message: string;
1704
- };
1705
- };
1706
- };
1707
- /** @description Forbidden */
1708
- 403: {
1709
- headers: {
1710
- [name: string]: unknown;
1711
- };
1712
- content: {
1713
- 'application/json': {
1714
- /** @example Error message describing the issue. */
1715
- message: string;
1716
- };
1717
- };
1718
- };
1719
- /** @description Not Found */
1720
- 404: {
1721
- headers: {
1722
- [name: string]: unknown;
1723
- };
1724
- content: {
1725
- 'application/json': {
1726
- /** @example Error message describing the issue. */
1727
- message: string;
1728
- };
1729
- };
1730
- };
1731
- /** @description Internal Server Error */
1732
- 500: {
1733
- headers: {
1734
- [name: string]: unknown;
1735
- };
1736
- content: {
1737
- 'application/json': {
1738
- /** @example Error message describing the issue. */
1739
- message: string;
1740
- };
1741
- };
1742
- };
1743
- };
1744
- };
1745
- delete?: never;
1746
- options?: never;
1747
- head?: never;
1748
- patch?: never;
1749
- trace?: never;
1750
- };
1751
- '/api/v0/document_versions:count': {
1752
- parameters: {
1753
- query?: never;
1754
- header?: never;
1755
- path?: never;
1756
- cookie?: never;
1757
- };
1758
- get?: never;
1759
- put?: never;
1760
- post: {
1761
- parameters: {
1762
- query?: never;
1763
- header?: never;
1764
- path?: never;
1765
- cookie?: never;
1766
- };
1767
- requestBody?: {
1768
- content: {
1769
- 'application/json': components['schemas']['CountDocumentVersionRequest'];
1770
- };
1771
- };
1772
- responses: {
1773
- /** @description Document version count */
1774
- 200: {
1775
- headers: {
1776
- [name: string]: unknown;
1777
- };
1778
- content: {
1779
- 'application/json': components['schemas']['CountDocumentVersionResponse'];
1780
- };
1781
- };
1782
- /** @description Bad Request */
1783
- 400: {
1784
- headers: {
1785
- [name: string]: unknown;
1786
- };
1787
- content: {
1788
- 'application/json': {
1789
- /** @example Error message describing the issue. */
1790
- message: string;
1791
- };
1792
- };
1793
- };
1794
- /** @description Unauthorized */
1795
- 401: {
1796
- headers: {
1797
- [name: string]: unknown;
1798
- };
1799
- content: {
1800
- 'application/json': {
1801
- /** @example Error message describing the issue. */
1802
- message: string;
1803
- };
1804
- };
1805
- };
1806
- /** @description Forbidden */
1807
- 403: {
1808
- headers: {
1809
- [name: string]: unknown;
1810
- };
1811
- content: {
1812
- 'application/json': {
1813
- /** @example Error message describing the issue. */
1814
- message: string;
1815
- };
1816
- };
1817
- };
1818
- /** @description Not Found */
1819
- 404: {
1820
- headers: {
1821
- [name: string]: unknown;
1822
- };
1823
- content: {
1824
- 'application/json': {
1825
- /** @example Error message describing the issue. */
1826
- message: string;
1827
- };
1828
- };
1829
- };
1830
- /** @description Internal Server Error */
1831
- 500: {
1832
- headers: {
1833
- [name: string]: unknown;
1834
- };
1835
- content: {
1836
- 'application/json': {
1837
- /** @example Error message describing the issue. */
1838
- message: string;
1839
- };
1840
- };
1841
- };
1842
- };
1843
- };
1844
- delete?: never;
1845
- options?: never;
1846
- head?: never;
1847
- patch?: never;
1848
- trace?: never;
1849
- };
1850
- '/api/v0/document_versions:create': {
1851
- parameters: {
1852
- query?: never;
1853
- header?: never;
1854
- path?: never;
1855
- cookie?: never;
1856
- };
1857
- get?: never;
1858
- put?: never;
1859
- post: {
1860
- parameters: {
1861
- query?: never;
1862
- header?: never;
1863
- path?: never;
1864
- cookie?: never;
1865
- };
1866
- requestBody?: {
1867
- content: {
1868
- 'application/json': components['schemas']['CreateDocumentVersionRequest'];
1869
- };
1870
- };
1871
- responses: {
1872
- /** @description Document version created */
1873
- 201: {
1874
- headers: {
1875
- [name: string]: unknown;
1876
- };
1877
- content: {
1878
- 'application/json': components['schemas']['CreateDocumentVersionResponse'];
1879
- };
1880
- };
1881
- /** @description Bad Request */
1882
- 400: {
1883
- headers: {
1884
- [name: string]: unknown;
1885
- };
1886
- content: {
1887
- 'application/json': {
1888
- /** @example Error message describing the issue. */
1889
- message: string;
1890
- };
1891
- };
1892
- };
1893
- /** @description Unauthorized */
1894
- 401: {
1895
- headers: {
1896
- [name: string]: unknown;
1897
- };
1898
- content: {
1899
- 'application/json': {
1900
- /** @example Error message describing the issue. */
1901
- message: string;
1902
- };
1903
- };
1904
- };
1905
- /** @description Forbidden */
1906
- 403: {
1907
- headers: {
1908
- [name: string]: unknown;
1909
- };
1910
- content: {
1911
- 'application/json': {
1912
- /** @example Error message describing the issue. */
1913
- message: string;
1914
- };
1915
- };
1916
- };
1917
- /** @description Not Found */
1918
- 404: {
1919
- headers: {
1920
- [name: string]: unknown;
1921
- };
1922
- content: {
1923
- 'application/json': {
1924
- /** @example Error message describing the issue. */
1925
- message: string;
1926
- };
1927
- };
1928
- };
1929
- /** @description Internal Server Error */
1930
- 500: {
1931
- headers: {
1932
- [name: string]: unknown;
1933
- };
1934
- content: {
1935
- 'application/json': {
1936
- /** @example Error message describing the issue. */
1937
- message: string;
1938
- };
1939
- };
1940
- };
1941
- };
1942
- };
1943
- delete?: never;
1944
- options?: never;
1945
- head?: never;
1946
- patch?: never;
1947
- trace?: never;
1948
- };
1949
- '/api/v0/document_versions:find': {
1950
- parameters: {
1951
- query?: never;
1952
- header?: never;
1953
- path?: never;
1954
- cookie?: never;
1955
- };
1956
- get?: never;
1957
- put?: never;
1958
- post: {
1959
- parameters: {
1960
- query?: never;
1961
- header?: never;
1962
- path?: never;
1963
- cookie?: never;
1964
- };
1965
- requestBody?: {
1966
- content: {
1967
- 'application/json': components['schemas']['FindDocumentVersionsRequest'];
1968
- };
1969
- };
1970
- responses: {
1971
- /** @description Document versions found */
1972
- 200: {
1973
- headers: {
1974
- [name: string]: unknown;
1975
- };
1976
- content: {
1977
- 'application/json': components['schemas']['FindDocumentVersionsResponse'];
1978
- };
1979
- };
1980
- /** @description Bad Request */
1981
- 400: {
1982
- headers: {
1983
- [name: string]: unknown;
1984
- };
1985
- content: {
1986
- 'application/json': {
1987
- /** @example Error message describing the issue. */
1988
- message: string;
1989
- };
1990
- };
1991
- };
1992
- /** @description Unauthorized */
1993
- 401: {
1994
- headers: {
1995
- [name: string]: unknown;
1996
- };
1997
- content: {
1998
- 'application/json': {
1999
- /** @example Error message describing the issue. */
2000
- message: string;
2001
- };
2002
- };
2003
- };
2004
- /** @description Forbidden */
2005
- 403: {
2006
- headers: {
2007
- [name: string]: unknown;
2008
- };
2009
- content: {
2010
- 'application/json': {
2011
- /** @example Error message describing the issue. */
2012
- message: string;
2013
- };
2014
- };
2015
- };
2016
- /** @description Not Found */
2017
- 404: {
2018
- headers: {
2019
- [name: string]: unknown;
2020
- };
2021
- content: {
2022
- 'application/json': {
2023
- /** @example Error message describing the issue. */
2024
- message: string;
2025
- };
2026
- };
2027
- };
2028
- /** @description Internal Server Error */
2029
- 500: {
2030
- headers: {
2031
- [name: string]: unknown;
2032
- };
2033
- content: {
2034
- 'application/json': {
2035
- /** @example Error message describing the issue. */
2036
- message: string;
2037
- };
2038
- };
2039
- };
2040
- };
2041
- };
2042
- delete?: never;
2043
- options?: never;
2044
- head?: never;
2045
- patch?: never;
2046
- trace?: never;
2047
- };
2048
- '/api/v0/document_versions:update': {
2049
- parameters: {
2050
- query?: never;
2051
- header?: never;
2052
- path?: never;
2053
- cookie?: never;
2054
- };
2055
- get?: never;
2056
- put?: never;
2057
- post: {
2058
- parameters: {
2059
- query?: never;
2060
- header?: never;
2061
- path?: never;
2062
- cookie?: never;
2063
- };
2064
- requestBody?: {
2065
- content: {
2066
- 'application/json': components['schemas']['UpdateDocumentVersionRequest'];
2067
- };
2068
- };
2069
- responses: {
2070
- /** @description Document versions updated */
2071
- 200: {
2072
- headers: {
2073
- [name: string]: unknown;
2074
- };
2075
- content: {
2076
- 'application/json': components['schemas']['UpdateDocumentVersionResponse'];
2077
- };
2078
- };
2079
- /** @description Bad Request */
2080
- 400: {
2081
- headers: {
2082
- [name: string]: unknown;
2083
- };
2084
- content: {
2085
- 'application/json': {
2086
- /** @example Error message describing the issue. */
2087
- message: string;
2088
- };
2089
- };
2090
- };
2091
- /** @description Unauthorized */
2092
- 401: {
2093
- headers: {
2094
- [name: string]: unknown;
2095
- };
2096
- content: {
2097
- 'application/json': {
2098
- /** @example Error message describing the issue. */
2099
- message: string;
2100
- };
2101
- };
2102
- };
2103
- /** @description Forbidden */
2104
- 403: {
2105
- headers: {
2106
- [name: string]: unknown;
2107
- };
2108
- content: {
2109
- 'application/json': {
2110
- /** @example Error message describing the issue. */
2111
- message: string;
2112
- };
2113
- };
2114
- };
2115
- /** @description Not Found */
2116
- 404: {
2117
- headers: {
2118
- [name: string]: unknown;
2119
- };
2120
- content: {
2121
- 'application/json': {
2122
- /** @example Error message describing the issue. */
2123
- message: string;
2124
- };
2125
- };
2126
- };
2127
- /** @description Internal Server Error */
2128
- 500: {
2129
- headers: {
2130
- [name: string]: unknown;
2131
- };
2132
- content: {
2133
- 'application/json': {
2134
- /** @example Error message describing the issue. */
2135
- message: string;
2136
- };
2137
- };
2138
- };
2139
- };
2140
- };
2141
- delete?: never;
2142
- options?: never;
2143
- head?: never;
2144
- patch?: never;
2145
- trace?: never;
2146
- };
2147
- '/api/v0/document_versions:delete': {
2148
- parameters: {
2149
- query?: never;
2150
- header?: never;
2151
- path?: never;
2152
- cookie?: never;
2153
- };
2154
- get?: never;
2155
- put?: never;
2156
- post: {
2157
- parameters: {
2158
- query?: never;
2159
- header?: never;
2160
- path?: never;
2161
- cookie?: never;
2162
- };
2163
- requestBody?: {
2164
- content: {
2165
- 'application/json': components['schemas']['DeleteDocumentVersionRequest'];
2166
- };
2167
- };
2168
- responses: {
2169
- /** @description Document versions deleted */
2170
- 200: {
2171
- headers: {
2172
- [name: string]: unknown;
2173
- };
2174
- content: {
2175
- 'application/json': components['schemas']['DeleteDocumentVersionResponse'];
2176
- };
2177
- };
2178
- /** @description Bad Request */
2179
- 400: {
2180
- headers: {
2181
- [name: string]: unknown;
2182
- };
2183
- content: {
2184
- 'application/json': {
2185
- /** @example Error message describing the issue. */
2186
- message: string;
2187
- };
2188
- };
2189
- };
2190
- /** @description Unauthorized */
2191
- 401: {
2192
- headers: {
2193
- [name: string]: unknown;
2194
- };
2195
- content: {
2196
- 'application/json': {
2197
- /** @example Error message describing the issue. */
2198
- message: string;
2199
- };
2200
- };
2201
- };
2202
- /** @description Forbidden */
2203
- 403: {
2204
- headers: {
2205
- [name: string]: unknown;
2206
- };
2207
- content: {
2208
- 'application/json': {
2209
- /** @example Error message describing the issue. */
2210
- message: string;
2211
- };
2212
- };
2213
- };
2214
- /** @description Not Found */
2215
- 404: {
2216
- headers: {
2217
- [name: string]: unknown;
2218
- };
2219
- content: {
2220
- 'application/json': {
2221
- /** @example Error message describing the issue. */
2222
- message: string;
2223
- };
2224
- };
2225
- };
2226
- /** @description Internal Server Error */
2227
- 500: {
2228
- headers: {
2229
- [name: string]: unknown;
2230
- };
2231
- content: {
2232
- 'application/json': {
2233
- /** @example Error message describing the issue. */
2234
- message: string;
2235
- };
2236
- };
2237
- };
2238
- };
2239
- };
2240
- delete?: never;
2241
- options?: never;
2242
- head?: never;
2243
- patch?: never;
2244
- trace?: never;
2245
- };
2246
- '/api/v0/uploads/sign': {
2247
- parameters: {
2248
- query?: never;
2249
- header?: never;
2250
- path?: never;
2251
- cookie?: never;
2252
- };
2253
- get?: never;
2254
- put?: never;
2255
- post: {
2256
- parameters: {
2257
- query?: never;
2258
- header?: never;
2259
- path?: never;
2260
- cookie?: never;
2261
- };
2262
- requestBody?: {
2263
- content: {
2264
- 'application/json': components['schemas']['GeneratePresignedUploadUrlRequest'];
2265
- };
2266
- };
2267
- responses: {
2268
- /** @description Presigned upload URL generated */
2269
- 200: {
2270
- headers: {
2271
- [name: string]: unknown;
2272
- };
2273
- content: {
2274
- 'application/json': components['schemas']['GeneratePresignedUploadUrlResponse'];
2275
- };
2276
- };
2277
- /** @description Bad Request */
2278
- 400: {
2279
- headers: {
2280
- [name: string]: unknown;
2281
- };
2282
- content: {
2283
- 'application/json': {
2284
- /** @example Error message describing the issue. */
2285
- message: string;
2286
- };
2287
- };
2288
- };
2289
- /** @description Unauthorized */
2290
- 401: {
2291
- headers: {
2292
- [name: string]: unknown;
2293
- };
2294
- content: {
2295
- 'application/json': {
2296
- /** @example Error message describing the issue. */
2297
- message: string;
2298
- };
2299
- };
2300
- };
2301
- /** @description Forbidden */
2302
- 403: {
2303
- headers: {
2304
- [name: string]: unknown;
2305
- };
2306
- content: {
2307
- 'application/json': {
2308
- /** @example Error message describing the issue. */
2309
- message: string;
2310
- };
2311
- };
2312
- };
2313
- /** @description Not Found */
2314
- 404: {
2315
- headers: {
2316
- [name: string]: unknown;
2317
- };
2318
- content: {
2319
- 'application/json': {
2320
- /** @example Error message describing the issue. */
2321
- message: string;
2322
- };
2323
- };
2324
- };
2325
- /** @description Service Unavailable */
2326
- 503: {
2327
- headers: {
2328
- [name: string]: unknown;
2329
- };
2330
- content: {
2331
- 'application/json': {
2332
- /** @example Error message describing the issue. */
2333
- message: string;
2334
- };
2335
- };
2336
- };
2337
- };
2338
- };
2339
- delete?: never;
2340
- options?: never;
2341
- head?: never;
2342
- patch?: never;
2343
- trace?: never;
2344
- };
2345
- '/api/v0/uploads/download/sign': {
2346
- parameters: {
2347
- query?: never;
2348
- header?: never;
2349
- path?: never;
2350
- cookie?: never;
2351
- };
2352
- get?: never;
2353
- put?: never;
2354
- post: {
2355
- parameters: {
2356
- query?: never;
2357
- header?: never;
2358
- path?: never;
2359
- cookie?: never;
2360
- };
2361
- requestBody?: {
2362
- content: {
2363
- 'application/json': components['schemas']['GeneratePresignedDownloadUrlRequest'];
2364
- };
2365
- };
2366
- responses: {
2367
- /** @description Presigned download URL generated */
2368
- 200: {
2369
- headers: {
2370
- [name: string]: unknown;
2371
- };
2372
- content: {
2373
- 'application/json': components['schemas']['GeneratePresignedDownloadUrlResponse'];
2374
- };
2375
- };
2376
- /** @description Bad Request */
2377
- 400: {
2378
- headers: {
2379
- [name: string]: unknown;
2380
- };
2381
- content: {
2382
- 'application/json': {
2383
- /** @example Error message describing the issue. */
2384
- message: string;
2385
- };
2386
- };
2387
- };
2388
- /** @description Unauthorized */
2389
- 401: {
2390
- headers: {
2391
- [name: string]: unknown;
2392
- };
2393
- content: {
2394
- 'application/json': {
2395
- /** @example Error message describing the issue. */
2396
- message: string;
2397
- };
2398
- };
2399
- };
2400
- /** @description Forbidden */
2401
- 403: {
2402
- headers: {
2403
- [name: string]: unknown;
2404
- };
2405
- content: {
2406
- 'application/json': {
2407
- /** @example Error message describing the issue. */
2408
- message: string;
2409
- };
2410
- };
2411
- };
2412
- /** @description Not Found */
2413
- 404: {
2414
- headers: {
2415
- [name: string]: unknown;
2416
- };
2417
- content: {
2418
- 'application/json': {
2419
- /** @example Error message describing the issue. */
2420
- message: string;
2421
- };
2422
- };
2423
- };
2424
- /** @description Service Unavailable */
2425
- 503: {
2426
- headers: {
2427
- [name: string]: unknown;
2428
- };
2429
- content: {
2430
- 'application/json': {
2431
- /** @example Error message describing the issue. */
2432
- message: string;
2433
- };
2434
- };
2435
- };
2436
- };
2437
- };
2438
- delete?: never;
2439
- options?: never;
2440
- head?: never;
2441
- patch?: never;
2442
- trace?: never;
2443
- };
2444
- '/api/v0/uploads/multipart/initiate': {
2445
- parameters: {
2446
- query?: never;
2447
- header?: never;
2448
- path?: never;
2449
- cookie?: never;
2450
- };
2451
- get?: never;
2452
- put?: never;
2453
- post: {
2454
- parameters: {
2455
- query?: never;
2456
- header?: never;
2457
- path?: never;
2458
- cookie?: never;
2459
- };
2460
- requestBody?: {
2461
- content: {
2462
- 'application/json': components['schemas']['InitiateMultipartUploadRequest'];
2463
- };
2464
- };
2465
- responses: {
2466
- /** @description Multipart upload initiated */
2467
- 200: {
2468
- headers: {
2469
- [name: string]: unknown;
2470
- };
2471
- content: {
2472
- 'application/json': components['schemas']['InitiateMultipartUploadResponse'];
2473
- };
2474
- };
2475
- /** @description Bad Request */
2476
- 400: {
2477
- headers: {
2478
- [name: string]: unknown;
2479
- };
2480
- content: {
2481
- 'application/json': {
2482
- /** @example Error message describing the issue. */
2483
- message: string;
2484
- };
2485
- };
2486
- };
2487
- /** @description Unauthorized */
2488
- 401: {
2489
- headers: {
2490
- [name: string]: unknown;
2491
- };
2492
- content: {
2493
- 'application/json': {
2494
- /** @example Error message describing the issue. */
2495
- message: string;
2496
- };
2497
- };
2498
- };
2499
- /** @description Forbidden */
2500
- 403: {
2501
- headers: {
2502
- [name: string]: unknown;
2503
- };
2504
- content: {
2505
- 'application/json': {
2506
- /** @example Error message describing the issue. */
2507
- message: string;
2508
- };
2509
- };
2510
- };
2511
- /** @description Not Found */
2512
- 404: {
2513
- headers: {
2514
- [name: string]: unknown;
2515
- };
2516
- content: {
2517
- 'application/json': {
2518
- /** @example Error message describing the issue. */
2519
- message: string;
2520
- };
2521
- };
2522
- };
2523
- /** @description Service Unavailable */
2524
- 503: {
2525
- headers: {
2526
- [name: string]: unknown;
2527
- };
2528
- content: {
2529
- 'application/json': {
2530
- /** @example Error message describing the issue. */
2531
- message: string;
2532
- };
2533
- };
2534
- };
2535
- };
2536
- };
2537
- delete?: never;
2538
- options?: never;
2539
- head?: never;
2540
- patch?: never;
2541
- trace?: never;
2542
- };
2543
- '/api/v0/uploads/multipart/parts': {
2544
- parameters: {
2545
- query?: never;
2546
- header?: never;
2547
- path?: never;
2548
- cookie?: never;
2549
- };
2550
- get?: never;
2551
- put?: never;
2552
- post: {
2553
- parameters: {
2554
- query?: never;
2555
- header?: never;
2556
- path?: never;
2557
- cookie?: never;
2558
- };
2559
- requestBody?: {
2560
- content: {
2561
- 'application/json': components['schemas']['GenerateUploadPartUrlsRequest'];
2562
- };
2563
- };
2564
- responses: {
2565
- /** @description Upload part URLs generated */
2566
- 200: {
2567
- headers: {
2568
- [name: string]: unknown;
2569
- };
2570
- content: {
2571
- 'application/json': components['schemas']['GenerateUploadPartUrlsResponse'];
2572
- };
2573
- };
2574
- /** @description Bad Request */
2575
- 400: {
2576
- headers: {
2577
- [name: string]: unknown;
2578
- };
2579
- content: {
2580
- 'application/json': {
2581
- /** @example Error message describing the issue. */
2582
- message: string;
2583
- };
2584
- };
2585
- };
2586
- /** @description Unauthorized */
2587
- 401: {
2588
- headers: {
2589
- [name: string]: unknown;
2590
- };
2591
- content: {
2592
- 'application/json': {
2593
- /** @example Error message describing the issue. */
2594
- message: string;
2595
- };
2596
- };
2597
- };
2598
- /** @description Forbidden */
2599
- 403: {
2600
- headers: {
2601
- [name: string]: unknown;
2602
- };
2603
- content: {
2604
- 'application/json': {
2605
- /** @example Error message describing the issue. */
2606
- message: string;
2607
- };
2608
- };
2609
- };
2610
- /** @description Not Found */
2611
- 404: {
2612
- headers: {
2613
- [name: string]: unknown;
2614
- };
2615
- content: {
2616
- 'application/json': {
2617
- /** @example Error message describing the issue. */
2618
- message: string;
2619
- };
2620
- };
2621
- };
2622
- /** @description Service Unavailable */
2623
- 503: {
2624
- headers: {
2625
- [name: string]: unknown;
2626
- };
2627
- content: {
2628
- 'application/json': {
2629
- /** @example Error message describing the issue. */
2630
- message: string;
2631
- };
2632
- };
2633
- };
2634
- };
2635
- };
2636
- delete?: never;
2637
- options?: never;
2638
- head?: never;
2639
- patch?: never;
2640
- trace?: never;
2641
- };
2642
- '/api/v0/uploads/multipart/complete': {
2643
- parameters: {
2644
- query?: never;
2645
- header?: never;
2646
- path?: never;
2647
- cookie?: never;
2648
- };
2649
- get?: never;
2650
- put?: never;
2651
- post: {
2652
- parameters: {
2653
- query?: never;
2654
- header?: never;
2655
- path?: never;
2656
- cookie?: never;
2657
- };
2658
- requestBody?: {
2659
- content: {
2660
- 'application/json': components['schemas']['CompleteMultipartUploadRequest'];
2661
- };
2662
- };
2663
- responses: {
2664
- /** @description Multipart upload completed */
2665
- 200: {
2666
- headers: {
2667
- [name: string]: unknown;
2668
- };
2669
- content: {
2670
- 'application/json': components['schemas']['CompleteMultipartUploadResponse'];
2671
- };
2672
- };
2673
- /** @description Bad Request */
2674
- 400: {
2675
- headers: {
2676
- [name: string]: unknown;
2677
- };
2678
- content: {
2679
- 'application/json': {
2680
- /** @example Error message describing the issue. */
2681
- message: string;
2682
- };
2683
- };
2684
- };
2685
- /** @description Unauthorized */
2686
- 401: {
2687
- headers: {
2688
- [name: string]: unknown;
2689
- };
2690
- content: {
2691
- 'application/json': {
2692
- /** @example Error message describing the issue. */
2693
- message: string;
2694
- };
2695
- };
2696
- };
2697
- /** @description Forbidden */
2698
- 403: {
2699
- headers: {
2700
- [name: string]: unknown;
2701
- };
2702
- content: {
2703
- 'application/json': {
2704
- /** @example Error message describing the issue. */
2705
- message: string;
2706
- };
2707
- };
2708
- };
2709
- /** @description Not Found */
2710
- 404: {
2711
- headers: {
2712
- [name: string]: unknown;
2713
- };
2714
- content: {
2715
- 'application/json': {
2716
- /** @example Error message describing the issue. */
2717
- message: string;
2718
- };
2719
- };
2720
- };
2721
- /** @description Service Unavailable */
2722
- 503: {
2723
- headers: {
2724
- [name: string]: unknown;
2725
- };
2726
- content: {
2727
- 'application/json': {
2728
- /** @example Error message describing the issue. */
2729
- message: string;
2730
- };
2731
- };
2732
- };
2733
- };
2734
- };
2735
- delete?: never;
2736
- options?: never;
2737
- head?: never;
2738
- patch?: never;
2739
- trace?: never;
2740
- };
2741
- '/api/v0/uploads/multipart/abort': {
2742
- parameters: {
2743
- query?: never;
2744
- header?: never;
2745
- path?: never;
2746
- cookie?: never;
2747
- };
2748
- get?: never;
2749
- put?: never;
2750
- post: {
2751
- parameters: {
2752
- query?: never;
2753
- header?: never;
2754
- path?: never;
2755
- cookie?: never;
2756
- };
2757
- requestBody?: {
2758
- content: {
2759
- 'application/json': components['schemas']['AbortMultipartUploadRequest'];
2760
- };
2761
- };
2762
- responses: {
2763
- /** @description Multipart upload aborted */
2764
- 200: {
2765
- headers: {
2766
- [name: string]: unknown;
2767
- };
2768
- content: {
2769
- 'application/json': components['schemas']['AbortMultipartUploadResponse'];
2770
- };
2771
- };
2772
- /** @description Bad Request */
2773
- 400: {
2774
- headers: {
2775
- [name: string]: unknown;
2776
- };
2777
- content: {
2778
- 'application/json': {
2779
- /** @example Error message describing the issue. */
2780
- message: string;
2781
- };
2782
- };
2783
- };
2784
- /** @description Unauthorized */
2785
- 401: {
2786
- headers: {
2787
- [name: string]: unknown;
2788
- };
2789
- content: {
2790
- 'application/json': {
2791
- /** @example Error message describing the issue. */
2792
- message: string;
2793
- };
2794
- };
2795
- };
2796
- /** @description Forbidden */
2797
- 403: {
2798
- headers: {
2799
- [name: string]: unknown;
2800
- };
2801
- content: {
2802
- 'application/json': {
2803
- /** @example Error message describing the issue. */
2804
- message: string;
2805
- };
2806
- };
2807
- };
2808
- /** @description Not Found */
2809
- 404: {
2810
- headers: {
2811
- [name: string]: unknown;
2812
- };
2813
- content: {
2814
- 'application/json': {
2815
- /** @example Error message describing the issue. */
2816
- message: string;
2817
- };
2818
- };
2819
- };
2820
- /** @description Service Unavailable */
2821
- 503: {
2822
- headers: {
2823
- [name: string]: unknown;
2824
- };
2825
- content: {
2826
- 'application/json': {
2827
- /** @example Error message describing the issue. */
2828
- message: string;
2829
- };
2830
- };
2831
- };
2832
- };
2833
- };
2834
- delete?: never;
2835
- options?: never;
2836
- head?: never;
2837
- patch?: never;
2838
- trace?: never;
2839
- };
2840
- '/api/v0/uploads/{collectionId}/{filename}': {
2841
- parameters: {
2842
- query?: never;
2843
- header?: never;
2844
- path?: never;
2845
- cookie?: never;
2846
- };
2847
- get?: never;
2848
- put?: never;
2849
- post?: never;
2850
- delete: {
2851
- parameters: {
2852
- query?: never;
2853
- header?: never;
2854
- path: {
2855
- collectionId: string;
2856
- filename: string;
2857
- };
2858
- cookie?: never;
2859
- };
2860
- requestBody?: never;
2861
- responses: {
2862
- /** @description File deleted successfully */
2863
- 200: {
2864
- headers: {
2865
- [name: string]: unknown;
2866
- };
2867
- content: {
2868
- 'application/json': components['schemas']['DeleteFileResponse'];
2869
- };
2870
- };
2871
- /** @description Bad Request */
2872
- 400: {
2873
- headers: {
2874
- [name: string]: unknown;
2875
- };
2876
- content: {
2877
- 'application/json': {
2878
- /** @example Error message describing the issue. */
2879
- message: string;
2880
- };
2881
- };
2882
- };
2883
- /** @description Unauthorized */
2884
- 401: {
2885
- headers: {
2886
- [name: string]: unknown;
2887
- };
2888
- content: {
2889
- 'application/json': {
2890
- /** @example Error message describing the issue. */
2891
- message: string;
2892
- };
2893
- };
2894
- };
2895
- /** @description Forbidden */
2896
- 403: {
2897
- headers: {
2898
- [name: string]: unknown;
2899
- };
2900
- content: {
2901
- 'application/json': {
2902
- /** @example Error message describing the issue. */
2903
- message: string;
2904
- };
2905
- };
2906
- };
2907
- /** @description Not Found */
2908
- 404: {
2909
- headers: {
2910
- [name: string]: unknown;
2911
- };
2912
- content: {
2913
- 'application/json': {
2914
- /** @example Error message describing the issue. */
2915
- message: string;
2916
- };
2917
- };
2918
- };
2919
- /** @description Service Unavailable */
2920
- 503: {
2921
- headers: {
2922
- [name: string]: unknown;
2923
- };
2924
- content: {
2925
- 'application/json': {
2926
- /** @example Error message describing the issue. */
2927
- message: string;
2928
- };
2929
- };
2930
- };
2931
- };
2932
- };
2933
- options?: never;
2934
- head?: never;
2935
- patch?: never;
2936
- trace?: never;
2937
- };
2938
- '/.well-known/jwks.json': {
2939
- parameters: {
2940
- query?: never;
2941
- header?: never;
2942
- path?: never;
2943
- cookie?: never;
2944
- };
2945
- get: {
2946
- parameters: {
2947
- query?: never;
2948
- header?: never;
2949
- path?: never;
2950
- cookie?: never;
2951
- };
2952
- requestBody?: never;
2953
- responses: {
2954
- /** @description JSON Web Key Set */
2955
- 200: {
2956
- headers: {
2957
- [name: string]: unknown;
2958
- };
2959
- content: {
2960
- 'application/json': components['schemas']['JwksResponse'];
2961
- };
2962
- };
2963
- /** @description Internal Server Error - Key not found */
2964
- 500: {
2965
- headers: {
2966
- [name: string]: unknown;
2967
- };
2968
- content: {
2969
- 'application/json': {
2970
- message: string;
2971
- };
2972
- };
2973
- };
2974
- };
2975
- };
2976
- put?: never;
2977
- post?: never;
2978
- delete?: never;
2979
- options?: never;
2980
- head?: never;
2981
- patch?: never;
2982
- trace?: never;
2983
- };
2984
- '/dev/jwt': {
2985
- parameters: {
2986
- query?: never;
2987
- header?: never;
2988
- path?: never;
2989
- cookie?: never;
2990
- };
2991
- get?: never;
2992
- put?: never;
2993
- post: {
2994
- parameters: {
2995
- query?: never;
2996
- header?: never;
2997
- path?: never;
2998
- cookie?: never;
2999
- };
3000
- requestBody?: {
3001
- content: {
3002
- 'application/json': components['schemas']['CreateJwtRequest'];
3003
- };
3004
- };
3005
- responses: {
3006
- /** @description JWT created successfully */
3007
- 200: {
3008
- headers: {
3009
- [name: string]: unknown;
3010
- };
3011
- content: {
3012
- 'application/json': components['schemas']['CreateJwtResponse'];
3013
- };
3014
- };
3015
- /** @description Internal Server Error - Private key not found */
3016
- 500: {
3017
- headers: {
3018
- [name: string]: unknown;
3019
- };
3020
- content: {
3021
- 'application/json': {
3022
- message: string;
3023
- };
3024
- };
3025
- };
3026
- };
3027
- };
3028
- delete?: never;
3029
- options?: never;
3030
- head?: never;
3031
- patch?: never;
3032
- trace?: never;
3033
- };
3034
- '/dev/clear-db': {
3035
- parameters: {
3036
- query?: never;
3037
- header?: never;
3038
- path?: never;
3039
- cookie?: never;
3040
- };
3041
- get?: never;
3042
- put?: never;
3043
- post: {
3044
- parameters: {
3045
- query?: never;
3046
- header?: never;
3047
- path?: never;
3048
- cookie?: never;
3049
- };
3050
- requestBody?: never;
3051
- responses: {
3052
- /** @description Database cleared successfully */
3053
- 200: {
3054
- headers: {
3055
- [name: string]: unknown;
3056
- };
3057
- content: {
3058
- 'application/json': {
3059
- message: string;
3060
- success: boolean;
3061
- };
3062
- };
3063
- };
3064
- };
3065
- };
3066
- delete?: never;
3067
- options?: never;
3068
- head?: never;
3069
- patch?: never;
3070
- trace?: never;
3071
- };
3072
- };
3073
- export type webhooks = Record<string, never>;
3074
- export type components = {
3075
- schemas: {
3076
- AuthContextResponse: {
3077
- /**
3078
- * @description Type of authentication scope
3079
- * @example project
3080
- * @enum {string}
3081
- */
3082
- scopeType: 'super_user' | 'project';
3083
- /**
3084
- * @description Content system ID if scopeType is project, undefined for super_user
3085
- * @example 4cfea8de-4f44-4efd-a8fc-7d539249e9f1
3086
- */
3087
- contentSystemScope?: string;
3088
- };
3089
- HealthResponse: {
3090
- /** @example ok */
3091
- status: string;
3092
- /** @example connected */
3093
- database: string;
3094
- /** @example available */
3095
- s3: string;
3096
- /** @example 2026-01-01T00:00:00.000Z */
3097
- timestamp: string;
3098
- };
3099
- ApiKey: {
3100
- /** @example 123abc */
3101
- id: string;
3102
- /** @example My API Key */
3103
- name: string;
3104
- /** @example 123def */
3105
- contentSystemId: string;
3106
- /** @example BRTRKFsL */
3107
- shortToken: string;
3108
- /**
3109
- * Format: date
3110
- * @example 2024-01-01T00:00:00.000Z
3111
- */
3112
- createdAt: string;
3113
- /**
3114
- * Format: date
3115
- * @example 2024-01-01T00:00:00.000Z
3116
- */
3117
- updatedAt: string;
3118
- };
3119
- ListApiKeysResponse: {
3120
- data: components['schemas']['ApiKey'][];
3121
- total: number;
3122
- };
3123
- CreateApiKeyResponse: {
3124
- /** @example 123abc */
3125
- id: string;
3126
- /** @example 123def */
3127
- contentSystemId: string;
3128
- /** @example BRTRKFsL */
3129
- shortToken: string;
3130
- /**
3131
- * @description Full API key - only returned on creation
3132
- * @example figma_BRTRKFsL_51FwqftsmMDHHbJAMEXXHCgG
3133
- */
3134
- fullToken: string;
3135
- /**
3136
- * Format: date
3137
- * @example 2024-01-01T00:00:00.000Z
3138
- */
3139
- createdAt: string;
3140
- /**
3141
- * Format: date
3142
- * @example 2024-01-01T00:00:00.000Z
3143
- */
3144
- updatedAt: string;
3145
- };
3146
- CreateApiKeyRequest: {
3147
- /** @example My API Key */
3148
- name: string;
3149
- /** @example 123def */
3150
- contentSystemId: string;
3151
- };
3152
- ContentSystem: {
3153
- /** @example cms-xxxxx-xxxxx */
3154
- id: string;
3155
- /** @example demo-tenant */
3156
- owningKey: string;
3157
- /** @example Demo CMS */
3158
- name: string;
3159
- /**
3160
- * Format: date
3161
- * @example 2024-01-01T00:00:00Z
3162
- */
3163
- createdAt: string;
3164
- /**
3165
- * Format: date
3166
- * @example 2024-01-01T00:00:00Z
3167
- */
3168
- updatedAt: string;
3169
- };
3170
- CreateContentSystemResponse: {
3171
- /** @example cms-xxxxx-xxxxx */
3172
- id: string;
3173
- /** @example demo-tenant */
3174
- owningKey: string;
3175
- /** @example Demo CMS */
3176
- name: string;
3177
- /**
3178
- * Format: date
3179
- * @example 2024-01-01T00:00:00Z
3180
- */
3181
- createdAt: string;
3182
- /**
3183
- * Format: date
3184
- * @example 2024-01-01T00:00:00Z
3185
- */
3186
- updatedAt: string;
3187
- };
3188
- CreateContentSystemRequest: {
3189
- /** @example demo-tenant */
3190
- owningKey: string;
3191
- /** @example Demo CMS */
3192
- name: string;
3193
- };
3194
- RetrieveContentSystemResponse: {
3195
- /** @example cms-xxxxx-xxxxx */
3196
- id: string;
3197
- /** @example demo-tenant */
3198
- owningKey: string;
3199
- /** @example Demo CMS */
3200
- name: string;
3201
- /**
3202
- * Format: date
3203
- * @example 2024-01-01T00:00:00Z
3204
- */
3205
- createdAt: string;
3206
- /**
3207
- * Format: date
3208
- * @example 2024-01-01T00:00:00Z
3209
- */
3210
- updatedAt: string;
3211
- };
3212
- UpdateContentSystemResponse: {
3213
- /** @example cms-xxxxx-xxxxx */
3214
- id: string;
3215
- /** @example demo-tenant */
3216
- owningKey: string;
3217
- /** @example Demo CMS */
3218
- name: string;
3219
- /**
3220
- * Format: date
3221
- * @example 2024-01-01T00:00:00Z
3222
- */
3223
- createdAt: string;
3224
- /**
3225
- * Format: date
3226
- * @example 2024-01-01T00:00:00Z
3227
- */
3228
- updatedAt: string;
3229
- };
3230
- UpdateContentSystemRequest: {
3231
- /** @example demo-tenant */
3232
- owningKey?: string;
3233
- /** @example Demo CMS */
3234
- name?: string;
3235
- };
3236
- Collection: {
3237
- /** @example posts */
3238
- id: string;
3239
- /** @example cms-xxxxx-xxxxx */
3240
- contentSystemId: string;
3241
- /**
3242
- * Format: date
3243
- * @example 2024-01-01T00:00:00Z
3244
- */
3245
- createdAt: string;
3246
- /**
3247
- * Format: date
3248
- * @example 2024-01-01T00:00:00Z
3249
- */
3250
- updatedAt: string;
3251
- };
3252
- CreateCollectionResponse: {
3253
- /** @example posts */
3254
- id: string;
3255
- /** @example cms-xxxxx-xxxxx */
3256
- contentSystemId: string;
3257
- /**
3258
- * Format: date
3259
- * @example 2024-01-01T00:00:00Z
3260
- */
3261
- createdAt: string;
3262
- /**
3263
- * Format: date
3264
- * @example 2024-01-01T00:00:00Z
3265
- */
3266
- updatedAt: string;
3267
- };
3268
- CreateCollectionRequest: {
3269
- /** @example posts */
3270
- id: string;
3271
- };
3272
- RetrieveCollectionResponse: {
3273
- /** @example posts */
3274
- id: string;
3275
- /** @example cms-xxxxx-xxxxx */
3276
- contentSystemId: string;
3277
- /**
3278
- * Format: date
3279
- * @example 2024-01-01T00:00:00Z
3280
- */
3281
- createdAt: string;
3282
- /**
3283
- * Format: date
3284
- * @example 2024-01-01T00:00:00Z
3285
- */
3286
- updatedAt: string;
3287
- };
3288
- UpdateCollectionResponse: {
3289
- /** @example posts */
3290
- id: string;
3291
- /** @example cms-xxxxx-xxxxx */
3292
- contentSystemId: string;
3293
- /**
3294
- * Format: date
3295
- * @example 2024-01-01T00:00:00Z
3296
- */
3297
- createdAt: string;
3298
- /**
3299
- * Format: date
3300
- * @example 2024-01-01T00:00:00Z
3301
- */
3302
- updatedAt: string;
3303
- };
3304
- UpdateCollectionRequest: {
3305
- /** @example posts */
3306
- id: string;
3307
- };
3308
- CountDocumentResponse: {
3309
- result: {
3310
- /** @example 1 */
3311
- count: number;
3312
- };
3313
- };
3314
- /**
3315
- * @example array
3316
- * @enum {string}
3317
- */
3318
- PathType: 'array';
3319
- /**
3320
- * @example {
3321
- * "author.tagIds": "array"
3322
- * }
3323
- */
3324
- PathTypesMeta: {
3325
- [key: string]: components['schemas']['PathType'];
3326
- };
3327
- RequestMeta: {
3328
- pathTypes?: components['schemas']['PathTypesMeta'];
3329
- };
3330
- DataValue: string | number | boolean | unknown | components['schemas']['DataValue'][] | {
3331
- [key: string]: components['schemas']['DataValue'];
3332
- } | unknown;
3333
- /**
3334
- * @example {
3335
- * "and": [
3336
- * {
3337
- * "path": "status",
3338
- * "operator": "equals",
3339
- * "value": "published"
3340
- * },
3341
- * {
3342
- * "path": "createdAt",
3343
- * "operator": "greater_than",
3344
- * "value": "2025-01-01T00:00:00Z"
3345
- * }
3346
- * ]
3347
- * }
3348
- */
3349
- WhereClause: {
3350
- and: components['schemas']['WhereClause'][];
3351
- } | {
3352
- or: components['schemas']['WhereClause'][];
3353
- } | {
3354
- path: string;
3355
- operator: 'equals' | 'not_equals' | 'in' | 'not_in' | 'greater_than' | 'greater_than_equal' | 'less_than' | 'less_than_equal' | 'like' | 'not_like' | 'all' | 'contains' | 'exists' | 'intersects' | 'near' | 'within';
3356
- value: components['schemas']['DataValue'];
3357
- };
3358
- CountDocumentRequest: {
3359
- /** @example cms-xxxxx-xxxxx */
3360
- contentSystemId: string;
3361
- /** @example posts */
3362
- collection: string;
3363
- meta?: components['schemas']['RequestMeta'];
3364
- where?: components['schemas']['WhereClause'];
3365
- };
3366
- /**
3367
- * @example {
3368
- * "id": "doc-key",
3369
- * "title": "Placeholder title",
3370
- * "content": "This is placeholder content",
3371
- * "createdAt": "2024-01-01T00:00:00Z",
3372
- * "updatedAt": "2024-01-02T00:00:00Z",
3373
- * "deletedAt": "2024-01-05T00:00:00Z"
3374
- * }
3375
- */
3376
- DocumentData: {
3377
- [key: string]: components['schemas']['DataValue'];
3378
- };
3379
- Document: {
3380
- /** @example cms-xxxxx-xxxxx */
3381
- contentSystemId: string;
3382
- /** @example posts */
3383
- collection: string;
3384
- doc: components['schemas']['DocumentData'];
3385
- };
3386
- CreateDocumentResponse: {
3387
- result: components['schemas']['Document'] & {
3388
- /** @example doc-key */
3389
- id: string;
3390
- };
3391
- };
3392
- /** @example createdAt */
3393
- SortClause: string | string[];
3394
- /**
3395
- * @example [
3396
- * {
3397
- * "collectionId": "books",
3398
- * "on": "authorId",
3399
- * "path": "books",
3400
- * "count": false,
3401
- * "where": {
3402
- * "path": "status",
3403
- * "operator": "equals",
3404
- * "value": "published"
3405
- * },
3406
- * "limit": 5,
3407
- * "page": 1,
3408
- * "sort": [
3409
- * {
3410
- * "path": "title",
3411
- * "direction": "asc"
3412
- * }
3413
- * ]
3414
- * }
3415
- * ]
3416
- */
3417
- JoinClause: {
3418
- collectionId: string;
3419
- on: string;
3420
- path: string;
3421
- count: boolean;
3422
- where?: components['schemas']['WhereClause'];
3423
- limit?: number;
3424
- page?: number;
3425
- sort?: components['schemas']['SortClause'];
3426
- }[];
3427
- LocaleClause: {
3428
- locale: string;
3429
- fallbackLocale: string;
3430
- paths: string[];
3431
- };
3432
- /**
3433
- * @example {
3434
- * "mode": "include",
3435
- * "paths": [
3436
- * "title",
3437
- * "author.name",
3438
- * "tags"
3439
- * ]
3440
- * }
3441
- */
3442
- SelectClause: {
3443
- /** @enum {string} */
3444
- mode: 'exclude' | 'include';
3445
- paths: string[];
3446
- };
3447
- CreateDocumentRequest: {
3448
- /** @example cms-xxxxx-xxxxx */
3449
- contentSystemId: string;
3450
- /** @example posts */
3451
- collection: string;
3452
- doc: components['schemas']['DocumentData'];
3453
- returning?: false | {
3454
- join?: components['schemas']['JoinClause'];
3455
- locale?: components['schemas']['LocaleClause'];
3456
- select?: components['schemas']['SelectClause'];
3457
- };
3458
- };
3459
- FindDocumentsResponse: {
3460
- result: {
3461
- data: (components['schemas']['Document'] & {
3462
- /** @example doc-key */
3463
- id: string;
3464
- })[];
3465
- totalDocs: number;
3466
- limit: number;
3467
- page: number;
3468
- totalPages: number;
3469
- pagingCounter: number;
3470
- hasPrevPage: boolean;
3471
- hasNextPage: boolean;
3472
- prevPage: number | null;
3473
- nextPage: number | null;
3474
- };
3475
- };
3476
- FindDocumentsRequest: {
3477
- /** @example cms-xxxxx-xxxxx */
3478
- contentSystemId: string;
3479
- /** @example posts */
3480
- collection: string;
3481
- join?: components['schemas']['JoinClause'];
3482
- /** @example 10 */
3483
- limit?: number;
3484
- locale?: components['schemas']['LocaleClause'];
3485
- /** @example 1 */
3486
- page?: number;
3487
- meta?: components['schemas']['RequestMeta'];
3488
- select?: components['schemas']['SelectClause'];
3489
- sort?: components['schemas']['SortClause'];
3490
- where?: components['schemas']['WhereClause'];
3491
- };
3492
- UpdateDocumentResponse: {
3493
- result?: {
3494
- /** @example 1 */
3495
- count: number;
3496
- } | {
3497
- data: (components['schemas']['Document'] & {
3498
- /** @example doc-key */
3499
- id: string;
3500
- })[];
3501
- };
3502
- };
3503
- /**
3504
- * @example {
3505
- * "title": "New Title",
3506
- * "views": {
3507
- * "$inc": 1
3508
- * },
3509
- * "status": "draft"
3510
- * }
3511
- */
3512
- DataWithOperations: {
3513
- [key: string]: components['schemas']['DataValue'];
3514
- };
3515
- UpdateDocumentRequest: {
3516
- /** @example cms-xxxxx-xxxxx */
3517
- contentSystemId: string;
3518
- /** @example posts */
3519
- collection: string;
3520
- /** @example false */
3521
- createOnMissing: false | {
3522
- id: string;
3523
- };
3524
- doc: components['schemas']['DataWithOperations'];
3525
- /** @example 10 */
3526
- limit?: number;
3527
- meta?: components['schemas']['RequestMeta'];
3528
- returning?: false | {
3529
- join?: components['schemas']['JoinClause'];
3530
- locale?: components['schemas']['LocaleClause'];
3531
- select?: components['schemas']['SelectClause'];
3532
- };
3533
- sort?: components['schemas']['SortClause'];
3534
- where: components['schemas']['WhereClause'];
3535
- };
3536
- DeleteDocumentResponse: {
3537
- result?: {
3538
- /** @example 1 */
3539
- count: number;
3540
- } | {
3541
- data: (components['schemas']['Document'] & {
3542
- /** @example doc-key */
3543
- id: string;
3544
- })[];
3545
- };
3546
- };
3547
- DeleteDocumentRequest: {
3548
- /** @example cms-xxxxx-xxxxx */
3549
- contentSystemId: string;
3550
- /** @example posts */
3551
- collection: string;
3552
- meta?: components['schemas']['RequestMeta'];
3553
- returning?: false | {
3554
- join?: components['schemas']['JoinClause'];
3555
- locale?: components['schemas']['LocaleClause'];
3556
- select?: components['schemas']['SelectClause'];
3557
- };
3558
- where: components['schemas']['WhereClause'];
3559
- };
3560
- CountDocumentVersionResponse: {
3561
- result: {
3562
- /** @example 1 */
3563
- count: number;
3564
- };
3565
- };
3566
- CountDocumentVersionRequest: {
3567
- /** @example cms-xxxxx-xxxxx */
3568
- contentSystemId: string;
3569
- /** @example posts */
3570
- collection: string;
3571
- meta?: components['schemas']['RequestMeta'];
3572
- where?: components['schemas']['WhereClause'];
3573
- };
3574
- DocumentVersion: {
3575
- /** @example cms-xxxxx-xxxxx */
3576
- contentSystemId: string;
3577
- /** @example posts */
3578
- collection: string;
3579
- versionDoc: {
3580
- /** @example 2024-01-01T00:00:00Z */
3581
- createdAt?: string | null;
3582
- /** @example 2024-01-01T00:00:00Z */
3583
- updatedAt?: string | null;
3584
- /** @example true */
3585
- latest?: boolean;
3586
- /** @example doc-key */
3587
- parent?: string | number;
3588
- version: components['schemas']['DocumentData'] & unknown;
3589
- /** @example ver-xxxxx-xxxxx */
3590
- id: string;
3591
- };
3592
- };
3593
- CreateDocumentVersionResponse: {
3594
- result: components['schemas']['DocumentVersion'] & {
3595
- /** @example ver-xxxxx-xxxxx */
3596
- id: string;
3597
- };
3598
- };
3599
- /**
3600
- * @example {
3601
- * "contentSystemId": "cms-xxxxx-xxxxx",
3602
- * "collection": "posts",
3603
- * "versionDoc": {
3604
- * "createdAt": "2024-01-01T00:00:00Z",
3605
- * "updatedAt": "2024-01-01T00:00:00Z",
3606
- * "latest": true,
3607
- * "parent": "doc-key",
3608
- * "version": {
3609
- * "title": "Placeholder title",
3610
- * "content": "This is placeholder content"
3611
- * }
3612
- * },
3613
- * "returning": false
3614
- * }
3615
- */
3616
- CreateDocumentVersionRequest: {
3617
- /** @example cms-xxxxx-xxxxx */
3618
- contentSystemId: string;
3619
- /** @example posts */
3620
- collection: string;
3621
- versionDoc: {
3622
- /** @example 2024-01-01T00:00:00Z */
3623
- createdAt?: string | null;
3624
- /** @example 2024-01-01T00:00:00Z */
3625
- updatedAt?: string | null;
3626
- /** @example true */
3627
- latest?: boolean;
3628
- /** @example doc-key */
3629
- parent?: string | number;
3630
- version: components['schemas']['DocumentData'] & unknown;
3631
- };
3632
- returning?: false | {
3633
- join?: components['schemas']['JoinClause'];
3634
- locale?: components['schemas']['LocaleClause'];
3635
- select?: components['schemas']['SelectClause'];
3636
- };
3637
- };
3638
- FindDocumentVersionsResponse: {
3639
- result: {
3640
- data: (components['schemas']['DocumentVersion'] & {
3641
- /** @example ver-xxxxx-xxxxx */
3642
- id: string;
3643
- })[];
3644
- totalDocs: number;
3645
- limit: number;
3646
- page: number;
3647
- totalPages: number;
3648
- pagingCounter: number;
3649
- hasPrevPage: boolean;
3650
- hasNextPage: boolean;
3651
- prevPage: number | null;
3652
- nextPage: number | null;
3653
- };
3654
- };
3655
- FindDocumentVersionsRequest: {
3656
- /** @example cms-xxxxx-xxxxx */
3657
- contentSystemId: string;
3658
- /** @example posts */
3659
- collection: string;
3660
- join?: components['schemas']['JoinClause'];
3661
- /** @example 10 */
3662
- limit?: number;
3663
- locale?: components['schemas']['LocaleClause'];
3664
- /** @example 1 */
3665
- page?: number;
3666
- meta?: components['schemas']['RequestMeta'];
3667
- select?: components['schemas']['SelectClause'];
3668
- sort?: components['schemas']['SortClause'];
3669
- where?: components['schemas']['WhereClause'];
3670
- };
3671
- UpdateDocumentVersionResponse: {
3672
- result?: {
3673
- /** @example 1 */
3674
- count: number;
3675
- } | {
3676
- data: (components['schemas']['DocumentVersion'] & {
3677
- /** @example ver-xxxxx-xxxxx */
3678
- id: string;
3679
- })[];
3680
- };
3681
- };
3682
- UpdateDocumentVersionRequest: {
3683
- /** @example cms-xxxxx-xxxxx */
3684
- contentSystemId: string;
3685
- /** @example posts */
3686
- collection: string;
3687
- /** @example false */
3688
- createOnMissing: false | {
3689
- parent: string;
3690
- latest: boolean;
3691
- };
3692
- versionDoc: {
3693
- /** @example 2024-01-01T00:00:00Z */
3694
- createdAt?: string | null;
3695
- /** @example 2024-01-01T00:00:00Z */
3696
- updatedAt?: string | null;
3697
- /** @example true */
3698
- latest?: boolean;
3699
- /** @example doc-key */
3700
- parent?: string | number;
3701
- version: components['schemas']['DocumentData'] & unknown;
3702
- };
3703
- where: components['schemas']['WhereClause'];
3704
- /** @example 10 */
3705
- limit?: number;
3706
- meta?: components['schemas']['RequestMeta'];
3707
- sort?: components['schemas']['SortClause'];
3708
- returning?: false | {
3709
- join?: components['schemas']['JoinClause'];
3710
- locale?: components['schemas']['LocaleClause'];
3711
- select?: components['schemas']['SelectClause'];
3712
- };
3713
- };
3714
- DeleteDocumentVersionResponse: {
3715
- result?: {
3716
- /** @example 1 */
3717
- count: number;
3718
- } | {
3719
- data: (components['schemas']['DocumentVersion'] & {
3720
- /** @example ver-xxxxx-xxxxx */
3721
- id: string;
3722
- })[];
3723
- };
3724
- };
3725
- DeleteDocumentVersionRequest: {
3726
- /** @example cms-xxxxx-xxxxx */
3727
- contentSystemId: string;
3728
- /** @example posts */
3729
- collection: string;
3730
- meta?: components['schemas']['RequestMeta'];
3731
- returning?: false | {
3732
- join?: components['schemas']['JoinClause'];
3733
- locale?: components['schemas']['LocaleClause'];
3734
- select?: components['schemas']['SelectClause'];
3735
- };
3736
- where: components['schemas']['WhereClause'];
3737
- };
3738
- GeneratePresignedUploadUrlResponse: {
3739
- /** @example https://s3.amazonaws.com/bucket/key?presigned-params */
3740
- url: string;
3741
- };
3742
- GeneratePresignedUploadUrlRequest: {
3743
- /** @example document.pdf */
3744
- filename: string;
3745
- /** @example application/pdf */
3746
- contentType?: string;
3747
- /**
3748
- * @default 3600
3749
- * @example 3600
3750
- */
3751
- expiresIn: number;
3752
- /** @example media */
3753
- collectionId: string;
3754
- };
3755
- GeneratePresignedDownloadUrlResponse: {
3756
- /** @example https://s3.amazonaws.com/bucket/key?presigned-params */
3757
- url: string;
3758
- };
3759
- GeneratePresignedDownloadUrlRequest: {
3760
- /** @example document.pdf */
3761
- filename: string;
3762
- /**
3763
- * @default 3600
3764
- * @example 3600
3765
- */
3766
- expiresIn: number;
3767
- /** @example media */
3768
- collectionId: string;
3769
- };
3770
- InitiateMultipartUploadResponse: {
3771
- /** @example abc123xyz789 */
3772
- uploadId: string;
3773
- };
3774
- InitiateMultipartUploadRequest: {
3775
- /** @example large-video.mp4 */
3776
- filename: string;
3777
- /** @example video/mp4 */
3778
- contentType: string;
3779
- /** @example media */
3780
- collectionId: string;
3781
- };
3782
- GenerateUploadPartUrlsResponse: {
3783
- /**
3784
- * @example [
3785
- * {
3786
- * "partNumber": 1,
3787
- * "url": "https://s3.amazonaws.com/..."
3788
- * }
3789
- * ]
3790
- */
3791
- parts: {
3792
- /** @example 1 */
3793
- partNumber: number;
3794
- /** @example https://s3.amazonaws.com/bucket/key?presigned-params */
3795
- url: string;
3796
- }[];
3797
- };
3798
- GenerateUploadPartUrlsRequest: {
3799
- /** @example large-video.mp4 */
3800
- filename: string;
3801
- /** @example abc123xyz789 */
3802
- uploadId: string;
3803
- /**
3804
- * @example [
3805
- * 1,
3806
- * 2,
3807
- * 3
3808
- * ]
3809
- */
3810
- partNumbers: number[];
3811
- /**
3812
- * @default 3600
3813
- * @example 3600
3814
- */
3815
- expiresIn: number;
3816
- /** @example media */
3817
- collectionId: string;
3818
- };
3819
- CompleteMultipartUploadResponse: {
3820
- /**
3821
- * @example true
3822
- * @enum {boolean}
3823
- */
3824
- success: true;
3825
- };
3826
- CompleteMultipartUploadRequest: {
3827
- /** @example large-video.mp4 */
3828
- filename: string;
3829
- /** @example abc123xyz789 */
3830
- uploadId: string;
3831
- /**
3832
- * @example [
3833
- * {
3834
- * "PartNumber": 1,
3835
- * "ETag": "\"abc123\""
3836
- * }
3837
- * ]
3838
- */
3839
- parts: {
3840
- /** @example 1 */
3841
- PartNumber: number;
3842
- /** @example "abc123" */
3843
- ETag: string;
3844
- }[];
3845
- /** @example media */
3846
- collectionId: string;
3847
- };
3848
- AbortMultipartUploadResponse: {
3849
- /**
3850
- * @example true
3851
- * @enum {boolean}
3852
- */
3853
- success: true;
3854
- };
3855
- AbortMultipartUploadRequest: {
3856
- /** @example large-video.mp4 */
3857
- filename: string;
3858
- /** @example abc123xyz789 */
3859
- uploadId: string;
3860
- /** @example media */
3861
- collectionId: string;
3862
- };
3863
- DeleteFileResponse: {
3864
- /**
3865
- * @example true
3866
- * @enum {boolean}
3867
- */
3868
- success: true;
3869
- };
3870
- JwksResponse: {
3871
- keys: {
3872
- /** @example RSA */
3873
- kty: string;
3874
- /** @example sig */
3875
- use: string;
3876
- /** @example dev-key-1 */
3877
- kid: string;
3878
- /** @example RS256 */
3879
- alg: string;
3880
- /** @example base64url-encoded-modulus */
3881
- n: string;
3882
- /** @example AQAB */
3883
- e: string;
3884
- }[];
3885
- };
3886
- CreateJwtResponse: {
3887
- /**
3888
- * @description Generated JWT token
3889
- * @example eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
3890
- */
3891
- token: string;
3892
- /**
3893
- * @description Token expiration time in seconds
3894
- * @example 604800
3895
- */
3896
- expires_in: number;
3897
- };
3898
- CreateJwtRequest: {
3899
- /**
3900
- * @description Content system ID to include in the JWT aud field
3901
- * @example 4cfea8de-4f44-4efd-a8fc-7d539249e9f1
3902
- */
3903
- content_system_id?: string;
3904
- };
3905
- };
3906
- responses: never;
3907
- parameters: never;
3908
- requestBodies: never;
3909
- headers: never;
3910
- pathItems: never;
3911
- };
3912
- export type $defs = Record<string, never>;
3913
- export type operations = Record<string, never>;
3914
- //# sourceMappingURL=content-api-types.d.ts.map