@blezgo/api-sdk 0.1.0

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 (175) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +27 -0
  3. package/dist/account/client.d.ts +3 -0
  4. package/dist/account/client.d.ts.map +1 -0
  5. package/dist/account/client.js +3 -0
  6. package/dist/account/client.js.map +1 -0
  7. package/dist/account/generated.d.ts +2648 -0
  8. package/dist/account/generated.d.ts.map +1 -0
  9. package/dist/account/generated.js +6 -0
  10. package/dist/account/generated.js.map +1 -0
  11. package/dist/account/index.d.ts +2 -0
  12. package/dist/account/index.d.ts.map +1 -0
  13. package/dist/account/index.js +2 -0
  14. package/dist/account/index.js.map +1 -0
  15. package/dist/admin/client.d.ts +3 -0
  16. package/dist/admin/client.d.ts.map +1 -0
  17. package/dist/admin/client.js +3 -0
  18. package/dist/admin/client.js.map +1 -0
  19. package/dist/admin/generated.d.ts +956 -0
  20. package/dist/admin/generated.d.ts.map +1 -0
  21. package/dist/admin/generated.js +6 -0
  22. package/dist/admin/generated.js.map +1 -0
  23. package/dist/admin/index.d.ts +2 -0
  24. package/dist/admin/index.d.ts.map +1 -0
  25. package/dist/admin/index.js +2 -0
  26. package/dist/admin/index.js.map +1 -0
  27. package/dist/authentication/client.d.ts +3 -0
  28. package/dist/authentication/client.d.ts.map +1 -0
  29. package/dist/authentication/client.js +3 -0
  30. package/dist/authentication/client.js.map +1 -0
  31. package/dist/authentication/generated.d.ts +746 -0
  32. package/dist/authentication/generated.d.ts.map +1 -0
  33. package/dist/authentication/generated.js +6 -0
  34. package/dist/authentication/generated.js.map +1 -0
  35. package/dist/authentication/index.d.ts +2 -0
  36. package/dist/authentication/index.d.ts.map +1 -0
  37. package/dist/authentication/index.js +2 -0
  38. package/dist/authentication/index.js.map +1 -0
  39. package/dist/cache/client.d.ts +3 -0
  40. package/dist/cache/client.d.ts.map +1 -0
  41. package/dist/cache/client.js +3 -0
  42. package/dist/cache/client.js.map +1 -0
  43. package/dist/cache/generated.d.ts +3355 -0
  44. package/dist/cache/generated.d.ts.map +1 -0
  45. package/dist/cache/generated.js +6 -0
  46. package/dist/cache/generated.js.map +1 -0
  47. package/dist/cache/index.d.ts +2 -0
  48. package/dist/cache/index.d.ts.map +1 -0
  49. package/dist/cache/index.js +2 -0
  50. package/dist/cache/index.js.map +1 -0
  51. package/dist/config/client.d.ts +3 -0
  52. package/dist/config/client.d.ts.map +1 -0
  53. package/dist/config/client.js +3 -0
  54. package/dist/config/client.js.map +1 -0
  55. package/dist/config/generated.d.ts +1150 -0
  56. package/dist/config/generated.d.ts.map +1 -0
  57. package/dist/config/generated.js +6 -0
  58. package/dist/config/generated.js.map +1 -0
  59. package/dist/config/index.d.ts +2 -0
  60. package/dist/config/index.d.ts.map +1 -0
  61. package/dist/config/index.js +2 -0
  62. package/dist/config/index.js.map +1 -0
  63. package/dist/dashboard/client.d.ts +3 -0
  64. package/dist/dashboard/client.d.ts.map +1 -0
  65. package/dist/dashboard/client.js +3 -0
  66. package/dist/dashboard/client.js.map +1 -0
  67. package/dist/dashboard/generated.d.ts +4831 -0
  68. package/dist/dashboard/generated.d.ts.map +1 -0
  69. package/dist/dashboard/generated.js +6 -0
  70. package/dist/dashboard/generated.js.map +1 -0
  71. package/dist/dashboard/index.d.ts +2 -0
  72. package/dist/dashboard/index.d.ts.map +1 -0
  73. package/dist/dashboard/index.js +2 -0
  74. package/dist/dashboard/index.js.map +1 -0
  75. package/dist/errors/client.d.ts +3 -0
  76. package/dist/errors/client.d.ts.map +1 -0
  77. package/dist/errors/client.js +3 -0
  78. package/dist/errors/client.js.map +1 -0
  79. package/dist/errors/generated.d.ts +340 -0
  80. package/dist/errors/generated.d.ts.map +1 -0
  81. package/dist/errors/generated.js +6 -0
  82. package/dist/errors/generated.js.map +1 -0
  83. package/dist/errors/index.d.ts +2 -0
  84. package/dist/errors/index.d.ts.map +1 -0
  85. package/dist/errors/index.js +2 -0
  86. package/dist/errors/index.js.map +1 -0
  87. package/dist/index.d.ts +15 -0
  88. package/dist/index.d.ts.map +1 -0
  89. package/dist/index.js +19 -0
  90. package/dist/index.js.map +1 -0
  91. package/dist/internationalization/client.d.ts +3 -0
  92. package/dist/internationalization/client.d.ts.map +1 -0
  93. package/dist/internationalization/client.js +3 -0
  94. package/dist/internationalization/client.js.map +1 -0
  95. package/dist/internationalization/generated.d.ts +587 -0
  96. package/dist/internationalization/generated.d.ts.map +1 -0
  97. package/dist/internationalization/generated.js +6 -0
  98. package/dist/internationalization/generated.js.map +1 -0
  99. package/dist/internationalization/index.d.ts +2 -0
  100. package/dist/internationalization/index.d.ts.map +1 -0
  101. package/dist/internationalization/index.js +2 -0
  102. package/dist/internationalization/index.js.map +1 -0
  103. package/dist/invitations/client.d.ts +3 -0
  104. package/dist/invitations/client.d.ts.map +1 -0
  105. package/dist/invitations/client.js +3 -0
  106. package/dist/invitations/client.js.map +1 -0
  107. package/dist/invitations/generated.d.ts +4019 -0
  108. package/dist/invitations/generated.d.ts.map +1 -0
  109. package/dist/invitations/generated.js +6 -0
  110. package/dist/invitations/generated.js.map +1 -0
  111. package/dist/invitations/index.d.ts +2 -0
  112. package/dist/invitations/index.d.ts.map +1 -0
  113. package/dist/invitations/index.js +2 -0
  114. package/dist/invitations/index.js.map +1 -0
  115. package/dist/registration/client.d.ts +3 -0
  116. package/dist/registration/client.d.ts.map +1 -0
  117. package/dist/registration/client.js +3 -0
  118. package/dist/registration/client.js.map +1 -0
  119. package/dist/registration/generated.d.ts +1010 -0
  120. package/dist/registration/generated.d.ts.map +1 -0
  121. package/dist/registration/generated.js +6 -0
  122. package/dist/registration/generated.js.map +1 -0
  123. package/dist/registration/index.d.ts +2 -0
  124. package/dist/registration/index.d.ts.map +1 -0
  125. package/dist/registration/index.js +2 -0
  126. package/dist/registration/index.js.map +1 -0
  127. package/dist/role/client.d.ts +3 -0
  128. package/dist/role/client.d.ts.map +1 -0
  129. package/dist/role/client.js +3 -0
  130. package/dist/role/client.js.map +1 -0
  131. package/dist/role/generated.d.ts +6324 -0
  132. package/dist/role/generated.d.ts.map +1 -0
  133. package/dist/role/generated.js +6 -0
  134. package/dist/role/generated.js.map +1 -0
  135. package/dist/role/index.d.ts +2 -0
  136. package/dist/role/index.d.ts.map +1 -0
  137. package/dist/role/index.js +2 -0
  138. package/dist/role/index.js.map +1 -0
  139. package/dist/tenant/client.d.ts +3 -0
  140. package/dist/tenant/client.d.ts.map +1 -0
  141. package/dist/tenant/client.js +3 -0
  142. package/dist/tenant/client.js.map +1 -0
  143. package/dist/tenant/generated.d.ts +8273 -0
  144. package/dist/tenant/generated.d.ts.map +1 -0
  145. package/dist/tenant/generated.js +6 -0
  146. package/dist/tenant/generated.js.map +1 -0
  147. package/dist/tenant/index.d.ts +2 -0
  148. package/dist/tenant/index.d.ts.map +1 -0
  149. package/dist/tenant/index.js +2 -0
  150. package/dist/tenant/index.js.map +1 -0
  151. package/dist/tokens/client.d.ts +3 -0
  152. package/dist/tokens/client.d.ts.map +1 -0
  153. package/dist/tokens/client.js +3 -0
  154. package/dist/tokens/client.js.map +1 -0
  155. package/dist/tokens/generated.d.ts +528 -0
  156. package/dist/tokens/generated.d.ts.map +1 -0
  157. package/dist/tokens/generated.js +6 -0
  158. package/dist/tokens/generated.js.map +1 -0
  159. package/dist/tokens/index.d.ts +2 -0
  160. package/dist/tokens/index.d.ts.map +1 -0
  161. package/dist/tokens/index.js +2 -0
  162. package/dist/tokens/index.js.map +1 -0
  163. package/dist/user/client.d.ts +3 -0
  164. package/dist/user/client.d.ts.map +1 -0
  165. package/dist/user/client.js +3 -0
  166. package/dist/user/client.js.map +1 -0
  167. package/dist/user/generated.d.ts +4350 -0
  168. package/dist/user/generated.d.ts.map +1 -0
  169. package/dist/user/generated.js +6 -0
  170. package/dist/user/generated.js.map +1 -0
  171. package/dist/user/index.d.ts +2 -0
  172. package/dist/user/index.d.ts.map +1 -0
  173. package/dist/user/index.js +2 -0
  174. package/dist/user/index.js.map +1 -0
  175. package/package.json +39 -0
@@ -0,0 +1,3355 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export interface paths {
6
+ "/v1/admin/cache/stats": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /**
14
+ * Get Cache Stats
15
+ * @description Get comprehensive Redis cache statistics.
16
+ *
17
+ * Returns real Redis INFO metrics — O(1), no SCAN.
18
+ * Namespace counts are approximate (maintained via INCR/DECR; TTL-expired
19
+ * keys are not decremented — treat as trend indicators).
20
+ *
21
+ * **Auth**: cache.view.all
22
+ */
23
+ get: operations["getCacheStats"];
24
+ put?: never;
25
+ post?: never;
26
+ delete?: never;
27
+ options?: never;
28
+ head?: never;
29
+ patch?: never;
30
+ trace?: never;
31
+ };
32
+ "/v1/admin/cache/clear": {
33
+ parameters: {
34
+ query?: never;
35
+ header?: never;
36
+ path?: never;
37
+ cookie?: never;
38
+ };
39
+ get?: never;
40
+ put?: never;
41
+ /**
42
+ * Clear All Cache
43
+ * @description Flush entire Redis database.
44
+ *
45
+ * **Requires confirmation**: body must include `{"confirm": "CLEAR_ALL"}`.
46
+ * In dry_run mode: returns current key count without deleting anything.
47
+ *
48
+ * **Auth**: cache.clear.all | **Rate limit**: 5/hour per admin
49
+ */
50
+ post: operations["clearAllCache"];
51
+ delete?: never;
52
+ options?: never;
53
+ head?: never;
54
+ patch?: never;
55
+ trace?: never;
56
+ };
57
+ "/v1/admin/cache/clear/domain-validation": {
58
+ parameters: {
59
+ query?: never;
60
+ header?: never;
61
+ path?: never;
62
+ cookie?: never;
63
+ };
64
+ get?: never;
65
+ put?: never;
66
+ /**
67
+ * Clear Domain Validation Cache
68
+ * @description Clear domain validation cache.
69
+ *
70
+ * - `domain` (optional): clear one domain; omit to clear all domain-validation keys.
71
+ * - `dry_run=true`: return key count without deleting.
72
+ *
73
+ * **Auth**: cache.clear.all
74
+ */
75
+ post: operations["clearDomainValidationCache"];
76
+ delete?: never;
77
+ options?: never;
78
+ head?: never;
79
+ patch?: never;
80
+ trace?: never;
81
+ };
82
+ "/v1/admin/cache/clear/event-config": {
83
+ parameters: {
84
+ query?: never;
85
+ header?: never;
86
+ path?: never;
87
+ cookie?: never;
88
+ };
89
+ get?: never;
90
+ put?: never;
91
+ /**
92
+ * Clear Event Config Cache
93
+ * @description Clear event configuration cache for this org.
94
+ *
95
+ * - `event_code` (optional): clear one event; omit to clear all for this org.
96
+ * - `dry_run=true`: return key count without deleting.
97
+ *
98
+ * **Auth**: cache.clear.all
99
+ */
100
+ post: operations["clearEventConfigCache"];
101
+ delete?: never;
102
+ options?: never;
103
+ head?: never;
104
+ patch?: never;
105
+ trace?: never;
106
+ };
107
+ "/v1/admin/cache/clear/templates": {
108
+ parameters: {
109
+ query?: never;
110
+ header?: never;
111
+ path?: never;
112
+ cookie?: never;
113
+ };
114
+ get?: never;
115
+ put?: never;
116
+ /**
117
+ * Clear Templates Cache
118
+ * @description Clear notification template cache for this org.
119
+ *
120
+ * - `event_id`, `channel` (optional): narrow scope; omit either to broaden.
121
+ * - `dry_run=true`: return key count without deleting.
122
+ *
123
+ * **Auth**: cache.clear.all
124
+ */
125
+ post: operations["clearTemplatesCache"];
126
+ delete?: never;
127
+ options?: never;
128
+ head?: never;
129
+ patch?: never;
130
+ trace?: never;
131
+ };
132
+ "/v1/admin/cache/clear/docs-branding": {
133
+ parameters: {
134
+ query?: never;
135
+ header?: never;
136
+ path?: never;
137
+ cookie?: never;
138
+ };
139
+ get?: never;
140
+ put?: never;
141
+ /**
142
+ * Clear Docs Branding Cache
143
+ * @description Clear API documentation branding cache.
144
+ *
145
+ * - `domain` (optional): clear one domain; omit to clear all.
146
+ * - `dry_run=true`: return key count without deleting.
147
+ *
148
+ * **Auth**: cache.clear.all
149
+ */
150
+ post: operations["clearDocsBrandingCache"];
151
+ delete?: never;
152
+ options?: never;
153
+ head?: never;
154
+ patch?: never;
155
+ trace?: never;
156
+ };
157
+ "/v1/admin/cache/clear/user-preferences": {
158
+ parameters: {
159
+ query?: never;
160
+ header?: never;
161
+ path?: never;
162
+ cookie?: never;
163
+ };
164
+ get?: never;
165
+ put?: never;
166
+ /**
167
+ * Clear User Preferences Cache
168
+ * @description Clear user preference cache.
169
+ *
170
+ * - `user_id_internal` (optional): clear one user's prefs; omit to clear all users in this org.
171
+ * - `dry_run=true`: return key count without deleting.
172
+ *
173
+ * **Auth**: cache.clear.all
174
+ */
175
+ post: operations["clearUserPreferencesCache"];
176
+ delete?: never;
177
+ options?: never;
178
+ head?: never;
179
+ patch?: never;
180
+ trace?: never;
181
+ };
182
+ "/v1/admin/cache/clear/suppression": {
183
+ parameters: {
184
+ query?: never;
185
+ header?: never;
186
+ path?: never;
187
+ cookie?: never;
188
+ };
189
+ get?: never;
190
+ put?: never;
191
+ /**
192
+ * Clear Suppression Cache
193
+ * @description Clear notification suppression cache.
194
+ *
195
+ * - `channel` + `recipient`: clear one entry (recipient is hashed — safe to pass raw)
196
+ * - `channel` only: clear all suppression entries for that channel in this org
197
+ * - Neither: clear all suppression cache for this org
198
+ *
199
+ * Use case: recipient's bounce/opt-out was resolved and admin wants next send to go through.
200
+ *
201
+ * **Auth**: cache.clear.all
202
+ */
203
+ post: operations["clearSuppressionCache"];
204
+ delete?: never;
205
+ options?: never;
206
+ head?: never;
207
+ patch?: never;
208
+ trace?: never;
209
+ };
210
+ "/v1/admin/cache/clear/storage-provider": {
211
+ parameters: {
212
+ query?: never;
213
+ header?: never;
214
+ path?: never;
215
+ cookie?: never;
216
+ };
217
+ get?: never;
218
+ put?: never;
219
+ /**
220
+ * Clear Storage Provider Cache
221
+ * @description Flush in-memory storage provider and config caches.
222
+ *
223
+ * This endpoint does NOT touch Redis — it clears the Python in-memory caches
224
+ * inside `StorageProviderFactory` (1-hour TTL) and `ConfigLoader` (30-min TTL).
225
+ *
226
+ * Use this immediately after updating `storage_config_tbl` (e.g. changing `cdn_url`)
227
+ * so the service picks up the new config on the next request without a restart.
228
+ *
229
+ * **Scope options** (mutually exclusive — `all_tenants` takes priority):
230
+ * - `all_tenants=true` → flush every cached provider + entire config cache
231
+ * - `tenant_id=X` → flush that tenant's provider override + config cache
232
+ * - (neither) → flush global default provider + config cache
233
+ *
234
+ * **Note**: No `dry_run` — this is in-memory state, not Redis keys.
235
+ *
236
+ * **Auth**: cache.clear.all
237
+ */
238
+ post: operations["clearStorageProviderCache"];
239
+ delete?: never;
240
+ options?: never;
241
+ head?: never;
242
+ patch?: never;
243
+ trace?: never;
244
+ };
245
+ "/v1/admin/cache/invalidate": {
246
+ parameters: {
247
+ query?: never;
248
+ header?: never;
249
+ path?: never;
250
+ cookie?: never;
251
+ };
252
+ get?: never;
253
+ put?: never;
254
+ /**
255
+ * Invalidate Cache
256
+ * @description Invalidate cache by namespace + scope — structured, no raw Redis patterns.
257
+ *
258
+ * **Body**:
259
+ * ```json
260
+ * {
261
+ * "namespace": "user_pref",
262
+ * "scope": "user",
263
+ * "scope_id": "4001"
264
+ * }
265
+ * ```
266
+ *
267
+ * **Namespace / scope combinations**:
268
+ * - `event_config` + `org` → all event configs for this org
269
+ * - `event_config` + `event` + `scope_id=user_registered` → one event
270
+ * - `template` + `org` → all templates for org
271
+ * - `template` + `event` + `scope_id=5` → all channels for event 5
272
+ * - `user_pref` + `org` → all user prefs for org
273
+ * - `user_pref` + `user` + `scope_id=4001` → one user
274
+ * - `suppression` + `org` → all suppression entries for org
275
+ * - `domain_validation` + `domain` + `scope_id=api.example.com` → one domain
276
+ * - `docs_branding` + `domain` + `scope_id=api.example.com` → one domain
277
+ * - `announcement` + `org` → all announcements for org
278
+ * - `support` + `org` → all support cache for org
279
+ * - `gamification` + `org` → all gamification cache for org
280
+ * - `gamification` + `user` + `scope_id=4001` → one user
281
+ *
282
+ * org_id is always taken from the auth JWT — never from the request body.
283
+ *
284
+ * **Auth**: cache.clear.all
285
+ */
286
+ post: operations["invalidateCacheStructured"];
287
+ delete?: never;
288
+ options?: never;
289
+ head?: never;
290
+ patch?: never;
291
+ trace?: never;
292
+ };
293
+ "/v1/admin/cache/audit-log": {
294
+ parameters: {
295
+ query?: never;
296
+ header?: never;
297
+ path?: never;
298
+ cookie?: never;
299
+ };
300
+ /**
301
+ * Get Cache Audit Log
302
+ * @description Paginated audit log of cache admin operations for this org.
303
+ *
304
+ * **Query params** (all optional):
305
+ * - `namespace`: filter by namespace
306
+ * - `from_date`, `to_date`: ISO 8601 date range
307
+ *
308
+ * **Auth**: cache.view.all
309
+ */
310
+ get: operations["getCacheAuditLog"];
311
+ put?: never;
312
+ post?: never;
313
+ delete?: never;
314
+ options?: never;
315
+ head?: never;
316
+ patch?: never;
317
+ trace?: never;
318
+ };
319
+ "/v1/admin/cache/keys": {
320
+ parameters: {
321
+ query?: never;
322
+ header?: never;
323
+ path?: never;
324
+ cookie?: never;
325
+ };
326
+ /**
327
+ * Browse Cache Keys
328
+ * @description Browse cache keys for a namespace with cursor-based pagination.
329
+ *
330
+ * Uses Redis SCAN (non-blocking) — safe on large keyspaces.
331
+ * Keys are returned without the internal `coresvc:` prefix.
332
+ * org_id is enforced from the auth JWT — you can only see your own org's keys.
333
+ *
334
+ * **Pagination**: pass `next_cursor` from the previous response as `cursor`
335
+ * in the next request. When `next_cursor` is 0 the full namespace has been scanned.
336
+ *
337
+ * **Note**: Cache values are never returned — only key names and TTLs.
338
+ *
339
+ * **Auth**: cache.view.all
340
+ */
341
+ get: operations["browseCacheKeys"];
342
+ put?: never;
343
+ post?: never;
344
+ delete?: never;
345
+ options?: never;
346
+ head?: never;
347
+ patch?: never;
348
+ trace?: never;
349
+ };
350
+ "/v1/admin/cache/keys/ttl": {
351
+ parameters: {
352
+ query?: never;
353
+ header?: never;
354
+ path?: never;
355
+ cookie?: never;
356
+ };
357
+ /**
358
+ * Get Cache Key Ttl
359
+ * @description Return TTL and memory usage for a single cache key.
360
+ *
361
+ * Provide the bare key — no `coresvc:` prefix needed.
362
+ *
363
+ * **Security**: the key must belong to the requesting org. Keys for
364
+ * org-scoped namespaces are validated to contain the org's ID.
365
+ * Returns 404 if the key does not exist or belongs to another org.
366
+ *
367
+ * **Auth**: cache.view.all
368
+ */
369
+ get: operations["getCacheKeyTtl"];
370
+ put?: never;
371
+ post?: never;
372
+ delete?: never;
373
+ options?: never;
374
+ head?: never;
375
+ patch?: never;
376
+ trace?: never;
377
+ };
378
+ "/v1/admin/cache/warm-up": {
379
+ parameters: {
380
+ query?: never;
381
+ header?: never;
382
+ path?: never;
383
+ cookie?: never;
384
+ };
385
+ get?: never;
386
+ put?: never;
387
+ /**
388
+ * Trigger Cache Warm Up
389
+ * @description Trigger background cache warm-up for this org.
390
+ *
391
+ * Dispatches a Celery task that fetches recently-used data from DB
392
+ * and pre-populates Redis. Already-cached keys are skipped.
393
+ *
394
+ * **Supported namespaces**:
395
+ * - `event_config` — pre-warms all active event handler configs for the org
396
+ * - `template` — reserved (deferred: requires usage-tracking data)
397
+ *
398
+ * **Limits** (enforced inside Celery task):
399
+ * - Max 500 keys warmed per invocation
400
+ * - Processed in chunks of 100 to avoid long DB transactions
401
+ *
402
+ * Returns a `task_id` for status tracking.
403
+ *
404
+ * **Auth**: cache.clear.all | **Rate limit**: 5/hour per admin
405
+ */
406
+ post: operations["triggerCacheWarmUp"];
407
+ delete?: never;
408
+ options?: never;
409
+ head?: never;
410
+ patch?: never;
411
+ trace?: never;
412
+ };
413
+ }
414
+ export type webhooks = Record<string, never>;
415
+ export interface components {
416
+ schemas: {
417
+ Extensions: {
418
+ /** @example GENERIC_ERROR */
419
+ message_code?: string;
420
+ /** @example [] */
421
+ invalid_params?: components["schemas"]["InvalidParam"][];
422
+ extra_data?: Record<string, never> | null;
423
+ /** @example Detailed debug information */
424
+ debug?: string | null;
425
+ };
426
+ /**
427
+ * @example {
428
+ * "status": "success",
429
+ * "message": "Operation successful",
430
+ * "message_code": "api_suc_20001",
431
+ * "data": {},
432
+ * "metadata": {
433
+ * "timestamp": "2026-03-26T10:00:00.000Z",
434
+ * "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
435
+ * "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
436
+ * "version": "v1",
437
+ * "executionTime": 42,
438
+ * "language": "en-US"
439
+ * }
440
+ * }
441
+ */
442
+ StandardResponse: {
443
+ /** @example success */
444
+ status?: string;
445
+ data?: Record<string, never> | null;
446
+ /** @example Operation successful */
447
+ message?: string | null;
448
+ /** @example api_suc_20001 */
449
+ message_code?: string | null;
450
+ metadata?: Record<string, never> | null;
451
+ error?: components["schemas"]["ErrorResponse"];
452
+ };
453
+ InvalidParam: {
454
+ /** @example items[0].quantity */
455
+ field?: string;
456
+ /** @example Input should be greater than or equal to 1 */
457
+ error?: string;
458
+ };
459
+ ErrorResponse: {
460
+ /** @example about:blank */
461
+ type?: string;
462
+ /** @example GENERIC_ERROR */
463
+ code?: string;
464
+ /** @example Client Error */
465
+ title?: string;
466
+ /** @example 400 */
467
+ status?: number;
468
+ /** @example An error occurred */
469
+ detail?: string;
470
+ /** @example /v1/cart/items */
471
+ instance?: string;
472
+ extensions?: components["schemas"]["Extensions"];
473
+ };
474
+ /** ClearAllBody */
475
+ ClearAllBody: {
476
+ /** Confirm */
477
+ confirm?: string | null;
478
+ };
479
+ /** InvalidateBody */
480
+ InvalidateBody: {
481
+ /** Namespace */
482
+ namespace: string;
483
+ /**
484
+ * Scope
485
+ * @default org
486
+ * @enum {string}
487
+ */
488
+ scope: "org" | "user" | "domain" | "event" | "entity";
489
+ /** Scope Id */
490
+ scope_id?: string | null;
491
+ };
492
+ /** WarmUpBody */
493
+ WarmUpBody: {
494
+ /** Namespaces */
495
+ namespaces: string[];
496
+ };
497
+ };
498
+ responses: never;
499
+ parameters: never;
500
+ requestBodies: never;
501
+ headers: never;
502
+ pathItems: never;
503
+ }
504
+ export type $defs = Record<string, never>;
505
+ export interface operations {
506
+ getCacheStats: {
507
+ parameters: {
508
+ query?: never;
509
+ header?: {
510
+ authorization?: string | null;
511
+ };
512
+ path?: never;
513
+ cookie?: never;
514
+ };
515
+ requestBody?: never;
516
+ responses: {
517
+ /** @description Successful Response */
518
+ 200: {
519
+ headers: {
520
+ [name: string]: unknown;
521
+ };
522
+ content: {
523
+ "application/json": components["schemas"]["StandardResponse"];
524
+ };
525
+ };
526
+ /** @description Bad Request */
527
+ 400: {
528
+ headers: {
529
+ [name: string]: unknown;
530
+ };
531
+ content: {
532
+ /**
533
+ * @example {
534
+ * "status": "error",
535
+ * "message": "An error occurred",
536
+ * "message_code": "GENERIC_ERROR",
537
+ * "metadata": {
538
+ * "timestamp": "2025-08-05T18:38:57Z",
539
+ * "requestId": "uuid",
540
+ * "traceId": "uuid",
541
+ * "version": "v1",
542
+ * "executionTime": 0,
543
+ * "language": "en-US",
544
+ * "links": [
545
+ * {
546
+ * "rel": "self",
547
+ * "href": "/v1/cart/items",
548
+ * "method": "POST"
549
+ * }
550
+ * ]
551
+ * },
552
+ * "error": {
553
+ * "type": "https://{your-domain}/errors/client-error",
554
+ * "code": "GENERIC_ERROR",
555
+ * "title": "Client Error",
556
+ * "status": 400,
557
+ * "detail": "An error occurred",
558
+ * "instance": "/v1/cart/items",
559
+ * "extensions": {
560
+ * "message_code": "GENERIC_ERROR",
561
+ * "invalid_params": []
562
+ * }
563
+ * }
564
+ * }
565
+ */
566
+ "application/json": components["schemas"]["StandardResponse"];
567
+ };
568
+ };
569
+ /** @description Unprocessable Entity */
570
+ 422: {
571
+ headers: {
572
+ [name: string]: unknown;
573
+ };
574
+ content: {
575
+ /**
576
+ * @example {
577
+ * "status": "error",
578
+ * "message": "One or more input fields are invalid",
579
+ * "message_code": "INVALID_INPUT",
580
+ * "metadata": {
581
+ * "timestamp": "2025-08-05T18:38:57Z",
582
+ * "requestId": "uuid",
583
+ * "traceId": "uuid",
584
+ * "version": "v1",
585
+ * "executionTime": 0,
586
+ * "language": "en-US",
587
+ * "links": [
588
+ * {
589
+ * "rel": "self",
590
+ * "href": "/v1/cart/items",
591
+ * "method": "POST"
592
+ * }
593
+ * ]
594
+ * },
595
+ * "error": {
596
+ * "type": "https://{your-domain}/errors/invalid-input",
597
+ * "code": "INVALID_INPUT",
598
+ * "title": "Invalid Input",
599
+ * "status": 422,
600
+ * "detail": "One or more input fields are invalid",
601
+ * "instance": "/v1/cart/items",
602
+ * "extensions": {
603
+ * "message_code": "INVALID_INPUT",
604
+ * "invalid_params": [
605
+ * {
606
+ * "field": "items[0].quantity",
607
+ * "error": "Input should be greater than or equal to 1"
608
+ * }
609
+ * ]
610
+ * }
611
+ * }
612
+ * }
613
+ */
614
+ "application/json": components["schemas"]["StandardResponse"];
615
+ };
616
+ };
617
+ /** @description Too Many Requests */
618
+ 429: {
619
+ headers: {
620
+ [name: string]: unknown;
621
+ };
622
+ content: {
623
+ /**
624
+ * @example {
625
+ * "status": "error",
626
+ * "message": "Too many requests",
627
+ * "message_code": "RATE_LIMIT_EXCEEDED",
628
+ * "metadata": {
629
+ * "timestamp": "2025-08-05T18:38:57Z",
630
+ * "requestId": "uuid",
631
+ * "traceId": "uuid",
632
+ * "version": "v1",
633
+ * "executionTime": 0,
634
+ * "language": "en-US",
635
+ * "links": [
636
+ * {
637
+ * "rel": "self",
638
+ * "href": "/v1/cart/items",
639
+ * "method": "POST"
640
+ * }
641
+ * ]
642
+ * },
643
+ * "error": {
644
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
645
+ * "code": "RATE_LIMIT_EXCEEDED",
646
+ * "title": "Rate Limit Exceeded",
647
+ * "status": 429,
648
+ * "detail": "Too many requests",
649
+ * "instance": "/v1/cart/items",
650
+ * "extensions": {
651
+ * "message_code": "RATE_LIMIT_EXCEEDED",
652
+ * "invalid_params": []
653
+ * }
654
+ * }
655
+ * }
656
+ */
657
+ "application/json": components["schemas"]["StandardResponse"];
658
+ };
659
+ };
660
+ /** @description Internal Server Error */
661
+ 500: {
662
+ headers: {
663
+ [name: string]: unknown;
664
+ };
665
+ content: {
666
+ /**
667
+ * @example {
668
+ * "status": "error",
669
+ * "message": "An unexpected error occurred",
670
+ * "message_code": "SERVER_ERROR",
671
+ * "metadata": {
672
+ * "timestamp": "2025-08-05T18:38:57Z",
673
+ * "requestId": "uuid",
674
+ * "traceId": "uuid",
675
+ * "version": "v1",
676
+ * "executionTime": 0,
677
+ * "language": "en-US",
678
+ * "links": [
679
+ * {
680
+ * "rel": "self",
681
+ * "href": "/v1/cart/items",
682
+ * "method": "POST"
683
+ * }
684
+ * ]
685
+ * },
686
+ * "error": {
687
+ * "type": "https://{your-domain}/errors/server-error",
688
+ * "code": "SERVER_ERROR",
689
+ * "title": "Server Error",
690
+ * "status": 500,
691
+ * "detail": "An unexpected error occurred",
692
+ * "instance": "/v1/cart/items",
693
+ * "extensions": {
694
+ * "message_code": "SERVER_ERROR",
695
+ * "invalid_params": []
696
+ * }
697
+ * }
698
+ * }
699
+ */
700
+ "application/json": components["schemas"]["StandardResponse"];
701
+ };
702
+ };
703
+ };
704
+ };
705
+ clearAllCache: {
706
+ parameters: {
707
+ query?: {
708
+ dry_run?: boolean;
709
+ };
710
+ header?: {
711
+ authorization?: string | null;
712
+ };
713
+ path?: never;
714
+ cookie?: never;
715
+ };
716
+ requestBody?: {
717
+ content: {
718
+ "application/json": components["schemas"]["ClearAllBody"];
719
+ };
720
+ };
721
+ responses: {
722
+ /** @description Successful Response */
723
+ 200: {
724
+ headers: {
725
+ [name: string]: unknown;
726
+ };
727
+ content: {
728
+ "application/json": components["schemas"]["StandardResponse"];
729
+ };
730
+ };
731
+ /** @description Bad Request */
732
+ 400: {
733
+ headers: {
734
+ [name: string]: unknown;
735
+ };
736
+ content: {
737
+ /**
738
+ * @example {
739
+ * "status": "error",
740
+ * "message": "An error occurred",
741
+ * "message_code": "GENERIC_ERROR",
742
+ * "metadata": {
743
+ * "timestamp": "2025-08-05T18:38:57Z",
744
+ * "requestId": "uuid",
745
+ * "traceId": "uuid",
746
+ * "version": "v1",
747
+ * "executionTime": 0,
748
+ * "language": "en-US",
749
+ * "links": [
750
+ * {
751
+ * "rel": "self",
752
+ * "href": "/v1/cart/items",
753
+ * "method": "POST"
754
+ * }
755
+ * ]
756
+ * },
757
+ * "error": {
758
+ * "type": "https://{your-domain}/errors/client-error",
759
+ * "code": "GENERIC_ERROR",
760
+ * "title": "Client Error",
761
+ * "status": 400,
762
+ * "detail": "An error occurred",
763
+ * "instance": "/v1/cart/items",
764
+ * "extensions": {
765
+ * "message_code": "GENERIC_ERROR",
766
+ * "invalid_params": []
767
+ * }
768
+ * }
769
+ * }
770
+ */
771
+ "application/json": components["schemas"]["StandardResponse"];
772
+ };
773
+ };
774
+ /** @description Unprocessable Entity */
775
+ 422: {
776
+ headers: {
777
+ [name: string]: unknown;
778
+ };
779
+ content: {
780
+ /**
781
+ * @example {
782
+ * "status": "error",
783
+ * "message": "One or more input fields are invalid",
784
+ * "message_code": "INVALID_INPUT",
785
+ * "metadata": {
786
+ * "timestamp": "2025-08-05T18:38:57Z",
787
+ * "requestId": "uuid",
788
+ * "traceId": "uuid",
789
+ * "version": "v1",
790
+ * "executionTime": 0,
791
+ * "language": "en-US",
792
+ * "links": [
793
+ * {
794
+ * "rel": "self",
795
+ * "href": "/v1/cart/items",
796
+ * "method": "POST"
797
+ * }
798
+ * ]
799
+ * },
800
+ * "error": {
801
+ * "type": "https://{your-domain}/errors/invalid-input",
802
+ * "code": "INVALID_INPUT",
803
+ * "title": "Invalid Input",
804
+ * "status": 422,
805
+ * "detail": "One or more input fields are invalid",
806
+ * "instance": "/v1/cart/items",
807
+ * "extensions": {
808
+ * "message_code": "INVALID_INPUT",
809
+ * "invalid_params": [
810
+ * {
811
+ * "field": "items[0].quantity",
812
+ * "error": "Input should be greater than or equal to 1"
813
+ * }
814
+ * ]
815
+ * }
816
+ * }
817
+ * }
818
+ */
819
+ "application/json": components["schemas"]["StandardResponse"];
820
+ };
821
+ };
822
+ /** @description Too Many Requests */
823
+ 429: {
824
+ headers: {
825
+ [name: string]: unknown;
826
+ };
827
+ content: {
828
+ /**
829
+ * @example {
830
+ * "status": "error",
831
+ * "message": "Too many requests",
832
+ * "message_code": "RATE_LIMIT_EXCEEDED",
833
+ * "metadata": {
834
+ * "timestamp": "2025-08-05T18:38:57Z",
835
+ * "requestId": "uuid",
836
+ * "traceId": "uuid",
837
+ * "version": "v1",
838
+ * "executionTime": 0,
839
+ * "language": "en-US",
840
+ * "links": [
841
+ * {
842
+ * "rel": "self",
843
+ * "href": "/v1/cart/items",
844
+ * "method": "POST"
845
+ * }
846
+ * ]
847
+ * },
848
+ * "error": {
849
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
850
+ * "code": "RATE_LIMIT_EXCEEDED",
851
+ * "title": "Rate Limit Exceeded",
852
+ * "status": 429,
853
+ * "detail": "Too many requests",
854
+ * "instance": "/v1/cart/items",
855
+ * "extensions": {
856
+ * "message_code": "RATE_LIMIT_EXCEEDED",
857
+ * "invalid_params": []
858
+ * }
859
+ * }
860
+ * }
861
+ */
862
+ "application/json": components["schemas"]["StandardResponse"];
863
+ };
864
+ };
865
+ /** @description Internal Server Error */
866
+ 500: {
867
+ headers: {
868
+ [name: string]: unknown;
869
+ };
870
+ content: {
871
+ /**
872
+ * @example {
873
+ * "status": "error",
874
+ * "message": "An unexpected error occurred",
875
+ * "message_code": "SERVER_ERROR",
876
+ * "metadata": {
877
+ * "timestamp": "2025-08-05T18:38:57Z",
878
+ * "requestId": "uuid",
879
+ * "traceId": "uuid",
880
+ * "version": "v1",
881
+ * "executionTime": 0,
882
+ * "language": "en-US",
883
+ * "links": [
884
+ * {
885
+ * "rel": "self",
886
+ * "href": "/v1/cart/items",
887
+ * "method": "POST"
888
+ * }
889
+ * ]
890
+ * },
891
+ * "error": {
892
+ * "type": "https://{your-domain}/errors/server-error",
893
+ * "code": "SERVER_ERROR",
894
+ * "title": "Server Error",
895
+ * "status": 500,
896
+ * "detail": "An unexpected error occurred",
897
+ * "instance": "/v1/cart/items",
898
+ * "extensions": {
899
+ * "message_code": "SERVER_ERROR",
900
+ * "invalid_params": []
901
+ * }
902
+ * }
903
+ * }
904
+ */
905
+ "application/json": components["schemas"]["StandardResponse"];
906
+ };
907
+ };
908
+ };
909
+ };
910
+ clearDomainValidationCache: {
911
+ parameters: {
912
+ query?: {
913
+ domain?: string | null;
914
+ dry_run?: boolean;
915
+ };
916
+ header?: {
917
+ authorization?: string | null;
918
+ };
919
+ path?: never;
920
+ cookie?: never;
921
+ };
922
+ requestBody?: never;
923
+ responses: {
924
+ /** @description Successful Response */
925
+ 200: {
926
+ headers: {
927
+ [name: string]: unknown;
928
+ };
929
+ content: {
930
+ "application/json": components["schemas"]["StandardResponse"];
931
+ };
932
+ };
933
+ /** @description Bad Request */
934
+ 400: {
935
+ headers: {
936
+ [name: string]: unknown;
937
+ };
938
+ content: {
939
+ /**
940
+ * @example {
941
+ * "status": "error",
942
+ * "message": "An error occurred",
943
+ * "message_code": "GENERIC_ERROR",
944
+ * "metadata": {
945
+ * "timestamp": "2025-08-05T18:38:57Z",
946
+ * "requestId": "uuid",
947
+ * "traceId": "uuid",
948
+ * "version": "v1",
949
+ * "executionTime": 0,
950
+ * "language": "en-US",
951
+ * "links": [
952
+ * {
953
+ * "rel": "self",
954
+ * "href": "/v1/cart/items",
955
+ * "method": "POST"
956
+ * }
957
+ * ]
958
+ * },
959
+ * "error": {
960
+ * "type": "https://{your-domain}/errors/client-error",
961
+ * "code": "GENERIC_ERROR",
962
+ * "title": "Client Error",
963
+ * "status": 400,
964
+ * "detail": "An error occurred",
965
+ * "instance": "/v1/cart/items",
966
+ * "extensions": {
967
+ * "message_code": "GENERIC_ERROR",
968
+ * "invalid_params": []
969
+ * }
970
+ * }
971
+ * }
972
+ */
973
+ "application/json": components["schemas"]["StandardResponse"];
974
+ };
975
+ };
976
+ /** @description Unprocessable Entity */
977
+ 422: {
978
+ headers: {
979
+ [name: string]: unknown;
980
+ };
981
+ content: {
982
+ /**
983
+ * @example {
984
+ * "status": "error",
985
+ * "message": "One or more input fields are invalid",
986
+ * "message_code": "INVALID_INPUT",
987
+ * "metadata": {
988
+ * "timestamp": "2025-08-05T18:38:57Z",
989
+ * "requestId": "uuid",
990
+ * "traceId": "uuid",
991
+ * "version": "v1",
992
+ * "executionTime": 0,
993
+ * "language": "en-US",
994
+ * "links": [
995
+ * {
996
+ * "rel": "self",
997
+ * "href": "/v1/cart/items",
998
+ * "method": "POST"
999
+ * }
1000
+ * ]
1001
+ * },
1002
+ * "error": {
1003
+ * "type": "https://{your-domain}/errors/invalid-input",
1004
+ * "code": "INVALID_INPUT",
1005
+ * "title": "Invalid Input",
1006
+ * "status": 422,
1007
+ * "detail": "One or more input fields are invalid",
1008
+ * "instance": "/v1/cart/items",
1009
+ * "extensions": {
1010
+ * "message_code": "INVALID_INPUT",
1011
+ * "invalid_params": [
1012
+ * {
1013
+ * "field": "items[0].quantity",
1014
+ * "error": "Input should be greater than or equal to 1"
1015
+ * }
1016
+ * ]
1017
+ * }
1018
+ * }
1019
+ * }
1020
+ */
1021
+ "application/json": components["schemas"]["StandardResponse"];
1022
+ };
1023
+ };
1024
+ /** @description Too Many Requests */
1025
+ 429: {
1026
+ headers: {
1027
+ [name: string]: unknown;
1028
+ };
1029
+ content: {
1030
+ /**
1031
+ * @example {
1032
+ * "status": "error",
1033
+ * "message": "Too many requests",
1034
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1035
+ * "metadata": {
1036
+ * "timestamp": "2025-08-05T18:38:57Z",
1037
+ * "requestId": "uuid",
1038
+ * "traceId": "uuid",
1039
+ * "version": "v1",
1040
+ * "executionTime": 0,
1041
+ * "language": "en-US",
1042
+ * "links": [
1043
+ * {
1044
+ * "rel": "self",
1045
+ * "href": "/v1/cart/items",
1046
+ * "method": "POST"
1047
+ * }
1048
+ * ]
1049
+ * },
1050
+ * "error": {
1051
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
1052
+ * "code": "RATE_LIMIT_EXCEEDED",
1053
+ * "title": "Rate Limit Exceeded",
1054
+ * "status": 429,
1055
+ * "detail": "Too many requests",
1056
+ * "instance": "/v1/cart/items",
1057
+ * "extensions": {
1058
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1059
+ * "invalid_params": []
1060
+ * }
1061
+ * }
1062
+ * }
1063
+ */
1064
+ "application/json": components["schemas"]["StandardResponse"];
1065
+ };
1066
+ };
1067
+ /** @description Internal Server Error */
1068
+ 500: {
1069
+ headers: {
1070
+ [name: string]: unknown;
1071
+ };
1072
+ content: {
1073
+ /**
1074
+ * @example {
1075
+ * "status": "error",
1076
+ * "message": "An unexpected error occurred",
1077
+ * "message_code": "SERVER_ERROR",
1078
+ * "metadata": {
1079
+ * "timestamp": "2025-08-05T18:38:57Z",
1080
+ * "requestId": "uuid",
1081
+ * "traceId": "uuid",
1082
+ * "version": "v1",
1083
+ * "executionTime": 0,
1084
+ * "language": "en-US",
1085
+ * "links": [
1086
+ * {
1087
+ * "rel": "self",
1088
+ * "href": "/v1/cart/items",
1089
+ * "method": "POST"
1090
+ * }
1091
+ * ]
1092
+ * },
1093
+ * "error": {
1094
+ * "type": "https://{your-domain}/errors/server-error",
1095
+ * "code": "SERVER_ERROR",
1096
+ * "title": "Server Error",
1097
+ * "status": 500,
1098
+ * "detail": "An unexpected error occurred",
1099
+ * "instance": "/v1/cart/items",
1100
+ * "extensions": {
1101
+ * "message_code": "SERVER_ERROR",
1102
+ * "invalid_params": []
1103
+ * }
1104
+ * }
1105
+ * }
1106
+ */
1107
+ "application/json": components["schemas"]["StandardResponse"];
1108
+ };
1109
+ };
1110
+ };
1111
+ };
1112
+ clearEventConfigCache: {
1113
+ parameters: {
1114
+ query?: {
1115
+ event_code?: string | null;
1116
+ dry_run?: boolean;
1117
+ };
1118
+ header?: {
1119
+ authorization?: string | null;
1120
+ };
1121
+ path?: never;
1122
+ cookie?: never;
1123
+ };
1124
+ requestBody?: never;
1125
+ responses: {
1126
+ /** @description Successful Response */
1127
+ 200: {
1128
+ headers: {
1129
+ [name: string]: unknown;
1130
+ };
1131
+ content: {
1132
+ "application/json": components["schemas"]["StandardResponse"];
1133
+ };
1134
+ };
1135
+ /** @description Bad Request */
1136
+ 400: {
1137
+ headers: {
1138
+ [name: string]: unknown;
1139
+ };
1140
+ content: {
1141
+ /**
1142
+ * @example {
1143
+ * "status": "error",
1144
+ * "message": "An error occurred",
1145
+ * "message_code": "GENERIC_ERROR",
1146
+ * "metadata": {
1147
+ * "timestamp": "2025-08-05T18:38:57Z",
1148
+ * "requestId": "uuid",
1149
+ * "traceId": "uuid",
1150
+ * "version": "v1",
1151
+ * "executionTime": 0,
1152
+ * "language": "en-US",
1153
+ * "links": [
1154
+ * {
1155
+ * "rel": "self",
1156
+ * "href": "/v1/cart/items",
1157
+ * "method": "POST"
1158
+ * }
1159
+ * ]
1160
+ * },
1161
+ * "error": {
1162
+ * "type": "https://{your-domain}/errors/client-error",
1163
+ * "code": "GENERIC_ERROR",
1164
+ * "title": "Client Error",
1165
+ * "status": 400,
1166
+ * "detail": "An error occurred",
1167
+ * "instance": "/v1/cart/items",
1168
+ * "extensions": {
1169
+ * "message_code": "GENERIC_ERROR",
1170
+ * "invalid_params": []
1171
+ * }
1172
+ * }
1173
+ * }
1174
+ */
1175
+ "application/json": components["schemas"]["StandardResponse"];
1176
+ };
1177
+ };
1178
+ /** @description Unprocessable Entity */
1179
+ 422: {
1180
+ headers: {
1181
+ [name: string]: unknown;
1182
+ };
1183
+ content: {
1184
+ /**
1185
+ * @example {
1186
+ * "status": "error",
1187
+ * "message": "One or more input fields are invalid",
1188
+ * "message_code": "INVALID_INPUT",
1189
+ * "metadata": {
1190
+ * "timestamp": "2025-08-05T18:38:57Z",
1191
+ * "requestId": "uuid",
1192
+ * "traceId": "uuid",
1193
+ * "version": "v1",
1194
+ * "executionTime": 0,
1195
+ * "language": "en-US",
1196
+ * "links": [
1197
+ * {
1198
+ * "rel": "self",
1199
+ * "href": "/v1/cart/items",
1200
+ * "method": "POST"
1201
+ * }
1202
+ * ]
1203
+ * },
1204
+ * "error": {
1205
+ * "type": "https://{your-domain}/errors/invalid-input",
1206
+ * "code": "INVALID_INPUT",
1207
+ * "title": "Invalid Input",
1208
+ * "status": 422,
1209
+ * "detail": "One or more input fields are invalid",
1210
+ * "instance": "/v1/cart/items",
1211
+ * "extensions": {
1212
+ * "message_code": "INVALID_INPUT",
1213
+ * "invalid_params": [
1214
+ * {
1215
+ * "field": "items[0].quantity",
1216
+ * "error": "Input should be greater than or equal to 1"
1217
+ * }
1218
+ * ]
1219
+ * }
1220
+ * }
1221
+ * }
1222
+ */
1223
+ "application/json": components["schemas"]["StandardResponse"];
1224
+ };
1225
+ };
1226
+ /** @description Too Many Requests */
1227
+ 429: {
1228
+ headers: {
1229
+ [name: string]: unknown;
1230
+ };
1231
+ content: {
1232
+ /**
1233
+ * @example {
1234
+ * "status": "error",
1235
+ * "message": "Too many requests",
1236
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1237
+ * "metadata": {
1238
+ * "timestamp": "2025-08-05T18:38:57Z",
1239
+ * "requestId": "uuid",
1240
+ * "traceId": "uuid",
1241
+ * "version": "v1",
1242
+ * "executionTime": 0,
1243
+ * "language": "en-US",
1244
+ * "links": [
1245
+ * {
1246
+ * "rel": "self",
1247
+ * "href": "/v1/cart/items",
1248
+ * "method": "POST"
1249
+ * }
1250
+ * ]
1251
+ * },
1252
+ * "error": {
1253
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
1254
+ * "code": "RATE_LIMIT_EXCEEDED",
1255
+ * "title": "Rate Limit Exceeded",
1256
+ * "status": 429,
1257
+ * "detail": "Too many requests",
1258
+ * "instance": "/v1/cart/items",
1259
+ * "extensions": {
1260
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1261
+ * "invalid_params": []
1262
+ * }
1263
+ * }
1264
+ * }
1265
+ */
1266
+ "application/json": components["schemas"]["StandardResponse"];
1267
+ };
1268
+ };
1269
+ /** @description Internal Server Error */
1270
+ 500: {
1271
+ headers: {
1272
+ [name: string]: unknown;
1273
+ };
1274
+ content: {
1275
+ /**
1276
+ * @example {
1277
+ * "status": "error",
1278
+ * "message": "An unexpected error occurred",
1279
+ * "message_code": "SERVER_ERROR",
1280
+ * "metadata": {
1281
+ * "timestamp": "2025-08-05T18:38:57Z",
1282
+ * "requestId": "uuid",
1283
+ * "traceId": "uuid",
1284
+ * "version": "v1",
1285
+ * "executionTime": 0,
1286
+ * "language": "en-US",
1287
+ * "links": [
1288
+ * {
1289
+ * "rel": "self",
1290
+ * "href": "/v1/cart/items",
1291
+ * "method": "POST"
1292
+ * }
1293
+ * ]
1294
+ * },
1295
+ * "error": {
1296
+ * "type": "https://{your-domain}/errors/server-error",
1297
+ * "code": "SERVER_ERROR",
1298
+ * "title": "Server Error",
1299
+ * "status": 500,
1300
+ * "detail": "An unexpected error occurred",
1301
+ * "instance": "/v1/cart/items",
1302
+ * "extensions": {
1303
+ * "message_code": "SERVER_ERROR",
1304
+ * "invalid_params": []
1305
+ * }
1306
+ * }
1307
+ * }
1308
+ */
1309
+ "application/json": components["schemas"]["StandardResponse"];
1310
+ };
1311
+ };
1312
+ };
1313
+ };
1314
+ clearTemplatesCache: {
1315
+ parameters: {
1316
+ query?: {
1317
+ event_id?: number | null;
1318
+ channel?: string | null;
1319
+ dry_run?: boolean;
1320
+ };
1321
+ header?: {
1322
+ authorization?: string | null;
1323
+ };
1324
+ path?: never;
1325
+ cookie?: never;
1326
+ };
1327
+ requestBody?: never;
1328
+ responses: {
1329
+ /** @description Successful Response */
1330
+ 200: {
1331
+ headers: {
1332
+ [name: string]: unknown;
1333
+ };
1334
+ content: {
1335
+ "application/json": components["schemas"]["StandardResponse"];
1336
+ };
1337
+ };
1338
+ /** @description Bad Request */
1339
+ 400: {
1340
+ headers: {
1341
+ [name: string]: unknown;
1342
+ };
1343
+ content: {
1344
+ /**
1345
+ * @example {
1346
+ * "status": "error",
1347
+ * "message": "An error occurred",
1348
+ * "message_code": "GENERIC_ERROR",
1349
+ * "metadata": {
1350
+ * "timestamp": "2025-08-05T18:38:57Z",
1351
+ * "requestId": "uuid",
1352
+ * "traceId": "uuid",
1353
+ * "version": "v1",
1354
+ * "executionTime": 0,
1355
+ * "language": "en-US",
1356
+ * "links": [
1357
+ * {
1358
+ * "rel": "self",
1359
+ * "href": "/v1/cart/items",
1360
+ * "method": "POST"
1361
+ * }
1362
+ * ]
1363
+ * },
1364
+ * "error": {
1365
+ * "type": "https://{your-domain}/errors/client-error",
1366
+ * "code": "GENERIC_ERROR",
1367
+ * "title": "Client Error",
1368
+ * "status": 400,
1369
+ * "detail": "An error occurred",
1370
+ * "instance": "/v1/cart/items",
1371
+ * "extensions": {
1372
+ * "message_code": "GENERIC_ERROR",
1373
+ * "invalid_params": []
1374
+ * }
1375
+ * }
1376
+ * }
1377
+ */
1378
+ "application/json": components["schemas"]["StandardResponse"];
1379
+ };
1380
+ };
1381
+ /** @description Unprocessable Entity */
1382
+ 422: {
1383
+ headers: {
1384
+ [name: string]: unknown;
1385
+ };
1386
+ content: {
1387
+ /**
1388
+ * @example {
1389
+ * "status": "error",
1390
+ * "message": "One or more input fields are invalid",
1391
+ * "message_code": "INVALID_INPUT",
1392
+ * "metadata": {
1393
+ * "timestamp": "2025-08-05T18:38:57Z",
1394
+ * "requestId": "uuid",
1395
+ * "traceId": "uuid",
1396
+ * "version": "v1",
1397
+ * "executionTime": 0,
1398
+ * "language": "en-US",
1399
+ * "links": [
1400
+ * {
1401
+ * "rel": "self",
1402
+ * "href": "/v1/cart/items",
1403
+ * "method": "POST"
1404
+ * }
1405
+ * ]
1406
+ * },
1407
+ * "error": {
1408
+ * "type": "https://{your-domain}/errors/invalid-input",
1409
+ * "code": "INVALID_INPUT",
1410
+ * "title": "Invalid Input",
1411
+ * "status": 422,
1412
+ * "detail": "One or more input fields are invalid",
1413
+ * "instance": "/v1/cart/items",
1414
+ * "extensions": {
1415
+ * "message_code": "INVALID_INPUT",
1416
+ * "invalid_params": [
1417
+ * {
1418
+ * "field": "items[0].quantity",
1419
+ * "error": "Input should be greater than or equal to 1"
1420
+ * }
1421
+ * ]
1422
+ * }
1423
+ * }
1424
+ * }
1425
+ */
1426
+ "application/json": components["schemas"]["StandardResponse"];
1427
+ };
1428
+ };
1429
+ /** @description Too Many Requests */
1430
+ 429: {
1431
+ headers: {
1432
+ [name: string]: unknown;
1433
+ };
1434
+ content: {
1435
+ /**
1436
+ * @example {
1437
+ * "status": "error",
1438
+ * "message": "Too many requests",
1439
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1440
+ * "metadata": {
1441
+ * "timestamp": "2025-08-05T18:38:57Z",
1442
+ * "requestId": "uuid",
1443
+ * "traceId": "uuid",
1444
+ * "version": "v1",
1445
+ * "executionTime": 0,
1446
+ * "language": "en-US",
1447
+ * "links": [
1448
+ * {
1449
+ * "rel": "self",
1450
+ * "href": "/v1/cart/items",
1451
+ * "method": "POST"
1452
+ * }
1453
+ * ]
1454
+ * },
1455
+ * "error": {
1456
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
1457
+ * "code": "RATE_LIMIT_EXCEEDED",
1458
+ * "title": "Rate Limit Exceeded",
1459
+ * "status": 429,
1460
+ * "detail": "Too many requests",
1461
+ * "instance": "/v1/cart/items",
1462
+ * "extensions": {
1463
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1464
+ * "invalid_params": []
1465
+ * }
1466
+ * }
1467
+ * }
1468
+ */
1469
+ "application/json": components["schemas"]["StandardResponse"];
1470
+ };
1471
+ };
1472
+ /** @description Internal Server Error */
1473
+ 500: {
1474
+ headers: {
1475
+ [name: string]: unknown;
1476
+ };
1477
+ content: {
1478
+ /**
1479
+ * @example {
1480
+ * "status": "error",
1481
+ * "message": "An unexpected error occurred",
1482
+ * "message_code": "SERVER_ERROR",
1483
+ * "metadata": {
1484
+ * "timestamp": "2025-08-05T18:38:57Z",
1485
+ * "requestId": "uuid",
1486
+ * "traceId": "uuid",
1487
+ * "version": "v1",
1488
+ * "executionTime": 0,
1489
+ * "language": "en-US",
1490
+ * "links": [
1491
+ * {
1492
+ * "rel": "self",
1493
+ * "href": "/v1/cart/items",
1494
+ * "method": "POST"
1495
+ * }
1496
+ * ]
1497
+ * },
1498
+ * "error": {
1499
+ * "type": "https://{your-domain}/errors/server-error",
1500
+ * "code": "SERVER_ERROR",
1501
+ * "title": "Server Error",
1502
+ * "status": 500,
1503
+ * "detail": "An unexpected error occurred",
1504
+ * "instance": "/v1/cart/items",
1505
+ * "extensions": {
1506
+ * "message_code": "SERVER_ERROR",
1507
+ * "invalid_params": []
1508
+ * }
1509
+ * }
1510
+ * }
1511
+ */
1512
+ "application/json": components["schemas"]["StandardResponse"];
1513
+ };
1514
+ };
1515
+ };
1516
+ };
1517
+ clearDocsBrandingCache: {
1518
+ parameters: {
1519
+ query?: {
1520
+ domain?: string | null;
1521
+ dry_run?: boolean;
1522
+ };
1523
+ header?: {
1524
+ authorization?: string | null;
1525
+ };
1526
+ path?: never;
1527
+ cookie?: never;
1528
+ };
1529
+ requestBody?: never;
1530
+ responses: {
1531
+ /** @description Successful Response */
1532
+ 200: {
1533
+ headers: {
1534
+ [name: string]: unknown;
1535
+ };
1536
+ content: {
1537
+ "application/json": components["schemas"]["StandardResponse"];
1538
+ };
1539
+ };
1540
+ /** @description Bad Request */
1541
+ 400: {
1542
+ headers: {
1543
+ [name: string]: unknown;
1544
+ };
1545
+ content: {
1546
+ /**
1547
+ * @example {
1548
+ * "status": "error",
1549
+ * "message": "An error occurred",
1550
+ * "message_code": "GENERIC_ERROR",
1551
+ * "metadata": {
1552
+ * "timestamp": "2025-08-05T18:38:57Z",
1553
+ * "requestId": "uuid",
1554
+ * "traceId": "uuid",
1555
+ * "version": "v1",
1556
+ * "executionTime": 0,
1557
+ * "language": "en-US",
1558
+ * "links": [
1559
+ * {
1560
+ * "rel": "self",
1561
+ * "href": "/v1/cart/items",
1562
+ * "method": "POST"
1563
+ * }
1564
+ * ]
1565
+ * },
1566
+ * "error": {
1567
+ * "type": "https://{your-domain}/errors/client-error",
1568
+ * "code": "GENERIC_ERROR",
1569
+ * "title": "Client Error",
1570
+ * "status": 400,
1571
+ * "detail": "An error occurred",
1572
+ * "instance": "/v1/cart/items",
1573
+ * "extensions": {
1574
+ * "message_code": "GENERIC_ERROR",
1575
+ * "invalid_params": []
1576
+ * }
1577
+ * }
1578
+ * }
1579
+ */
1580
+ "application/json": components["schemas"]["StandardResponse"];
1581
+ };
1582
+ };
1583
+ /** @description Unprocessable Entity */
1584
+ 422: {
1585
+ headers: {
1586
+ [name: string]: unknown;
1587
+ };
1588
+ content: {
1589
+ /**
1590
+ * @example {
1591
+ * "status": "error",
1592
+ * "message": "One or more input fields are invalid",
1593
+ * "message_code": "INVALID_INPUT",
1594
+ * "metadata": {
1595
+ * "timestamp": "2025-08-05T18:38:57Z",
1596
+ * "requestId": "uuid",
1597
+ * "traceId": "uuid",
1598
+ * "version": "v1",
1599
+ * "executionTime": 0,
1600
+ * "language": "en-US",
1601
+ * "links": [
1602
+ * {
1603
+ * "rel": "self",
1604
+ * "href": "/v1/cart/items",
1605
+ * "method": "POST"
1606
+ * }
1607
+ * ]
1608
+ * },
1609
+ * "error": {
1610
+ * "type": "https://{your-domain}/errors/invalid-input",
1611
+ * "code": "INVALID_INPUT",
1612
+ * "title": "Invalid Input",
1613
+ * "status": 422,
1614
+ * "detail": "One or more input fields are invalid",
1615
+ * "instance": "/v1/cart/items",
1616
+ * "extensions": {
1617
+ * "message_code": "INVALID_INPUT",
1618
+ * "invalid_params": [
1619
+ * {
1620
+ * "field": "items[0].quantity",
1621
+ * "error": "Input should be greater than or equal to 1"
1622
+ * }
1623
+ * ]
1624
+ * }
1625
+ * }
1626
+ * }
1627
+ */
1628
+ "application/json": components["schemas"]["StandardResponse"];
1629
+ };
1630
+ };
1631
+ /** @description Too Many Requests */
1632
+ 429: {
1633
+ headers: {
1634
+ [name: string]: unknown;
1635
+ };
1636
+ content: {
1637
+ /**
1638
+ * @example {
1639
+ * "status": "error",
1640
+ * "message": "Too many requests",
1641
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1642
+ * "metadata": {
1643
+ * "timestamp": "2025-08-05T18:38:57Z",
1644
+ * "requestId": "uuid",
1645
+ * "traceId": "uuid",
1646
+ * "version": "v1",
1647
+ * "executionTime": 0,
1648
+ * "language": "en-US",
1649
+ * "links": [
1650
+ * {
1651
+ * "rel": "self",
1652
+ * "href": "/v1/cart/items",
1653
+ * "method": "POST"
1654
+ * }
1655
+ * ]
1656
+ * },
1657
+ * "error": {
1658
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
1659
+ * "code": "RATE_LIMIT_EXCEEDED",
1660
+ * "title": "Rate Limit Exceeded",
1661
+ * "status": 429,
1662
+ * "detail": "Too many requests",
1663
+ * "instance": "/v1/cart/items",
1664
+ * "extensions": {
1665
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1666
+ * "invalid_params": []
1667
+ * }
1668
+ * }
1669
+ * }
1670
+ */
1671
+ "application/json": components["schemas"]["StandardResponse"];
1672
+ };
1673
+ };
1674
+ /** @description Internal Server Error */
1675
+ 500: {
1676
+ headers: {
1677
+ [name: string]: unknown;
1678
+ };
1679
+ content: {
1680
+ /**
1681
+ * @example {
1682
+ * "status": "error",
1683
+ * "message": "An unexpected error occurred",
1684
+ * "message_code": "SERVER_ERROR",
1685
+ * "metadata": {
1686
+ * "timestamp": "2025-08-05T18:38:57Z",
1687
+ * "requestId": "uuid",
1688
+ * "traceId": "uuid",
1689
+ * "version": "v1",
1690
+ * "executionTime": 0,
1691
+ * "language": "en-US",
1692
+ * "links": [
1693
+ * {
1694
+ * "rel": "self",
1695
+ * "href": "/v1/cart/items",
1696
+ * "method": "POST"
1697
+ * }
1698
+ * ]
1699
+ * },
1700
+ * "error": {
1701
+ * "type": "https://{your-domain}/errors/server-error",
1702
+ * "code": "SERVER_ERROR",
1703
+ * "title": "Server Error",
1704
+ * "status": 500,
1705
+ * "detail": "An unexpected error occurred",
1706
+ * "instance": "/v1/cart/items",
1707
+ * "extensions": {
1708
+ * "message_code": "SERVER_ERROR",
1709
+ * "invalid_params": []
1710
+ * }
1711
+ * }
1712
+ * }
1713
+ */
1714
+ "application/json": components["schemas"]["StandardResponse"];
1715
+ };
1716
+ };
1717
+ };
1718
+ };
1719
+ clearUserPreferencesCache: {
1720
+ parameters: {
1721
+ query?: {
1722
+ /** @description Internal user ID — clears one user; omit to clear all for org */
1723
+ user_id_internal?: number | null;
1724
+ dry_run?: boolean;
1725
+ };
1726
+ header?: {
1727
+ authorization?: string | null;
1728
+ };
1729
+ path?: never;
1730
+ cookie?: never;
1731
+ };
1732
+ requestBody?: never;
1733
+ responses: {
1734
+ /** @description Successful Response */
1735
+ 200: {
1736
+ headers: {
1737
+ [name: string]: unknown;
1738
+ };
1739
+ content: {
1740
+ "application/json": components["schemas"]["StandardResponse"];
1741
+ };
1742
+ };
1743
+ /** @description Bad Request */
1744
+ 400: {
1745
+ headers: {
1746
+ [name: string]: unknown;
1747
+ };
1748
+ content: {
1749
+ /**
1750
+ * @example {
1751
+ * "status": "error",
1752
+ * "message": "An error occurred",
1753
+ * "message_code": "GENERIC_ERROR",
1754
+ * "metadata": {
1755
+ * "timestamp": "2025-08-05T18:38:57Z",
1756
+ * "requestId": "uuid",
1757
+ * "traceId": "uuid",
1758
+ * "version": "v1",
1759
+ * "executionTime": 0,
1760
+ * "language": "en-US",
1761
+ * "links": [
1762
+ * {
1763
+ * "rel": "self",
1764
+ * "href": "/v1/cart/items",
1765
+ * "method": "POST"
1766
+ * }
1767
+ * ]
1768
+ * },
1769
+ * "error": {
1770
+ * "type": "https://{your-domain}/errors/client-error",
1771
+ * "code": "GENERIC_ERROR",
1772
+ * "title": "Client Error",
1773
+ * "status": 400,
1774
+ * "detail": "An error occurred",
1775
+ * "instance": "/v1/cart/items",
1776
+ * "extensions": {
1777
+ * "message_code": "GENERIC_ERROR",
1778
+ * "invalid_params": []
1779
+ * }
1780
+ * }
1781
+ * }
1782
+ */
1783
+ "application/json": components["schemas"]["StandardResponse"];
1784
+ };
1785
+ };
1786
+ /** @description Unprocessable Entity */
1787
+ 422: {
1788
+ headers: {
1789
+ [name: string]: unknown;
1790
+ };
1791
+ content: {
1792
+ /**
1793
+ * @example {
1794
+ * "status": "error",
1795
+ * "message": "One or more input fields are invalid",
1796
+ * "message_code": "INVALID_INPUT",
1797
+ * "metadata": {
1798
+ * "timestamp": "2025-08-05T18:38:57Z",
1799
+ * "requestId": "uuid",
1800
+ * "traceId": "uuid",
1801
+ * "version": "v1",
1802
+ * "executionTime": 0,
1803
+ * "language": "en-US",
1804
+ * "links": [
1805
+ * {
1806
+ * "rel": "self",
1807
+ * "href": "/v1/cart/items",
1808
+ * "method": "POST"
1809
+ * }
1810
+ * ]
1811
+ * },
1812
+ * "error": {
1813
+ * "type": "https://{your-domain}/errors/invalid-input",
1814
+ * "code": "INVALID_INPUT",
1815
+ * "title": "Invalid Input",
1816
+ * "status": 422,
1817
+ * "detail": "One or more input fields are invalid",
1818
+ * "instance": "/v1/cart/items",
1819
+ * "extensions": {
1820
+ * "message_code": "INVALID_INPUT",
1821
+ * "invalid_params": [
1822
+ * {
1823
+ * "field": "items[0].quantity",
1824
+ * "error": "Input should be greater than or equal to 1"
1825
+ * }
1826
+ * ]
1827
+ * }
1828
+ * }
1829
+ * }
1830
+ */
1831
+ "application/json": components["schemas"]["StandardResponse"];
1832
+ };
1833
+ };
1834
+ /** @description Too Many Requests */
1835
+ 429: {
1836
+ headers: {
1837
+ [name: string]: unknown;
1838
+ };
1839
+ content: {
1840
+ /**
1841
+ * @example {
1842
+ * "status": "error",
1843
+ * "message": "Too many requests",
1844
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1845
+ * "metadata": {
1846
+ * "timestamp": "2025-08-05T18:38:57Z",
1847
+ * "requestId": "uuid",
1848
+ * "traceId": "uuid",
1849
+ * "version": "v1",
1850
+ * "executionTime": 0,
1851
+ * "language": "en-US",
1852
+ * "links": [
1853
+ * {
1854
+ * "rel": "self",
1855
+ * "href": "/v1/cart/items",
1856
+ * "method": "POST"
1857
+ * }
1858
+ * ]
1859
+ * },
1860
+ * "error": {
1861
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
1862
+ * "code": "RATE_LIMIT_EXCEEDED",
1863
+ * "title": "Rate Limit Exceeded",
1864
+ * "status": 429,
1865
+ * "detail": "Too many requests",
1866
+ * "instance": "/v1/cart/items",
1867
+ * "extensions": {
1868
+ * "message_code": "RATE_LIMIT_EXCEEDED",
1869
+ * "invalid_params": []
1870
+ * }
1871
+ * }
1872
+ * }
1873
+ */
1874
+ "application/json": components["schemas"]["StandardResponse"];
1875
+ };
1876
+ };
1877
+ /** @description Internal Server Error */
1878
+ 500: {
1879
+ headers: {
1880
+ [name: string]: unknown;
1881
+ };
1882
+ content: {
1883
+ /**
1884
+ * @example {
1885
+ * "status": "error",
1886
+ * "message": "An unexpected error occurred",
1887
+ * "message_code": "SERVER_ERROR",
1888
+ * "metadata": {
1889
+ * "timestamp": "2025-08-05T18:38:57Z",
1890
+ * "requestId": "uuid",
1891
+ * "traceId": "uuid",
1892
+ * "version": "v1",
1893
+ * "executionTime": 0,
1894
+ * "language": "en-US",
1895
+ * "links": [
1896
+ * {
1897
+ * "rel": "self",
1898
+ * "href": "/v1/cart/items",
1899
+ * "method": "POST"
1900
+ * }
1901
+ * ]
1902
+ * },
1903
+ * "error": {
1904
+ * "type": "https://{your-domain}/errors/server-error",
1905
+ * "code": "SERVER_ERROR",
1906
+ * "title": "Server Error",
1907
+ * "status": 500,
1908
+ * "detail": "An unexpected error occurred",
1909
+ * "instance": "/v1/cart/items",
1910
+ * "extensions": {
1911
+ * "message_code": "SERVER_ERROR",
1912
+ * "invalid_params": []
1913
+ * }
1914
+ * }
1915
+ * }
1916
+ */
1917
+ "application/json": components["schemas"]["StandardResponse"];
1918
+ };
1919
+ };
1920
+ };
1921
+ };
1922
+ clearSuppressionCache: {
1923
+ parameters: {
1924
+ query?: {
1925
+ /** @description email | sms | push */
1926
+ channel?: string | null;
1927
+ /** @description Raw recipient address — will be SHA-256 hashed internally */
1928
+ recipient?: string | null;
1929
+ dry_run?: boolean;
1930
+ };
1931
+ header?: {
1932
+ authorization?: string | null;
1933
+ };
1934
+ path?: never;
1935
+ cookie?: never;
1936
+ };
1937
+ requestBody?: never;
1938
+ responses: {
1939
+ /** @description Successful Response */
1940
+ 200: {
1941
+ headers: {
1942
+ [name: string]: unknown;
1943
+ };
1944
+ content: {
1945
+ "application/json": components["schemas"]["StandardResponse"];
1946
+ };
1947
+ };
1948
+ /** @description Bad Request */
1949
+ 400: {
1950
+ headers: {
1951
+ [name: string]: unknown;
1952
+ };
1953
+ content: {
1954
+ /**
1955
+ * @example {
1956
+ * "status": "error",
1957
+ * "message": "An error occurred",
1958
+ * "message_code": "GENERIC_ERROR",
1959
+ * "metadata": {
1960
+ * "timestamp": "2025-08-05T18:38:57Z",
1961
+ * "requestId": "uuid",
1962
+ * "traceId": "uuid",
1963
+ * "version": "v1",
1964
+ * "executionTime": 0,
1965
+ * "language": "en-US",
1966
+ * "links": [
1967
+ * {
1968
+ * "rel": "self",
1969
+ * "href": "/v1/cart/items",
1970
+ * "method": "POST"
1971
+ * }
1972
+ * ]
1973
+ * },
1974
+ * "error": {
1975
+ * "type": "https://{your-domain}/errors/client-error",
1976
+ * "code": "GENERIC_ERROR",
1977
+ * "title": "Client Error",
1978
+ * "status": 400,
1979
+ * "detail": "An error occurred",
1980
+ * "instance": "/v1/cart/items",
1981
+ * "extensions": {
1982
+ * "message_code": "GENERIC_ERROR",
1983
+ * "invalid_params": []
1984
+ * }
1985
+ * }
1986
+ * }
1987
+ */
1988
+ "application/json": components["schemas"]["StandardResponse"];
1989
+ };
1990
+ };
1991
+ /** @description Unprocessable Entity */
1992
+ 422: {
1993
+ headers: {
1994
+ [name: string]: unknown;
1995
+ };
1996
+ content: {
1997
+ /**
1998
+ * @example {
1999
+ * "status": "error",
2000
+ * "message": "One or more input fields are invalid",
2001
+ * "message_code": "INVALID_INPUT",
2002
+ * "metadata": {
2003
+ * "timestamp": "2025-08-05T18:38:57Z",
2004
+ * "requestId": "uuid",
2005
+ * "traceId": "uuid",
2006
+ * "version": "v1",
2007
+ * "executionTime": 0,
2008
+ * "language": "en-US",
2009
+ * "links": [
2010
+ * {
2011
+ * "rel": "self",
2012
+ * "href": "/v1/cart/items",
2013
+ * "method": "POST"
2014
+ * }
2015
+ * ]
2016
+ * },
2017
+ * "error": {
2018
+ * "type": "https://{your-domain}/errors/invalid-input",
2019
+ * "code": "INVALID_INPUT",
2020
+ * "title": "Invalid Input",
2021
+ * "status": 422,
2022
+ * "detail": "One or more input fields are invalid",
2023
+ * "instance": "/v1/cart/items",
2024
+ * "extensions": {
2025
+ * "message_code": "INVALID_INPUT",
2026
+ * "invalid_params": [
2027
+ * {
2028
+ * "field": "items[0].quantity",
2029
+ * "error": "Input should be greater than or equal to 1"
2030
+ * }
2031
+ * ]
2032
+ * }
2033
+ * }
2034
+ * }
2035
+ */
2036
+ "application/json": components["schemas"]["StandardResponse"];
2037
+ };
2038
+ };
2039
+ /** @description Too Many Requests */
2040
+ 429: {
2041
+ headers: {
2042
+ [name: string]: unknown;
2043
+ };
2044
+ content: {
2045
+ /**
2046
+ * @example {
2047
+ * "status": "error",
2048
+ * "message": "Too many requests",
2049
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2050
+ * "metadata": {
2051
+ * "timestamp": "2025-08-05T18:38:57Z",
2052
+ * "requestId": "uuid",
2053
+ * "traceId": "uuid",
2054
+ * "version": "v1",
2055
+ * "executionTime": 0,
2056
+ * "language": "en-US",
2057
+ * "links": [
2058
+ * {
2059
+ * "rel": "self",
2060
+ * "href": "/v1/cart/items",
2061
+ * "method": "POST"
2062
+ * }
2063
+ * ]
2064
+ * },
2065
+ * "error": {
2066
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
2067
+ * "code": "RATE_LIMIT_EXCEEDED",
2068
+ * "title": "Rate Limit Exceeded",
2069
+ * "status": 429,
2070
+ * "detail": "Too many requests",
2071
+ * "instance": "/v1/cart/items",
2072
+ * "extensions": {
2073
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2074
+ * "invalid_params": []
2075
+ * }
2076
+ * }
2077
+ * }
2078
+ */
2079
+ "application/json": components["schemas"]["StandardResponse"];
2080
+ };
2081
+ };
2082
+ /** @description Internal Server Error */
2083
+ 500: {
2084
+ headers: {
2085
+ [name: string]: unknown;
2086
+ };
2087
+ content: {
2088
+ /**
2089
+ * @example {
2090
+ * "status": "error",
2091
+ * "message": "An unexpected error occurred",
2092
+ * "message_code": "SERVER_ERROR",
2093
+ * "metadata": {
2094
+ * "timestamp": "2025-08-05T18:38:57Z",
2095
+ * "requestId": "uuid",
2096
+ * "traceId": "uuid",
2097
+ * "version": "v1",
2098
+ * "executionTime": 0,
2099
+ * "language": "en-US",
2100
+ * "links": [
2101
+ * {
2102
+ * "rel": "self",
2103
+ * "href": "/v1/cart/items",
2104
+ * "method": "POST"
2105
+ * }
2106
+ * ]
2107
+ * },
2108
+ * "error": {
2109
+ * "type": "https://{your-domain}/errors/server-error",
2110
+ * "code": "SERVER_ERROR",
2111
+ * "title": "Server Error",
2112
+ * "status": 500,
2113
+ * "detail": "An unexpected error occurred",
2114
+ * "instance": "/v1/cart/items",
2115
+ * "extensions": {
2116
+ * "message_code": "SERVER_ERROR",
2117
+ * "invalid_params": []
2118
+ * }
2119
+ * }
2120
+ * }
2121
+ */
2122
+ "application/json": components["schemas"]["StandardResponse"];
2123
+ };
2124
+ };
2125
+ };
2126
+ };
2127
+ clearStorageProviderCache: {
2128
+ parameters: {
2129
+ query?: {
2130
+ /** @description Tenant org_id to invalidate. Omit for global default. */
2131
+ tenant_id?: number | null;
2132
+ /** @description Flush entire provider cache including all tenant overrides. */
2133
+ all_tenants?: boolean;
2134
+ };
2135
+ header?: {
2136
+ authorization?: string | null;
2137
+ };
2138
+ path?: never;
2139
+ cookie?: never;
2140
+ };
2141
+ requestBody?: never;
2142
+ responses: {
2143
+ /** @description Successful Response */
2144
+ 200: {
2145
+ headers: {
2146
+ [name: string]: unknown;
2147
+ };
2148
+ content: {
2149
+ "application/json": components["schemas"]["StandardResponse"];
2150
+ };
2151
+ };
2152
+ /** @description Bad Request */
2153
+ 400: {
2154
+ headers: {
2155
+ [name: string]: unknown;
2156
+ };
2157
+ content: {
2158
+ /**
2159
+ * @example {
2160
+ * "status": "error",
2161
+ * "message": "An error occurred",
2162
+ * "message_code": "GENERIC_ERROR",
2163
+ * "metadata": {
2164
+ * "timestamp": "2025-08-05T18:38:57Z",
2165
+ * "requestId": "uuid",
2166
+ * "traceId": "uuid",
2167
+ * "version": "v1",
2168
+ * "executionTime": 0,
2169
+ * "language": "en-US",
2170
+ * "links": [
2171
+ * {
2172
+ * "rel": "self",
2173
+ * "href": "/v1/cart/items",
2174
+ * "method": "POST"
2175
+ * }
2176
+ * ]
2177
+ * },
2178
+ * "error": {
2179
+ * "type": "https://{your-domain}/errors/client-error",
2180
+ * "code": "GENERIC_ERROR",
2181
+ * "title": "Client Error",
2182
+ * "status": 400,
2183
+ * "detail": "An error occurred",
2184
+ * "instance": "/v1/cart/items",
2185
+ * "extensions": {
2186
+ * "message_code": "GENERIC_ERROR",
2187
+ * "invalid_params": []
2188
+ * }
2189
+ * }
2190
+ * }
2191
+ */
2192
+ "application/json": components["schemas"]["StandardResponse"];
2193
+ };
2194
+ };
2195
+ /** @description Unprocessable Entity */
2196
+ 422: {
2197
+ headers: {
2198
+ [name: string]: unknown;
2199
+ };
2200
+ content: {
2201
+ /**
2202
+ * @example {
2203
+ * "status": "error",
2204
+ * "message": "One or more input fields are invalid",
2205
+ * "message_code": "INVALID_INPUT",
2206
+ * "metadata": {
2207
+ * "timestamp": "2025-08-05T18:38:57Z",
2208
+ * "requestId": "uuid",
2209
+ * "traceId": "uuid",
2210
+ * "version": "v1",
2211
+ * "executionTime": 0,
2212
+ * "language": "en-US",
2213
+ * "links": [
2214
+ * {
2215
+ * "rel": "self",
2216
+ * "href": "/v1/cart/items",
2217
+ * "method": "POST"
2218
+ * }
2219
+ * ]
2220
+ * },
2221
+ * "error": {
2222
+ * "type": "https://{your-domain}/errors/invalid-input",
2223
+ * "code": "INVALID_INPUT",
2224
+ * "title": "Invalid Input",
2225
+ * "status": 422,
2226
+ * "detail": "One or more input fields are invalid",
2227
+ * "instance": "/v1/cart/items",
2228
+ * "extensions": {
2229
+ * "message_code": "INVALID_INPUT",
2230
+ * "invalid_params": [
2231
+ * {
2232
+ * "field": "items[0].quantity",
2233
+ * "error": "Input should be greater than or equal to 1"
2234
+ * }
2235
+ * ]
2236
+ * }
2237
+ * }
2238
+ * }
2239
+ */
2240
+ "application/json": components["schemas"]["StandardResponse"];
2241
+ };
2242
+ };
2243
+ /** @description Too Many Requests */
2244
+ 429: {
2245
+ headers: {
2246
+ [name: string]: unknown;
2247
+ };
2248
+ content: {
2249
+ /**
2250
+ * @example {
2251
+ * "status": "error",
2252
+ * "message": "Too many requests",
2253
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2254
+ * "metadata": {
2255
+ * "timestamp": "2025-08-05T18:38:57Z",
2256
+ * "requestId": "uuid",
2257
+ * "traceId": "uuid",
2258
+ * "version": "v1",
2259
+ * "executionTime": 0,
2260
+ * "language": "en-US",
2261
+ * "links": [
2262
+ * {
2263
+ * "rel": "self",
2264
+ * "href": "/v1/cart/items",
2265
+ * "method": "POST"
2266
+ * }
2267
+ * ]
2268
+ * },
2269
+ * "error": {
2270
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
2271
+ * "code": "RATE_LIMIT_EXCEEDED",
2272
+ * "title": "Rate Limit Exceeded",
2273
+ * "status": 429,
2274
+ * "detail": "Too many requests",
2275
+ * "instance": "/v1/cart/items",
2276
+ * "extensions": {
2277
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2278
+ * "invalid_params": []
2279
+ * }
2280
+ * }
2281
+ * }
2282
+ */
2283
+ "application/json": components["schemas"]["StandardResponse"];
2284
+ };
2285
+ };
2286
+ /** @description Internal Server Error */
2287
+ 500: {
2288
+ headers: {
2289
+ [name: string]: unknown;
2290
+ };
2291
+ content: {
2292
+ /**
2293
+ * @example {
2294
+ * "status": "error",
2295
+ * "message": "An unexpected error occurred",
2296
+ * "message_code": "SERVER_ERROR",
2297
+ * "metadata": {
2298
+ * "timestamp": "2025-08-05T18:38:57Z",
2299
+ * "requestId": "uuid",
2300
+ * "traceId": "uuid",
2301
+ * "version": "v1",
2302
+ * "executionTime": 0,
2303
+ * "language": "en-US",
2304
+ * "links": [
2305
+ * {
2306
+ * "rel": "self",
2307
+ * "href": "/v1/cart/items",
2308
+ * "method": "POST"
2309
+ * }
2310
+ * ]
2311
+ * },
2312
+ * "error": {
2313
+ * "type": "https://{your-domain}/errors/server-error",
2314
+ * "code": "SERVER_ERROR",
2315
+ * "title": "Server Error",
2316
+ * "status": 500,
2317
+ * "detail": "An unexpected error occurred",
2318
+ * "instance": "/v1/cart/items",
2319
+ * "extensions": {
2320
+ * "message_code": "SERVER_ERROR",
2321
+ * "invalid_params": []
2322
+ * }
2323
+ * }
2324
+ * }
2325
+ */
2326
+ "application/json": components["schemas"]["StandardResponse"];
2327
+ };
2328
+ };
2329
+ };
2330
+ };
2331
+ invalidateCacheStructured: {
2332
+ parameters: {
2333
+ query?: {
2334
+ dry_run?: boolean;
2335
+ };
2336
+ header?: {
2337
+ authorization?: string | null;
2338
+ };
2339
+ path?: never;
2340
+ cookie?: never;
2341
+ };
2342
+ requestBody: {
2343
+ content: {
2344
+ "application/json": components["schemas"]["InvalidateBody"];
2345
+ };
2346
+ };
2347
+ responses: {
2348
+ /** @description Successful Response */
2349
+ 200: {
2350
+ headers: {
2351
+ [name: string]: unknown;
2352
+ };
2353
+ content: {
2354
+ "application/json": components["schemas"]["StandardResponse"];
2355
+ };
2356
+ };
2357
+ /** @description Bad Request */
2358
+ 400: {
2359
+ headers: {
2360
+ [name: string]: unknown;
2361
+ };
2362
+ content: {
2363
+ /**
2364
+ * @example {
2365
+ * "status": "error",
2366
+ * "message": "An error occurred",
2367
+ * "message_code": "GENERIC_ERROR",
2368
+ * "metadata": {
2369
+ * "timestamp": "2025-08-05T18:38:57Z",
2370
+ * "requestId": "uuid",
2371
+ * "traceId": "uuid",
2372
+ * "version": "v1",
2373
+ * "executionTime": 0,
2374
+ * "language": "en-US",
2375
+ * "links": [
2376
+ * {
2377
+ * "rel": "self",
2378
+ * "href": "/v1/cart/items",
2379
+ * "method": "POST"
2380
+ * }
2381
+ * ]
2382
+ * },
2383
+ * "error": {
2384
+ * "type": "https://{your-domain}/errors/client-error",
2385
+ * "code": "GENERIC_ERROR",
2386
+ * "title": "Client Error",
2387
+ * "status": 400,
2388
+ * "detail": "An error occurred",
2389
+ * "instance": "/v1/cart/items",
2390
+ * "extensions": {
2391
+ * "message_code": "GENERIC_ERROR",
2392
+ * "invalid_params": []
2393
+ * }
2394
+ * }
2395
+ * }
2396
+ */
2397
+ "application/json": components["schemas"]["StandardResponse"];
2398
+ };
2399
+ };
2400
+ /** @description Unprocessable Entity */
2401
+ 422: {
2402
+ headers: {
2403
+ [name: string]: unknown;
2404
+ };
2405
+ content: {
2406
+ /**
2407
+ * @example {
2408
+ * "status": "error",
2409
+ * "message": "One or more input fields are invalid",
2410
+ * "message_code": "INVALID_INPUT",
2411
+ * "metadata": {
2412
+ * "timestamp": "2025-08-05T18:38:57Z",
2413
+ * "requestId": "uuid",
2414
+ * "traceId": "uuid",
2415
+ * "version": "v1",
2416
+ * "executionTime": 0,
2417
+ * "language": "en-US",
2418
+ * "links": [
2419
+ * {
2420
+ * "rel": "self",
2421
+ * "href": "/v1/cart/items",
2422
+ * "method": "POST"
2423
+ * }
2424
+ * ]
2425
+ * },
2426
+ * "error": {
2427
+ * "type": "https://{your-domain}/errors/invalid-input",
2428
+ * "code": "INVALID_INPUT",
2429
+ * "title": "Invalid Input",
2430
+ * "status": 422,
2431
+ * "detail": "One or more input fields are invalid",
2432
+ * "instance": "/v1/cart/items",
2433
+ * "extensions": {
2434
+ * "message_code": "INVALID_INPUT",
2435
+ * "invalid_params": [
2436
+ * {
2437
+ * "field": "items[0].quantity",
2438
+ * "error": "Input should be greater than or equal to 1"
2439
+ * }
2440
+ * ]
2441
+ * }
2442
+ * }
2443
+ * }
2444
+ */
2445
+ "application/json": components["schemas"]["StandardResponse"];
2446
+ };
2447
+ };
2448
+ /** @description Too Many Requests */
2449
+ 429: {
2450
+ headers: {
2451
+ [name: string]: unknown;
2452
+ };
2453
+ content: {
2454
+ /**
2455
+ * @example {
2456
+ * "status": "error",
2457
+ * "message": "Too many requests",
2458
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2459
+ * "metadata": {
2460
+ * "timestamp": "2025-08-05T18:38:57Z",
2461
+ * "requestId": "uuid",
2462
+ * "traceId": "uuid",
2463
+ * "version": "v1",
2464
+ * "executionTime": 0,
2465
+ * "language": "en-US",
2466
+ * "links": [
2467
+ * {
2468
+ * "rel": "self",
2469
+ * "href": "/v1/cart/items",
2470
+ * "method": "POST"
2471
+ * }
2472
+ * ]
2473
+ * },
2474
+ * "error": {
2475
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
2476
+ * "code": "RATE_LIMIT_EXCEEDED",
2477
+ * "title": "Rate Limit Exceeded",
2478
+ * "status": 429,
2479
+ * "detail": "Too many requests",
2480
+ * "instance": "/v1/cart/items",
2481
+ * "extensions": {
2482
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2483
+ * "invalid_params": []
2484
+ * }
2485
+ * }
2486
+ * }
2487
+ */
2488
+ "application/json": components["schemas"]["StandardResponse"];
2489
+ };
2490
+ };
2491
+ /** @description Internal Server Error */
2492
+ 500: {
2493
+ headers: {
2494
+ [name: string]: unknown;
2495
+ };
2496
+ content: {
2497
+ /**
2498
+ * @example {
2499
+ * "status": "error",
2500
+ * "message": "An unexpected error occurred",
2501
+ * "message_code": "SERVER_ERROR",
2502
+ * "metadata": {
2503
+ * "timestamp": "2025-08-05T18:38:57Z",
2504
+ * "requestId": "uuid",
2505
+ * "traceId": "uuid",
2506
+ * "version": "v1",
2507
+ * "executionTime": 0,
2508
+ * "language": "en-US",
2509
+ * "links": [
2510
+ * {
2511
+ * "rel": "self",
2512
+ * "href": "/v1/cart/items",
2513
+ * "method": "POST"
2514
+ * }
2515
+ * ]
2516
+ * },
2517
+ * "error": {
2518
+ * "type": "https://{your-domain}/errors/server-error",
2519
+ * "code": "SERVER_ERROR",
2520
+ * "title": "Server Error",
2521
+ * "status": 500,
2522
+ * "detail": "An unexpected error occurred",
2523
+ * "instance": "/v1/cart/items",
2524
+ * "extensions": {
2525
+ * "message_code": "SERVER_ERROR",
2526
+ * "invalid_params": []
2527
+ * }
2528
+ * }
2529
+ * }
2530
+ */
2531
+ "application/json": components["schemas"]["StandardResponse"];
2532
+ };
2533
+ };
2534
+ };
2535
+ };
2536
+ getCacheAuditLog: {
2537
+ parameters: {
2538
+ query?: {
2539
+ namespace?: string | null;
2540
+ from_date?: string | null;
2541
+ to_date?: string | null;
2542
+ /** @description Page number (1-based) */
2543
+ page?: number;
2544
+ /** @description Items per page (1–100, default 20) */
2545
+ limit?: number;
2546
+ };
2547
+ header?: {
2548
+ authorization?: string | null;
2549
+ };
2550
+ path?: never;
2551
+ cookie?: never;
2552
+ };
2553
+ requestBody?: never;
2554
+ responses: {
2555
+ /** @description Successful Response */
2556
+ 200: {
2557
+ headers: {
2558
+ [name: string]: unknown;
2559
+ };
2560
+ content: {
2561
+ "application/json": components["schemas"]["StandardResponse"];
2562
+ };
2563
+ };
2564
+ /** @description Bad Request */
2565
+ 400: {
2566
+ headers: {
2567
+ [name: string]: unknown;
2568
+ };
2569
+ content: {
2570
+ /**
2571
+ * @example {
2572
+ * "status": "error",
2573
+ * "message": "An error occurred",
2574
+ * "message_code": "GENERIC_ERROR",
2575
+ * "metadata": {
2576
+ * "timestamp": "2025-08-05T18:38:57Z",
2577
+ * "requestId": "uuid",
2578
+ * "traceId": "uuid",
2579
+ * "version": "v1",
2580
+ * "executionTime": 0,
2581
+ * "language": "en-US",
2582
+ * "links": [
2583
+ * {
2584
+ * "rel": "self",
2585
+ * "href": "/v1/cart/items",
2586
+ * "method": "POST"
2587
+ * }
2588
+ * ]
2589
+ * },
2590
+ * "error": {
2591
+ * "type": "https://{your-domain}/errors/client-error",
2592
+ * "code": "GENERIC_ERROR",
2593
+ * "title": "Client Error",
2594
+ * "status": 400,
2595
+ * "detail": "An error occurred",
2596
+ * "instance": "/v1/cart/items",
2597
+ * "extensions": {
2598
+ * "message_code": "GENERIC_ERROR",
2599
+ * "invalid_params": []
2600
+ * }
2601
+ * }
2602
+ * }
2603
+ */
2604
+ "application/json": components["schemas"]["StandardResponse"];
2605
+ };
2606
+ };
2607
+ /** @description Unprocessable Entity */
2608
+ 422: {
2609
+ headers: {
2610
+ [name: string]: unknown;
2611
+ };
2612
+ content: {
2613
+ /**
2614
+ * @example {
2615
+ * "status": "error",
2616
+ * "message": "One or more input fields are invalid",
2617
+ * "message_code": "INVALID_INPUT",
2618
+ * "metadata": {
2619
+ * "timestamp": "2025-08-05T18:38:57Z",
2620
+ * "requestId": "uuid",
2621
+ * "traceId": "uuid",
2622
+ * "version": "v1",
2623
+ * "executionTime": 0,
2624
+ * "language": "en-US",
2625
+ * "links": [
2626
+ * {
2627
+ * "rel": "self",
2628
+ * "href": "/v1/cart/items",
2629
+ * "method": "POST"
2630
+ * }
2631
+ * ]
2632
+ * },
2633
+ * "error": {
2634
+ * "type": "https://{your-domain}/errors/invalid-input",
2635
+ * "code": "INVALID_INPUT",
2636
+ * "title": "Invalid Input",
2637
+ * "status": 422,
2638
+ * "detail": "One or more input fields are invalid",
2639
+ * "instance": "/v1/cart/items",
2640
+ * "extensions": {
2641
+ * "message_code": "INVALID_INPUT",
2642
+ * "invalid_params": [
2643
+ * {
2644
+ * "field": "items[0].quantity",
2645
+ * "error": "Input should be greater than or equal to 1"
2646
+ * }
2647
+ * ]
2648
+ * }
2649
+ * }
2650
+ * }
2651
+ */
2652
+ "application/json": components["schemas"]["StandardResponse"];
2653
+ };
2654
+ };
2655
+ /** @description Too Many Requests */
2656
+ 429: {
2657
+ headers: {
2658
+ [name: string]: unknown;
2659
+ };
2660
+ content: {
2661
+ /**
2662
+ * @example {
2663
+ * "status": "error",
2664
+ * "message": "Too many requests",
2665
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2666
+ * "metadata": {
2667
+ * "timestamp": "2025-08-05T18:38:57Z",
2668
+ * "requestId": "uuid",
2669
+ * "traceId": "uuid",
2670
+ * "version": "v1",
2671
+ * "executionTime": 0,
2672
+ * "language": "en-US",
2673
+ * "links": [
2674
+ * {
2675
+ * "rel": "self",
2676
+ * "href": "/v1/cart/items",
2677
+ * "method": "POST"
2678
+ * }
2679
+ * ]
2680
+ * },
2681
+ * "error": {
2682
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
2683
+ * "code": "RATE_LIMIT_EXCEEDED",
2684
+ * "title": "Rate Limit Exceeded",
2685
+ * "status": 429,
2686
+ * "detail": "Too many requests",
2687
+ * "instance": "/v1/cart/items",
2688
+ * "extensions": {
2689
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2690
+ * "invalid_params": []
2691
+ * }
2692
+ * }
2693
+ * }
2694
+ */
2695
+ "application/json": components["schemas"]["StandardResponse"];
2696
+ };
2697
+ };
2698
+ /** @description Internal Server Error */
2699
+ 500: {
2700
+ headers: {
2701
+ [name: string]: unknown;
2702
+ };
2703
+ content: {
2704
+ /**
2705
+ * @example {
2706
+ * "status": "error",
2707
+ * "message": "An unexpected error occurred",
2708
+ * "message_code": "SERVER_ERROR",
2709
+ * "metadata": {
2710
+ * "timestamp": "2025-08-05T18:38:57Z",
2711
+ * "requestId": "uuid",
2712
+ * "traceId": "uuid",
2713
+ * "version": "v1",
2714
+ * "executionTime": 0,
2715
+ * "language": "en-US",
2716
+ * "links": [
2717
+ * {
2718
+ * "rel": "self",
2719
+ * "href": "/v1/cart/items",
2720
+ * "method": "POST"
2721
+ * }
2722
+ * ]
2723
+ * },
2724
+ * "error": {
2725
+ * "type": "https://{your-domain}/errors/server-error",
2726
+ * "code": "SERVER_ERROR",
2727
+ * "title": "Server Error",
2728
+ * "status": 500,
2729
+ * "detail": "An unexpected error occurred",
2730
+ * "instance": "/v1/cart/items",
2731
+ * "extensions": {
2732
+ * "message_code": "SERVER_ERROR",
2733
+ * "invalid_params": []
2734
+ * }
2735
+ * }
2736
+ * }
2737
+ */
2738
+ "application/json": components["schemas"]["StandardResponse"];
2739
+ };
2740
+ };
2741
+ };
2742
+ };
2743
+ browseCacheKeys: {
2744
+ parameters: {
2745
+ query: {
2746
+ /** @description Namespace to browse — e.g. event_config, template, user_pref */
2747
+ namespace: string;
2748
+ /** @description Redis SCAN cursor (0 = start of new scan) */
2749
+ cursor?: number;
2750
+ /** @description Max keys to return per page */
2751
+ limit?: number;
2752
+ };
2753
+ header?: {
2754
+ authorization?: string | null;
2755
+ };
2756
+ path?: never;
2757
+ cookie?: never;
2758
+ };
2759
+ requestBody?: never;
2760
+ responses: {
2761
+ /** @description Successful Response */
2762
+ 200: {
2763
+ headers: {
2764
+ [name: string]: unknown;
2765
+ };
2766
+ content: {
2767
+ "application/json": components["schemas"]["StandardResponse"];
2768
+ };
2769
+ };
2770
+ /** @description Bad Request */
2771
+ 400: {
2772
+ headers: {
2773
+ [name: string]: unknown;
2774
+ };
2775
+ content: {
2776
+ /**
2777
+ * @example {
2778
+ * "status": "error",
2779
+ * "message": "An error occurred",
2780
+ * "message_code": "GENERIC_ERROR",
2781
+ * "metadata": {
2782
+ * "timestamp": "2025-08-05T18:38:57Z",
2783
+ * "requestId": "uuid",
2784
+ * "traceId": "uuid",
2785
+ * "version": "v1",
2786
+ * "executionTime": 0,
2787
+ * "language": "en-US",
2788
+ * "links": [
2789
+ * {
2790
+ * "rel": "self",
2791
+ * "href": "/v1/cart/items",
2792
+ * "method": "POST"
2793
+ * }
2794
+ * ]
2795
+ * },
2796
+ * "error": {
2797
+ * "type": "https://{your-domain}/errors/client-error",
2798
+ * "code": "GENERIC_ERROR",
2799
+ * "title": "Client Error",
2800
+ * "status": 400,
2801
+ * "detail": "An error occurred",
2802
+ * "instance": "/v1/cart/items",
2803
+ * "extensions": {
2804
+ * "message_code": "GENERIC_ERROR",
2805
+ * "invalid_params": []
2806
+ * }
2807
+ * }
2808
+ * }
2809
+ */
2810
+ "application/json": components["schemas"]["StandardResponse"];
2811
+ };
2812
+ };
2813
+ /** @description Unprocessable Entity */
2814
+ 422: {
2815
+ headers: {
2816
+ [name: string]: unknown;
2817
+ };
2818
+ content: {
2819
+ /**
2820
+ * @example {
2821
+ * "status": "error",
2822
+ * "message": "One or more input fields are invalid",
2823
+ * "message_code": "INVALID_INPUT",
2824
+ * "metadata": {
2825
+ * "timestamp": "2025-08-05T18:38:57Z",
2826
+ * "requestId": "uuid",
2827
+ * "traceId": "uuid",
2828
+ * "version": "v1",
2829
+ * "executionTime": 0,
2830
+ * "language": "en-US",
2831
+ * "links": [
2832
+ * {
2833
+ * "rel": "self",
2834
+ * "href": "/v1/cart/items",
2835
+ * "method": "POST"
2836
+ * }
2837
+ * ]
2838
+ * },
2839
+ * "error": {
2840
+ * "type": "https://{your-domain}/errors/invalid-input",
2841
+ * "code": "INVALID_INPUT",
2842
+ * "title": "Invalid Input",
2843
+ * "status": 422,
2844
+ * "detail": "One or more input fields are invalid",
2845
+ * "instance": "/v1/cart/items",
2846
+ * "extensions": {
2847
+ * "message_code": "INVALID_INPUT",
2848
+ * "invalid_params": [
2849
+ * {
2850
+ * "field": "items[0].quantity",
2851
+ * "error": "Input should be greater than or equal to 1"
2852
+ * }
2853
+ * ]
2854
+ * }
2855
+ * }
2856
+ * }
2857
+ */
2858
+ "application/json": components["schemas"]["StandardResponse"];
2859
+ };
2860
+ };
2861
+ /** @description Too Many Requests */
2862
+ 429: {
2863
+ headers: {
2864
+ [name: string]: unknown;
2865
+ };
2866
+ content: {
2867
+ /**
2868
+ * @example {
2869
+ * "status": "error",
2870
+ * "message": "Too many requests",
2871
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2872
+ * "metadata": {
2873
+ * "timestamp": "2025-08-05T18:38:57Z",
2874
+ * "requestId": "uuid",
2875
+ * "traceId": "uuid",
2876
+ * "version": "v1",
2877
+ * "executionTime": 0,
2878
+ * "language": "en-US",
2879
+ * "links": [
2880
+ * {
2881
+ * "rel": "self",
2882
+ * "href": "/v1/cart/items",
2883
+ * "method": "POST"
2884
+ * }
2885
+ * ]
2886
+ * },
2887
+ * "error": {
2888
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
2889
+ * "code": "RATE_LIMIT_EXCEEDED",
2890
+ * "title": "Rate Limit Exceeded",
2891
+ * "status": 429,
2892
+ * "detail": "Too many requests",
2893
+ * "instance": "/v1/cart/items",
2894
+ * "extensions": {
2895
+ * "message_code": "RATE_LIMIT_EXCEEDED",
2896
+ * "invalid_params": []
2897
+ * }
2898
+ * }
2899
+ * }
2900
+ */
2901
+ "application/json": components["schemas"]["StandardResponse"];
2902
+ };
2903
+ };
2904
+ /** @description Internal Server Error */
2905
+ 500: {
2906
+ headers: {
2907
+ [name: string]: unknown;
2908
+ };
2909
+ content: {
2910
+ /**
2911
+ * @example {
2912
+ * "status": "error",
2913
+ * "message": "An unexpected error occurred",
2914
+ * "message_code": "SERVER_ERROR",
2915
+ * "metadata": {
2916
+ * "timestamp": "2025-08-05T18:38:57Z",
2917
+ * "requestId": "uuid",
2918
+ * "traceId": "uuid",
2919
+ * "version": "v1",
2920
+ * "executionTime": 0,
2921
+ * "language": "en-US",
2922
+ * "links": [
2923
+ * {
2924
+ * "rel": "self",
2925
+ * "href": "/v1/cart/items",
2926
+ * "method": "POST"
2927
+ * }
2928
+ * ]
2929
+ * },
2930
+ * "error": {
2931
+ * "type": "https://{your-domain}/errors/server-error",
2932
+ * "code": "SERVER_ERROR",
2933
+ * "title": "Server Error",
2934
+ * "status": 500,
2935
+ * "detail": "An unexpected error occurred",
2936
+ * "instance": "/v1/cart/items",
2937
+ * "extensions": {
2938
+ * "message_code": "SERVER_ERROR",
2939
+ * "invalid_params": []
2940
+ * }
2941
+ * }
2942
+ * }
2943
+ */
2944
+ "application/json": components["schemas"]["StandardResponse"];
2945
+ };
2946
+ };
2947
+ };
2948
+ };
2949
+ getCacheKeyTtl: {
2950
+ parameters: {
2951
+ query: {
2952
+ /** @description Bare cache key without coresvc: prefix (e.g. event_config:782:user_registered) */
2953
+ key: string;
2954
+ };
2955
+ header?: {
2956
+ authorization?: string | null;
2957
+ };
2958
+ path?: never;
2959
+ cookie?: never;
2960
+ };
2961
+ requestBody?: never;
2962
+ responses: {
2963
+ /** @description Successful Response */
2964
+ 200: {
2965
+ headers: {
2966
+ [name: string]: unknown;
2967
+ };
2968
+ content: {
2969
+ "application/json": components["schemas"]["StandardResponse"];
2970
+ };
2971
+ };
2972
+ /** @description Bad Request */
2973
+ 400: {
2974
+ headers: {
2975
+ [name: string]: unknown;
2976
+ };
2977
+ content: {
2978
+ /**
2979
+ * @example {
2980
+ * "status": "error",
2981
+ * "message": "An error occurred",
2982
+ * "message_code": "GENERIC_ERROR",
2983
+ * "metadata": {
2984
+ * "timestamp": "2025-08-05T18:38:57Z",
2985
+ * "requestId": "uuid",
2986
+ * "traceId": "uuid",
2987
+ * "version": "v1",
2988
+ * "executionTime": 0,
2989
+ * "language": "en-US",
2990
+ * "links": [
2991
+ * {
2992
+ * "rel": "self",
2993
+ * "href": "/v1/cart/items",
2994
+ * "method": "POST"
2995
+ * }
2996
+ * ]
2997
+ * },
2998
+ * "error": {
2999
+ * "type": "https://{your-domain}/errors/client-error",
3000
+ * "code": "GENERIC_ERROR",
3001
+ * "title": "Client Error",
3002
+ * "status": 400,
3003
+ * "detail": "An error occurred",
3004
+ * "instance": "/v1/cart/items",
3005
+ * "extensions": {
3006
+ * "message_code": "GENERIC_ERROR",
3007
+ * "invalid_params": []
3008
+ * }
3009
+ * }
3010
+ * }
3011
+ */
3012
+ "application/json": components["schemas"]["StandardResponse"];
3013
+ };
3014
+ };
3015
+ /** @description Unprocessable Entity */
3016
+ 422: {
3017
+ headers: {
3018
+ [name: string]: unknown;
3019
+ };
3020
+ content: {
3021
+ /**
3022
+ * @example {
3023
+ * "status": "error",
3024
+ * "message": "One or more input fields are invalid",
3025
+ * "message_code": "INVALID_INPUT",
3026
+ * "metadata": {
3027
+ * "timestamp": "2025-08-05T18:38:57Z",
3028
+ * "requestId": "uuid",
3029
+ * "traceId": "uuid",
3030
+ * "version": "v1",
3031
+ * "executionTime": 0,
3032
+ * "language": "en-US",
3033
+ * "links": [
3034
+ * {
3035
+ * "rel": "self",
3036
+ * "href": "/v1/cart/items",
3037
+ * "method": "POST"
3038
+ * }
3039
+ * ]
3040
+ * },
3041
+ * "error": {
3042
+ * "type": "https://{your-domain}/errors/invalid-input",
3043
+ * "code": "INVALID_INPUT",
3044
+ * "title": "Invalid Input",
3045
+ * "status": 422,
3046
+ * "detail": "One or more input fields are invalid",
3047
+ * "instance": "/v1/cart/items",
3048
+ * "extensions": {
3049
+ * "message_code": "INVALID_INPUT",
3050
+ * "invalid_params": [
3051
+ * {
3052
+ * "field": "items[0].quantity",
3053
+ * "error": "Input should be greater than or equal to 1"
3054
+ * }
3055
+ * ]
3056
+ * }
3057
+ * }
3058
+ * }
3059
+ */
3060
+ "application/json": components["schemas"]["StandardResponse"];
3061
+ };
3062
+ };
3063
+ /** @description Too Many Requests */
3064
+ 429: {
3065
+ headers: {
3066
+ [name: string]: unknown;
3067
+ };
3068
+ content: {
3069
+ /**
3070
+ * @example {
3071
+ * "status": "error",
3072
+ * "message": "Too many requests",
3073
+ * "message_code": "RATE_LIMIT_EXCEEDED",
3074
+ * "metadata": {
3075
+ * "timestamp": "2025-08-05T18:38:57Z",
3076
+ * "requestId": "uuid",
3077
+ * "traceId": "uuid",
3078
+ * "version": "v1",
3079
+ * "executionTime": 0,
3080
+ * "language": "en-US",
3081
+ * "links": [
3082
+ * {
3083
+ * "rel": "self",
3084
+ * "href": "/v1/cart/items",
3085
+ * "method": "POST"
3086
+ * }
3087
+ * ]
3088
+ * },
3089
+ * "error": {
3090
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
3091
+ * "code": "RATE_LIMIT_EXCEEDED",
3092
+ * "title": "Rate Limit Exceeded",
3093
+ * "status": 429,
3094
+ * "detail": "Too many requests",
3095
+ * "instance": "/v1/cart/items",
3096
+ * "extensions": {
3097
+ * "message_code": "RATE_LIMIT_EXCEEDED",
3098
+ * "invalid_params": []
3099
+ * }
3100
+ * }
3101
+ * }
3102
+ */
3103
+ "application/json": components["schemas"]["StandardResponse"];
3104
+ };
3105
+ };
3106
+ /** @description Internal Server Error */
3107
+ 500: {
3108
+ headers: {
3109
+ [name: string]: unknown;
3110
+ };
3111
+ content: {
3112
+ /**
3113
+ * @example {
3114
+ * "status": "error",
3115
+ * "message": "An unexpected error occurred",
3116
+ * "message_code": "SERVER_ERROR",
3117
+ * "metadata": {
3118
+ * "timestamp": "2025-08-05T18:38:57Z",
3119
+ * "requestId": "uuid",
3120
+ * "traceId": "uuid",
3121
+ * "version": "v1",
3122
+ * "executionTime": 0,
3123
+ * "language": "en-US",
3124
+ * "links": [
3125
+ * {
3126
+ * "rel": "self",
3127
+ * "href": "/v1/cart/items",
3128
+ * "method": "POST"
3129
+ * }
3130
+ * ]
3131
+ * },
3132
+ * "error": {
3133
+ * "type": "https://{your-domain}/errors/server-error",
3134
+ * "code": "SERVER_ERROR",
3135
+ * "title": "Server Error",
3136
+ * "status": 500,
3137
+ * "detail": "An unexpected error occurred",
3138
+ * "instance": "/v1/cart/items",
3139
+ * "extensions": {
3140
+ * "message_code": "SERVER_ERROR",
3141
+ * "invalid_params": []
3142
+ * }
3143
+ * }
3144
+ * }
3145
+ */
3146
+ "application/json": components["schemas"]["StandardResponse"];
3147
+ };
3148
+ };
3149
+ };
3150
+ };
3151
+ triggerCacheWarmUp: {
3152
+ parameters: {
3153
+ query?: never;
3154
+ header?: {
3155
+ authorization?: string | null;
3156
+ };
3157
+ path?: never;
3158
+ cookie?: never;
3159
+ };
3160
+ requestBody: {
3161
+ content: {
3162
+ "application/json": components["schemas"]["WarmUpBody"];
3163
+ };
3164
+ };
3165
+ responses: {
3166
+ /** @description Successful Response */
3167
+ 200: {
3168
+ headers: {
3169
+ [name: string]: unknown;
3170
+ };
3171
+ content: {
3172
+ "application/json": components["schemas"]["StandardResponse"];
3173
+ };
3174
+ };
3175
+ /** @description Bad Request */
3176
+ 400: {
3177
+ headers: {
3178
+ [name: string]: unknown;
3179
+ };
3180
+ content: {
3181
+ /**
3182
+ * @example {
3183
+ * "status": "error",
3184
+ * "message": "An error occurred",
3185
+ * "message_code": "GENERIC_ERROR",
3186
+ * "metadata": {
3187
+ * "timestamp": "2025-08-05T18:38:57Z",
3188
+ * "requestId": "uuid",
3189
+ * "traceId": "uuid",
3190
+ * "version": "v1",
3191
+ * "executionTime": 0,
3192
+ * "language": "en-US",
3193
+ * "links": [
3194
+ * {
3195
+ * "rel": "self",
3196
+ * "href": "/v1/cart/items",
3197
+ * "method": "POST"
3198
+ * }
3199
+ * ]
3200
+ * },
3201
+ * "error": {
3202
+ * "type": "https://{your-domain}/errors/client-error",
3203
+ * "code": "GENERIC_ERROR",
3204
+ * "title": "Client Error",
3205
+ * "status": 400,
3206
+ * "detail": "An error occurred",
3207
+ * "instance": "/v1/cart/items",
3208
+ * "extensions": {
3209
+ * "message_code": "GENERIC_ERROR",
3210
+ * "invalid_params": []
3211
+ * }
3212
+ * }
3213
+ * }
3214
+ */
3215
+ "application/json": components["schemas"]["StandardResponse"];
3216
+ };
3217
+ };
3218
+ /** @description Unprocessable Entity */
3219
+ 422: {
3220
+ headers: {
3221
+ [name: string]: unknown;
3222
+ };
3223
+ content: {
3224
+ /**
3225
+ * @example {
3226
+ * "status": "error",
3227
+ * "message": "One or more input fields are invalid",
3228
+ * "message_code": "INVALID_INPUT",
3229
+ * "metadata": {
3230
+ * "timestamp": "2025-08-05T18:38:57Z",
3231
+ * "requestId": "uuid",
3232
+ * "traceId": "uuid",
3233
+ * "version": "v1",
3234
+ * "executionTime": 0,
3235
+ * "language": "en-US",
3236
+ * "links": [
3237
+ * {
3238
+ * "rel": "self",
3239
+ * "href": "/v1/cart/items",
3240
+ * "method": "POST"
3241
+ * }
3242
+ * ]
3243
+ * },
3244
+ * "error": {
3245
+ * "type": "https://{your-domain}/errors/invalid-input",
3246
+ * "code": "INVALID_INPUT",
3247
+ * "title": "Invalid Input",
3248
+ * "status": 422,
3249
+ * "detail": "One or more input fields are invalid",
3250
+ * "instance": "/v1/cart/items",
3251
+ * "extensions": {
3252
+ * "message_code": "INVALID_INPUT",
3253
+ * "invalid_params": [
3254
+ * {
3255
+ * "field": "items[0].quantity",
3256
+ * "error": "Input should be greater than or equal to 1"
3257
+ * }
3258
+ * ]
3259
+ * }
3260
+ * }
3261
+ * }
3262
+ */
3263
+ "application/json": components["schemas"]["StandardResponse"];
3264
+ };
3265
+ };
3266
+ /** @description Too Many Requests */
3267
+ 429: {
3268
+ headers: {
3269
+ [name: string]: unknown;
3270
+ };
3271
+ content: {
3272
+ /**
3273
+ * @example {
3274
+ * "status": "error",
3275
+ * "message": "Too many requests",
3276
+ * "message_code": "RATE_LIMIT_EXCEEDED",
3277
+ * "metadata": {
3278
+ * "timestamp": "2025-08-05T18:38:57Z",
3279
+ * "requestId": "uuid",
3280
+ * "traceId": "uuid",
3281
+ * "version": "v1",
3282
+ * "executionTime": 0,
3283
+ * "language": "en-US",
3284
+ * "links": [
3285
+ * {
3286
+ * "rel": "self",
3287
+ * "href": "/v1/cart/items",
3288
+ * "method": "POST"
3289
+ * }
3290
+ * ]
3291
+ * },
3292
+ * "error": {
3293
+ * "type": "https://{your-domain}/errors/rate-limit-exceeded",
3294
+ * "code": "RATE_LIMIT_EXCEEDED",
3295
+ * "title": "Rate Limit Exceeded",
3296
+ * "status": 429,
3297
+ * "detail": "Too many requests",
3298
+ * "instance": "/v1/cart/items",
3299
+ * "extensions": {
3300
+ * "message_code": "RATE_LIMIT_EXCEEDED",
3301
+ * "invalid_params": []
3302
+ * }
3303
+ * }
3304
+ * }
3305
+ */
3306
+ "application/json": components["schemas"]["StandardResponse"];
3307
+ };
3308
+ };
3309
+ /** @description Internal Server Error */
3310
+ 500: {
3311
+ headers: {
3312
+ [name: string]: unknown;
3313
+ };
3314
+ content: {
3315
+ /**
3316
+ * @example {
3317
+ * "status": "error",
3318
+ * "message": "An unexpected error occurred",
3319
+ * "message_code": "SERVER_ERROR",
3320
+ * "metadata": {
3321
+ * "timestamp": "2025-08-05T18:38:57Z",
3322
+ * "requestId": "uuid",
3323
+ * "traceId": "uuid",
3324
+ * "version": "v1",
3325
+ * "executionTime": 0,
3326
+ * "language": "en-US",
3327
+ * "links": [
3328
+ * {
3329
+ * "rel": "self",
3330
+ * "href": "/v1/cart/items",
3331
+ * "method": "POST"
3332
+ * }
3333
+ * ]
3334
+ * },
3335
+ * "error": {
3336
+ * "type": "https://{your-domain}/errors/server-error",
3337
+ * "code": "SERVER_ERROR",
3338
+ * "title": "Server Error",
3339
+ * "status": 500,
3340
+ * "detail": "An unexpected error occurred",
3341
+ * "instance": "/v1/cart/items",
3342
+ * "extensions": {
3343
+ * "message_code": "SERVER_ERROR",
3344
+ * "invalid_params": []
3345
+ * }
3346
+ * }
3347
+ * }
3348
+ */
3349
+ "application/json": components["schemas"]["StandardResponse"];
3350
+ };
3351
+ };
3352
+ };
3353
+ };
3354
+ }
3355
+ //# sourceMappingURL=generated.d.ts.map