@salesforce/b2c-tooling-sdk 1.9.0 → 1.11.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 (649) hide show
  1. package/data/content-schemas/componenttype.json +37 -0
  2. package/dist/esm/config/dw-json.d.ts +9 -2
  3. package/dist/esm/config/dw-json.js.map +1 -1
  4. package/dist/esm/config/index.d.ts +2 -2
  5. package/dist/esm/config/index.js +1 -1
  6. package/dist/esm/config/index.js.map +1 -1
  7. package/dist/esm/config/mapping.d.ts +7 -1
  8. package/dist/esm/config/mapping.js +10 -0
  9. package/dist/esm/config/mapping.js.map +1 -1
  10. package/dist/esm/config/sources/package-json-source.js +1 -0
  11. package/dist/esm/config/sources/package-json-source.js.map +1 -1
  12. package/dist/esm/config/types.d.ts +23 -2
  13. package/dist/esm/operations/content/validate.js +46 -4
  14. package/dist/esm/operations/content/validate.js.map +1 -1
  15. package/dist/esm/operations/jobs/site-archive.d.ts +12 -0
  16. package/dist/esm/operations/jobs/site-archive.js +107 -3
  17. package/dist/esm/operations/jobs/site-archive.js.map +1 -1
  18. package/package.json +73 -285
  19. package/dist/cjs/auth/api-key.d.ts +0 -28
  20. package/dist/cjs/auth/api-key.js +0 -45
  21. package/dist/cjs/auth/api-key.js.map +0 -1
  22. package/dist/cjs/auth/basic.d.ts +0 -7
  23. package/dist/cjs/auth/basic.js +0 -20
  24. package/dist/cjs/auth/basic.js.map +0 -1
  25. package/dist/cjs/auth/index.d.ts +0 -74
  26. package/dist/cjs/auth/index.js +0 -76
  27. package/dist/cjs/auth/index.js.map +0 -1
  28. package/dist/cjs/auth/jwt-utils.d.ts +0 -25
  29. package/dist/cjs/auth/jwt-utils.js +0 -66
  30. package/dist/cjs/auth/jwt-utils.js.map +0 -1
  31. package/dist/cjs/auth/middleware.d.ts +0 -196
  32. package/dist/cjs/auth/middleware.js +0 -190
  33. package/dist/cjs/auth/middleware.js.map +0 -1
  34. package/dist/cjs/auth/oauth-implicit.d.ts +0 -89
  35. package/dist/cjs/auth/oauth-implicit.js +0 -350
  36. package/dist/cjs/auth/oauth-implicit.js.map +0 -1
  37. package/dist/cjs/auth/oauth-jwt.d.ts +0 -99
  38. package/dist/cjs/auth/oauth-jwt.js +0 -343
  39. package/dist/cjs/auth/oauth-jwt.js.map +0 -1
  40. package/dist/cjs/auth/oauth.d.ts +0 -88
  41. package/dist/cjs/auth/oauth.js +0 -252
  42. package/dist/cjs/auth/oauth.js.map +0 -1
  43. package/dist/cjs/auth/resolve.d.ts +0 -100
  44. package/dist/cjs/auth/resolve.js +0 -175
  45. package/dist/cjs/auth/resolve.js.map +0 -1
  46. package/dist/cjs/auth/stateful-oauth-strategy.d.ts +0 -39
  47. package/dist/cjs/auth/stateful-oauth-strategy.js +0 -130
  48. package/dist/cjs/auth/stateful-oauth-strategy.js.map +0 -1
  49. package/dist/cjs/auth/stateful-store.d.ts +0 -49
  50. package/dist/cjs/auth/stateful-store.js +0 -166
  51. package/dist/cjs/auth/stateful-store.js.map +0 -1
  52. package/dist/cjs/auth/types.d.ts +0 -124
  53. package/dist/cjs/auth/types.js +0 -8
  54. package/dist/cjs/auth/types.js.map +0 -1
  55. package/dist/cjs/cli/am-command.d.ts +0 -74
  56. package/dist/cjs/cli/am-command.js +0 -199
  57. package/dist/cjs/cli/am-command.js.map +0 -1
  58. package/dist/cjs/cli/base-command.d.ts +0 -232
  59. package/dist/cjs/cli/base-command.js +0 -695
  60. package/dist/cjs/cli/base-command.js.map +0 -1
  61. package/dist/cjs/cli/cartridge-command.d.ts +0 -67
  62. package/dist/cjs/cli/cartridge-command.js +0 -146
  63. package/dist/cjs/cli/cartridge-command.js.map +0 -1
  64. package/dist/cjs/cli/cartridge-providers.d.ts +0 -149
  65. package/dist/cjs/cli/cartridge-providers.js +0 -103
  66. package/dist/cjs/cli/cartridge-providers.js.map +0 -1
  67. package/dist/cjs/cli/columns.d.ts +0 -128
  68. package/dist/cjs/cli/columns.js +0 -128
  69. package/dist/cjs/cli/columns.js.map +0 -1
  70. package/dist/cjs/cli/config.d.ts +0 -159
  71. package/dist/cjs/cli/config.js +0 -185
  72. package/dist/cjs/cli/config.js.map +0 -1
  73. package/dist/cjs/cli/details.d.ts +0 -69
  74. package/dist/cjs/cli/details.js +0 -72
  75. package/dist/cjs/cli/details.js.map +0 -1
  76. package/dist/cjs/cli/hooks.d.ts +0 -324
  77. package/dist/cjs/cli/hooks.js +0 -3
  78. package/dist/cjs/cli/hooks.js.map +0 -1
  79. package/dist/cjs/cli/index.d.ts +0 -108
  80. package/dist/cjs/cli/index.js +0 -111
  81. package/dist/cjs/cli/index.js.map +0 -1
  82. package/dist/cjs/cli/instance-command.d.ts +0 -131
  83. package/dist/cjs/cli/instance-command.js +0 -214
  84. package/dist/cjs/cli/instance-command.js.map +0 -1
  85. package/dist/cjs/cli/job-command.d.ts +0 -32
  86. package/dist/cjs/cli/job-command.js +0 -60
  87. package/dist/cjs/cli/job-command.js.map +0 -1
  88. package/dist/cjs/cli/lifecycle.d.ts +0 -189
  89. package/dist/cjs/cli/lifecycle.js +0 -130
  90. package/dist/cjs/cli/lifecycle.js.map +0 -1
  91. package/dist/cjs/cli/mrt-command.d.ts +0 -57
  92. package/dist/cjs/cli/mrt-command.js +0 -95
  93. package/dist/cjs/cli/mrt-command.js.map +0 -1
  94. package/dist/cjs/cli/oauth-command.d.ts +0 -122
  95. package/dist/cjs/cli/oauth-command.js +0 -311
  96. package/dist/cjs/cli/oauth-command.js.map +0 -1
  97. package/dist/cjs/cli/ods-command.d.ts +0 -97
  98. package/dist/cjs/cli/ods-command.js +0 -136
  99. package/dist/cjs/cli/ods-command.js.map +0 -1
  100. package/dist/cjs/cli/table.d.ts +0 -113
  101. package/dist/cjs/cli/table.js +0 -175
  102. package/dist/cjs/cli/table.js.map +0 -1
  103. package/dist/cjs/cli/webdav-command.d.ts +0 -110
  104. package/dist/cjs/cli/webdav-command.js +0 -106
  105. package/dist/cjs/cli/webdav-command.js.map +0 -1
  106. package/dist/cjs/clients/am-api.d.ts +0 -521
  107. package/dist/cjs/clients/am-api.js +0 -992
  108. package/dist/cjs/clients/am-api.js.map +0 -1
  109. package/dist/cjs/clients/am-apiclients-api.generated.d.ts +0 -803
  110. package/dist/cjs/clients/am-apiclients-api.generated.js +0 -6
  111. package/dist/cjs/clients/am-apiclients-api.generated.js.map +0 -1
  112. package/dist/cjs/clients/am-roles-api.generated.d.ts +0 -298
  113. package/dist/cjs/clients/am-roles-api.generated.js +0 -6
  114. package/dist/cjs/clients/am-roles-api.generated.js.map +0 -1
  115. package/dist/cjs/clients/am-users-api.generated.d.ts +0 -954
  116. package/dist/cjs/clients/am-users-api.generated.js +0 -6
  117. package/dist/cjs/clients/am-users-api.generated.js.map +0 -1
  118. package/dist/cjs/clients/cdn-zones.d.ts +0 -186
  119. package/dist/cjs/clients/cdn-zones.generated.d.ts +0 -8330
  120. package/dist/cjs/clients/cdn-zones.generated.js +0 -6
  121. package/dist/cjs/clients/cdn-zones.generated.js.map +0 -1
  122. package/dist/cjs/clients/cdn-zones.js +0 -103
  123. package/dist/cjs/clients/cdn-zones.js.map +0 -1
  124. package/dist/cjs/clients/cip.d.ts +0 -162
  125. package/dist/cjs/clients/cip.js +0 -572
  126. package/dist/cjs/clients/cip.js.map +0 -1
  127. package/dist/cjs/clients/custom-apis.d.ts +0 -174
  128. package/dist/cjs/clients/custom-apis.generated.d.ts +0 -202
  129. package/dist/cjs/clients/custom-apis.generated.js +0 -6
  130. package/dist/cjs/clients/custom-apis.generated.js.map +0 -1
  131. package/dist/cjs/clients/custom-apis.js +0 -140
  132. package/dist/cjs/clients/custom-apis.js.map +0 -1
  133. package/dist/cjs/clients/error-utils.d.ts +0 -35
  134. package/dist/cjs/clients/error-utils.js +0 -69
  135. package/dist/cjs/clients/error-utils.js.map +0 -1
  136. package/dist/cjs/clients/granular-replications.d.ts +0 -70
  137. package/dist/cjs/clients/granular-replications.generated.d.ts +0 -416
  138. package/dist/cjs/clients/granular-replications.generated.js +0 -6
  139. package/dist/cjs/clients/granular-replications.generated.js.map +0 -1
  140. package/dist/cjs/clients/granular-replications.js +0 -73
  141. package/dist/cjs/clients/granular-replications.js.map +0 -1
  142. package/dist/cjs/clients/index.d.ts +0 -145
  143. package/dist/cjs/clients/index.js +0 -137
  144. package/dist/cjs/clients/index.js.map +0 -1
  145. package/dist/cjs/clients/middleware-registry.d.ts +0 -184
  146. package/dist/cjs/clients/middleware-registry.js +0 -104
  147. package/dist/cjs/clients/middleware-registry.js.map +0 -1
  148. package/dist/cjs/clients/middleware.d.ts +0 -183
  149. package/dist/cjs/clients/middleware.js +0 -465
  150. package/dist/cjs/clients/middleware.js.map +0 -1
  151. package/dist/cjs/clients/mrt-b2c.d.ts +0 -138
  152. package/dist/cjs/clients/mrt-b2c.generated.d.ts +0 -176
  153. package/dist/cjs/clients/mrt-b2c.generated.js +0 -6
  154. package/dist/cjs/clients/mrt-b2c.generated.js.map +0 -1
  155. package/dist/cjs/clients/mrt-b2c.js +0 -86
  156. package/dist/cjs/clients/mrt-b2c.js.map +0 -1
  157. package/dist/cjs/clients/mrt.d.ts +0 -143
  158. package/dist/cjs/clients/mrt.generated.d.ts +0 -3806
  159. package/dist/cjs/clients/mrt.generated.js +0 -6
  160. package/dist/cjs/clients/mrt.generated.js.map +0 -1
  161. package/dist/cjs/clients/mrt.js +0 -93
  162. package/dist/cjs/clients/mrt.js.map +0 -1
  163. package/dist/cjs/clients/ocapi.d.ts +0 -128
  164. package/dist/cjs/clients/ocapi.generated.d.ts +0 -26052
  165. package/dist/cjs/clients/ocapi.generated.js +0 -6
  166. package/dist/cjs/clients/ocapi.generated.js.map +0 -1
  167. package/dist/cjs/clients/ocapi.js +0 -78
  168. package/dist/cjs/clients/ocapi.js.map +0 -1
  169. package/dist/cjs/clients/ods.d.ts +0 -160
  170. package/dist/cjs/clients/ods.generated.d.ts +0 -2860
  171. package/dist/cjs/clients/ods.generated.js +0 -6
  172. package/dist/cjs/clients/ods.generated.js.map +0 -1
  173. package/dist/cjs/clients/ods.js +0 -103
  174. package/dist/cjs/clients/ods.js.map +0 -1
  175. package/dist/cjs/clients/scapi-schemas.d.ts +0 -161
  176. package/dist/cjs/clients/scapi-schemas.generated.d.ts +0 -328
  177. package/dist/cjs/clients/scapi-schemas.generated.js +0 -6
  178. package/dist/cjs/clients/scapi-schemas.generated.js.map +0 -1
  179. package/dist/cjs/clients/scapi-schemas.js +0 -98
  180. package/dist/cjs/clients/scapi-schemas.js.map +0 -1
  181. package/dist/cjs/clients/slas-admin.d.ts +0 -132
  182. package/dist/cjs/clients/slas-admin.generated.d.ts +0 -1434
  183. package/dist/cjs/clients/slas-admin.generated.js +0 -6
  184. package/dist/cjs/clients/slas-admin.generated.js.map +0 -1
  185. package/dist/cjs/clients/slas-admin.js +0 -79
  186. package/dist/cjs/clients/slas-admin.js.map +0 -1
  187. package/dist/cjs/clients/tls-dispatcher.d.ts +0 -42
  188. package/dist/cjs/clients/tls-dispatcher.js +0 -107
  189. package/dist/cjs/clients/tls-dispatcher.js.map +0 -1
  190. package/dist/cjs/clients/user-agent.d.ts +0 -43
  191. package/dist/cjs/clients/user-agent.js +0 -87
  192. package/dist/cjs/clients/user-agent.js.map +0 -1
  193. package/dist/cjs/clients/webdav.d.ts +0 -186
  194. package/dist/cjs/clients/webdav.js +0 -395
  195. package/dist/cjs/clients/webdav.js.map +0 -1
  196. package/dist/cjs/config/config-source-registry.d.ts +0 -115
  197. package/dist/cjs/config/config-source-registry.js +0 -103
  198. package/dist/cjs/config/config-source-registry.js.map +0 -1
  199. package/dist/cjs/config/dw-json.d.ts +0 -267
  200. package/dist/cjs/config/dw-json.js +0 -333
  201. package/dist/cjs/config/dw-json.js.map +0 -1
  202. package/dist/cjs/config/index.d.ts +0 -100
  203. package/dist/cjs/config/index.js +0 -110
  204. package/dist/cjs/config/index.js.map +0 -1
  205. package/dist/cjs/config/instance-manager.d.ts +0 -97
  206. package/dist/cjs/config/instance-manager.js +0 -166
  207. package/dist/cjs/config/instance-manager.js.map +0 -1
  208. package/dist/cjs/config/mapping.d.ts +0 -193
  209. package/dist/cjs/config/mapping.js +0 -530
  210. package/dist/cjs/config/mapping.js.map +0 -1
  211. package/dist/cjs/config/resolved-config.d.ts +0 -29
  212. package/dist/cjs/config/resolved-config.js +0 -81
  213. package/dist/cjs/config/resolved-config.js.map +0 -1
  214. package/dist/cjs/config/resolver.d.ts +0 -191
  215. package/dist/cjs/config/resolver.js +0 -406
  216. package/dist/cjs/config/resolver.js.map +0 -1
  217. package/dist/cjs/config/sources/dw-json-source.d.ts +0 -27
  218. package/dist/cjs/config/sources/dw-json-source.js +0 -106
  219. package/dist/cjs/config/sources/dw-json-source.js.map +0 -1
  220. package/dist/cjs/config/sources/env-source.d.ts +0 -32
  221. package/dist/cjs/config/sources/env-source.js +0 -116
  222. package/dist/cjs/config/sources/env-source.js.map +0 -1
  223. package/dist/cjs/config/sources/index.d.ts +0 -9
  224. package/dist/cjs/config/sources/index.js +0 -15
  225. package/dist/cjs/config/sources/index.js.map +0 -1
  226. package/dist/cjs/config/sources/mobify-source.d.ts +0 -25
  227. package/dist/cjs/config/sources/mobify-source.js +0 -84
  228. package/dist/cjs/config/sources/mobify-source.js.map +0 -1
  229. package/dist/cjs/config/sources/package-json-source.d.ts +0 -14
  230. package/dist/cjs/config/sources/package-json-source.js +0 -96
  231. package/dist/cjs/config/sources/package-json-source.js.map +0 -1
  232. package/dist/cjs/config/types.d.ts +0 -407
  233. package/dist/cjs/config/types.js +0 -2
  234. package/dist/cjs/config/types.js.map +0 -1
  235. package/dist/cjs/defaults.d.ts +0 -36
  236. package/dist/cjs/defaults.js +0 -54
  237. package/dist/cjs/defaults.js.map +0 -1
  238. package/dist/cjs/discovery/detector.d.ts +0 -75
  239. package/dist/cjs/discovery/detector.js +0 -108
  240. package/dist/cjs/discovery/detector.js.map +0 -1
  241. package/dist/cjs/discovery/index.d.ts +0 -63
  242. package/dist/cjs/discovery/index.js +0 -70
  243. package/dist/cjs/discovery/index.js.map +0 -1
  244. package/dist/cjs/discovery/patterns/cartridges.d.ts +0 -16
  245. package/dist/cjs/discovery/patterns/cartridges.js +0 -16
  246. package/dist/cjs/discovery/patterns/cartridges.js.map +0 -1
  247. package/dist/cjs/discovery/patterns/index.d.ts +0 -21
  248. package/dist/cjs/discovery/patterns/index.js +0 -16
  249. package/dist/cjs/discovery/patterns/index.js.map +0 -1
  250. package/dist/cjs/discovery/patterns/pwa-kit.d.ts +0 -15
  251. package/dist/cjs/discovery/patterns/pwa-kit.js +0 -26
  252. package/dist/cjs/discovery/patterns/pwa-kit.js.map +0 -1
  253. package/dist/cjs/discovery/patterns/sfra.d.ts +0 -34
  254. package/dist/cjs/discovery/patterns/sfra.js +0 -50
  255. package/dist/cjs/discovery/patterns/sfra.js.map +0 -1
  256. package/dist/cjs/discovery/patterns/storefront-next.d.ts +0 -10
  257. package/dist/cjs/discovery/patterns/storefront-next.js +0 -65
  258. package/dist/cjs/discovery/patterns/storefront-next.js.map +0 -1
  259. package/dist/cjs/discovery/types.d.ts +0 -47
  260. package/dist/cjs/discovery/types.js +0 -12
  261. package/dist/cjs/discovery/types.js.map +0 -1
  262. package/dist/cjs/discovery/utils.d.ts +0 -44
  263. package/dist/cjs/discovery/utils.js +0 -82
  264. package/dist/cjs/discovery/utils.js.map +0 -1
  265. package/dist/cjs/docs/download.d.ts +0 -45
  266. package/dist/cjs/docs/download.js +0 -96
  267. package/dist/cjs/docs/download.js.map +0 -1
  268. package/dist/cjs/docs/index.d.ts +0 -44
  269. package/dist/cjs/docs/index.js +0 -12
  270. package/dist/cjs/docs/index.js.map +0 -1
  271. package/dist/cjs/docs/schema.d.ts +0 -26
  272. package/dist/cjs/docs/schema.js +0 -92
  273. package/dist/cjs/docs/schema.js.map +0 -1
  274. package/dist/cjs/docs/search.d.ts +0 -67
  275. package/dist/cjs/docs/search.js +0 -128
  276. package/dist/cjs/docs/search.js.map +0 -1
  277. package/dist/cjs/docs/types.d.ts +0 -64
  278. package/dist/cjs/docs/types.js +0 -15
  279. package/dist/cjs/docs/types.js.map +0 -1
  280. package/dist/cjs/errors/http-error.d.ts +0 -34
  281. package/dist/cjs/errors/http-error.js +0 -45
  282. package/dist/cjs/errors/http-error.js.map +0 -1
  283. package/dist/cjs/errors/index.d.ts +0 -12
  284. package/dist/cjs/errors/index.js +0 -18
  285. package/dist/cjs/errors/index.js.map +0 -1
  286. package/dist/cjs/i18n/index.d.ts +0 -144
  287. package/dist/cjs/i18n/index.js +0 -245
  288. package/dist/cjs/i18n/index.js.map +0 -1
  289. package/dist/cjs/i18n/locales/de.d.ts +0 -13
  290. package/dist/cjs/i18n/locales/de.js +0 -19
  291. package/dist/cjs/i18n/locales/de.js.map +0 -1
  292. package/dist/cjs/i18n/locales/index.d.ts +0 -28
  293. package/dist/cjs/i18n/locales/index.js +0 -25
  294. package/dist/cjs/i18n/locales/index.js.map +0 -1
  295. package/dist/cjs/index.d.ts +0 -33
  296. package/dist/cjs/index.js +0 -41
  297. package/dist/cjs/index.js.map +0 -1
  298. package/dist/cjs/instance/index.d.ts +0 -136
  299. package/dist/cjs/instance/index.js +0 -131
  300. package/dist/cjs/instance/index.js.map +0 -1
  301. package/dist/cjs/logging/index.d.ts +0 -116
  302. package/dist/cjs/logging/index.js +0 -121
  303. package/dist/cjs/logging/index.js.map +0 -1
  304. package/dist/cjs/logging/logger.d.ts +0 -9
  305. package/dist/cjs/logging/logger.js +0 -138
  306. package/dist/cjs/logging/logger.js.map +0 -1
  307. package/dist/cjs/logging/types.d.ts +0 -45
  308. package/dist/cjs/logging/types.js +0 -10
  309. package/dist/cjs/logging/types.js.map +0 -1
  310. package/dist/cjs/operations/bm-roles/index.d.ts +0 -52
  311. package/dist/cjs/operations/bm-roles/index.js +0 -57
  312. package/dist/cjs/operations/bm-roles/index.js.map +0 -1
  313. package/dist/cjs/operations/bm-roles/roles.d.ts +0 -155
  314. package/dist/cjs/operations/bm-roles/roles.js +0 -194
  315. package/dist/cjs/operations/bm-roles/roles.js.map +0 -1
  316. package/dist/cjs/operations/bm-users/index.d.ts +0 -50
  317. package/dist/cjs/operations/bm-users/index.js +0 -55
  318. package/dist/cjs/operations/bm-users/index.js.map +0 -1
  319. package/dist/cjs/operations/bm-users/users.d.ts +0 -189
  320. package/dist/cjs/operations/bm-users/users.js +0 -229
  321. package/dist/cjs/operations/bm-users/users.js.map +0 -1
  322. package/dist/cjs/operations/cap/index.d.ts +0 -56
  323. package/dist/cjs/operations/cap/index.js +0 -57
  324. package/dist/cjs/operations/cap/index.js.map +0 -1
  325. package/dist/cjs/operations/cap/install.d.ts +0 -53
  326. package/dist/cjs/operations/cap/install.js +0 -181
  327. package/dist/cjs/operations/cap/install.js.map +0 -1
  328. package/dist/cjs/operations/cap/list.d.ts +0 -92
  329. package/dist/cjs/operations/cap/list.js +0 -230
  330. package/dist/cjs/operations/cap/list.js.map +0 -1
  331. package/dist/cjs/operations/cap/package.d.ts +0 -39
  332. package/dist/cjs/operations/cap/package.js +0 -77
  333. package/dist/cjs/operations/cap/package.js.map +0 -1
  334. package/dist/cjs/operations/cap/pull.d.ts +0 -21
  335. package/dist/cjs/operations/cap/pull.js +0 -77
  336. package/dist/cjs/operations/cap/pull.js.map +0 -1
  337. package/dist/cjs/operations/cap/uninstall.d.ts +0 -46
  338. package/dist/cjs/operations/cap/uninstall.js +0 -87
  339. package/dist/cjs/operations/cap/uninstall.js.map +0 -1
  340. package/dist/cjs/operations/cap/validate.d.ts +0 -47
  341. package/dist/cjs/operations/cap/validate.js +0 -235
  342. package/dist/cjs/operations/cap/validate.js.map +0 -1
  343. package/dist/cjs/operations/cip/index.d.ts +0 -35
  344. package/dist/cjs/operations/cip/index.js +0 -128
  345. package/dist/cjs/operations/cip/index.js.map +0 -1
  346. package/dist/cjs/operations/cip/reports.d.ts +0 -2
  347. package/dist/cjs/operations/cip/reports.js +0 -210
  348. package/dist/cjs/operations/cip/reports.js.map +0 -1
  349. package/dist/cjs/operations/cip/types.d.ts +0 -97
  350. package/dist/cjs/operations/cip/types.js +0 -7
  351. package/dist/cjs/operations/cip/types.js.map +0 -1
  352. package/dist/cjs/operations/code/cartridges.d.ts +0 -46
  353. package/dist/cjs/operations/code/cartridges.js +0 -69
  354. package/dist/cjs/operations/code/cartridges.js.map +0 -1
  355. package/dist/cjs/operations/code/deploy.d.ts +0 -121
  356. package/dist/cjs/operations/code/deploy.js +0 -255
  357. package/dist/cjs/operations/code/deploy.js.map +0 -1
  358. package/dist/cjs/operations/code/download.d.ts +0 -77
  359. package/dist/cjs/operations/code/download.js +0 -300
  360. package/dist/cjs/operations/code/download.js.map +0 -1
  361. package/dist/cjs/operations/code/index.d.ts +0 -74
  362. package/dist/cjs/operations/code/index.js +0 -80
  363. package/dist/cjs/operations/code/index.js.map +0 -1
  364. package/dist/cjs/operations/code/upload-files.d.ts +0 -47
  365. package/dist/cjs/operations/code/upload-files.js +0 -116
  366. package/dist/cjs/operations/code/upload-files.js.map +0 -1
  367. package/dist/cjs/operations/code/versions.d.ts +0 -99
  368. package/dist/cjs/operations/code/versions.js +0 -156
  369. package/dist/cjs/operations/code/versions.js.map +0 -1
  370. package/dist/cjs/operations/code/watch.d.ts +0 -58
  371. package/dist/cjs/operations/code/watch.js +0 -175
  372. package/dist/cjs/operations/code/watch.js.map +0 -1
  373. package/dist/cjs/operations/content/asset-query.d.ts +0 -22
  374. package/dist/cjs/operations/content/asset-query.js +0 -77
  375. package/dist/cjs/operations/content/asset-query.js.map +0 -1
  376. package/dist/cjs/operations/content/export.d.ts +0 -57
  377. package/dist/cjs/operations/content/export.js +0 -221
  378. package/dist/cjs/operations/content/export.js.map +0 -1
  379. package/dist/cjs/operations/content/index.d.ts +0 -56
  380. package/dist/cjs/operations/content/index.js +0 -60
  381. package/dist/cjs/operations/content/index.js.map +0 -1
  382. package/dist/cjs/operations/content/library.d.ts +0 -137
  383. package/dist/cjs/operations/content/library.js +0 -396
  384. package/dist/cjs/operations/content/library.js.map +0 -1
  385. package/dist/cjs/operations/content/types.d.ts +0 -144
  386. package/dist/cjs/operations/content/types.js +0 -7
  387. package/dist/cjs/operations/content/types.js.map +0 -1
  388. package/dist/cjs/operations/content/validate.d.ts +0 -64
  389. package/dist/cjs/operations/content/validate.js +0 -170
  390. package/dist/cjs/operations/content/validate.js.map +0 -1
  391. package/dist/cjs/operations/debug/dap-adapter.d.ts +0 -72
  392. package/dist/cjs/operations/debug/dap-adapter.js +0 -505
  393. package/dist/cjs/operations/debug/dap-adapter.js.map +0 -1
  394. package/dist/cjs/operations/debug/debug-session.d.ts +0 -51
  395. package/dist/cjs/operations/debug/debug-session.js +0 -234
  396. package/dist/cjs/operations/debug/debug-session.js.map +0 -1
  397. package/dist/cjs/operations/debug/index.d.ts +0 -20
  398. package/dist/cjs/operations/debug/index.js +0 -21
  399. package/dist/cjs/operations/debug/index.js.map +0 -1
  400. package/dist/cjs/operations/debug/projections.d.ts +0 -72
  401. package/dist/cjs/operations/debug/projections.js +0 -84
  402. package/dist/cjs/operations/debug/projections.js.map +0 -1
  403. package/dist/cjs/operations/debug/resolve-path.d.ts +0 -15
  404. package/dist/cjs/operations/debug/resolve-path.js +0 -52
  405. package/dist/cjs/operations/debug/resolve-path.js.map +0 -1
  406. package/dist/cjs/operations/debug/sdapi-client.d.ts +0 -44
  407. package/dist/cjs/operations/debug/sdapi-client.js +0 -169
  408. package/dist/cjs/operations/debug/sdapi-client.js.map +0 -1
  409. package/dist/cjs/operations/debug/source-mapping.d.ts +0 -13
  410. package/dist/cjs/operations/debug/source-mapping.js +0 -57
  411. package/dist/cjs/operations/debug/source-mapping.js.map +0 -1
  412. package/dist/cjs/operations/debug/types.d.ts +0 -95
  413. package/dist/cjs/operations/debug/types.js +0 -2
  414. package/dist/cjs/operations/debug/types.js.map +0 -1
  415. package/dist/cjs/operations/debug/variable-store.d.ts +0 -35
  416. package/dist/cjs/operations/debug/variable-store.js +0 -52
  417. package/dist/cjs/operations/debug/variable-store.js.map +0 -1
  418. package/dist/cjs/operations/jobs/index.d.ts +0 -66
  419. package/dist/cjs/operations/jobs/index.js +0 -72
  420. package/dist/cjs/operations/jobs/index.js.map +0 -1
  421. package/dist/cjs/operations/jobs/run.d.ts +0 -239
  422. package/dist/cjs/operations/jobs/run.js +0 -324
  423. package/dist/cjs/operations/jobs/run.js.map +0 -1
  424. package/dist/cjs/operations/jobs/site-archive.d.ts +0 -267
  425. package/dist/cjs/operations/jobs/site-archive.js +0 -423
  426. package/dist/cjs/operations/jobs/site-archive.js.map +0 -1
  427. package/dist/cjs/operations/logs/index.d.ts +0 -65
  428. package/dist/cjs/operations/logs/index.js +0 -73
  429. package/dist/cjs/operations/logs/index.js.map +0 -1
  430. package/dist/cjs/operations/logs/list.d.ts +0 -35
  431. package/dist/cjs/operations/logs/list.js +0 -144
  432. package/dist/cjs/operations/logs/list.js.map +0 -1
  433. package/dist/cjs/operations/logs/path-normalizer.d.ts +0 -82
  434. package/dist/cjs/operations/logs/path-normalizer.js +0 -190
  435. package/dist/cjs/operations/logs/path-normalizer.js.map +0 -1
  436. package/dist/cjs/operations/logs/tail.d.ts +0 -92
  437. package/dist/cjs/operations/logs/tail.js +0 -525
  438. package/dist/cjs/operations/logs/tail.js.map +0 -1
  439. package/dist/cjs/operations/logs/types.d.ts +0 -132
  440. package/dist/cjs/operations/logs/types.js +0 -7
  441. package/dist/cjs/operations/logs/types.js.map +0 -1
  442. package/dist/cjs/operations/mrt/access-control.d.ts +0 -192
  443. package/dist/cjs/operations/mrt/access-control.js +0 -152
  444. package/dist/cjs/operations/mrt/access-control.js.map +0 -1
  445. package/dist/cjs/operations/mrt/b2c-config.d.ts +0 -201
  446. package/dist/cjs/operations/mrt/b2c-config.js +0 -210
  447. package/dist/cjs/operations/mrt/b2c-config.js.map +0 -1
  448. package/dist/cjs/operations/mrt/bundle.d.ts +0 -114
  449. package/dist/cjs/operations/mrt/bundle.js +0 -166
  450. package/dist/cjs/operations/mrt/bundle.js.map +0 -1
  451. package/dist/cjs/operations/mrt/cache.d.ts +0 -80
  452. package/dist/cjs/operations/mrt/cache.js +0 -65
  453. package/dist/cjs/operations/mrt/cache.js.map +0 -1
  454. package/dist/cjs/operations/mrt/certificate.d.ts +0 -60
  455. package/dist/cjs/operations/mrt/certificate.js +0 -76
  456. package/dist/cjs/operations/mrt/certificate.js.map +0 -1
  457. package/dist/cjs/operations/mrt/deployment.d.ts +0 -157
  458. package/dist/cjs/operations/mrt/deployment.js +0 -109
  459. package/dist/cjs/operations/mrt/deployment.js.map +0 -1
  460. package/dist/cjs/operations/mrt/env-var.d.ts +0 -176
  461. package/dist/cjs/operations/mrt/env-var.js +0 -231
  462. package/dist/cjs/operations/mrt/env-var.js.map +0 -1
  463. package/dist/cjs/operations/mrt/env.d.ts +0 -491
  464. package/dist/cjs/operations/mrt/env.js +0 -425
  465. package/dist/cjs/operations/mrt/env.js.map +0 -1
  466. package/dist/cjs/operations/mrt/index.d.ts +0 -75
  467. package/dist/cjs/operations/mrt/index.js +0 -81
  468. package/dist/cjs/operations/mrt/index.js.map +0 -1
  469. package/dist/cjs/operations/mrt/member.d.ts +0 -281
  470. package/dist/cjs/operations/mrt/member.js +0 -244
  471. package/dist/cjs/operations/mrt/member.js.map +0 -1
  472. package/dist/cjs/operations/mrt/notification.d.ts +0 -252
  473. package/dist/cjs/operations/mrt/notification.js +0 -206
  474. package/dist/cjs/operations/mrt/notification.js.map +0 -1
  475. package/dist/cjs/operations/mrt/organization-member.d.ts +0 -68
  476. package/dist/cjs/operations/mrt/organization-member.js +0 -88
  477. package/dist/cjs/operations/mrt/organization-member.js.map +0 -1
  478. package/dist/cjs/operations/mrt/organization.d.ts +0 -80
  479. package/dist/cjs/operations/mrt/organization.js +0 -53
  480. package/dist/cjs/operations/mrt/organization.js.map +0 -1
  481. package/dist/cjs/operations/mrt/project.d.ts +0 -261
  482. package/dist/cjs/operations/mrt/project.js +0 -232
  483. package/dist/cjs/operations/mrt/project.js.map +0 -1
  484. package/dist/cjs/operations/mrt/push.d.ts +0 -290
  485. package/dist/cjs/operations/mrt/push.js +0 -288
  486. package/dist/cjs/operations/mrt/push.js.map +0 -1
  487. package/dist/cjs/operations/mrt/redirect.d.ts +0 -337
  488. package/dist/cjs/operations/mrt/redirect.js +0 -256
  489. package/dist/cjs/operations/mrt/redirect.js.map +0 -1
  490. package/dist/cjs/operations/mrt/tail-logs.d.ts +0 -130
  491. package/dist/cjs/operations/mrt/tail-logs.js +0 -224
  492. package/dist/cjs/operations/mrt/tail-logs.js.map +0 -1
  493. package/dist/cjs/operations/mrt/user.d.ts +0 -135
  494. package/dist/cjs/operations/mrt/user.js +0 -153
  495. package/dist/cjs/operations/mrt/user.js.map +0 -1
  496. package/dist/cjs/operations/ods/index.d.ts +0 -10
  497. package/dist/cjs/operations/ods/index.js +0 -14
  498. package/dist/cjs/operations/ods/index.js.map +0 -1
  499. package/dist/cjs/operations/ods/sandbox-lookup.d.ts +0 -63
  500. package/dist/cjs/operations/ods/sandbox-lookup.js +0 -130
  501. package/dist/cjs/operations/ods/sandbox-lookup.js.map +0 -1
  502. package/dist/cjs/operations/ods/wait-for-clone.d.ts +0 -46
  503. package/dist/cjs/operations/ods/wait-for-clone.js +0 -100
  504. package/dist/cjs/operations/ods/wait-for-clone.js.map +0 -1
  505. package/dist/cjs/operations/ods/wait-for-sandbox.d.ts +0 -64
  506. package/dist/cjs/operations/ods/wait-for-sandbox.js +0 -114
  507. package/dist/cjs/operations/ods/wait-for-sandbox.js.map +0 -1
  508. package/dist/cjs/operations/orgs/index.d.ts +0 -74
  509. package/dist/cjs/operations/orgs/index.js +0 -33
  510. package/dist/cjs/operations/orgs/index.js.map +0 -1
  511. package/dist/cjs/operations/roles/index.d.ts +0 -43
  512. package/dist/cjs/operations/roles/index.js +0 -48
  513. package/dist/cjs/operations/roles/index.js.map +0 -1
  514. package/dist/cjs/operations/sites/cartridges.d.ts +0 -114
  515. package/dist/cjs/operations/sites/cartridges.js +0 -378
  516. package/dist/cjs/operations/sites/cartridges.js.map +0 -1
  517. package/dist/cjs/operations/sites/index.d.ts +0 -46
  518. package/dist/cjs/operations/sites/index.js +0 -51
  519. package/dist/cjs/operations/sites/index.js.map +0 -1
  520. package/dist/cjs/operations/users/index.d.ts +0 -153
  521. package/dist/cjs/operations/users/index.js +0 -139
  522. package/dist/cjs/operations/users/index.js.map +0 -1
  523. package/dist/cjs/operations/util/zip.d.ts +0 -5
  524. package/dist/cjs/operations/util/zip.js +0 -25
  525. package/dist/cjs/operations/util/zip.js.map +0 -1
  526. package/dist/cjs/package.json +0 -1
  527. package/dist/cjs/plugins/discovery.d.ts +0 -46
  528. package/dist/cjs/plugins/discovery.js +0 -122
  529. package/dist/cjs/plugins/discovery.js.map +0 -1
  530. package/dist/cjs/plugins/index.d.ts +0 -26
  531. package/dist/cjs/plugins/index.js +0 -32
  532. package/dist/cjs/plugins/index.js.map +0 -1
  533. package/dist/cjs/plugins/loader.d.ts +0 -34
  534. package/dist/cjs/plugins/loader.js +0 -59
  535. package/dist/cjs/plugins/loader.js.map +0 -1
  536. package/dist/cjs/plugins/manager.d.ts +0 -70
  537. package/dist/cjs/plugins/manager.js +0 -173
  538. package/dist/cjs/plugins/manager.js.map +0 -1
  539. package/dist/cjs/safety/index.d.ts +0 -12
  540. package/dist/cjs/safety/index.js +0 -11
  541. package/dist/cjs/safety/index.js.map +0 -1
  542. package/dist/cjs/safety/safety-guard.d.ts +0 -92
  543. package/dist/cjs/safety/safety-guard.js +0 -270
  544. package/dist/cjs/safety/safety-guard.js.map +0 -1
  545. package/dist/cjs/safety/safety-middleware.d.ts +0 -130
  546. package/dist/cjs/safety/safety-middleware.js +0 -248
  547. package/dist/cjs/safety/safety-middleware.js.map +0 -1
  548. package/dist/cjs/safety/types.d.ts +0 -81
  549. package/dist/cjs/safety/types.js +0 -16
  550. package/dist/cjs/safety/types.js.map +0 -1
  551. package/dist/cjs/safety/with-confirmation.d.ts +0 -58
  552. package/dist/cjs/safety/with-confirmation.js +0 -67
  553. package/dist/cjs/safety/with-confirmation.js.map +0 -1
  554. package/dist/cjs/scaffold/engine.d.ts +0 -68
  555. package/dist/cjs/scaffold/engine.js +0 -149
  556. package/dist/cjs/scaffold/engine.js.map +0 -1
  557. package/dist/cjs/scaffold/executor.d.ts +0 -36
  558. package/dist/cjs/scaffold/executor.js +0 -293
  559. package/dist/cjs/scaffold/executor.js.map +0 -1
  560. package/dist/cjs/scaffold/index.d.ts +0 -76
  561. package/dist/cjs/scaffold/index.js +0 -23
  562. package/dist/cjs/scaffold/index.js.map +0 -1
  563. package/dist/cjs/scaffold/merge.d.ts +0 -63
  564. package/dist/cjs/scaffold/merge.js +0 -192
  565. package/dist/cjs/scaffold/merge.js.map +0 -1
  566. package/dist/cjs/scaffold/parameter-resolver.d.ts +0 -86
  567. package/dist/cjs/scaffold/parameter-resolver.js +0 -191
  568. package/dist/cjs/scaffold/parameter-resolver.js.map +0 -1
  569. package/dist/cjs/scaffold/registry.d.ts +0 -60
  570. package/dist/cjs/scaffold/registry.js +0 -225
  571. package/dist/cjs/scaffold/registry.js.map +0 -1
  572. package/dist/cjs/scaffold/sources.d.ts +0 -83
  573. package/dist/cjs/scaffold/sources.js +0 -236
  574. package/dist/cjs/scaffold/sources.js.map +0 -1
  575. package/dist/cjs/scaffold/types.d.ts +0 -282
  576. package/dist/cjs/scaffold/types.js +0 -14
  577. package/dist/cjs/scaffold/types.js.map +0 -1
  578. package/dist/cjs/scaffold/validation.d.ts +0 -81
  579. package/dist/cjs/scaffold/validation.js +0 -250
  580. package/dist/cjs/scaffold/validation.js.map +0 -1
  581. package/dist/cjs/scaffold/validators.d.ts +0 -33
  582. package/dist/cjs/scaffold/validators.js +0 -340
  583. package/dist/cjs/scaffold/validators.js.map +0 -1
  584. package/dist/cjs/schemas/collapse.d.ts +0 -150
  585. package/dist/cjs/schemas/collapse.js +0 -180
  586. package/dist/cjs/schemas/collapse.js.map +0 -1
  587. package/dist/cjs/schemas/index.d.ts +0 -58
  588. package/dist/cjs/schemas/index.js +0 -65
  589. package/dist/cjs/schemas/index.js.map +0 -1
  590. package/dist/cjs/schemas/security-schemes.d.ts +0 -26
  591. package/dist/cjs/schemas/security-schemes.js +0 -44
  592. package/dist/cjs/schemas/security-schemes.js.map +0 -1
  593. package/dist/cjs/skills/agents.d.ts +0 -42
  594. package/dist/cjs/skills/agents.js +0 -200
  595. package/dist/cjs/skills/agents.js.map +0 -1
  596. package/dist/cjs/skills/github.d.ts +0 -31
  597. package/dist/cjs/skills/github.js +0 -450
  598. package/dist/cjs/skills/github.js.map +0 -1
  599. package/dist/cjs/skills/index.d.ts +0 -43
  600. package/dist/cjs/skills/index.js +0 -16
  601. package/dist/cjs/skills/index.js.map +0 -1
  602. package/dist/cjs/skills/installer.d.ts +0 -35
  603. package/dist/cjs/skills/installer.js +0 -182
  604. package/dist/cjs/skills/installer.js.map +0 -1
  605. package/dist/cjs/skills/parser.d.ts +0 -39
  606. package/dist/cjs/skills/parser.js +0 -126
  607. package/dist/cjs/skills/parser.js.map +0 -1
  608. package/dist/cjs/skills/sources.d.ts +0 -4
  609. package/dist/cjs/skills/sources.js +0 -52
  610. package/dist/cjs/skills/sources.js.map +0 -1
  611. package/dist/cjs/skills/types.d.ts +0 -153
  612. package/dist/cjs/skills/types.js +0 -7
  613. package/dist/cjs/skills/types.js.map +0 -1
  614. package/dist/cjs/slas/index.d.ts +0 -12
  615. package/dist/cjs/slas/index.js +0 -8
  616. package/dist/cjs/slas/index.js.map +0 -1
  617. package/dist/cjs/slas/pkce.d.ts +0 -13
  618. package/dist/cjs/slas/pkce.js +0 -35
  619. package/dist/cjs/slas/pkce.js.map +0 -1
  620. package/dist/cjs/slas/token.d.ts +0 -24
  621. package/dist/cjs/slas/token.js +0 -261
  622. package/dist/cjs/slas/token.js.map +0 -1
  623. package/dist/cjs/slas/types.d.ts +0 -43
  624. package/dist/cjs/slas/types.js +0 -7
  625. package/dist/cjs/slas/types.js.map +0 -1
  626. package/dist/cjs/telemetry/index.d.ts +0 -34
  627. package/dist/cjs/telemetry/index.js +0 -32
  628. package/dist/cjs/telemetry/index.js.map +0 -1
  629. package/dist/cjs/telemetry/telemetry.d.ts +0 -88
  630. package/dist/cjs/telemetry/telemetry.js +0 -298
  631. package/dist/cjs/telemetry/telemetry.js.map +0 -1
  632. package/dist/cjs/telemetry/types.d.ts +0 -62
  633. package/dist/cjs/telemetry/types.js +0 -7
  634. package/dist/cjs/telemetry/types.js.map +0 -1
  635. package/dist/cjs/test-utils/config-isolation.d.ts +0 -2
  636. package/dist/cjs/test-utils/config-isolation.js +0 -48
  637. package/dist/cjs/test-utils/config-isolation.js.map +0 -1
  638. package/dist/cjs/test-utils/index.d.ts +0 -1
  639. package/dist/cjs/test-utils/index.js +0 -7
  640. package/dist/cjs/test-utils/index.js.map +0 -1
  641. package/dist/cjs/ux/confirm.d.ts +0 -14
  642. package/dist/cjs/ux/confirm.js +0 -36
  643. package/dist/cjs/ux/confirm.js.map +0 -1
  644. package/dist/cjs/ux/index.d.ts +0 -1
  645. package/dist/cjs/ux/index.js +0 -7
  646. package/dist/cjs/ux/index.js.map +0 -1
  647. package/dist/cjs/version.d.ts +0 -14
  648. package/dist/cjs/version.js +0 -29
  649. package/dist/cjs/version.js.map +0 -1
@@ -1,2860 +0,0 @@
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
- "/": {
7
- parameters: {
8
- query?: never;
9
- header?: never;
10
- path?: never;
11
- cookie?: never;
12
- };
13
- /**
14
- * Retrieve API information.
15
- * @description Return API version information.
16
- */
17
- get: operations["getApiInfo"];
18
- put?: never;
19
- post?: never;
20
- delete?: never;
21
- options?: never;
22
- head?: never;
23
- patch?: never;
24
- trace?: never;
25
- };
26
- "/me": {
27
- parameters: {
28
- query?: never;
29
- header?: never;
30
- path?: never;
31
- cookie?: never;
32
- };
33
- /**
34
- * Retrieve user information.
35
- * @description Return information about the user interacting with the API.
36
- */
37
- get: operations["getUserInfo"];
38
- put?: never;
39
- post?: never;
40
- delete?: never;
41
- options?: never;
42
- head?: never;
43
- patch?: never;
44
- trace?: never;
45
- };
46
- "/system": {
47
- parameters: {
48
- query?: never;
49
- header?: never;
50
- path?: never;
51
- cookie?: never;
52
- };
53
- /**
54
- * Retrieve system information
55
- * @description Returns information about the system, the user is interacting with.
56
- */
57
- get: operations["getSystemInfo"];
58
- put?: never;
59
- post?: never;
60
- delete?: never;
61
- options?: never;
62
- head?: never;
63
- patch?: never;
64
- trace?: never;
65
- };
66
- "/realms/{realm}/system": {
67
- parameters: {
68
- query?: never;
69
- header?: never;
70
- path: {
71
- /** @description The four-letter ID of the realm. */
72
- realm: components["parameters"]["realmParam"];
73
- };
74
- cookie?: never;
75
- };
76
- /**
77
- * Retrieve system information
78
- * @description Returns information about the system, the user is interacting with.
79
- */
80
- get: operations["getRealmSystemInfo"];
81
- put?: never;
82
- post?: never;
83
- delete?: never;
84
- options?: never;
85
- head?: never;
86
- patch?: never;
87
- trace?: never;
88
- };
89
- "/realms/{realm}": {
90
- parameters: {
91
- query?: {
92
- /** @description Additional information, which should be shown in the realm query. Available options are: [configuration,usage, accountdetails]. */
93
- expand?: ("configuration" | "usage" | "accountdetails")[];
94
- };
95
- header?: never;
96
- path: {
97
- /** @description The four-letter ID of the realm. */
98
- realm: components["parameters"]["realmParam"];
99
- };
100
- cookie?: never;
101
- };
102
- /**
103
- * Show realm information.
104
- * @description Return metadata about a realm.
105
- */
106
- get: operations["getRealm"];
107
- put?: never;
108
- post?: never;
109
- delete?: never;
110
- options?: never;
111
- head?: never;
112
- patch?: never;
113
- trace?: never;
114
- };
115
- "/realms/{realm}/configuration": {
116
- parameters: {
117
- query?: never;
118
- header?: never;
119
- path: {
120
- /** @description The four-letter ID of the realm. */
121
- realm: components["parameters"]["realmParam"];
122
- };
123
- cookie?: never;
124
- };
125
- /**
126
- * Show realm configuration.
127
- * @description Return the current configuration values of the realm.
128
- */
129
- get: operations["getRealmConfiguration"];
130
- put?: never;
131
- post?: never;
132
- delete?: never;
133
- options?: never;
134
- head?: never;
135
- /**
136
- * Update realm configuration.
137
- * @description Update the customizable configuration of a realm. Note that the internal time format in weekday schedules is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Times).
138
- */
139
- patch: operations["patchRealmConfiguration"];
140
- trace?: never;
141
- };
142
- "/realms/{realm}/usage": {
143
- parameters: {
144
- query?: {
145
- /** @description Earliest date for which data is in the response. Thirty days in the past by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
146
- from?: components["parameters"]["fromParam"];
147
- /** @description Latest date for which data is included in the response. Today's date by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
148
- to?: components["parameters"]["toParam"];
149
- /** @description Field to check whether detailed report is to be retrieved, by default detailed report will not be pulled */
150
- detailedReport?: components["parameters"]["detailedReportParam"];
151
- /** @description Granularity of usage to be included in the response. By default, granular usage is not returned. */
152
- granularity?: components["parameters"]["granularityParam"];
153
- };
154
- header?: never;
155
- path: {
156
- /** @description The four-letter ID of the realm. */
157
- realm: components["parameters"]["realmParam"];
158
- };
159
- cookie?: never;
160
- };
161
- /**
162
- * Show usage information for realm.
163
- * @description Return information about the realm's usage.
164
- */
165
- get: operations["getRealmUsage"];
166
- put?: never;
167
- post?: never;
168
- delete?: never;
169
- options?: never;
170
- head?: never;
171
- patch?: never;
172
- trace?: never;
173
- };
174
- "/realms/usages": {
175
- parameters: {
176
- query?: never;
177
- header?: never;
178
- path?: never;
179
- cookie?: never;
180
- };
181
- get?: never;
182
- put?: never;
183
- /**
184
- * Show usage information for given realms.
185
- * @description Update the customizable configuration of a realm. Note that the internal time format in weekday schedules is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Times).
186
- */
187
- post: operations["searchRealmUsage"];
188
- delete?: never;
189
- options?: never;
190
- head?: never;
191
- patch?: never;
192
- trace?: never;
193
- };
194
- "/sandboxes": {
195
- parameters: {
196
- query?: never;
197
- header?: never;
198
- path?: never;
199
- cookie?: never;
200
- };
201
- /**
202
- * List sandboxes.
203
- * @description Return all sandboxes of a realm.
204
- */
205
- get: operations["getSandboxes"];
206
- put?: never;
207
- /**
208
- * Create sandbox.
209
- * @description Create a new sandbox within the realm.
210
- */
211
- post: operations["createSandbox"];
212
- delete?: never;
213
- options?: never;
214
- head?: never;
215
- patch?: never;
216
- trace?: never;
217
- };
218
- "/sandboxes/{sandboxId}": {
219
- parameters: {
220
- query?: never;
221
- header?: never;
222
- path: {
223
- /** @description The sandbox UUID. */
224
- sandboxId: components["parameters"]["sandboxIdParam"];
225
- };
226
- cookie?: never;
227
- };
228
- /**
229
- * Retrieve sandbox information.
230
- * @description Return details on a specific sandbox in a realm.
231
- */
232
- get: operations["getSandbox"];
233
- put?: never;
234
- post?: never;
235
- /**
236
- * Delete sandbox.
237
- * @description Delete a specific sandbox in a realm.
238
- */
239
- delete: operations["deleteSandbox"];
240
- options?: never;
241
- head?: never;
242
- /**
243
- * Update sandbox.
244
- * @description Update a sandbox.
245
- */
246
- patch: operations["patchSandbox"];
247
- trace?: never;
248
- };
249
- "/sandboxes/{sandboxId}/aliases": {
250
- parameters: {
251
- query?: never;
252
- header?: never;
253
- path: {
254
- /** @description The sandbox UUID. */
255
- sandboxId: components["parameters"]["sandboxIdParam"];
256
- };
257
- cookie?: never;
258
- };
259
- /**
260
- * Read all sandbox aliases
261
- * @description Retrieve a list of all past and present operations on a sandbox within the realm.
262
- */
263
- get: operations["getAliases"];
264
- put?: never;
265
- /**
266
- * Create sandbox alias.
267
- * @description Create a new sandbox alias.
268
- */
269
- post: operations["createAlias"];
270
- delete?: never;
271
- options?: never;
272
- head?: never;
273
- patch?: never;
274
- trace?: never;
275
- };
276
- "/sandboxes/{sandboxId}/aliases/{sandboxAliasId}": {
277
- parameters: {
278
- query?: never;
279
- header?: never;
280
- path: {
281
- /** @description The sandbox UUID. */
282
- sandboxId: components["parameters"]["sandboxIdParam"];
283
- /** @description The sandbox alias UUID. */
284
- sandboxAliasId: components["parameters"]["sandboxAliasIdParam"];
285
- };
286
- cookie?: never;
287
- };
288
- /**
289
- * Read Alias configuration
290
- * @description Retrieves a dedicated alias for the sandbox. Can be called without authentication to get cookie values for the alias.
291
- */
292
- get: operations["getAlias"];
293
- put?: never;
294
- post?: never;
295
- /**
296
- * Delete Alias configuration
297
- * @description Deletes a dedicated alias configuration for a sandbox.
298
- */
299
- delete: operations["deleteAlias"];
300
- options?: never;
301
- head?: never;
302
- patch?: never;
303
- trace?: never;
304
- };
305
- "/sandboxes/{sandboxId}/clones": {
306
- parameters: {
307
- query?: never;
308
- header?: never;
309
- path: {
310
- /** @description The sandbox UUID. */
311
- sandboxId: components["parameters"]["sandboxIdParam"];
312
- };
313
- cookie?: never;
314
- };
315
- /**
316
- * List all cloned sandboxes for a specific sandbox.
317
- * @description Return all cloned sandboxes for a specific sandbox. Optionally filter by date range using fromDate and toDate parameters. If fromDate is provided without toDate, toDate defaults to the current timestamp. If both are omitted, all clones are returned. All dates are processed in UTC timezone. Optionally filter by status.
318
- */
319
- get: operations["getSandboxesClone"];
320
- put?: never;
321
- /**
322
- * Create sandbox clone.
323
- * @description Create a new sandbox clone for a specific sandbox.
324
- */
325
- post: operations["createSandboxClone"];
326
- delete?: never;
327
- options?: never;
328
- head?: never;
329
- patch?: never;
330
- trace?: never;
331
- };
332
- "/sandboxes/{sandboxId}/clones/{cloneId}": {
333
- parameters: {
334
- query?: never;
335
- header?: never;
336
- path: {
337
- /** @description The sandbox UUID. */
338
- sandboxId: components["parameters"]["sandboxIdParam"];
339
- /** @description The sandbox clone unique ID. A unique identifier of the sandbox in the format: realm-instance-clone-timestamp (e.g., aaaa-002-1642780893121), where: realm is 4 lowercase letters, instance is 3-digit number, timestamp is in ddMMyyyyHHmm format (13 digits). */
340
- cloneId: components["parameters"]["sandboxCloneIdParam"];
341
- };
342
- cookie?: never;
343
- };
344
- /**
345
- * Retrieve sandbox clone information.
346
- * @description Return details on a specific cloned sandbox for a sandbox.
347
- */
348
- get: operations["getSandboxClone"];
349
- put?: never;
350
- post?: never;
351
- delete?: never;
352
- options?: never;
353
- head?: never;
354
- patch?: never;
355
- trace?: never;
356
- };
357
- "/sandboxes/{sandboxId}/operations": {
358
- parameters: {
359
- query?: never;
360
- header?: never;
361
- path: {
362
- /** @description The sandbox UUID. */
363
- sandboxId: components["parameters"]["sandboxIdParam"];
364
- };
365
- cookie?: never;
366
- };
367
- /**
368
- * List sandbox operations.
369
- * @description Retrieve a list of all past and present operations on a sandbox within the realm.
370
- */
371
- get: operations["getSandboxOperations"];
372
- put?: never;
373
- /**
374
- * Run sandbox operation.
375
- * @description Request an operation on a sandbox within the realm.
376
- */
377
- post: operations["createSandboxOperation"];
378
- delete?: never;
379
- options?: never;
380
- head?: never;
381
- patch?: never;
382
- trace?: never;
383
- };
384
- "/sandboxes/{sandboxId}/operations/{operationId}": {
385
- parameters: {
386
- query?: never;
387
- header?: never;
388
- path: {
389
- /** @description The sandbox UUID. */
390
- sandboxId: components["parameters"]["sandboxIdParam"];
391
- /** @description The operation UUID. */
392
- operationId: components["parameters"]["operationIdParam"];
393
- };
394
- cookie?: never;
395
- };
396
- /**
397
- * Retrieve sandbox operation.
398
- * @description Return details of a sandbox operation that was recently submitted, is currently in progress, or has already finished.
399
- */
400
- get: operations["getSandboxOperation"];
401
- put?: never;
402
- post?: never;
403
- delete?: never;
404
- options?: never;
405
- head?: never;
406
- patch?: never;
407
- trace?: never;
408
- };
409
- "/sandboxes/{sandboxId}/settings": {
410
- parameters: {
411
- query?: never;
412
- header?: never;
413
- path: {
414
- /** @description The sandbox UUID. */
415
- sandboxId: components["parameters"]["sandboxIdParam"];
416
- };
417
- cookie?: never;
418
- };
419
- /**
420
- * Show sandbox settings.
421
- * @description Return all settings of the sandbox.
422
- */
423
- get: operations["getSandboxSettings"];
424
- put?: never;
425
- post?: never;
426
- delete?: never;
427
- options?: never;
428
- head?: never;
429
- patch?: never;
430
- trace?: never;
431
- };
432
- "/sandboxes/{sandboxId}/usage": {
433
- parameters: {
434
- query?: {
435
- /** @description Earliest date for which data is in the response. Thirty days in the past by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
436
- from?: components["parameters"]["fromParam"];
437
- /** @description Latest date for which data is included in the response. Today's date by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
438
- to?: components["parameters"]["toParam"];
439
- };
440
- header?: never;
441
- path: {
442
- /** @description The sandbox UUID. */
443
- sandboxId: components["parameters"]["sandboxIdParam"];
444
- };
445
- cookie?: never;
446
- };
447
- /**
448
- * Show sandbox usage.
449
- * @description Return information on sandbox usage.
450
- */
451
- get: operations["getSandboxUsage"];
452
- put?: never;
453
- post?: never;
454
- delete?: never;
455
- options?: never;
456
- head?: never;
457
- patch?: never;
458
- trace?: never;
459
- };
460
- "/sandboxes/{sandboxId}/storage": {
461
- parameters: {
462
- query?: never;
463
- header?: never;
464
- path: {
465
- /** @description The sandbox UUID. */
466
- sandboxId: components["parameters"]["sandboxIdParam"];
467
- };
468
- cookie?: never;
469
- };
470
- /**
471
- * Show sandbox storage
472
- * @description Return information on sandbox storage capacity for a currently running sandbox.
473
- */
474
- get: operations["getSandboxStorage"];
475
- put?: never;
476
- post?: never;
477
- delete?: never;
478
- options?: never;
479
- head?: never;
480
- patch?: never;
481
- trace?: never;
482
- };
483
- }
484
- export type webhooks = Record<string, never>;
485
- export interface components {
486
- schemas: {
487
- Response: {
488
- /**
489
- * @description Type of response object.
490
- * @enum {string}
491
- */
492
- kind: "ApiVersion" | "UserInfo" | "SystemInfo" | "Realm" | "RealmConfiguration" | "RealmUsage" | "MultiRealmUsage" | "Sandbox" | "SandboxList" | "SandboxAlias" | "SandboxAliasList" | "SandboxSettings" | "SandboxUsage" | "SandboxStorage" | "SandboxOperationList" | "SandboxCloneList" | "SandboxClone" | "Status";
493
- /**
494
- * Format: int32
495
- * @description Response code sent along with the status.
496
- */
497
- code: number;
498
- };
499
- StatusResponse: components["schemas"]["Response"] & {
500
- /**
501
- * @description String with value 'Success' or 'Failure' to indicate request outcome.
502
- * @enum {string}
503
- */
504
- status: "Success" | "Failure";
505
- };
506
- PagedResponse: components["schemas"]["StatusResponse"] & {
507
- metadata?: components["schemas"]["PagingMetadata"];
508
- };
509
- PagingMetadata: {
510
- /**
511
- * Format: int32
512
- * @description Index of the current page.
513
- */
514
- page?: number;
515
- /**
516
- * Format: int32
517
- * @description Maximum count of elements per page.
518
- */
519
- perPage?: number;
520
- /**
521
- * Format: int32
522
- * @description Total count of pages.
523
- */
524
- pageCount?: number;
525
- /**
526
- * Format: int64
527
- * @description Total count of elements.
528
- */
529
- totalCount?: number;
530
- links?: components["schemas"]["PagingLinks"];
531
- };
532
- PagingLinks: {
533
- /** @description Relative link to this page. */
534
- self?: string;
535
- /** @description Relative link to the first page. */
536
- first?: string;
537
- /** @description Relative link to the previous page. 'null' if the current page is the first page. */
538
- previous?: string;
539
- /** @description Relative link to the next page. 'null' if the current page is the last page. */
540
- next?: string;
541
- /** @description Relative link to the last page. */
542
- last?: string;
543
- };
544
- RealmResponse: components["schemas"]["StatusResponse"] & {
545
- data?: components["schemas"]["RealmModel"];
546
- };
547
- RealmModel: {
548
- /** @description GUID of the realm in the system. */
549
- id: string;
550
- /** @description Human-readable four-letter ID of the realm. */
551
- name?: string;
552
- /** @description Flag indicating whether the realm is enabled for any operations. */
553
- enabled?: boolean;
554
- usage?: components["schemas"]["RealmUsageSummaryModel"];
555
- configuration?: components["schemas"]["RealmConfigurationModel"];
556
- accountdetails?: components["schemas"]["AccountDetailsModel"];
557
- };
558
- RealmUsageSummaryModel: {
559
- /**
560
- * Format: int64
561
- * @description Number of currently active sandboxes for a realm.
562
- * @example 42
563
- */
564
- activeSandboxes: number;
565
- };
566
- RealmConfigurationResponse: components["schemas"]["StatusResponse"] & {
567
- data?: components["schemas"]["RealmConfigurationModel"];
568
- };
569
- /** @description Object that holds an integer-based configuration property. A zero value means "unlimited". */
570
- ConfigurationIntegerValue: {
571
- /**
572
- * Format: int32
573
- * @description Fixed value for this configuration property. You can't use this along with a maximum or default value.
574
- */
575
- fixedValue?: number;
576
- /**
577
- * Format: int32
578
- * @description Maximum value for this property.
579
- */
580
- maximum?: number;
581
- /**
582
- * Format: int32
583
- * @description Default value for this property.
584
- */
585
- defaultValue?: number;
586
- };
587
- /** @description A schedule definition for a dedicated time on specific weekdays. */
588
- WeekdaySchedule: {
589
- /** @description List of weekdays, where the action should take place */
590
- weekdays?: ("MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY")[];
591
- /**
592
- * @description Time (with timezone) where the action should take place on the specified weekdays. Time format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Times). If no time zone is given, the timezone defaults to GMT.
593
- * @example 20:10:00Z
594
- */
595
- time?: string;
596
- };
597
- /**
598
- * @description Configuration object related to sandboxes of a realm.
599
- * @example {
600
- * "limitsEnabled": true,
601
- * "totalNumberOfSandboxes": 50,
602
- * "sandboxTTL": {
603
- * "maximum": 240,
604
- * "defaultValue": 8
605
- * },
606
- * "localUsersAllowed": false
607
- * }
608
- */
609
- RealmSandboxConfigurationModel: {
610
- /** @description Flag indicating whether sandbox specific limits are enforced for the realm. */
611
- limitsEnabled: boolean;
612
- /** @description Total number of sandboxes (regardless of state) that the realm can hold. */
613
- totalNumberOfSandboxes: number;
614
- sandboxTTL: components["schemas"]["ConfigurationIntegerValue"];
615
- /** @description Flag indicating whether users outside the Account Manager are allowed. */
616
- localUsersAllowed: boolean;
617
- };
618
- /**
619
- * @description Update data for configuration data related to sandboxes of a realm. The time formats within the weekday schedules have to be passed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Times) format.
620
- * @example {
621
- * "sandboxTTL": {
622
- * "maximum": 240,
623
- * "defaultValue": 24
624
- * },
625
- * "startScheduler": {
626
- * "weekdays": [
627
- * "MONDAY",
628
- * "TUESDAY",
629
- * "WEDNESDAY",
630
- * "THURSDAY",
631
- * "FRIDAY"
632
- * ],
633
- * "time": "08:00:00+03:00"
634
- * },
635
- * "stopScheduler": {
636
- * "weekdays": [
637
- * "MONDAY",
638
- * "TUESDAY",
639
- * "WEDNESDAY",
640
- * "THURSDAY",
641
- * "FRIDAY"
642
- * ],
643
- * "time": "19:00:00Z"
644
- * }
645
- * }
646
- */
647
- RealmSandboxConfigurationUpdateModel: {
648
- sandboxTTL?: components["schemas"]["ConfigurationIntegerValue"];
649
- startScheduler?: unknown;
650
- stopScheduler?: unknown;
651
- } | null;
652
- /**
653
- * @description Configuration object related to requests targeting the sandboxes of a realm.
654
- * @example {
655
- * "enforced": true,
656
- * "maxRate": 50000,
657
- * "timePeriod": 60
658
- * }
659
- */
660
- RealmRequestConfigurationModel: {
661
- /** @description If enabled, rate limiting is active. */
662
- enforced: boolean;
663
- /** @description Maximum requests allowed per time period. */
664
- maxRate?: number;
665
- /** @description Number of seconds during which to count requests. */
666
- timePeriod?: number;
667
- };
668
- RealmConfigurationModel: {
669
- /**
670
- * @example [
671
- * "email1@example.com",
672
- * "email2@example.com"
673
- * ]
674
- */
675
- emails?: string[];
676
- sandbox?: components["schemas"]["RealmSandboxConfigurationModel"];
677
- requests?: components["schemas"]["RealmRequestConfigurationModel"];
678
- startScheduler?: components["schemas"]["WeekdaySchedule"];
679
- stopScheduler?: components["schemas"]["WeekdaySchedule"];
680
- };
681
- RealmConfigurationUpdateRequestModel: {
682
- /**
683
- * @example [
684
- * "email1@example.com",
685
- * "email2@example.com"
686
- * ]
687
- */
688
- emails?: string[];
689
- sandbox?: components["schemas"]["RealmSandboxConfigurationUpdateModel"];
690
- };
691
- RealmUsageResponse: components["schemas"]["StatusResponse"] & {
692
- data?: components["schemas"]["RealmUsageModel"];
693
- };
694
- MultiRealmUsageModel: {
695
- /** @description GUID of the realm in the system. */
696
- realmName: string;
697
- realmUsage?: components["schemas"]["RealmUsageModel"];
698
- /** @description Error while getting usage. */
699
- error?: string;
700
- };
701
- RealmUsageModel: {
702
- /** @description GUID of the realm in the system. */
703
- id: string;
704
- /** @description account/SFID of the realm in clusterstate table or org62 Tenant table */
705
- accountId?: string;
706
- /**
707
- * Format: int64
708
- * @description Total number of sandboxes created during the requested timeframe (by default, the previous 30 days).
709
- * @example 93
710
- */
711
- createdSandboxes?: number;
712
- /**
713
- * Format: int64
714
- * @description Total number of sandboxes active during the requested timeframe (by default, the previous 30 days).
715
- * @example 128
716
- */
717
- activeSandboxes?: number;
718
- /**
719
- * Format: int64
720
- * @description Total number of sandboxes deleted during the requested timeframe (by default, the previous 30 days).
721
- * @example 86
722
- */
723
- deletedSandboxes?: number;
724
- /**
725
- * Format: int64
726
- * @description Total number of seconds sandboxes ran during the requested timeframe (by default, the previous 30 days).
727
- * @example 360000
728
- */
729
- sandboxSeconds?: number;
730
- minutesUpByProfile?: {
731
- profile?: components["schemas"]["SandboxResourceProfile"];
732
- /**
733
- * Format: int64
734
- * @description How many minutes sandboxes of this profile type were running during the report timeframe.
735
- */
736
- minutes?: number;
737
- }[];
738
- /**
739
- * Format: int64
740
- * @description Sum of minutes sandboxes in this realm were running during the requested timeframe (by default, the previous 30 days).
741
- * @example 360000
742
- */
743
- minutesUp?: number;
744
- /**
745
- * Format: int64
746
- * @description Sum of minutes sandboxes in this realm were not running during the requested timeframe (by default, the previous 30 days).
747
- * @example 180000
748
- */
749
- minutesDown?: number;
750
- sandboxDetails?: components["schemas"]["SandboxInfo"][];
751
- granularUsage?: components["schemas"]["GranularUsage"][];
752
- };
753
- AccountDetailsModel: {
754
- /**
755
- * @description Account name.
756
- * @example Disney
757
- */
758
- accountName?: string;
759
- /**
760
- * Format: double
761
- * @description Total Credit Balance left.
762
- * @example 93.234
763
- */
764
- creditBalance?: number;
765
- };
766
- MultiRealmUsageRequest: {
767
- /**
768
- * Format: date
769
- * @description Time the sandbox was started.
770
- */
771
- from?: string;
772
- /**
773
- * Format: date
774
- * @description Time the sandbox was stopped. If the sandbox is still running, this value will not exist for the last block.
775
- */
776
- to?: string;
777
- realms?: string[];
778
- /**
779
- * @description Field to check whether detailed report is to be retrieved, by default detailed report will not be pulled.
780
- * @default false
781
- * @enum {boolean}
782
- */
783
- detailedReport: false | true;
784
- };
785
- MultiRealmUsageResponse: {
786
- data?: components["schemas"]["MultiRealmUsageModel"][];
787
- } & (components["schemas"]["StatusResponse"] & Record<string, never>);
788
- SandboxListResponse: components["schemas"]["StatusResponse"] & {
789
- data?: components["schemas"]["SandboxModel"][];
790
- };
791
- SandboxResponse: components["schemas"]["StatusResponse"] & {
792
- data?: components["schemas"]["SandboxModel"];
793
- };
794
- SandboxCloneListResponse: components["schemas"]["StatusResponse"] & {
795
- data?: components["schemas"]["SandboxCloneGetModel"][];
796
- };
797
- SandboxCloneResponse: components["schemas"]["StatusResponse"] & {
798
- data?: components["schemas"]["SandboxCloneGetModel"];
799
- };
800
- SandboxCloneCreateResponse: components["schemas"]["StatusResponse"] & {
801
- data?: components["schemas"]["SandboxCloneCreateModel"];
802
- };
803
- SandboxCloneGetModel: {
804
- cloneId?: string;
805
- realm?: string;
806
- sourceInstance?: string;
807
- targetInstance?: string;
808
- sourceInstanceId?: string;
809
- targetInstanceId?: string;
810
- targetProfile?: components["schemas"]["SandboxResourceProfile"];
811
- /** Format: date-time */
812
- createdAt?: string;
813
- createdBy?: string;
814
- /** Format: date-time */
815
- lastUpdated?: string;
816
- status?: components["schemas"]["SandboxCloneState"];
817
- elapsedTimeInSec?: number;
818
- progressPercentage?: number;
819
- /** @description The last known clone processing state before completion or failure */
820
- lastKnownState?: string;
821
- customCodeVersion?: string;
822
- storefrontCount?: number;
823
- /** Format: int64 */
824
- filesystemUsageSize?: number;
825
- /** Format: int64 */
826
- databaseTransferSize?: number;
827
- };
828
- SandboxCloneCreateModel: {
829
- /** @example zyom-002-017-180620251331 */
830
- cloneId?: string;
831
- };
832
- SandboxCloneProvisioningRequestModel: {
833
- targetProfile?: components["schemas"]["SandboxResourceProfile"];
834
- /**
835
- * @example [
836
- * "email1@example.com",
837
- * "email2@example.com"
838
- * ]
839
- */
840
- emails?: string[];
841
- /**
842
- * Format: int32
843
- * @description Number of hours for the sandbox clone lifetime. Valid values are: 0 or negative (infinite lifetime), or 24 hours and above. Values between 1 and 23 are not allowed. The TTL must also adhere to the maximum TTL configuration for the realm.
844
- * @default 24
845
- */
846
- ttl: number;
847
- };
848
- /** @enum {string} */
849
- SandboxCloneState: "PENDING" | "IN_PROGRESS" | "COMPLETED" | "FAILED";
850
- /** @description Shows all filesystem storages and how much space is left on them. */
851
- SandboxStorageModel: {
852
- [key: string]: components["schemas"]["StorageUsageModel"];
853
- };
854
- /** @description Represents a single filesystem storage unit with its available space. */
855
- StorageUsageModel: {
856
- /**
857
- * Format: int64
858
- * @description Total available space in MB.
859
- */
860
- spaceTotal?: number;
861
- /**
862
- * Format: int64
863
- * @description Used space in MB.
864
- */
865
- spaceUsed?: number;
866
- /**
867
- * Format: int32
868
- * @description Used space in percent, compared to total space.
869
- */
870
- percentageUsed?: number;
871
- };
872
- SandboxModel: {
873
- id?: string;
874
- realm?: string;
875
- emails?: string[];
876
- /** @description Flag indicating whether the sandbox is enabled for any operations. */
877
- enabled?: boolean;
878
- instance?: string;
879
- /**
880
- * SandboxModelVersions
881
- * @description Versions of the components that make up the sandbox.
882
- */
883
- versions?: {
884
- /** @description Version of the commerce application. */
885
- app?: string;
886
- /** @description Version of the web proxy. */
887
- web?: string;
888
- };
889
- /** @description Defaults to false. If set to true, the sandbox is covered by automatic start/stop actions, which can be set to a dedicated time via realm- configuration API. */
890
- autoScheduled?: boolean;
891
- /** @description Defaults to false. If set to true, analytics will be enabled in ODS. */
892
- analyticsEnabled?: boolean;
893
- resourceProfile?: components["schemas"]["SandboxResourceProfile"];
894
- state?: components["schemas"]["SandboxState"];
895
- /** Format: date-time */
896
- createdAt?: string;
897
- createdBy?: string;
898
- /**
899
- * Format: date-time
900
- * @description Time when the delete operation was created.
901
- */
902
- deletedAt?: string;
903
- /** @description User who requested the sandbox deletion. */
904
- deletedBy?: string;
905
- /** Format: date-time */
906
- eol?: string;
907
- tags?: string[];
908
- hostName?: string;
909
- /** @description Set of named links for accessing the sandbox. */
910
- links?: {
911
- /** @description Fully qualified URL of the sandbox Business Manager web app. */
912
- bm?: string;
913
- /** @description Fully qualified URL of OCAPI data API (excluding version selector). */
914
- ocapi?: string;
915
- /** @description Fully qualified WebDAV URL for accessing import and export files. */
916
- impex?: string;
917
- /** @description Fully qualified WebDAV URL for accessing code. */
918
- code?: string;
919
- /** @description Fully qualified WebDAV URL for accessing log files. */
920
- logs?: string;
921
- };
922
- startScheduler?: components["schemas"]["WeekdaySchedule"];
923
- stopScheduler?: components["schemas"]["WeekdaySchedule"];
924
- /** @description The realm-instance identifier of the source sandbox from which this sandbox was cloned. */
925
- clonedFrom?: string;
926
- /** @description The UUID of the source sandbox from which this sandbox was cloned. */
927
- sourceInstanceIdentifier?: string;
928
- /** @description Detailed clone information if this sandbox was created by cloning another sandbox. Only present when expand=clonedetails is requested and the sandbox is a clone. */
929
- cloneDetails?: components["schemas"]["SandboxCloneGetModel"];
930
- };
931
- GranularUsage: {
932
- /** @description start of the usage being returned */
933
- usageDate?: string;
934
- /**
935
- * Format: double
936
- * @description Credits consumed when sandboxes were up during the requested timeframe.
937
- * @example 3600.001
938
- */
939
- creditsUp?: number;
940
- /**
941
- * Format: double
942
- * @description Credits consumed when sandboxes were down during the requested timeframe.
943
- * @example 1440.001
944
- */
945
- creditsDown?: number;
946
- /**
947
- * Format: int64
948
- * @description Minutes sandboxes were up during the requested timeframe.
949
- * @example 360000
950
- */
951
- minutesUp?: number;
952
- /**
953
- * Format: int64
954
- * @description Minutes sandboxes were down during the requested timeframe.
955
- * @example 180000
956
- */
957
- minutesDown?: number;
958
- };
959
- SandboxInfo: {
960
- realm?: string;
961
- resourceProfile?: components["schemas"]["SandboxResourceProfile"];
962
- /** Format: date-time */
963
- createdAt?: string;
964
- /**
965
- * Format: date-time
966
- * @description Time when the delete operation was created.
967
- */
968
- deletedAt?: string;
969
- /** @description Name of the sandbox */
970
- name?: string;
971
- /** @description instanceId of the sandbox */
972
- instanceId?: string;
973
- minutesUpByProfile?: {
974
- profile?: components["schemas"]["SandboxResourceProfile"];
975
- /**
976
- * Format: int64
977
- * @description How many minutes sandboxes of this profile type were running during the report timeframe.
978
- */
979
- minutes?: number;
980
- }[];
981
- /**
982
- * Format: int64
983
- * @description Minutes sandbox in this realm was running during the requested timeframe (by default, the previous 30 days).
984
- * @example 360000
985
- */
986
- minutesUp?: number;
987
- /**
988
- * Format: int64
989
- * @description Minutes sandbox in this realm was not running during the requested timeframe (by default, the previous 30 days).
990
- * @example 180000
991
- */
992
- minutesDown?: number;
993
- /** @description Defaults to false. If set to true, the sandbox is covered by automatic start/stop actions, which can be set to a dedicated time via realm- configuration API.: */
994
- autoScheduled?: boolean;
995
- startScheduler?: components["schemas"]["WeekdaySchedule"];
996
- stopScheduler?: components["schemas"]["WeekdaySchedule"];
997
- /** @description Cluster where sandbox resides. */
998
- clusterName?: string;
999
- };
1000
- /** @enum {string} */
1001
- SandboxState: "new" | "creating" | "starting" | "started" | "stopping" | "stopped" | "deleting" | "deleted" | "resetting" | "failed" | "unknown" | "upgrading";
1002
- /**
1003
- * @description Determines the resource allocation for the sandbox, "medium" is the default. Be careful, more powerful profiles consume more credits.
1004
- * @enum {string}
1005
- */
1006
- SandboxResourceProfile: "medium" | "large" | "xlarge" | "xxlarge";
1007
- SandboxOperationRequestModel: {
1008
- /** @enum {string} */
1009
- operation: "start" | "stop" | "restart" | "reset";
1010
- };
1011
- SandboxAliasResponse: components["schemas"]["StatusResponse"] & {
1012
- data?: components["schemas"]["SandboxAliasModel"];
1013
- };
1014
- SandboxAliasListResponse: components["schemas"]["StatusResponse"] & {
1015
- data?: components["schemas"]["SandboxAliasModel"][];
1016
- };
1017
- SandboxAliasModel: {
1018
- /**
1019
- * Format: uuid
1020
- * @description The sandbox alias UUID.
1021
- */
1022
- readonly id?: string;
1023
- /**
1024
- * @description The alias name.
1025
- * @example www.example.com
1026
- */
1027
- name: string;
1028
- /**
1029
- * @description Define if it's a unique configuration
1030
- * @example false
1031
- */
1032
- unique?: boolean;
1033
- /**
1034
- * @description Request a valid certificate to be generated on the fly through Lets Encrypt. This action consumes certificate requests from the domain quota imposed by Let's Encrypt, please read the Alias documentation carefully.
1035
- * @example false
1036
- */
1037
- requestLetsEncryptCertificate?: boolean;
1038
- /**
1039
- * Format: uuid
1040
- * @description The UUID of the sandbox the sandbox alias is pointing to.
1041
- */
1042
- readonly sandboxId?: string;
1043
- /** @description The cookie required for each request to this alias. */
1044
- readonly cookie?: {
1045
- name: string;
1046
- value: string;
1047
- path?: string;
1048
- domain?: string;
1049
- };
1050
- /** @description The link that can be used to save the required cookie for this alias in the browser. */
1051
- readonly registration?: string;
1052
- /** @description The verification code to be added as TXT record in the DNS */
1053
- readonly domainVerificationRecord?: string;
1054
- /**
1055
- * @description The status of the alias creation process
1056
- * @enum {string}
1057
- */
1058
- readonly status?: "pending" | "verified";
1059
- };
1060
- SandboxOperationResponse: components["schemas"]["StatusResponse"] & {
1061
- data?: components["schemas"]["SandboxOperationModel"];
1062
- };
1063
- SandboxOperationListResponse: components["schemas"]["PagedResponse"] & {
1064
- data?: components["schemas"]["SandboxOperationModel"][];
1065
- };
1066
- SandboxSettingsResponse: components["schemas"]["StatusResponse"] & {
1067
- data?: components["schemas"]["SandboxSettings"];
1068
- };
1069
- SandboxStorageResponse: components["schemas"]["StatusResponse"] & {
1070
- data?: components["schemas"]["SandboxStorageModel"];
1071
- };
1072
- SandboxUsageResponse: components["schemas"]["StatusResponse"] & {
1073
- data?: components["schemas"]["SandboxUsageModel"];
1074
- };
1075
- SandboxUsageModel: {
1076
- id: string;
1077
- /**
1078
- * Format: int64
1079
- * @description Total number of seconds during which the sandbox ran.
1080
- */
1081
- sandboxSeconds?: number;
1082
- minutesUpByProfile?: {
1083
- profile?: components["schemas"]["SandboxResourceProfile"];
1084
- /**
1085
- * Format: int64
1086
- * @description How many minutes sandboxes of this profile type were running during the report timeframe.
1087
- */
1088
- minutes?: number;
1089
- }[];
1090
- /**
1091
- * Format: int64
1092
- * @description Sum of minutes sandboxes in this realm were running during the requested timeframe (by default, the previous 30 days).
1093
- * @example 360000
1094
- */
1095
- minutesUp?: number;
1096
- /**
1097
- * Format: int64
1098
- * @description Sum of minutes sandboxes in this realm were not running during the requested timeframe (by default, the previous 30 days).
1099
- * @example 180000
1100
- */
1101
- minutesDown?: number;
1102
- granularUsage?: components["schemas"]["GranularUsage"][];
1103
- /** @description List of blocks, which describe the separate uptimes of a sandbox */
1104
- history?: {
1105
- /**
1106
- * Format: date-time
1107
- * @description Time the sandbox was started.
1108
- */
1109
- from: string;
1110
- /**
1111
- * Format: date-time
1112
- * @description Time the sandbox was stopped. If the sandbox is still running, this value will not exist for the last block.
1113
- */
1114
- to?: string;
1115
- /**
1116
- * Format: int64
1117
- * @description Number of seconds that the sandbox was running for this block.
1118
- */
1119
- sandboxSeconds?: number;
1120
- resourceProfile?: components["schemas"]["SandboxResourceProfile"];
1121
- /** @description This property is set to true if the block exceeds the given timeframe and was therefore trimmed. */
1122
- exceedsTimeframe?: boolean;
1123
- /** @description Cluster where sandbox resides. */
1124
- clusterName?: string;
1125
- }[];
1126
- };
1127
- SandboxOperationModel: {
1128
- id: string;
1129
- /** @enum {string} */
1130
- operation: "start" | "stop" | "restart" | "reset" | "create" | "delete" | "upgrade";
1131
- /** Format: date-time */
1132
- createdAt?: string;
1133
- operationBy?: string;
1134
- /** @enum {string} */
1135
- operationState: "pending" | "running" | "finished";
1136
- sandboxState?: components["schemas"]["SandboxState"];
1137
- /**
1138
- * @description Indicates whether the operation finished successfully ('Success') or not ('Failure').
1139
- * @enum {string}
1140
- */
1141
- status?: "success" | "failure";
1142
- };
1143
- /**
1144
- * @example {
1145
- * "realm": "<your realm id>",
1146
- * "emails": [
1147
- * "email1@example.com",
1148
- * "email2@example.com"
1149
- * ],
1150
- * "ttl": 24,
1151
- * "autoScheduled": false,
1152
- * "tags": [
1153
- * "<your-custom-tag>"
1154
- * ],
1155
- * "analyticsEnabled": false,
1156
- * "startScheduler": {
1157
- * "weekdays": [
1158
- * "MONDAY",
1159
- * "TUESDAY",
1160
- * "WEDNESDAY",
1161
- * "THURSDAY",
1162
- * "FRIDAY"
1163
- * ],
1164
- * "time": "08:00:00+03:00"
1165
- * },
1166
- * "stopScheduler": {
1167
- * "weekdays": [
1168
- * "MONDAY",
1169
- * "TUESDAY",
1170
- * "WEDNESDAY",
1171
- * "THURSDAY",
1172
- * "FRIDAY"
1173
- * ],
1174
- * "time": "19:00:00Z"
1175
- * },
1176
- * "resourceProfile": "medium",
1177
- * "settings": {
1178
- * "ocapi": [
1179
- * {
1180
- * "client_id": "<your client id>",
1181
- * "resources": [
1182
- * {
1183
- * "resource_id": "/**",
1184
- * "methods": [
1185
- * "get",
1186
- * "post",
1187
- * "put",
1188
- * "patch",
1189
- * "delete"
1190
- * ],
1191
- * "read_attributes": "(**)",
1192
- * "write_attributes": ""
1193
- * }
1194
- * ]
1195
- * }
1196
- * ],
1197
- * "webdav": [
1198
- * {
1199
- * "client_id": "<your client id>",
1200
- * "permissions": [
1201
- * {
1202
- * "path": "/cartridges",
1203
- * "operations": [
1204
- * "read_write"
1205
- * ]
1206
- * },
1207
- * {
1208
- * "path": "/impex",
1209
- * "operations": [
1210
- * "read_write"
1211
- * ]
1212
- * }
1213
- * ]
1214
- * }
1215
- * ]
1216
- * }
1217
- * }
1218
- */
1219
- SandboxProvisioningRequestModel: {
1220
- realm: string;
1221
- emails?: string[];
1222
- /**
1223
- * Format: int32
1224
- * @description Number of hours the sandbox will live (must adhere to the maximum TTL quotas). If set to 0 or less, the sandbox will have an infinite lifetime.
1225
- */
1226
- ttl?: number;
1227
- /** @description Defaults to false. If set to true, the sandbox is covered by automatic start/stop actions, which can be set to a dedicated time via realm- configuration API. */
1228
- autoScheduled?: boolean;
1229
- /**
1230
- * @description Defaults to false. If set to true, analytics will be enabled in ODS.
1231
- * @default false
1232
- */
1233
- analyticsEnabled: boolean;
1234
- tags?: string[];
1235
- startScheduler?: unknown;
1236
- stopScheduler?: unknown;
1237
- resourceProfile?: components["schemas"]["SandboxResourceProfile"];
1238
- settings?: components["schemas"]["SandboxSettings"];
1239
- };
1240
- /**
1241
- * @example {
1242
- * "emails": [
1243
- * "email1@example.com",
1244
- * "email2@example.com"
1245
- * ],
1246
- * "ttl": null,
1247
- * "autoScheduled": false,
1248
- * "resourceProfile": "desiredProfile",
1249
- * "tags": [
1250
- * "<your-custom-tag>"
1251
- * ],
1252
- * "startScheduler": {
1253
- * "weekdays": [
1254
- * "MONDAY",
1255
- * "TUESDAY",
1256
- * "WEDNESDAY",
1257
- * "THURSDAY",
1258
- * "FRIDAY"
1259
- * ],
1260
- * "time": "08:00:00+03:00"
1261
- * },
1262
- * "stopScheduler": {
1263
- * "weekdays": [
1264
- * "MONDAY",
1265
- * "TUESDAY",
1266
- * "WEDNESDAY",
1267
- * "THURSDAY",
1268
- * "FRIDAY"
1269
- * ],
1270
- * "time": "19:00:00Z"
1271
- * }
1272
- * }
1273
- */
1274
- SandboxUpdateRequestModel: {
1275
- emails?: string[];
1276
- /**
1277
- * Format: int32
1278
- * @description Number of hours added to the sandbox lifetime (must, together with previous extensions, adhere to the maximum TTL configuration). If set to 0 or less, the sandbox will have an infinite lifetime.
1279
- */
1280
- ttl?: number;
1281
- resourceProfile?: components["schemas"]["SandboxResourceProfile"];
1282
- /** @description If set to true, this sandbox will be captured by automated start-/stop -management. */
1283
- autoScheduled?: boolean;
1284
- tags?: string[];
1285
- startScheduler?: unknown;
1286
- stopScheduler?: unknown;
1287
- };
1288
- /** @description Map of additional settings evaluated when the sandbox is provisioned and initialized. */
1289
- SandboxSettings: {
1290
- ocapi?: components["schemas"]["OcapiSettings"];
1291
- webdav?: components["schemas"]["WebDavSettings"];
1292
- };
1293
- /** @description Use this document to configure Open Commerce API permissions for multiple client applications in the context of a single site. */
1294
- OcapiSettings: {
1295
- /**
1296
- * Format: uuid
1297
- * @description Client application ID.
1298
- */
1299
- client_id: string;
1300
- /** @description Array of resource-specific permission documents. */
1301
- resources?: {
1302
- /** @description Open Commerce API HTTP method filter. For example, the filter ["get","patch"] allows access to the GET and PATCH methods for the specified resource path. You can specify methods that are supported for a resource. You can list all available resources and methods for the Shop API, version 18.1, with the following meta data call: http://{your-domain}/dw/meta/rest/shop/v18_1?client_id={your-client-id} */
1303
- methods: ("get" | "delete" | "patch" | "post" | "put")[];
1304
- /** @description String that controls which properties are included in the response document. The configuration value must be specified using property selection syntax. */
1305
- read_attributes?: string;
1306
- /** @description String that controls which properties can be included in the request document. The configuration value must be specified using property selection syntax. */
1307
- write_attributes?: string;
1308
- /** @description OCAPI resource identifier. For example: /products/*\/images or /products/specific_id/images. This property supports Ant path style to describe resource IDs. You can specify wildcards or specific product IDs; you can also specify the pattern /products/** to access to all available sub-resources. You can list all resource identifiers for the Shop API, version 18.1, with the following meta data call: http://{your-domain}/dw/meta/rest/shop/v18_1?client_id={your-client-id} */
1309
- resource_id: string;
1310
- /** @description Version range documents granting permissions only to a subset of OCAPI versions. */
1311
- version_range?: {
1312
- /** @description From version (for example, 18.1). If you don't specify the from version, all versions including the oldest are accessible. */
1313
- from?: string;
1314
- /** @description Until version (for example, 18.1). The until version is exclusive, which means that it is not part of the range. If you don't specify the until version, all versions including the most recent one are accessible. */
1315
- until?: string;
1316
- }[];
1317
- }[];
1318
- }[];
1319
- /** @description WebDAV settings contain WebDAV client permissions for multiple client applications in the context of your organization. WebDAV client permissions enable you to configure which API clients can access your WebDAV files. These permissions also give you fine-grained control over which directories each client can access. */
1320
- WebDavSettings: {
1321
- /**
1322
- * Format: uuid
1323
- * @description Client ID indicating the API client for which the permissions are configured.
1324
- */
1325
- client_id: string;
1326
- /** @description Array of directory-based permissions documents. Multiple permissions paths cannot intersect each other; for example, the following two paths intersect and are therefore invalid: /impex/src and /impex/src/foo. */
1327
- permissions: {
1328
- /** @description Directory for which the WebDAV permission is granted, including all subdirectories. File-specific permissions are not permitted. */
1329
- path: string;
1330
- /** @description Array of operations granted on this directory. Possible values are read and read_write. */
1331
- operations: ("read" | "read_write")[];
1332
- }[];
1333
- }[];
1334
- ApiVersionResponse: components["schemas"]["StatusResponse"] & {
1335
- data?: components["schemas"]["ApiVersion"];
1336
- };
1337
- ApiVersion: {
1338
- /** @enum {string} */
1339
- version?: "v1";
1340
- git?: {
1341
- commit?: string;
1342
- /** Format: date-time */
1343
- time?: string;
1344
- };
1345
- build?: {
1346
- version?: string;
1347
- /** Format: date-time */
1348
- time?: string;
1349
- };
1350
- };
1351
- UserInfoResponse: components["schemas"]["StatusResponse"] & {
1352
- data?: components["schemas"]["UserInfoSpec"];
1353
- };
1354
- UserInfoSpec: {
1355
- user?: {
1356
- /** @description User's unique ID on Account Manager. */
1357
- id?: string;
1358
- /** @description User's email address. */
1359
- email?: string;
1360
- /** @description User's human-readable, full name. */
1361
- name?: string;
1362
- };
1363
- client?: {
1364
- /** @description OAuth client ID used to retrieve the access token. */
1365
- id?: string;
1366
- };
1367
- /** @description User's roles as returned by Account Manager. */
1368
- roles?: string[];
1369
- /** @description Realms that the user is allowed to access. All sandboxes within these realms are accessible. */
1370
- realms?: string[];
1371
- /** @description Sandboxes that the user is allowed to access. */
1372
- sandboxes?: string[];
1373
- };
1374
- SystemInfoResponse: components["schemas"]["StatusResponse"] & {
1375
- data?: components["schemas"]["SystemInfoSpec"];
1376
- };
1377
- SystemInfoSpec: {
1378
- /** @description The region, the system is deployed on. */
1379
- region?: string;
1380
- /** @description Public IP addresses of internal services like API server */
1381
- systemIps?: string[];
1382
- /** @description Public IP addresses of all sandboxes */
1383
- sandboxIps?: string[];
1384
- /** @description IP addresses for incoming traffic. */
1385
- inboundIps?: string[];
1386
- /** @description IP addresses for outgoing traffic. */
1387
- outboundIps?: string[];
1388
- };
1389
- ErrorResponse: components["schemas"]["StatusResponse"] & {
1390
- error?: components["schemas"]["ErrorModel"];
1391
- };
1392
- ErrorModel: {
1393
- /**
1394
- * @description String with value 'Success' or 'Failure' to indicate request outcome.
1395
- * @enum {string}
1396
- */
1397
- status: "Success" | "Failure";
1398
- /** @description Human-readable description of the error. */
1399
- message?: string;
1400
- /** @description Machine-readable, one-word, CamelCase description of why the operation failed. If this value is empty, there is no information available. The reason clarifies an HTTP status code but does not override it. */
1401
- reason?: string;
1402
- /** @description Extended data associated with the reason. Each reason can define its own extended details. This field is optional, and the data returned is not guaranteed to conform to any schema except that defined by the reason type. */
1403
- details?: {
1404
- [key: string]: string;
1405
- };
1406
- };
1407
- };
1408
- responses: never;
1409
- parameters: {
1410
- /** @description The four-letter ID of the realm. */
1411
- realmParam: string;
1412
- /** @description The sandbox UUID. */
1413
- sandboxIdParam: string;
1414
- /** @description The sandbox alias UUID. */
1415
- sandboxAliasIdParam: string;
1416
- /** @description The sandbox clone unique ID. A unique identifier of the sandbox in the format: realm-instance-clone-timestamp (e.g., aaaa-002-1642780893121), where: realm is 4 lowercase letters, instance is 3-digit number, timestamp is in ddMMyyyyHHmm format (13 digits). */
1417
- sandboxCloneIdParam: string;
1418
- /** @description The operation UUID. */
1419
- operationIdParam: string;
1420
- /** @description The page to access in a paged response. Page numbers start with '0', which is the default value. */
1421
- pageParam: number;
1422
- /** @description Count of elements on a page. The default value is '20'. */
1423
- perPageParam: number;
1424
- /** @description Earliest date for which data is in the response. Thirty days in the past by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
1425
- fromParam: string;
1426
- /** @description Latest date for which data is included in the response. Today's date by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
1427
- toParam: string;
1428
- /** @description Order of the list. Default value is ''asc''. */
1429
- sortOrderParam: "asc" | "desc";
1430
- /** @description Field by which to order the list. By default, the list is not ordered. */
1431
- sortByOperationParam: "created" | "operation_state" | "status" | "operation";
1432
- /** @description State of operations included in the response. By default, all operations are included. */
1433
- operationStateParam: "pending" | "running" | "finished";
1434
- /** @description Status of operations included in the response. By default, all operations are included. */
1435
- operationStatusParam: "success" | "failure";
1436
- /** @description Type of operations included in the response. By default, all operations are included. */
1437
- operationTypeParam: "start" | "stop" | "restart" | "reset" | "create" | "delete" | "upgrade";
1438
- /** @description Field to check whether detailed report is to be retrieved, by default detailed report will not be pulled */
1439
- detailedReportParam: false | true;
1440
- /** @description Granularity of usage to be included in the response. By default, granular usage is not returned. */
1441
- granularityParam: "daily" | "weekly" | "monthly";
1442
- };
1443
- requestBodies: never;
1444
- headers: never;
1445
- pathItems: never;
1446
- }
1447
- export type $defs = Record<string, never>;
1448
- export interface operations {
1449
- getApiInfo: {
1450
- parameters: {
1451
- query?: never;
1452
- header?: never;
1453
- path?: never;
1454
- cookie?: never;
1455
- };
1456
- requestBody?: never;
1457
- responses: {
1458
- /** @description API version information. */
1459
- 200: {
1460
- headers: {
1461
- [name: string]: unknown;
1462
- };
1463
- content: {
1464
- "application/json": components["schemas"]["ApiVersionResponse"];
1465
- };
1466
- };
1467
- };
1468
- };
1469
- getUserInfo: {
1470
- parameters: {
1471
- query?: never;
1472
- header?: never;
1473
- path?: never;
1474
- cookie?: never;
1475
- };
1476
- requestBody?: never;
1477
- responses: {
1478
- /** @description Metadata about the authenticated API user. */
1479
- 200: {
1480
- headers: {
1481
- [name: string]: unknown;
1482
- };
1483
- content: {
1484
- "application/json": components["schemas"]["UserInfoResponse"];
1485
- };
1486
- };
1487
- };
1488
- };
1489
- getSystemInfo: {
1490
- parameters: {
1491
- query?: never;
1492
- header?: never;
1493
- path?: never;
1494
- cookie?: never;
1495
- };
1496
- requestBody?: never;
1497
- responses: {
1498
- /** @description Metadata about the system */
1499
- 200: {
1500
- headers: {
1501
- [name: string]: unknown;
1502
- };
1503
- content: {
1504
- "application/json": components["schemas"]["SystemInfoResponse"];
1505
- };
1506
- };
1507
- };
1508
- };
1509
- getRealmSystemInfo: {
1510
- parameters: {
1511
- query?: never;
1512
- header?: never;
1513
- path: {
1514
- /** @description The four-letter ID of the realm. */
1515
- realm: components["parameters"]["realmParam"];
1516
- };
1517
- cookie?: never;
1518
- };
1519
- requestBody?: never;
1520
- responses: {
1521
- /** @description Metadata about the system */
1522
- 200: {
1523
- headers: {
1524
- [name: string]: unknown;
1525
- };
1526
- content: {
1527
- "application/json": components["schemas"]["SystemInfoResponse"];
1528
- };
1529
- };
1530
- };
1531
- };
1532
- getRealm: {
1533
- parameters: {
1534
- query?: {
1535
- /** @description Additional information, which should be shown in the realm query. Available options are: [configuration,usage, accountdetails]. */
1536
- expand?: ("configuration" | "usage" | "accountdetails")[];
1537
- };
1538
- header?: never;
1539
- path: {
1540
- /** @description The four-letter ID of the realm. */
1541
- realm: components["parameters"]["realmParam"];
1542
- };
1543
- cookie?: never;
1544
- };
1545
- requestBody?: never;
1546
- responses: {
1547
- /** @description Realm metadata. */
1548
- 200: {
1549
- headers: {
1550
- [name: string]: unknown;
1551
- };
1552
- content: {
1553
- "application/json": components["schemas"]["RealmResponse"];
1554
- };
1555
- };
1556
- /** @description The ID is not a valid realm ID. */
1557
- 400: {
1558
- headers: {
1559
- [name: string]: unknown;
1560
- };
1561
- content: {
1562
- "application/json": components["schemas"]["ErrorResponse"];
1563
- };
1564
- };
1565
- /** @description The user isn't authenticated. */
1566
- 401: {
1567
- headers: {
1568
- [name: string]: unknown;
1569
- };
1570
- content: {
1571
- "application/json": components["schemas"]["ErrorResponse"];
1572
- };
1573
- };
1574
- /** @description The user doesn't have access to the realm. */
1575
- 403: {
1576
- headers: {
1577
- [name: string]: unknown;
1578
- };
1579
- content: {
1580
- "application/json": components["schemas"]["ErrorResponse"];
1581
- };
1582
- };
1583
- /** @description There isn't any realm with that ID. */
1584
- 404: {
1585
- headers: {
1586
- [name: string]: unknown;
1587
- };
1588
- content: {
1589
- "application/json": components["schemas"]["ErrorResponse"];
1590
- };
1591
- };
1592
- };
1593
- };
1594
- getRealmConfiguration: {
1595
- parameters: {
1596
- query?: never;
1597
- header?: never;
1598
- path: {
1599
- /** @description The four-letter ID of the realm. */
1600
- realm: components["parameters"]["realmParam"];
1601
- };
1602
- cookie?: never;
1603
- };
1604
- requestBody?: never;
1605
- responses: {
1606
- /** @description Current configuration values of the realm. */
1607
- 200: {
1608
- headers: {
1609
- [name: string]: unknown;
1610
- };
1611
- content: {
1612
- "application/json": components["schemas"]["RealmConfigurationResponse"];
1613
- };
1614
- };
1615
- /** @description The ID isn't valid or the configuration isn't valid. */
1616
- 400: {
1617
- headers: {
1618
- [name: string]: unknown;
1619
- };
1620
- content: {
1621
- "application/json": components["schemas"]["ErrorResponse"];
1622
- };
1623
- };
1624
- /** @description The user doesn't have access to that realm. */
1625
- 403: {
1626
- headers: {
1627
- [name: string]: unknown;
1628
- };
1629
- content: {
1630
- "application/json": components["schemas"]["ErrorResponse"];
1631
- };
1632
- };
1633
- /** @description There isn't any realm with that ID. */
1634
- 404: {
1635
- headers: {
1636
- [name: string]: unknown;
1637
- };
1638
- content: {
1639
- "application/json": components["schemas"]["ErrorResponse"];
1640
- };
1641
- };
1642
- };
1643
- };
1644
- patchRealmConfiguration: {
1645
- parameters: {
1646
- query?: never;
1647
- header?: never;
1648
- path: {
1649
- /** @description The four-letter ID of the realm. */
1650
- realm: components["parameters"]["realmParam"];
1651
- };
1652
- cookie?: never;
1653
- };
1654
- /** @description Realm values to update. */
1655
- requestBody: {
1656
- content: {
1657
- "application/json": components["schemas"]["RealmConfigurationUpdateRequestModel"];
1658
- };
1659
- };
1660
- responses: {
1661
- /** @description Updated realm configuration data. */
1662
- 200: {
1663
- headers: {
1664
- [name: string]: unknown;
1665
- };
1666
- content: {
1667
- "application/json": components["schemas"]["RealmConfigurationResponse"];
1668
- };
1669
- };
1670
- /** @description The ID isn't a valid realm ID. */
1671
- 400: {
1672
- headers: {
1673
- [name: string]: unknown;
1674
- };
1675
- content: {
1676
- "application/json": components["schemas"]["ErrorResponse"];
1677
- };
1678
- };
1679
- /** @description The user isn't authenticated. */
1680
- 401: {
1681
- headers: {
1682
- [name: string]: unknown;
1683
- };
1684
- content: {
1685
- "application/json": components["schemas"]["ErrorResponse"];
1686
- };
1687
- };
1688
- /** @description The user doesn't have access to that realm. */
1689
- 403: {
1690
- headers: {
1691
- [name: string]: unknown;
1692
- };
1693
- content: {
1694
- "application/json": components["schemas"]["ErrorResponse"];
1695
- };
1696
- };
1697
- /** @description There isn't any realm with that ID. */
1698
- 404: {
1699
- headers: {
1700
- [name: string]: unknown;
1701
- };
1702
- content: {
1703
- "application/json": components["schemas"]["ErrorResponse"];
1704
- };
1705
- };
1706
- };
1707
- };
1708
- getRealmUsage: {
1709
- parameters: {
1710
- query?: {
1711
- /** @description Earliest date for which data is in the response. Thirty days in the past by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
1712
- from?: components["parameters"]["fromParam"];
1713
- /** @description Latest date for which data is included in the response. Today's date by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
1714
- to?: components["parameters"]["toParam"];
1715
- /** @description Field to check whether detailed report is to be retrieved, by default detailed report will not be pulled */
1716
- detailedReport?: components["parameters"]["detailedReportParam"];
1717
- /** @description Granularity of usage to be included in the response. By default, granular usage is not returned. */
1718
- granularity?: components["parameters"]["granularityParam"];
1719
- };
1720
- header?: never;
1721
- path: {
1722
- /** @description The four-letter ID of the realm. */
1723
- realm: components["parameters"]["realmParam"];
1724
- };
1725
- cookie?: never;
1726
- };
1727
- requestBody?: never;
1728
- responses: {
1729
- /** @description Realm's usage information. */
1730
- 200: {
1731
- headers: {
1732
- [name: string]: unknown;
1733
- };
1734
- content: {
1735
- "application/json": components["schemas"]["RealmUsageResponse"];
1736
- "text/csv": components["schemas"]["RealmUsageResponse"];
1737
- };
1738
- };
1739
- /** @description The ID isn't valid. */
1740
- 400: {
1741
- headers: {
1742
- [name: string]: unknown;
1743
- };
1744
- content: {
1745
- "application/json": components["schemas"]["ErrorResponse"];
1746
- "text/csv": components["schemas"]["ErrorResponse"];
1747
- };
1748
- };
1749
- /** @description The user doesn't have access to the realm. */
1750
- 403: {
1751
- headers: {
1752
- [name: string]: unknown;
1753
- };
1754
- content: {
1755
- "application/json": components["schemas"]["ErrorResponse"];
1756
- "text/csv": components["schemas"]["ErrorResponse"];
1757
- };
1758
- };
1759
- /** @description There isn't any realm with that ID. */
1760
- 404: {
1761
- headers: {
1762
- [name: string]: unknown;
1763
- };
1764
- content: {
1765
- "application/json": components["schemas"]["ErrorResponse"];
1766
- "text/csv": components["schemas"]["ErrorResponse"];
1767
- };
1768
- };
1769
- };
1770
- };
1771
- searchRealmUsage: {
1772
- parameters: {
1773
- query?: never;
1774
- header?: never;
1775
- path?: never;
1776
- cookie?: never;
1777
- };
1778
- /** @description Return information for given all realm's usage */
1779
- requestBody: {
1780
- content: {
1781
- "application/json": components["schemas"]["MultiRealmUsageRequest"];
1782
- };
1783
- };
1784
- responses: {
1785
- /** @description Aggregates all realm usage data. */
1786
- 200: {
1787
- headers: {
1788
- [name: string]: unknown;
1789
- };
1790
- content: {
1791
- "application/json": components["schemas"]["MultiRealmUsageResponse"];
1792
- "text/csv": components["schemas"]["MultiRealmUsageResponse"];
1793
- };
1794
- };
1795
- /** @description The ID isn't a valid realm ID. */
1796
- 400: {
1797
- headers: {
1798
- [name: string]: unknown;
1799
- };
1800
- content: {
1801
- "application/json": components["schemas"]["ErrorResponse"];
1802
- "text/csv": components["schemas"]["ErrorResponse"];
1803
- };
1804
- };
1805
- /** @description The user isn't authenticated. */
1806
- 401: {
1807
- headers: {
1808
- [name: string]: unknown;
1809
- };
1810
- content: {
1811
- "application/json": components["schemas"]["ErrorResponse"];
1812
- "text/csv": components["schemas"]["ErrorResponse"];
1813
- };
1814
- };
1815
- /** @description The user doesn't have access to that realm. */
1816
- 403: {
1817
- headers: {
1818
- [name: string]: unknown;
1819
- };
1820
- content: {
1821
- "application/json": components["schemas"]["ErrorResponse"];
1822
- "text/csv": components["schemas"]["ErrorResponse"];
1823
- };
1824
- };
1825
- /** @description There isn't any realm with that ID. */
1826
- 404: {
1827
- headers: {
1828
- [name: string]: unknown;
1829
- };
1830
- content: {
1831
- "application/json": components["schemas"]["ErrorResponse"];
1832
- "text/csv": components["schemas"]["ErrorResponse"];
1833
- };
1834
- };
1835
- };
1836
- };
1837
- getSandboxes: {
1838
- parameters: {
1839
- query?: {
1840
- /** @description If set, return deleted sandboxes. */
1841
- include_deleted?: boolean;
1842
- /** @description If passed in supported format, returns sandboxes that matches the query. Supported format: realm=zzzz&state=active&resourceProfile=medium&createdBy=user1&tags=[tag1,tag2,tag3]. */
1843
- filter_params?: string;
1844
- };
1845
- header?: never;
1846
- path?: never;
1847
- cookie?: never;
1848
- };
1849
- requestBody?: never;
1850
- responses: {
1851
- /** @description List of sandboxes. */
1852
- 200: {
1853
- headers: {
1854
- [name: string]: unknown;
1855
- };
1856
- content: {
1857
- "application/json": components["schemas"]["SandboxListResponse"];
1858
- };
1859
- };
1860
- /** @description The request parameters are invalid (bad request). */
1861
- 400: {
1862
- headers: {
1863
- [name: string]: unknown;
1864
- };
1865
- content: {
1866
- "application/json": components["schemas"]["ErrorResponse"];
1867
- };
1868
- };
1869
- /** @description The user doesn't have access to that realm. */
1870
- 403: {
1871
- headers: {
1872
- [name: string]: unknown;
1873
- };
1874
- content: {
1875
- "application/json": components["schemas"]["ErrorResponse"];
1876
- };
1877
- };
1878
- /** @description There isn't any realm with that ID. */
1879
- 404: {
1880
- headers: {
1881
- [name: string]: unknown;
1882
- };
1883
- content: {
1884
- "application/json": components["schemas"]["ErrorResponse"];
1885
- };
1886
- };
1887
- };
1888
- };
1889
- createSandbox: {
1890
- parameters: {
1891
- query?: never;
1892
- header?: never;
1893
- path?: never;
1894
- cookie?: never;
1895
- };
1896
- /** @description Metadata about the new sandbox. */
1897
- requestBody: {
1898
- content: {
1899
- "application/json": components["schemas"]["SandboxProvisioningRequestModel"];
1900
- };
1901
- };
1902
- responses: {
1903
- /** @description The sandbox creation has started. */
1904
- 201: {
1905
- headers: {
1906
- /** @description URI of the created sandbox. */
1907
- Location?: string;
1908
- [name: string]: unknown;
1909
- };
1910
- content: {
1911
- "application/json": components["schemas"]["SandboxResponse"];
1912
- };
1913
- };
1914
- /** @description The request parameters are invalid (bad request). */
1915
- 400: {
1916
- headers: {
1917
- [name: string]: unknown;
1918
- };
1919
- content: {
1920
- "application/json": components["schemas"]["ErrorResponse"];
1921
- };
1922
- };
1923
- /** @description The user doesn't have access to the realm. */
1924
- 403: {
1925
- headers: {
1926
- [name: string]: unknown;
1927
- };
1928
- content: {
1929
- "application/json": components["schemas"]["ErrorResponse"];
1930
- };
1931
- };
1932
- /** @description There isn't any realm with that ID. */
1933
- 404: {
1934
- headers: {
1935
- [name: string]: unknown;
1936
- };
1937
- content: {
1938
- "application/json": components["schemas"]["ErrorResponse"];
1939
- };
1940
- };
1941
- /** @description There were server errors initiating the sandbox deployment. */
1942
- 500: {
1943
- headers: {
1944
- [name: string]: unknown;
1945
- };
1946
- content: {
1947
- "application/json": components["schemas"]["ErrorResponse"];
1948
- };
1949
- };
1950
- };
1951
- };
1952
- getSandbox: {
1953
- parameters: {
1954
- query?: {
1955
- /** @description Additional information to include in the sandbox query. Available options: clonedetails */
1956
- expand?: "clonedetails"[];
1957
- };
1958
- header?: never;
1959
- path: {
1960
- /** @description The sandbox UUID. */
1961
- sandboxId: components["parameters"]["sandboxIdParam"];
1962
- };
1963
- cookie?: never;
1964
- };
1965
- requestBody?: never;
1966
- responses: {
1967
- /** @description Details on the sandbox (including its state). */
1968
- 200: {
1969
- headers: {
1970
- [name: string]: unknown;
1971
- };
1972
- content: {
1973
- "application/json": components["schemas"]["SandboxResponse"];
1974
- };
1975
- };
1976
- /** @description The request parameters are invalid (bad request). */
1977
- 400: {
1978
- headers: {
1979
- [name: string]: unknown;
1980
- };
1981
- content: {
1982
- "application/json": components["schemas"]["ErrorResponse"];
1983
- };
1984
- };
1985
- /** @description The user doesn't have access to the requested realm. */
1986
- 403: {
1987
- headers: {
1988
- [name: string]: unknown;
1989
- };
1990
- content: {
1991
- "application/json": components["schemas"]["ErrorResponse"];
1992
- };
1993
- };
1994
- /** @description There isn't any realm with that ID. */
1995
- 404: {
1996
- headers: {
1997
- [name: string]: unknown;
1998
- };
1999
- content: {
2000
- "application/json": components["schemas"]["ErrorResponse"];
2001
- };
2002
- };
2003
- };
2004
- };
2005
- deleteSandbox: {
2006
- parameters: {
2007
- query?: never;
2008
- header?: never;
2009
- path: {
2010
- /** @description The sandbox UUID. */
2011
- sandboxId: components["parameters"]["sandboxIdParam"];
2012
- };
2013
- cookie?: never;
2014
- };
2015
- requestBody?: never;
2016
- responses: {
2017
- /** @description The request for deleting the sandbox has been accepted by the API server. This doesn't mean that the sandbox has already been deleted, since the actual deletion process does not necessarily start immediately and might take a while. You can track the deletion process using sandbox GET requests. */
2018
- 202: {
2019
- headers: {
2020
- [name: string]: unknown;
2021
- };
2022
- content: {
2023
- "application/json": components["schemas"]["StatusResponse"];
2024
- };
2025
- };
2026
- /** @description The request parameters are invalid (bad request). */
2027
- 400: {
2028
- headers: {
2029
- [name: string]: unknown;
2030
- };
2031
- content: {
2032
- "application/json": components["schemas"]["ErrorResponse"];
2033
- };
2034
- };
2035
- /** @description The user doesn't have access to that realm. */
2036
- 403: {
2037
- headers: {
2038
- [name: string]: unknown;
2039
- };
2040
- content: {
2041
- "application/json": components["schemas"]["ErrorResponse"];
2042
- };
2043
- };
2044
- /** @description ID not found. */
2045
- 404: {
2046
- headers: {
2047
- [name: string]: unknown;
2048
- };
2049
- content: {
2050
- "application/json": components["schemas"]["ErrorResponse"];
2051
- };
2052
- };
2053
- };
2054
- };
2055
- patchSandbox: {
2056
- parameters: {
2057
- query?: never;
2058
- header?: never;
2059
- path: {
2060
- /** @description The sandbox UUID. */
2061
- sandboxId: components["parameters"]["sandboxIdParam"];
2062
- };
2063
- cookie?: never;
2064
- };
2065
- /** @description Sandbox values to update. */
2066
- requestBody: {
2067
- content: {
2068
- "application/json": components["schemas"]["SandboxUpdateRequestModel"];
2069
- };
2070
- };
2071
- responses: {
2072
- /** @description Updated details on the sandbox (including its state). */
2073
- 200: {
2074
- headers: {
2075
- [name: string]: unknown;
2076
- };
2077
- content: {
2078
- "application/json": components["schemas"]["SandboxResponse"];
2079
- };
2080
- };
2081
- /** @description The request parameters are invalid (bad request). */
2082
- 400: {
2083
- headers: {
2084
- [name: string]: unknown;
2085
- };
2086
- content: {
2087
- "application/json": components["schemas"]["ErrorResponse"];
2088
- };
2089
- };
2090
- /** @description The user doesn't have access to the realm. */
2091
- 403: {
2092
- headers: {
2093
- [name: string]: unknown;
2094
- };
2095
- content: {
2096
- "application/json": components["schemas"]["ErrorResponse"];
2097
- };
2098
- };
2099
- /** @description There isn't any sandbox with that ID. */
2100
- 404: {
2101
- headers: {
2102
- [name: string]: unknown;
2103
- };
2104
- content: {
2105
- "application/json": components["schemas"]["ErrorResponse"];
2106
- };
2107
- };
2108
- };
2109
- };
2110
- getAliases: {
2111
- parameters: {
2112
- query?: never;
2113
- header?: never;
2114
- path: {
2115
- /** @description The sandbox UUID. */
2116
- sandboxId: components["parameters"]["sandboxIdParam"];
2117
- };
2118
- cookie?: never;
2119
- };
2120
- requestBody?: never;
2121
- responses: {
2122
- /** @description List of Alias configurations. */
2123
- 200: {
2124
- headers: {
2125
- [name: string]: unknown;
2126
- };
2127
- content: {
2128
- "application/json": components["schemas"]["SandboxAliasListResponse"];
2129
- };
2130
- };
2131
- /** @description The user doesn't have access to the realm or sandbox. */
2132
- 403: {
2133
- headers: {
2134
- [name: string]: unknown;
2135
- };
2136
- content: {
2137
- "application/json": components["schemas"]["ErrorResponse"];
2138
- };
2139
- };
2140
- /** @description There isn't any sandbox with that ID. */
2141
- 404: {
2142
- headers: {
2143
- [name: string]: unknown;
2144
- };
2145
- content: {
2146
- "application/json": components["schemas"]["ErrorResponse"];
2147
- };
2148
- };
2149
- };
2150
- };
2151
- createAlias: {
2152
- parameters: {
2153
- query?: never;
2154
- header?: never;
2155
- path: {
2156
- /** @description The sandbox UUID. */
2157
- sandboxId: components["parameters"]["sandboxIdParam"];
2158
- };
2159
- cookie?: never;
2160
- };
2161
- /** @description The alias for the sandbox */
2162
- requestBody: {
2163
- content: {
2164
- "application/json": components["schemas"]["SandboxAliasModel"];
2165
- };
2166
- };
2167
- responses: {
2168
- /** @description The sandbox alias already exists. */
2169
- 200: {
2170
- headers: {
2171
- [name: string]: unknown;
2172
- };
2173
- content: {
2174
- "application/json": components["schemas"]["SandboxAliasResponse"];
2175
- };
2176
- };
2177
- /** @description The alias has been created. */
2178
- 201: {
2179
- headers: {
2180
- [name: string]: unknown;
2181
- };
2182
- content: {
2183
- "application/json": components["schemas"]["SandboxAliasResponse"];
2184
- };
2185
- };
2186
- /** @description The request parameters are invalid (bad request). */
2187
- 400: {
2188
- headers: {
2189
- [name: string]: unknown;
2190
- };
2191
- content: {
2192
- "application/json": components["schemas"]["ErrorResponse"];
2193
- };
2194
- };
2195
- /** @description The user doesn't have access to the sandbox. */
2196
- 403: {
2197
- headers: {
2198
- [name: string]: unknown;
2199
- };
2200
- content: {
2201
- "application/json": components["schemas"]["ErrorResponse"];
2202
- };
2203
- };
2204
- /** @description There isn't any sandbox with that ID. */
2205
- 404: {
2206
- headers: {
2207
- [name: string]: unknown;
2208
- };
2209
- content: {
2210
- "application/json": components["schemas"]["ErrorResponse"];
2211
- };
2212
- };
2213
- };
2214
- };
2215
- getAlias: {
2216
- parameters: {
2217
- query?: never;
2218
- header?: never;
2219
- path: {
2220
- /** @description The sandbox UUID. */
2221
- sandboxId: components["parameters"]["sandboxIdParam"];
2222
- /** @description The sandbox alias UUID. */
2223
- sandboxAliasId: components["parameters"]["sandboxAliasIdParam"];
2224
- };
2225
- cookie?: never;
2226
- };
2227
- requestBody?: never;
2228
- responses: {
2229
- /** @description The Alias configuration. */
2230
- 200: {
2231
- headers: {
2232
- [name: string]: unknown;
2233
- };
2234
- content: {
2235
- "application/json": components["schemas"]["SandboxAliasResponse"];
2236
- };
2237
- };
2238
- /** @description The user doesn't have access to the realm or sandbox. */
2239
- 403: {
2240
- headers: {
2241
- [name: string]: unknown;
2242
- };
2243
- content: {
2244
- "application/json": components["schemas"]["ErrorResponse"];
2245
- };
2246
- };
2247
- /** @description There isn't any sandbox or any alias with that ID. */
2248
- 404: {
2249
- headers: {
2250
- [name: string]: unknown;
2251
- };
2252
- content: {
2253
- "application/json": components["schemas"]["ErrorResponse"];
2254
- };
2255
- };
2256
- };
2257
- };
2258
- deleteAlias: {
2259
- parameters: {
2260
- query?: never;
2261
- header?: never;
2262
- path: {
2263
- /** @description The sandbox UUID. */
2264
- sandboxId: components["parameters"]["sandboxIdParam"];
2265
- /** @description The sandbox alias UUID. */
2266
- sandboxAliasId: components["parameters"]["sandboxAliasIdParam"];
2267
- };
2268
- cookie?: never;
2269
- };
2270
- requestBody?: never;
2271
- responses: {
2272
- /** @description Shows, that alias currently gets deleted. */
2273
- 202: {
2274
- headers: {
2275
- [name: string]: unknown;
2276
- };
2277
- content: {
2278
- "application/json": components["schemas"]["StatusResponse"];
2279
- };
2280
- };
2281
- /** @description The user doesn't have access to the realm or sandbox. */
2282
- 403: {
2283
- headers: {
2284
- [name: string]: unknown;
2285
- };
2286
- content: {
2287
- "application/json": components["schemas"]["ErrorResponse"];
2288
- };
2289
- };
2290
- /** @description There isn't any sandbox or any alias with that ID. */
2291
- 404: {
2292
- headers: {
2293
- [name: string]: unknown;
2294
- };
2295
- content: {
2296
- "application/json": components["schemas"]["ErrorResponse"];
2297
- };
2298
- };
2299
- };
2300
- };
2301
- getSandboxesClone: {
2302
- parameters: {
2303
- query?: {
2304
- /** @description Filter clones created on or after this date (ISO 8601 date format, e.g., 2024-01-01). When provided without toDate, toDate defaults to the current timestamp. */
2305
- fromDate?: string;
2306
- /** @description Filter clones created on or before this date (ISO 8601 date format, e.g., 2024-12-31). If omitted when fromDate is provided, defaults to current timestamp. Optional parameter. */
2307
- toDate?: string;
2308
- /** @description Filter clones by status (Pending, InProgress, Failed, or Completed). If not provided, returns all clones regardless of status. */
2309
- status?: "Pending" | "InProgress" | "Failed" | "Completed";
2310
- };
2311
- header?: never;
2312
- path: {
2313
- /** @description The sandbox UUID. */
2314
- sandboxId: components["parameters"]["sandboxIdParam"];
2315
- };
2316
- cookie?: never;
2317
- };
2318
- requestBody?: never;
2319
- responses: {
2320
- /** @description List of cloned sandboxes. */
2321
- 200: {
2322
- headers: {
2323
- [name: string]: unknown;
2324
- };
2325
- content: {
2326
- "application/json": components["schemas"]["SandboxCloneListResponse"];
2327
- };
2328
- };
2329
- /** @description The request parameters are invalid (bad request). */
2330
- 400: {
2331
- headers: {
2332
- [name: string]: unknown;
2333
- };
2334
- content: {
2335
- "application/json": components["schemas"]["ErrorResponse"];
2336
- };
2337
- };
2338
- /** @description The user doesn't have access to that realm. */
2339
- 403: {
2340
- headers: {
2341
- [name: string]: unknown;
2342
- };
2343
- content: {
2344
- "application/json": components["schemas"]["ErrorResponse"];
2345
- };
2346
- };
2347
- /** @description There isn't any sandbox with that ID. */
2348
- 404: {
2349
- headers: {
2350
- [name: string]: unknown;
2351
- };
2352
- content: {
2353
- "application/json": components["schemas"]["ErrorResponse"];
2354
- };
2355
- };
2356
- /** @description There were server errors during the request. */
2357
- 500: {
2358
- headers: {
2359
- [name: string]: unknown;
2360
- };
2361
- content: {
2362
- "application/json": components["schemas"]["ErrorResponse"];
2363
- };
2364
- };
2365
- };
2366
- };
2367
- createSandboxClone: {
2368
- parameters: {
2369
- query?: never;
2370
- header?: never;
2371
- path: {
2372
- /** @description The sandbox UUID. */
2373
- sandboxId: components["parameters"]["sandboxIdParam"];
2374
- };
2375
- cookie?: never;
2376
- };
2377
- /** @description Metadata about the new sandbox clone. */
2378
- requestBody: {
2379
- content: {
2380
- "application/json": components["schemas"]["SandboxCloneProvisioningRequestModel"];
2381
- };
2382
- };
2383
- responses: {
2384
- /** @description The sandbox clone creation has started. */
2385
- 201: {
2386
- headers: {
2387
- /** @description URI of the created sandbox clone. */
2388
- Location?: string;
2389
- [name: string]: unknown;
2390
- };
2391
- content: {
2392
- "application/json": components["schemas"]["SandboxCloneCreateResponse"];
2393
- };
2394
- };
2395
- /** @description The request parameters are invalid (bad request). */
2396
- 400: {
2397
- headers: {
2398
- [name: string]: unknown;
2399
- };
2400
- content: {
2401
- "application/json": components["schemas"]["ErrorResponse"];
2402
- };
2403
- };
2404
- /** @description The user doesn't have access to the realm. */
2405
- 403: {
2406
- headers: {
2407
- [name: string]: unknown;
2408
- };
2409
- content: {
2410
- "application/json": components["schemas"]["ErrorResponse"];
2411
- };
2412
- };
2413
- /** @description There isn't any sandbox with that ID. */
2414
- 404: {
2415
- headers: {
2416
- [name: string]: unknown;
2417
- };
2418
- content: {
2419
- "application/json": components["schemas"]["ErrorResponse"];
2420
- };
2421
- };
2422
- /** @description There were server errors during the request. */
2423
- 500: {
2424
- headers: {
2425
- [name: string]: unknown;
2426
- };
2427
- content: {
2428
- "application/json": components["schemas"]["ErrorResponse"];
2429
- };
2430
- };
2431
- };
2432
- };
2433
- getSandboxClone: {
2434
- parameters: {
2435
- query?: never;
2436
- header?: never;
2437
- path: {
2438
- /** @description The sandbox UUID. */
2439
- sandboxId: components["parameters"]["sandboxIdParam"];
2440
- /** @description The sandbox clone unique ID. A unique identifier of the sandbox in the format: realm-instance-clone-timestamp (e.g., aaaa-002-1642780893121), where: realm is 4 lowercase letters, instance is 3-digit number, timestamp is in ddMMyyyyHHmm format (13 digits). */
2441
- cloneId: components["parameters"]["sandboxCloneIdParam"];
2442
- };
2443
- cookie?: never;
2444
- };
2445
- requestBody?: never;
2446
- responses: {
2447
- /** @description Details on the cloned sandbox (including its state). */
2448
- 200: {
2449
- headers: {
2450
- [name: string]: unknown;
2451
- };
2452
- content: {
2453
- "application/json": components["schemas"]["SandboxCloneResponse"];
2454
- };
2455
- };
2456
- /** @description The request parameters are invalid (bad request). */
2457
- 400: {
2458
- headers: {
2459
- [name: string]: unknown;
2460
- };
2461
- content: {
2462
- "application/json": components["schemas"]["ErrorResponse"];
2463
- };
2464
- };
2465
- /** @description The user doesn't have access to the requested realm. */
2466
- 403: {
2467
- headers: {
2468
- [name: string]: unknown;
2469
- };
2470
- content: {
2471
- "application/json": components["schemas"]["ErrorResponse"];
2472
- };
2473
- };
2474
- /** @description There isn't any sandbox with that ID. */
2475
- 404: {
2476
- headers: {
2477
- [name: string]: unknown;
2478
- };
2479
- content: {
2480
- "application/json": components["schemas"]["ErrorResponse"];
2481
- };
2482
- };
2483
- /** @description There were server errors during the request. */
2484
- 500: {
2485
- headers: {
2486
- [name: string]: unknown;
2487
- };
2488
- content: {
2489
- "application/json": components["schemas"]["ErrorResponse"];
2490
- };
2491
- };
2492
- };
2493
- };
2494
- getSandboxOperations: {
2495
- parameters: {
2496
- query?: {
2497
- /** @description Earliest date for which data is in the response. Thirty days in the past by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
2498
- from?: components["parameters"]["fromParam"];
2499
- /** @description Latest date for which data is included in the response. Today's date by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
2500
- to?: components["parameters"]["toParam"];
2501
- /** @description State of operations included in the response. By default, all operations are included. */
2502
- operation_state?: components["parameters"]["operationStateParam"];
2503
- /** @description Status of operations included in the response. By default, all operations are included. */
2504
- status?: components["parameters"]["operationStatusParam"];
2505
- /** @description Type of operations included in the response. By default, all operations are included. */
2506
- operation?: components["parameters"]["operationTypeParam"];
2507
- /** @description Order of the list. Default value is ''asc''. */
2508
- sort_order?: components["parameters"]["sortOrderParam"];
2509
- /** @description Field by which to order the list. By default, the list is not ordered. */
2510
- sort_by?: components["parameters"]["sortByOperationParam"];
2511
- /** @description The page to access in a paged response. Page numbers start with '0', which is the default value. */
2512
- page?: components["parameters"]["pageParam"];
2513
- /** @description Count of elements on a page. The default value is '20'. */
2514
- per_page?: components["parameters"]["perPageParam"];
2515
- };
2516
- header?: never;
2517
- path: {
2518
- /** @description The sandbox UUID. */
2519
- sandboxId: components["parameters"]["sandboxIdParam"];
2520
- };
2521
- cookie?: never;
2522
- };
2523
- requestBody?: never;
2524
- responses: {
2525
- /** @description List of operations. */
2526
- 200: {
2527
- headers: {
2528
- /** @description Paging metadata, as described in <a href="https://tools.ietf.org/html/rfc5988">RFC-5988</a> */
2529
- Link?: string;
2530
- /** @description Total count of elements. */
2531
- "X-Pagination-Count"?: number;
2532
- /** @description Current page index. */
2533
- "X-Pagination-Page"?: number;
2534
- /** @description Maximum count of pages. */
2535
- "X-Pagination-Limit"?: number;
2536
- [name: string]: unknown;
2537
- };
2538
- content: {
2539
- "application/json": components["schemas"]["SandboxOperationListResponse"];
2540
- };
2541
- };
2542
- /** @description The request parameters are invalid (bad request). */
2543
- 400: {
2544
- headers: {
2545
- [name: string]: unknown;
2546
- };
2547
- content: {
2548
- "application/json": components["schemas"]["ErrorResponse"];
2549
- };
2550
- };
2551
- /** @description The user doesn't have access to the sandbox. */
2552
- 403: {
2553
- headers: {
2554
- [name: string]: unknown;
2555
- };
2556
- content: {
2557
- "application/json": components["schemas"]["ErrorResponse"];
2558
- };
2559
- };
2560
- /** @description There isn't any sandbox with that ID. */
2561
- 404: {
2562
- headers: {
2563
- [name: string]: unknown;
2564
- };
2565
- content: {
2566
- "application/json": components["schemas"]["ErrorResponse"];
2567
- };
2568
- };
2569
- /** @description There were server errors during the operation. */
2570
- 500: {
2571
- headers: {
2572
- [name: string]: unknown;
2573
- };
2574
- content: {
2575
- "application/json": components["schemas"]["ErrorResponse"];
2576
- };
2577
- };
2578
- };
2579
- };
2580
- createSandboxOperation: {
2581
- parameters: {
2582
- query?: never;
2583
- header?: never;
2584
- path: {
2585
- /** @description The sandbox UUID. */
2586
- sandboxId: components["parameters"]["sandboxIdParam"];
2587
- };
2588
- cookie?: never;
2589
- };
2590
- /** @description Operation to be carried out on a sandbox. */
2591
- requestBody: {
2592
- content: {
2593
- "application/json": components["schemas"]["SandboxOperationRequestModel"];
2594
- };
2595
- };
2596
- responses: {
2597
- /** @description The operation has been accepted. */
2598
- 202: {
2599
- headers: {
2600
- [name: string]: unknown;
2601
- };
2602
- content: {
2603
- "application/json": components["schemas"]["SandboxOperationResponse"];
2604
- };
2605
- };
2606
- /** @description The request parameters are invalid (bad request). */
2607
- 400: {
2608
- headers: {
2609
- [name: string]: unknown;
2610
- };
2611
- content: {
2612
- "application/json": components["schemas"]["ErrorResponse"];
2613
- };
2614
- };
2615
- /** @description The user doesn't have access to the sandbox. */
2616
- 403: {
2617
- headers: {
2618
- [name: string]: unknown;
2619
- };
2620
- content: {
2621
- "application/json": components["schemas"]["ErrorResponse"];
2622
- };
2623
- };
2624
- /** @description There isn't any sandbox with that ID. */
2625
- 404: {
2626
- headers: {
2627
- [name: string]: unknown;
2628
- };
2629
- content: {
2630
- "application/json": components["schemas"]["ErrorResponse"];
2631
- };
2632
- };
2633
- /** @description The operation isn't allowed in the current state of the sandbox. */
2634
- 422: {
2635
- headers: {
2636
- [name: string]: unknown;
2637
- };
2638
- content: {
2639
- "application/json": components["schemas"]["ErrorResponse"];
2640
- };
2641
- };
2642
- /** @description There were server errors during the operation. */
2643
- 500: {
2644
- headers: {
2645
- [name: string]: unknown;
2646
- };
2647
- content: {
2648
- "application/json": components["schemas"]["ErrorResponse"];
2649
- };
2650
- };
2651
- };
2652
- };
2653
- getSandboxOperation: {
2654
- parameters: {
2655
- query?: never;
2656
- header?: never;
2657
- path: {
2658
- /** @description The sandbox UUID. */
2659
- sandboxId: components["parameters"]["sandboxIdParam"];
2660
- /** @description The operation UUID. */
2661
- operationId: components["parameters"]["operationIdParam"];
2662
- };
2663
- cookie?: never;
2664
- };
2665
- requestBody?: never;
2666
- responses: {
2667
- /** @description Details of the sandbox operation's state and the state of its target. If the operation has already finished, indicates whether the operation was successful. */
2668
- 200: {
2669
- headers: {
2670
- [name: string]: unknown;
2671
- };
2672
- content: {
2673
- "application/json": components["schemas"]["SandboxOperationResponse"];
2674
- };
2675
- };
2676
- /** @description The request parameters are invalid (bad request). */
2677
- 400: {
2678
- headers: {
2679
- [name: string]: unknown;
2680
- };
2681
- content: {
2682
- "application/json": components["schemas"]["ErrorResponse"];
2683
- };
2684
- };
2685
- /** @description The user doesn't have access to the requested operation or sandbox. */
2686
- 403: {
2687
- headers: {
2688
- [name: string]: unknown;
2689
- };
2690
- content: {
2691
- "application/json": components["schemas"]["ErrorResponse"];
2692
- };
2693
- };
2694
- /** @description There isn't any sandbox or realm matching the given parameters. */
2695
- 404: {
2696
- headers: {
2697
- [name: string]: unknown;
2698
- };
2699
- content: {
2700
- "application/json": components["schemas"]["ErrorResponse"];
2701
- };
2702
- };
2703
- };
2704
- };
2705
- getSandboxSettings: {
2706
- parameters: {
2707
- query?: never;
2708
- header?: never;
2709
- path: {
2710
- /** @description The sandbox UUID. */
2711
- sandboxId: components["parameters"]["sandboxIdParam"];
2712
- };
2713
- cookie?: never;
2714
- };
2715
- requestBody?: never;
2716
- responses: {
2717
- /** @description Details of the sandbox settings. */
2718
- 200: {
2719
- headers: {
2720
- [name: string]: unknown;
2721
- };
2722
- content: {
2723
- "application/json": components["schemas"]["SandboxSettingsResponse"];
2724
- };
2725
- };
2726
- /** @description The sandbox ID isn't valid. */
2727
- 400: {
2728
- headers: {
2729
- [name: string]: unknown;
2730
- };
2731
- content: {
2732
- "application/json": components["schemas"]["ErrorResponse"];
2733
- };
2734
- };
2735
- /** @description The user doesn't have access to the requested sandbox. */
2736
- 403: {
2737
- headers: {
2738
- [name: string]: unknown;
2739
- };
2740
- content: {
2741
- "application/json": components["schemas"]["ErrorResponse"];
2742
- };
2743
- };
2744
- /** @description There isn't any sandbox matching the ID. */
2745
- 404: {
2746
- headers: {
2747
- [name: string]: unknown;
2748
- };
2749
- content: {
2750
- "application/json": components["schemas"]["ErrorResponse"];
2751
- };
2752
- };
2753
- };
2754
- };
2755
- getSandboxUsage: {
2756
- parameters: {
2757
- query?: {
2758
- /** @description Earliest date for which data is in the response. Thirty days in the past by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
2759
- from?: components["parameters"]["fromParam"];
2760
- /** @description Latest date for which data is included in the response. Today's date by default. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>. */
2761
- to?: components["parameters"]["toParam"];
2762
- };
2763
- header?: never;
2764
- path: {
2765
- /** @description The sandbox UUID. */
2766
- sandboxId: components["parameters"]["sandboxIdParam"];
2767
- };
2768
- cookie?: never;
2769
- };
2770
- requestBody?: never;
2771
- responses: {
2772
- /** @description Sandbox usage information. */
2773
- 200: {
2774
- headers: {
2775
- [name: string]: unknown;
2776
- };
2777
- content: {
2778
- "application/json": components["schemas"]["SandboxUsageResponse"];
2779
- };
2780
- };
2781
- /** @description The sandbox ID isn't valid. */
2782
- 400: {
2783
- headers: {
2784
- [name: string]: unknown;
2785
- };
2786
- content: {
2787
- "application/json": components["schemas"]["ErrorResponse"];
2788
- };
2789
- };
2790
- /** @description The user doesn't have access to the requested sandbox. */
2791
- 403: {
2792
- headers: {
2793
- [name: string]: unknown;
2794
- };
2795
- content: {
2796
- "application/json": components["schemas"]["ErrorResponse"];
2797
- };
2798
- };
2799
- /** @description There isn't any sandbox matching the ID. */
2800
- 404: {
2801
- headers: {
2802
- [name: string]: unknown;
2803
- };
2804
- content: {
2805
- "application/json": components["schemas"]["ErrorResponse"];
2806
- };
2807
- };
2808
- };
2809
- };
2810
- getSandboxStorage: {
2811
- parameters: {
2812
- query?: never;
2813
- header?: never;
2814
- path: {
2815
- /** @description The sandbox UUID. */
2816
- sandboxId: components["parameters"]["sandboxIdParam"];
2817
- };
2818
- cookie?: never;
2819
- };
2820
- requestBody?: never;
2821
- responses: {
2822
- /** @description Sandbox storage information. */
2823
- 200: {
2824
- headers: {
2825
- [name: string]: unknown;
2826
- };
2827
- content: {
2828
- "application/json": components["schemas"]["SandboxStorageResponse"];
2829
- };
2830
- };
2831
- /** @description The sandbox ID isn't valid. */
2832
- 400: {
2833
- headers: {
2834
- [name: string]: unknown;
2835
- };
2836
- content: {
2837
- "application/json": components["schemas"]["ErrorResponse"];
2838
- };
2839
- };
2840
- /** @description The user doesn't have access to the requested sandbox. */
2841
- 403: {
2842
- headers: {
2843
- [name: string]: unknown;
2844
- };
2845
- content: {
2846
- "application/json": components["schemas"]["ErrorResponse"];
2847
- };
2848
- };
2849
- /** @description There isn't any sandbox matching the ID. */
2850
- 404: {
2851
- headers: {
2852
- [name: string]: unknown;
2853
- };
2854
- content: {
2855
- "application/json": components["schemas"]["ErrorResponse"];
2856
- };
2857
- };
2858
- };
2859
- };
2860
- }