@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,1418 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Stores",
5
+ "version": "1.2.0",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "Store"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/store/stores/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/stores": {
21
+ "get": {
22
+ "operationId": "getStores",
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": "siteId",
36
+ "in": "query",
37
+ "required": true,
38
+ "style": "form",
39
+ "explode": true,
40
+ "schema": {
41
+ "$ref": "#/components/schemas/SiteId"
42
+ }
43
+ },
44
+ {
45
+ "name": "select",
46
+ "in": "query",
47
+ "required": false,
48
+ "style": "form",
49
+ "explode": true,
50
+ "schema": {
51
+ "$ref": "#/components/schemas/Select"
52
+ }
53
+ },
54
+ {
55
+ "name": "limit",
56
+ "in": "query",
57
+ "required": false,
58
+ "style": "form",
59
+ "explode": true,
60
+ "schema": {
61
+ "type": "integer",
62
+ "format": "int32",
63
+ "default": 50,
64
+ "maximum": 200,
65
+ "minimum": 1
66
+ }
67
+ },
68
+ {
69
+ "name": "offset",
70
+ "in": "query",
71
+ "required": false,
72
+ "style": "form",
73
+ "explode": true,
74
+ "schema": {
75
+ "type": "integer",
76
+ "format": "int32",
77
+ "default": 0,
78
+ "minimum": 0
79
+ }
80
+ }
81
+ ],
82
+ "responses": {
83
+ "200": {
84
+ "description": "Returns a paginated list of stores",
85
+ "content": {
86
+ "application/json": {
87
+ "schema": {
88
+ "$ref": "#/components/schemas/StoreResult"
89
+ }
90
+ }
91
+ }
92
+ },
93
+ "401": {
94
+ "$ref": "#/components/responses/401unauthorized"
95
+ },
96
+ "403": {
97
+ "$ref": "#/components/responses/403forbidden"
98
+ }
99
+ },
100
+ "security": [
101
+ {
102
+ "AmOAuth2": [
103
+ "sfcc.stores",
104
+ "sfcc.stores.rw"
105
+ ]
106
+ }
107
+ ]
108
+ }
109
+ },
110
+ "/organizations/{organizationId}/stores/{id}": {
111
+ "get": {
112
+ "operationId": "getStore",
113
+ "parameters": [
114
+ {
115
+ "name": "organizationId",
116
+ "in": "path",
117
+ "required": true,
118
+ "style": "simple",
119
+ "explode": false,
120
+ "schema": {
121
+ "$ref": "#/components/schemas/OrganizationId"
122
+ }
123
+ },
124
+ {
125
+ "name": "siteId",
126
+ "in": "query",
127
+ "required": true,
128
+ "style": "form",
129
+ "explode": true,
130
+ "schema": {
131
+ "$ref": "#/components/schemas/SiteId"
132
+ }
133
+ },
134
+ {
135
+ "name": "id",
136
+ "in": "path",
137
+ "required": true,
138
+ "style": "simple",
139
+ "explode": false,
140
+ "schema": {
141
+ "$ref": "#/components/schemas/StoreId"
142
+ }
143
+ },
144
+ {
145
+ "name": "select",
146
+ "in": "query",
147
+ "required": false,
148
+ "style": "form",
149
+ "explode": true,
150
+ "schema": {
151
+ "$ref": "#/components/schemas/Select"
152
+ }
153
+ }
154
+ ],
155
+ "responses": {
156
+ "200": {
157
+ "description": "Returns the store document",
158
+ "content": {
159
+ "application/json": {
160
+ "schema": {
161
+ "$ref": "#/components/schemas/Store"
162
+ }
163
+ }
164
+ }
165
+ },
166
+ "401": {
167
+ "$ref": "#/components/responses/401unauthorized"
168
+ },
169
+ "403": {
170
+ "$ref": "#/components/responses/403forbidden"
171
+ },
172
+ "404": {
173
+ "description": "Store Not Found",
174
+ "content": {
175
+ "application/problem+json": {
176
+ "schema": {
177
+ "$ref": "#/components/schemas/ErrorResponse"
178
+ }
179
+ }
180
+ }
181
+ }
182
+ },
183
+ "security": [
184
+ {
185
+ "AmOAuth2": [
186
+ "sfcc.stores",
187
+ "sfcc.stores.rw"
188
+ ]
189
+ }
190
+ ]
191
+ },
192
+ "put": {
193
+ "operationId": "createOrReplaceStore",
194
+ "parameters": [
195
+ {
196
+ "name": "organizationId",
197
+ "in": "path",
198
+ "required": true,
199
+ "style": "simple",
200
+ "explode": false,
201
+ "schema": {
202
+ "$ref": "#/components/schemas/OrganizationId"
203
+ }
204
+ },
205
+ {
206
+ "name": "siteId",
207
+ "in": "query",
208
+ "required": true,
209
+ "style": "form",
210
+ "explode": true,
211
+ "schema": {
212
+ "$ref": "#/components/schemas/SiteId"
213
+ }
214
+ },
215
+ {
216
+ "name": "id",
217
+ "in": "path",
218
+ "required": true,
219
+ "style": "simple",
220
+ "explode": false,
221
+ "schema": {
222
+ "$ref": "#/components/schemas/StoreId"
223
+ }
224
+ }
225
+ ],
226
+ "requestBody": {
227
+ "content": {
228
+ "application/json": {
229
+ "schema": {
230
+ "$ref": "#/components/schemas/StoreRequest"
231
+ }
232
+ }
233
+ },
234
+ "required": true
235
+ },
236
+ "responses": {
237
+ "200": {
238
+ "description": "Returns the replaced store document.",
239
+ "content": {
240
+ "application/json": {
241
+ "schema": {
242
+ "$ref": "#/components/schemas/Store"
243
+ }
244
+ }
245
+ }
246
+ },
247
+ "201": {
248
+ "description": "Returns the newly created store document.",
249
+ "content": {
250
+ "application/json": {
251
+ "schema": {
252
+ "$ref": "#/components/schemas/Store"
253
+ }
254
+ }
255
+ }
256
+ },
257
+ "400": {
258
+ "description": "Bad Request",
259
+ "content": {
260
+ "application/problem+json": {
261
+ "schema": {
262
+ "$ref": "#/components/schemas/ErrorResponse"
263
+ }
264
+ }
265
+ }
266
+ },
267
+ "401": {
268
+ "$ref": "#/components/responses/401unauthorized"
269
+ },
270
+ "403": {
271
+ "$ref": "#/components/responses/403forbidden"
272
+ }
273
+ },
274
+ "security": [
275
+ {
276
+ "AmOAuth2": [
277
+ "sfcc.stores.rw"
278
+ ]
279
+ }
280
+ ]
281
+ },
282
+ "delete": {
283
+ "operationId": "deleteStore",
284
+ "parameters": [
285
+ {
286
+ "name": "organizationId",
287
+ "in": "path",
288
+ "required": true,
289
+ "style": "simple",
290
+ "explode": false,
291
+ "schema": {
292
+ "$ref": "#/components/schemas/OrganizationId"
293
+ }
294
+ },
295
+ {
296
+ "name": "siteId",
297
+ "in": "query",
298
+ "required": true,
299
+ "style": "form",
300
+ "explode": true,
301
+ "schema": {
302
+ "$ref": "#/components/schemas/SiteId"
303
+ }
304
+ },
305
+ {
306
+ "name": "id",
307
+ "in": "path",
308
+ "required": true,
309
+ "style": "simple",
310
+ "explode": false,
311
+ "schema": {
312
+ "$ref": "#/components/schemas/StoreId"
313
+ }
314
+ }
315
+ ],
316
+ "responses": {
317
+ "204": {
318
+ "description": "Store successfully deleted. No content returned."
319
+ },
320
+ "401": {
321
+ "$ref": "#/components/responses/401unauthorized"
322
+ },
323
+ "403": {
324
+ "$ref": "#/components/responses/403forbidden"
325
+ },
326
+ "404": {
327
+ "description": "Store Not Found",
328
+ "content": {
329
+ "application/problem+json": {
330
+ "schema": {
331
+ "$ref": "#/components/schemas/ErrorResponse"
332
+ }
333
+ }
334
+ }
335
+ }
336
+ },
337
+ "security": [
338
+ {
339
+ "AmOAuth2": [
340
+ "sfcc.stores.rw"
341
+ ]
342
+ }
343
+ ]
344
+ },
345
+ "patch": {
346
+ "operationId": "updateStore",
347
+ "parameters": [
348
+ {
349
+ "name": "organizationId",
350
+ "in": "path",
351
+ "required": true,
352
+ "style": "simple",
353
+ "explode": false,
354
+ "schema": {
355
+ "$ref": "#/components/schemas/OrganizationId"
356
+ }
357
+ },
358
+ {
359
+ "name": "siteId",
360
+ "in": "query",
361
+ "required": true,
362
+ "style": "form",
363
+ "explode": true,
364
+ "schema": {
365
+ "$ref": "#/components/schemas/SiteId"
366
+ }
367
+ },
368
+ {
369
+ "name": "id",
370
+ "in": "path",
371
+ "required": true,
372
+ "style": "simple",
373
+ "explode": false,
374
+ "schema": {
375
+ "$ref": "#/components/schemas/StoreId"
376
+ }
377
+ }
378
+ ],
379
+ "requestBody": {
380
+ "content": {
381
+ "application/json": {
382
+ "schema": {
383
+ "$ref": "#/components/schemas/StoreRequest"
384
+ }
385
+ }
386
+ },
387
+ "required": true
388
+ },
389
+ "responses": {
390
+ "200": {
391
+ "description": "Returns the updated store document.",
392
+ "content": {
393
+ "application/json": {
394
+ "schema": {
395
+ "$ref": "#/components/schemas/Store"
396
+ }
397
+ }
398
+ }
399
+ },
400
+ "400": {
401
+ "description": "Bad Request",
402
+ "content": {
403
+ "application/problem+json": {
404
+ "schema": {
405
+ "$ref": "#/components/schemas/ErrorResponse"
406
+ }
407
+ }
408
+ }
409
+ },
410
+ "401": {
411
+ "$ref": "#/components/responses/401unauthorized"
412
+ },
413
+ "403": {
414
+ "$ref": "#/components/responses/403forbidden"
415
+ },
416
+ "404": {
417
+ "description": "Store Not Found",
418
+ "content": {
419
+ "application/problem+json": {
420
+ "schema": {
421
+ "$ref": "#/components/schemas/ErrorResponse"
422
+ }
423
+ }
424
+ }
425
+ }
426
+ },
427
+ "security": [
428
+ {
429
+ "AmOAuth2": [
430
+ "sfcc.stores.rw"
431
+ ]
432
+ }
433
+ ]
434
+ }
435
+ },
436
+ "/organizations/{organizationId}/store-search": {
437
+ "post": {
438
+ "operationId": "searchStores",
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": "siteId",
452
+ "in": "query",
453
+ "required": true,
454
+ "style": "form",
455
+ "explode": true,
456
+ "schema": {
457
+ "$ref": "#/components/schemas/SiteId"
458
+ }
459
+ }
460
+ ],
461
+ "requestBody": {
462
+ "content": {
463
+ "application/json": {
464
+ "schema": {
465
+ "$ref": "#/components/schemas/StoreSearchRequest"
466
+ }
467
+ }
468
+ },
469
+ "required": true
470
+ },
471
+ "responses": {
472
+ "200": {
473
+ "description": "Returns store search results",
474
+ "content": {
475
+ "application/json": {
476
+ "schema": {
477
+ "$ref": "#/components/schemas/StoreSearchResult"
478
+ }
479
+ }
480
+ }
481
+ },
482
+ "400": {
483
+ "description": "Bad Request",
484
+ "content": {
485
+ "application/problem+json": {
486
+ "schema": {
487
+ "$ref": "#/components/schemas/ErrorResponse"
488
+ }
489
+ }
490
+ }
491
+ },
492
+ "401": {
493
+ "$ref": "#/components/responses/401unauthorized"
494
+ },
495
+ "403": {
496
+ "$ref": "#/components/responses/403forbidden"
497
+ }
498
+ },
499
+ "security": [
500
+ {
501
+ "AmOAuth2": [
502
+ "sfcc.stores",
503
+ "sfcc.stores.rw"
504
+ ]
505
+ }
506
+ ]
507
+ }
508
+ }
509
+ },
510
+ "components": {
511
+ "schemas": {
512
+ "OrganizationId": {
513
+ "type": "string",
514
+ "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
515
+ },
516
+ "SiteId": {
517
+ "type": "string",
518
+ "maxLength": 32,
519
+ "minLength": 1
520
+ },
521
+ "Select": {
522
+ "type": "string",
523
+ "minLength": 1,
524
+ "pattern": "^[(].*[)]$"
525
+ },
526
+ "Total": {
527
+ "type": "integer",
528
+ "format": "int32",
529
+ "default": 0,
530
+ "minimum": 0
531
+ },
532
+ "ResultBase": {
533
+ "type": "object",
534
+ "properties": {
535
+ "limit": {
536
+ "type": "integer",
537
+ "format": "int32"
538
+ },
539
+ "total": {
540
+ "$ref": "#/components/schemas/Total"
541
+ }
542
+ },
543
+ "required": [
544
+ "limit",
545
+ "total"
546
+ ]
547
+ },
548
+ "Offset": {
549
+ "type": "integer",
550
+ "format": "int32",
551
+ "default": 0,
552
+ "minimum": 0
553
+ },
554
+ "PaginatedResultBase": {
555
+ "allOf": [
556
+ {
557
+ "$ref": "#/components/schemas/ResultBase"
558
+ }
559
+ ],
560
+ "properties": {
561
+ "offset": {
562
+ "$ref": "#/components/schemas/Offset"
563
+ }
564
+ },
565
+ "required": [
566
+ "limit",
567
+ "offset",
568
+ "total"
569
+ ]
570
+ },
571
+ "StoreId": {
572
+ "type": "string",
573
+ "maxLength": 256,
574
+ "minLength": 1
575
+ },
576
+ "CountryCode": {
577
+ "type": "string",
578
+ "pattern": "^[A-Z][A-Z]$"
579
+ },
580
+ "InventoryId": {
581
+ "type": "string",
582
+ "maxLength": 256,
583
+ "minLength": 1
584
+ },
585
+ "MarkupText": {
586
+ "type": "object",
587
+ "properties": {
588
+ "markup": {
589
+ "type": "string"
590
+ },
591
+ "source": {
592
+ "type": "string"
593
+ }
594
+ },
595
+ "required": [
596
+ "markup",
597
+ "source"
598
+ ]
599
+ },
600
+ "Email": {
601
+ "type": "string",
602
+ "format": "email",
603
+ "maxLength": 256
604
+ },
605
+ "MediaFile": {
606
+ "type": "object",
607
+ "properties": {
608
+ "absUrl": {
609
+ "type": "string"
610
+ },
611
+ "alt": {
612
+ "type": "object",
613
+ "additionalProperties": {
614
+ "type": "string"
615
+ }
616
+ },
617
+ "disBaseUrl": {
618
+ "type": "string"
619
+ },
620
+ "path": {
621
+ "type": "string"
622
+ },
623
+ "title": {
624
+ "type": "object",
625
+ "additionalProperties": {
626
+ "type": "string"
627
+ }
628
+ }
629
+ },
630
+ "required": [
631
+ "path"
632
+ ]
633
+ },
634
+ "Store": {
635
+ "type": "object",
636
+ "additionalProperties": {},
637
+ "properties": {
638
+ "id": {
639
+ "allOf": [
640
+ {
641
+ "$ref": "#/components/schemas/StoreId"
642
+ }
643
+ ]
644
+ },
645
+ "name": {
646
+ "type": "string",
647
+ "maxLength": 256
648
+ },
649
+ "address1": {
650
+ "type": "string",
651
+ "maxLength": 256
652
+ },
653
+ "address2": {
654
+ "type": "string",
655
+ "maxLength": 256
656
+ },
657
+ "city": {
658
+ "type": "string",
659
+ "maxLength": 256
660
+ },
661
+ "countryCode": {
662
+ "$ref": "#/components/schemas/CountryCode"
663
+ },
664
+ "phone": {
665
+ "type": "string",
666
+ "maxLength": 256
667
+ },
668
+ "postalCode": {
669
+ "type": "string",
670
+ "maxLength": 10
671
+ },
672
+ "stateCode": {
673
+ "type": "string",
674
+ "maxLength": 256
675
+ },
676
+ "fax": {
677
+ "type": "string",
678
+ "maxLength": 256
679
+ },
680
+ "longitude": {
681
+ "type": "number",
682
+ "format": "double",
683
+ "maximum": 180,
684
+ "minimum": -180
685
+ },
686
+ "latitude": {
687
+ "type": "number",
688
+ "format": "double",
689
+ "maximum": 90,
690
+ "minimum": -90
691
+ },
692
+ "inventoryId": {
693
+ "allOf": [
694
+ {
695
+ "$ref": "#/components/schemas/InventoryId"
696
+ }
697
+ ]
698
+ },
699
+ "storeHours": {
700
+ "type": "object",
701
+ "additionalProperties": {
702
+ "$ref": "#/components/schemas/MarkupText"
703
+ }
704
+ },
705
+ "storeEvents": {
706
+ "type": "object",
707
+ "additionalProperties": {
708
+ "$ref": "#/components/schemas/MarkupText"
709
+ }
710
+ },
711
+ "email": {
712
+ "allOf": [
713
+ {
714
+ "$ref": "#/components/schemas/Email"
715
+ }
716
+ ]
717
+ },
718
+ "image": {
719
+ "allOf": [
720
+ {
721
+ "$ref": "#/components/schemas/MediaFile"
722
+ }
723
+ ]
724
+ },
725
+ "storeLocatorEnabled": {
726
+ "type": "boolean"
727
+ },
728
+ "posEnabled": {
729
+ "type": "boolean"
730
+ },
731
+ "creationDate": {
732
+ "type": "string",
733
+ "format": "date-time",
734
+ "readOnly": true
735
+ },
736
+ "lastModified": {
737
+ "type": "string",
738
+ "format": "date-time",
739
+ "readOnly": true
740
+ }
741
+ },
742
+ "required": [
743
+ "id"
744
+ ]
745
+ },
746
+ "StoreResult": {
747
+ "allOf": [
748
+ {
749
+ "$ref": "#/components/schemas/PaginatedResultBase"
750
+ }
751
+ ],
752
+ "properties": {
753
+ "data": {
754
+ "type": "array",
755
+ "items": {
756
+ "$ref": "#/components/schemas/Store"
757
+ }
758
+ }
759
+ },
760
+ "required": [
761
+ "data"
762
+ ]
763
+ },
764
+ "ErrorResponse": {
765
+ "type": "object",
766
+ "additionalProperties": true,
767
+ "properties": {
768
+ "title": {
769
+ "type": "string",
770
+ "maxLength": 256
771
+ },
772
+ "type": {
773
+ "type": "string",
774
+ "maxLength": 2048
775
+ },
776
+ "detail": {
777
+ "type": "string"
778
+ },
779
+ "instance": {
780
+ "type": "string",
781
+ "maxLength": 2048
782
+ }
783
+ },
784
+ "required": [
785
+ "detail",
786
+ "title",
787
+ "type"
788
+ ]
789
+ },
790
+ "StoreRequest": {
791
+ "type": "object",
792
+ "additionalProperties": {},
793
+ "properties": {
794
+ "id": {
795
+ "allOf": [
796
+ {
797
+ "$ref": "#/components/schemas/StoreId"
798
+ }
799
+ ]
800
+ },
801
+ "name": {
802
+ "type": "string",
803
+ "maxLength": 256
804
+ },
805
+ "address1": {
806
+ "type": "string",
807
+ "maxLength": 256
808
+ },
809
+ "address2": {
810
+ "type": "string",
811
+ "maxLength": 256
812
+ },
813
+ "city": {
814
+ "type": "string",
815
+ "maxLength": 256
816
+ },
817
+ "countryCode": {
818
+ "$ref": "#/components/schemas/CountryCode"
819
+ },
820
+ "phone": {
821
+ "type": "string",
822
+ "maxLength": 256
823
+ },
824
+ "postalCode": {
825
+ "type": "string",
826
+ "maxLength": 10
827
+ },
828
+ "stateCode": {
829
+ "type": "string",
830
+ "maxLength": 256
831
+ },
832
+ "fax": {
833
+ "type": "string",
834
+ "maxLength": 256
835
+ },
836
+ "longitude": {
837
+ "type": "number",
838
+ "format": "double",
839
+ "maximum": 180,
840
+ "minimum": -180
841
+ },
842
+ "latitude": {
843
+ "type": "number",
844
+ "format": "double",
845
+ "maximum": 90,
846
+ "minimum": -90
847
+ },
848
+ "inventoryId": {
849
+ "allOf": [
850
+ {
851
+ "$ref": "#/components/schemas/InventoryId"
852
+ }
853
+ ]
854
+ },
855
+ "storeHours": {
856
+ "type": "object",
857
+ "additionalProperties": {
858
+ "$ref": "#/components/schemas/MarkupText"
859
+ }
860
+ },
861
+ "storeEvents": {
862
+ "type": "object",
863
+ "additionalProperties": {
864
+ "$ref": "#/components/schemas/MarkupText"
865
+ }
866
+ },
867
+ "email": {
868
+ "allOf": [
869
+ {
870
+ "$ref": "#/components/schemas/Email"
871
+ }
872
+ ]
873
+ },
874
+ "image": {
875
+ "allOf": [
876
+ {
877
+ "$ref": "#/components/schemas/MediaFile"
878
+ }
879
+ ]
880
+ },
881
+ "storeLocatorEnabled": {
882
+ "type": "boolean"
883
+ },
884
+ "posEnabled": {
885
+ "type": "boolean"
886
+ }
887
+ },
888
+ "required": [
889
+ "id"
890
+ ]
891
+ },
892
+ "Query": {
893
+ "type": "object",
894
+ "additionalProperties": false,
895
+ "maxProperties": 1,
896
+ "minProperties": 1,
897
+ "properties": {
898
+ "boolQuery": {
899
+ "$ref": "#/components/schemas/BoolQuery"
900
+ },
901
+ "filteredQuery": {
902
+ "$ref": "#/components/schemas/FilteredQuery"
903
+ },
904
+ "matchAllQuery": {
905
+ "$ref": "#/components/schemas/MatchAllQuery"
906
+ },
907
+ "nestedQuery": {
908
+ "$ref": "#/components/schemas/NestedQuery"
909
+ },
910
+ "termQuery": {
911
+ "$ref": "#/components/schemas/TermQuery"
912
+ },
913
+ "textQuery": {
914
+ "$ref": "#/components/schemas/TextQuery"
915
+ }
916
+ }
917
+ },
918
+ "BoolQuery": {
919
+ "type": "object",
920
+ "additionalProperties": false,
921
+ "properties": {
922
+ "must": {
923
+ "type": "array",
924
+ "items": {
925
+ "$ref": "#/components/schemas/Query"
926
+ }
927
+ },
928
+ "mustNot": {
929
+ "type": "array",
930
+ "items": {
931
+ "$ref": "#/components/schemas/Query"
932
+ }
933
+ },
934
+ "should": {
935
+ "type": "array",
936
+ "items": {
937
+ "$ref": "#/components/schemas/Query"
938
+ }
939
+ }
940
+ }
941
+ },
942
+ "Filter": {
943
+ "type": "object",
944
+ "additionalProperties": false,
945
+ "maxProperties": 1,
946
+ "minProperties": 1,
947
+ "properties": {
948
+ "boolFilter": {
949
+ "$ref": "#/components/schemas/BoolFilter"
950
+ },
951
+ "queryFilter": {
952
+ "$ref": "#/components/schemas/QueryFilter"
953
+ },
954
+ "range2Filter": {
955
+ "$ref": "#/components/schemas/Range2Filter"
956
+ },
957
+ "rangeFilter": {
958
+ "$ref": "#/components/schemas/RangeFilter"
959
+ },
960
+ "termFilter": {
961
+ "$ref": "#/components/schemas/TermFilter"
962
+ }
963
+ }
964
+ },
965
+ "BoolFilter": {
966
+ "type": "object",
967
+ "additionalProperties": false,
968
+ "properties": {
969
+ "filters": {
970
+ "type": "array",
971
+ "items": {
972
+ "$ref": "#/components/schemas/Filter"
973
+ }
974
+ },
975
+ "operator": {
976
+ "type": "string",
977
+ "enum": [
978
+ "and",
979
+ "or",
980
+ "not"
981
+ ]
982
+ }
983
+ },
984
+ "required": [
985
+ "operator"
986
+ ]
987
+ },
988
+ "QueryFilter": {
989
+ "type": "object",
990
+ "properties": {
991
+ "query": {
992
+ "$ref": "#/components/schemas/Query"
993
+ }
994
+ },
995
+ "required": [
996
+ "query"
997
+ ]
998
+ },
999
+ "Field": {
1000
+ "type": "string",
1001
+ "maxLength": 260
1002
+ },
1003
+ "Range2Filter": {
1004
+ "type": "object",
1005
+ "additionalProperties": false,
1006
+ "properties": {
1007
+ "filterMode": {
1008
+ "type": "string",
1009
+ "default": "overlap",
1010
+ "enum": [
1011
+ "overlap",
1012
+ "containing",
1013
+ "contained"
1014
+ ]
1015
+ },
1016
+ "fromField": {
1017
+ "allOf": [
1018
+ {
1019
+ "$ref": "#/components/schemas/Field"
1020
+ }
1021
+ ]
1022
+ },
1023
+ "fromInclusive": {
1024
+ "type": "boolean",
1025
+ "default": true
1026
+ },
1027
+ "fromValue": {},
1028
+ "toField": {
1029
+ "allOf": [
1030
+ {
1031
+ "$ref": "#/components/schemas/Field"
1032
+ }
1033
+ ]
1034
+ },
1035
+ "toInclusive": {
1036
+ "type": "boolean",
1037
+ "default": true
1038
+ },
1039
+ "toValue": {}
1040
+ },
1041
+ "required": [
1042
+ "fromField",
1043
+ "toField"
1044
+ ]
1045
+ },
1046
+ "RangeFilter": {
1047
+ "type": "object",
1048
+ "properties": {
1049
+ "field": {
1050
+ "allOf": [
1051
+ {
1052
+ "$ref": "#/components/schemas/Field"
1053
+ }
1054
+ ]
1055
+ },
1056
+ "from": {
1057
+ "oneOf": [
1058
+ {
1059
+ "type": "string",
1060
+ "format": "date-time"
1061
+ },
1062
+ {
1063
+ "type": "integer"
1064
+ },
1065
+ {
1066
+ "type": "number"
1067
+ }
1068
+ ]
1069
+ },
1070
+ "fromInclusive": {
1071
+ "type": "boolean",
1072
+ "default": true
1073
+ },
1074
+ "to": {
1075
+ "oneOf": [
1076
+ {
1077
+ "type": "string",
1078
+ "format": "date-time"
1079
+ },
1080
+ {
1081
+ "type": "integer"
1082
+ },
1083
+ {
1084
+ "type": "number"
1085
+ }
1086
+ ]
1087
+ },
1088
+ "toInclusive": {
1089
+ "type": "boolean",
1090
+ "default": true
1091
+ }
1092
+ },
1093
+ "required": [
1094
+ "field"
1095
+ ]
1096
+ },
1097
+ "TermFilter": {
1098
+ "type": "object",
1099
+ "additionalProperties": false,
1100
+ "properties": {
1101
+ "field": {
1102
+ "allOf": [
1103
+ {
1104
+ "$ref": "#/components/schemas/Field"
1105
+ }
1106
+ ]
1107
+ },
1108
+ "operator": {
1109
+ "type": "string",
1110
+ "enum": [
1111
+ "is",
1112
+ "one_of",
1113
+ "is_null",
1114
+ "is_not_null",
1115
+ "less",
1116
+ "greater",
1117
+ "not_in",
1118
+ "neq"
1119
+ ]
1120
+ },
1121
+ "values": {
1122
+ "type": "array",
1123
+ "items": {
1124
+ "type": "string"
1125
+ }
1126
+ }
1127
+ },
1128
+ "required": [
1129
+ "field",
1130
+ "operator"
1131
+ ]
1132
+ },
1133
+ "FilteredQuery": {
1134
+ "type": "object",
1135
+ "additionalProperties": false,
1136
+ "properties": {
1137
+ "filter": {
1138
+ "$ref": "#/components/schemas/Filter"
1139
+ },
1140
+ "query": {
1141
+ "$ref": "#/components/schemas/Query"
1142
+ }
1143
+ },
1144
+ "required": [
1145
+ "filter",
1146
+ "query"
1147
+ ]
1148
+ },
1149
+ "MatchAllQuery": {
1150
+ "type": "object"
1151
+ },
1152
+ "NestedQuery": {
1153
+ "type": "object",
1154
+ "additionalProperties": false,
1155
+ "properties": {
1156
+ "path": {
1157
+ "type": "string",
1158
+ "maxLength": 2048
1159
+ },
1160
+ "query": {
1161
+ "$ref": "#/components/schemas/Query"
1162
+ },
1163
+ "scoreMode": {
1164
+ "type": "string",
1165
+ "enum": [
1166
+ "avg",
1167
+ "total",
1168
+ "max",
1169
+ "none"
1170
+ ]
1171
+ }
1172
+ },
1173
+ "required": [
1174
+ "path",
1175
+ "query"
1176
+ ]
1177
+ },
1178
+ "TermQuery": {
1179
+ "type": "object",
1180
+ "properties": {
1181
+ "fields": {
1182
+ "type": "array",
1183
+ "items": {
1184
+ "$ref": "#/components/schemas/Field"
1185
+ },
1186
+ "minItems": 1
1187
+ },
1188
+ "operator": {
1189
+ "type": "string",
1190
+ "enum": [
1191
+ "is",
1192
+ "one_of",
1193
+ "is_null",
1194
+ "is_not_null",
1195
+ "less",
1196
+ "greater",
1197
+ "not_in",
1198
+ "neq"
1199
+ ]
1200
+ },
1201
+ "values": {
1202
+ "type": "array",
1203
+ "items": {
1204
+ "oneOf": [
1205
+ {
1206
+ "type": "string"
1207
+ },
1208
+ {
1209
+ "type": "number"
1210
+ },
1211
+ {
1212
+ "type": "boolean"
1213
+ },
1214
+ {
1215
+ "type": "integer"
1216
+ }
1217
+ ]
1218
+ }
1219
+ }
1220
+ },
1221
+ "required": [
1222
+ "fields",
1223
+ "operator"
1224
+ ]
1225
+ },
1226
+ "TextQuery": {
1227
+ "type": "object",
1228
+ "additionalProperties": false,
1229
+ "properties": {
1230
+ "fields": {
1231
+ "type": "array",
1232
+ "items": {
1233
+ "$ref": "#/components/schemas/Field"
1234
+ },
1235
+ "minItems": 1
1236
+ },
1237
+ "searchPhrase": {
1238
+ "type": "string"
1239
+ }
1240
+ },
1241
+ "required": [
1242
+ "fields",
1243
+ "searchPhrase"
1244
+ ]
1245
+ },
1246
+ "Sort": {
1247
+ "type": "object",
1248
+ "additionalProperties": false,
1249
+ "properties": {
1250
+ "field": {
1251
+ "type": "string",
1252
+ "maxLength": 256
1253
+ },
1254
+ "sortOrder": {
1255
+ "type": "string",
1256
+ "default": "asc",
1257
+ "enum": [
1258
+ "asc",
1259
+ "desc"
1260
+ ]
1261
+ }
1262
+ },
1263
+ "required": [
1264
+ "field"
1265
+ ]
1266
+ },
1267
+ "SearchRequest": {
1268
+ "type": "object",
1269
+ "properties": {
1270
+ "limit": {
1271
+ "type": "integer",
1272
+ "format": "int32",
1273
+ "maximum": 200,
1274
+ "minimum": 1
1275
+ },
1276
+ "query": {
1277
+ "$ref": "#/components/schemas/Query"
1278
+ },
1279
+ "sorts": {
1280
+ "type": "array",
1281
+ "items": {
1282
+ "$ref": "#/components/schemas/Sort"
1283
+ }
1284
+ },
1285
+ "offset": {
1286
+ "$ref": "#/components/schemas/Offset"
1287
+ }
1288
+ },
1289
+ "required": [
1290
+ "query"
1291
+ ]
1292
+ },
1293
+ "StoreSearchRequest": {
1294
+ "additionalProperties": false,
1295
+ "allOf": [
1296
+ {
1297
+ "$ref": "#/components/schemas/SearchRequest"
1298
+ }
1299
+ ]
1300
+ },
1301
+ "PaginatedSearchResult": {
1302
+ "additionalProperties": false,
1303
+ "allOf": [
1304
+ {
1305
+ "$ref": "#/components/schemas/PaginatedResultBase"
1306
+ }
1307
+ ],
1308
+ "properties": {
1309
+ "query": {
1310
+ "$ref": "#/components/schemas/Query"
1311
+ },
1312
+ "sorts": {
1313
+ "type": "array",
1314
+ "items": {
1315
+ "$ref": "#/components/schemas/Sort"
1316
+ }
1317
+ },
1318
+ "hits": {
1319
+ "type": "array",
1320
+ "items": {
1321
+ "type": "object"
1322
+ }
1323
+ }
1324
+ },
1325
+ "required": [
1326
+ "query"
1327
+ ]
1328
+ },
1329
+ "StoreSearchResult": {
1330
+ "allOf": [
1331
+ {
1332
+ "$ref": "#/components/schemas/PaginatedSearchResult"
1333
+ }
1334
+ ],
1335
+ "properties": {
1336
+ "hits": {
1337
+ "type": "array",
1338
+ "items": {
1339
+ "$ref": "#/components/schemas/Store"
1340
+ }
1341
+ }
1342
+ },
1343
+ "required": [
1344
+ "hits",
1345
+ "query"
1346
+ ]
1347
+ }
1348
+ },
1349
+ "responses": {
1350
+ "401unauthorized": {
1351
+ "description": "Your access token is invalid or expired and can’t be used to identify a user.",
1352
+ "content": {
1353
+ "application/problem+json": {
1354
+ "schema": {
1355
+ "$ref": "#/components/schemas/ErrorResponse"
1356
+ }
1357
+ }
1358
+ }
1359
+ },
1360
+ "403forbidden": {
1361
+ "description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
1362
+ "content": {
1363
+ "application/problem+json": {
1364
+ "schema": {
1365
+ "$ref": "#/components/schemas/ErrorResponse"
1366
+ }
1367
+ }
1368
+ }
1369
+ }
1370
+ },
1371
+ "parameters": {
1372
+ "organizationId": {
1373
+ "name": "organizationId",
1374
+ "in": "path",
1375
+ "required": true,
1376
+ "style": "simple",
1377
+ "explode": false,
1378
+ "schema": {
1379
+ "$ref": "#/components/schemas/OrganizationId"
1380
+ }
1381
+ },
1382
+ "siteId": {
1383
+ "name": "siteId",
1384
+ "in": "query",
1385
+ "required": true,
1386
+ "style": "form",
1387
+ "explode": true,
1388
+ "schema": {
1389
+ "$ref": "#/components/schemas/SiteId"
1390
+ }
1391
+ },
1392
+ "select": {
1393
+ "name": "select",
1394
+ "in": "query",
1395
+ "required": false,
1396
+ "style": "form",
1397
+ "explode": true,
1398
+ "schema": {
1399
+ "$ref": "#/components/schemas/Select"
1400
+ }
1401
+ }
1402
+ },
1403
+ "securitySchemes": {
1404
+ "AmOAuth2": {
1405
+ "type": "oauth2",
1406
+ "flows": {
1407
+ "clientCredentials": {
1408
+ "tokenUrl": "https://account.demandware.com/dw/oauth2/access_token",
1409
+ "scopes": {
1410
+ "sfcc.stores": "Read access to store resources",
1411
+ "sfcc.stores.rw": "Read and write access to store resources"
1412
+ }
1413
+ }
1414
+ }
1415
+ }
1416
+ }
1417
+ }
1418
+ }