@salesforce/b2c-tooling-sdk 1.24.2 → 2.0.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 (460) hide show
  1. package/data/content-schemas/componenttype.json +0 -30
  2. package/data/scapi-snippets/campaign-promotions.js +40 -0
  3. package/data/scapi-snippets/code-version-inspect.js +31 -0
  4. package/data/scapi-snippets/create-product.js +108 -0
  5. package/data/scapi-snippets/failed-job-triage.js +37 -0
  6. package/data/scapi-snippets/job-execution-inspect.js +52 -0
  7. package/data/scapi-snippets/job-execution-review.js +46 -0
  8. package/data/scapi-snippets/manifest.json +220 -0
  9. package/data/scapi-snippets/site-cartridge-inspect.js +27 -0
  10. package/data/tooling/index.json +80 -116
  11. package/dist/esm/auth/index.d.ts +2 -2
  12. package/dist/esm/auth/index.js +1 -1
  13. package/dist/esm/auth/index.js.map +1 -1
  14. package/dist/esm/auth/oauth-implicit.d.ts +1 -0
  15. package/dist/esm/auth/oauth-implicit.js +1 -0
  16. package/dist/esm/auth/oauth-implicit.js.map +1 -1
  17. package/dist/esm/auth/oauth-jwt.d.ts +18 -4
  18. package/dist/esm/auth/oauth-jwt.js +67 -17
  19. package/dist/esm/auth/oauth-jwt.js.map +1 -1
  20. package/dist/esm/auth/oauth-pkce-fallback.d.ts +1 -0
  21. package/dist/esm/auth/oauth-pkce-fallback.js +1 -0
  22. package/dist/esm/auth/oauth-pkce-fallback.js.map +1 -1
  23. package/dist/esm/auth/oauth-pkce.d.ts +1 -0
  24. package/dist/esm/auth/oauth-pkce.js +1 -0
  25. package/dist/esm/auth/oauth-pkce.js.map +1 -1
  26. package/dist/esm/auth/oauth.d.ts +55 -6
  27. package/dist/esm/auth/oauth.js +139 -21
  28. package/dist/esm/auth/oauth.js.map +1 -1
  29. package/dist/esm/auth/resolve.d.ts +37 -0
  30. package/dist/esm/auth/resolve.js +48 -0
  31. package/dist/esm/auth/resolve.js.map +1 -1
  32. package/dist/esm/auth/types.d.ts +44 -0
  33. package/dist/esm/auth/types.js.map +1 -1
  34. package/dist/esm/cli/base-command.d.ts +9 -0
  35. package/dist/esm/cli/base-command.js +31 -0
  36. package/dist/esm/cli/base-command.js.map +1 -1
  37. package/dist/esm/cli/bm-command.d.ts +15 -0
  38. package/dist/esm/cli/bm-command.js +25 -0
  39. package/dist/esm/cli/bm-command.js.map +1 -0
  40. package/dist/esm/cli/code-command.d.ts +14 -0
  41. package/dist/esm/cli/code-command.js +22 -0
  42. package/dist/esm/cli/code-command.js.map +1 -0
  43. package/dist/esm/cli/config.js +3 -0
  44. package/dist/esm/cli/config.js.map +1 -1
  45. package/dist/esm/cli/index.d.ts +5 -1
  46. package/dist/esm/cli/index.js +7 -1
  47. package/dist/esm/cli/index.js.map +1 -1
  48. package/dist/esm/cli/instance-command.d.ts +45 -0
  49. package/dist/esm/cli/instance-command.js +66 -1
  50. package/dist/esm/cli/instance-command.js.map +1 -1
  51. package/dist/esm/cli/job-command.d.ts +37 -16
  52. package/dist/esm/cli/job-command.js +73 -23
  53. package/dist/esm/cli/job-command.js.map +1 -1
  54. package/dist/esm/cli/mrt-command.d.ts +138 -9
  55. package/dist/esm/cli/mrt-command.js +277 -16
  56. package/dist/esm/cli/mrt-command.js.map +1 -1
  57. package/dist/esm/cli/oauth-command.d.ts +1 -1
  58. package/dist/esm/cli/oauth-command.js +2 -0
  59. package/dist/esm/cli/oauth-command.js.map +1 -1
  60. package/dist/esm/cli/webdav-command.d.ts +1 -0
  61. package/dist/esm/clients/cdn-zones.js +2 -5
  62. package/dist/esm/clients/cdn-zones.js.map +1 -1
  63. package/dist/esm/clients/cip.d.ts +12 -3
  64. package/dist/esm/clients/cip.js +85 -30
  65. package/dist/esm/clients/cip.js.map +1 -1
  66. package/dist/esm/clients/custom-apis.js +2 -5
  67. package/dist/esm/clients/custom-apis.js.map +1 -1
  68. package/dist/esm/clients/dual-backend-factory.d.ts +70 -0
  69. package/dist/esm/clients/dual-backend-factory.js +48 -0
  70. package/dist/esm/clients/dual-backend-factory.js.map +1 -0
  71. package/dist/esm/clients/error-utils.d.ts +62 -0
  72. package/dist/esm/clients/error-utils.js +98 -0
  73. package/dist/esm/clients/error-utils.js.map +1 -1
  74. package/dist/esm/clients/granular-replications.js +2 -5
  75. package/dist/esm/clients/granular-replications.js.map +1 -1
  76. package/dist/esm/clients/index.d.ts +28 -3
  77. package/dist/esm/clients/index.js +24 -2
  78. package/dist/esm/clients/index.js.map +1 -1
  79. package/dist/esm/clients/metrics.js +2 -5
  80. package/dist/esm/clients/metrics.js.map +1 -1
  81. package/dist/esm/clients/middleware-registry.d.ts +4 -2
  82. package/dist/esm/clients/middleware-registry.js +3 -1
  83. package/dist/esm/clients/middleware-registry.js.map +1 -1
  84. package/dist/esm/clients/middleware.d.ts +39 -0
  85. package/dist/esm/clients/middleware.js +126 -25
  86. package/dist/esm/clients/middleware.js.map +1 -1
  87. package/dist/esm/clients/mrt-b2c.js +3 -0
  88. package/dist/esm/clients/mrt-b2c.js.map +1 -1
  89. package/dist/esm/clients/mrt.d.ts +27 -10
  90. package/dist/esm/clients/mrt.generated.d.ts +77 -0
  91. package/dist/esm/clients/mrt.js +68 -0
  92. package/dist/esm/clients/mrt.js.map +1 -1
  93. package/dist/esm/clients/preferences.js +2 -5
  94. package/dist/esm/clients/preferences.js.map +1 -1
  95. package/dist/esm/clients/scapi-backend-utils.d.ts +163 -0
  96. package/dist/esm/clients/scapi-backend-utils.js +180 -0
  97. package/dist/esm/clients/scapi-backend-utils.js.map +1 -0
  98. package/dist/esm/clients/scapi-catalogs.d.ts +12 -0
  99. package/dist/esm/clients/scapi-catalogs.generated.d.ts +104 -0
  100. package/dist/esm/clients/scapi-catalogs.generated.js +6 -0
  101. package/dist/esm/clients/scapi-catalogs.generated.js.map +1 -0
  102. package/dist/esm/clients/scapi-catalogs.js +14 -0
  103. package/dist/esm/clients/scapi-catalogs.js.map +1 -0
  104. package/dist/esm/clients/scapi-client-factory.d.ts +81 -0
  105. package/dist/esm/clients/scapi-client-factory.js +84 -0
  106. package/dist/esm/clients/scapi-client-factory.js.map +1 -0
  107. package/dist/esm/clients/scapi-fallback-backend.d.ts +34 -0
  108. package/dist/esm/clients/scapi-fallback-backend.js +132 -0
  109. package/dist/esm/clients/scapi-fallback-backend.js.map +1 -0
  110. package/dist/esm/clients/scapi-jobs.d.ts +32 -0
  111. package/dist/esm/clients/scapi-jobs.generated.d.ts +535 -0
  112. package/dist/esm/clients/scapi-jobs.generated.js +6 -0
  113. package/dist/esm/clients/scapi-jobs.generated.js.map +1 -0
  114. package/dist/esm/clients/scapi-jobs.js +24 -0
  115. package/dist/esm/clients/scapi-jobs.js.map +1 -0
  116. package/dist/esm/clients/scapi-merchant-roles.d.ts +19 -0
  117. package/dist/esm/clients/scapi-merchant-roles.generated.d.ts +726 -0
  118. package/dist/esm/clients/scapi-merchant-roles.generated.js +6 -0
  119. package/dist/esm/clients/scapi-merchant-roles.generated.js.map +1 -0
  120. package/dist/esm/clients/scapi-merchant-roles.js +12 -0
  121. package/dist/esm/clients/scapi-merchant-roles.js.map +1 -0
  122. package/dist/esm/clients/scapi-merchant-users.d.ts +19 -0
  123. package/dist/esm/clients/scapi-merchant-users.generated.d.ts +300 -0
  124. package/dist/esm/clients/scapi-merchant-users.generated.js +6 -0
  125. package/dist/esm/clients/scapi-merchant-users.generated.js.map +1 -0
  126. package/dist/esm/clients/scapi-merchant-users.js +12 -0
  127. package/dist/esm/clients/scapi-merchant-users.js.map +1 -0
  128. package/dist/esm/clients/scapi-schemas.js +2 -5
  129. package/dist/esm/clients/scapi-schemas.js.map +1 -1
  130. package/dist/esm/clients/scapi-scope-tier.d.ts +78 -0
  131. package/dist/esm/clients/scapi-scope-tier.js +113 -0
  132. package/dist/esm/clients/scapi-scope-tier.js.map +1 -0
  133. package/dist/esm/clients/scapi-scripts.d.ts +17 -0
  134. package/dist/esm/clients/scapi-scripts.generated.d.ts +392 -0
  135. package/dist/esm/clients/scapi-scripts.generated.js +6 -0
  136. package/dist/esm/clients/scapi-scripts.generated.js.map +1 -0
  137. package/dist/esm/clients/scapi-scripts.js +12 -0
  138. package/dist/esm/clients/scapi-scripts.js.map +1 -0
  139. package/dist/esm/clients/scapi-sites.d.ts +26 -0
  140. package/dist/esm/clients/scapi-sites.generated.d.ts +500 -0
  141. package/dist/esm/clients/scapi-sites.generated.js +6 -0
  142. package/dist/esm/clients/scapi-sites.generated.js.map +1 -0
  143. package/dist/esm/clients/scapi-sites.js +25 -0
  144. package/dist/esm/clients/scapi-sites.js.map +1 -0
  145. package/dist/esm/clients/slas-shopper.d.ts +19 -0
  146. package/dist/esm/clients/slas-shopper.generated.d.ts +165 -0
  147. package/dist/esm/clients/slas-shopper.generated.js +6 -0
  148. package/dist/esm/clients/slas-shopper.generated.js.map +1 -0
  149. package/dist/esm/clients/slas-shopper.js +35 -0
  150. package/dist/esm/clients/slas-shopper.js.map +1 -0
  151. package/dist/esm/clients/storefront-deployments.d.ts +56 -0
  152. package/dist/esm/clients/storefront-deployments.generated.d.ts +558 -0
  153. package/dist/esm/clients/storefront-deployments.generated.js +6 -0
  154. package/dist/esm/clients/storefront-deployments.generated.js.map +1 -0
  155. package/dist/esm/clients/storefront-deployments.js +24 -0
  156. package/dist/esm/clients/storefront-deployments.js.map +1 -0
  157. package/dist/esm/clients/webdav.js +4 -1
  158. package/dist/esm/clients/webdav.js.map +1 -1
  159. package/dist/esm/compat/dispatcher.d.ts +49 -0
  160. package/dist/esm/compat/dispatcher.js +124 -0
  161. package/dist/esm/compat/dispatcher.js.map +1 -0
  162. package/dist/esm/compat/index.d.ts +10 -0
  163. package/dist/esm/compat/index.js +15 -0
  164. package/dist/esm/compat/index.js.map +1 -0
  165. package/dist/esm/compat/jobs-backend.d.ts +31 -0
  166. package/dist/esm/compat/jobs-backend.js +76 -0
  167. package/dist/esm/compat/jobs-backend.js.map +1 -0
  168. package/dist/esm/config/dw-json.d.ts +4 -0
  169. package/dist/esm/config/dw-json.js.map +1 -1
  170. package/dist/esm/config/index.d.ts +1 -1
  171. package/dist/esm/config/index.js.map +1 -1
  172. package/dist/esm/config/mapping.d.ts +2 -5
  173. package/dist/esm/config/mapping.js +25 -1
  174. package/dist/esm/config/mapping.js.map +1 -1
  175. package/dist/esm/config/resolved-config.d.ts +2 -2
  176. package/dist/esm/config/resolved-config.js.map +1 -1
  177. package/dist/esm/config/sources/env-source.js +17 -0
  178. package/dist/esm/config/sources/env-source.js.map +1 -1
  179. package/dist/esm/config/types.d.ts +21 -2
  180. package/dist/esm/docs/search.js +2 -25
  181. package/dist/esm/docs/search.js.map +1 -1
  182. package/dist/esm/guidance/catalog.d.ts +37 -0
  183. package/dist/esm/guidance/catalog.js +282 -0
  184. package/dist/esm/guidance/catalog.js.map +1 -0
  185. package/dist/esm/guidance/index.d.ts +8 -0
  186. package/dist/esm/guidance/index.js +14 -0
  187. package/dist/esm/guidance/index.js.map +1 -0
  188. package/dist/esm/guidance/markdown.d.ts +10 -0
  189. package/dist/esm/guidance/markdown.js +52 -0
  190. package/dist/esm/guidance/markdown.js.map +1 -0
  191. package/dist/esm/guidance/types.d.ts +92 -0
  192. package/dist/esm/guidance/types.js +17 -0
  193. package/dist/esm/guidance/types.js.map +1 -0
  194. package/dist/esm/index.d.ts +14 -5
  195. package/dist/esm/index.js +14 -2
  196. package/dist/esm/index.js.map +1 -1
  197. package/dist/esm/instance/index.d.ts +96 -2
  198. package/dist/esm/instance/index.js +98 -5
  199. package/dist/esm/instance/index.js.map +1 -1
  200. package/dist/esm/operations/bm-roles/backend.d.ts +4 -0
  201. package/dist/esm/operations/bm-roles/backend.js +11 -0
  202. package/dist/esm/operations/bm-roles/backend.js.map +1 -0
  203. package/dist/esm/operations/bm-roles/index.d.ts +6 -0
  204. package/dist/esm/operations/bm-roles/index.js +4 -0
  205. package/dist/esm/operations/bm-roles/index.js.map +1 -1
  206. package/dist/esm/operations/bm-roles/ocapi-backend.d.ts +17 -0
  207. package/dist/esm/operations/bm-roles/ocapi-backend.js +151 -0
  208. package/dist/esm/operations/bm-roles/ocapi-backend.js.map +1 -0
  209. package/dist/esm/operations/bm-roles/roles.js +13 -17
  210. package/dist/esm/operations/bm-roles/roles.js.map +1 -1
  211. package/dist/esm/operations/bm-roles/scapi-backend.d.ts +27 -0
  212. package/dist/esm/operations/bm-roles/scapi-backend.js +138 -0
  213. package/dist/esm/operations/bm-roles/scapi-backend.js.map +1 -0
  214. package/dist/esm/operations/bm-roles/types.d.ts +49 -0
  215. package/dist/esm/operations/bm-roles/types.js +2 -0
  216. package/dist/esm/operations/bm-roles/types.js.map +1 -0
  217. package/dist/esm/operations/bm-users/backend.d.ts +4 -0
  218. package/dist/esm/operations/bm-users/backend.js +11 -0
  219. package/dist/esm/operations/bm-users/backend.js.map +1 -0
  220. package/dist/esm/operations/bm-users/index.d.ts +11 -3
  221. package/dist/esm/operations/bm-users/index.js +9 -3
  222. package/dist/esm/operations/bm-users/index.js.map +1 -1
  223. package/dist/esm/operations/bm-users/ocapi-backend.d.ts +13 -0
  224. package/dist/esm/operations/bm-users/ocapi-backend.js +92 -0
  225. package/dist/esm/operations/bm-users/ocapi-backend.js.map +1 -0
  226. package/dist/esm/operations/bm-users/scapi-backend.d.ts +23 -0
  227. package/dist/esm/operations/bm-users/scapi-backend.js +199 -0
  228. package/dist/esm/operations/bm-users/scapi-backend.js.map +1 -0
  229. package/dist/esm/operations/bm-users/types.d.ts +99 -0
  230. package/dist/esm/operations/bm-users/types.js +2 -0
  231. package/dist/esm/operations/bm-users/types.js.map +1 -0
  232. package/dist/esm/operations/bm-users/users.d.ts +4 -3
  233. package/dist/esm/operations/bm-users/users.js +23 -19
  234. package/dist/esm/operations/bm-users/users.js.map +1 -1
  235. package/dist/esm/operations/cap/install.js +23 -45
  236. package/dist/esm/operations/cap/install.js.map +1 -1
  237. package/dist/esm/operations/cap/list.js +4 -8
  238. package/dist/esm/operations/cap/list.js.map +1 -1
  239. package/dist/esm/operations/cap/uninstall.js +17 -37
  240. package/dist/esm/operations/cap/uninstall.js.map +1 -1
  241. package/dist/esm/operations/catalogs/catalogs-backend.d.ts +4 -0
  242. package/dist/esm/operations/catalogs/catalogs-backend.js +16 -0
  243. package/dist/esm/operations/catalogs/catalogs-backend.js.map +1 -0
  244. package/dist/esm/operations/catalogs/catalogs-types.d.ts +14 -0
  245. package/dist/esm/operations/catalogs/catalogs-types.js +2 -0
  246. package/dist/esm/operations/catalogs/catalogs-types.js.map +1 -0
  247. package/dist/esm/operations/catalogs/index.d.ts +7 -0
  248. package/dist/esm/operations/catalogs/index.js +10 -0
  249. package/dist/esm/operations/catalogs/index.js.map +1 -0
  250. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.d.ts +8 -0
  251. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js +36 -0
  252. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js.map +1 -0
  253. package/dist/esm/operations/catalogs/scapi-catalogs-backend.d.ts +15 -0
  254. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js +42 -0
  255. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js.map +1 -0
  256. package/dist/esm/operations/cip/index.js +10 -2
  257. package/dist/esm/operations/cip/index.js.map +1 -1
  258. package/dist/esm/operations/cip/reports.js +19 -3
  259. package/dist/esm/operations/cip/reports.js.map +1 -1
  260. package/dist/esm/operations/cip/types.d.ts +8 -4
  261. package/dist/esm/operations/code/deploy.d.ts +3 -0
  262. package/dist/esm/operations/code/deploy.js +5 -3
  263. package/dist/esm/operations/code/deploy.js.map +1 -1
  264. package/dist/esm/operations/code/download.d.ts +3 -0
  265. package/dist/esm/operations/code/download.js +5 -5
  266. package/dist/esm/operations/code/download.js.map +1 -1
  267. package/dist/esm/operations/code/index.d.ts +7 -1
  268. package/dist/esm/operations/code/index.js +5 -1
  269. package/dist/esm/operations/code/index.js.map +1 -1
  270. package/dist/esm/operations/code/ocapi-scripts-backend.d.ts +12 -0
  271. package/dist/esm/operations/code/ocapi-scripts-backend.js +40 -0
  272. package/dist/esm/operations/code/ocapi-scripts-backend.js.map +1 -0
  273. package/dist/esm/operations/code/scapi-scripts-backend.d.ts +22 -0
  274. package/dist/esm/operations/code/scapi-scripts-backend.js +94 -0
  275. package/dist/esm/operations/code/scapi-scripts-backend.js.map +1 -0
  276. package/dist/esm/operations/code/scripts-backend.d.ts +17 -0
  277. package/dist/esm/operations/code/scripts-backend.js +40 -0
  278. package/dist/esm/operations/code/scripts-backend.js.map +1 -0
  279. package/dist/esm/operations/code/scripts-types.d.ts +43 -0
  280. package/dist/esm/operations/code/scripts-types.js +2 -0
  281. package/dist/esm/operations/code/scripts-types.js.map +1 -0
  282. package/dist/esm/operations/code/upload-files.d.ts +6 -0
  283. package/dist/esm/operations/code/upload-files.js +58 -7
  284. package/dist/esm/operations/code/upload-files.js.map +1 -1
  285. package/dist/esm/operations/code/versions.d.ts +0 -20
  286. package/dist/esm/operations/code/versions.js +16 -51
  287. package/dist/esm/operations/code/versions.js.map +1 -1
  288. package/dist/esm/operations/code/watch.d.ts +3 -0
  289. package/dist/esm/operations/code/watch.js +3 -2
  290. package/dist/esm/operations/code/watch.js.map +1 -1
  291. package/dist/esm/operations/jobs/discover.d.ts +1 -1
  292. package/dist/esm/operations/jobs/discover.js +51 -21
  293. package/dist/esm/operations/jobs/discover.js.map +1 -1
  294. package/dist/esm/operations/jobs/index.d.ts +14 -57
  295. package/dist/esm/operations/jobs/index.js +15 -59
  296. package/dist/esm/operations/jobs/index.js.map +1 -1
  297. package/dist/esm/operations/jobs/ocapi-mapping.d.ts +34 -0
  298. package/dist/esm/operations/jobs/ocapi-mapping.js +100 -0
  299. package/dist/esm/operations/jobs/ocapi-mapping.js.map +1 -0
  300. package/dist/esm/operations/jobs/run-system-job.d.ts +81 -0
  301. package/dist/esm/operations/jobs/run-system-job.js +137 -0
  302. package/dist/esm/operations/jobs/run-system-job.js.map +1 -0
  303. package/dist/esm/operations/jobs/run.js +16 -4
  304. package/dist/esm/operations/jobs/run.js.map +1 -1
  305. package/dist/esm/operations/jobs/scapi-ops.d.ts +61 -0
  306. package/dist/esm/operations/jobs/scapi-ops.js +214 -0
  307. package/dist/esm/operations/jobs/scapi-ops.js.map +1 -0
  308. package/dist/esm/operations/jobs/site-archive.js +28 -66
  309. package/dist/esm/operations/jobs/site-archive.js.map +1 -1
  310. package/dist/esm/operations/jobs/types.d.ts +46 -0
  311. package/dist/esm/operations/jobs/types.js +2 -0
  312. package/dist/esm/operations/jobs/types.js.map +1 -0
  313. package/dist/esm/operations/jobs/wait-canonical.d.ts +28 -0
  314. package/dist/esm/operations/jobs/wait-canonical.js +48 -0
  315. package/dist/esm/operations/jobs/wait-canonical.js.map +1 -0
  316. package/dist/esm/operations/mrt/bundle.d.ts +164 -2
  317. package/dist/esm/operations/mrt/bundle.js +315 -9
  318. package/dist/esm/operations/mrt/bundle.js.map +1 -1
  319. package/dist/esm/operations/mrt/deployment.d.ts +221 -0
  320. package/dist/esm/operations/mrt/deployment.js +239 -0
  321. package/dist/esm/operations/mrt/deployment.js.map +1 -1
  322. package/dist/esm/operations/mrt/index.d.ts +8 -6
  323. package/dist/esm/operations/mrt/index.js +5 -3
  324. package/dist/esm/operations/mrt/index.js.map +1 -1
  325. package/dist/esm/operations/mrt/mrt-backend.d.ts +117 -0
  326. package/dist/esm/operations/mrt/mrt-backend.js +84 -0
  327. package/dist/esm/operations/mrt/mrt-backend.js.map +1 -0
  328. package/dist/esm/operations/mrt/push.d.ts +83 -1
  329. package/dist/esm/operations/mrt/push.js +102 -1
  330. package/dist/esm/operations/mrt/push.js.map +1 -1
  331. package/dist/esm/operations/sites/cartridges.d.ts +10 -8
  332. package/dist/esm/operations/sites/cartridges.js +35 -67
  333. package/dist/esm/operations/sites/cartridges.js.map +1 -1
  334. package/dist/esm/operations/sites/index.d.ts +10 -6
  335. package/dist/esm/operations/sites/index.js +9 -6
  336. package/dist/esm/operations/sites/index.js.map +1 -1
  337. package/dist/esm/operations/sites/ocapi-sites-backend.d.ts +20 -0
  338. package/dist/esm/operations/sites/ocapi-sites-backend.js +98 -0
  339. package/dist/esm/operations/sites/ocapi-sites-backend.js.map +1 -0
  340. package/dist/esm/operations/sites/scapi-sites-backend.d.ts +33 -0
  341. package/dist/esm/operations/sites/scapi-sites-backend.js +166 -0
  342. package/dist/esm/operations/sites/scapi-sites-backend.js.map +1 -0
  343. package/dist/esm/operations/sites/sites-backend.d.ts +9 -0
  344. package/dist/esm/operations/sites/sites-backend.js +16 -0
  345. package/dist/esm/operations/sites/sites-backend.js.map +1 -0
  346. package/dist/esm/operations/sites/sites-scopes.d.ts +2 -0
  347. package/dist/esm/operations/sites/sites-scopes.js +16 -0
  348. package/dist/esm/operations/sites/sites-scopes.js.map +1 -0
  349. package/dist/esm/operations/sites/sites-types.d.ts +50 -0
  350. package/dist/esm/operations/sites/sites-types.js +2 -0
  351. package/dist/esm/operations/sites/sites-types.js.map +1 -0
  352. package/dist/esm/safety/safety-middleware.d.ts +7 -3
  353. package/dist/esm/safety/safety-middleware.js +13 -9
  354. package/dist/esm/safety/safety-middleware.js.map +1 -1
  355. package/dist/esm/scaffold/sources.js +6 -9
  356. package/dist/esm/scaffold/sources.js.map +1 -1
  357. package/dist/esm/scapi/auth-primitives.d.ts +3 -0
  358. package/dist/esm/scapi/auth-primitives.js +104 -0
  359. package/dist/esm/scapi/auth-primitives.js.map +1 -0
  360. package/dist/esm/scapi/authentication.d.ts +30 -0
  361. package/dist/esm/scapi/authentication.js +136 -0
  362. package/dist/esm/scapi/authentication.js.map +1 -0
  363. package/dist/esm/scapi/catalog.d.ts +29 -0
  364. package/dist/esm/scapi/catalog.js +81 -0
  365. package/dist/esm/scapi/catalog.js.map +1 -0
  366. package/dist/esm/scapi/index.d.ts +12 -0
  367. package/dist/esm/scapi/index.js +13 -0
  368. package/dist/esm/scapi/index.js.map +1 -0
  369. package/dist/esm/scapi/request.d.ts +15 -0
  370. package/dist/esm/scapi/request.js +239 -0
  371. package/dist/esm/scapi/request.js.map +1 -0
  372. package/dist/esm/scapi/runtime.d.ts +20 -0
  373. package/dist/esm/scapi/runtime.js +131 -0
  374. package/dist/esm/scapi/runtime.js.map +1 -0
  375. package/dist/esm/scapi/snippets.d.ts +22 -0
  376. package/dist/esm/scapi/snippets.js +140 -0
  377. package/dist/esm/scapi/snippets.js.map +1 -0
  378. package/dist/esm/scapi/worker-source.d.ts +2 -0
  379. package/dist/esm/scapi/worker-source.js +101 -0
  380. package/dist/esm/scapi/worker-source.js.map +1 -0
  381. package/dist/esm/search/ranking.d.ts +12 -0
  382. package/dist/esm/search/ranking.js +28 -0
  383. package/dist/esm/search/ranking.js.map +1 -0
  384. package/dist/esm/skills/sources.d.ts +2 -2
  385. package/dist/esm/skills/sources.js +10 -2
  386. package/dist/esm/skills/sources.js.map +1 -1
  387. package/dist/esm/skills/types.d.ts +1 -1
  388. package/dist/esm/slas/token.js +33 -94
  389. package/dist/esm/slas/token.js.map +1 -1
  390. package/dist/esm/slas/types.d.ts +5 -0
  391. package/node_modules/@salesforce/b2c-api-schemas/README.md +23 -0
  392. package/node_modules/@salesforce/b2c-api-schemas/manifest.json +576 -0
  393. package/node_modules/@salesforce/b2c-api-schemas/package.json +15 -0
  394. package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +11490 -0
  395. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +3589 -0
  396. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +6544 -0
  397. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +7148 -0
  398. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +4411 -0
  399. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +643 -0
  400. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +295 -0
  401. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +2036 -0
  402. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +327 -0
  403. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +234 -0
  404. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +1542 -0
  405. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +405 -0
  406. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +2531 -0
  407. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +7944 -0
  408. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +292 -0
  409. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +2537 -0
  410. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +517 -0
  411. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +589 -0
  412. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +3600 -0
  413. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +2319 -0
  414. package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +658 -0
  415. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +2649 -0
  416. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +6615 -0
  417. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +2103 -0
  418. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1760 -0
  419. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +640 -0
  420. package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1263 -0
  421. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1259 -0
  422. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +760 -0
  423. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +1047 -0
  424. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1929 -0
  425. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +1542 -0
  426. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +1093 -0
  427. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +1324 -0
  428. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +325 -0
  429. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +631 -0
  430. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +1036 -0
  431. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +5175 -0
  432. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +866 -0
  433. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +747 -0
  434. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +5076 -0
  435. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +509 -0
  436. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +517 -0
  437. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +2961 -0
  438. package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1889 -0
  439. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +7014 -0
  440. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1898 -0
  441. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +622 -0
  442. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +192 -0
  443. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +913 -0
  444. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +630 -0
  445. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +223 -0
  446. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +423 -0
  447. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +1088 -0
  448. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +798 -0
  449. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +607 -0
  450. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1418 -0
  451. package/package.json +24 -3
  452. package/specs/dx-scripts-v1.yaml +409 -0
  453. package/specs/merchant-roles-v1.yaml +1085 -0
  454. package/specs/merchant-users-v1.yaml +398 -0
  455. package/specs/mrt-api-v1.json +105 -0
  456. package/specs/operations-jobs-v1.yaml +793 -0
  457. package/specs/product-catalogs-v1.yaml +111 -0
  458. package/specs/site-sites-v1.yaml +667 -0
  459. package/specs/slas-shopper-v1.yaml +83 -0
  460. package/specs/storefront-deployments-v1.yaml +630 -0
@@ -0,0 +1,3600 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Experiences",
5
+ "version": "1.2.0",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "Experience"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/experience/experiences/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/pages/{pageId}": {
21
+ "put": {
22
+ "operationId": "createOrUpdatePage",
23
+ "parameters": [
24
+ {
25
+ "name": "organizationId",
26
+ "in": "path",
27
+ "required": true,
28
+ "style": "simple",
29
+ "explode": false,
30
+ "schema": {
31
+ "$ref": "#/components/schemas/OrganizationId"
32
+ }
33
+ },
34
+ {
35
+ "name": "pageId",
36
+ "in": "path",
37
+ "required": true,
38
+ "style": "simple",
39
+ "explode": false,
40
+ "schema": {
41
+ "type": "string",
42
+ "maxLength": 256
43
+ }
44
+ },
45
+ {
46
+ "name": "siteId",
47
+ "in": "query",
48
+ "required": true,
49
+ "style": "form",
50
+ "explode": true,
51
+ "schema": {
52
+ "$ref": "#/components/schemas/SiteId"
53
+ }
54
+ }
55
+ ],
56
+ "requestBody": {
57
+ "content": {
58
+ "application/json": {
59
+ "schema": {
60
+ "$ref": "#/components/schemas/PageRequest"
61
+ }
62
+ }
63
+ },
64
+ "required": true
65
+ },
66
+ "responses": {
67
+ "200": {
68
+ "description": "Page updated successfully",
69
+ "content": {
70
+ "application/json": {
71
+ "schema": {
72
+ "$ref": "#/components/schemas/Page"
73
+ }
74
+ }
75
+ }
76
+ },
77
+ "201": {
78
+ "description": "Page created successfully",
79
+ "content": {
80
+ "application/json": {
81
+ "schema": {
82
+ "$ref": "#/components/schemas/Page"
83
+ }
84
+ }
85
+ }
86
+ },
87
+ "400": {
88
+ "description": "Invalid page data provided.\n",
89
+ "content": {
90
+ "application/json": {
91
+ "schema": {
92
+ "$ref": "#/components/schemas/ErrorResponse"
93
+ }
94
+ }
95
+ }
96
+ },
97
+ "404": {
98
+ "description": "The requested resource was not found. This can occur when:\n- The specified site ID does not exist.\n- An existing page's page type is missing or invalid.\n",
99
+ "content": {
100
+ "application/json": {
101
+ "schema": {
102
+ "$ref": "#/components/schemas/ErrorResponse"
103
+ }
104
+ }
105
+ }
106
+ },
107
+ "409": {
108
+ "description": "Page ID mismatch or validation error.\n",
109
+ "content": {
110
+ "application/json": {
111
+ "schema": {
112
+ "$ref": "#/components/schemas/ErrorResponse"
113
+ }
114
+ }
115
+ }
116
+ }
117
+ },
118
+ "security": [
119
+ {
120
+ "AmOAuth2": [
121
+ "sfcc.experiences.rw"
122
+ ]
123
+ }
124
+ ]
125
+ }
126
+ },
127
+ "/organizations/{organizationId}/libraries/{libraryId}/folders/{folderId}": {
128
+ "get": {
129
+ "operationId": "getContentFolder",
130
+ "parameters": [
131
+ {
132
+ "name": "organizationId",
133
+ "in": "path",
134
+ "required": true,
135
+ "style": "simple",
136
+ "explode": false,
137
+ "schema": {
138
+ "$ref": "#/components/schemas/OrganizationId"
139
+ }
140
+ },
141
+ {
142
+ "name": "libraryId",
143
+ "in": "path",
144
+ "required": true,
145
+ "style": "simple",
146
+ "explode": false,
147
+ "schema": {
148
+ "type": "string",
149
+ "maxLength": 256
150
+ }
151
+ },
152
+ {
153
+ "name": "folderId",
154
+ "in": "path",
155
+ "required": true,
156
+ "style": "simple",
157
+ "explode": false,
158
+ "schema": {
159
+ "type": "string",
160
+ "maxLength": 256
161
+ }
162
+ }
163
+ ],
164
+ "responses": {
165
+ "200": {
166
+ "description": "Content folder retrieved successfully",
167
+ "content": {
168
+ "application/json": {
169
+ "schema": {
170
+ "$ref": "#/components/schemas/ContentFolder"
171
+ }
172
+ }
173
+ }
174
+ },
175
+ "404": {
176
+ "description": "The requested resource was not found. This can occur when:\n- The specified library does not exist.\n- The specified folder does not exist in the library.\n",
177
+ "content": {
178
+ "application/json": {
179
+ "schema": {
180
+ "$ref": "#/components/schemas/ErrorResponse"
181
+ }
182
+ }
183
+ }
184
+ }
185
+ },
186
+ "security": [
187
+ {
188
+ "AmOAuth2": [
189
+ "sfcc.experiences.rw"
190
+ ]
191
+ }
192
+ ]
193
+ },
194
+ "put": {
195
+ "operationId": "createOrUpdateContentFolder",
196
+ "parameters": [
197
+ {
198
+ "name": "organizationId",
199
+ "in": "path",
200
+ "required": true,
201
+ "style": "simple",
202
+ "explode": false,
203
+ "schema": {
204
+ "$ref": "#/components/schemas/OrganizationId"
205
+ }
206
+ },
207
+ {
208
+ "name": "libraryId",
209
+ "in": "path",
210
+ "required": true,
211
+ "style": "simple",
212
+ "explode": false,
213
+ "schema": {
214
+ "type": "string",
215
+ "maxLength": 256
216
+ }
217
+ },
218
+ {
219
+ "name": "folderId",
220
+ "in": "path",
221
+ "required": true,
222
+ "style": "simple",
223
+ "explode": false,
224
+ "schema": {
225
+ "type": "string",
226
+ "maxLength": 256
227
+ }
228
+ }
229
+ ],
230
+ "requestBody": {
231
+ "content": {
232
+ "application/json": {
233
+ "schema": {
234
+ "$ref": "#/components/schemas/ContentFolder"
235
+ }
236
+ }
237
+ },
238
+ "required": true
239
+ },
240
+ "responses": {
241
+ "200": {
242
+ "description": "Content folder updated successfully",
243
+ "content": {
244
+ "application/json": {
245
+ "schema": {
246
+ "$ref": "#/components/schemas/ContentFolder"
247
+ }
248
+ }
249
+ }
250
+ },
251
+ "201": {
252
+ "description": "Content folder created successfully",
253
+ "content": {
254
+ "application/json": {
255
+ "schema": {
256
+ "$ref": "#/components/schemas/ContentFolder"
257
+ }
258
+ }
259
+ }
260
+ },
261
+ "400": {
262
+ "description": "Invalid folder data provided.\n",
263
+ "content": {
264
+ "application/json": {
265
+ "schema": {
266
+ "$ref": "#/components/schemas/ErrorResponse"
267
+ }
268
+ }
269
+ }
270
+ },
271
+ "404": {
272
+ "description": "The specified library does not exist.\n",
273
+ "content": {
274
+ "application/json": {
275
+ "schema": {
276
+ "$ref": "#/components/schemas/ErrorResponse"
277
+ }
278
+ }
279
+ }
280
+ }
281
+ },
282
+ "security": [
283
+ {
284
+ "AmOAuth2": [
285
+ "sfcc.experiences.rw"
286
+ ]
287
+ }
288
+ ]
289
+ },
290
+ "delete": {
291
+ "operationId": "deleteContentFolder",
292
+ "parameters": [
293
+ {
294
+ "name": "organizationId",
295
+ "in": "path",
296
+ "required": true,
297
+ "style": "simple",
298
+ "explode": false,
299
+ "schema": {
300
+ "$ref": "#/components/schemas/OrganizationId"
301
+ }
302
+ },
303
+ {
304
+ "name": "libraryId",
305
+ "in": "path",
306
+ "required": true,
307
+ "style": "simple",
308
+ "explode": false,
309
+ "schema": {
310
+ "type": "string",
311
+ "maxLength": 256
312
+ }
313
+ },
314
+ {
315
+ "name": "folderId",
316
+ "in": "path",
317
+ "required": true,
318
+ "style": "simple",
319
+ "explode": false,
320
+ "schema": {
321
+ "type": "string",
322
+ "maxLength": 256
323
+ }
324
+ }
325
+ ],
326
+ "responses": {
327
+ "204": {
328
+ "description": "Content folder deleted successfully"
329
+ },
330
+ "404": {
331
+ "description": "The requested resource was not found.\n",
332
+ "content": {
333
+ "application/json": {
334
+ "schema": {
335
+ "$ref": "#/components/schemas/ErrorResponse"
336
+ }
337
+ }
338
+ }
339
+ }
340
+ },
341
+ "security": [
342
+ {
343
+ "AmOAuth2": [
344
+ "sfcc.experiences.rw"
345
+ ]
346
+ }
347
+ ]
348
+ },
349
+ "patch": {
350
+ "operationId": "patchContentFolder",
351
+ "parameters": [
352
+ {
353
+ "name": "organizationId",
354
+ "in": "path",
355
+ "required": true,
356
+ "style": "simple",
357
+ "explode": false,
358
+ "schema": {
359
+ "$ref": "#/components/schemas/OrganizationId"
360
+ }
361
+ },
362
+ {
363
+ "name": "libraryId",
364
+ "in": "path",
365
+ "required": true,
366
+ "style": "simple",
367
+ "explode": false,
368
+ "schema": {
369
+ "type": "string",
370
+ "maxLength": 256
371
+ }
372
+ },
373
+ {
374
+ "name": "folderId",
375
+ "in": "path",
376
+ "required": true,
377
+ "style": "simple",
378
+ "explode": false,
379
+ "schema": {
380
+ "type": "string",
381
+ "maxLength": 256
382
+ }
383
+ }
384
+ ],
385
+ "requestBody": {
386
+ "content": {
387
+ "application/json": {
388
+ "schema": {
389
+ "$ref": "#/components/schemas/ContentFolder"
390
+ }
391
+ }
392
+ },
393
+ "required": true
394
+ },
395
+ "responses": {
396
+ "200": {
397
+ "description": "Content folder updated successfully",
398
+ "content": {
399
+ "application/json": {
400
+ "schema": {
401
+ "$ref": "#/components/schemas/ContentFolder"
402
+ }
403
+ }
404
+ }
405
+ },
406
+ "400": {
407
+ "description": "Invalid folder data provided.\n",
408
+ "content": {
409
+ "application/json": {
410
+ "schema": {
411
+ "$ref": "#/components/schemas/ErrorResponse"
412
+ }
413
+ }
414
+ }
415
+ },
416
+ "404": {
417
+ "description": "The requested resource was not found.\n",
418
+ "content": {
419
+ "application/json": {
420
+ "schema": {
421
+ "$ref": "#/components/schemas/ErrorResponse"
422
+ }
423
+ }
424
+ }
425
+ }
426
+ },
427
+ "security": [
428
+ {
429
+ "AmOAuth2": [
430
+ "sfcc.experiences.rw"
431
+ ]
432
+ }
433
+ ]
434
+ }
435
+ },
436
+ "/organizations/{organizationId}/libraries/{libraryId}/folders/{folderId}/sub-folders": {
437
+ "get": {
438
+ "operationId": "getSubFolders",
439
+ "parameters": [
440
+ {
441
+ "name": "organizationId",
442
+ "in": "path",
443
+ "required": true,
444
+ "style": "simple",
445
+ "explode": false,
446
+ "schema": {
447
+ "$ref": "#/components/schemas/OrganizationId"
448
+ }
449
+ },
450
+ {
451
+ "name": "libraryId",
452
+ "in": "path",
453
+ "required": true,
454
+ "style": "simple",
455
+ "explode": false,
456
+ "schema": {
457
+ "type": "string",
458
+ "maxLength": 256
459
+ }
460
+ },
461
+ {
462
+ "name": "folderId",
463
+ "in": "path",
464
+ "required": true,
465
+ "style": "simple",
466
+ "explode": false,
467
+ "schema": {
468
+ "type": "string",
469
+ "maxLength": 256
470
+ }
471
+ },
472
+ {
473
+ "name": "limit",
474
+ "in": "query",
475
+ "required": false,
476
+ "style": "form",
477
+ "explode": true,
478
+ "schema": {
479
+ "type": "integer",
480
+ "format": "int32",
481
+ "default": 25,
482
+ "maximum": 200,
483
+ "minimum": 1
484
+ }
485
+ },
486
+ {
487
+ "name": "offset",
488
+ "in": "query",
489
+ "required": false,
490
+ "style": "form",
491
+ "explode": true,
492
+ "schema": {
493
+ "type": "integer",
494
+ "format": "int32",
495
+ "default": 0,
496
+ "minimum": 0
497
+ }
498
+ }
499
+ ],
500
+ "responses": {
501
+ "200": {
502
+ "description": "Sub-folders retrieved successfully",
503
+ "content": {
504
+ "application/json": {
505
+ "schema": {
506
+ "$ref": "#/components/schemas/ContentSubFolderResult"
507
+ }
508
+ }
509
+ }
510
+ },
511
+ "400": {
512
+ "description": "Invalid request parameters provided.\n",
513
+ "content": {
514
+ "application/json": {
515
+ "schema": {
516
+ "$ref": "#/components/schemas/ErrorResponse"
517
+ }
518
+ }
519
+ }
520
+ },
521
+ "404": {
522
+ "description": "The requested resource was not found. This can occur when:\n- The specified library does not exist.\n- The specified parent folder does not exist in the library.\n",
523
+ "content": {
524
+ "application/json": {
525
+ "schema": {
526
+ "$ref": "#/components/schemas/ErrorResponse"
527
+ }
528
+ }
529
+ }
530
+ }
531
+ },
532
+ "security": [
533
+ {
534
+ "AmOAuth2": [
535
+ "sfcc.experiences",
536
+ "sfcc.experiences.rw"
537
+ ]
538
+ }
539
+ ]
540
+ }
541
+ },
542
+ "/organizations/{organizationId}/libraries/{libraryId}/content/{contentId}": {
543
+ "get": {
544
+ "operationId": "getContent",
545
+ "parameters": [
546
+ {
547
+ "name": "organizationId",
548
+ "in": "path",
549
+ "required": true,
550
+ "style": "simple",
551
+ "explode": false,
552
+ "schema": {
553
+ "$ref": "#/components/schemas/OrganizationId"
554
+ }
555
+ },
556
+ {
557
+ "name": "libraryId",
558
+ "in": "path",
559
+ "required": true,
560
+ "style": "simple",
561
+ "explode": false,
562
+ "schema": {
563
+ "type": "string",
564
+ "maxLength": 256
565
+ }
566
+ },
567
+ {
568
+ "name": "contentId",
569
+ "in": "path",
570
+ "required": true,
571
+ "style": "simple",
572
+ "explode": false,
573
+ "schema": {
574
+ "type": "string",
575
+ "maxLength": 256
576
+ }
577
+ }
578
+ ],
579
+ "responses": {
580
+ "200": {
581
+ "description": "Content asset retrieved successfully",
582
+ "content": {
583
+ "application/json": {
584
+ "schema": {
585
+ "$ref": "#/components/schemas/ContentAsset"
586
+ }
587
+ }
588
+ }
589
+ },
590
+ "404": {
591
+ "description": "The requested resource was not found. This can occur when:\n- The specified library does not exist.\n- The specified content asset does not exist in the library.\n",
592
+ "content": {
593
+ "application/json": {
594
+ "schema": {
595
+ "$ref": "#/components/schemas/ErrorResponse"
596
+ }
597
+ }
598
+ }
599
+ }
600
+ },
601
+ "security": [
602
+ {
603
+ "AmOAuth2": [
604
+ "sfcc.experiences",
605
+ "sfcc.experiences.rw"
606
+ ]
607
+ }
608
+ ]
609
+ },
610
+ "put": {
611
+ "operationId": "createOrUpdateContent",
612
+ "parameters": [
613
+ {
614
+ "name": "organizationId",
615
+ "in": "path",
616
+ "required": true,
617
+ "style": "simple",
618
+ "explode": false,
619
+ "schema": {
620
+ "$ref": "#/components/schemas/OrganizationId"
621
+ }
622
+ },
623
+ {
624
+ "name": "libraryId",
625
+ "in": "path",
626
+ "required": true,
627
+ "style": "simple",
628
+ "explode": false,
629
+ "schema": {
630
+ "type": "string",
631
+ "maxLength": 256
632
+ }
633
+ },
634
+ {
635
+ "name": "contentId",
636
+ "in": "path",
637
+ "required": true,
638
+ "style": "simple",
639
+ "explode": false,
640
+ "schema": {
641
+ "type": "string",
642
+ "maxLength": 256
643
+ }
644
+ }
645
+ ],
646
+ "requestBody": {
647
+ "content": {
648
+ "application/json": {
649
+ "schema": {
650
+ "$ref": "#/components/schemas/ContentAsset"
651
+ }
652
+ }
653
+ },
654
+ "required": true
655
+ },
656
+ "responses": {
657
+ "200": {
658
+ "description": "Content asset updated successfully",
659
+ "content": {
660
+ "application/json": {
661
+ "schema": {
662
+ "$ref": "#/components/schemas/ContentAsset"
663
+ }
664
+ }
665
+ }
666
+ },
667
+ "201": {
668
+ "description": "Content asset created successfully",
669
+ "content": {
670
+ "application/json": {
671
+ "schema": {
672
+ "$ref": "#/components/schemas/ContentAsset"
673
+ }
674
+ }
675
+ }
676
+ },
677
+ "400": {
678
+ "description": "Invalid content data provided.\n",
679
+ "content": {
680
+ "application/json": {
681
+ "schema": {
682
+ "$ref": "#/components/schemas/ErrorResponse"
683
+ }
684
+ }
685
+ }
686
+ },
687
+ "404": {
688
+ "description": "The specified library does not exist.\n",
689
+ "content": {
690
+ "application/json": {
691
+ "schema": {
692
+ "$ref": "#/components/schemas/ErrorResponse"
693
+ }
694
+ }
695
+ }
696
+ }
697
+ },
698
+ "security": [
699
+ {
700
+ "AmOAuth2": [
701
+ "sfcc.experiences.rw"
702
+ ]
703
+ }
704
+ ]
705
+ },
706
+ "delete": {
707
+ "operationId": "deleteContent",
708
+ "parameters": [
709
+ {
710
+ "name": "organizationId",
711
+ "in": "path",
712
+ "required": true,
713
+ "style": "simple",
714
+ "explode": false,
715
+ "schema": {
716
+ "$ref": "#/components/schemas/OrganizationId"
717
+ }
718
+ },
719
+ {
720
+ "name": "libraryId",
721
+ "in": "path",
722
+ "required": true,
723
+ "style": "simple",
724
+ "explode": false,
725
+ "schema": {
726
+ "type": "string",
727
+ "maxLength": 256
728
+ }
729
+ },
730
+ {
731
+ "name": "contentId",
732
+ "in": "path",
733
+ "required": true,
734
+ "style": "simple",
735
+ "explode": false,
736
+ "schema": {
737
+ "type": "string",
738
+ "maxLength": 256
739
+ }
740
+ }
741
+ ],
742
+ "responses": {
743
+ "204": {
744
+ "description": "Content asset deleted successfully"
745
+ },
746
+ "404": {
747
+ "description": "The requested resource was not found.\n",
748
+ "content": {
749
+ "application/json": {
750
+ "schema": {
751
+ "$ref": "#/components/schemas/ErrorResponse"
752
+ }
753
+ }
754
+ }
755
+ }
756
+ },
757
+ "security": [
758
+ {
759
+ "AmOAuth2": [
760
+ "sfcc.experiences.rw"
761
+ ]
762
+ }
763
+ ]
764
+ },
765
+ "patch": {
766
+ "operationId": "patchContent",
767
+ "parameters": [
768
+ {
769
+ "name": "organizationId",
770
+ "in": "path",
771
+ "required": true,
772
+ "style": "simple",
773
+ "explode": false,
774
+ "schema": {
775
+ "$ref": "#/components/schemas/OrganizationId"
776
+ }
777
+ },
778
+ {
779
+ "name": "libraryId",
780
+ "in": "path",
781
+ "required": true,
782
+ "style": "simple",
783
+ "explode": false,
784
+ "schema": {
785
+ "type": "string",
786
+ "maxLength": 256
787
+ }
788
+ },
789
+ {
790
+ "name": "contentId",
791
+ "in": "path",
792
+ "required": true,
793
+ "style": "simple",
794
+ "explode": false,
795
+ "schema": {
796
+ "type": "string",
797
+ "maxLength": 256
798
+ }
799
+ }
800
+ ],
801
+ "requestBody": {
802
+ "content": {
803
+ "application/json": {
804
+ "schema": {
805
+ "$ref": "#/components/schemas/ContentAsset"
806
+ }
807
+ }
808
+ },
809
+ "required": true
810
+ },
811
+ "responses": {
812
+ "200": {
813
+ "description": "Content asset updated successfully",
814
+ "content": {
815
+ "application/json": {
816
+ "schema": {
817
+ "$ref": "#/components/schemas/ContentAsset"
818
+ }
819
+ }
820
+ }
821
+ },
822
+ "404": {
823
+ "description": "The requested resource was not found.\n",
824
+ "content": {
825
+ "application/json": {
826
+ "schema": {
827
+ "$ref": "#/components/schemas/ErrorResponse"
828
+ }
829
+ }
830
+ }
831
+ }
832
+ },
833
+ "security": [
834
+ {
835
+ "AmOAuth2": [
836
+ "sfcc.experiences.rw"
837
+ ]
838
+ }
839
+ ]
840
+ }
841
+ },
842
+ "/organizations/{organizationId}/libraries/{libraryId}/content/{contentId}/folders": {
843
+ "get": {
844
+ "operationId": "getContentFolders",
845
+ "parameters": [
846
+ {
847
+ "name": "organizationId",
848
+ "in": "path",
849
+ "required": true,
850
+ "style": "simple",
851
+ "explode": false,
852
+ "schema": {
853
+ "$ref": "#/components/schemas/OrganizationId"
854
+ }
855
+ },
856
+ {
857
+ "name": "libraryId",
858
+ "in": "path",
859
+ "required": true,
860
+ "style": "simple",
861
+ "explode": false,
862
+ "schema": {
863
+ "type": "string",
864
+ "maxLength": 256
865
+ }
866
+ },
867
+ {
868
+ "name": "contentId",
869
+ "in": "path",
870
+ "required": true,
871
+ "style": "simple",
872
+ "explode": false,
873
+ "schema": {
874
+ "type": "string",
875
+ "maxLength": 256
876
+ }
877
+ },
878
+ {
879
+ "name": "limit",
880
+ "in": "query",
881
+ "required": false,
882
+ "style": "form",
883
+ "explode": true,
884
+ "schema": {
885
+ "type": "integer",
886
+ "format": "int32",
887
+ "default": 25,
888
+ "maximum": 200,
889
+ "minimum": 1
890
+ }
891
+ },
892
+ {
893
+ "name": "offset",
894
+ "in": "query",
895
+ "required": false,
896
+ "style": "form",
897
+ "explode": true,
898
+ "schema": {
899
+ "type": "integer",
900
+ "format": "int32",
901
+ "default": 0,
902
+ "minimum": 0
903
+ }
904
+ }
905
+ ],
906
+ "responses": {
907
+ "200": {
908
+ "description": "Folder information retrieved successfully",
909
+ "content": {
910
+ "application/json": {
911
+ "schema": {
912
+ "$ref": "#/components/schemas/ContentFolderResult"
913
+ }
914
+ }
915
+ }
916
+ },
917
+ "404": {
918
+ "description": "The requested resource was not found. This can occur when:\n- The specified library does not exist.\n- The specified content asset does not exist in the library.\n",
919
+ "content": {
920
+ "application/json": {
921
+ "schema": {
922
+ "$ref": "#/components/schemas/ErrorResponse"
923
+ }
924
+ }
925
+ }
926
+ }
927
+ },
928
+ "security": [
929
+ {
930
+ "AmOAuth2": [
931
+ "sfcc.experiences",
932
+ "sfcc.experiences.rw"
933
+ ]
934
+ }
935
+ ]
936
+ }
937
+ },
938
+ "/organizations/{organizationId}/libraries/{libraryId}/folder-assignments/{contentId}/{folderId}": {
939
+ "get": {
940
+ "operationId": "getFolderAssignment",
941
+ "parameters": [
942
+ {
943
+ "name": "organizationId",
944
+ "in": "path",
945
+ "required": true,
946
+ "style": "simple",
947
+ "explode": false,
948
+ "schema": {
949
+ "$ref": "#/components/schemas/OrganizationId"
950
+ }
951
+ },
952
+ {
953
+ "name": "libraryId",
954
+ "in": "path",
955
+ "required": true,
956
+ "style": "simple",
957
+ "explode": false,
958
+ "schema": {
959
+ "type": "string",
960
+ "maxLength": 256
961
+ }
962
+ },
963
+ {
964
+ "name": "contentId",
965
+ "in": "path",
966
+ "required": true,
967
+ "style": "simple",
968
+ "explode": false,
969
+ "schema": {
970
+ "type": "string",
971
+ "maxLength": 256
972
+ }
973
+ },
974
+ {
975
+ "name": "folderId",
976
+ "in": "path",
977
+ "required": true,
978
+ "style": "simple",
979
+ "explode": false,
980
+ "schema": {
981
+ "type": "string",
982
+ "maxLength": 256
983
+ }
984
+ }
985
+ ],
986
+ "responses": {
987
+ "200": {
988
+ "description": "Folder assignment retrieved successfully",
989
+ "content": {
990
+ "application/json": {
991
+ "schema": {
992
+ "$ref": "#/components/schemas/ContentFolderAssignment"
993
+ }
994
+ }
995
+ }
996
+ },
997
+ "404": {
998
+ "description": "The requested resource was not found. This can occur when:\n- The specified library does not exist.\n- The specified content asset does not exist in the library.\n- The specified folder does not exist in the library.\n- The assignment between the content asset and folder does not exist.\n",
999
+ "content": {
1000
+ "application/json": {
1001
+ "schema": {
1002
+ "$ref": "#/components/schemas/ErrorResponse"
1003
+ }
1004
+ }
1005
+ }
1006
+ }
1007
+ },
1008
+ "security": [
1009
+ {
1010
+ "AmOAuth2": [
1011
+ "sfcc.experiences",
1012
+ "sfcc.experiences.rw"
1013
+ ]
1014
+ }
1015
+ ]
1016
+ },
1017
+ "put": {
1018
+ "operationId": "createOrUpdateFolderAssignment",
1019
+ "parameters": [
1020
+ {
1021
+ "name": "organizationId",
1022
+ "in": "path",
1023
+ "required": true,
1024
+ "style": "simple",
1025
+ "explode": false,
1026
+ "schema": {
1027
+ "$ref": "#/components/schemas/OrganizationId"
1028
+ }
1029
+ },
1030
+ {
1031
+ "name": "libraryId",
1032
+ "in": "path",
1033
+ "required": true,
1034
+ "style": "simple",
1035
+ "explode": false,
1036
+ "schema": {
1037
+ "type": "string",
1038
+ "maxLength": 256
1039
+ }
1040
+ },
1041
+ {
1042
+ "name": "contentId",
1043
+ "in": "path",
1044
+ "required": true,
1045
+ "style": "simple",
1046
+ "explode": false,
1047
+ "schema": {
1048
+ "type": "string",
1049
+ "maxLength": 256
1050
+ }
1051
+ },
1052
+ {
1053
+ "name": "folderId",
1054
+ "in": "path",
1055
+ "required": true,
1056
+ "style": "simple",
1057
+ "explode": false,
1058
+ "schema": {
1059
+ "type": "string",
1060
+ "maxLength": 256
1061
+ }
1062
+ }
1063
+ ],
1064
+ "requestBody": {
1065
+ "content": {
1066
+ "application/json": {
1067
+ "schema": {
1068
+ "$ref": "#/components/schemas/ContentFolderAssignment"
1069
+ }
1070
+ }
1071
+ },
1072
+ "required": true
1073
+ },
1074
+ "responses": {
1075
+ "200": {
1076
+ "description": "Content Folder assignment updated successfully",
1077
+ "content": {
1078
+ "application/json": {
1079
+ "schema": {
1080
+ "$ref": "#/components/schemas/ContentFolderAssignment"
1081
+ }
1082
+ }
1083
+ }
1084
+ },
1085
+ "201": {
1086
+ "description": "Content Folder assignment created successfully",
1087
+ "content": {
1088
+ "application/json": {
1089
+ "schema": {
1090
+ "$ref": "#/components/schemas/ContentFolderAssignment"
1091
+ }
1092
+ }
1093
+ }
1094
+ },
1095
+ "404": {
1096
+ "description": "The specified resource does not exist.\n",
1097
+ "content": {
1098
+ "application/json": {
1099
+ "schema": {
1100
+ "$ref": "#/components/schemas/ErrorResponse"
1101
+ }
1102
+ }
1103
+ }
1104
+ }
1105
+ },
1106
+ "security": [
1107
+ {
1108
+ "AmOAuth2": [
1109
+ "sfcc.experiences.rw"
1110
+ ]
1111
+ }
1112
+ ]
1113
+ },
1114
+ "delete": {
1115
+ "operationId": "deleteFolderAssignment",
1116
+ "parameters": [
1117
+ {
1118
+ "name": "organizationId",
1119
+ "in": "path",
1120
+ "required": true,
1121
+ "style": "simple",
1122
+ "explode": false,
1123
+ "schema": {
1124
+ "$ref": "#/components/schemas/OrganizationId"
1125
+ }
1126
+ },
1127
+ {
1128
+ "name": "libraryId",
1129
+ "in": "path",
1130
+ "required": true,
1131
+ "style": "simple",
1132
+ "explode": false,
1133
+ "schema": {
1134
+ "type": "string",
1135
+ "maxLength": 256
1136
+ }
1137
+ },
1138
+ {
1139
+ "name": "contentId",
1140
+ "in": "path",
1141
+ "required": true,
1142
+ "style": "simple",
1143
+ "explode": false,
1144
+ "schema": {
1145
+ "type": "string",
1146
+ "maxLength": 256
1147
+ }
1148
+ },
1149
+ {
1150
+ "name": "folderId",
1151
+ "in": "path",
1152
+ "required": true,
1153
+ "style": "simple",
1154
+ "explode": false,
1155
+ "schema": {
1156
+ "type": "string",
1157
+ "maxLength": 256
1158
+ }
1159
+ }
1160
+ ],
1161
+ "responses": {
1162
+ "204": {
1163
+ "description": "Content folder assignment deleted successfully"
1164
+ },
1165
+ "404": {
1166
+ "description": "The requested resource was not found.\n",
1167
+ "content": {
1168
+ "application/json": {
1169
+ "schema": {
1170
+ "$ref": "#/components/schemas/ErrorResponse"
1171
+ }
1172
+ }
1173
+ }
1174
+ }
1175
+ },
1176
+ "security": [
1177
+ {
1178
+ "AmOAuth2": [
1179
+ "sfcc.experiences.rw"
1180
+ ]
1181
+ }
1182
+ ]
1183
+ },
1184
+ "patch": {
1185
+ "operationId": "updateFolderAssignment",
1186
+ "parameters": [
1187
+ {
1188
+ "name": "organizationId",
1189
+ "in": "path",
1190
+ "required": true,
1191
+ "style": "simple",
1192
+ "explode": false,
1193
+ "schema": {
1194
+ "$ref": "#/components/schemas/OrganizationId"
1195
+ }
1196
+ },
1197
+ {
1198
+ "name": "libraryId",
1199
+ "in": "path",
1200
+ "required": true,
1201
+ "style": "simple",
1202
+ "explode": false,
1203
+ "schema": {
1204
+ "type": "string",
1205
+ "maxLength": 256
1206
+ }
1207
+ },
1208
+ {
1209
+ "name": "contentId",
1210
+ "in": "path",
1211
+ "required": true,
1212
+ "style": "simple",
1213
+ "explode": false,
1214
+ "schema": {
1215
+ "type": "string",
1216
+ "maxLength": 256
1217
+ }
1218
+ },
1219
+ {
1220
+ "name": "folderId",
1221
+ "in": "path",
1222
+ "required": true,
1223
+ "style": "simple",
1224
+ "explode": false,
1225
+ "schema": {
1226
+ "type": "string",
1227
+ "maxLength": 256
1228
+ }
1229
+ }
1230
+ ],
1231
+ "requestBody": {
1232
+ "content": {
1233
+ "application/json": {
1234
+ "schema": {
1235
+ "$ref": "#/components/schemas/ContentFolderAssignment"
1236
+ }
1237
+ }
1238
+ },
1239
+ "required": true
1240
+ },
1241
+ "responses": {
1242
+ "200": {
1243
+ "description": "Content folder assignment updated successfully",
1244
+ "content": {
1245
+ "application/json": {
1246
+ "schema": {
1247
+ "$ref": "#/components/schemas/ContentFolderAssignment"
1248
+ }
1249
+ }
1250
+ }
1251
+ },
1252
+ "404": {
1253
+ "description": "The specified resource does not exist.\n",
1254
+ "content": {
1255
+ "application/json": {
1256
+ "schema": {
1257
+ "$ref": "#/components/schemas/ErrorResponse"
1258
+ }
1259
+ }
1260
+ }
1261
+ }
1262
+ },
1263
+ "security": [
1264
+ {
1265
+ "AmOAuth2": [
1266
+ "sfcc.experiences.rw"
1267
+ ]
1268
+ }
1269
+ ]
1270
+ }
1271
+ },
1272
+ "/organizations/{organizationId}/libraries/{libraryId}/folders/{folderId}/content": {
1273
+ "get": {
1274
+ "operationId": "getFolderContent",
1275
+ "parameters": [
1276
+ {
1277
+ "name": "organizationId",
1278
+ "in": "path",
1279
+ "required": true,
1280
+ "style": "simple",
1281
+ "explode": false,
1282
+ "schema": {
1283
+ "$ref": "#/components/schemas/OrganizationId"
1284
+ }
1285
+ },
1286
+ {
1287
+ "name": "libraryId",
1288
+ "in": "path",
1289
+ "required": true,
1290
+ "style": "simple",
1291
+ "explode": false,
1292
+ "schema": {
1293
+ "type": "string",
1294
+ "maxLength": 256
1295
+ }
1296
+ },
1297
+ {
1298
+ "name": "folderId",
1299
+ "in": "path",
1300
+ "required": true,
1301
+ "style": "simple",
1302
+ "explode": false,
1303
+ "schema": {
1304
+ "type": "string",
1305
+ "maxLength": 256
1306
+ }
1307
+ },
1308
+ {
1309
+ "name": "limit",
1310
+ "in": "query",
1311
+ "required": false,
1312
+ "style": "form",
1313
+ "explode": true,
1314
+ "schema": {
1315
+ "type": "integer",
1316
+ "format": "int32",
1317
+ "default": 25,
1318
+ "maximum": 200,
1319
+ "minimum": 1
1320
+ }
1321
+ },
1322
+ {
1323
+ "name": "offset",
1324
+ "in": "query",
1325
+ "required": false,
1326
+ "style": "form",
1327
+ "explode": true,
1328
+ "schema": {
1329
+ "type": "integer",
1330
+ "format": "int32",
1331
+ "default": 0,
1332
+ "minimum": 0
1333
+ }
1334
+ }
1335
+ ],
1336
+ "responses": {
1337
+ "200": {
1338
+ "description": "Content assets retrieved successfully",
1339
+ "content": {
1340
+ "application/json": {
1341
+ "schema": {
1342
+ "$ref": "#/components/schemas/ContentAssetResult"
1343
+ }
1344
+ }
1345
+ }
1346
+ },
1347
+ "400": {
1348
+ "description": "Invalid request parameters provided.\n",
1349
+ "content": {
1350
+ "application/json": {
1351
+ "schema": {
1352
+ "$ref": "#/components/schemas/ErrorResponse"
1353
+ }
1354
+ }
1355
+ }
1356
+ },
1357
+ "404": {
1358
+ "description": "The requested resource was not found. This can occur when:\n- The specified library does not exist.\n- The specified folder does not exist in the library.\n",
1359
+ "content": {
1360
+ "application/json": {
1361
+ "schema": {
1362
+ "$ref": "#/components/schemas/ErrorResponse"
1363
+ }
1364
+ }
1365
+ }
1366
+ }
1367
+ },
1368
+ "security": [
1369
+ {
1370
+ "AmOAuth2": [
1371
+ "sfcc.experiences",
1372
+ "sfcc.experiences.rw"
1373
+ ]
1374
+ }
1375
+ ]
1376
+ }
1377
+ },
1378
+ "/organizations/{organizationId}/slots/{slotId}/{contextType}": {
1379
+ "get": {
1380
+ "operationId": "getSlot",
1381
+ "parameters": [
1382
+ {
1383
+ "name": "organizationId",
1384
+ "in": "path",
1385
+ "required": true,
1386
+ "style": "simple",
1387
+ "explode": false,
1388
+ "schema": {
1389
+ "$ref": "#/components/schemas/OrganizationId"
1390
+ }
1391
+ },
1392
+ {
1393
+ "name": "siteId",
1394
+ "in": "query",
1395
+ "required": true,
1396
+ "style": "form",
1397
+ "explode": true,
1398
+ "schema": {
1399
+ "$ref": "#/components/schemas/SiteId"
1400
+ }
1401
+ },
1402
+ {
1403
+ "name": "slotId",
1404
+ "in": "path",
1405
+ "required": true,
1406
+ "style": "simple",
1407
+ "explode": false,
1408
+ "schema": {
1409
+ "type": "string",
1410
+ "maxLength": 256
1411
+ }
1412
+ },
1413
+ {
1414
+ "name": "contextType",
1415
+ "in": "path",
1416
+ "required": true,
1417
+ "style": "simple",
1418
+ "explode": false,
1419
+ "schema": {
1420
+ "type": "string",
1421
+ "enum": [
1422
+ "global",
1423
+ "category",
1424
+ "folder"
1425
+ ]
1426
+ }
1427
+ },
1428
+ {
1429
+ "name": "select",
1430
+ "in": "query",
1431
+ "required": false,
1432
+ "style": "form",
1433
+ "explode": true,
1434
+ "schema": {
1435
+ "$ref": "#/components/schemas/Select"
1436
+ }
1437
+ }
1438
+ ],
1439
+ "responses": {
1440
+ "200": {
1441
+ "description": "Slot retrieved successfully",
1442
+ "content": {
1443
+ "application/json": {
1444
+ "schema": {
1445
+ "$ref": "#/components/schemas/Slot"
1446
+ }
1447
+ }
1448
+ }
1449
+ },
1450
+ "404": {
1451
+ "description": "The requested resource was not found. This can occur when:\n- The specified site does not exist.\n- The specified slot does not exist in the given context.\n",
1452
+ "content": {
1453
+ "application/json": {
1454
+ "schema": {
1455
+ "$ref": "#/components/schemas/ErrorResponse"
1456
+ }
1457
+ }
1458
+ }
1459
+ }
1460
+ },
1461
+ "security": [
1462
+ {
1463
+ "AmOAuth2": [
1464
+ "sfcc.experiences",
1465
+ "sfcc.experiences.rw"
1466
+ ]
1467
+ }
1468
+ ]
1469
+ }
1470
+ },
1471
+ "/organizations/{organizationId}/slot-search": {
1472
+ "post": {
1473
+ "operationId": "searchSlots",
1474
+ "parameters": [
1475
+ {
1476
+ "name": "organizationId",
1477
+ "in": "path",
1478
+ "required": true,
1479
+ "style": "simple",
1480
+ "explode": false,
1481
+ "schema": {
1482
+ "$ref": "#/components/schemas/OrganizationId"
1483
+ }
1484
+ },
1485
+ {
1486
+ "name": "siteId",
1487
+ "in": "query",
1488
+ "required": true,
1489
+ "style": "form",
1490
+ "explode": true,
1491
+ "schema": {
1492
+ "$ref": "#/components/schemas/SiteId"
1493
+ }
1494
+ }
1495
+ ],
1496
+ "requestBody": {
1497
+ "content": {
1498
+ "application/json": {
1499
+ "schema": {
1500
+ "$ref": "#/components/schemas/SlotSearchRequest"
1501
+ }
1502
+ }
1503
+ },
1504
+ "required": true
1505
+ },
1506
+ "responses": {
1507
+ "200": {
1508
+ "description": "Search completed successfully",
1509
+ "content": {
1510
+ "application/json": {
1511
+ "schema": {
1512
+ "$ref": "#/components/schemas/SlotSearchResult"
1513
+ }
1514
+ }
1515
+ }
1516
+ },
1517
+ "400": {
1518
+ "description": "Invalid search query provided.\n",
1519
+ "content": {
1520
+ "application/json": {
1521
+ "schema": {
1522
+ "$ref": "#/components/schemas/ErrorResponse"
1523
+ }
1524
+ }
1525
+ }
1526
+ },
1527
+ "404": {
1528
+ "description": "The requested resource was not found. This can occur when:\n- The specified site does not exist.\n",
1529
+ "content": {
1530
+ "application/json": {
1531
+ "schema": {
1532
+ "$ref": "#/components/schemas/ErrorResponse"
1533
+ }
1534
+ }
1535
+ }
1536
+ }
1537
+ },
1538
+ "security": [
1539
+ {
1540
+ "AmOAuth2": [
1541
+ "sfcc.experiences",
1542
+ "sfcc.experiences.rw"
1543
+ ]
1544
+ }
1545
+ ]
1546
+ }
1547
+ },
1548
+ "/organizations/{organizationId}/slots/{slotId}/slot-configurations/{configurationId}": {
1549
+ "get": {
1550
+ "operationId": "getSlotConfiguration",
1551
+ "parameters": [
1552
+ {
1553
+ "name": "organizationId",
1554
+ "in": "path",
1555
+ "required": true,
1556
+ "style": "simple",
1557
+ "explode": false,
1558
+ "schema": {
1559
+ "$ref": "#/components/schemas/OrganizationId"
1560
+ }
1561
+ },
1562
+ {
1563
+ "name": "siteId",
1564
+ "in": "query",
1565
+ "required": true,
1566
+ "style": "form",
1567
+ "explode": true,
1568
+ "schema": {
1569
+ "$ref": "#/components/schemas/SiteId"
1570
+ }
1571
+ },
1572
+ {
1573
+ "name": "slotId",
1574
+ "in": "path",
1575
+ "required": true,
1576
+ "style": "simple",
1577
+ "explode": false,
1578
+ "schema": {
1579
+ "type": "string",
1580
+ "maxLength": 256
1581
+ }
1582
+ },
1583
+ {
1584
+ "name": "configurationId",
1585
+ "in": "path",
1586
+ "required": true,
1587
+ "style": "simple",
1588
+ "explode": false,
1589
+ "schema": {
1590
+ "type": "string",
1591
+ "maxLength": 256
1592
+ }
1593
+ },
1594
+ {
1595
+ "name": "context",
1596
+ "in": "query",
1597
+ "required": false,
1598
+ "style": "form",
1599
+ "explode": true,
1600
+ "schema": {
1601
+ "type": "string",
1602
+ "enum": [
1603
+ "global",
1604
+ "category",
1605
+ "folder"
1606
+ ]
1607
+ }
1608
+ }
1609
+ ],
1610
+ "responses": {
1611
+ "200": {
1612
+ "description": "Slot configuration retrieved successfully",
1613
+ "content": {
1614
+ "application/json": {
1615
+ "schema": {
1616
+ "$ref": "#/components/schemas/SlotConfiguration"
1617
+ }
1618
+ }
1619
+ }
1620
+ },
1621
+ "400": {
1622
+ "description": "Invalid request parameters. This can occur when:\n- The specified context type is invalid.\n- The context ID is missing for category or folder context.\n",
1623
+ "content": {
1624
+ "application/json": {
1625
+ "schema": {
1626
+ "$ref": "#/components/schemas/ErrorResponse"
1627
+ }
1628
+ }
1629
+ }
1630
+ },
1631
+ "404": {
1632
+ "description": "The requested resource was not found. This can occur when:\n- The specified slot does not exist.\n- The specified slot configuration does not exist.\n- The specified site does not exist.\n",
1633
+ "content": {
1634
+ "application/json": {
1635
+ "schema": {
1636
+ "$ref": "#/components/schemas/ErrorResponse"
1637
+ }
1638
+ }
1639
+ }
1640
+ }
1641
+ },
1642
+ "security": [
1643
+ {
1644
+ "AmOAuth2": [
1645
+ "sfcc.experiences",
1646
+ "sfcc.experiences.rw"
1647
+ ]
1648
+ }
1649
+ ]
1650
+ },
1651
+ "put": {
1652
+ "operationId": "createOrUpdateSlotConfiguration",
1653
+ "parameters": [
1654
+ {
1655
+ "name": "organizationId",
1656
+ "in": "path",
1657
+ "required": true,
1658
+ "style": "simple",
1659
+ "explode": false,
1660
+ "schema": {
1661
+ "$ref": "#/components/schemas/OrganizationId"
1662
+ }
1663
+ },
1664
+ {
1665
+ "name": "siteId",
1666
+ "in": "query",
1667
+ "required": true,
1668
+ "style": "form",
1669
+ "explode": true,
1670
+ "schema": {
1671
+ "$ref": "#/components/schemas/SiteId"
1672
+ }
1673
+ },
1674
+ {
1675
+ "name": "slotId",
1676
+ "in": "path",
1677
+ "required": true,
1678
+ "style": "simple",
1679
+ "explode": false,
1680
+ "schema": {
1681
+ "type": "string",
1682
+ "maxLength": 256
1683
+ }
1684
+ },
1685
+ {
1686
+ "name": "configurationId",
1687
+ "in": "path",
1688
+ "required": true,
1689
+ "style": "simple",
1690
+ "explode": false,
1691
+ "schema": {
1692
+ "type": "string",
1693
+ "maxLength": 256
1694
+ }
1695
+ },
1696
+ {
1697
+ "name": "context",
1698
+ "in": "query",
1699
+ "required": false,
1700
+ "style": "form",
1701
+ "explode": true,
1702
+ "schema": {
1703
+ "type": "string",
1704
+ "enum": [
1705
+ "global",
1706
+ "category",
1707
+ "folder"
1708
+ ]
1709
+ }
1710
+ }
1711
+ ],
1712
+ "requestBody": {
1713
+ "content": {
1714
+ "application/json": {
1715
+ "schema": {
1716
+ "$ref": "#/components/schemas/SlotConfiguration"
1717
+ }
1718
+ }
1719
+ },
1720
+ "required": true
1721
+ },
1722
+ "responses": {
1723
+ "200": {
1724
+ "description": "Slot configuration updated successfully",
1725
+ "content": {
1726
+ "application/json": {
1727
+ "schema": {
1728
+ "$ref": "#/components/schemas/SlotConfiguration"
1729
+ }
1730
+ }
1731
+ }
1732
+ },
1733
+ "201": {
1734
+ "description": "Slot configuration created successfully",
1735
+ "content": {
1736
+ "application/json": {
1737
+ "schema": {
1738
+ "$ref": "#/components/schemas/SlotConfiguration"
1739
+ }
1740
+ }
1741
+ }
1742
+ },
1743
+ "400": {
1744
+ "description": "Invalid slot configuration data provided. This can occur when:\n- The ID in the request path does not match the ID in the request body.\n- The specified context type is invalid.\n- The context ID is missing for category or folder context.\n",
1745
+ "content": {
1746
+ "application/json": {
1747
+ "schema": {
1748
+ "$ref": "#/components/schemas/ErrorResponse"
1749
+ }
1750
+ }
1751
+ }
1752
+ },
1753
+ "404": {
1754
+ "description": "The specified resource was not found. This can occur when:\n- The specified site does not exist.\n- The specified slot does not exist.\n- Content asset does not exist in the library.\n",
1755
+ "content": {
1756
+ "application/json": {
1757
+ "schema": {
1758
+ "$ref": "#/components/schemas/ErrorResponse"
1759
+ }
1760
+ }
1761
+ }
1762
+ }
1763
+ },
1764
+ "security": [
1765
+ {
1766
+ "AmOAuth2": [
1767
+ "sfcc.experiences.rw"
1768
+ ]
1769
+ }
1770
+ ]
1771
+ },
1772
+ "delete": {
1773
+ "operationId": "deleteSlotConfiguration",
1774
+ "parameters": [
1775
+ {
1776
+ "name": "organizationId",
1777
+ "in": "path",
1778
+ "required": true,
1779
+ "style": "simple",
1780
+ "explode": false,
1781
+ "schema": {
1782
+ "$ref": "#/components/schemas/OrganizationId"
1783
+ }
1784
+ },
1785
+ {
1786
+ "name": "siteId",
1787
+ "in": "query",
1788
+ "required": true,
1789
+ "style": "form",
1790
+ "explode": true,
1791
+ "schema": {
1792
+ "$ref": "#/components/schemas/SiteId"
1793
+ }
1794
+ },
1795
+ {
1796
+ "name": "slotId",
1797
+ "in": "path",
1798
+ "required": true,
1799
+ "style": "simple",
1800
+ "explode": false,
1801
+ "schema": {
1802
+ "type": "string",
1803
+ "maxLength": 256
1804
+ }
1805
+ },
1806
+ {
1807
+ "name": "configurationId",
1808
+ "in": "path",
1809
+ "required": true,
1810
+ "style": "simple",
1811
+ "explode": false,
1812
+ "schema": {
1813
+ "type": "string",
1814
+ "maxLength": 256
1815
+ }
1816
+ },
1817
+ {
1818
+ "name": "context",
1819
+ "in": "query",
1820
+ "required": false,
1821
+ "style": "form",
1822
+ "explode": true,
1823
+ "schema": {
1824
+ "type": "string",
1825
+ "enum": [
1826
+ "global",
1827
+ "category",
1828
+ "folder"
1829
+ ]
1830
+ }
1831
+ }
1832
+ ],
1833
+ "responses": {
1834
+ "204": {
1835
+ "description": "Slot configuration deleted successfully"
1836
+ },
1837
+ "400": {
1838
+ "description": "Invalid request parameters. This can occur when:\n- The specified context type is invalid.\n",
1839
+ "content": {
1840
+ "application/json": {
1841
+ "schema": {
1842
+ "$ref": "#/components/schemas/ErrorResponse"
1843
+ }
1844
+ }
1845
+ }
1846
+ },
1847
+ "404": {
1848
+ "description": "The requested resource was not found. This can occur when:\n- The specified site does not exist.\n- The specified slot does not exist.\n",
1849
+ "content": {
1850
+ "application/json": {
1851
+ "schema": {
1852
+ "$ref": "#/components/schemas/ErrorResponse"
1853
+ }
1854
+ }
1855
+ }
1856
+ }
1857
+ },
1858
+ "security": [
1859
+ {
1860
+ "AmOAuth2": [
1861
+ "sfcc.experiences.rw"
1862
+ ]
1863
+ }
1864
+ ]
1865
+ },
1866
+ "patch": {
1867
+ "operationId": "patchSlotConfiguration",
1868
+ "parameters": [
1869
+ {
1870
+ "name": "organizationId",
1871
+ "in": "path",
1872
+ "required": true,
1873
+ "style": "simple",
1874
+ "explode": false,
1875
+ "schema": {
1876
+ "$ref": "#/components/schemas/OrganizationId"
1877
+ }
1878
+ },
1879
+ {
1880
+ "name": "siteId",
1881
+ "in": "query",
1882
+ "required": true,
1883
+ "style": "form",
1884
+ "explode": true,
1885
+ "schema": {
1886
+ "$ref": "#/components/schemas/SiteId"
1887
+ }
1888
+ },
1889
+ {
1890
+ "name": "slotId",
1891
+ "in": "path",
1892
+ "required": true,
1893
+ "style": "simple",
1894
+ "explode": false,
1895
+ "schema": {
1896
+ "type": "string",
1897
+ "maxLength": 256
1898
+ }
1899
+ },
1900
+ {
1901
+ "name": "configurationId",
1902
+ "in": "path",
1903
+ "required": true,
1904
+ "style": "simple",
1905
+ "explode": false,
1906
+ "schema": {
1907
+ "type": "string",
1908
+ "maxLength": 256
1909
+ }
1910
+ },
1911
+ {
1912
+ "name": "context",
1913
+ "in": "query",
1914
+ "required": false,
1915
+ "style": "form",
1916
+ "explode": true,
1917
+ "schema": {
1918
+ "type": "string",
1919
+ "enum": [
1920
+ "global",
1921
+ "category",
1922
+ "folder"
1923
+ ]
1924
+ }
1925
+ }
1926
+ ],
1927
+ "requestBody": {
1928
+ "content": {
1929
+ "application/json": {
1930
+ "schema": {
1931
+ "$ref": "#/components/schemas/SlotConfiguration"
1932
+ }
1933
+ }
1934
+ },
1935
+ "required": true
1936
+ },
1937
+ "responses": {
1938
+ "200": {
1939
+ "description": "Slot configuration updated successfully",
1940
+ "content": {
1941
+ "application/json": {
1942
+ "schema": {
1943
+ "$ref": "#/components/schemas/SlotConfiguration"
1944
+ }
1945
+ }
1946
+ }
1947
+ },
1948
+ "400": {
1949
+ "description": "Invalid slot configuration data provided. This can occur when:\n- The specified context type is invalid.\n- The context ID is missing for category or folder context.\n",
1950
+ "content": {
1951
+ "application/json": {
1952
+ "schema": {
1953
+ "$ref": "#/components/schemas/ErrorResponse"
1954
+ }
1955
+ }
1956
+ }
1957
+ },
1958
+ "404": {
1959
+ "description": "The requested resource was not found. This can occur when:\n- The specified slot does not exist.\n- The specified slot configuration does not exist.\n- The specified site does not exist.\n- Content asset does not exist in the library.\n",
1960
+ "content": {
1961
+ "application/json": {
1962
+ "schema": {
1963
+ "$ref": "#/components/schemas/ErrorResponse"
1964
+ }
1965
+ }
1966
+ }
1967
+ },
1968
+ "409": {
1969
+ "description": "Conflict with existing resource. This can occur when:\n- A slot configuration with the specified ID already exists in this context.\n",
1970
+ "content": {
1971
+ "application/json": {
1972
+ "schema": {
1973
+ "$ref": "#/components/schemas/ErrorResponse"
1974
+ }
1975
+ }
1976
+ }
1977
+ }
1978
+ },
1979
+ "security": [
1980
+ {
1981
+ "AmOAuth2": [
1982
+ "sfcc.experiences.rw"
1983
+ ]
1984
+ }
1985
+ ]
1986
+ }
1987
+ },
1988
+ "/organizations/{organizationId}/slot-configurations-search": {
1989
+ "post": {
1990
+ "operationId": "searchSlotConfigurations",
1991
+ "parameters": [
1992
+ {
1993
+ "name": "organizationId",
1994
+ "in": "path",
1995
+ "required": true,
1996
+ "style": "simple",
1997
+ "explode": false,
1998
+ "schema": {
1999
+ "$ref": "#/components/schemas/OrganizationId"
2000
+ }
2001
+ },
2002
+ {
2003
+ "name": "siteId",
2004
+ "in": "query",
2005
+ "required": true,
2006
+ "style": "form",
2007
+ "explode": true,
2008
+ "schema": {
2009
+ "$ref": "#/components/schemas/SiteId"
2010
+ }
2011
+ }
2012
+ ],
2013
+ "requestBody": {
2014
+ "content": {
2015
+ "application/json": {
2016
+ "schema": {
2017
+ "$ref": "#/components/schemas/SlotConfigurationSearchRequest"
2018
+ }
2019
+ }
2020
+ },
2021
+ "required": true
2022
+ },
2023
+ "responses": {
2024
+ "200": {
2025
+ "description": "Search completed successfully",
2026
+ "content": {
2027
+ "application/json": {
2028
+ "schema": {
2029
+ "$ref": "#/components/schemas/SlotConfigurationSearchResult"
2030
+ }
2031
+ }
2032
+ }
2033
+ },
2034
+ "400": {
2035
+ "description": "Invalid search query provided.\n",
2036
+ "content": {
2037
+ "application/json": {
2038
+ "schema": {
2039
+ "$ref": "#/components/schemas/ErrorResponse"
2040
+ }
2041
+ }
2042
+ }
2043
+ },
2044
+ "404": {
2045
+ "description": "The requested resource was not found. This can occur when:\n- The specified site does not exist.\n",
2046
+ "content": {
2047
+ "application/json": {
2048
+ "schema": {
2049
+ "$ref": "#/components/schemas/ErrorResponse"
2050
+ }
2051
+ }
2052
+ }
2053
+ }
2054
+ },
2055
+ "security": [
2056
+ {
2057
+ "AmOAuth2": [
2058
+ "sfcc.experiences",
2059
+ "sfcc.experiences.rw"
2060
+ ]
2061
+ }
2062
+ ]
2063
+ }
2064
+ }
2065
+ },
2066
+ "components": {
2067
+ "schemas": {
2068
+ "OrganizationId": {
2069
+ "type": "string",
2070
+ "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
2071
+ },
2072
+ "SiteId": {
2073
+ "type": "string",
2074
+ "maxLength": 32,
2075
+ "minLength": 1
2076
+ },
2077
+ "PageBase": {
2078
+ "type": "object",
2079
+ "additionalProperties": {},
2080
+ "properties": {
2081
+ "id": {
2082
+ "type": "string",
2083
+ "maxLength": 256
2084
+ },
2085
+ "typeId": {
2086
+ "type": "string",
2087
+ "maxLength": 256
2088
+ },
2089
+ "aspectTypeId": {
2090
+ "type": "string",
2091
+ "maxLength": 256
2092
+ },
2093
+ "name": {
2094
+ "type": "string",
2095
+ "maxLength": 4000
2096
+ },
2097
+ "description": {
2098
+ "type": "string",
2099
+ "maxLength": 4000
2100
+ },
2101
+ "pageTitle": {
2102
+ "type": "string",
2103
+ "maxLength": 4000
2104
+ },
2105
+ "pageDescription": {
2106
+ "type": "string",
2107
+ "maxLength": 4000
2108
+ },
2109
+ "pageKeywords": {
2110
+ "type": "string",
2111
+ "maxLength": 4000
2112
+ },
2113
+ "thumbnail": {
2114
+ "type": "string",
2115
+ "maxLength": 256
2116
+ },
2117
+ "data": {
2118
+ "type": "object",
2119
+ "additionalProperties": false
2120
+ }
2121
+ },
2122
+ "required": [
2123
+ "id",
2124
+ "name",
2125
+ "typeId"
2126
+ ]
2127
+ },
2128
+ "RegionRequest": {
2129
+ "type": "object",
2130
+ "additionalProperties": {},
2131
+ "properties": {
2132
+ "id": {
2133
+ "type": "string",
2134
+ "maxLength": 256
2135
+ },
2136
+ "components": {
2137
+ "type": "array",
2138
+ "items": {
2139
+ "$ref": "#/components/schemas/ComponentRequest"
2140
+ }
2141
+ }
2142
+ },
2143
+ "required": [
2144
+ "id"
2145
+ ]
2146
+ },
2147
+ "ComponentRequest": {
2148
+ "type": "object",
2149
+ "additionalProperties": {},
2150
+ "properties": {
2151
+ "id": {
2152
+ "type": "string",
2153
+ "maxLength": 256
2154
+ },
2155
+ "typeId": {
2156
+ "type": "string",
2157
+ "maxLength": 256
2158
+ },
2159
+ "name": {
2160
+ "type": "string",
2161
+ "maxLength": 256
2162
+ },
2163
+ "data": {
2164
+ "type": "object",
2165
+ "additionalProperties": false
2166
+ },
2167
+ "visible": {
2168
+ "type": "boolean"
2169
+ },
2170
+ "localized": {
2171
+ "type": "boolean"
2172
+ },
2173
+ "designMetadata": {
2174
+ "type": "object",
2175
+ "additionalProperties": false
2176
+ },
2177
+ "regions": {
2178
+ "type": "array",
2179
+ "items": {
2180
+ "$ref": "#/components/schemas/RegionRequest"
2181
+ }
2182
+ }
2183
+ },
2184
+ "required": [
2185
+ "id",
2186
+ "typeId"
2187
+ ]
2188
+ },
2189
+ "PageRequest": {
2190
+ "allOf": [
2191
+ {
2192
+ "$ref": "#/components/schemas/PageBase"
2193
+ }
2194
+ ],
2195
+ "properties": {
2196
+ "regions": {
2197
+ "type": "array",
2198
+ "items": {
2199
+ "$ref": "#/components/schemas/RegionRequest"
2200
+ }
2201
+ }
2202
+ }
2203
+ },
2204
+ "Region": {
2205
+ "type": "object",
2206
+ "properties": {
2207
+ "id": {
2208
+ "type": "string",
2209
+ "maxLength": 256
2210
+ },
2211
+ "components": {
2212
+ "type": "array",
2213
+ "items": {
2214
+ "$ref": "#/components/schemas/Component"
2215
+ }
2216
+ }
2217
+ },
2218
+ "required": [
2219
+ "id"
2220
+ ]
2221
+ },
2222
+ "Component": {
2223
+ "type": "object",
2224
+ "properties": {
2225
+ "id": {
2226
+ "type": "string",
2227
+ "maxLength": 256
2228
+ },
2229
+ "typeId": {
2230
+ "type": "string",
2231
+ "maxLength": 256
2232
+ },
2233
+ "name": {
2234
+ "type": "string",
2235
+ "maxLength": 256
2236
+ },
2237
+ "data": {
2238
+ "type": "object",
2239
+ "additionalProperties": false
2240
+ },
2241
+ "custom": {
2242
+ "type": "object",
2243
+ "additionalProperties": false
2244
+ },
2245
+ "visible": {
2246
+ "type": "boolean"
2247
+ },
2248
+ "localized": {
2249
+ "type": "boolean"
2250
+ },
2251
+ "fragment": {
2252
+ "type": "boolean"
2253
+ },
2254
+ "designMetadata": {
2255
+ "type": "object",
2256
+ "additionalProperties": false
2257
+ },
2258
+ "regions": {
2259
+ "type": "array",
2260
+ "items": {
2261
+ "$ref": "#/components/schemas/Region"
2262
+ }
2263
+ }
2264
+ },
2265
+ "required": [
2266
+ "id",
2267
+ "typeId"
2268
+ ]
2269
+ },
2270
+ "Page": {
2271
+ "allOf": [
2272
+ {
2273
+ "$ref": "#/components/schemas/PageBase"
2274
+ }
2275
+ ],
2276
+ "properties": {
2277
+ "custom": {
2278
+ "type": "object",
2279
+ "additionalProperties": false
2280
+ },
2281
+ "regions": {
2282
+ "type": "array",
2283
+ "items": {
2284
+ "$ref": "#/components/schemas/Region"
2285
+ }
2286
+ },
2287
+ "creationDate": {
2288
+ "type": "string",
2289
+ "format": "date-time"
2290
+ },
2291
+ "lastModified": {
2292
+ "type": "string",
2293
+ "format": "date-time"
2294
+ },
2295
+ "online": {
2296
+ "type": "boolean"
2297
+ }
2298
+ }
2299
+ },
2300
+ "ErrorResponse": {
2301
+ "type": "object",
2302
+ "additionalProperties": true,
2303
+ "properties": {
2304
+ "title": {
2305
+ "type": "string",
2306
+ "maxLength": 256
2307
+ },
2308
+ "type": {
2309
+ "type": "string",
2310
+ "maxLength": 2048
2311
+ },
2312
+ "detail": {
2313
+ "type": "string"
2314
+ },
2315
+ "instance": {
2316
+ "type": "string",
2317
+ "maxLength": 2048
2318
+ }
2319
+ },
2320
+ "required": [
2321
+ "detail",
2322
+ "title",
2323
+ "type"
2324
+ ]
2325
+ },
2326
+ "ContentFolder": {
2327
+ "type": "object",
2328
+ "additionalProperties": {},
2329
+ "properties": {
2330
+ "id": {
2331
+ "type": "string",
2332
+ "maxLength": 256
2333
+ },
2334
+ "description": {
2335
+ "type": "object",
2336
+ "additionalProperties": {
2337
+ "type": "string"
2338
+ }
2339
+ },
2340
+ "name": {
2341
+ "type": "object",
2342
+ "additionalProperties": {
2343
+ "type": "string"
2344
+ }
2345
+ },
2346
+ "online": {
2347
+ "type": "boolean"
2348
+ },
2349
+ "pageDescription": {
2350
+ "type": "object",
2351
+ "additionalProperties": {
2352
+ "type": "string"
2353
+ }
2354
+ },
2355
+ "pageKeywords": {
2356
+ "type": "object",
2357
+ "additionalProperties": {
2358
+ "type": "string"
2359
+ }
2360
+ },
2361
+ "pageTitle": {
2362
+ "type": "object",
2363
+ "additionalProperties": {
2364
+ "type": "string"
2365
+ }
2366
+ },
2367
+ "pageUrl": {
2368
+ "type": "object",
2369
+ "additionalProperties": {
2370
+ "type": "string"
2371
+ }
2372
+ },
2373
+ "parentFolderId": {
2374
+ "type": "string"
2375
+ },
2376
+ "template": {
2377
+ "type": "string"
2378
+ },
2379
+ "creationDate": {
2380
+ "type": "string",
2381
+ "format": "date-time",
2382
+ "readOnly": true
2383
+ },
2384
+ "lastModified": {
2385
+ "type": "string",
2386
+ "format": "date-time",
2387
+ "readOnly": true
2388
+ }
2389
+ },
2390
+ "required": [
2391
+ "id"
2392
+ ]
2393
+ },
2394
+ "Total": {
2395
+ "type": "integer",
2396
+ "format": "int32",
2397
+ "default": 0,
2398
+ "minimum": 0
2399
+ },
2400
+ "ResultBase": {
2401
+ "type": "object",
2402
+ "properties": {
2403
+ "limit": {
2404
+ "type": "integer",
2405
+ "format": "int32"
2406
+ },
2407
+ "total": {
2408
+ "$ref": "#/components/schemas/Total"
2409
+ }
2410
+ },
2411
+ "required": [
2412
+ "limit",
2413
+ "total"
2414
+ ]
2415
+ },
2416
+ "Offset": {
2417
+ "type": "integer",
2418
+ "format": "int32",
2419
+ "default": 0,
2420
+ "minimum": 0
2421
+ },
2422
+ "PaginatedResultBase": {
2423
+ "allOf": [
2424
+ {
2425
+ "$ref": "#/components/schemas/ResultBase"
2426
+ }
2427
+ ],
2428
+ "properties": {
2429
+ "offset": {
2430
+ "$ref": "#/components/schemas/Offset"
2431
+ }
2432
+ },
2433
+ "required": [
2434
+ "limit",
2435
+ "offset",
2436
+ "total"
2437
+ ]
2438
+ },
2439
+ "ContentSubFolderResult": {
2440
+ "allOf": [
2441
+ {
2442
+ "$ref": "#/components/schemas/PaginatedResultBase"
2443
+ }
2444
+ ],
2445
+ "properties": {
2446
+ "hits": {
2447
+ "type": "array",
2448
+ "items": {
2449
+ "$ref": "#/components/schemas/ContentFolder"
2450
+ }
2451
+ }
2452
+ }
2453
+ },
2454
+ "ContentAsset": {
2455
+ "type": "object",
2456
+ "additionalProperties": {},
2457
+ "properties": {
2458
+ "id": {
2459
+ "type": "string",
2460
+ "maxLength": 256
2461
+ },
2462
+ "classificationFolderId": {
2463
+ "type": "string"
2464
+ },
2465
+ "name": {
2466
+ "type": "object",
2467
+ "additionalProperties": {
2468
+ "type": "string"
2469
+ }
2470
+ },
2471
+ "description": {
2472
+ "type": "object",
2473
+ "additionalProperties": {
2474
+ "type": "string"
2475
+ }
2476
+ },
2477
+ "online": {
2478
+ "type": "object",
2479
+ "additionalProperties": {
2480
+ "type": "boolean"
2481
+ }
2482
+ },
2483
+ "pageDescription": {
2484
+ "type": "object",
2485
+ "additionalProperties": {
2486
+ "type": "string"
2487
+ }
2488
+ },
2489
+ "pageKeywords": {
2490
+ "type": "object",
2491
+ "additionalProperties": {
2492
+ "type": "string"
2493
+ }
2494
+ },
2495
+ "pageTitle": {
2496
+ "type": "object",
2497
+ "additionalProperties": {
2498
+ "type": "string"
2499
+ }
2500
+ },
2501
+ "pageUrl": {
2502
+ "type": "object",
2503
+ "additionalProperties": {
2504
+ "type": "string"
2505
+ }
2506
+ },
2507
+ "searchable": {
2508
+ "type": "object",
2509
+ "additionalProperties": {
2510
+ "type": "boolean"
2511
+ }
2512
+ },
2513
+ "siteMapChangeFrequency": {
2514
+ "type": "object",
2515
+ "additionalProperties": {
2516
+ "type": "string",
2517
+ "enum": [
2518
+ "always",
2519
+ "hourly",
2520
+ "daily",
2521
+ "weekly",
2522
+ "monthly",
2523
+ "yearly",
2524
+ "never"
2525
+ ]
2526
+ }
2527
+ },
2528
+ "siteMapIncluded": {
2529
+ "type": "object",
2530
+ "additionalProperties": {
2531
+ "type": "integer",
2532
+ "maximum": 1,
2533
+ "minimum": 0
2534
+ }
2535
+ },
2536
+ "siteMapPriority": {
2537
+ "type": "object",
2538
+ "additionalProperties": {
2539
+ "type": "number"
2540
+ }
2541
+ },
2542
+ "template": {
2543
+ "type": "string"
2544
+ },
2545
+ "creationDate": {
2546
+ "type": "string",
2547
+ "format": "date-time",
2548
+ "readOnly": true
2549
+ },
2550
+ "lastModified": {
2551
+ "type": "string",
2552
+ "format": "date-time",
2553
+ "readOnly": true
2554
+ }
2555
+ },
2556
+ "required": [
2557
+ "id"
2558
+ ]
2559
+ },
2560
+ "ContentFolderResult": {
2561
+ "allOf": [
2562
+ {
2563
+ "$ref": "#/components/schemas/PaginatedResultBase"
2564
+ }
2565
+ ],
2566
+ "properties": {
2567
+ "hits": {
2568
+ "type": "array",
2569
+ "items": {
2570
+ "$ref": "#/components/schemas/ContentFolder"
2571
+ }
2572
+ }
2573
+ }
2574
+ },
2575
+ "ContentFolderAssignment": {
2576
+ "type": "object",
2577
+ "additionalProperties": {},
2578
+ "properties": {
2579
+ "contentId": {
2580
+ "type": "string",
2581
+ "maxLength": 256
2582
+ },
2583
+ "folderId": {
2584
+ "type": "string",
2585
+ "maxLength": 256
2586
+ },
2587
+ "position": {
2588
+ "type": "number",
2589
+ "format": "double",
2590
+ "minimum": 0
2591
+ },
2592
+ "default": {
2593
+ "type": "boolean"
2594
+ }
2595
+ },
2596
+ "required": [
2597
+ "contentId",
2598
+ "folderId"
2599
+ ]
2600
+ },
2601
+ "ContentAssetResult": {
2602
+ "allOf": [
2603
+ {
2604
+ "$ref": "#/components/schemas/PaginatedResultBase"
2605
+ }
2606
+ ],
2607
+ "properties": {
2608
+ "hits": {
2609
+ "type": "array",
2610
+ "items": {
2611
+ "$ref": "#/components/schemas/ContentAsset"
2612
+ }
2613
+ }
2614
+ }
2615
+ },
2616
+ "Select": {
2617
+ "type": "string",
2618
+ "minLength": 1,
2619
+ "pattern": "^[(].*[)]$"
2620
+ },
2621
+ "MarkupText": {
2622
+ "type": "object",
2623
+ "properties": {
2624
+ "source": {
2625
+ "type": "string"
2626
+ },
2627
+ "markup": {
2628
+ "type": "string"
2629
+ }
2630
+ }
2631
+ },
2632
+ "TimeOfDay": {
2633
+ "type": "object",
2634
+ "properties": {
2635
+ "timeFrom": {
2636
+ "type": "string",
2637
+ "pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$"
2638
+ },
2639
+ "timeTo": {
2640
+ "type": "string",
2641
+ "pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$"
2642
+ }
2643
+ }
2644
+ },
2645
+ "Recurrence": {
2646
+ "type": "object",
2647
+ "properties": {
2648
+ "dayOfWeek": {
2649
+ "type": "array",
2650
+ "items": {
2651
+ "type": "string",
2652
+ "enum": [
2653
+ "monday",
2654
+ "tuesday",
2655
+ "wednesday",
2656
+ "thursday",
2657
+ "friday",
2658
+ "saturday",
2659
+ "sunday"
2660
+ ]
2661
+ }
2662
+ },
2663
+ "timeOfDay": {
2664
+ "$ref": "#/components/schemas/TimeOfDay"
2665
+ }
2666
+ }
2667
+ },
2668
+ "Schedule": {
2669
+ "type": "object",
2670
+ "properties": {
2671
+ "startDate": {
2672
+ "type": "string",
2673
+ "format": "date-time"
2674
+ },
2675
+ "endDate": {
2676
+ "type": "string",
2677
+ "format": "date-time"
2678
+ },
2679
+ "recurrence": {
2680
+ "$ref": "#/components/schemas/Recurrence"
2681
+ }
2682
+ }
2683
+ },
2684
+ "SlotContent": {
2685
+ "type": "object",
2686
+ "properties": {
2687
+ "type": {
2688
+ "type": "string",
2689
+ "enum": [
2690
+ "products",
2691
+ "categories",
2692
+ "contentAssets",
2693
+ "html",
2694
+ "recommendedProducts"
2695
+ ]
2696
+ },
2697
+ "productIds": {
2698
+ "type": "array",
2699
+ "items": {
2700
+ "type": "string",
2701
+ "maxLength": 100
2702
+ }
2703
+ },
2704
+ "categoryIds": {
2705
+ "type": "array",
2706
+ "items": {
2707
+ "type": "string",
2708
+ "maxLength": 256
2709
+ }
2710
+ },
2711
+ "recommendationRuleId": {
2712
+ "type": "string",
2713
+ "maxLength": 256
2714
+ },
2715
+ "contentAssetIds": {
2716
+ "type": "array",
2717
+ "items": {
2718
+ "type": "string"
2719
+ }
2720
+ },
2721
+ "body": {
2722
+ "type": "object",
2723
+ "additionalProperties": {
2724
+ "$ref": "#/components/schemas/MarkupText"
2725
+ }
2726
+ }
2727
+ },
2728
+ "required": [
2729
+ "type"
2730
+ ]
2731
+ },
2732
+ "SlotConfiguration": {
2733
+ "type": "object",
2734
+ "additionalProperties": {},
2735
+ "properties": {
2736
+ "configurationId": {
2737
+ "type": "string",
2738
+ "maxLength": 256
2739
+ },
2740
+ "slotId": {
2741
+ "type": "string",
2742
+ "maxLength": 256
2743
+ },
2744
+ "uuid": {
2745
+ "type": "string",
2746
+ "maxLength": 28
2747
+ },
2748
+ "enabled": {
2749
+ "type": "boolean"
2750
+ },
2751
+ "default": {
2752
+ "type": "boolean"
2753
+ },
2754
+ "description": {
2755
+ "type": "string",
2756
+ "maxLength": 4000
2757
+ },
2758
+ "callout": {
2759
+ "type": "object",
2760
+ "additionalProperties": {
2761
+ "$ref": "#/components/schemas/MarkupText"
2762
+ }
2763
+ },
2764
+ "customerGroups": {
2765
+ "type": "array",
2766
+ "items": {
2767
+ "type": "string"
2768
+ }
2769
+ },
2770
+ "rank": {
2771
+ "type": "integer",
2772
+ "minimum": 1
2773
+ },
2774
+ "template": {
2775
+ "type": "string",
2776
+ "maxLength": 256
2777
+ },
2778
+ "contextId": {
2779
+ "type": "string",
2780
+ "maxLength": 256
2781
+ },
2782
+ "context": {
2783
+ "type": "string",
2784
+ "enum": [
2785
+ "global",
2786
+ "category",
2787
+ "folder"
2788
+ ]
2789
+ },
2790
+ "schedule": {
2791
+ "$ref": "#/components/schemas/Schedule"
2792
+ },
2793
+ "slotContent": {
2794
+ "$ref": "#/components/schemas/SlotContent"
2795
+ },
2796
+ "assignmentInformation": {
2797
+ "$ref": "#/components/schemas/SlotConfigurationAssignmentInformation"
2798
+ },
2799
+ "creationDate": {
2800
+ "type": "string",
2801
+ "format": "date-time"
2802
+ },
2803
+ "lastModified": {
2804
+ "type": "string",
2805
+ "format": "date-time"
2806
+ }
2807
+ },
2808
+ "required": [
2809
+ "configurationId",
2810
+ "enabled",
2811
+ "slotContent",
2812
+ "slotId"
2813
+ ]
2814
+ },
2815
+ "SlotConfigurationCampaignAssignment": {
2816
+ "type": "object",
2817
+ "properties": {
2818
+ "slotId": {
2819
+ "type": "string",
2820
+ "maxLength": 256
2821
+ },
2822
+ "slotConfigurationId": {
2823
+ "type": "string",
2824
+ "maxLength": 256
2825
+ },
2826
+ "slotConfigurationUuid": {
2827
+ "type": "string",
2828
+ "maxLength": 28
2829
+ },
2830
+ "description": {
2831
+ "type": "string",
2832
+ "maxLength": 4000
2833
+ },
2834
+ "campaignId": {
2835
+ "type": "string",
2836
+ "maxLength": 256
2837
+ },
2838
+ "rank": {
2839
+ "type": "integer",
2840
+ "minimum": 1
2841
+ },
2842
+ "customerGroups": {
2843
+ "type": "array",
2844
+ "items": {
2845
+ "type": "string"
2846
+ }
2847
+ },
2848
+ "context": {
2849
+ "type": "string",
2850
+ "enum": [
2851
+ "global",
2852
+ "category",
2853
+ "folder"
2854
+ ]
2855
+ },
2856
+ "slotContextId": {
2857
+ "type": "string",
2858
+ "maxLength": 256
2859
+ },
2860
+ "enabled": {
2861
+ "type": "boolean"
2862
+ },
2863
+ "schedule": {
2864
+ "$ref": "#/components/schemas/Schedule"
2865
+ },
2866
+ "campaign": {
2867
+ "type": "object",
2868
+ "additionalProperties": false
2869
+ },
2870
+ "slotConfiguration": {
2871
+ "$ref": "#/components/schemas/SlotConfiguration"
2872
+ },
2873
+ "creationDate": {
2874
+ "type": "string",
2875
+ "format": "date-time"
2876
+ },
2877
+ "lastModified": {
2878
+ "type": "string",
2879
+ "format": "date-time"
2880
+ }
2881
+ },
2882
+ "required": [
2883
+ "context",
2884
+ "slotConfigurationId",
2885
+ "slotId"
2886
+ ]
2887
+ },
2888
+ "SlotConfigurationABTestGroupAssignment": {
2889
+ "type": "object",
2890
+ "properties": {
2891
+ "abtestId": {
2892
+ "type": "string"
2893
+ },
2894
+ "abtestDescription": {
2895
+ "type": "string"
2896
+ },
2897
+ "enabled": {
2898
+ "type": "boolean"
2899
+ },
2900
+ "schedule": {
2901
+ "$ref": "#/components/schemas/Schedule"
2902
+ },
2903
+ "segmentId": {
2904
+ "type": "string"
2905
+ },
2906
+ "segmentDescription": {
2907
+ "type": "string"
2908
+ }
2909
+ }
2910
+ },
2911
+ "SlotConfigurationAssignmentInformation": {
2912
+ "type": "object",
2913
+ "properties": {
2914
+ "activeCampaignAssignments": {
2915
+ "type": "array",
2916
+ "items": {
2917
+ "$ref": "#/components/schemas/SlotConfigurationCampaignAssignment"
2918
+ }
2919
+ },
2920
+ "upcomingCampaignAssignments": {
2921
+ "type": "array",
2922
+ "items": {
2923
+ "$ref": "#/components/schemas/SlotConfigurationCampaignAssignment"
2924
+ }
2925
+ },
2926
+ "activeAbtestAssignments": {
2927
+ "type": "array",
2928
+ "items": {
2929
+ "$ref": "#/components/schemas/SlotConfigurationABTestGroupAssignment"
2930
+ }
2931
+ },
2932
+ "upcomingAbtestAssignments": {
2933
+ "type": "array",
2934
+ "items": {
2935
+ "$ref": "#/components/schemas/SlotConfigurationABTestGroupAssignment"
2936
+ }
2937
+ }
2938
+ }
2939
+ },
2940
+ "Slot": {
2941
+ "type": "object",
2942
+ "properties": {
2943
+ "slotId": {
2944
+ "type": "string",
2945
+ "maxLength": 256
2946
+ },
2947
+ "description": {
2948
+ "type": "string",
2949
+ "maxLength": 4000
2950
+ },
2951
+ "previewUrl": {
2952
+ "type": "string",
2953
+ "maxLength": 4000
2954
+ },
2955
+ "contextType": {
2956
+ "type": "string",
2957
+ "enum": [
2958
+ "global",
2959
+ "category",
2960
+ "folder"
2961
+ ]
2962
+ },
2963
+ "slotConfigurations": {
2964
+ "type": "array",
2965
+ "items": {
2966
+ "$ref": "#/components/schemas/SlotConfiguration"
2967
+ }
2968
+ },
2969
+ "creationDate": {
2970
+ "type": "string",
2971
+ "format": "date-time"
2972
+ },
2973
+ "lastModified": {
2974
+ "type": "string",
2975
+ "format": "date-time"
2976
+ }
2977
+ },
2978
+ "required": [
2979
+ "contextType",
2980
+ "slotId"
2981
+ ]
2982
+ },
2983
+ "Query": {
2984
+ "type": "object",
2985
+ "additionalProperties": false,
2986
+ "maxProperties": 1,
2987
+ "minProperties": 1,
2988
+ "properties": {
2989
+ "boolQuery": {
2990
+ "$ref": "#/components/schemas/BoolQuery"
2991
+ },
2992
+ "filteredQuery": {
2993
+ "$ref": "#/components/schemas/FilteredQuery"
2994
+ },
2995
+ "matchAllQuery": {
2996
+ "$ref": "#/components/schemas/MatchAllQuery"
2997
+ },
2998
+ "nestedQuery": {
2999
+ "$ref": "#/components/schemas/NestedQuery"
3000
+ },
3001
+ "termQuery": {
3002
+ "$ref": "#/components/schemas/TermQuery"
3003
+ },
3004
+ "textQuery": {
3005
+ "$ref": "#/components/schemas/TextQuery"
3006
+ }
3007
+ }
3008
+ },
3009
+ "BoolQuery": {
3010
+ "type": "object",
3011
+ "additionalProperties": false,
3012
+ "properties": {
3013
+ "must": {
3014
+ "type": "array",
3015
+ "items": {
3016
+ "$ref": "#/components/schemas/Query"
3017
+ }
3018
+ },
3019
+ "mustNot": {
3020
+ "type": "array",
3021
+ "items": {
3022
+ "$ref": "#/components/schemas/Query"
3023
+ }
3024
+ },
3025
+ "should": {
3026
+ "type": "array",
3027
+ "items": {
3028
+ "$ref": "#/components/schemas/Query"
3029
+ }
3030
+ }
3031
+ }
3032
+ },
3033
+ "Filter": {
3034
+ "type": "object",
3035
+ "additionalProperties": false,
3036
+ "maxProperties": 1,
3037
+ "minProperties": 1,
3038
+ "properties": {
3039
+ "boolFilter": {
3040
+ "$ref": "#/components/schemas/BoolFilter"
3041
+ },
3042
+ "queryFilter": {
3043
+ "$ref": "#/components/schemas/QueryFilter"
3044
+ },
3045
+ "range2Filter": {
3046
+ "$ref": "#/components/schemas/Range2Filter"
3047
+ },
3048
+ "rangeFilter": {
3049
+ "$ref": "#/components/schemas/RangeFilter"
3050
+ },
3051
+ "termFilter": {
3052
+ "$ref": "#/components/schemas/TermFilter"
3053
+ }
3054
+ }
3055
+ },
3056
+ "BoolFilter": {
3057
+ "type": "object",
3058
+ "additionalProperties": false,
3059
+ "properties": {
3060
+ "filters": {
3061
+ "type": "array",
3062
+ "items": {
3063
+ "$ref": "#/components/schemas/Filter"
3064
+ }
3065
+ },
3066
+ "operator": {
3067
+ "type": "string",
3068
+ "enum": [
3069
+ "and",
3070
+ "or",
3071
+ "not"
3072
+ ]
3073
+ }
3074
+ },
3075
+ "required": [
3076
+ "operator"
3077
+ ]
3078
+ },
3079
+ "QueryFilter": {
3080
+ "type": "object",
3081
+ "properties": {
3082
+ "query": {
3083
+ "$ref": "#/components/schemas/Query"
3084
+ }
3085
+ },
3086
+ "required": [
3087
+ "query"
3088
+ ]
3089
+ },
3090
+ "Field": {
3091
+ "type": "string",
3092
+ "maxLength": 260
3093
+ },
3094
+ "Range2Filter": {
3095
+ "type": "object",
3096
+ "additionalProperties": false,
3097
+ "properties": {
3098
+ "filterMode": {
3099
+ "type": "string",
3100
+ "default": "overlap",
3101
+ "enum": [
3102
+ "overlap",
3103
+ "containing",
3104
+ "contained"
3105
+ ]
3106
+ },
3107
+ "fromField": {
3108
+ "allOf": [
3109
+ {
3110
+ "$ref": "#/components/schemas/Field"
3111
+ }
3112
+ ]
3113
+ },
3114
+ "fromInclusive": {
3115
+ "type": "boolean",
3116
+ "default": true
3117
+ },
3118
+ "fromValue": {},
3119
+ "toField": {
3120
+ "allOf": [
3121
+ {
3122
+ "$ref": "#/components/schemas/Field"
3123
+ }
3124
+ ]
3125
+ },
3126
+ "toInclusive": {
3127
+ "type": "boolean",
3128
+ "default": true
3129
+ },
3130
+ "toValue": {}
3131
+ },
3132
+ "required": [
3133
+ "fromField",
3134
+ "toField"
3135
+ ]
3136
+ },
3137
+ "RangeFilter": {
3138
+ "type": "object",
3139
+ "properties": {
3140
+ "field": {
3141
+ "allOf": [
3142
+ {
3143
+ "$ref": "#/components/schemas/Field"
3144
+ }
3145
+ ]
3146
+ },
3147
+ "from": {
3148
+ "oneOf": [
3149
+ {
3150
+ "type": "string",
3151
+ "format": "date-time"
3152
+ },
3153
+ {
3154
+ "type": "integer"
3155
+ },
3156
+ {
3157
+ "type": "number"
3158
+ }
3159
+ ]
3160
+ },
3161
+ "fromInclusive": {
3162
+ "type": "boolean",
3163
+ "default": true
3164
+ },
3165
+ "to": {
3166
+ "oneOf": [
3167
+ {
3168
+ "type": "string",
3169
+ "format": "date-time"
3170
+ },
3171
+ {
3172
+ "type": "integer"
3173
+ },
3174
+ {
3175
+ "type": "number"
3176
+ }
3177
+ ]
3178
+ },
3179
+ "toInclusive": {
3180
+ "type": "boolean",
3181
+ "default": true
3182
+ }
3183
+ },
3184
+ "required": [
3185
+ "field"
3186
+ ]
3187
+ },
3188
+ "TermFilter": {
3189
+ "type": "object",
3190
+ "additionalProperties": false,
3191
+ "properties": {
3192
+ "field": {
3193
+ "allOf": [
3194
+ {
3195
+ "$ref": "#/components/schemas/Field"
3196
+ }
3197
+ ]
3198
+ },
3199
+ "operator": {
3200
+ "type": "string",
3201
+ "enum": [
3202
+ "is",
3203
+ "one_of",
3204
+ "is_null",
3205
+ "is_not_null",
3206
+ "less",
3207
+ "greater",
3208
+ "not_in",
3209
+ "neq"
3210
+ ]
3211
+ },
3212
+ "values": {
3213
+ "type": "array",
3214
+ "items": {
3215
+ "type": "string"
3216
+ }
3217
+ }
3218
+ },
3219
+ "required": [
3220
+ "field",
3221
+ "operator"
3222
+ ]
3223
+ },
3224
+ "FilteredQuery": {
3225
+ "type": "object",
3226
+ "additionalProperties": false,
3227
+ "properties": {
3228
+ "filter": {
3229
+ "$ref": "#/components/schemas/Filter"
3230
+ },
3231
+ "query": {
3232
+ "$ref": "#/components/schemas/Query"
3233
+ }
3234
+ },
3235
+ "required": [
3236
+ "filter",
3237
+ "query"
3238
+ ]
3239
+ },
3240
+ "MatchAllQuery": {
3241
+ "type": "object"
3242
+ },
3243
+ "NestedQuery": {
3244
+ "type": "object",
3245
+ "additionalProperties": false,
3246
+ "properties": {
3247
+ "path": {
3248
+ "type": "string",
3249
+ "maxLength": 2048
3250
+ },
3251
+ "query": {
3252
+ "$ref": "#/components/schemas/Query"
3253
+ },
3254
+ "scoreMode": {
3255
+ "type": "string",
3256
+ "enum": [
3257
+ "avg",
3258
+ "total",
3259
+ "max",
3260
+ "none"
3261
+ ]
3262
+ }
3263
+ },
3264
+ "required": [
3265
+ "path",
3266
+ "query"
3267
+ ]
3268
+ },
3269
+ "TermQuery": {
3270
+ "type": "object",
3271
+ "properties": {
3272
+ "fields": {
3273
+ "type": "array",
3274
+ "items": {
3275
+ "$ref": "#/components/schemas/Field"
3276
+ },
3277
+ "minItems": 1
3278
+ },
3279
+ "operator": {
3280
+ "type": "string",
3281
+ "enum": [
3282
+ "is",
3283
+ "one_of",
3284
+ "is_null",
3285
+ "is_not_null",
3286
+ "less",
3287
+ "greater",
3288
+ "not_in",
3289
+ "neq"
3290
+ ]
3291
+ },
3292
+ "values": {
3293
+ "type": "array",
3294
+ "items": {
3295
+ "oneOf": [
3296
+ {
3297
+ "type": "string"
3298
+ },
3299
+ {
3300
+ "type": "number"
3301
+ },
3302
+ {
3303
+ "type": "boolean"
3304
+ },
3305
+ {
3306
+ "type": "integer"
3307
+ }
3308
+ ]
3309
+ }
3310
+ }
3311
+ },
3312
+ "required": [
3313
+ "fields",
3314
+ "operator"
3315
+ ]
3316
+ },
3317
+ "TextQuery": {
3318
+ "type": "object",
3319
+ "additionalProperties": false,
3320
+ "properties": {
3321
+ "fields": {
3322
+ "type": "array",
3323
+ "items": {
3324
+ "$ref": "#/components/schemas/Field"
3325
+ },
3326
+ "minItems": 1
3327
+ },
3328
+ "searchPhrase": {
3329
+ "type": "string"
3330
+ }
3331
+ },
3332
+ "required": [
3333
+ "fields",
3334
+ "searchPhrase"
3335
+ ]
3336
+ },
3337
+ "Sort": {
3338
+ "type": "object",
3339
+ "additionalProperties": false,
3340
+ "properties": {
3341
+ "field": {
3342
+ "type": "string",
3343
+ "maxLength": 256
3344
+ },
3345
+ "sortOrder": {
3346
+ "type": "string",
3347
+ "default": "asc",
3348
+ "enum": [
3349
+ "asc",
3350
+ "desc"
3351
+ ]
3352
+ }
3353
+ },
3354
+ "required": [
3355
+ "field"
3356
+ ]
3357
+ },
3358
+ "SearchRequest": {
3359
+ "type": "object",
3360
+ "properties": {
3361
+ "limit": {
3362
+ "type": "integer",
3363
+ "format": "int32",
3364
+ "maximum": 200,
3365
+ "minimum": 1
3366
+ },
3367
+ "query": {
3368
+ "$ref": "#/components/schemas/Query"
3369
+ },
3370
+ "sorts": {
3371
+ "type": "array",
3372
+ "items": {
3373
+ "$ref": "#/components/schemas/Sort"
3374
+ }
3375
+ },
3376
+ "offset": {
3377
+ "$ref": "#/components/schemas/Offset"
3378
+ }
3379
+ },
3380
+ "required": [
3381
+ "query"
3382
+ ]
3383
+ },
3384
+ "SlotSearchRequest": {
3385
+ "allOf": [
3386
+ {
3387
+ "$ref": "#/components/schemas/SearchRequest"
3388
+ }
3389
+ ]
3390
+ },
3391
+ "PaginatedSearchResult": {
3392
+ "additionalProperties": false,
3393
+ "allOf": [
3394
+ {
3395
+ "$ref": "#/components/schemas/PaginatedResultBase"
3396
+ }
3397
+ ],
3398
+ "properties": {
3399
+ "query": {
3400
+ "$ref": "#/components/schemas/Query"
3401
+ },
3402
+ "sorts": {
3403
+ "type": "array",
3404
+ "items": {
3405
+ "$ref": "#/components/schemas/Sort"
3406
+ }
3407
+ },
3408
+ "hits": {
3409
+ "type": "array",
3410
+ "items": {
3411
+ "type": "object"
3412
+ }
3413
+ }
3414
+ },
3415
+ "required": [
3416
+ "query"
3417
+ ]
3418
+ },
3419
+ "SlotSearchResult": {
3420
+ "allOf": [
3421
+ {
3422
+ "$ref": "#/components/schemas/PaginatedSearchResult"
3423
+ }
3424
+ ],
3425
+ "properties": {
3426
+ "hits": {
3427
+ "type": "array",
3428
+ "items": {
3429
+ "$ref": "#/components/schemas/Slot"
3430
+ }
3431
+ }
3432
+ }
3433
+ },
3434
+ "SlotConfigurationSearchRequest": {
3435
+ "allOf": [
3436
+ {
3437
+ "$ref": "#/components/schemas/SearchRequest"
3438
+ }
3439
+ ]
3440
+ },
3441
+ "SlotConfigurationSearchResult": {
3442
+ "allOf": [
3443
+ {
3444
+ "$ref": "#/components/schemas/PaginatedSearchResult"
3445
+ }
3446
+ ],
3447
+ "properties": {
3448
+ "hits": {
3449
+ "type": "array",
3450
+ "items": {
3451
+ "$ref": "#/components/schemas/SlotConfiguration"
3452
+ }
3453
+ }
3454
+ }
3455
+ }
3456
+ },
3457
+ "parameters": {
3458
+ "organizationId": {
3459
+ "name": "organizationId",
3460
+ "in": "path",
3461
+ "required": true,
3462
+ "style": "simple",
3463
+ "explode": false,
3464
+ "schema": {
3465
+ "$ref": "#/components/schemas/OrganizationId"
3466
+ }
3467
+ },
3468
+ "pageId": {
3469
+ "name": "pageId",
3470
+ "in": "path",
3471
+ "required": true,
3472
+ "style": "simple",
3473
+ "explode": false,
3474
+ "schema": {
3475
+ "type": "string",
3476
+ "maxLength": 256
3477
+ }
3478
+ },
3479
+ "siteId": {
3480
+ "name": "siteId",
3481
+ "in": "query",
3482
+ "required": true,
3483
+ "style": "form",
3484
+ "explode": true,
3485
+ "schema": {
3486
+ "$ref": "#/components/schemas/SiteId"
3487
+ }
3488
+ },
3489
+ "libraryId": {
3490
+ "name": "libraryId",
3491
+ "in": "path",
3492
+ "required": true,
3493
+ "style": "simple",
3494
+ "explode": false,
3495
+ "schema": {
3496
+ "type": "string",
3497
+ "maxLength": 256
3498
+ }
3499
+ },
3500
+ "folderId": {
3501
+ "name": "folderId",
3502
+ "in": "path",
3503
+ "required": true,
3504
+ "style": "simple",
3505
+ "explode": false,
3506
+ "schema": {
3507
+ "type": "string",
3508
+ "maxLength": 256
3509
+ }
3510
+ },
3511
+ "contentId": {
3512
+ "name": "contentId",
3513
+ "in": "path",
3514
+ "required": true,
3515
+ "style": "simple",
3516
+ "explode": false,
3517
+ "schema": {
3518
+ "type": "string",
3519
+ "maxLength": 256
3520
+ }
3521
+ },
3522
+ "slotId": {
3523
+ "name": "slotId",
3524
+ "in": "path",
3525
+ "required": true,
3526
+ "style": "simple",
3527
+ "explode": false,
3528
+ "schema": {
3529
+ "type": "string",
3530
+ "maxLength": 256
3531
+ }
3532
+ },
3533
+ "contextType": {
3534
+ "name": "contextType",
3535
+ "in": "path",
3536
+ "required": true,
3537
+ "style": "simple",
3538
+ "explode": false,
3539
+ "schema": {
3540
+ "type": "string",
3541
+ "enum": [
3542
+ "global",
3543
+ "category",
3544
+ "folder"
3545
+ ]
3546
+ }
3547
+ },
3548
+ "select": {
3549
+ "name": "select",
3550
+ "in": "query",
3551
+ "required": false,
3552
+ "style": "form",
3553
+ "explode": true,
3554
+ "schema": {
3555
+ "$ref": "#/components/schemas/Select"
3556
+ }
3557
+ },
3558
+ "configurationId": {
3559
+ "name": "configurationId",
3560
+ "in": "path",
3561
+ "required": true,
3562
+ "style": "simple",
3563
+ "explode": false,
3564
+ "schema": {
3565
+ "type": "string",
3566
+ "maxLength": 256
3567
+ }
3568
+ },
3569
+ "context": {
3570
+ "name": "context",
3571
+ "in": "query",
3572
+ "required": false,
3573
+ "style": "form",
3574
+ "explode": true,
3575
+ "schema": {
3576
+ "type": "string",
3577
+ "enum": [
3578
+ "global",
3579
+ "category",
3580
+ "folder"
3581
+ ]
3582
+ }
3583
+ }
3584
+ },
3585
+ "securitySchemes": {
3586
+ "AmOAuth2": {
3587
+ "type": "oauth2",
3588
+ "flows": {
3589
+ "clientCredentials": {
3590
+ "tokenUrl": "https://account.demandware.com/oauth2/token",
3591
+ "scopes": {
3592
+ "sfcc.experiences": "Read-only access to merchandiser experiences",
3593
+ "sfcc.experiences.rw": "Read and write access to merchandiser experiences"
3594
+ }
3595
+ }
3596
+ }
3597
+ }
3598
+ }
3599
+ }
3600
+ }