@salesforce/b2c-tooling-sdk 1.10.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 (638) hide show
  1. package/data/content-schemas/componenttype.json +37 -0
  2. package/dist/esm/operations/content/validate.js +46 -4
  3. package/dist/esm/operations/content/validate.js.map +1 -1
  4. package/dist/esm/operations/jobs/site-archive.d.ts +12 -0
  5. package/dist/esm/operations/jobs/site-archive.js +107 -3
  6. package/dist/esm/operations/jobs/site-archive.js.map +1 -1
  7. package/package.json +73 -285
  8. package/dist/cjs/auth/api-key.d.ts +0 -28
  9. package/dist/cjs/auth/api-key.js +0 -45
  10. package/dist/cjs/auth/api-key.js.map +0 -1
  11. package/dist/cjs/auth/basic.d.ts +0 -7
  12. package/dist/cjs/auth/basic.js +0 -20
  13. package/dist/cjs/auth/basic.js.map +0 -1
  14. package/dist/cjs/auth/index.d.ts +0 -74
  15. package/dist/cjs/auth/index.js +0 -76
  16. package/dist/cjs/auth/index.js.map +0 -1
  17. package/dist/cjs/auth/jwt-utils.d.ts +0 -25
  18. package/dist/cjs/auth/jwt-utils.js +0 -66
  19. package/dist/cjs/auth/jwt-utils.js.map +0 -1
  20. package/dist/cjs/auth/middleware.d.ts +0 -196
  21. package/dist/cjs/auth/middleware.js +0 -190
  22. package/dist/cjs/auth/middleware.js.map +0 -1
  23. package/dist/cjs/auth/oauth-implicit.d.ts +0 -89
  24. package/dist/cjs/auth/oauth-implicit.js +0 -350
  25. package/dist/cjs/auth/oauth-implicit.js.map +0 -1
  26. package/dist/cjs/auth/oauth-jwt.d.ts +0 -99
  27. package/dist/cjs/auth/oauth-jwt.js +0 -343
  28. package/dist/cjs/auth/oauth-jwt.js.map +0 -1
  29. package/dist/cjs/auth/oauth.d.ts +0 -88
  30. package/dist/cjs/auth/oauth.js +0 -252
  31. package/dist/cjs/auth/oauth.js.map +0 -1
  32. package/dist/cjs/auth/resolve.d.ts +0 -100
  33. package/dist/cjs/auth/resolve.js +0 -175
  34. package/dist/cjs/auth/resolve.js.map +0 -1
  35. package/dist/cjs/auth/stateful-oauth-strategy.d.ts +0 -39
  36. package/dist/cjs/auth/stateful-oauth-strategy.js +0 -130
  37. package/dist/cjs/auth/stateful-oauth-strategy.js.map +0 -1
  38. package/dist/cjs/auth/stateful-store.d.ts +0 -49
  39. package/dist/cjs/auth/stateful-store.js +0 -166
  40. package/dist/cjs/auth/stateful-store.js.map +0 -1
  41. package/dist/cjs/auth/types.d.ts +0 -124
  42. package/dist/cjs/auth/types.js +0 -8
  43. package/dist/cjs/auth/types.js.map +0 -1
  44. package/dist/cjs/cli/am-command.d.ts +0 -74
  45. package/dist/cjs/cli/am-command.js +0 -199
  46. package/dist/cjs/cli/am-command.js.map +0 -1
  47. package/dist/cjs/cli/base-command.d.ts +0 -232
  48. package/dist/cjs/cli/base-command.js +0 -695
  49. package/dist/cjs/cli/base-command.js.map +0 -1
  50. package/dist/cjs/cli/cartridge-command.d.ts +0 -67
  51. package/dist/cjs/cli/cartridge-command.js +0 -146
  52. package/dist/cjs/cli/cartridge-command.js.map +0 -1
  53. package/dist/cjs/cli/cartridge-providers.d.ts +0 -149
  54. package/dist/cjs/cli/cartridge-providers.js +0 -103
  55. package/dist/cjs/cli/cartridge-providers.js.map +0 -1
  56. package/dist/cjs/cli/columns.d.ts +0 -128
  57. package/dist/cjs/cli/columns.js +0 -128
  58. package/dist/cjs/cli/columns.js.map +0 -1
  59. package/dist/cjs/cli/config.d.ts +0 -159
  60. package/dist/cjs/cli/config.js +0 -185
  61. package/dist/cjs/cli/config.js.map +0 -1
  62. package/dist/cjs/cli/details.d.ts +0 -69
  63. package/dist/cjs/cli/details.js +0 -72
  64. package/dist/cjs/cli/details.js.map +0 -1
  65. package/dist/cjs/cli/hooks.d.ts +0 -324
  66. package/dist/cjs/cli/hooks.js +0 -3
  67. package/dist/cjs/cli/hooks.js.map +0 -1
  68. package/dist/cjs/cli/index.d.ts +0 -108
  69. package/dist/cjs/cli/index.js +0 -111
  70. package/dist/cjs/cli/index.js.map +0 -1
  71. package/dist/cjs/cli/instance-command.d.ts +0 -131
  72. package/dist/cjs/cli/instance-command.js +0 -214
  73. package/dist/cjs/cli/instance-command.js.map +0 -1
  74. package/dist/cjs/cli/job-command.d.ts +0 -32
  75. package/dist/cjs/cli/job-command.js +0 -60
  76. package/dist/cjs/cli/job-command.js.map +0 -1
  77. package/dist/cjs/cli/lifecycle.d.ts +0 -189
  78. package/dist/cjs/cli/lifecycle.js +0 -130
  79. package/dist/cjs/cli/lifecycle.js.map +0 -1
  80. package/dist/cjs/cli/mrt-command.d.ts +0 -57
  81. package/dist/cjs/cli/mrt-command.js +0 -95
  82. package/dist/cjs/cli/mrt-command.js.map +0 -1
  83. package/dist/cjs/cli/oauth-command.d.ts +0 -122
  84. package/dist/cjs/cli/oauth-command.js +0 -311
  85. package/dist/cjs/cli/oauth-command.js.map +0 -1
  86. package/dist/cjs/cli/ods-command.d.ts +0 -97
  87. package/dist/cjs/cli/ods-command.js +0 -136
  88. package/dist/cjs/cli/ods-command.js.map +0 -1
  89. package/dist/cjs/cli/table.d.ts +0 -113
  90. package/dist/cjs/cli/table.js +0 -175
  91. package/dist/cjs/cli/table.js.map +0 -1
  92. package/dist/cjs/cli/webdav-command.d.ts +0 -110
  93. package/dist/cjs/cli/webdav-command.js +0 -106
  94. package/dist/cjs/cli/webdav-command.js.map +0 -1
  95. package/dist/cjs/clients/am-api.d.ts +0 -521
  96. package/dist/cjs/clients/am-api.js +0 -992
  97. package/dist/cjs/clients/am-api.js.map +0 -1
  98. package/dist/cjs/clients/am-apiclients-api.generated.d.ts +0 -803
  99. package/dist/cjs/clients/am-apiclients-api.generated.js +0 -6
  100. package/dist/cjs/clients/am-apiclients-api.generated.js.map +0 -1
  101. package/dist/cjs/clients/am-roles-api.generated.d.ts +0 -298
  102. package/dist/cjs/clients/am-roles-api.generated.js +0 -6
  103. package/dist/cjs/clients/am-roles-api.generated.js.map +0 -1
  104. package/dist/cjs/clients/am-users-api.generated.d.ts +0 -954
  105. package/dist/cjs/clients/am-users-api.generated.js +0 -6
  106. package/dist/cjs/clients/am-users-api.generated.js.map +0 -1
  107. package/dist/cjs/clients/cdn-zones.d.ts +0 -186
  108. package/dist/cjs/clients/cdn-zones.generated.d.ts +0 -8330
  109. package/dist/cjs/clients/cdn-zones.generated.js +0 -6
  110. package/dist/cjs/clients/cdn-zones.generated.js.map +0 -1
  111. package/dist/cjs/clients/cdn-zones.js +0 -103
  112. package/dist/cjs/clients/cdn-zones.js.map +0 -1
  113. package/dist/cjs/clients/cip.d.ts +0 -162
  114. package/dist/cjs/clients/cip.js +0 -572
  115. package/dist/cjs/clients/cip.js.map +0 -1
  116. package/dist/cjs/clients/custom-apis.d.ts +0 -174
  117. package/dist/cjs/clients/custom-apis.generated.d.ts +0 -202
  118. package/dist/cjs/clients/custom-apis.generated.js +0 -6
  119. package/dist/cjs/clients/custom-apis.generated.js.map +0 -1
  120. package/dist/cjs/clients/custom-apis.js +0 -140
  121. package/dist/cjs/clients/custom-apis.js.map +0 -1
  122. package/dist/cjs/clients/error-utils.d.ts +0 -35
  123. package/dist/cjs/clients/error-utils.js +0 -69
  124. package/dist/cjs/clients/error-utils.js.map +0 -1
  125. package/dist/cjs/clients/granular-replications.d.ts +0 -70
  126. package/dist/cjs/clients/granular-replications.generated.d.ts +0 -416
  127. package/dist/cjs/clients/granular-replications.generated.js +0 -6
  128. package/dist/cjs/clients/granular-replications.generated.js.map +0 -1
  129. package/dist/cjs/clients/granular-replications.js +0 -73
  130. package/dist/cjs/clients/granular-replications.js.map +0 -1
  131. package/dist/cjs/clients/index.d.ts +0 -145
  132. package/dist/cjs/clients/index.js +0 -137
  133. package/dist/cjs/clients/index.js.map +0 -1
  134. package/dist/cjs/clients/middleware-registry.d.ts +0 -184
  135. package/dist/cjs/clients/middleware-registry.js +0 -104
  136. package/dist/cjs/clients/middleware-registry.js.map +0 -1
  137. package/dist/cjs/clients/middleware.d.ts +0 -183
  138. package/dist/cjs/clients/middleware.js +0 -465
  139. package/dist/cjs/clients/middleware.js.map +0 -1
  140. package/dist/cjs/clients/mrt-b2c.d.ts +0 -138
  141. package/dist/cjs/clients/mrt-b2c.generated.d.ts +0 -176
  142. package/dist/cjs/clients/mrt-b2c.generated.js +0 -6
  143. package/dist/cjs/clients/mrt-b2c.generated.js.map +0 -1
  144. package/dist/cjs/clients/mrt-b2c.js +0 -86
  145. package/dist/cjs/clients/mrt-b2c.js.map +0 -1
  146. package/dist/cjs/clients/mrt.d.ts +0 -143
  147. package/dist/cjs/clients/mrt.generated.d.ts +0 -3806
  148. package/dist/cjs/clients/mrt.generated.js +0 -6
  149. package/dist/cjs/clients/mrt.generated.js.map +0 -1
  150. package/dist/cjs/clients/mrt.js +0 -93
  151. package/dist/cjs/clients/mrt.js.map +0 -1
  152. package/dist/cjs/clients/ocapi.d.ts +0 -128
  153. package/dist/cjs/clients/ocapi.generated.d.ts +0 -26052
  154. package/dist/cjs/clients/ocapi.generated.js +0 -6
  155. package/dist/cjs/clients/ocapi.generated.js.map +0 -1
  156. package/dist/cjs/clients/ocapi.js +0 -78
  157. package/dist/cjs/clients/ocapi.js.map +0 -1
  158. package/dist/cjs/clients/ods.d.ts +0 -160
  159. package/dist/cjs/clients/ods.generated.d.ts +0 -2860
  160. package/dist/cjs/clients/ods.generated.js +0 -6
  161. package/dist/cjs/clients/ods.generated.js.map +0 -1
  162. package/dist/cjs/clients/ods.js +0 -103
  163. package/dist/cjs/clients/ods.js.map +0 -1
  164. package/dist/cjs/clients/scapi-schemas.d.ts +0 -161
  165. package/dist/cjs/clients/scapi-schemas.generated.d.ts +0 -328
  166. package/dist/cjs/clients/scapi-schemas.generated.js +0 -6
  167. package/dist/cjs/clients/scapi-schemas.generated.js.map +0 -1
  168. package/dist/cjs/clients/scapi-schemas.js +0 -98
  169. package/dist/cjs/clients/scapi-schemas.js.map +0 -1
  170. package/dist/cjs/clients/slas-admin.d.ts +0 -132
  171. package/dist/cjs/clients/slas-admin.generated.d.ts +0 -1434
  172. package/dist/cjs/clients/slas-admin.generated.js +0 -6
  173. package/dist/cjs/clients/slas-admin.generated.js.map +0 -1
  174. package/dist/cjs/clients/slas-admin.js +0 -79
  175. package/dist/cjs/clients/slas-admin.js.map +0 -1
  176. package/dist/cjs/clients/tls-dispatcher.d.ts +0 -42
  177. package/dist/cjs/clients/tls-dispatcher.js +0 -107
  178. package/dist/cjs/clients/tls-dispatcher.js.map +0 -1
  179. package/dist/cjs/clients/user-agent.d.ts +0 -43
  180. package/dist/cjs/clients/user-agent.js +0 -87
  181. package/dist/cjs/clients/user-agent.js.map +0 -1
  182. package/dist/cjs/clients/webdav.d.ts +0 -186
  183. package/dist/cjs/clients/webdav.js +0 -395
  184. package/dist/cjs/clients/webdav.js.map +0 -1
  185. package/dist/cjs/config/config-source-registry.d.ts +0 -115
  186. package/dist/cjs/config/config-source-registry.js +0 -103
  187. package/dist/cjs/config/config-source-registry.js.map +0 -1
  188. package/dist/cjs/config/dw-json.d.ts +0 -274
  189. package/dist/cjs/config/dw-json.js +0 -333
  190. package/dist/cjs/config/dw-json.js.map +0 -1
  191. package/dist/cjs/config/index.d.ts +0 -100
  192. package/dist/cjs/config/index.js +0 -110
  193. package/dist/cjs/config/index.js.map +0 -1
  194. package/dist/cjs/config/instance-manager.d.ts +0 -97
  195. package/dist/cjs/config/instance-manager.js +0 -166
  196. package/dist/cjs/config/instance-manager.js.map +0 -1
  197. package/dist/cjs/config/mapping.d.ts +0 -199
  198. package/dist/cjs/config/mapping.js +0 -540
  199. package/dist/cjs/config/mapping.js.map +0 -1
  200. package/dist/cjs/config/resolved-config.d.ts +0 -29
  201. package/dist/cjs/config/resolved-config.js +0 -81
  202. package/dist/cjs/config/resolved-config.js.map +0 -1
  203. package/dist/cjs/config/resolver.d.ts +0 -191
  204. package/dist/cjs/config/resolver.js +0 -406
  205. package/dist/cjs/config/resolver.js.map +0 -1
  206. package/dist/cjs/config/sources/dw-json-source.d.ts +0 -27
  207. package/dist/cjs/config/sources/dw-json-source.js +0 -106
  208. package/dist/cjs/config/sources/dw-json-source.js.map +0 -1
  209. package/dist/cjs/config/sources/env-source.d.ts +0 -32
  210. package/dist/cjs/config/sources/env-source.js +0 -116
  211. package/dist/cjs/config/sources/env-source.js.map +0 -1
  212. package/dist/cjs/config/sources/index.d.ts +0 -9
  213. package/dist/cjs/config/sources/index.js +0 -15
  214. package/dist/cjs/config/sources/index.js.map +0 -1
  215. package/dist/cjs/config/sources/mobify-source.d.ts +0 -25
  216. package/dist/cjs/config/sources/mobify-source.js +0 -84
  217. package/dist/cjs/config/sources/mobify-source.js.map +0 -1
  218. package/dist/cjs/config/sources/package-json-source.d.ts +0 -14
  219. package/dist/cjs/config/sources/package-json-source.js +0 -97
  220. package/dist/cjs/config/sources/package-json-source.js.map +0 -1
  221. package/dist/cjs/config/types.d.ts +0 -428
  222. package/dist/cjs/config/types.js +0 -2
  223. package/dist/cjs/config/types.js.map +0 -1
  224. package/dist/cjs/defaults.d.ts +0 -36
  225. package/dist/cjs/defaults.js +0 -54
  226. package/dist/cjs/defaults.js.map +0 -1
  227. package/dist/cjs/discovery/detector.d.ts +0 -75
  228. package/dist/cjs/discovery/detector.js +0 -108
  229. package/dist/cjs/discovery/detector.js.map +0 -1
  230. package/dist/cjs/discovery/index.d.ts +0 -63
  231. package/dist/cjs/discovery/index.js +0 -70
  232. package/dist/cjs/discovery/index.js.map +0 -1
  233. package/dist/cjs/discovery/patterns/cartridges.d.ts +0 -16
  234. package/dist/cjs/discovery/patterns/cartridges.js +0 -16
  235. package/dist/cjs/discovery/patterns/cartridges.js.map +0 -1
  236. package/dist/cjs/discovery/patterns/index.d.ts +0 -21
  237. package/dist/cjs/discovery/patterns/index.js +0 -16
  238. package/dist/cjs/discovery/patterns/index.js.map +0 -1
  239. package/dist/cjs/discovery/patterns/pwa-kit.d.ts +0 -15
  240. package/dist/cjs/discovery/patterns/pwa-kit.js +0 -26
  241. package/dist/cjs/discovery/patterns/pwa-kit.js.map +0 -1
  242. package/dist/cjs/discovery/patterns/sfra.d.ts +0 -34
  243. package/dist/cjs/discovery/patterns/sfra.js +0 -50
  244. package/dist/cjs/discovery/patterns/sfra.js.map +0 -1
  245. package/dist/cjs/discovery/patterns/storefront-next.d.ts +0 -10
  246. package/dist/cjs/discovery/patterns/storefront-next.js +0 -65
  247. package/dist/cjs/discovery/patterns/storefront-next.js.map +0 -1
  248. package/dist/cjs/discovery/types.d.ts +0 -47
  249. package/dist/cjs/discovery/types.js +0 -12
  250. package/dist/cjs/discovery/types.js.map +0 -1
  251. package/dist/cjs/discovery/utils.d.ts +0 -44
  252. package/dist/cjs/discovery/utils.js +0 -82
  253. package/dist/cjs/discovery/utils.js.map +0 -1
  254. package/dist/cjs/docs/download.d.ts +0 -45
  255. package/dist/cjs/docs/download.js +0 -96
  256. package/dist/cjs/docs/download.js.map +0 -1
  257. package/dist/cjs/docs/index.d.ts +0 -44
  258. package/dist/cjs/docs/index.js +0 -12
  259. package/dist/cjs/docs/index.js.map +0 -1
  260. package/dist/cjs/docs/schema.d.ts +0 -26
  261. package/dist/cjs/docs/schema.js +0 -92
  262. package/dist/cjs/docs/schema.js.map +0 -1
  263. package/dist/cjs/docs/search.d.ts +0 -67
  264. package/dist/cjs/docs/search.js +0 -128
  265. package/dist/cjs/docs/search.js.map +0 -1
  266. package/dist/cjs/docs/types.d.ts +0 -64
  267. package/dist/cjs/docs/types.js +0 -15
  268. package/dist/cjs/docs/types.js.map +0 -1
  269. package/dist/cjs/errors/http-error.d.ts +0 -34
  270. package/dist/cjs/errors/http-error.js +0 -45
  271. package/dist/cjs/errors/http-error.js.map +0 -1
  272. package/dist/cjs/errors/index.d.ts +0 -12
  273. package/dist/cjs/errors/index.js +0 -18
  274. package/dist/cjs/errors/index.js.map +0 -1
  275. package/dist/cjs/i18n/index.d.ts +0 -144
  276. package/dist/cjs/i18n/index.js +0 -245
  277. package/dist/cjs/i18n/index.js.map +0 -1
  278. package/dist/cjs/i18n/locales/de.d.ts +0 -13
  279. package/dist/cjs/i18n/locales/de.js +0 -19
  280. package/dist/cjs/i18n/locales/de.js.map +0 -1
  281. package/dist/cjs/i18n/locales/index.d.ts +0 -28
  282. package/dist/cjs/i18n/locales/index.js +0 -25
  283. package/dist/cjs/i18n/locales/index.js.map +0 -1
  284. package/dist/cjs/index.d.ts +0 -33
  285. package/dist/cjs/index.js +0 -41
  286. package/dist/cjs/index.js.map +0 -1
  287. package/dist/cjs/instance/index.d.ts +0 -136
  288. package/dist/cjs/instance/index.js +0 -131
  289. package/dist/cjs/instance/index.js.map +0 -1
  290. package/dist/cjs/logging/index.d.ts +0 -116
  291. package/dist/cjs/logging/index.js +0 -121
  292. package/dist/cjs/logging/index.js.map +0 -1
  293. package/dist/cjs/logging/logger.d.ts +0 -9
  294. package/dist/cjs/logging/logger.js +0 -138
  295. package/dist/cjs/logging/logger.js.map +0 -1
  296. package/dist/cjs/logging/types.d.ts +0 -45
  297. package/dist/cjs/logging/types.js +0 -10
  298. package/dist/cjs/logging/types.js.map +0 -1
  299. package/dist/cjs/operations/bm-roles/index.d.ts +0 -52
  300. package/dist/cjs/operations/bm-roles/index.js +0 -57
  301. package/dist/cjs/operations/bm-roles/index.js.map +0 -1
  302. package/dist/cjs/operations/bm-roles/roles.d.ts +0 -155
  303. package/dist/cjs/operations/bm-roles/roles.js +0 -194
  304. package/dist/cjs/operations/bm-roles/roles.js.map +0 -1
  305. package/dist/cjs/operations/bm-users/index.d.ts +0 -50
  306. package/dist/cjs/operations/bm-users/index.js +0 -55
  307. package/dist/cjs/operations/bm-users/index.js.map +0 -1
  308. package/dist/cjs/operations/bm-users/users.d.ts +0 -189
  309. package/dist/cjs/operations/bm-users/users.js +0 -229
  310. package/dist/cjs/operations/bm-users/users.js.map +0 -1
  311. package/dist/cjs/operations/cap/index.d.ts +0 -56
  312. package/dist/cjs/operations/cap/index.js +0 -57
  313. package/dist/cjs/operations/cap/index.js.map +0 -1
  314. package/dist/cjs/operations/cap/install.d.ts +0 -53
  315. package/dist/cjs/operations/cap/install.js +0 -181
  316. package/dist/cjs/operations/cap/install.js.map +0 -1
  317. package/dist/cjs/operations/cap/list.d.ts +0 -92
  318. package/dist/cjs/operations/cap/list.js +0 -230
  319. package/dist/cjs/operations/cap/list.js.map +0 -1
  320. package/dist/cjs/operations/cap/package.d.ts +0 -39
  321. package/dist/cjs/operations/cap/package.js +0 -77
  322. package/dist/cjs/operations/cap/package.js.map +0 -1
  323. package/dist/cjs/operations/cap/pull.d.ts +0 -21
  324. package/dist/cjs/operations/cap/pull.js +0 -77
  325. package/dist/cjs/operations/cap/pull.js.map +0 -1
  326. package/dist/cjs/operations/cap/uninstall.d.ts +0 -46
  327. package/dist/cjs/operations/cap/uninstall.js +0 -87
  328. package/dist/cjs/operations/cap/uninstall.js.map +0 -1
  329. package/dist/cjs/operations/cap/validate.d.ts +0 -47
  330. package/dist/cjs/operations/cap/validate.js +0 -235
  331. package/dist/cjs/operations/cap/validate.js.map +0 -1
  332. package/dist/cjs/operations/cip/index.d.ts +0 -35
  333. package/dist/cjs/operations/cip/index.js +0 -128
  334. package/dist/cjs/operations/cip/index.js.map +0 -1
  335. package/dist/cjs/operations/cip/reports.d.ts +0 -2
  336. package/dist/cjs/operations/cip/reports.js +0 -210
  337. package/dist/cjs/operations/cip/reports.js.map +0 -1
  338. package/dist/cjs/operations/cip/types.d.ts +0 -97
  339. package/dist/cjs/operations/cip/types.js +0 -7
  340. package/dist/cjs/operations/cip/types.js.map +0 -1
  341. package/dist/cjs/operations/code/cartridges.d.ts +0 -46
  342. package/dist/cjs/operations/code/cartridges.js +0 -69
  343. package/dist/cjs/operations/code/cartridges.js.map +0 -1
  344. package/dist/cjs/operations/code/deploy.d.ts +0 -121
  345. package/dist/cjs/operations/code/deploy.js +0 -255
  346. package/dist/cjs/operations/code/deploy.js.map +0 -1
  347. package/dist/cjs/operations/code/download.d.ts +0 -77
  348. package/dist/cjs/operations/code/download.js +0 -300
  349. package/dist/cjs/operations/code/download.js.map +0 -1
  350. package/dist/cjs/operations/code/index.d.ts +0 -74
  351. package/dist/cjs/operations/code/index.js +0 -80
  352. package/dist/cjs/operations/code/index.js.map +0 -1
  353. package/dist/cjs/operations/code/upload-files.d.ts +0 -47
  354. package/dist/cjs/operations/code/upload-files.js +0 -116
  355. package/dist/cjs/operations/code/upload-files.js.map +0 -1
  356. package/dist/cjs/operations/code/versions.d.ts +0 -99
  357. package/dist/cjs/operations/code/versions.js +0 -156
  358. package/dist/cjs/operations/code/versions.js.map +0 -1
  359. package/dist/cjs/operations/code/watch.d.ts +0 -58
  360. package/dist/cjs/operations/code/watch.js +0 -175
  361. package/dist/cjs/operations/code/watch.js.map +0 -1
  362. package/dist/cjs/operations/content/asset-query.d.ts +0 -22
  363. package/dist/cjs/operations/content/asset-query.js +0 -77
  364. package/dist/cjs/operations/content/asset-query.js.map +0 -1
  365. package/dist/cjs/operations/content/export.d.ts +0 -57
  366. package/dist/cjs/operations/content/export.js +0 -221
  367. package/dist/cjs/operations/content/export.js.map +0 -1
  368. package/dist/cjs/operations/content/index.d.ts +0 -56
  369. package/dist/cjs/operations/content/index.js +0 -60
  370. package/dist/cjs/operations/content/index.js.map +0 -1
  371. package/dist/cjs/operations/content/library.d.ts +0 -137
  372. package/dist/cjs/operations/content/library.js +0 -396
  373. package/dist/cjs/operations/content/library.js.map +0 -1
  374. package/dist/cjs/operations/content/types.d.ts +0 -144
  375. package/dist/cjs/operations/content/types.js +0 -7
  376. package/dist/cjs/operations/content/types.js.map +0 -1
  377. package/dist/cjs/operations/content/validate.d.ts +0 -64
  378. package/dist/cjs/operations/content/validate.js +0 -170
  379. package/dist/cjs/operations/content/validate.js.map +0 -1
  380. package/dist/cjs/operations/debug/dap-adapter.d.ts +0 -72
  381. package/dist/cjs/operations/debug/dap-adapter.js +0 -505
  382. package/dist/cjs/operations/debug/dap-adapter.js.map +0 -1
  383. package/dist/cjs/operations/debug/debug-session.d.ts +0 -51
  384. package/dist/cjs/operations/debug/debug-session.js +0 -234
  385. package/dist/cjs/operations/debug/debug-session.js.map +0 -1
  386. package/dist/cjs/operations/debug/index.d.ts +0 -20
  387. package/dist/cjs/operations/debug/index.js +0 -21
  388. package/dist/cjs/operations/debug/index.js.map +0 -1
  389. package/dist/cjs/operations/debug/projections.d.ts +0 -72
  390. package/dist/cjs/operations/debug/projections.js +0 -84
  391. package/dist/cjs/operations/debug/projections.js.map +0 -1
  392. package/dist/cjs/operations/debug/resolve-path.d.ts +0 -15
  393. package/dist/cjs/operations/debug/resolve-path.js +0 -52
  394. package/dist/cjs/operations/debug/resolve-path.js.map +0 -1
  395. package/dist/cjs/operations/debug/sdapi-client.d.ts +0 -44
  396. package/dist/cjs/operations/debug/sdapi-client.js +0 -169
  397. package/dist/cjs/operations/debug/sdapi-client.js.map +0 -1
  398. package/dist/cjs/operations/debug/source-mapping.d.ts +0 -13
  399. package/dist/cjs/operations/debug/source-mapping.js +0 -57
  400. package/dist/cjs/operations/debug/source-mapping.js.map +0 -1
  401. package/dist/cjs/operations/debug/types.d.ts +0 -95
  402. package/dist/cjs/operations/debug/types.js +0 -2
  403. package/dist/cjs/operations/debug/types.js.map +0 -1
  404. package/dist/cjs/operations/debug/variable-store.d.ts +0 -35
  405. package/dist/cjs/operations/debug/variable-store.js +0 -52
  406. package/dist/cjs/operations/debug/variable-store.js.map +0 -1
  407. package/dist/cjs/operations/jobs/index.d.ts +0 -66
  408. package/dist/cjs/operations/jobs/index.js +0 -72
  409. package/dist/cjs/operations/jobs/index.js.map +0 -1
  410. package/dist/cjs/operations/jobs/run.d.ts +0 -239
  411. package/dist/cjs/operations/jobs/run.js +0 -324
  412. package/dist/cjs/operations/jobs/run.js.map +0 -1
  413. package/dist/cjs/operations/jobs/site-archive.d.ts +0 -267
  414. package/dist/cjs/operations/jobs/site-archive.js +0 -423
  415. package/dist/cjs/operations/jobs/site-archive.js.map +0 -1
  416. package/dist/cjs/operations/logs/index.d.ts +0 -65
  417. package/dist/cjs/operations/logs/index.js +0 -73
  418. package/dist/cjs/operations/logs/index.js.map +0 -1
  419. package/dist/cjs/operations/logs/list.d.ts +0 -35
  420. package/dist/cjs/operations/logs/list.js +0 -144
  421. package/dist/cjs/operations/logs/list.js.map +0 -1
  422. package/dist/cjs/operations/logs/path-normalizer.d.ts +0 -82
  423. package/dist/cjs/operations/logs/path-normalizer.js +0 -190
  424. package/dist/cjs/operations/logs/path-normalizer.js.map +0 -1
  425. package/dist/cjs/operations/logs/tail.d.ts +0 -92
  426. package/dist/cjs/operations/logs/tail.js +0 -525
  427. package/dist/cjs/operations/logs/tail.js.map +0 -1
  428. package/dist/cjs/operations/logs/types.d.ts +0 -132
  429. package/dist/cjs/operations/logs/types.js +0 -7
  430. package/dist/cjs/operations/logs/types.js.map +0 -1
  431. package/dist/cjs/operations/mrt/access-control.d.ts +0 -192
  432. package/dist/cjs/operations/mrt/access-control.js +0 -152
  433. package/dist/cjs/operations/mrt/access-control.js.map +0 -1
  434. package/dist/cjs/operations/mrt/b2c-config.d.ts +0 -201
  435. package/dist/cjs/operations/mrt/b2c-config.js +0 -210
  436. package/dist/cjs/operations/mrt/b2c-config.js.map +0 -1
  437. package/dist/cjs/operations/mrt/bundle.d.ts +0 -114
  438. package/dist/cjs/operations/mrt/bundle.js +0 -166
  439. package/dist/cjs/operations/mrt/bundle.js.map +0 -1
  440. package/dist/cjs/operations/mrt/cache.d.ts +0 -80
  441. package/dist/cjs/operations/mrt/cache.js +0 -65
  442. package/dist/cjs/operations/mrt/cache.js.map +0 -1
  443. package/dist/cjs/operations/mrt/certificate.d.ts +0 -60
  444. package/dist/cjs/operations/mrt/certificate.js +0 -76
  445. package/dist/cjs/operations/mrt/certificate.js.map +0 -1
  446. package/dist/cjs/operations/mrt/deployment.d.ts +0 -157
  447. package/dist/cjs/operations/mrt/deployment.js +0 -109
  448. package/dist/cjs/operations/mrt/deployment.js.map +0 -1
  449. package/dist/cjs/operations/mrt/env-var.d.ts +0 -176
  450. package/dist/cjs/operations/mrt/env-var.js +0 -231
  451. package/dist/cjs/operations/mrt/env-var.js.map +0 -1
  452. package/dist/cjs/operations/mrt/env.d.ts +0 -491
  453. package/dist/cjs/operations/mrt/env.js +0 -425
  454. package/dist/cjs/operations/mrt/env.js.map +0 -1
  455. package/dist/cjs/operations/mrt/index.d.ts +0 -75
  456. package/dist/cjs/operations/mrt/index.js +0 -81
  457. package/dist/cjs/operations/mrt/index.js.map +0 -1
  458. package/dist/cjs/operations/mrt/member.d.ts +0 -281
  459. package/dist/cjs/operations/mrt/member.js +0 -244
  460. package/dist/cjs/operations/mrt/member.js.map +0 -1
  461. package/dist/cjs/operations/mrt/notification.d.ts +0 -252
  462. package/dist/cjs/operations/mrt/notification.js +0 -206
  463. package/dist/cjs/operations/mrt/notification.js.map +0 -1
  464. package/dist/cjs/operations/mrt/organization-member.d.ts +0 -68
  465. package/dist/cjs/operations/mrt/organization-member.js +0 -88
  466. package/dist/cjs/operations/mrt/organization-member.js.map +0 -1
  467. package/dist/cjs/operations/mrt/organization.d.ts +0 -80
  468. package/dist/cjs/operations/mrt/organization.js +0 -53
  469. package/dist/cjs/operations/mrt/organization.js.map +0 -1
  470. package/dist/cjs/operations/mrt/project.d.ts +0 -261
  471. package/dist/cjs/operations/mrt/project.js +0 -232
  472. package/dist/cjs/operations/mrt/project.js.map +0 -1
  473. package/dist/cjs/operations/mrt/push.d.ts +0 -290
  474. package/dist/cjs/operations/mrt/push.js +0 -288
  475. package/dist/cjs/operations/mrt/push.js.map +0 -1
  476. package/dist/cjs/operations/mrt/redirect.d.ts +0 -337
  477. package/dist/cjs/operations/mrt/redirect.js +0 -256
  478. package/dist/cjs/operations/mrt/redirect.js.map +0 -1
  479. package/dist/cjs/operations/mrt/tail-logs.d.ts +0 -130
  480. package/dist/cjs/operations/mrt/tail-logs.js +0 -224
  481. package/dist/cjs/operations/mrt/tail-logs.js.map +0 -1
  482. package/dist/cjs/operations/mrt/user.d.ts +0 -135
  483. package/dist/cjs/operations/mrt/user.js +0 -153
  484. package/dist/cjs/operations/mrt/user.js.map +0 -1
  485. package/dist/cjs/operations/ods/index.d.ts +0 -10
  486. package/dist/cjs/operations/ods/index.js +0 -14
  487. package/dist/cjs/operations/ods/index.js.map +0 -1
  488. package/dist/cjs/operations/ods/sandbox-lookup.d.ts +0 -63
  489. package/dist/cjs/operations/ods/sandbox-lookup.js +0 -130
  490. package/dist/cjs/operations/ods/sandbox-lookup.js.map +0 -1
  491. package/dist/cjs/operations/ods/wait-for-clone.d.ts +0 -46
  492. package/dist/cjs/operations/ods/wait-for-clone.js +0 -100
  493. package/dist/cjs/operations/ods/wait-for-clone.js.map +0 -1
  494. package/dist/cjs/operations/ods/wait-for-sandbox.d.ts +0 -64
  495. package/dist/cjs/operations/ods/wait-for-sandbox.js +0 -114
  496. package/dist/cjs/operations/ods/wait-for-sandbox.js.map +0 -1
  497. package/dist/cjs/operations/orgs/index.d.ts +0 -74
  498. package/dist/cjs/operations/orgs/index.js +0 -33
  499. package/dist/cjs/operations/orgs/index.js.map +0 -1
  500. package/dist/cjs/operations/roles/index.d.ts +0 -43
  501. package/dist/cjs/operations/roles/index.js +0 -48
  502. package/dist/cjs/operations/roles/index.js.map +0 -1
  503. package/dist/cjs/operations/sites/cartridges.d.ts +0 -114
  504. package/dist/cjs/operations/sites/cartridges.js +0 -378
  505. package/dist/cjs/operations/sites/cartridges.js.map +0 -1
  506. package/dist/cjs/operations/sites/index.d.ts +0 -46
  507. package/dist/cjs/operations/sites/index.js +0 -51
  508. package/dist/cjs/operations/sites/index.js.map +0 -1
  509. package/dist/cjs/operations/users/index.d.ts +0 -153
  510. package/dist/cjs/operations/users/index.js +0 -139
  511. package/dist/cjs/operations/users/index.js.map +0 -1
  512. package/dist/cjs/operations/util/zip.d.ts +0 -5
  513. package/dist/cjs/operations/util/zip.js +0 -25
  514. package/dist/cjs/operations/util/zip.js.map +0 -1
  515. package/dist/cjs/package.json +0 -1
  516. package/dist/cjs/plugins/discovery.d.ts +0 -46
  517. package/dist/cjs/plugins/discovery.js +0 -122
  518. package/dist/cjs/plugins/discovery.js.map +0 -1
  519. package/dist/cjs/plugins/index.d.ts +0 -26
  520. package/dist/cjs/plugins/index.js +0 -32
  521. package/dist/cjs/plugins/index.js.map +0 -1
  522. package/dist/cjs/plugins/loader.d.ts +0 -34
  523. package/dist/cjs/plugins/loader.js +0 -59
  524. package/dist/cjs/plugins/loader.js.map +0 -1
  525. package/dist/cjs/plugins/manager.d.ts +0 -70
  526. package/dist/cjs/plugins/manager.js +0 -173
  527. package/dist/cjs/plugins/manager.js.map +0 -1
  528. package/dist/cjs/safety/index.d.ts +0 -12
  529. package/dist/cjs/safety/index.js +0 -11
  530. package/dist/cjs/safety/index.js.map +0 -1
  531. package/dist/cjs/safety/safety-guard.d.ts +0 -92
  532. package/dist/cjs/safety/safety-guard.js +0 -270
  533. package/dist/cjs/safety/safety-guard.js.map +0 -1
  534. package/dist/cjs/safety/safety-middleware.d.ts +0 -130
  535. package/dist/cjs/safety/safety-middleware.js +0 -248
  536. package/dist/cjs/safety/safety-middleware.js.map +0 -1
  537. package/dist/cjs/safety/types.d.ts +0 -81
  538. package/dist/cjs/safety/types.js +0 -16
  539. package/dist/cjs/safety/types.js.map +0 -1
  540. package/dist/cjs/safety/with-confirmation.d.ts +0 -58
  541. package/dist/cjs/safety/with-confirmation.js +0 -67
  542. package/dist/cjs/safety/with-confirmation.js.map +0 -1
  543. package/dist/cjs/scaffold/engine.d.ts +0 -68
  544. package/dist/cjs/scaffold/engine.js +0 -149
  545. package/dist/cjs/scaffold/engine.js.map +0 -1
  546. package/dist/cjs/scaffold/executor.d.ts +0 -36
  547. package/dist/cjs/scaffold/executor.js +0 -293
  548. package/dist/cjs/scaffold/executor.js.map +0 -1
  549. package/dist/cjs/scaffold/index.d.ts +0 -76
  550. package/dist/cjs/scaffold/index.js +0 -23
  551. package/dist/cjs/scaffold/index.js.map +0 -1
  552. package/dist/cjs/scaffold/merge.d.ts +0 -63
  553. package/dist/cjs/scaffold/merge.js +0 -192
  554. package/dist/cjs/scaffold/merge.js.map +0 -1
  555. package/dist/cjs/scaffold/parameter-resolver.d.ts +0 -86
  556. package/dist/cjs/scaffold/parameter-resolver.js +0 -191
  557. package/dist/cjs/scaffold/parameter-resolver.js.map +0 -1
  558. package/dist/cjs/scaffold/registry.d.ts +0 -60
  559. package/dist/cjs/scaffold/registry.js +0 -225
  560. package/dist/cjs/scaffold/registry.js.map +0 -1
  561. package/dist/cjs/scaffold/sources.d.ts +0 -83
  562. package/dist/cjs/scaffold/sources.js +0 -236
  563. package/dist/cjs/scaffold/sources.js.map +0 -1
  564. package/dist/cjs/scaffold/types.d.ts +0 -282
  565. package/dist/cjs/scaffold/types.js +0 -14
  566. package/dist/cjs/scaffold/types.js.map +0 -1
  567. package/dist/cjs/scaffold/validation.d.ts +0 -81
  568. package/dist/cjs/scaffold/validation.js +0 -250
  569. package/dist/cjs/scaffold/validation.js.map +0 -1
  570. package/dist/cjs/scaffold/validators.d.ts +0 -33
  571. package/dist/cjs/scaffold/validators.js +0 -340
  572. package/dist/cjs/scaffold/validators.js.map +0 -1
  573. package/dist/cjs/schemas/collapse.d.ts +0 -150
  574. package/dist/cjs/schemas/collapse.js +0 -180
  575. package/dist/cjs/schemas/collapse.js.map +0 -1
  576. package/dist/cjs/schemas/index.d.ts +0 -58
  577. package/dist/cjs/schemas/index.js +0 -65
  578. package/dist/cjs/schemas/index.js.map +0 -1
  579. package/dist/cjs/schemas/security-schemes.d.ts +0 -26
  580. package/dist/cjs/schemas/security-schemes.js +0 -44
  581. package/dist/cjs/schemas/security-schemes.js.map +0 -1
  582. package/dist/cjs/skills/agents.d.ts +0 -42
  583. package/dist/cjs/skills/agents.js +0 -200
  584. package/dist/cjs/skills/agents.js.map +0 -1
  585. package/dist/cjs/skills/github.d.ts +0 -31
  586. package/dist/cjs/skills/github.js +0 -450
  587. package/dist/cjs/skills/github.js.map +0 -1
  588. package/dist/cjs/skills/index.d.ts +0 -43
  589. package/dist/cjs/skills/index.js +0 -16
  590. package/dist/cjs/skills/index.js.map +0 -1
  591. package/dist/cjs/skills/installer.d.ts +0 -35
  592. package/dist/cjs/skills/installer.js +0 -182
  593. package/dist/cjs/skills/installer.js.map +0 -1
  594. package/dist/cjs/skills/parser.d.ts +0 -39
  595. package/dist/cjs/skills/parser.js +0 -126
  596. package/dist/cjs/skills/parser.js.map +0 -1
  597. package/dist/cjs/skills/sources.d.ts +0 -4
  598. package/dist/cjs/skills/sources.js +0 -52
  599. package/dist/cjs/skills/sources.js.map +0 -1
  600. package/dist/cjs/skills/types.d.ts +0 -153
  601. package/dist/cjs/skills/types.js +0 -7
  602. package/dist/cjs/skills/types.js.map +0 -1
  603. package/dist/cjs/slas/index.d.ts +0 -12
  604. package/dist/cjs/slas/index.js +0 -8
  605. package/dist/cjs/slas/index.js.map +0 -1
  606. package/dist/cjs/slas/pkce.d.ts +0 -13
  607. package/dist/cjs/slas/pkce.js +0 -35
  608. package/dist/cjs/slas/pkce.js.map +0 -1
  609. package/dist/cjs/slas/token.d.ts +0 -24
  610. package/dist/cjs/slas/token.js +0 -261
  611. package/dist/cjs/slas/token.js.map +0 -1
  612. package/dist/cjs/slas/types.d.ts +0 -43
  613. package/dist/cjs/slas/types.js +0 -7
  614. package/dist/cjs/slas/types.js.map +0 -1
  615. package/dist/cjs/telemetry/index.d.ts +0 -34
  616. package/dist/cjs/telemetry/index.js +0 -32
  617. package/dist/cjs/telemetry/index.js.map +0 -1
  618. package/dist/cjs/telemetry/telemetry.d.ts +0 -88
  619. package/dist/cjs/telemetry/telemetry.js +0 -298
  620. package/dist/cjs/telemetry/telemetry.js.map +0 -1
  621. package/dist/cjs/telemetry/types.d.ts +0 -62
  622. package/dist/cjs/telemetry/types.js +0 -7
  623. package/dist/cjs/telemetry/types.js.map +0 -1
  624. package/dist/cjs/test-utils/config-isolation.d.ts +0 -2
  625. package/dist/cjs/test-utils/config-isolation.js +0 -48
  626. package/dist/cjs/test-utils/config-isolation.js.map +0 -1
  627. package/dist/cjs/test-utils/index.d.ts +0 -1
  628. package/dist/cjs/test-utils/index.js +0 -7
  629. package/dist/cjs/test-utils/index.js.map +0 -1
  630. package/dist/cjs/ux/confirm.d.ts +0 -14
  631. package/dist/cjs/ux/confirm.js +0 -36
  632. package/dist/cjs/ux/confirm.js.map +0 -1
  633. package/dist/cjs/ux/index.d.ts +0 -1
  634. package/dist/cjs/ux/index.js +0 -7
  635. package/dist/cjs/ux/index.js.map +0 -1
  636. package/dist/cjs/version.d.ts +0 -14
  637. package/dist/cjs/version.js +0 -29
  638. package/dist/cjs/version.js.map +0 -1
@@ -1,3806 +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
- "/api/organizations/": {
7
- parameters: {
8
- query?: never;
9
- header?: never;
10
- path?: never;
11
- cookie?: never;
12
- };
13
- /** @description List organizations. */
14
- get: operations["organizations_list"];
15
- put?: never;
16
- post?: never;
17
- delete?: never;
18
- options?: never;
19
- head?: never;
20
- patch?: never;
21
- trace?: never;
22
- };
23
- "/api/organizations/{organization_slug}/certificates/": {
24
- parameters: {
25
- query?: never;
26
- header?: never;
27
- path?: never;
28
- cookie?: never;
29
- };
30
- /** @description List certificates for an organization with filtering and search */
31
- get: operations["organizations_certificates_list"];
32
- put?: never;
33
- /** @description Create a new certificate for an organization */
34
- post: operations["organizations_certificates_create"];
35
- delete?: never;
36
- options?: never;
37
- head?: never;
38
- patch?: never;
39
- trace?: never;
40
- };
41
- "/api/organizations/{organization_slug}/certificates/{cert_id}/": {
42
- parameters: {
43
- query?: never;
44
- header?: never;
45
- path?: never;
46
- cookie?: never;
47
- };
48
- /** @description Retrieve a specific certificate for an organization */
49
- get: operations["organizations_certificates_retrieve"];
50
- put?: never;
51
- post?: never;
52
- /** @description Delete a specific certificate for an organization */
53
- delete: operations["organizations_certificates_destroy"];
54
- options?: never;
55
- head?: never;
56
- patch?: never;
57
- trace?: never;
58
- };
59
- "/api/organizations/{organization_slug}/certificates/{cert_id}/restart-validation/": {
60
- parameters: {
61
- query?: never;
62
- header?: never;
63
- path?: never;
64
- cookie?: never;
65
- };
66
- get?: never;
67
- /** @description Restart validation for a certificate. Creates a new certificate in AWS and updates the existing certificate record. Only works for certificates that are not yet validated. */
68
- put: operations["organizations_certificates_restart_validation_update"];
69
- post?: never;
70
- delete?: never;
71
- options?: never;
72
- head?: never;
73
- /** @description Restart validation for a specific certificate for an organization. */
74
- patch: operations["organizations_certificates_restart_validation_partial_update"];
75
- trace?: never;
76
- };
77
- "/api/organizations/{organization_slug}/members/": {
78
- parameters: {
79
- query?: never;
80
- header?: never;
81
- path?: never;
82
- cookie?: never;
83
- };
84
- /** @description List all the members of an organization. */
85
- get: operations["list_organization_members"];
86
- put?: never;
87
- /** @description Add a new member to an organization. */
88
- post: operations["organizations_members_create"];
89
- delete?: never;
90
- options?: never;
91
- head?: never;
92
- patch?: never;
93
- trace?: never;
94
- };
95
- "/api/organizations/{organization_slug}/members/{email}/": {
96
- parameters: {
97
- query?: never;
98
- header?: never;
99
- path?: never;
100
- cookie?: never;
101
- };
102
- /** @description Read data about an organization member's permissions. */
103
- get: operations["organizations_members_retrieve"];
104
- put?: never;
105
- post?: never;
106
- /** @description Remove a member from an organization. */
107
- delete: operations["organizations_members_destroy"];
108
- options?: never;
109
- head?: never;
110
- /** @description Update an organization member's permissions. */
111
- patch: operations["organizations_members_partial_update"];
112
- trace?: never;
113
- };
114
- "/api/projects/": {
115
- parameters: {
116
- query?: never;
117
- header?: never;
118
- path?: never;
119
- cookie?: never;
120
- };
121
- /** @description List projects. */
122
- get: operations["projects_list"];
123
- put?: never;
124
- /** @description Create a project. */
125
- post: operations["projects_create"];
126
- delete?: never;
127
- options?: never;
128
- head?: never;
129
- patch?: never;
130
- trace?: never;
131
- };
132
- "/api/projects/{project_slug}/": {
133
- parameters: {
134
- query?: never;
135
- header?: never;
136
- path?: never;
137
- cookie?: never;
138
- };
139
- /** @description Read data about a project. */
140
- get: operations["projects_retrieve"];
141
- put?: never;
142
- post?: never;
143
- /** @description Delete a project. */
144
- delete: operations["projects_destroy"];
145
- options?: never;
146
- head?: never;
147
- /** @description Update a project. */
148
- patch: operations["projects_partial_update"];
149
- trace?: never;
150
- };
151
- "/api/projects/{project_slug}/builds/": {
152
- parameters: {
153
- query?: never;
154
- header?: never;
155
- path?: never;
156
- cookie?: never;
157
- };
158
- get?: never;
159
- put?: never;
160
- /** @description Upload a bundle. */
161
- post: operations["projects_builds_create"];
162
- delete?: never;
163
- options?: never;
164
- head?: never;
165
- patch?: never;
166
- trace?: never;
167
- };
168
- "/api/projects/{project_slug}/builds/{target_slug}/": {
169
- parameters: {
170
- query?: never;
171
- header?: never;
172
- path?: never;
173
- cookie?: never;
174
- };
175
- get?: never;
176
- put?: never;
177
- /** @description Upload a bundle and deploy it to an environment asynchronously. */
178
- post: operations["projects_builds_create_and_deploy"];
179
- delete?: never;
180
- options?: never;
181
- head?: never;
182
- patch?: never;
183
- trace?: never;
184
- };
185
- "/api/projects/{project_slug}/bundles/": {
186
- parameters: {
187
- query?: never;
188
- header?: never;
189
- path?: never;
190
- cookie?: never;
191
- };
192
- /** @description List bundles of a project */
193
- get: operations["projects_bundles_list"];
194
- put?: never;
195
- post?: never;
196
- delete?: never;
197
- options?: never;
198
- head?: never;
199
- patch?: never;
200
- trace?: never;
201
- };
202
- "/api/projects/{project_slug}/bundles/{bundle_id}/": {
203
- parameters: {
204
- query?: never;
205
- header?: never;
206
- path?: never;
207
- cookie?: never;
208
- };
209
- get?: never;
210
- put?: never;
211
- post?: never;
212
- /** @description Request deletion of a bundle. The bundle will be asynchronously deleted. This operation can only be performed by project admins. */
213
- delete: operations["projects_bundles_destroy"];
214
- options?: never;
215
- head?: never;
216
- patch?: never;
217
- trace?: never;
218
- };
219
- "/api/projects/{project_slug}/bundles/{bundle_id}/download/": {
220
- parameters: {
221
- query?: never;
222
- header?: never;
223
- path?: never;
224
- cookie?: never;
225
- };
226
- /** @description Get a presigned URL (active for one hour) to download a bundle archive. */
227
- get: operations["projects_bundles_download_retrieve"];
228
- put?: never;
229
- post?: never;
230
- delete?: never;
231
- options?: never;
232
- head?: never;
233
- patch?: never;
234
- trace?: never;
235
- };
236
- "/api/projects/{project_slug}/bundles/bulk-delete/": {
237
- parameters: {
238
- query?: never;
239
- header?: never;
240
- path?: never;
241
- cookie?: never;
242
- };
243
- get?: never;
244
- put?: never;
245
- /** @description Request deletion for multiple bundles. Bundles are deleted asynchronously. Only project admins can perform this call. The response indicates which bundles were successfully queued for deletion and which failed validation. */
246
- post: operations["projects_bundles_bulk_delete_create"];
247
- delete?: never;
248
- options?: never;
249
- head?: never;
250
- patch?: never;
251
- trace?: never;
252
- };
253
- "/api/projects/{project_slug}/members/": {
254
- parameters: {
255
- query?: never;
256
- header?: never;
257
- path?: never;
258
- cookie?: never;
259
- };
260
- /** @description List a project's members. */
261
- get: operations["projects_members_list"];
262
- put?: never;
263
- /** @description Create a new project member. */
264
- post: operations["projects_members_create"];
265
- delete?: never;
266
- options?: never;
267
- head?: never;
268
- patch?: never;
269
- trace?: never;
270
- };
271
- "/api/projects/{project_slug}/members/{email}/": {
272
- parameters: {
273
- query?: never;
274
- header?: never;
275
- path?: never;
276
- cookie?: never;
277
- };
278
- /** @description Read data about a project member's permissions. */
279
- get: operations["projects_members_retrieve"];
280
- put?: never;
281
- post?: never;
282
- /** @description Delete a project member. */
283
- delete: operations["projects_members_destroy"];
284
- options?: never;
285
- head?: never;
286
- /** @description Update a project member's permissions. */
287
- patch: operations["projects_members_partial_update"];
288
- trace?: never;
289
- };
290
- "/api/projects/{project_slug}/notifications/": {
291
- parameters: {
292
- query?: never;
293
- header?: never;
294
- path?: never;
295
- cookie?: never;
296
- };
297
- /** @description List notifications for a project */
298
- get: operations["projects_notifications_list"];
299
- put?: never;
300
- /** @description Create notification for a Project */
301
- post: operations["projects_notifications_create"];
302
- delete?: never;
303
- options?: never;
304
- head?: never;
305
- patch?: never;
306
- trace?: never;
307
- };
308
- "/api/projects/{project_slug}/notifications/{id}/": {
309
- parameters: {
310
- query?: never;
311
- header?: never;
312
- path?: never;
313
- cookie?: never;
314
- };
315
- /** @description Read data about a notification. */
316
- get: operations["projects_notifications_retrieve"];
317
- put?: never;
318
- post?: never;
319
- /** @description Delete a notification. */
320
- delete: operations["projects_notifications_destroy"];
321
- options?: never;
322
- head?: never;
323
- /** @description Update a project's notification. */
324
- patch: operations["projects_notifications_partial_update"];
325
- trace?: never;
326
- };
327
- "/api/projects/{project_slug}/target/": {
328
- parameters: {
329
- query?: never;
330
- header?: never;
331
- path?: never;
332
- cookie?: never;
333
- };
334
- /** @description List a project's targets. */
335
- get: operations["projects_target_list"];
336
- put?: never;
337
- /** @description Create a new target. */
338
- post: operations["projects_target_create"];
339
- delete?: never;
340
- options?: never;
341
- head?: never;
342
- patch?: never;
343
- trace?: never;
344
- };
345
- "/api/projects/{project_slug}/target/{target_slug}/": {
346
- parameters: {
347
- query?: never;
348
- header?: never;
349
- path?: never;
350
- cookie?: never;
351
- };
352
- /** @description Read data about a target. */
353
- get: operations["projects_target_retrieve"];
354
- put?: never;
355
- post?: never;
356
- /** @description Delete a target. */
357
- delete: operations["projects_target_destroy"];
358
- options?: never;
359
- head?: never;
360
- /** @description Update a target. Important: This endpoint automatically re-deploys the current bundle if any of the SSR-related properties are changed. */
361
- patch: operations["projects_target_partial_update"];
362
- trace?: never;
363
- };
364
- "/api/projects/{project_slug}/target/{target_slug}/access-control-header/": {
365
- parameters: {
366
- query?: never;
367
- header?: never;
368
- path?: never;
369
- cookie?: never;
370
- };
371
- /** @description List a target's access control headers. */
372
- get: operations["projects_target_access_control_header_list"];
373
- put?: never;
374
- /** @description Create an access control header to restrict access to an environment so that only trusted traffic coming from your content delivery network (CDN) or development team is allowed. Requests to this environment must contain the header `x-sfdc-access-control` with the value provided or they will be rejected. Accepts an object with a value for a single access control header. See [Access Control Headers](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/managed-runtime-administration.html?q=access%20control%20header#access-control-headers). */
375
- post: operations["projects_target_access_control_header_create"];
376
- delete?: never;
377
- options?: never;
378
- head?: never;
379
- patch?: never;
380
- trace?: never;
381
- };
382
- "/api/projects/{project_slug}/target/{target_slug}/access-control-header/{id}/": {
383
- parameters: {
384
- query?: never;
385
- header?: never;
386
- path?: never;
387
- cookie?: never;
388
- };
389
- /** @description Read data about an access control header by its id. */
390
- get: operations["projects_target_access_control_header_retrieve"];
391
- put?: never;
392
- post?: never;
393
- /** @description Delete an access control header by its id. */
394
- delete: operations["projects_target_access_control_header_destroy"];
395
- options?: never;
396
- head?: never;
397
- patch?: never;
398
- trace?: never;
399
- };
400
- "/api/projects/{project_slug}/target/{target_slug}/clone/": {
401
- parameters: {
402
- query?: never;
403
- header?: never;
404
- path?: never;
405
- cookie?: never;
406
- };
407
- get?: never;
408
- put?: never;
409
- /** @description Clone a target from another target in the same project. This creates a new target with the same configuration as the source target, excluding proxies and production flag. Optionally clones redirects and environment variables. The new target will be automatically deployed with the same bundle as the source target's current deployment (if source has a deployed bundle) or with a reset bundle. */
410
- post: operations["projects_target_clone_create"];
411
- delete?: never;
412
- options?: never;
413
- head?: never;
414
- patch?: never;
415
- trace?: never;
416
- };
417
- "/api/projects/{project_slug}/target/{target_slug}/deploy/": {
418
- parameters: {
419
- query?: never;
420
- header?: never;
421
- path?: never;
422
- cookie?: never;
423
- };
424
- /** @description Get the deployment history of a target. */
425
- get: operations["projects_target_deploy_list"];
426
- put?: never;
427
- /** @description Deploys a bundle to a target. Returns the status of the deploy. Deployment details are not immediately available in the response as this endpoint is asynchronous. Request the target for progress updates. */
428
- post: operations["projects_target_deploy_create"];
429
- delete?: never;
430
- options?: never;
431
- head?: never;
432
- patch?: never;
433
- trace?: never;
434
- };
435
- "/api/projects/{project_slug}/target/{target_slug}/env-var/": {
436
- parameters: {
437
- query?: never;
438
- header?: never;
439
- path?: never;
440
- cookie?: never;
441
- };
442
- /** @description List a target's environment variables. */
443
- get: operations["projects_target_env_var_list"];
444
- put?: never;
445
- post?: never;
446
- delete?: never;
447
- options?: never;
448
- head?: never;
449
- /** @description Create, update, or delete environment variables. Accepts an object with values for single or multiple environment variables. If the variable does not exist, it is created. If the variable exists, it is updated. And if the variable exists and the value is null, it is deleted. */
450
- patch: operations["projects_target_env_var_partial_update"];
451
- trace?: never;
452
- };
453
- "/api/projects/{project_slug}/target/{target_slug}/invalidation/": {
454
- parameters: {
455
- query?: never;
456
- header?: never;
457
- path?: never;
458
- cookie?: never;
459
- };
460
- get?: never;
461
- put?: never;
462
- /** @description Invalidate a target's cached objects in the CDN. Cache invalidations are asynchronous and usually complete within two minutes. */
463
- post: operations["projects_target_invalidation_create"];
464
- delete?: never;
465
- options?: never;
466
- head?: never;
467
- patch?: never;
468
- trace?: never;
469
- };
470
- "/api/projects/{project_slug}/target/{target_slug}/redirect/": {
471
- parameters: {
472
- query?: never;
473
- header?: never;
474
- path?: never;
475
- cookie?: never;
476
- };
477
- /** @description List a target's redirects. See [Redirects](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/managed-runtime-administration.html#redirects). */
478
- get: operations["projects_target_redirect_list"];
479
- put?: never;
480
- /** @description Create one or more redirects. This endpoint accepts either an object with values for a single redirect, or an array of objects for bulk creation. For example, consider a seasonal campaign page for spring. When the spring campaign ends and is replaced with a summer campaign, you can redirect from the spring URL to the summer URL. We recommend that you always create redirects in your staging target (environment) and then [clone](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/references/mrt-admin?meta=projects_target_redirect_clone_create) them to your production target. This allows you to test the redirects and verify that they work as expected. Changes may take up to 20 minutes to take effect on your site. See [Redirects](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/managed-runtime-administration.html#redirects). */
481
- post: operations["projects_target_redirect_create"];
482
- delete?: never;
483
- options?: never;
484
- head?: never;
485
- patch?: never;
486
- trace?: never;
487
- };
488
- "/api/projects/{project_slug}/target/{target_slug}/redirect/{from_path}": {
489
- parameters: {
490
- query?: never;
491
- header?: never;
492
- path?: never;
493
- cookie?: never;
494
- };
495
- /** @description Read data about a redirect by `from_path`. See [Redirects](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/managed-runtime-administration.html#redirects). */
496
- get: operations["projects_target_redirect_retrieve"];
497
- put?: never;
498
- post?: never;
499
- /** @description Delete a redirect by `from_path`. For example, you can delete a redirect that's no longer needed because a seasonal campaign is over, you removed a page, or you want to streamline your redirect structure and improve search engine ranking. We recommend that you always delete redirects in your staging target (environment), and then [clone](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/references/mrt-admin?meta=projects_target_redirect_clone_create) the changes to your production target. Changes may take up to 20 minutes to take effect on your site. When you delete a redirect, you no longer see it in Runtime Admin. See [Redirects](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/managed-runtime-administration.html#redirects). */
500
- delete: operations["projects_target_redirect_destroy"];
501
- options?: never;
502
- head?: never;
503
- /** @description Update a redirect by `from_path`. For example, you can change a redirect if your content moved or you rebranded with new pages. We recommend that you always change redirects in your staging target (environment), and then [clone](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/references/mrt-admin?meta=projects_target_redirect_clone_create) the changes to your production target. Changes may take up to 20 minutes to take effect on your site. See [Redirects](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/managed-runtime-administration.html#redirects). */
504
- patch: operations["projects_target_redirect_partial_update"];
505
- trace?: never;
506
- };
507
- "/api/projects/{project_slug}/target/{to_target_slug}/redirect/clone/": {
508
- parameters: {
509
- query?: never;
510
- header?: never;
511
- path?: never;
512
- cookie?: never;
513
- };
514
- get?: never;
515
- put?: never;
516
- /** @description Clone redirects from one target to another. Important: when you clone redirects, you're replacing all the redirects in one target with all the redirects in the other. See [Redirects](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/managed-runtime-administration.html#redirects). */
517
- post: operations["projects_target_redirect_clone_create"];
518
- delete?: never;
519
- options?: never;
520
- head?: never;
521
- patch?: never;
522
- trace?: never;
523
- };
524
- "/api/users/me/api_key/": {
525
- parameters: {
526
- query?: never;
527
- header?: never;
528
- path?: never;
529
- cookie?: never;
530
- };
531
- get?: never;
532
- put?: never;
533
- /** @description Generate or reset the API key. */
534
- post: operations["users_me_api_key_create"];
535
- delete?: never;
536
- options?: never;
537
- head?: never;
538
- patch?: never;
539
- trace?: never;
540
- };
541
- "/api/users/me/email-preferences/": {
542
- parameters: {
543
- query?: never;
544
- header?: never;
545
- path?: never;
546
- cookie?: never;
547
- };
548
- /** @description Get email notification preferences for the authenticated user. */
549
- get: operations["users_me_email_preferences_retrieve"];
550
- put?: never;
551
- post?: never;
552
- delete?: never;
553
- options?: never;
554
- head?: never;
555
- /** @description Update email notification preferences for the authenticated user. */
556
- patch: operations["users_me_email_preferences_partial_update"];
557
- trace?: never;
558
- };
559
- "/api/users/me/profile/": {
560
- parameters: {
561
- query?: never;
562
- header?: never;
563
- path?: never;
564
- cookie?: never;
565
- };
566
- /** @description Get the profile information for the authenticated user. */
567
- get: operations["users_me_profile_retrieve"];
568
- put?: never;
569
- post?: never;
570
- delete?: never;
571
- options?: never;
572
- head?: never;
573
- patch?: never;
574
- trace?: never;
575
- };
576
- }
577
- export type webhooks = Record<string, never>;
578
- export interface components {
579
- schemas: {
580
- APIAccessControlHeaderV2Create: {
581
- /**
582
- * Format: uuid
583
- * @description Id for this Access Control Header.
584
- */
585
- readonly id?: string;
586
- /** @description Value to be encrypted. A header value is made up of your chosen set of characters. For the constraints that apply to the value, see [Access Control Headers](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/managed-runtime-administration.html?q=access%20control%20header#access-control-headers). */
587
- value: string;
588
- /**
589
- * Email address
590
- * Format: email
591
- */
592
- readonly user_email?: string;
593
- /**
594
- * Format: date-time
595
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
596
- */
597
- readonly created_at?: string;
598
- readonly publishing_status?: components["schemas"]["Status1d2Enum"];
599
- readonly publishing_status_description?: string;
600
- };
601
- APIOrganization: {
602
- /** Format: uuid */
603
- readonly uuid?: string;
604
- name: string;
605
- slug: string;
606
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
607
- /**
608
- * Format: date-time
609
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
610
- */
611
- readonly created_at?: string;
612
- /**
613
- * Format: date-time
614
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
615
- */
616
- readonly updated_at?: string;
617
- readonly permissions?: {
618
- create_project?: boolean;
619
- };
620
- readonly has_mobify_tag_project?: boolean;
621
- readonly limits?: components["schemas"]["OrganizationLimits"];
622
- readonly auto_delete?: components["schemas"]["OrganizationAutoDelete"];
623
- /** @description Enable SSR architecture selection (x86 or arm64) for this organization */
624
- readonly can_configure_ssr_architecture?: boolean;
625
- };
626
- APIOrganizationMember: {
627
- /**
628
- * Email address
629
- * Format: email
630
- */
631
- readonly user?: string;
632
- readonly email?: string;
633
- role: components["schemas"]["RoleEnum"];
634
- readonly first_name?: string;
635
- readonly last_name?: string;
636
- readonly can_view_all_projects?: boolean;
637
- readonly custom_domain_cert_permission?: components["schemas"]["Status1d2Enum"];
638
- };
639
- /** @description Serializer for creating organization members. */
640
- APIOrganizationMemberCreate: {
641
- /**
642
- * Email address
643
- * Format: email
644
- */
645
- user: string;
646
- role: components["schemas"]["RoleEnum"];
647
- can_view_all_projects?: boolean;
648
- custom_domain_cert_permission?: components["schemas"]["Status1d2Enum"];
649
- };
650
- /**
651
- * @description Serializer for updating organization role permissions.
652
- * Allows updating can_view_all_projects and custom_domain_cert_permission.
653
- */
654
- APIOrganizationMemberUpdate: {
655
- /**
656
- * Email address
657
- * Format: email
658
- */
659
- readonly user?: string;
660
- readonly role?: components["schemas"]["RoleEnum"];
661
- readonly first_name?: string;
662
- readonly last_name?: string;
663
- can_view_all_projects?: boolean;
664
- custom_domain_cert_permission?: components["schemas"]["Status1d2Enum"];
665
- };
666
- APIProjectMember: {
667
- /**
668
- * Email address
669
- * Format: email
670
- */
671
- user: string;
672
- role: {
673
- name?: string;
674
- /** @enum {integer} */
675
- value?: 0 | 1 | 2 | 3;
676
- };
677
- };
678
- APIProjectV2Create: {
679
- /** @description User-friendly name for this project */
680
- name: string;
681
- /** Format: uri */
682
- url?: string;
683
- slug?: string;
684
- organization: string;
685
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
686
- readonly project_type?: components["schemas"]["ProjectTypeEnum"];
687
- readonly permissions?: {
688
- browse?: boolean;
689
- deploy?: boolean;
690
- delete_bundle?: boolean;
691
- delete_project?: boolean;
692
- edit_redirect?: boolean;
693
- edit_roles?: boolean;
694
- edit_settings?: boolean;
695
- validate_tag?: boolean;
696
- edit_environment?: boolean;
697
- create_environment?: boolean;
698
- delete_environment?: boolean;
699
- create_notification?: boolean;
700
- list_notifications?: boolean;
701
- retrieve_notification?: boolean;
702
- edit_notification?: boolean;
703
- delete_notification?: boolean;
704
- create_jwt?: boolean;
705
- upload_bundle?: boolean;
706
- edit_environment_variable?: boolean;
707
- edit_access_control_header?: boolean;
708
- edit_data_access_layer_entry?: boolean;
709
- };
710
- /**
711
- * SSR AWS Region
712
- * @description The default AWS region for newly created targets
713
- *
714
- * * `us-east-1` - US East (N. Virginia)
715
- * * `us-east-2` - US East (Ohio)
716
- * * `us-west-1` - US West (N. California)
717
- * * `us-west-2` - US West (Oregon)
718
- * * `ap-south-1` - Asia Pacific (Mumbai)
719
- * * `ap-south-2` - Asia Pacific (Hyderabad)
720
- * * `ap-northeast-2` - Asia Pacific (Seoul)
721
- * * `ap-southeast-1` - Asia Pacific (Singapore)
722
- * * `ap-southeast-2` - Asia Pacific (Sydney)
723
- * * `ap-southeast-3` - Asia Pacific (Jakarta)
724
- * * `ap-northeast-1` - Asia Pacific (Tokyo)
725
- * * `ap-northeast-3` - Asia Pacific (Osaka)
726
- * * `ca-central-1` - Canada (Central)
727
- * * `eu-central-1` - EU (Frankfurt)
728
- * * `eu-central-2` - EU (Zurich)
729
- * * `eu-west-1` - EU (Ireland)
730
- * * `eu-west-2` - EU (London)
731
- * * `eu-west-3` - EU (Paris)
732
- * * `eu-north-1` - EU (Stockholm)
733
- * * `eu-south-1` - EU (Milan)
734
- * * `il-central-1` - Israel (Tel Aviv)
735
- * * `me-central-1` - Middle East (UAE)
736
- * * `sa-east-1` - South America (Sao Paulo)
737
- */
738
- ssr_region?: components["schemas"]["SsrRegionEnum"];
739
- /**
740
- * @description Default Server-Side Rendering architecture (x86 or arm64) for targets under this project.
741
- *
742
- * * `x86` - x86
743
- * * `arm64` - ARM64
744
- */
745
- ssr_architecture?: (components["schemas"]["SsrArchitectureEnum"] | components["schemas"]["NullEnum"]) | null;
746
- /**
747
- * Format: date-time
748
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
749
- */
750
- readonly created_at?: string;
751
- /**
752
- * Format: date-time
753
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
754
- */
755
- readonly updated_at?: string;
756
- /**
757
- * @description Source of the project. One of: ecom, core, direct.
758
- *
759
- * * `ecom` - ecom
760
- * * `core` - core
761
- * * `direct` - direct
762
- */
763
- readonly source?: (components["schemas"]["SourceEnum"] | components["schemas"]["NullEnum"]) | null;
764
- };
765
- APIProjectV2Update: {
766
- /** @description User-friendly name for this project */
767
- name: string;
768
- /** Format: uri */
769
- url?: string;
770
- readonly slug?: string;
771
- /** @description User-friendly identifier for this instance. */
772
- organization?: string;
773
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
774
- readonly project_type?: components["schemas"]["ProjectTypeEnum"];
775
- readonly permissions?: {
776
- browse?: boolean;
777
- deploy?: boolean;
778
- delete_bundle?: boolean;
779
- delete_project?: boolean;
780
- edit_redirect?: boolean;
781
- edit_roles?: boolean;
782
- edit_settings?: boolean;
783
- validate_tag?: boolean;
784
- edit_environment?: boolean;
785
- create_environment?: boolean;
786
- delete_environment?: boolean;
787
- create_notification?: boolean;
788
- list_notifications?: boolean;
789
- retrieve_notification?: boolean;
790
- edit_notification?: boolean;
791
- delete_notification?: boolean;
792
- create_jwt?: boolean;
793
- upload_bundle?: boolean;
794
- edit_environment_variable?: boolean;
795
- edit_access_control_header?: boolean;
796
- edit_data_access_layer_entry?: boolean;
797
- };
798
- /**
799
- * SSR AWS Region
800
- * @description The default AWS region for newly created targets
801
- *
802
- * * `us-east-1` - US East (N. Virginia)
803
- * * `us-east-2` - US East (Ohio)
804
- * * `us-west-1` - US West (N. California)
805
- * * `us-west-2` - US West (Oregon)
806
- * * `ap-south-1` - Asia Pacific (Mumbai)
807
- * * `ap-south-2` - Asia Pacific (Hyderabad)
808
- * * `ap-northeast-2` - Asia Pacific (Seoul)
809
- * * `ap-southeast-1` - Asia Pacific (Singapore)
810
- * * `ap-southeast-2` - Asia Pacific (Sydney)
811
- * * `ap-southeast-3` - Asia Pacific (Jakarta)
812
- * * `ap-northeast-1` - Asia Pacific (Tokyo)
813
- * * `ap-northeast-3` - Asia Pacific (Osaka)
814
- * * `ca-central-1` - Canada (Central)
815
- * * `eu-central-1` - EU (Frankfurt)
816
- * * `eu-central-2` - EU (Zurich)
817
- * * `eu-west-1` - EU (Ireland)
818
- * * `eu-west-2` - EU (London)
819
- * * `eu-west-3` - EU (Paris)
820
- * * `eu-north-1` - EU (Stockholm)
821
- * * `eu-south-1` - EU (Milan)
822
- * * `il-central-1` - Israel (Tel Aviv)
823
- * * `me-central-1` - Middle East (UAE)
824
- * * `sa-east-1` - South America (Sao Paulo)
825
- */
826
- ssr_region?: components["schemas"]["SsrRegionEnum"];
827
- /**
828
- * @description Default Server-Side Rendering architecture (x86 or arm64) for targets under this project.
829
- *
830
- * * `x86` - x86
831
- * * `arm64` - ARM64
832
- */
833
- ssr_architecture?: (components["schemas"]["SsrArchitectureEnum"] | components["schemas"]["NullEnum"]) | null;
834
- /**
835
- * Format: date-time
836
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
837
- */
838
- readonly created_at?: string;
839
- /**
840
- * Format: date-time
841
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
842
- */
843
- readonly updated_at?: string;
844
- /**
845
- * @description Source of the project. One of: ecom, core, direct.
846
- *
847
- * * `ecom` - ecom
848
- * * `core` - core
849
- * * `direct` - direct
850
- */
851
- readonly source?: (components["schemas"]["SourceEnum"] | components["schemas"]["NullEnum"]) | null;
852
- };
853
- APIRedirectV2Clone: {
854
- from_target_slug: string;
855
- };
856
- APIRedirectV2CreateUpdate: {
857
- /** @description A relative URL. For example, the `from_path` value `/spring` redirects shoppers from the URL `www.example.com/spring`. An asterisk (`*`) at the end of the `from_path` indicates a wildcard. For example, a redirect from `/a/*` matches `/a/`, `/a/b`, and `/a/b/c`. */
858
- from_path: string;
859
- /** @description A relative or absolute URL. For example, the `to_url` value `/summer` redirects shoppers to the URL `www.example.com/summer`. */
860
- to_url: string;
861
- /** @description Some requests contain query string parameters to include in the redirected request. For example, the relative path `/spring-landing-page` can be appended with a query string for analytics tracking, such as `/spring-landing-page?gclid=123`. The `true` value includes query string parameters in the redirect. The `false` value excludes query string parameters from the redirect. The default value is `false`. */
862
- forward_querystring?: boolean | null;
863
- /** @description The `true` value automatically includes any path that comes after the wildcard portion of the `from_path` in the `to_url`. For example: if `/a/*` matches `/a/b/c` in the `from_path` and the `to_url` is `/z/`, the redirect URL is `/z/b/c`. The `false` value excludes the wildcard portion. The default value is `false`. */
864
- forward_wildcard?: boolean | null;
865
- /**
866
- * @description The HTTP status code to be returned in the response. 301 (Moved Permanently) is the recommended and default value. 302 (Found or Moved Temporarily) is another allowable value. For more information about HTTP status codes, see this [status code explainer](https://moz.com/learn/seo/redirection).
867
- *
868
- * * `301` - Permanent 301
869
- * * `302` - Temporary 302
870
- */
871
- http_status_code?: components["schemas"]["HttpStatusCodeEnum"];
872
- /** @description The status of the redeployment that happens after you call this API. Allowable values: Pending, Completed, Failed. If the request failed, you can [redeploy the environment](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/pushing-and-deploying-bundles.html) specified in your request. */
873
- readonly publishing_status?: string;
874
- /**
875
- * Email address
876
- * Format: email
877
- * @description Email of the user who created the redirect.
878
- */
879
- readonly user_email?: string;
880
- /**
881
- * Format: date-time
882
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
883
- */
884
- readonly created_at?: string;
885
- /**
886
- * Format: date-time
887
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
888
- */
889
- readonly updated_at?: string;
890
- /**
891
- * Email address
892
- * Format: email
893
- * @description Email of the user who last updated the redirect.
894
- */
895
- readonly updated_by?: string;
896
- };
897
- /**
898
- * @description Serializer for target cloning request.
899
- * Inherits from APITargetV2BaseSerializer to reuse validation helper methods.
900
- */
901
- APITargetV2Clone: {
902
- /** @description The slug of the target to clone from. */
903
- from_target_slug: string;
904
- /** @description Full hostname to be used by the cloned environment. Required when using non-MRT managed certificate. */
905
- ssr_external_hostname?: string | null;
906
- /** @description The domain to be used for a Universal PWA SSR deployment (e.g. customer.com). If not provided and hostname is provided, will be extracted from hostname. */
907
- ssr_external_domain?: string | null;
908
- /** @description The ID of the certificate to associate with the cloned target's custom domain. Required for custom domains. */
909
- certificate_id?: number | null;
910
- /**
911
- * @description Whether to clone redirects from the source target.
912
- * @default false
913
- */
914
- clone_redirects: boolean;
915
- /**
916
- * @description Whether to clone environment variables from the source target.
917
- * @default false
918
- */
919
- clone_environment_variables: boolean;
920
- /**
921
- * @description Whether to clone B2C target info from the source target.
922
- * @default false
923
- */
924
- clone_b2c_target_info: boolean;
925
- };
926
- /** @description This is the serializer for target create/list APIs. */
927
- APITargetV2Create: {
928
- slug?: string;
929
- /** @description User-friendly name for this target */
930
- name: string;
931
- /**
932
- * @description Target State
933
- *
934
- * * `CREATE_IN_PROGRESS` - Create in Progress
935
- * * `PUBLISH_IN_PROGRESS` - Publish in Progress
936
- * * `ACTIVE` - Active
937
- * * `CREATE_FAILED` - Create Failed
938
- * * `PUBLISH_FAILED` - Publish Failed
939
- */
940
- readonly state?: components["schemas"]["StateEnum"];
941
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
942
- /** @description Hostname (literal or JavaScript regular expression between / characters) on which this target should be loaded by the V8 Tag */
943
- hostname?: string | null;
944
- readonly current_deploy?: {
945
- [key: string]: unknown;
946
- };
947
- /** @description Full hostname to be used by the environment eg. www.customer.com. */
948
- ssr_external_hostname?: string | null;
949
- /** @description The domain to be used for a Universal PWA SSR deployment (e.g. customer.com) */
950
- ssr_external_domain?: string | null;
951
- /**
952
- * SSR AWS Region
953
- * @description The AWS region to which a Universal PWA SSR should be deployed (e.g. us-east-1)
954
- *
955
- * * `us-east-1` - US East (N. Virginia)
956
- * * `us-east-2` - US East (Ohio)
957
- * * `us-west-1` - US West (N. California)
958
- * * `us-west-2` - US West (Oregon)
959
- * * `ap-south-1` - Asia Pacific (Mumbai)
960
- * * `ap-south-2` - Asia Pacific (Hyderabad)
961
- * * `ap-northeast-2` - Asia Pacific (Seoul)
962
- * * `ap-southeast-1` - Asia Pacific (Singapore)
963
- * * `ap-southeast-2` - Asia Pacific (Sydney)
964
- * * `ap-southeast-3` - Asia Pacific (Jakarta)
965
- * * `ap-northeast-1` - Asia Pacific (Tokyo)
966
- * * `ap-northeast-3` - Asia Pacific (Osaka)
967
- * * `ca-central-1` - Canada (Central)
968
- * * `eu-central-1` - EU (Frankfurt)
969
- * * `eu-central-2` - EU (Zurich)
970
- * * `eu-west-1` - EU (Ireland)
971
- * * `eu-west-2` - EU (London)
972
- * * `eu-west-3` - EU (Paris)
973
- * * `eu-north-1` - EU (Stockholm)
974
- * * `eu-south-1` - EU (Milan)
975
- * * `il-central-1` - Israel (Tel Aviv)
976
- * * `me-central-1` - Middle East (UAE)
977
- * * `sa-east-1` - South America (Sao Paulo)
978
- */
979
- ssr_region?: components["schemas"]["SsrRegionEnum"] | components["schemas"]["BlankEnum"];
980
- /**
981
- * @description The architecture for the Server-Side Rendering function (x86 or ARM64). If not specified, the ssr_architecture that's set in the project is used.
982
- *
983
- * * `x86` - x86
984
- * * `arm64` - ARM64
985
- */
986
- ssr_architecture?: (components["schemas"]["SsrArchitectureEnum"] | components["schemas"]["NullEnum"]) | null;
987
- /** @description Optional space-separated list of IP addresses (CIDR blocks) that can access this target. Leave blank to allow all IPs. */
988
- ssr_whitelisted_ips?: string | null;
989
- ssr_proxy_configs?: {
990
- host: string;
991
- protocol?: string;
992
- }[] | null;
993
- /** @description The Managed Runtime CDN origin domain name. */
994
- readonly cdn_domain_name?: string;
995
- /**
996
- * Production
997
- * @description Treat this target as a production environment.
998
- */
999
- is_production?: boolean;
1000
- /** @description Set true to forward the HTTP cookie header sent by clients to your origin and ensure the Set-Cookie header sent by your app is respected and not stripped. */
1001
- allow_cookies?: boolean | null;
1002
- /** @description Set true to enable source map support. This will set the NODE_OPTIONS environment variable to "--enable-source-maps" in your MRT environment. */
1003
- enable_source_maps?: boolean | null;
1004
- /**
1005
- * @description The minimum log level that will be emitted for this target
1006
- *
1007
- * * `TRACE` - TRACE
1008
- * * `DEBUG` - DEBUG
1009
- * * `INFO` - INFO
1010
- * * `WARN` - WARN
1011
- * * `ERROR` - ERROR
1012
- * * `FATAL` - FATAL
1013
- */
1014
- log_level?: (components["schemas"]["LogLevelEnum"] | components["schemas"]["NullEnum"]) | null;
1015
- /** @description The ID of the certificate to associate with this target's custom domain. Must be an integer unique within the organization. */
1016
- certificate_id?: number | null;
1017
- /** @description The certificate domain used by this target. For MRT default domains, returns wildcard format (e.g., *.mobify-storefront-staging.com). For custom domains, returns the certificate domain name. */
1018
- readonly certificate_domain?: string;
1019
- /**
1020
- * @description The content delivery network used for content, traffic, and security. A B2C instance must be connected to this environment to select eCDN.
1021
- *
1022
- * * `unknown` - unknown
1023
- * * `mrt_cdn` - mrt_cdn
1024
- * * `ecdn` - ecdn
1025
- * * `stacked_cdn` - stacked_cdn
1026
- */
1027
- readonly configured_cdn?: (components["schemas"]["ConfiguredCdnEnum"] | components["schemas"]["NullEnum"]) | null;
1028
- /** @description Add a publicly visible hostname. Enter a subdomain if one is not already provided with your organization’s certified domain. */
1029
- readonly cdn_public_hostname?: string | null;
1030
- /**
1031
- * @description Source of the environment. One of: ecom, core, direct.
1032
- *
1033
- * * `ecom` - ecom
1034
- * * `core` - core
1035
- * * `direct` - direct
1036
- */
1037
- readonly source?: (components["schemas"]["SourceEnum"] | components["schemas"]["NullEnum"]) | null;
1038
- };
1039
- /** @description This is the serializer for cache invalidation API endpoint. */
1040
- APITargetV2CreateInvalidation: {
1041
- /** @description Path pattern to invalidate on the CDN. This must start with a forward slash (`/`). */
1042
- pattern: string;
1043
- /**
1044
- * @deprecated
1045
- * @description [Deprecated] Items to invalidate in the application cache.
1046
- * @default []
1047
- */
1048
- items: string[] | null;
1049
- /**
1050
- * @deprecated
1051
- * @description [Deprecated] Namespace of items to invalidate in the application cache.
1052
- */
1053
- namespace?: string;
1054
- };
1055
- /** @description This is the base Target serializer. */
1056
- APITargetV2Update: {
1057
- readonly slug?: string;
1058
- /** @description User-friendly name for this target */
1059
- name: string;
1060
- /**
1061
- * @description Target State
1062
- *
1063
- * * `CREATE_IN_PROGRESS` - Create in Progress
1064
- * * `PUBLISH_IN_PROGRESS` - Publish in Progress
1065
- * * `ACTIVE` - Active
1066
- * * `CREATE_FAILED` - Create Failed
1067
- * * `PUBLISH_FAILED` - Publish Failed
1068
- */
1069
- readonly state?: components["schemas"]["StateEnum"];
1070
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
1071
- /** @description Hostname (literal or JavaScript regular expression between / characters) on which this target should be loaded by the V8 Tag */
1072
- hostname?: string | null;
1073
- readonly current_deploy?: {
1074
- [key: string]: unknown;
1075
- };
1076
- /** @description Full hostname to be used by the environment eg. www.customer.com. */
1077
- ssr_external_hostname?: string | null;
1078
- /** @description The domain to be used for a Universal PWA SSR deployment (e.g. customer.com) */
1079
- ssr_external_domain?: string | null;
1080
- /**
1081
- * SSR AWS Region
1082
- * @description The AWS region to which a Universal PWA SSR should be deployed (e.g. us-east-1)
1083
- *
1084
- * * `us-east-1` - US East (N. Virginia)
1085
- * * `us-east-2` - US East (Ohio)
1086
- * * `us-west-1` - US West (N. California)
1087
- * * `us-west-2` - US West (Oregon)
1088
- * * `ap-south-1` - Asia Pacific (Mumbai)
1089
- * * `ap-south-2` - Asia Pacific (Hyderabad)
1090
- * * `ap-northeast-2` - Asia Pacific (Seoul)
1091
- * * `ap-southeast-1` - Asia Pacific (Singapore)
1092
- * * `ap-southeast-2` - Asia Pacific (Sydney)
1093
- * * `ap-southeast-3` - Asia Pacific (Jakarta)
1094
- * * `ap-northeast-1` - Asia Pacific (Tokyo)
1095
- * * `ap-northeast-3` - Asia Pacific (Osaka)
1096
- * * `ca-central-1` - Canada (Central)
1097
- * * `eu-central-1` - EU (Frankfurt)
1098
- * * `eu-central-2` - EU (Zurich)
1099
- * * `eu-west-1` - EU (Ireland)
1100
- * * `eu-west-2` - EU (London)
1101
- * * `eu-west-3` - EU (Paris)
1102
- * * `eu-north-1` - EU (Stockholm)
1103
- * * `eu-south-1` - EU (Milan)
1104
- * * `il-central-1` - Israel (Tel Aviv)
1105
- * * `me-central-1` - Middle East (UAE)
1106
- * * `sa-east-1` - South America (Sao Paulo)
1107
- */
1108
- ssr_region?: components["schemas"]["SsrRegionEnum"] | components["schemas"]["BlankEnum"];
1109
- /**
1110
- * @description The architecture for the Server-Side Rendering function (x86 or ARM64). If not specified, the ssr_architecture that's set in the project is used.
1111
- *
1112
- * * `x86` - x86
1113
- * * `arm64` - ARM64
1114
- */
1115
- ssr_architecture?: (components["schemas"]["SsrArchitectureEnum"] | components["schemas"]["NullEnum"]) | null;
1116
- /** @description Optional space-separated list of IP addresses (CIDR blocks) that can access this target. Leave blank to allow all IPs. */
1117
- ssr_whitelisted_ips?: string | null;
1118
- ssr_proxy_configs?: {
1119
- host: string;
1120
- protocol?: string;
1121
- }[] | null;
1122
- /** @description The Managed Runtime CDN origin domain name. */
1123
- readonly cdn_domain_name?: string;
1124
- /**
1125
- * Production
1126
- * @description Treat this target as a production environment.
1127
- */
1128
- is_production?: boolean;
1129
- /** @description Set true to forward the HTTP cookie header sent by clients to your origin and ensure the Set-Cookie header sent by your app is respected and not stripped. */
1130
- allow_cookies?: boolean | null;
1131
- /** @description Set true to enable source map support. This will set the NODE_OPTIONS environment variable to "--enable-source-maps" in your MRT environment. */
1132
- enable_source_maps?: boolean | null;
1133
- /**
1134
- * @description The minimum log level that will be emitted for this target
1135
- *
1136
- * * `TRACE` - TRACE
1137
- * * `DEBUG` - DEBUG
1138
- * * `INFO` - INFO
1139
- * * `WARN` - WARN
1140
- * * `ERROR` - ERROR
1141
- * * `FATAL` - FATAL
1142
- */
1143
- log_level?: (components["schemas"]["LogLevelEnum"] | components["schemas"]["NullEnum"]) | null;
1144
- /** @description The ID of the certificate to associate with this target's custom domain. Must be an integer unique within the organization. Set to null to remove the certificate association. */
1145
- certificate_id?: number | null;
1146
- /** @description The certificate domain used by this target. For MRT default domains, returns wildcard format (e.g., *.mobify-storefront-staging.com). For custom domains, returns the certificate domain name. */
1147
- readonly certificate_domain?: string;
1148
- /**
1149
- * @description The content delivery network used for content, traffic, and security. A B2C instance must be connected to this environment to select eCDN.
1150
- *
1151
- * * `unknown` - unknown
1152
- * * `mrt_cdn` - mrt_cdn
1153
- * * `ecdn` - ecdn
1154
- * * `stacked_cdn` - stacked_cdn
1155
- */
1156
- readonly configured_cdn?: (components["schemas"]["ConfiguredCdnEnum"] | components["schemas"]["NullEnum"]) | null;
1157
- /** @description Add a publicly visible hostname. Enter a subdomain if one is not already provided with your organization’s certified domain. */
1158
- readonly cdn_public_hostname?: string | null;
1159
- /**
1160
- * @description Source of the environment. One of: ecom, core, direct.
1161
- *
1162
- * * `ecom` - ecom
1163
- * * `core` - core
1164
- * * `direct` - direct
1165
- */
1166
- readonly source?: (components["schemas"]["SourceEnum"] | components["schemas"]["NullEnum"]) | null;
1167
- };
1168
- APIUserProfile: {
1169
- first_name?: string;
1170
- last_name?: string;
1171
- /**
1172
- * Email address
1173
- * Format: email
1174
- */
1175
- readonly email?: string;
1176
- /**
1177
- * Staff status
1178
- * @description Designates whether the user can log into this admin site.
1179
- */
1180
- readonly is_staff?: boolean;
1181
- /** Format: date-time */
1182
- readonly date_joined?: string;
1183
- /** Format: uuid */
1184
- readonly uuid?: string;
1185
- readonly highest_account_manager_role?: string;
1186
- };
1187
- /** @enum {unknown} */
1188
- BlankEnum: "";
1189
- /** @description Serializer to validate a bundle upload payload. */
1190
- Bundle: {
1191
- message: string;
1192
- data: string;
1193
- encoding: components["schemas"]["EncodingEnum"];
1194
- ssr_only?: string[];
1195
- ssr_shared?: string[];
1196
- ssr_parameters?: {
1197
- [key: string]: unknown;
1198
- };
1199
- bundle_metadata?: {
1200
- [key: string]: unknown;
1201
- };
1202
- };
1203
- BundleBulkDelete: {
1204
- bundle_ids: number[];
1205
- };
1206
- BundleBulkDeleteFailedRequest: {
1207
- /** @description The ID of the bundle that failed validation. */
1208
- bundle_id: number;
1209
- /** @description Error message that explains why the bundle can't be queued for deletion. */
1210
- errors: string;
1211
- };
1212
- BundleBulkDeleteResponse: {
1213
- /** @description Bundles that failed validation and couldn't be queued for deletion. */
1214
- rejected_bundles?: components["schemas"]["BundleBulkDeleteFailedRequest"][];
1215
- /** @description Bundle IDs for bundles that were queued for deletion. */
1216
- bundles_queued_for_cleanup?: number[];
1217
- };
1218
- BundleDownload: {
1219
- /** Format: uri */
1220
- download_url: string;
1221
- };
1222
- BundleList: {
1223
- /** @description A ID unique within a project. */
1224
- id: number;
1225
- message: string;
1226
- status?: components["schemas"]["Status1d2Enum"];
1227
- deletion_status?: components["schemas"]["DeletionStatusEnum"];
1228
- /**
1229
- * Email address
1230
- * Format: email
1231
- */
1232
- readonly user?: string;
1233
- /**
1234
- * Format: date-time
1235
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1236
- */
1237
- readonly created_at?: string;
1238
- /**
1239
- * Format: date-time
1240
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
1241
- */
1242
- readonly updated_at?: string;
1243
- };
1244
- /** @description Base serializer for certificate serializers with common fields and methods. */
1245
- CertificateBase: {
1246
- /** @description An ID unique within a business. */
1247
- readonly id?: number;
1248
- /**
1249
- * Certificate domain
1250
- * @description The domain for the certificate either wildcard (e.g. *.example.com) or single domain (e.g. sub.example.com)
1251
- */
1252
- domain_name: string;
1253
- readonly validation_requested_at?: string;
1254
- /**
1255
- * @description Current validation status of the certificate
1256
- *
1257
- * * `pending_validation` - Pending Validation
1258
- * * `validation_succeeded` - Validation Succeeded
1259
- * * `validation_failed` - Validation Failed
1260
- */
1261
- readonly validation_status?: components["schemas"]["ValidationStatusEnum"];
1262
- readonly validation_record?: string;
1263
- /**
1264
- * Certificate Expiry Date
1265
- * Format: date-time
1266
- * @description Expiry date of the certificate from ACM.
1267
- */
1268
- readonly expires_at?: string | null;
1269
- /**
1270
- * @description Current status of certificate renewal.
1271
- *
1272
- * * `PENDING_AUTO_RENEWAL` - Pending Auto Renewal
1273
- * * `FAILED` - Failed
1274
- */
1275
- readonly renewal_status?: (components["schemas"]["RenewalStatusEnum"] | components["schemas"]["NullEnum"]) | null;
1276
- /**
1277
- * @description Whether the certificate is eligible for renewal.
1278
- *
1279
- * * `ELIGIBLE` - Eligible
1280
- * * `INELIGIBLE` - Ineligible
1281
- */
1282
- readonly renewal_eligibility?: (components["schemas"]["RenewalEligibilityEnum"] | components["schemas"]["NullEnum"]) | null;
1283
- readonly targets?: string;
1284
- readonly created_by?: string;
1285
- /**
1286
- * Format: date-time
1287
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1288
- */
1289
- readonly created_at?: string;
1290
- readonly is_mrt_managed?: string;
1291
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
1292
- };
1293
- /** @description Base serializer for certificate serializers with common fields and methods. */
1294
- CertificateListCreate: {
1295
- /** @description An ID unique within a business. */
1296
- readonly id?: number;
1297
- /** @description The domain for the certificate (e.g. shop.example.com) */
1298
- domain_name: string;
1299
- readonly validation_requested_at?: string;
1300
- /**
1301
- * @description Current validation status of the certificate
1302
- *
1303
- * * `pending_validation` - Pending Validation
1304
- * * `validation_succeeded` - Validation Succeeded
1305
- * * `validation_failed` - Validation Failed
1306
- */
1307
- readonly validation_status?: components["schemas"]["ValidationStatusEnum"];
1308
- readonly validation_record?: string;
1309
- /**
1310
- * Certificate Expiry Date
1311
- * Format: date-time
1312
- * @description Expiry date of the certificate from ACM.
1313
- */
1314
- readonly expires_at?: string | null;
1315
- /**
1316
- * @description Current status of certificate renewal.
1317
- *
1318
- * * `PENDING_AUTO_RENEWAL` - Pending Auto Renewal
1319
- * * `FAILED` - Failed
1320
- */
1321
- readonly renewal_status?: (components["schemas"]["RenewalStatusEnum"] | components["schemas"]["NullEnum"]) | null;
1322
- /**
1323
- * @description Whether the certificate is eligible for renewal.
1324
- *
1325
- * * `ELIGIBLE` - Eligible
1326
- * * `INELIGIBLE` - Ineligible
1327
- */
1328
- readonly renewal_eligibility?: (components["schemas"]["RenewalEligibilityEnum"] | components["schemas"]["NullEnum"]) | null;
1329
- readonly targets?: string;
1330
- readonly created_by?: string;
1331
- /**
1332
- * Format: date-time
1333
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1334
- */
1335
- readonly created_at?: string;
1336
- readonly is_mrt_managed?: string;
1337
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
1338
- };
1339
- /**
1340
- * @description * `unknown` - unknown
1341
- * * `mrt_cdn` - mrt_cdn
1342
- * * `ecdn` - ecdn
1343
- * * `stacked_cdn` - stacked_cdn
1344
- * @enum {string}
1345
- */
1346
- ConfiguredCdnEnum: "unknown" | "mrt_cdn" | "ecdn" | "stacked_cdn";
1347
- /**
1348
- * @description * `ACTIVE` - Active
1349
- * * `CLEANUP_REQUESTED` - Cleanup Requested
1350
- * * `CLEANUP_IN_PROGRESS` - Cleanup in Progress
1351
- * * `CLEANUP_COMPLETE` - Cleanup Complete
1352
- * * `CLEANUP_FAILED` - Cleanup Failed
1353
- * @enum {string}
1354
- */
1355
- DeletionStatusEnum: "ACTIVE" | "CLEANUP_REQUESTED" | "CLEANUP_IN_PROGRESS" | "CLEANUP_COMPLETE" | "CLEANUP_FAILED";
1356
- /** @description This is the serializer for create deploy API endpoint. */
1357
- DeployCreate: {
1358
- /** @description Integer ID of the bundle to deploy or the string `current`, which re-deploys the currently deployed bundle */
1359
- bundle_id: unknown;
1360
- };
1361
- DeployList: {
1362
- /**
1363
- * Email address
1364
- * Format: email
1365
- */
1366
- readonly user?: string;
1367
- bundle: components["schemas"]["BundleList"];
1368
- /**
1369
- * Format: date-time
1370
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1371
- */
1372
- readonly created_at?: string;
1373
- /**
1374
- * Format: date-time
1375
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
1376
- */
1377
- readonly updated_at?: string;
1378
- readonly status?: components["schemas"]["DeployListStatusEnum"];
1379
- readonly deploy_type?: components["schemas"]["DeployTypeEnum"];
1380
- /**
1381
- * Format: uuid
1382
- * @description Id for an external publishing operation for this Deploy
1383
- */
1384
- external_publish_id?: string | null;
1385
- deploy_settings?: number | null;
1386
- duration: string;
1387
- };
1388
- /**
1389
- * @description * `Queued` - Queued
1390
- * * `In Progress` - In Progress
1391
- * * `Failed` - Failed
1392
- * * `Finished` - Finished
1393
- * @enum {string}
1394
- */
1395
- DeployListStatusEnum: "Queued" | "In Progress" | "Failed" | "Finished";
1396
- /**
1397
- * @description * `Publish` - Publish
1398
- * * `Reset Bundle` - Reset Bundle
1399
- * * `Push` - Push
1400
- * * `Deploy Settings` - Deploy Settings
1401
- * * `Redeploy` - Redeploy
1402
- * @enum {string}
1403
- */
1404
- DeployTypeEnum: "Publish" | "Reset Bundle" | "Push" | "Deploy Settings" | "Redeploy";
1405
- EmailNotification: {
1406
- /** Format: uuid */
1407
- readonly id?: string;
1408
- targets: string[];
1409
- recipients: string[];
1410
- /** @description Trigger this notification when a deployment starts for a target */
1411
- deployment_start?: boolean;
1412
- /** @description Trigger this notification when a deployment succeeds for a target */
1413
- deployment_success?: boolean;
1414
- /** @description Trigger this notification when a deployment fails for a target */
1415
- deployment_failed?: boolean;
1416
- /**
1417
- * Format: date-time
1418
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1419
- */
1420
- readonly created_at?: string;
1421
- /**
1422
- * Format: date-time
1423
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
1424
- */
1425
- readonly updated_at?: string;
1426
- /**
1427
- * Email address
1428
- * Format: email
1429
- */
1430
- readonly updated_by?: string;
1431
- };
1432
- EmailNotificationTyped: {
1433
- resourcetype: string;
1434
- } & components["schemas"]["EmailNotification"] & {
1435
- /**
1436
- * @description discriminator enum property added by openapi-typescript
1437
- * @enum {string}
1438
- */
1439
- resourcetype: "EmailNotification";
1440
- };
1441
- /**
1442
- * @description * `base64` - base64
1443
- * @enum {string}
1444
- */
1445
- EncodingEnum: "base64";
1446
- EnvironmentVariableList: {
1447
- name: string;
1448
- /** @description Value to be encrypted. */
1449
- value: string;
1450
- /**
1451
- * Email address
1452
- * Format: email
1453
- */
1454
- readonly created_by?: string;
1455
- /**
1456
- * Format: date-time
1457
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1458
- */
1459
- readonly created_at?: string;
1460
- /**
1461
- * Format: date-time
1462
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
1463
- */
1464
- readonly updated_at?: string;
1465
- /**
1466
- * Email address
1467
- * Format: email
1468
- */
1469
- readonly updated_by?: string;
1470
- readonly publishing_status?: components["schemas"]["Status1d2Enum"];
1471
- readonly publishing_status_description?: string;
1472
- };
1473
- /**
1474
- * @description * `301` - Permanent 301
1475
- * * `302` - Temporary 302
1476
- * @enum {integer}
1477
- */
1478
- HttpStatusCodeEnum: 301 | 302;
1479
- /**
1480
- * @description * `TRACE` - TRACE
1481
- * * `DEBUG` - DEBUG
1482
- * * `INFO` - INFO
1483
- * * `WARN` - WARN
1484
- * * `ERROR` - ERROR
1485
- * * `FATAL` - FATAL
1486
- * @enum {string}
1487
- */
1488
- LogLevelEnum: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL";
1489
- /** @enum {unknown} */
1490
- NullEnum: null;
1491
- OrganizationAutoDelete: {
1492
- enabled: boolean;
1493
- threshold: number;
1494
- };
1495
- OrganizationLimits: {
1496
- max_environments: components["schemas"]["ResourceLimit"];
1497
- max_production_environments: components["schemas"]["ResourceLimit"];
1498
- };
1499
- PaginatedAPIAccessControlHeaderV2CreateList: {
1500
- /** @example 123 */
1501
- count: number;
1502
- /**
1503
- * Format: uri
1504
- * @example http://api.example.org/accounts/?offset=400&limit=100
1505
- */
1506
- next?: string | null;
1507
- /**
1508
- * Format: uri
1509
- * @example http://api.example.org/accounts/?offset=200&limit=100
1510
- */
1511
- previous?: string | null;
1512
- results: components["schemas"]["APIAccessControlHeaderV2Create"][];
1513
- };
1514
- PaginatedAPIOrganizationList: {
1515
- /** @example 123 */
1516
- count: number;
1517
- /**
1518
- * Format: uri
1519
- * @example http://api.example.org/accounts/?offset=400&limit=100
1520
- */
1521
- next?: string | null;
1522
- /**
1523
- * Format: uri
1524
- * @example http://api.example.org/accounts/?offset=200&limit=100
1525
- */
1526
- previous?: string | null;
1527
- results: components["schemas"]["APIOrganization"][];
1528
- };
1529
- PaginatedAPIOrganizationMemberList: {
1530
- /** @example 123 */
1531
- count: number;
1532
- /**
1533
- * Format: uri
1534
- * @example http://api.example.org/accounts/?offset=400&limit=100
1535
- */
1536
- next?: string | null;
1537
- /**
1538
- * Format: uri
1539
- * @example http://api.example.org/accounts/?offset=200&limit=100
1540
- */
1541
- previous?: string | null;
1542
- results: components["schemas"]["APIOrganizationMember"][];
1543
- };
1544
- PaginatedAPIProjectMemberList: {
1545
- /** @example 123 */
1546
- count: number;
1547
- /**
1548
- * Format: uri
1549
- * @example http://api.example.org/accounts/?offset=400&limit=100
1550
- */
1551
- next?: string | null;
1552
- /**
1553
- * Format: uri
1554
- * @example http://api.example.org/accounts/?offset=200&limit=100
1555
- */
1556
- previous?: string | null;
1557
- results: components["schemas"]["APIProjectMember"][];
1558
- };
1559
- PaginatedAPIProjectV2CreateList: {
1560
- /** @example 123 */
1561
- count: number;
1562
- /**
1563
- * Format: uri
1564
- * @example http://api.example.org/accounts/?offset=400&limit=100
1565
- */
1566
- next?: string | null;
1567
- /**
1568
- * Format: uri
1569
- * @example http://api.example.org/accounts/?offset=200&limit=100
1570
- */
1571
- previous?: string | null;
1572
- results: components["schemas"]["APIProjectV2Create"][];
1573
- };
1574
- PaginatedAPIRedirectV2CreateUpdateList: {
1575
- /** @example 123 */
1576
- count: number;
1577
- /**
1578
- * Format: uri
1579
- * @example http://api.example.org/accounts/?offset=400&limit=100
1580
- */
1581
- next?: string | null;
1582
- /**
1583
- * Format: uri
1584
- * @example http://api.example.org/accounts/?offset=200&limit=100
1585
- */
1586
- previous?: string | null;
1587
- results: components["schemas"]["APIRedirectV2CreateUpdate"][];
1588
- };
1589
- PaginatedAPITargetV2CreateList: {
1590
- /** @example 123 */
1591
- count: number;
1592
- /**
1593
- * Format: uri
1594
- * @example http://api.example.org/accounts/?offset=400&limit=100
1595
- */
1596
- next?: string | null;
1597
- /**
1598
- * Format: uri
1599
- * @example http://api.example.org/accounts/?offset=200&limit=100
1600
- */
1601
- previous?: string | null;
1602
- results: components["schemas"]["APITargetV2Create"][];
1603
- };
1604
- PaginatedBundleListList: {
1605
- /** @example 123 */
1606
- count: number;
1607
- /**
1608
- * Format: uri
1609
- * @example http://api.example.org/accounts/?offset=400&limit=100
1610
- */
1611
- next?: string | null;
1612
- /**
1613
- * Format: uri
1614
- * @example http://api.example.org/accounts/?offset=200&limit=100
1615
- */
1616
- previous?: string | null;
1617
- results: components["schemas"]["BundleList"][];
1618
- };
1619
- PaginatedCertificateListCreateList: {
1620
- /** @example 123 */
1621
- count: number;
1622
- /**
1623
- * Format: uri
1624
- * @example http://api.example.org/accounts/?offset=400&limit=100
1625
- */
1626
- next?: string | null;
1627
- /**
1628
- * Format: uri
1629
- * @example http://api.example.org/accounts/?offset=200&limit=100
1630
- */
1631
- previous?: string | null;
1632
- results: components["schemas"]["CertificateListCreate"][];
1633
- };
1634
- PaginatedDeployListList: {
1635
- /** @example 123 */
1636
- count: number;
1637
- /**
1638
- * Format: uri
1639
- * @example http://api.example.org/accounts/?offset=400&limit=100
1640
- */
1641
- next?: string | null;
1642
- /**
1643
- * Format: uri
1644
- * @example http://api.example.org/accounts/?offset=200&limit=100
1645
- */
1646
- previous?: string | null;
1647
- results: components["schemas"]["DeployList"][];
1648
- };
1649
- PaginatedEnvironmentVariableListList: {
1650
- /** @example 123 */
1651
- count: number;
1652
- /**
1653
- * Format: uri
1654
- * @example http://api.example.org/accounts/?offset=400&limit=100
1655
- */
1656
- next?: string | null;
1657
- /**
1658
- * Format: uri
1659
- * @example http://api.example.org/accounts/?offset=200&limit=100
1660
- */
1661
- previous?: string | null;
1662
- results: components["schemas"]["EnvironmentVariableList"][];
1663
- };
1664
- PaginatedPolymorphicNotificationList: {
1665
- /** @example 123 */
1666
- count: number;
1667
- /**
1668
- * Format: uri
1669
- * @example http://api.example.org/accounts/?offset=400&limit=100
1670
- */
1671
- next?: string | null;
1672
- /**
1673
- * Format: uri
1674
- * @example http://api.example.org/accounts/?offset=200&limit=100
1675
- */
1676
- previous?: string | null;
1677
- results: components["schemas"]["PolymorphicNotification"][];
1678
- };
1679
- /**
1680
- * @description Serializer for updating organization role permissions.
1681
- * Allows updating can_view_all_projects and custom_domain_cert_permission.
1682
- */
1683
- PatchedAPIOrganizationMemberUpdate: {
1684
- /**
1685
- * Email address
1686
- * Format: email
1687
- */
1688
- readonly user?: string;
1689
- readonly role?: components["schemas"]["RoleEnum"];
1690
- readonly first_name?: string;
1691
- readonly last_name?: string;
1692
- can_view_all_projects?: boolean;
1693
- custom_domain_cert_permission?: components["schemas"]["Status1d2Enum"];
1694
- };
1695
- PatchedAPIProjectMember: {
1696
- /**
1697
- * Email address
1698
- * Format: email
1699
- */
1700
- user?: string;
1701
- role?: {
1702
- name?: string;
1703
- /** @enum {integer} */
1704
- value?: 0 | 1 | 2 | 3;
1705
- };
1706
- };
1707
- PatchedAPIProjectV2Update: {
1708
- /** @description User-friendly name for this project */
1709
- name?: string;
1710
- /** Format: uri */
1711
- url?: string;
1712
- readonly slug?: string;
1713
- /** @description User-friendly identifier for this instance. */
1714
- organization?: string;
1715
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
1716
- readonly project_type?: components["schemas"]["ProjectTypeEnum"];
1717
- readonly permissions?: {
1718
- browse?: boolean;
1719
- deploy?: boolean;
1720
- delete_bundle?: boolean;
1721
- delete_project?: boolean;
1722
- edit_redirect?: boolean;
1723
- edit_roles?: boolean;
1724
- edit_settings?: boolean;
1725
- validate_tag?: boolean;
1726
- edit_environment?: boolean;
1727
- create_environment?: boolean;
1728
- delete_environment?: boolean;
1729
- create_notification?: boolean;
1730
- list_notifications?: boolean;
1731
- retrieve_notification?: boolean;
1732
- edit_notification?: boolean;
1733
- delete_notification?: boolean;
1734
- create_jwt?: boolean;
1735
- upload_bundle?: boolean;
1736
- edit_environment_variable?: boolean;
1737
- edit_access_control_header?: boolean;
1738
- edit_data_access_layer_entry?: boolean;
1739
- };
1740
- /**
1741
- * SSR AWS Region
1742
- * @description The default AWS region for newly created targets
1743
- *
1744
- * * `us-east-1` - US East (N. Virginia)
1745
- * * `us-east-2` - US East (Ohio)
1746
- * * `us-west-1` - US West (N. California)
1747
- * * `us-west-2` - US West (Oregon)
1748
- * * `ap-south-1` - Asia Pacific (Mumbai)
1749
- * * `ap-south-2` - Asia Pacific (Hyderabad)
1750
- * * `ap-northeast-2` - Asia Pacific (Seoul)
1751
- * * `ap-southeast-1` - Asia Pacific (Singapore)
1752
- * * `ap-southeast-2` - Asia Pacific (Sydney)
1753
- * * `ap-southeast-3` - Asia Pacific (Jakarta)
1754
- * * `ap-northeast-1` - Asia Pacific (Tokyo)
1755
- * * `ap-northeast-3` - Asia Pacific (Osaka)
1756
- * * `ca-central-1` - Canada (Central)
1757
- * * `eu-central-1` - EU (Frankfurt)
1758
- * * `eu-central-2` - EU (Zurich)
1759
- * * `eu-west-1` - EU (Ireland)
1760
- * * `eu-west-2` - EU (London)
1761
- * * `eu-west-3` - EU (Paris)
1762
- * * `eu-north-1` - EU (Stockholm)
1763
- * * `eu-south-1` - EU (Milan)
1764
- * * `il-central-1` - Israel (Tel Aviv)
1765
- * * `me-central-1` - Middle East (UAE)
1766
- * * `sa-east-1` - South America (Sao Paulo)
1767
- */
1768
- ssr_region?: components["schemas"]["SsrRegionEnum"];
1769
- /**
1770
- * @description Default Server-Side Rendering architecture (x86 or arm64) for targets under this project.
1771
- *
1772
- * * `x86` - x86
1773
- * * `arm64` - ARM64
1774
- */
1775
- ssr_architecture?: (components["schemas"]["SsrArchitectureEnum"] | components["schemas"]["NullEnum"]) | null;
1776
- /**
1777
- * Format: date-time
1778
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1779
- */
1780
- readonly created_at?: string;
1781
- /**
1782
- * Format: date-time
1783
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
1784
- */
1785
- readonly updated_at?: string;
1786
- /**
1787
- * @description Source of the project. One of: ecom, core, direct.
1788
- *
1789
- * * `ecom` - ecom
1790
- * * `core` - core
1791
- * * `direct` - direct
1792
- */
1793
- readonly source?: (components["schemas"]["SourceEnum"] | components["schemas"]["NullEnum"]) | null;
1794
- };
1795
- PatchedAPIRedirectV2CreateUpdate: {
1796
- /** @description A relative URL. For example, the `from_path` value `/spring` redirects shoppers from the URL `www.example.com/spring`. An asterisk (`*`) at the end of the `from_path` indicates a wildcard. For example, a redirect from `/a/*` matches `/a/`, `/a/b`, and `/a/b/c`. */
1797
- from_path?: string;
1798
- /** @description A relative or absolute URL. For example, the `to_url` value `/summer` redirects shoppers to the URL `www.example.com/summer`. */
1799
- to_url?: string;
1800
- /** @description Some requests contain query string parameters to include in the redirected request. For example, the relative path `/spring-landing-page` can be appended with a query string for analytics tracking, such as `/spring-landing-page?gclid=123`. The `true` value includes query string parameters in the redirect. The `false` value excludes query string parameters from the redirect. The default value is `false`. */
1801
- forward_querystring?: boolean | null;
1802
- /** @description The `true` value automatically includes any path that comes after the wildcard portion of the `from_path` in the `to_url`. For example: if `/a/*` matches `/a/b/c` in the `from_path` and the `to_url` is `/z/`, the redirect URL is `/z/b/c`. The `false` value excludes the wildcard portion. The default value is `false`. */
1803
- forward_wildcard?: boolean | null;
1804
- /**
1805
- * @description The HTTP status code to be returned in the response. 301 (Moved Permanently) is the recommended and default value. 302 (Found or Moved Temporarily) is another allowable value. For more information about HTTP status codes, see this [status code explainer](https://moz.com/learn/seo/redirection).
1806
- *
1807
- * * `301` - Permanent 301
1808
- * * `302` - Temporary 302
1809
- */
1810
- http_status_code?: components["schemas"]["HttpStatusCodeEnum"];
1811
- /** @description The status of the redeployment that happens after you call this API. Allowable values: Pending, Completed, Failed. If the request failed, you can [redeploy the environment](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/pushing-and-deploying-bundles.html) specified in your request. */
1812
- readonly publishing_status?: string;
1813
- /**
1814
- * Email address
1815
- * Format: email
1816
- * @description Email of the user who created the redirect.
1817
- */
1818
- readonly user_email?: string;
1819
- /**
1820
- * Format: date-time
1821
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1822
- */
1823
- readonly created_at?: string;
1824
- /**
1825
- * Format: date-time
1826
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
1827
- */
1828
- readonly updated_at?: string;
1829
- /**
1830
- * Email address
1831
- * Format: email
1832
- * @description Email of the user who last updated the redirect.
1833
- */
1834
- readonly updated_by?: string;
1835
- };
1836
- /** @description This is the base Target serializer. */
1837
- PatchedAPITargetV2Update: {
1838
- readonly slug?: string;
1839
- /** @description User-friendly name for this target */
1840
- name?: string;
1841
- /**
1842
- * @description Target State
1843
- *
1844
- * * `CREATE_IN_PROGRESS` - Create in Progress
1845
- * * `PUBLISH_IN_PROGRESS` - Publish in Progress
1846
- * * `ACTIVE` - Active
1847
- * * `CREATE_FAILED` - Create Failed
1848
- * * `PUBLISH_FAILED` - Publish Failed
1849
- */
1850
- readonly state?: components["schemas"]["StateEnum"];
1851
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
1852
- /** @description Hostname (literal or JavaScript regular expression between / characters) on which this target should be loaded by the V8 Tag */
1853
- hostname?: string | null;
1854
- readonly current_deploy?: {
1855
- [key: string]: unknown;
1856
- };
1857
- /** @description Full hostname to be used by the environment eg. www.customer.com. */
1858
- ssr_external_hostname?: string | null;
1859
- /** @description The domain to be used for a Universal PWA SSR deployment (e.g. customer.com) */
1860
- ssr_external_domain?: string | null;
1861
- /**
1862
- * SSR AWS Region
1863
- * @description The AWS region to which a Universal PWA SSR should be deployed (e.g. us-east-1)
1864
- *
1865
- * * `us-east-1` - US East (N. Virginia)
1866
- * * `us-east-2` - US East (Ohio)
1867
- * * `us-west-1` - US West (N. California)
1868
- * * `us-west-2` - US West (Oregon)
1869
- * * `ap-south-1` - Asia Pacific (Mumbai)
1870
- * * `ap-south-2` - Asia Pacific (Hyderabad)
1871
- * * `ap-northeast-2` - Asia Pacific (Seoul)
1872
- * * `ap-southeast-1` - Asia Pacific (Singapore)
1873
- * * `ap-southeast-2` - Asia Pacific (Sydney)
1874
- * * `ap-southeast-3` - Asia Pacific (Jakarta)
1875
- * * `ap-northeast-1` - Asia Pacific (Tokyo)
1876
- * * `ap-northeast-3` - Asia Pacific (Osaka)
1877
- * * `ca-central-1` - Canada (Central)
1878
- * * `eu-central-1` - EU (Frankfurt)
1879
- * * `eu-central-2` - EU (Zurich)
1880
- * * `eu-west-1` - EU (Ireland)
1881
- * * `eu-west-2` - EU (London)
1882
- * * `eu-west-3` - EU (Paris)
1883
- * * `eu-north-1` - EU (Stockholm)
1884
- * * `eu-south-1` - EU (Milan)
1885
- * * `il-central-1` - Israel (Tel Aviv)
1886
- * * `me-central-1` - Middle East (UAE)
1887
- * * `sa-east-1` - South America (Sao Paulo)
1888
- */
1889
- ssr_region?: components["schemas"]["SsrRegionEnum"] | components["schemas"]["BlankEnum"];
1890
- /**
1891
- * @description The architecture for the Server-Side Rendering function (x86 or ARM64). If not specified, the ssr_architecture that's set in the project is used.
1892
- *
1893
- * * `x86` - x86
1894
- * * `arm64` - ARM64
1895
- */
1896
- ssr_architecture?: (components["schemas"]["SsrArchitectureEnum"] | components["schemas"]["NullEnum"]) | null;
1897
- /** @description Optional space-separated list of IP addresses (CIDR blocks) that can access this target. Leave blank to allow all IPs. */
1898
- ssr_whitelisted_ips?: string | null;
1899
- ssr_proxy_configs?: {
1900
- host: string;
1901
- protocol?: string;
1902
- }[] | null;
1903
- /** @description The Managed Runtime CDN origin domain name. */
1904
- readonly cdn_domain_name?: string;
1905
- /**
1906
- * Production
1907
- * @description Treat this target as a production environment.
1908
- */
1909
- is_production?: boolean;
1910
- /** @description Set true to forward the HTTP cookie header sent by clients to your origin and ensure the Set-Cookie header sent by your app is respected and not stripped. */
1911
- allow_cookies?: boolean | null;
1912
- /** @description Set true to enable source map support. This will set the NODE_OPTIONS environment variable to "--enable-source-maps" in your MRT environment. */
1913
- enable_source_maps?: boolean | null;
1914
- /**
1915
- * @description The minimum log level that will be emitted for this target
1916
- *
1917
- * * `TRACE` - TRACE
1918
- * * `DEBUG` - DEBUG
1919
- * * `INFO` - INFO
1920
- * * `WARN` - WARN
1921
- * * `ERROR` - ERROR
1922
- * * `FATAL` - FATAL
1923
- */
1924
- log_level?: (components["schemas"]["LogLevelEnum"] | components["schemas"]["NullEnum"]) | null;
1925
- /** @description The ID of the certificate to associate with this target's custom domain. Must be an integer unique within the organization. Set to null to remove the certificate association. */
1926
- certificate_id?: number | null;
1927
- /** @description The certificate domain used by this target. For MRT default domains, returns wildcard format (e.g., *.mobify-storefront-staging.com). For custom domains, returns the certificate domain name. */
1928
- readonly certificate_domain?: string;
1929
- /**
1930
- * @description The content delivery network used for content, traffic, and security. A B2C instance must be connected to this environment to select eCDN.
1931
- *
1932
- * * `unknown` - unknown
1933
- * * `mrt_cdn` - mrt_cdn
1934
- * * `ecdn` - ecdn
1935
- * * `stacked_cdn` - stacked_cdn
1936
- */
1937
- readonly configured_cdn?: (components["schemas"]["ConfiguredCdnEnum"] | components["schemas"]["NullEnum"]) | null;
1938
- /** @description Add a publicly visible hostname. Enter a subdomain if one is not already provided with your organization’s certified domain. */
1939
- readonly cdn_public_hostname?: string | null;
1940
- /**
1941
- * @description Source of the environment. One of: ecom, core, direct.
1942
- *
1943
- * * `ecom` - ecom
1944
- * * `core` - core
1945
- * * `direct` - direct
1946
- */
1947
- readonly source?: (components["schemas"]["SourceEnum"] | components["schemas"]["NullEnum"]) | null;
1948
- };
1949
- /** @description Base serializer for certificate serializers with common fields and methods. */
1950
- PatchedCertificateBase: {
1951
- /** @description An ID unique within a business. */
1952
- readonly id?: number;
1953
- /**
1954
- * Certificate domain
1955
- * @description The domain for the certificate either wildcard (e.g. *.example.com) or single domain (e.g. sub.example.com)
1956
- */
1957
- domain_name?: string;
1958
- readonly validation_requested_at?: string;
1959
- /**
1960
- * @description Current validation status of the certificate
1961
- *
1962
- * * `pending_validation` - Pending Validation
1963
- * * `validation_succeeded` - Validation Succeeded
1964
- * * `validation_failed` - Validation Failed
1965
- */
1966
- readonly validation_status?: components["schemas"]["ValidationStatusEnum"];
1967
- readonly validation_record?: string;
1968
- /**
1969
- * Certificate Expiry Date
1970
- * Format: date-time
1971
- * @description Expiry date of the certificate from ACM.
1972
- */
1973
- readonly expires_at?: string | null;
1974
- /**
1975
- * @description Current status of certificate renewal.
1976
- *
1977
- * * `PENDING_AUTO_RENEWAL` - Pending Auto Renewal
1978
- * * `FAILED` - Failed
1979
- */
1980
- readonly renewal_status?: (components["schemas"]["RenewalStatusEnum"] | components["schemas"]["NullEnum"]) | null;
1981
- /**
1982
- * @description Whether the certificate is eligible for renewal.
1983
- *
1984
- * * `ELIGIBLE` - Eligible
1985
- * * `INELIGIBLE` - Ineligible
1986
- */
1987
- readonly renewal_eligibility?: (components["schemas"]["RenewalEligibilityEnum"] | components["schemas"]["NullEnum"]) | null;
1988
- readonly targets?: string;
1989
- readonly created_by?: string;
1990
- /**
1991
- * Format: date-time
1992
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
1993
- */
1994
- readonly created_at?: string;
1995
- readonly is_mrt_managed?: string;
1996
- readonly deletion_status?: components["schemas"]["DeletionStatusEnum"];
1997
- };
1998
- PatchedEmailNotification: {
1999
- /** Format: uuid */
2000
- readonly id?: string;
2001
- targets?: string[];
2002
- recipients?: string[];
2003
- /** @description Trigger this notification when a deployment starts for a target */
2004
- deployment_start?: boolean;
2005
- /** @description Trigger this notification when a deployment succeeds for a target */
2006
- deployment_success?: boolean;
2007
- /** @description Trigger this notification when a deployment fails for a target */
2008
- deployment_failed?: boolean;
2009
- /**
2010
- * Format: date-time
2011
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
2012
- */
2013
- readonly created_at?: string;
2014
- /**
2015
- * Format: date-time
2016
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
2017
- */
2018
- readonly updated_at?: string;
2019
- /**
2020
- * Email address
2021
- * Format: email
2022
- */
2023
- readonly updated_by?: string;
2024
- };
2025
- PatchedEmailNotificationTyped: {
2026
- resourcetype?: string;
2027
- } & components["schemas"]["PatchedEmailNotification"] & {
2028
- /**
2029
- * @description discriminator enum property added by openapi-typescript
2030
- * @enum {string}
2031
- */
2032
- resourcetype: "EmailNotification";
2033
- };
2034
- PatchedPolymorphicNotification: components["schemas"]["PatchedEmailNotificationTyped"];
2035
- PatchedUserEmailPreferences: {
2036
- /** @description Receive email notifications about Node.js runtime deprecations */
2037
- node_deprecation_notifications?: boolean;
2038
- /** @description Receive email notifications about custom domain certificate changes */
2039
- custom_domain_certificate_notifications?: boolean;
2040
- /**
2041
- * Format: date-time
2042
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
2043
- */
2044
- readonly created_at?: string;
2045
- /**
2046
- * Format: date-time
2047
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
2048
- */
2049
- readonly updated_at?: string;
2050
- };
2051
- PolymorphicNotification: components["schemas"]["EmailNotificationTyped"];
2052
- /**
2053
- * @description * `MOBIFY_STUDIO` - MOBIFY_STUDIO
2054
- * * `MOBIFYJS_CLIENT` - MOBIFYJS_CLIENT
2055
- * * `MOBIFY_ADAPTIVEJS` - MOBIFY_ADAPTIVEJS
2056
- * * `MOBIFY_TAG_BASED_PWA` - MOBIFY_TAG_BASED_PWA
2057
- * * `SSR` - SSR
2058
- * @enum {string}
2059
- */
2060
- ProjectTypeEnum: "MOBIFY_STUDIO" | "MOBIFYJS_CLIENT" | "MOBIFY_ADAPTIVEJS" | "MOBIFY_TAG_BASED_PWA" | "SSR";
2061
- /**
2062
- * @description * `ELIGIBLE` - Eligible
2063
- * * `INELIGIBLE` - Ineligible
2064
- * @enum {string}
2065
- */
2066
- RenewalEligibilityEnum: "ELIGIBLE" | "INELIGIBLE";
2067
- /**
2068
- * @description * `PENDING_AUTO_RENEWAL` - Pending Auto Renewal
2069
- * * `FAILED` - Failed
2070
- * @enum {string}
2071
- */
2072
- RenewalStatusEnum: "PENDING_AUTO_RENEWAL" | "FAILED";
2073
- ResourceLimit: {
2074
- limit: number;
2075
- used: number;
2076
- };
2077
- /**
2078
- * @description * `0` - Owner
2079
- * * `1` - Member
2080
- * @enum {integer}
2081
- */
2082
- RoleEnum: 0 | 1;
2083
- /**
2084
- * @description * `ecom` - ecom
2085
- * * `core` - core
2086
- * * `direct` - direct
2087
- * @enum {string}
2088
- */
2089
- SourceEnum: "ecom" | "core" | "direct";
2090
- /**
2091
- * @description * `x86` - x86
2092
- * * `arm64` - ARM64
2093
- * @enum {string}
2094
- */
2095
- SsrArchitectureEnum: "x86" | "arm64";
2096
- /**
2097
- * @description * `us-east-1` - US East (N. Virginia)
2098
- * * `us-east-2` - US East (Ohio)
2099
- * * `us-west-1` - US West (N. California)
2100
- * * `us-west-2` - US West (Oregon)
2101
- * * `ap-south-1` - Asia Pacific (Mumbai)
2102
- * * `ap-south-2` - Asia Pacific (Hyderabad)
2103
- * * `ap-northeast-2` - Asia Pacific (Seoul)
2104
- * * `ap-southeast-1` - Asia Pacific (Singapore)
2105
- * * `ap-southeast-2` - Asia Pacific (Sydney)
2106
- * * `ap-southeast-3` - Asia Pacific (Jakarta)
2107
- * * `ap-northeast-1` - Asia Pacific (Tokyo)
2108
- * * `ap-northeast-3` - Asia Pacific (Osaka)
2109
- * * `ca-central-1` - Canada (Central)
2110
- * * `eu-central-1` - EU (Frankfurt)
2111
- * * `eu-central-2` - EU (Zurich)
2112
- * * `eu-west-1` - EU (Ireland)
2113
- * * `eu-west-2` - EU (London)
2114
- * * `eu-west-3` - EU (Paris)
2115
- * * `eu-north-1` - EU (Stockholm)
2116
- * * `eu-south-1` - EU (Milan)
2117
- * * `il-central-1` - Israel (Tel Aviv)
2118
- * * `me-central-1` - Middle East (UAE)
2119
- * * `sa-east-1` - South America (Sao Paulo)
2120
- * @enum {string}
2121
- */
2122
- SsrRegionEnum: "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "ap-south-1" | "ap-south-2" | "ap-northeast-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-3" | "ca-central-1" | "eu-central-1" | "eu-central-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-north-1" | "eu-south-1" | "il-central-1" | "me-central-1" | "sa-east-1";
2123
- /**
2124
- * @description * `CREATE_IN_PROGRESS` - Create in Progress
2125
- * * `PUBLISH_IN_PROGRESS` - Publish in Progress
2126
- * * `ACTIVE` - Active
2127
- * * `CREATE_FAILED` - Create Failed
2128
- * * `PUBLISH_FAILED` - Publish Failed
2129
- * @enum {string}
2130
- */
2131
- StateEnum: "CREATE_IN_PROGRESS" | "PUBLISH_IN_PROGRESS" | "ACTIVE" | "CREATE_FAILED" | "PUBLISH_FAILED";
2132
- /**
2133
- * @description * `0` - Pending
2134
- * * `1` - Completed
2135
- * * `2` - Failed
2136
- * @enum {integer}
2137
- */
2138
- Status1d2Enum: 0 | 1 | 2;
2139
- UserEmailPreferences: {
2140
- /** @description Receive email notifications about Node.js runtime deprecations */
2141
- node_deprecation_notifications?: boolean;
2142
- /** @description Receive email notifications about custom domain certificate changes */
2143
- custom_domain_certificate_notifications?: boolean;
2144
- /**
2145
- * Format: date-time
2146
- * @description Timestamp in the extended ISO 8601 format for when the object was created.
2147
- */
2148
- readonly created_at?: string;
2149
- /**
2150
- * Format: date-time
2151
- * @description Timestamp in the extended ISO 8601 format for when the object was last updated.
2152
- */
2153
- readonly updated_at?: string;
2154
- };
2155
- /**
2156
- * @description * `pending_validation` - Pending Validation
2157
- * * `validation_succeeded` - Validation Succeeded
2158
- * * `validation_failed` - Validation Failed
2159
- * @enum {string}
2160
- */
2161
- ValidationStatusEnum: "pending_validation" | "validation_succeeded" | "validation_failed";
2162
- };
2163
- responses: never;
2164
- parameters: never;
2165
- requestBodies: never;
2166
- headers: never;
2167
- pathItems: never;
2168
- }
2169
- export type $defs = Record<string, never>;
2170
- export interface operations {
2171
- organizations_list: {
2172
- parameters: {
2173
- query?: {
2174
- /** @description Number of results to return per page. */
2175
- limit?: number;
2176
- /** @description The initial index from which to return the results. */
2177
- offset?: number;
2178
- };
2179
- header?: never;
2180
- path?: never;
2181
- cookie?: never;
2182
- };
2183
- requestBody?: never;
2184
- responses: {
2185
- 200: {
2186
- headers: {
2187
- [name: string]: unknown;
2188
- };
2189
- content: {
2190
- "application/json": components["schemas"]["PaginatedAPIOrganizationList"];
2191
- };
2192
- };
2193
- };
2194
- };
2195
- organizations_certificates_list: {
2196
- parameters: {
2197
- query?: {
2198
- /** @description If true, returns only custom domain certificates created by the customer. */
2199
- custom_only?: boolean;
2200
- /** @description Number of results to return per page. */
2201
- limit?: number;
2202
- /** @description The initial index from which to return the results. */
2203
- offset?: number;
2204
- /** @description Which field to use when ordering the results. */
2205
- ordering?: string;
2206
- /** @description A search term. */
2207
- search?: string;
2208
- };
2209
- header?: never;
2210
- path: {
2211
- /** @description The organization identifier. */
2212
- organization_slug: string;
2213
- };
2214
- cookie?: never;
2215
- };
2216
- requestBody?: never;
2217
- responses: {
2218
- 200: {
2219
- headers: {
2220
- [name: string]: unknown;
2221
- };
2222
- content: {
2223
- "application/json": components["schemas"]["PaginatedCertificateListCreateList"];
2224
- };
2225
- };
2226
- };
2227
- };
2228
- organizations_certificates_create: {
2229
- parameters: {
2230
- query?: never;
2231
- header?: never;
2232
- path: {
2233
- /** @description The organization identifier. */
2234
- organization_slug: string;
2235
- };
2236
- cookie?: never;
2237
- };
2238
- requestBody: {
2239
- content: {
2240
- "application/json": components["schemas"]["CertificateListCreate"];
2241
- "application/x-www-form-urlencoded": components["schemas"]["CertificateListCreate"];
2242
- "multipart/form-data": components["schemas"]["CertificateListCreate"];
2243
- };
2244
- };
2245
- responses: {
2246
- 201: {
2247
- headers: {
2248
- [name: string]: unknown;
2249
- };
2250
- content: {
2251
- "application/json": components["schemas"]["CertificateListCreate"];
2252
- };
2253
- };
2254
- };
2255
- };
2256
- organizations_certificates_retrieve: {
2257
- parameters: {
2258
- query?: never;
2259
- header?: never;
2260
- path: {
2261
- /** @description The certificate's id */
2262
- cert_id: string;
2263
- /** @description The organization identifier. */
2264
- organization_slug: string;
2265
- };
2266
- cookie?: never;
2267
- };
2268
- requestBody?: never;
2269
- responses: {
2270
- 200: {
2271
- headers: {
2272
- [name: string]: unknown;
2273
- };
2274
- content: {
2275
- "application/json": components["schemas"]["CertificateBase"];
2276
- };
2277
- };
2278
- };
2279
- };
2280
- organizations_certificates_destroy: {
2281
- parameters: {
2282
- query?: never;
2283
- header?: never;
2284
- path: {
2285
- /** @description The certificate's id */
2286
- cert_id: string;
2287
- /** @description The organization identifier. */
2288
- organization_slug: string;
2289
- };
2290
- cookie?: never;
2291
- };
2292
- requestBody?: never;
2293
- responses: {
2294
- /** @description No response body */
2295
- 204: {
2296
- headers: {
2297
- [name: string]: unknown;
2298
- };
2299
- content?: never;
2300
- };
2301
- };
2302
- };
2303
- organizations_certificates_restart_validation_update: {
2304
- parameters: {
2305
- query?: never;
2306
- header?: never;
2307
- path: {
2308
- /** @description Certificate ID */
2309
- cert_id: string;
2310
- /** @description The organization identifier. */
2311
- organization_slug: string;
2312
- };
2313
- cookie?: never;
2314
- };
2315
- requestBody: {
2316
- content: {
2317
- "application/json": components["schemas"]["CertificateBase"];
2318
- "application/x-www-form-urlencoded": components["schemas"]["CertificateBase"];
2319
- "multipart/form-data": components["schemas"]["CertificateBase"];
2320
- };
2321
- };
2322
- responses: {
2323
- /** @description Certificate validation restarted successfully */
2324
- 200: {
2325
- headers: {
2326
- [name: string]: unknown;
2327
- };
2328
- content: {
2329
- "application/json": components["schemas"]["CertificateBase"];
2330
- };
2331
- };
2332
- /** @description Certificate is already validated or cannot be restarted */
2333
- 400: {
2334
- headers: {
2335
- [name: string]: unknown;
2336
- };
2337
- content?: never;
2338
- };
2339
- };
2340
- };
2341
- organizations_certificates_restart_validation_partial_update: {
2342
- parameters: {
2343
- query?: never;
2344
- header?: never;
2345
- path: {
2346
- cert_id: string;
2347
- organization_slug: string;
2348
- };
2349
- cookie?: never;
2350
- };
2351
- requestBody?: {
2352
- content: {
2353
- "application/json": components["schemas"]["PatchedCertificateBase"];
2354
- "application/x-www-form-urlencoded": components["schemas"]["PatchedCertificateBase"];
2355
- "multipart/form-data": components["schemas"]["PatchedCertificateBase"];
2356
- };
2357
- };
2358
- responses: {
2359
- 200: {
2360
- headers: {
2361
- [name: string]: unknown;
2362
- };
2363
- content: {
2364
- "application/json": components["schemas"]["CertificateBase"];
2365
- };
2366
- };
2367
- };
2368
- };
2369
- list_organization_members: {
2370
- parameters: {
2371
- query?: {
2372
- /** @description Number of results to return per page. */
2373
- limit?: number;
2374
- /** @description The initial index from which to return the results. */
2375
- offset?: number;
2376
- /** @description Which field to use when ordering the results. */
2377
- ordering?: string;
2378
- /** @description A search term. */
2379
- search?: string;
2380
- };
2381
- header?: never;
2382
- path: {
2383
- /** @description The organization identifier. */
2384
- organization_slug: string;
2385
- };
2386
- cookie?: never;
2387
- };
2388
- requestBody?: never;
2389
- responses: {
2390
- 200: {
2391
- headers: {
2392
- [name: string]: unknown;
2393
- };
2394
- content: {
2395
- "application/json": components["schemas"]["PaginatedAPIOrganizationMemberList"];
2396
- };
2397
- };
2398
- };
2399
- };
2400
- organizations_members_create: {
2401
- parameters: {
2402
- query?: never;
2403
- header?: never;
2404
- path: {
2405
- /** @description The organization identifier. */
2406
- organization_slug: string;
2407
- };
2408
- cookie?: never;
2409
- };
2410
- requestBody: {
2411
- content: {
2412
- "application/json": components["schemas"]["APIOrganizationMemberCreate"];
2413
- "application/x-www-form-urlencoded": components["schemas"]["APIOrganizationMemberCreate"];
2414
- "multipart/form-data": components["schemas"]["APIOrganizationMemberCreate"];
2415
- };
2416
- };
2417
- responses: {
2418
- 201: {
2419
- headers: {
2420
- [name: string]: unknown;
2421
- };
2422
- content: {
2423
- "application/json": components["schemas"]["APIOrganizationMemberCreate"];
2424
- };
2425
- };
2426
- };
2427
- };
2428
- organizations_members_retrieve: {
2429
- parameters: {
2430
- query?: never;
2431
- header?: never;
2432
- path: {
2433
- /** @description The email address of the organization member. */
2434
- email: string;
2435
- /** @description The organization identifier. */
2436
- organization_slug: string;
2437
- };
2438
- cookie?: never;
2439
- };
2440
- requestBody?: never;
2441
- responses: {
2442
- 200: {
2443
- headers: {
2444
- [name: string]: unknown;
2445
- };
2446
- content: {
2447
- "application/json": components["schemas"]["APIOrganizationMember"];
2448
- };
2449
- };
2450
- };
2451
- };
2452
- organizations_members_destroy: {
2453
- parameters: {
2454
- query?: never;
2455
- header?: never;
2456
- path: {
2457
- /** @description The email address of the organization member. */
2458
- email: string;
2459
- /** @description The organization identifier. */
2460
- organization_slug: string;
2461
- };
2462
- cookie?: never;
2463
- };
2464
- requestBody?: never;
2465
- responses: {
2466
- /** @description No response body */
2467
- 204: {
2468
- headers: {
2469
- [name: string]: unknown;
2470
- };
2471
- content?: never;
2472
- };
2473
- };
2474
- };
2475
- organizations_members_partial_update: {
2476
- parameters: {
2477
- query?: never;
2478
- header?: never;
2479
- path: {
2480
- /** @description The email address of the organization member. */
2481
- email: string;
2482
- /** @description The organization identifier. */
2483
- organization_slug: string;
2484
- };
2485
- cookie?: never;
2486
- };
2487
- requestBody?: {
2488
- content: {
2489
- "application/json": components["schemas"]["PatchedAPIOrganizationMemberUpdate"];
2490
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAPIOrganizationMemberUpdate"];
2491
- "multipart/form-data": components["schemas"]["PatchedAPIOrganizationMemberUpdate"];
2492
- };
2493
- };
2494
- responses: {
2495
- 200: {
2496
- headers: {
2497
- [name: string]: unknown;
2498
- };
2499
- content: {
2500
- "application/json": components["schemas"]["APIOrganizationMemberUpdate"];
2501
- };
2502
- };
2503
- };
2504
- };
2505
- projects_list: {
2506
- parameters: {
2507
- query?: {
2508
- /** @description Number of results to return per page. */
2509
- limit?: number;
2510
- /** @description The initial index from which to return the results. */
2511
- offset?: number;
2512
- /** @description An organization to search within. */
2513
- organization?: string;
2514
- };
2515
- header?: never;
2516
- path?: never;
2517
- cookie?: never;
2518
- };
2519
- requestBody?: never;
2520
- responses: {
2521
- 200: {
2522
- headers: {
2523
- [name: string]: unknown;
2524
- };
2525
- content: {
2526
- "application/json": components["schemas"]["PaginatedAPIProjectV2CreateList"];
2527
- };
2528
- };
2529
- };
2530
- };
2531
- projects_create: {
2532
- parameters: {
2533
- query?: never;
2534
- header?: never;
2535
- path?: never;
2536
- cookie?: never;
2537
- };
2538
- requestBody: {
2539
- content: {
2540
- "application/json": components["schemas"]["APIProjectV2Create"];
2541
- "application/x-www-form-urlencoded": components["schemas"]["APIProjectV2Create"];
2542
- "multipart/form-data": components["schemas"]["APIProjectV2Create"];
2543
- };
2544
- };
2545
- responses: {
2546
- 201: {
2547
- headers: {
2548
- [name: string]: unknown;
2549
- };
2550
- content: {
2551
- "application/json": components["schemas"]["APIProjectV2Create"];
2552
- };
2553
- };
2554
- };
2555
- };
2556
- projects_retrieve: {
2557
- parameters: {
2558
- query?: never;
2559
- header?: never;
2560
- path: {
2561
- /** @description The project identifier. */
2562
- project_slug: string;
2563
- };
2564
- cookie?: never;
2565
- };
2566
- requestBody?: never;
2567
- responses: {
2568
- 200: {
2569
- headers: {
2570
- [name: string]: unknown;
2571
- };
2572
- content: {
2573
- "application/json": components["schemas"]["APIProjectV2Update"];
2574
- };
2575
- };
2576
- };
2577
- };
2578
- projects_destroy: {
2579
- parameters: {
2580
- query?: never;
2581
- header?: never;
2582
- path: {
2583
- /** @description The project identifier. */
2584
- project_slug: string;
2585
- };
2586
- cookie?: never;
2587
- };
2588
- requestBody?: never;
2589
- responses: {
2590
- /** @description No response body */
2591
- 204: {
2592
- headers: {
2593
- [name: string]: unknown;
2594
- };
2595
- content?: never;
2596
- };
2597
- };
2598
- };
2599
- projects_partial_update: {
2600
- parameters: {
2601
- query?: never;
2602
- header?: never;
2603
- path: {
2604
- /** @description The project identifier. */
2605
- project_slug: string;
2606
- };
2607
- cookie?: never;
2608
- };
2609
- requestBody?: {
2610
- content: {
2611
- "application/json": components["schemas"]["PatchedAPIProjectV2Update"];
2612
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAPIProjectV2Update"];
2613
- "multipart/form-data": components["schemas"]["PatchedAPIProjectV2Update"];
2614
- };
2615
- };
2616
- responses: {
2617
- 200: {
2618
- headers: {
2619
- [name: string]: unknown;
2620
- };
2621
- content: {
2622
- "application/json": components["schemas"]["APIProjectV2Update"];
2623
- };
2624
- };
2625
- };
2626
- };
2627
- projects_builds_create: {
2628
- parameters: {
2629
- query?: never;
2630
- header?: never;
2631
- path: {
2632
- /** @description The project identifier. */
2633
- project_slug: string;
2634
- };
2635
- cookie?: never;
2636
- };
2637
- requestBody: {
2638
- content: {
2639
- "application/json": components["schemas"]["Bundle"];
2640
- "application/x-www-form-urlencoded": components["schemas"]["Bundle"];
2641
- "multipart/form-data": components["schemas"]["Bundle"];
2642
- };
2643
- };
2644
- responses: {
2645
- 200: {
2646
- headers: {
2647
- [name: string]: unknown;
2648
- };
2649
- content: {
2650
- "application/json": {
2651
- [key: string]: unknown;
2652
- };
2653
- };
2654
- };
2655
- };
2656
- };
2657
- projects_builds_create_and_deploy: {
2658
- parameters: {
2659
- query?: never;
2660
- header?: never;
2661
- path: {
2662
- /** @description The project identifier. */
2663
- project_slug: string;
2664
- /** @description The target identifier. */
2665
- target_slug: string;
2666
- };
2667
- cookie?: never;
2668
- };
2669
- requestBody: {
2670
- content: {
2671
- "application/json": components["schemas"]["Bundle"];
2672
- "application/x-www-form-urlencoded": components["schemas"]["Bundle"];
2673
- "multipart/form-data": components["schemas"]["Bundle"];
2674
- };
2675
- };
2676
- responses: {
2677
- 200: {
2678
- headers: {
2679
- [name: string]: unknown;
2680
- };
2681
- content: {
2682
- "application/json": {
2683
- [key: string]: unknown;
2684
- };
2685
- };
2686
- };
2687
- };
2688
- };
2689
- projects_bundles_list: {
2690
- parameters: {
2691
- query?: {
2692
- /** @description Number of results to return per page. */
2693
- limit?: number;
2694
- /** @description The initial index from which to return the results. */
2695
- offset?: number;
2696
- /** @description Which field to use when ordering the results. */
2697
- ordering?: string;
2698
- /** @description A search term. */
2699
- search?: string;
2700
- };
2701
- header?: never;
2702
- path: {
2703
- /** @description The project identifier. */
2704
- project_slug: string;
2705
- };
2706
- cookie?: never;
2707
- };
2708
- requestBody?: never;
2709
- responses: {
2710
- 200: {
2711
- headers: {
2712
- [name: string]: unknown;
2713
- };
2714
- content: {
2715
- "application/json": components["schemas"]["PaginatedBundleListList"];
2716
- };
2717
- };
2718
- };
2719
- };
2720
- projects_bundles_destroy: {
2721
- parameters: {
2722
- query?: never;
2723
- header?: never;
2724
- path: {
2725
- /** @description The bundle's id */
2726
- bundle_id: string;
2727
- /** @description The project identifier. */
2728
- project_slug: string;
2729
- };
2730
- cookie?: never;
2731
- };
2732
- requestBody?: never;
2733
- responses: {
2734
- /** @description Bundle deletion request accepted. The bundle will be asynchronously deleted. */
2735
- 202: {
2736
- headers: {
2737
- [name: string]: unknown;
2738
- };
2739
- content?: never;
2740
- };
2741
- /** @description Bundle deployed to one or more target, cannot delete. */
2742
- 403: {
2743
- headers: {
2744
- [name: string]: unknown;
2745
- };
2746
- content?: never;
2747
- };
2748
- /** @description Bundle not found. */
2749
- 404: {
2750
- headers: {
2751
- [name: string]: unknown;
2752
- };
2753
- content?: never;
2754
- };
2755
- /** @description Bundle cannot be deleted (in progress, in failed state). */
2756
- 409: {
2757
- headers: {
2758
- [name: string]: unknown;
2759
- };
2760
- content?: never;
2761
- };
2762
- };
2763
- };
2764
- projects_bundles_download_retrieve: {
2765
- parameters: {
2766
- query?: never;
2767
- header?: never;
2768
- path: {
2769
- /** @description The bundle's id */
2770
- bundle_id: string;
2771
- /** @description The project identifier. */
2772
- project_slug: string;
2773
- };
2774
- cookie?: never;
2775
- };
2776
- requestBody?: never;
2777
- responses: {
2778
- 200: {
2779
- headers: {
2780
- [name: string]: unknown;
2781
- };
2782
- content: {
2783
- "application/json": components["schemas"]["BundleDownload"];
2784
- };
2785
- };
2786
- };
2787
- };
2788
- projects_bundles_bulk_delete_create: {
2789
- parameters: {
2790
- query?: never;
2791
- header?: never;
2792
- path: {
2793
- /** @description The project identifier. */
2794
- project_slug: string;
2795
- };
2796
- cookie?: never;
2797
- };
2798
- requestBody: {
2799
- content: {
2800
- "application/json": components["schemas"]["BundleBulkDelete"];
2801
- "application/x-www-form-urlencoded": components["schemas"]["BundleBulkDelete"];
2802
- "multipart/form-data": components["schemas"]["BundleBulkDelete"];
2803
- };
2804
- };
2805
- responses: {
2806
- /** @description Bundle deletion was requested. Check the response body for details about the bundles that were queued and that failed deletion. */
2807
- 202: {
2808
- headers: {
2809
- [name: string]: unknown;
2810
- };
2811
- content: {
2812
- "application/json": components["schemas"]["BundleBulkDeleteResponse"];
2813
- };
2814
- };
2815
- /** @description An unexpected error occurred during the bulk delete operation. The operation has been rolled back and no bundles were deleted. */
2816
- 500: {
2817
- headers: {
2818
- [name: string]: unknown;
2819
- };
2820
- content?: never;
2821
- };
2822
- };
2823
- };
2824
- projects_members_list: {
2825
- parameters: {
2826
- query?: {
2827
- /** @description Number of results to return per page. */
2828
- limit?: number;
2829
- /** @description The initial index from which to return the results. */
2830
- offset?: number;
2831
- /** @description Which field to use when ordering the results. */
2832
- ordering?: string;
2833
- /**
2834
- * @description * `0` - Admin
2835
- * * `1` - Developer
2836
- * * `2` - Marketer
2837
- * * `3` - Read Only
2838
- *
2839
- * * `0` - Admin
2840
- * * `1` - Developer
2841
- * * `2` - Marketer
2842
- * * `3` - Read Only
2843
- */
2844
- role?: 0 | 1 | 2 | 3;
2845
- /** @description A search term. */
2846
- search?: string;
2847
- };
2848
- header?: never;
2849
- path: {
2850
- /** @description The project identifier. */
2851
- project_slug: string;
2852
- /** @description A role to filter on. Admin=0, Developer=1, Marketer=2, Read Only=3. */
2853
- role: string;
2854
- };
2855
- cookie?: never;
2856
- };
2857
- requestBody?: never;
2858
- responses: {
2859
- 200: {
2860
- headers: {
2861
- [name: string]: unknown;
2862
- };
2863
- content: {
2864
- "application/json": components["schemas"]["PaginatedAPIProjectMemberList"];
2865
- };
2866
- };
2867
- };
2868
- };
2869
- projects_members_create: {
2870
- parameters: {
2871
- query?: never;
2872
- header?: never;
2873
- path: {
2874
- /** @description The project identifier. */
2875
- project_slug: string;
2876
- };
2877
- cookie?: never;
2878
- };
2879
- requestBody: {
2880
- content: {
2881
- "application/json": components["schemas"]["APIProjectMember"];
2882
- "application/x-www-form-urlencoded": components["schemas"]["APIProjectMember"];
2883
- "multipart/form-data": components["schemas"]["APIProjectMember"];
2884
- };
2885
- };
2886
- responses: {
2887
- 201: {
2888
- headers: {
2889
- [name: string]: unknown;
2890
- };
2891
- content: {
2892
- "application/json": components["schemas"]["APIProjectMember"];
2893
- };
2894
- };
2895
- };
2896
- };
2897
- projects_members_retrieve: {
2898
- parameters: {
2899
- query?: never;
2900
- header?: never;
2901
- path: {
2902
- /** @description The project member's email address. */
2903
- email: string;
2904
- /** @description The project identifier. */
2905
- project_slug: string;
2906
- };
2907
- cookie?: never;
2908
- };
2909
- requestBody?: never;
2910
- responses: {
2911
- 200: {
2912
- headers: {
2913
- [name: string]: unknown;
2914
- };
2915
- content: {
2916
- "application/json": components["schemas"]["APIProjectMember"];
2917
- };
2918
- };
2919
- };
2920
- };
2921
- projects_members_destroy: {
2922
- parameters: {
2923
- query?: never;
2924
- header?: never;
2925
- path: {
2926
- /** @description The project member's email address. */
2927
- email: string;
2928
- /** @description The project identifier. */
2929
- project_slug: string;
2930
- };
2931
- cookie?: never;
2932
- };
2933
- requestBody?: never;
2934
- responses: {
2935
- /** @description No response body */
2936
- 204: {
2937
- headers: {
2938
- [name: string]: unknown;
2939
- };
2940
- content?: never;
2941
- };
2942
- };
2943
- };
2944
- projects_members_partial_update: {
2945
- parameters: {
2946
- query?: never;
2947
- header?: never;
2948
- path: {
2949
- /** @description The project member's email address. */
2950
- email: string;
2951
- /** @description The project identifier. */
2952
- project_slug: string;
2953
- };
2954
- cookie?: never;
2955
- };
2956
- requestBody?: {
2957
- content: {
2958
- "application/json": components["schemas"]["PatchedAPIProjectMember"];
2959
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAPIProjectMember"];
2960
- "multipart/form-data": components["schemas"]["PatchedAPIProjectMember"];
2961
- };
2962
- };
2963
- responses: {
2964
- 200: {
2965
- headers: {
2966
- [name: string]: unknown;
2967
- };
2968
- content: {
2969
- "application/json": components["schemas"]["APIProjectMember"];
2970
- };
2971
- };
2972
- };
2973
- };
2974
- projects_notifications_list: {
2975
- parameters: {
2976
- query?: {
2977
- /** @description Number of results to return per page. */
2978
- limit?: number;
2979
- /** @description The initial index from which to return the results. */
2980
- offset?: number;
2981
- targets__slug?: string;
2982
- };
2983
- header?: never;
2984
- path: {
2985
- /** @description The project identifier. */
2986
- project_slug: string;
2987
- };
2988
- cookie?: never;
2989
- };
2990
- requestBody?: never;
2991
- responses: {
2992
- 200: {
2993
- headers: {
2994
- [name: string]: unknown;
2995
- };
2996
- content: {
2997
- "application/json": components["schemas"]["PaginatedPolymorphicNotificationList"];
2998
- };
2999
- };
3000
- };
3001
- };
3002
- projects_notifications_create: {
3003
- parameters: {
3004
- query?: never;
3005
- header?: never;
3006
- path: {
3007
- /** @description The project identifier. */
3008
- project_slug: string;
3009
- };
3010
- cookie?: never;
3011
- };
3012
- requestBody?: {
3013
- content: {
3014
- "application/json": components["schemas"]["PolymorphicNotification"];
3015
- "application/x-www-form-urlencoded": components["schemas"]["PolymorphicNotification"];
3016
- "multipart/form-data": components["schemas"]["PolymorphicNotification"];
3017
- };
3018
- };
3019
- responses: {
3020
- 201: {
3021
- headers: {
3022
- [name: string]: unknown;
3023
- };
3024
- content: {
3025
- "application/json": components["schemas"]["PolymorphicNotification"];
3026
- };
3027
- };
3028
- };
3029
- };
3030
- projects_notifications_retrieve: {
3031
- parameters: {
3032
- query?: never;
3033
- header?: never;
3034
- path: {
3035
- /** @description The notification's unique UUID */
3036
- id: string;
3037
- /** @description The project identifier. */
3038
- project_slug: string;
3039
- };
3040
- cookie?: never;
3041
- };
3042
- requestBody?: never;
3043
- responses: {
3044
- 200: {
3045
- headers: {
3046
- [name: string]: unknown;
3047
- };
3048
- content: {
3049
- "application/json": components["schemas"]["PolymorphicNotification"];
3050
- };
3051
- };
3052
- };
3053
- };
3054
- projects_notifications_destroy: {
3055
- parameters: {
3056
- query?: never;
3057
- header?: never;
3058
- path: {
3059
- /** @description The notification's unique UUID */
3060
- id: string;
3061
- /** @description The project identifier. */
3062
- project_slug: string;
3063
- };
3064
- cookie?: never;
3065
- };
3066
- requestBody?: never;
3067
- responses: {
3068
- /** @description No response body */
3069
- 204: {
3070
- headers: {
3071
- [name: string]: unknown;
3072
- };
3073
- content?: never;
3074
- };
3075
- };
3076
- };
3077
- projects_notifications_partial_update: {
3078
- parameters: {
3079
- query?: never;
3080
- header?: never;
3081
- path: {
3082
- /** @description The notification's unique UUID */
3083
- id: string;
3084
- /** @description The project identifier. */
3085
- project_slug: string;
3086
- };
3087
- cookie?: never;
3088
- };
3089
- requestBody?: {
3090
- content: {
3091
- "application/json": components["schemas"]["PatchedPolymorphicNotification"];
3092
- "application/x-www-form-urlencoded": components["schemas"]["PatchedPolymorphicNotification"];
3093
- "multipart/form-data": components["schemas"]["PatchedPolymorphicNotification"];
3094
- };
3095
- };
3096
- responses: {
3097
- 200: {
3098
- headers: {
3099
- [name: string]: unknown;
3100
- };
3101
- content: {
3102
- "application/json": components["schemas"]["PolymorphicNotification"];
3103
- };
3104
- };
3105
- };
3106
- };
3107
- projects_target_list: {
3108
- parameters: {
3109
- query?: {
3110
- /** @description Number of results to return per page. */
3111
- limit?: number;
3112
- /** @description The initial index from which to return the results. */
3113
- offset?: number;
3114
- /** @description Which field to use when ordering the results. */
3115
- ordering?: string;
3116
- /** @description A search term. */
3117
- search?: string;
3118
- };
3119
- header?: never;
3120
- path: {
3121
- /** @description The project identifier. */
3122
- project_slug: string;
3123
- };
3124
- cookie?: never;
3125
- };
3126
- requestBody?: never;
3127
- responses: {
3128
- 200: {
3129
- headers: {
3130
- [name: string]: unknown;
3131
- };
3132
- content: {
3133
- "application/json": components["schemas"]["PaginatedAPITargetV2CreateList"];
3134
- };
3135
- };
3136
- };
3137
- };
3138
- projects_target_create: {
3139
- parameters: {
3140
- query?: never;
3141
- header?: never;
3142
- path: {
3143
- /** @description The project identifier. */
3144
- project_slug: string;
3145
- };
3146
- cookie?: never;
3147
- };
3148
- requestBody: {
3149
- content: {
3150
- "application/json": components["schemas"]["APITargetV2Create"];
3151
- "application/x-www-form-urlencoded": components["schemas"]["APITargetV2Create"];
3152
- "multipart/form-data": components["schemas"]["APITargetV2Create"];
3153
- };
3154
- };
3155
- responses: {
3156
- 201: {
3157
- headers: {
3158
- [name: string]: unknown;
3159
- };
3160
- content: {
3161
- "application/json": components["schemas"]["APITargetV2Create"];
3162
- };
3163
- };
3164
- };
3165
- };
3166
- projects_target_retrieve: {
3167
- parameters: {
3168
- query?: never;
3169
- header?: never;
3170
- path: {
3171
- /** @description The project identifier. */
3172
- project_slug: string;
3173
- /** @description The target identifier. */
3174
- target_slug: string;
3175
- };
3176
- cookie?: never;
3177
- };
3178
- requestBody?: never;
3179
- responses: {
3180
- 200: {
3181
- headers: {
3182
- [name: string]: unknown;
3183
- };
3184
- content: {
3185
- "application/json": components["schemas"]["APITargetV2Update"];
3186
- };
3187
- };
3188
- };
3189
- };
3190
- projects_target_destroy: {
3191
- parameters: {
3192
- query?: never;
3193
- header?: never;
3194
- path: {
3195
- /** @description The project identifier. */
3196
- project_slug: string;
3197
- /** @description The target identifier. */
3198
- target_slug: string;
3199
- };
3200
- cookie?: never;
3201
- };
3202
- requestBody?: never;
3203
- responses: {
3204
- /** @description No response body */
3205
- 204: {
3206
- headers: {
3207
- [name: string]: unknown;
3208
- };
3209
- content?: never;
3210
- };
3211
- };
3212
- };
3213
- projects_target_partial_update: {
3214
- parameters: {
3215
- query?: never;
3216
- header?: never;
3217
- path: {
3218
- /** @description The project identifier. */
3219
- project_slug: string;
3220
- /** @description The target identifier. */
3221
- target_slug: string;
3222
- };
3223
- cookie?: never;
3224
- };
3225
- requestBody?: {
3226
- content: {
3227
- "application/json": components["schemas"]["PatchedAPITargetV2Update"];
3228
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAPITargetV2Update"];
3229
- "multipart/form-data": components["schemas"]["PatchedAPITargetV2Update"];
3230
- };
3231
- };
3232
- responses: {
3233
- 200: {
3234
- headers: {
3235
- [name: string]: unknown;
3236
- };
3237
- content: {
3238
- "application/json": components["schemas"]["APITargetV2Update"];
3239
- };
3240
- };
3241
- };
3242
- };
3243
- projects_target_access_control_header_list: {
3244
- parameters: {
3245
- query?: {
3246
- /** @description Number of results to return per page. */
3247
- limit?: number;
3248
- /** @description The initial index from which to return the results. */
3249
- offset?: number;
3250
- /** @description Which field to use when ordering the results. */
3251
- ordering?: string;
3252
- /** @description A search term. */
3253
- search?: string;
3254
- };
3255
- header?: never;
3256
- path: {
3257
- /** @description The project identifier. */
3258
- project_slug: string;
3259
- /** @description The target identifier. */
3260
- target_slug: string;
3261
- };
3262
- cookie?: never;
3263
- };
3264
- requestBody?: never;
3265
- responses: {
3266
- 200: {
3267
- headers: {
3268
- [name: string]: unknown;
3269
- };
3270
- content: {
3271
- "application/json": components["schemas"]["PaginatedAPIAccessControlHeaderV2CreateList"];
3272
- };
3273
- };
3274
- };
3275
- };
3276
- projects_target_access_control_header_create: {
3277
- parameters: {
3278
- query?: never;
3279
- header?: never;
3280
- path: {
3281
- /** @description The project identifier. */
3282
- project_slug: string;
3283
- /** @description The target identifier. */
3284
- target_slug: string;
3285
- };
3286
- cookie?: never;
3287
- };
3288
- requestBody: {
3289
- content: {
3290
- "application/json": components["schemas"]["APIAccessControlHeaderV2Create"];
3291
- "application/x-www-form-urlencoded": components["schemas"]["APIAccessControlHeaderV2Create"];
3292
- "multipart/form-data": components["schemas"]["APIAccessControlHeaderV2Create"];
3293
- };
3294
- };
3295
- responses: {
3296
- 201: {
3297
- headers: {
3298
- [name: string]: unknown;
3299
- };
3300
- content: {
3301
- "application/json": components["schemas"]["APIAccessControlHeaderV2Create"];
3302
- };
3303
- };
3304
- };
3305
- };
3306
- projects_target_access_control_header_retrieve: {
3307
- parameters: {
3308
- query?: never;
3309
- header?: never;
3310
- path: {
3311
- /** @description The access control header's id. */
3312
- id: string;
3313
- /** @description The project identifier. */
3314
- project_slug: string;
3315
- /** @description The target identifier. */
3316
- target_slug: string;
3317
- };
3318
- cookie?: never;
3319
- };
3320
- requestBody?: never;
3321
- responses: {
3322
- 200: {
3323
- headers: {
3324
- [name: string]: unknown;
3325
- };
3326
- content: {
3327
- "application/json": components["schemas"]["APIAccessControlHeaderV2Create"];
3328
- };
3329
- };
3330
- };
3331
- };
3332
- projects_target_access_control_header_destroy: {
3333
- parameters: {
3334
- query?: never;
3335
- header?: never;
3336
- path: {
3337
- /** @description The access control header's id. */
3338
- id: string;
3339
- /** @description The project identifier. */
3340
- project_slug: string;
3341
- /** @description The target identifier. */
3342
- target_slug: string;
3343
- };
3344
- cookie?: never;
3345
- };
3346
- requestBody?: never;
3347
- responses: {
3348
- /** @description No response body */
3349
- 204: {
3350
- headers: {
3351
- [name: string]: unknown;
3352
- };
3353
- content?: never;
3354
- };
3355
- };
3356
- };
3357
- projects_target_clone_create: {
3358
- parameters: {
3359
- query?: never;
3360
- header?: never;
3361
- path: {
3362
- /** @description The project identifier. */
3363
- project_slug: string;
3364
- /** @description The target identifier. */
3365
- target_slug: string;
3366
- };
3367
- cookie?: never;
3368
- };
3369
- requestBody: {
3370
- content: {
3371
- "application/json": components["schemas"]["APITargetV2Clone"];
3372
- "application/x-www-form-urlencoded": components["schemas"]["APITargetV2Clone"];
3373
- "multipart/form-data": components["schemas"]["APITargetV2Clone"];
3374
- };
3375
- };
3376
- responses: {
3377
- 201: {
3378
- headers: {
3379
- [name: string]: unknown;
3380
- };
3381
- content: {
3382
- "application/json": components["schemas"]["APITargetV2Clone"];
3383
- };
3384
- };
3385
- };
3386
- };
3387
- projects_target_deploy_list: {
3388
- parameters: {
3389
- query?: {
3390
- /** @description Number of results to return per page. */
3391
- limit?: number;
3392
- /** @description The initial index from which to return the results. */
3393
- offset?: number;
3394
- };
3395
- header?: never;
3396
- path: {
3397
- /** @description The project identifier. */
3398
- project_slug: string;
3399
- /** @description The target identifier. */
3400
- target_slug: string;
3401
- };
3402
- cookie?: never;
3403
- };
3404
- requestBody?: never;
3405
- responses: {
3406
- 200: {
3407
- headers: {
3408
- [name: string]: unknown;
3409
- };
3410
- content: {
3411
- "application/json": components["schemas"]["PaginatedDeployListList"];
3412
- };
3413
- };
3414
- };
3415
- };
3416
- projects_target_deploy_create: {
3417
- parameters: {
3418
- query?: never;
3419
- header?: never;
3420
- path: {
3421
- /** @description The project identifier. */
3422
- project_slug: string;
3423
- /** @description The target identifier. */
3424
- target_slug: string;
3425
- };
3426
- cookie?: never;
3427
- };
3428
- requestBody: {
3429
- content: {
3430
- "application/json": components["schemas"]["DeployCreate"];
3431
- "application/x-www-form-urlencoded": components["schemas"]["DeployCreate"];
3432
- "multipart/form-data": components["schemas"]["DeployCreate"];
3433
- };
3434
- };
3435
- responses: {
3436
- 201: {
3437
- headers: {
3438
- [name: string]: unknown;
3439
- };
3440
- content: {
3441
- "application/json": components["schemas"]["DeployCreate"];
3442
- };
3443
- };
3444
- };
3445
- };
3446
- projects_target_env_var_list: {
3447
- parameters: {
3448
- query?: {
3449
- /** @description Number of results to return per page. */
3450
- limit?: number;
3451
- /** @description The initial index from which to return the results. */
3452
- offset?: number;
3453
- /** @description Which field to use when ordering the results. */
3454
- ordering?: string;
3455
- /** @description A search term. */
3456
- search?: string;
3457
- };
3458
- header?: never;
3459
- path: {
3460
- /** @description The project identifier. */
3461
- project_slug: string;
3462
- /** @description The target identifier. */
3463
- target_slug: string;
3464
- };
3465
- cookie?: never;
3466
- };
3467
- requestBody?: never;
3468
- responses: {
3469
- 200: {
3470
- headers: {
3471
- [name: string]: unknown;
3472
- };
3473
- content: {
3474
- "application/json": components["schemas"]["PaginatedEnvironmentVariableListList"];
3475
- };
3476
- };
3477
- };
3478
- };
3479
- projects_target_env_var_partial_update: {
3480
- parameters: {
3481
- query?: never;
3482
- header?: never;
3483
- path: {
3484
- /** @description The project identifier. */
3485
- project_slug: string;
3486
- /** @description The target identifier. */
3487
- target_slug: string;
3488
- };
3489
- cookie?: never;
3490
- };
3491
- requestBody?: {
3492
- content: {
3493
- "application/json": {
3494
- [key: string]: unknown;
3495
- };
3496
- "application/x-www-form-urlencoded": {
3497
- [key: string]: unknown;
3498
- };
3499
- "multipart/form-data": {
3500
- [key: string]: unknown;
3501
- };
3502
- };
3503
- };
3504
- responses: {
3505
- /** @description No response body. The request was processed successfully. */
3506
- 204: {
3507
- headers: {
3508
- [name: string]: unknown;
3509
- };
3510
- content?: never;
3511
- };
3512
- };
3513
- };
3514
- projects_target_invalidation_create: {
3515
- parameters: {
3516
- query?: never;
3517
- header?: never;
3518
- path: {
3519
- /** @description The project identifier. */
3520
- project_slug: string;
3521
- /** @description The target identifier. */
3522
- target_slug: string;
3523
- };
3524
- cookie?: never;
3525
- };
3526
- requestBody: {
3527
- content: {
3528
- "application/json": components["schemas"]["APITargetV2CreateInvalidation"];
3529
- "application/x-www-form-urlencoded": components["schemas"]["APITargetV2CreateInvalidation"];
3530
- "multipart/form-data": components["schemas"]["APITargetV2CreateInvalidation"];
3531
- };
3532
- };
3533
- responses: {
3534
- 201: {
3535
- headers: {
3536
- [name: string]: unknown;
3537
- };
3538
- content: {
3539
- "application/json": components["schemas"]["APITargetV2CreateInvalidation"];
3540
- };
3541
- };
3542
- };
3543
- };
3544
- projects_target_redirect_list: {
3545
- parameters: {
3546
- query?: {
3547
- /** @description Number of results to return per page. */
3548
- limit?: number;
3549
- /** @description The initial index from which to return the results. */
3550
- offset?: number;
3551
- /** @description Which field to use when ordering the results. */
3552
- ordering?: string;
3553
- /** @description A search term. */
3554
- search?: string;
3555
- };
3556
- header?: never;
3557
- path: {
3558
- /** @description The project identifier. */
3559
- project_slug: string;
3560
- /** @description The target identifier. */
3561
- target_slug: string;
3562
- };
3563
- cookie?: never;
3564
- };
3565
- requestBody?: never;
3566
- responses: {
3567
- 200: {
3568
- headers: {
3569
- [name: string]: unknown;
3570
- };
3571
- content: {
3572
- "application/json": components["schemas"]["PaginatedAPIRedirectV2CreateUpdateList"];
3573
- };
3574
- };
3575
- };
3576
- };
3577
- projects_target_redirect_create: {
3578
- parameters: {
3579
- query?: never;
3580
- header?: never;
3581
- path: {
3582
- /** @description The project identifier. */
3583
- project_slug: string;
3584
- /** @description The target identifier. */
3585
- target_slug: string;
3586
- };
3587
- cookie?: never;
3588
- };
3589
- requestBody: {
3590
- content: {
3591
- "application/json": components["schemas"]["APIRedirectV2CreateUpdate"];
3592
- "application/x-www-form-urlencoded": components["schemas"]["APIRedirectV2CreateUpdate"];
3593
- "multipart/form-data": components["schemas"]["APIRedirectV2CreateUpdate"];
3594
- };
3595
- };
3596
- responses: {
3597
- /** @description The request was processed successfully. */
3598
- 201: {
3599
- headers: {
3600
- [name: string]: unknown;
3601
- };
3602
- content: {
3603
- "application/json": components["schemas"]["APIRedirectV2CreateUpdate"];
3604
- };
3605
- };
3606
- };
3607
- };
3608
- projects_target_redirect_retrieve: {
3609
- parameters: {
3610
- query?: never;
3611
- header?: never;
3612
- path: {
3613
- /** @description The redirect's `from_path`. */
3614
- from_path: string;
3615
- /** @description The project identifier. */
3616
- project_slug: string;
3617
- /** @description The target identifier. */
3618
- target_slug: string;
3619
- };
3620
- cookie?: never;
3621
- };
3622
- requestBody?: never;
3623
- responses: {
3624
- 200: {
3625
- headers: {
3626
- [name: string]: unknown;
3627
- };
3628
- content: {
3629
- "application/json": components["schemas"]["APIRedirectV2CreateUpdate"];
3630
- };
3631
- };
3632
- };
3633
- };
3634
- projects_target_redirect_destroy: {
3635
- parameters: {
3636
- query?: never;
3637
- header?: never;
3638
- path: {
3639
- /** @description The redirect's `from_path`. */
3640
- from_path: string;
3641
- /** @description The project identifier. */
3642
- project_slug: string;
3643
- /** @description The target identifier. */
3644
- target_slug: string;
3645
- };
3646
- cookie?: never;
3647
- };
3648
- requestBody?: never;
3649
- responses: {
3650
- /** @description No response body. The request was processed successfully. */
3651
- 204: {
3652
- headers: {
3653
- [name: string]: unknown;
3654
- };
3655
- content?: never;
3656
- };
3657
- };
3658
- };
3659
- projects_target_redirect_partial_update: {
3660
- parameters: {
3661
- query?: never;
3662
- header?: never;
3663
- path: {
3664
- /** @description The redirect's `from_path`. */
3665
- from_path: string;
3666
- /** @description The project identifier. */
3667
- project_slug: string;
3668
- /** @description The target identifier. */
3669
- target_slug: string;
3670
- };
3671
- cookie?: never;
3672
- };
3673
- requestBody?: {
3674
- content: {
3675
- "application/json": components["schemas"]["PatchedAPIRedirectV2CreateUpdate"];
3676
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAPIRedirectV2CreateUpdate"];
3677
- "multipart/form-data": components["schemas"]["PatchedAPIRedirectV2CreateUpdate"];
3678
- };
3679
- };
3680
- responses: {
3681
- /** @description The request was processed successfully. */
3682
- 200: {
3683
- headers: {
3684
- [name: string]: unknown;
3685
- };
3686
- content: {
3687
- "application/json": components["schemas"]["APIRedirectV2CreateUpdate"];
3688
- };
3689
- };
3690
- };
3691
- };
3692
- projects_target_redirect_clone_create: {
3693
- parameters: {
3694
- query?: never;
3695
- header?: never;
3696
- path: {
3697
- /** @description The project identifier. */
3698
- project_slug: string;
3699
- /** @description The destination target identifier for the clone operation. */
3700
- to_target_slug: string;
3701
- };
3702
- cookie?: never;
3703
- };
3704
- requestBody: {
3705
- content: {
3706
- "application/json": components["schemas"]["APIRedirectV2Clone"];
3707
- "application/x-www-form-urlencoded": components["schemas"]["APIRedirectV2Clone"];
3708
- "multipart/form-data": components["schemas"]["APIRedirectV2Clone"];
3709
- };
3710
- };
3711
- responses: {
3712
- 201: {
3713
- headers: {
3714
- [name: string]: unknown;
3715
- };
3716
- content: {
3717
- "application/json": components["schemas"]["APIRedirectV2Clone"];
3718
- };
3719
- };
3720
- };
3721
- };
3722
- users_me_api_key_create: {
3723
- parameters: {
3724
- query?: never;
3725
- header?: never;
3726
- path?: never;
3727
- cookie?: never;
3728
- };
3729
- requestBody?: never;
3730
- responses: {
3731
- 201: {
3732
- headers: {
3733
- [name: string]: unknown;
3734
- };
3735
- content: {
3736
- "application/json": {
3737
- [key: string]: unknown;
3738
- };
3739
- };
3740
- };
3741
- };
3742
- };
3743
- users_me_email_preferences_retrieve: {
3744
- parameters: {
3745
- query?: never;
3746
- header?: never;
3747
- path?: never;
3748
- cookie?: never;
3749
- };
3750
- requestBody?: never;
3751
- responses: {
3752
- 200: {
3753
- headers: {
3754
- [name: string]: unknown;
3755
- };
3756
- content: {
3757
- "application/json": components["schemas"]["UserEmailPreferences"];
3758
- };
3759
- };
3760
- };
3761
- };
3762
- users_me_email_preferences_partial_update: {
3763
- parameters: {
3764
- query?: never;
3765
- header?: never;
3766
- path?: never;
3767
- cookie?: never;
3768
- };
3769
- requestBody?: {
3770
- content: {
3771
- "application/json": components["schemas"]["PatchedUserEmailPreferences"];
3772
- "application/x-www-form-urlencoded": components["schemas"]["PatchedUserEmailPreferences"];
3773
- "multipart/form-data": components["schemas"]["PatchedUserEmailPreferences"];
3774
- };
3775
- };
3776
- responses: {
3777
- 200: {
3778
- headers: {
3779
- [name: string]: unknown;
3780
- };
3781
- content: {
3782
- "application/json": components["schemas"]["UserEmailPreferences"];
3783
- };
3784
- };
3785
- };
3786
- };
3787
- users_me_profile_retrieve: {
3788
- parameters: {
3789
- query?: never;
3790
- header?: never;
3791
- path?: never;
3792
- cookie?: never;
3793
- };
3794
- requestBody?: never;
3795
- responses: {
3796
- 200: {
3797
- headers: {
3798
- [name: string]: unknown;
3799
- };
3800
- content: {
3801
- "application/json": components["schemas"]["APIUserProfile"];
3802
- };
3803
- };
3804
- };
3805
- };
3806
- }