@salesforce/b2c-tooling-sdk 1.24.2 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (482) 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 +83 -119
  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 +10 -1
  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 +154 -9
  55. package/dist/esm/cli/mrt-command.js +299 -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 +2 -0
  61. package/dist/esm/cli/webdav-command.js +1 -0
  62. package/dist/esm/cli/webdav-command.js.map +1 -1
  63. package/dist/esm/clients/cdn-zones.js +2 -5
  64. package/dist/esm/clients/cdn-zones.js.map +1 -1
  65. package/dist/esm/clients/cip.d.ts +12 -3
  66. package/dist/esm/clients/cip.js +85 -30
  67. package/dist/esm/clients/cip.js.map +1 -1
  68. package/dist/esm/clients/custom-apis.js +2 -5
  69. package/dist/esm/clients/custom-apis.js.map +1 -1
  70. package/dist/esm/clients/dual-backend-factory.d.ts +70 -0
  71. package/dist/esm/clients/dual-backend-factory.js +48 -0
  72. package/dist/esm/clients/dual-backend-factory.js.map +1 -0
  73. package/dist/esm/clients/error-utils.d.ts +62 -0
  74. package/dist/esm/clients/error-utils.js +98 -0
  75. package/dist/esm/clients/error-utils.js.map +1 -1
  76. package/dist/esm/clients/granular-replications.js +2 -5
  77. package/dist/esm/clients/granular-replications.js.map +1 -1
  78. package/dist/esm/clients/index.d.ts +30 -3
  79. package/dist/esm/clients/index.js +25 -2
  80. package/dist/esm/clients/index.js.map +1 -1
  81. package/dist/esm/clients/metrics.js +2 -5
  82. package/dist/esm/clients/metrics.js.map +1 -1
  83. package/dist/esm/clients/middleware-registry.d.ts +4 -2
  84. package/dist/esm/clients/middleware-registry.js +3 -1
  85. package/dist/esm/clients/middleware-registry.js.map +1 -1
  86. package/dist/esm/clients/middleware.d.ts +39 -0
  87. package/dist/esm/clients/middleware.js +126 -25
  88. package/dist/esm/clients/middleware.js.map +1 -1
  89. package/dist/esm/clients/mrt-b2c.js +3 -0
  90. package/dist/esm/clients/mrt-b2c.js.map +1 -1
  91. package/dist/esm/clients/mrt.d.ts +27 -10
  92. package/dist/esm/clients/mrt.generated.d.ts +77 -0
  93. package/dist/esm/clients/mrt.js +68 -0
  94. package/dist/esm/clients/mrt.js.map +1 -1
  95. package/dist/esm/clients/preferences.js +2 -5
  96. package/dist/esm/clients/preferences.js.map +1 -1
  97. package/dist/esm/clients/scapi-backend-utils.d.ts +163 -0
  98. package/dist/esm/clients/scapi-backend-utils.js +180 -0
  99. package/dist/esm/clients/scapi-backend-utils.js.map +1 -0
  100. package/dist/esm/clients/scapi-catalogs.d.ts +12 -0
  101. package/dist/esm/clients/scapi-catalogs.generated.d.ts +104 -0
  102. package/dist/esm/clients/scapi-catalogs.generated.js +6 -0
  103. package/dist/esm/clients/scapi-catalogs.generated.js.map +1 -0
  104. package/dist/esm/clients/scapi-catalogs.js +14 -0
  105. package/dist/esm/clients/scapi-catalogs.js.map +1 -0
  106. package/dist/esm/clients/scapi-client-factory.d.ts +81 -0
  107. package/dist/esm/clients/scapi-client-factory.js +84 -0
  108. package/dist/esm/clients/scapi-client-factory.js.map +1 -0
  109. package/dist/esm/clients/scapi-fallback-backend.d.ts +34 -0
  110. package/dist/esm/clients/scapi-fallback-backend.js +132 -0
  111. package/dist/esm/clients/scapi-fallback-backend.js.map +1 -0
  112. package/dist/esm/clients/scapi-jobs.d.ts +32 -0
  113. package/dist/esm/clients/scapi-jobs.generated.d.ts +535 -0
  114. package/dist/esm/clients/scapi-jobs.generated.js +6 -0
  115. package/dist/esm/clients/scapi-jobs.generated.js.map +1 -0
  116. package/dist/esm/clients/scapi-jobs.js +24 -0
  117. package/dist/esm/clients/scapi-jobs.js.map +1 -0
  118. package/dist/esm/clients/scapi-merchant-roles.d.ts +19 -0
  119. package/dist/esm/clients/scapi-merchant-roles.generated.d.ts +726 -0
  120. package/dist/esm/clients/scapi-merchant-roles.generated.js +6 -0
  121. package/dist/esm/clients/scapi-merchant-roles.generated.js.map +1 -0
  122. package/dist/esm/clients/scapi-merchant-roles.js +12 -0
  123. package/dist/esm/clients/scapi-merchant-roles.js.map +1 -0
  124. package/dist/esm/clients/scapi-merchant-users.d.ts +19 -0
  125. package/dist/esm/clients/scapi-merchant-users.generated.d.ts +300 -0
  126. package/dist/esm/clients/scapi-merchant-users.generated.js +6 -0
  127. package/dist/esm/clients/scapi-merchant-users.generated.js.map +1 -0
  128. package/dist/esm/clients/scapi-merchant-users.js +12 -0
  129. package/dist/esm/clients/scapi-merchant-users.js.map +1 -0
  130. package/dist/esm/clients/scapi-schemas.js +2 -5
  131. package/dist/esm/clients/scapi-schemas.js.map +1 -1
  132. package/dist/esm/clients/scapi-scope-tier.d.ts +78 -0
  133. package/dist/esm/clients/scapi-scope-tier.js +113 -0
  134. package/dist/esm/clients/scapi-scope-tier.js.map +1 -0
  135. package/dist/esm/clients/scapi-scripts.d.ts +17 -0
  136. package/dist/esm/clients/scapi-scripts.generated.d.ts +392 -0
  137. package/dist/esm/clients/scapi-scripts.generated.js +6 -0
  138. package/dist/esm/clients/scapi-scripts.generated.js.map +1 -0
  139. package/dist/esm/clients/scapi-scripts.js +12 -0
  140. package/dist/esm/clients/scapi-scripts.js.map +1 -0
  141. package/dist/esm/clients/scapi-sites.d.ts +26 -0
  142. package/dist/esm/clients/scapi-sites.generated.d.ts +500 -0
  143. package/dist/esm/clients/scapi-sites.generated.js +6 -0
  144. package/dist/esm/clients/scapi-sites.generated.js.map +1 -0
  145. package/dist/esm/clients/scapi-sites.js +25 -0
  146. package/dist/esm/clients/scapi-sites.js.map +1 -0
  147. package/dist/esm/clients/slas-shopper.d.ts +19 -0
  148. package/dist/esm/clients/slas-shopper.generated.d.ts +165 -0
  149. package/dist/esm/clients/slas-shopper.generated.js +6 -0
  150. package/dist/esm/clients/slas-shopper.generated.js.map +1 -0
  151. package/dist/esm/clients/slas-shopper.js +35 -0
  152. package/dist/esm/clients/slas-shopper.js.map +1 -0
  153. package/dist/esm/clients/storefront-deployments.d.ts +57 -0
  154. package/dist/esm/clients/storefront-deployments.generated.d.ts +558 -0
  155. package/dist/esm/clients/storefront-deployments.generated.js +6 -0
  156. package/dist/esm/clients/storefront-deployments.generated.js.map +1 -0
  157. package/dist/esm/clients/storefront-deployments.js +24 -0
  158. package/dist/esm/clients/storefront-deployments.js.map +1 -0
  159. package/dist/esm/clients/storefront-environments.d.ts +56 -0
  160. package/dist/esm/clients/storefront-environments.generated.d.ts +208 -0
  161. package/dist/esm/clients/storefront-environments.generated.js +6 -0
  162. package/dist/esm/clients/storefront-environments.generated.js.map +1 -0
  163. package/dist/esm/clients/storefront-environments.js +24 -0
  164. package/dist/esm/clients/storefront-environments.js.map +1 -0
  165. package/dist/esm/clients/webdav.js +4 -1
  166. package/dist/esm/clients/webdav.js.map +1 -1
  167. package/dist/esm/compat/dispatcher.d.ts +49 -0
  168. package/dist/esm/compat/dispatcher.js +124 -0
  169. package/dist/esm/compat/dispatcher.js.map +1 -0
  170. package/dist/esm/compat/index.d.ts +10 -0
  171. package/dist/esm/compat/index.js +15 -0
  172. package/dist/esm/compat/index.js.map +1 -0
  173. package/dist/esm/compat/jobs-backend.d.ts +31 -0
  174. package/dist/esm/compat/jobs-backend.js +76 -0
  175. package/dist/esm/compat/jobs-backend.js.map +1 -0
  176. package/dist/esm/config/dw-json.d.ts +4 -0
  177. package/dist/esm/config/dw-json.js.map +1 -1
  178. package/dist/esm/config/index.d.ts +1 -1
  179. package/dist/esm/config/index.js.map +1 -1
  180. package/dist/esm/config/mapping.d.ts +2 -5
  181. package/dist/esm/config/mapping.js +25 -1
  182. package/dist/esm/config/mapping.js.map +1 -1
  183. package/dist/esm/config/resolved-config.d.ts +2 -2
  184. package/dist/esm/config/resolved-config.js.map +1 -1
  185. package/dist/esm/config/resolver.js +12 -0
  186. package/dist/esm/config/resolver.js.map +1 -1
  187. package/dist/esm/config/sources/env-source.d.ts +10 -1
  188. package/dist/esm/config/sources/env-source.js +46 -1
  189. package/dist/esm/config/sources/env-source.js.map +1 -1
  190. package/dist/esm/config/types.d.ts +22 -3
  191. package/dist/esm/docs/search.js +2 -25
  192. package/dist/esm/docs/search.js.map +1 -1
  193. package/dist/esm/guidance/catalog.d.ts +37 -0
  194. package/dist/esm/guidance/catalog.js +282 -0
  195. package/dist/esm/guidance/catalog.js.map +1 -0
  196. package/dist/esm/guidance/index.d.ts +8 -0
  197. package/dist/esm/guidance/index.js +14 -0
  198. package/dist/esm/guidance/index.js.map +1 -0
  199. package/dist/esm/guidance/markdown.d.ts +10 -0
  200. package/dist/esm/guidance/markdown.js +52 -0
  201. package/dist/esm/guidance/markdown.js.map +1 -0
  202. package/dist/esm/guidance/types.d.ts +96 -0
  203. package/dist/esm/guidance/types.js +17 -0
  204. package/dist/esm/guidance/types.js.map +1 -0
  205. package/dist/esm/index.d.ts +14 -5
  206. package/dist/esm/index.js +14 -2
  207. package/dist/esm/index.js.map +1 -1
  208. package/dist/esm/instance/index.d.ts +96 -2
  209. package/dist/esm/instance/index.js +98 -5
  210. package/dist/esm/instance/index.js.map +1 -1
  211. package/dist/esm/operations/bm-roles/backend.d.ts +4 -0
  212. package/dist/esm/operations/bm-roles/backend.js +11 -0
  213. package/dist/esm/operations/bm-roles/backend.js.map +1 -0
  214. package/dist/esm/operations/bm-roles/index.d.ts +6 -0
  215. package/dist/esm/operations/bm-roles/index.js +4 -0
  216. package/dist/esm/operations/bm-roles/index.js.map +1 -1
  217. package/dist/esm/operations/bm-roles/ocapi-backend.d.ts +17 -0
  218. package/dist/esm/operations/bm-roles/ocapi-backend.js +151 -0
  219. package/dist/esm/operations/bm-roles/ocapi-backend.js.map +1 -0
  220. package/dist/esm/operations/bm-roles/roles.js +13 -17
  221. package/dist/esm/operations/bm-roles/roles.js.map +1 -1
  222. package/dist/esm/operations/bm-roles/scapi-backend.d.ts +27 -0
  223. package/dist/esm/operations/bm-roles/scapi-backend.js +138 -0
  224. package/dist/esm/operations/bm-roles/scapi-backend.js.map +1 -0
  225. package/dist/esm/operations/bm-roles/types.d.ts +49 -0
  226. package/dist/esm/operations/bm-roles/types.js +2 -0
  227. package/dist/esm/operations/bm-roles/types.js.map +1 -0
  228. package/dist/esm/operations/bm-users/backend.d.ts +4 -0
  229. package/dist/esm/operations/bm-users/backend.js +11 -0
  230. package/dist/esm/operations/bm-users/backend.js.map +1 -0
  231. package/dist/esm/operations/bm-users/index.d.ts +11 -3
  232. package/dist/esm/operations/bm-users/index.js +9 -3
  233. package/dist/esm/operations/bm-users/index.js.map +1 -1
  234. package/dist/esm/operations/bm-users/ocapi-backend.d.ts +13 -0
  235. package/dist/esm/operations/bm-users/ocapi-backend.js +92 -0
  236. package/dist/esm/operations/bm-users/ocapi-backend.js.map +1 -0
  237. package/dist/esm/operations/bm-users/scapi-backend.d.ts +23 -0
  238. package/dist/esm/operations/bm-users/scapi-backend.js +199 -0
  239. package/dist/esm/operations/bm-users/scapi-backend.js.map +1 -0
  240. package/dist/esm/operations/bm-users/types.d.ts +99 -0
  241. package/dist/esm/operations/bm-users/types.js +2 -0
  242. package/dist/esm/operations/bm-users/types.js.map +1 -0
  243. package/dist/esm/operations/bm-users/users.d.ts +4 -3
  244. package/dist/esm/operations/bm-users/users.js +23 -19
  245. package/dist/esm/operations/bm-users/users.js.map +1 -1
  246. package/dist/esm/operations/cap/install.js +23 -45
  247. package/dist/esm/operations/cap/install.js.map +1 -1
  248. package/dist/esm/operations/cap/list.js +4 -8
  249. package/dist/esm/operations/cap/list.js.map +1 -1
  250. package/dist/esm/operations/cap/uninstall.js +17 -37
  251. package/dist/esm/operations/cap/uninstall.js.map +1 -1
  252. package/dist/esm/operations/catalogs/catalogs-backend.d.ts +4 -0
  253. package/dist/esm/operations/catalogs/catalogs-backend.js +16 -0
  254. package/dist/esm/operations/catalogs/catalogs-backend.js.map +1 -0
  255. package/dist/esm/operations/catalogs/catalogs-types.d.ts +14 -0
  256. package/dist/esm/operations/catalogs/catalogs-types.js +2 -0
  257. package/dist/esm/operations/catalogs/catalogs-types.js.map +1 -0
  258. package/dist/esm/operations/catalogs/index.d.ts +7 -0
  259. package/dist/esm/operations/catalogs/index.js +10 -0
  260. package/dist/esm/operations/catalogs/index.js.map +1 -0
  261. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.d.ts +8 -0
  262. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js +36 -0
  263. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js.map +1 -0
  264. package/dist/esm/operations/catalogs/scapi-catalogs-backend.d.ts +15 -0
  265. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js +42 -0
  266. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js.map +1 -0
  267. package/dist/esm/operations/cip/index.js +10 -2
  268. package/dist/esm/operations/cip/index.js.map +1 -1
  269. package/dist/esm/operations/cip/reports.js +19 -3
  270. package/dist/esm/operations/cip/reports.js.map +1 -1
  271. package/dist/esm/operations/cip/types.d.ts +8 -4
  272. package/dist/esm/operations/code/deploy.d.ts +3 -0
  273. package/dist/esm/operations/code/deploy.js +9 -3
  274. package/dist/esm/operations/code/deploy.js.map +1 -1
  275. package/dist/esm/operations/code/download.d.ts +3 -0
  276. package/dist/esm/operations/code/download.js +5 -5
  277. package/dist/esm/operations/code/download.js.map +1 -1
  278. package/dist/esm/operations/code/index.d.ts +7 -1
  279. package/dist/esm/operations/code/index.js +5 -1
  280. package/dist/esm/operations/code/index.js.map +1 -1
  281. package/dist/esm/operations/code/ocapi-scripts-backend.d.ts +12 -0
  282. package/dist/esm/operations/code/ocapi-scripts-backend.js +40 -0
  283. package/dist/esm/operations/code/ocapi-scripts-backend.js.map +1 -0
  284. package/dist/esm/operations/code/scapi-scripts-backend.d.ts +22 -0
  285. package/dist/esm/operations/code/scapi-scripts-backend.js +94 -0
  286. package/dist/esm/operations/code/scapi-scripts-backend.js.map +1 -0
  287. package/dist/esm/operations/code/scripts-backend.d.ts +17 -0
  288. package/dist/esm/operations/code/scripts-backend.js +40 -0
  289. package/dist/esm/operations/code/scripts-backend.js.map +1 -0
  290. package/dist/esm/operations/code/scripts-types.d.ts +43 -0
  291. package/dist/esm/operations/code/scripts-types.js +2 -0
  292. package/dist/esm/operations/code/scripts-types.js.map +1 -0
  293. package/dist/esm/operations/code/upload-files.d.ts +6 -0
  294. package/dist/esm/operations/code/upload-files.js +58 -7
  295. package/dist/esm/operations/code/upload-files.js.map +1 -1
  296. package/dist/esm/operations/code/versions.d.ts +0 -20
  297. package/dist/esm/operations/code/versions.js +16 -51
  298. package/dist/esm/operations/code/versions.js.map +1 -1
  299. package/dist/esm/operations/code/watch.d.ts +3 -0
  300. package/dist/esm/operations/code/watch.js +3 -2
  301. package/dist/esm/operations/code/watch.js.map +1 -1
  302. package/dist/esm/operations/jobs/discover.d.ts +1 -1
  303. package/dist/esm/operations/jobs/discover.js +51 -21
  304. package/dist/esm/operations/jobs/discover.js.map +1 -1
  305. package/dist/esm/operations/jobs/index.d.ts +14 -57
  306. package/dist/esm/operations/jobs/index.js +15 -59
  307. package/dist/esm/operations/jobs/index.js.map +1 -1
  308. package/dist/esm/operations/jobs/ocapi-mapping.d.ts +34 -0
  309. package/dist/esm/operations/jobs/ocapi-mapping.js +100 -0
  310. package/dist/esm/operations/jobs/ocapi-mapping.js.map +1 -0
  311. package/dist/esm/operations/jobs/run-system-job.d.ts +81 -0
  312. package/dist/esm/operations/jobs/run-system-job.js +137 -0
  313. package/dist/esm/operations/jobs/run-system-job.js.map +1 -0
  314. package/dist/esm/operations/jobs/run.js +16 -4
  315. package/dist/esm/operations/jobs/run.js.map +1 -1
  316. package/dist/esm/operations/jobs/scapi-ops.d.ts +61 -0
  317. package/dist/esm/operations/jobs/scapi-ops.js +214 -0
  318. package/dist/esm/operations/jobs/scapi-ops.js.map +1 -0
  319. package/dist/esm/operations/jobs/site-archive.d.ts +7 -0
  320. package/dist/esm/operations/jobs/site-archive.js +28 -66
  321. package/dist/esm/operations/jobs/site-archive.js.map +1 -1
  322. package/dist/esm/operations/jobs/types.d.ts +46 -0
  323. package/dist/esm/operations/jobs/types.js +2 -0
  324. package/dist/esm/operations/jobs/types.js.map +1 -0
  325. package/dist/esm/operations/jobs/wait-canonical.d.ts +28 -0
  326. package/dist/esm/operations/jobs/wait-canonical.js +48 -0
  327. package/dist/esm/operations/jobs/wait-canonical.js.map +1 -0
  328. package/dist/esm/operations/mrt/bundle.d.ts +164 -2
  329. package/dist/esm/operations/mrt/bundle.js +315 -9
  330. package/dist/esm/operations/mrt/bundle.js.map +1 -1
  331. package/dist/esm/operations/mrt/deployment.d.ts +248 -0
  332. package/dist/esm/operations/mrt/deployment.js +252 -0
  333. package/dist/esm/operations/mrt/deployment.js.map +1 -1
  334. package/dist/esm/operations/mrt/env-var.d.ts +135 -0
  335. package/dist/esm/operations/mrt/env-var.js +203 -0
  336. package/dist/esm/operations/mrt/env-var.js.map +1 -1
  337. package/dist/esm/operations/mrt/index.d.ts +10 -8
  338. package/dist/esm/operations/mrt/index.js +6 -4
  339. package/dist/esm/operations/mrt/index.js.map +1 -1
  340. package/dist/esm/operations/mrt/mrt-backend.d.ts +117 -0
  341. package/dist/esm/operations/mrt/mrt-backend.js +84 -0
  342. package/dist/esm/operations/mrt/mrt-backend.js.map +1 -0
  343. package/dist/esm/operations/mrt/push.d.ts +285 -1
  344. package/dist/esm/operations/mrt/push.js +382 -1
  345. package/dist/esm/operations/mrt/push.js.map +1 -1
  346. package/dist/esm/operations/sites/cartridges.d.ts +10 -8
  347. package/dist/esm/operations/sites/cartridges.js +35 -67
  348. package/dist/esm/operations/sites/cartridges.js.map +1 -1
  349. package/dist/esm/operations/sites/index.d.ts +10 -6
  350. package/dist/esm/operations/sites/index.js +9 -6
  351. package/dist/esm/operations/sites/index.js.map +1 -1
  352. package/dist/esm/operations/sites/ocapi-sites-backend.d.ts +20 -0
  353. package/dist/esm/operations/sites/ocapi-sites-backend.js +98 -0
  354. package/dist/esm/operations/sites/ocapi-sites-backend.js.map +1 -0
  355. package/dist/esm/operations/sites/scapi-sites-backend.d.ts +33 -0
  356. package/dist/esm/operations/sites/scapi-sites-backend.js +166 -0
  357. package/dist/esm/operations/sites/scapi-sites-backend.js.map +1 -0
  358. package/dist/esm/operations/sites/sites-backend.d.ts +9 -0
  359. package/dist/esm/operations/sites/sites-backend.js +16 -0
  360. package/dist/esm/operations/sites/sites-backend.js.map +1 -0
  361. package/dist/esm/operations/sites/sites-scopes.d.ts +2 -0
  362. package/dist/esm/operations/sites/sites-scopes.js +16 -0
  363. package/dist/esm/operations/sites/sites-scopes.js.map +1 -0
  364. package/dist/esm/operations/sites/sites-types.d.ts +50 -0
  365. package/dist/esm/operations/sites/sites-types.js +2 -0
  366. package/dist/esm/operations/sites/sites-types.js.map +1 -0
  367. package/dist/esm/safety/safety-guard.d.ts +1 -0
  368. package/dist/esm/safety/safety-guard.js +2 -1
  369. package/dist/esm/safety/safety-guard.js.map +1 -1
  370. package/dist/esm/safety/safety-middleware.d.ts +7 -3
  371. package/dist/esm/safety/safety-middleware.js +13 -9
  372. package/dist/esm/safety/safety-middleware.js.map +1 -1
  373. package/dist/esm/safety/types.d.ts +2 -2
  374. package/dist/esm/scaffold/sources.js +6 -9
  375. package/dist/esm/scaffold/sources.js.map +1 -1
  376. package/dist/esm/scapi/auth-primitives.d.ts +3 -0
  377. package/dist/esm/scapi/auth-primitives.js +104 -0
  378. package/dist/esm/scapi/auth-primitives.js.map +1 -0
  379. package/dist/esm/scapi/authentication.d.ts +30 -0
  380. package/dist/esm/scapi/authentication.js +136 -0
  381. package/dist/esm/scapi/authentication.js.map +1 -0
  382. package/dist/esm/scapi/catalog.d.ts +29 -0
  383. package/dist/esm/scapi/catalog.js +81 -0
  384. package/dist/esm/scapi/catalog.js.map +1 -0
  385. package/dist/esm/scapi/index.d.ts +12 -0
  386. package/dist/esm/scapi/index.js +13 -0
  387. package/dist/esm/scapi/index.js.map +1 -0
  388. package/dist/esm/scapi/request.d.ts +28 -0
  389. package/dist/esm/scapi/request.js +273 -0
  390. package/dist/esm/scapi/request.js.map +1 -0
  391. package/dist/esm/scapi/runtime.d.ts +27 -0
  392. package/dist/esm/scapi/runtime.js +161 -0
  393. package/dist/esm/scapi/runtime.js.map +1 -0
  394. package/dist/esm/scapi/snippets.d.ts +22 -0
  395. package/dist/esm/scapi/snippets.js +140 -0
  396. package/dist/esm/scapi/snippets.js.map +1 -0
  397. package/dist/esm/scapi/worker-source.d.ts +2 -0
  398. package/dist/esm/scapi/worker-source.js +101 -0
  399. package/dist/esm/scapi/worker-source.js.map +1 -0
  400. package/dist/esm/search/ranking.d.ts +12 -0
  401. package/dist/esm/search/ranking.js +28 -0
  402. package/dist/esm/search/ranking.js.map +1 -0
  403. package/dist/esm/skills/sources.d.ts +2 -2
  404. package/dist/esm/skills/sources.js +18 -2
  405. package/dist/esm/skills/sources.js.map +1 -1
  406. package/dist/esm/skills/types.d.ts +1 -1
  407. package/dist/esm/slas/token.js +33 -94
  408. package/dist/esm/slas/token.js.map +1 -1
  409. package/dist/esm/slas/types.d.ts +5 -0
  410. package/dist/esm/test-utils/config-isolation.js +2 -2
  411. package/dist/esm/test-utils/config-isolation.js.map +1 -1
  412. package/node_modules/@salesforce/b2c-api-schemas/README.md +23 -0
  413. package/node_modules/@salesforce/b2c-api-schemas/manifest.json +576 -0
  414. package/node_modules/@salesforce/b2c-api-schemas/package.json +15 -0
  415. package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +11490 -0
  416. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +3589 -0
  417. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +6544 -0
  418. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +7148 -0
  419. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +4411 -0
  420. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +643 -0
  421. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +295 -0
  422. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +2036 -0
  423. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +327 -0
  424. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +234 -0
  425. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +1542 -0
  426. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +405 -0
  427. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +2531 -0
  428. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +7944 -0
  429. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +292 -0
  430. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +2537 -0
  431. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +517 -0
  432. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +589 -0
  433. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +3600 -0
  434. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +2319 -0
  435. package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +658 -0
  436. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +2649 -0
  437. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +6615 -0
  438. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +2103 -0
  439. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1760 -0
  440. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +640 -0
  441. package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1263 -0
  442. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1259 -0
  443. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +760 -0
  444. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +1047 -0
  445. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1929 -0
  446. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +1542 -0
  447. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +1093 -0
  448. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +1324 -0
  449. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +325 -0
  450. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +631 -0
  451. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +1036 -0
  452. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +5175 -0
  453. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +866 -0
  454. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +747 -0
  455. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +5076 -0
  456. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +509 -0
  457. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +517 -0
  458. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +2961 -0
  459. package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1889 -0
  460. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +7014 -0
  461. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1898 -0
  462. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +622 -0
  463. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +192 -0
  464. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +913 -0
  465. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +630 -0
  466. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +223 -0
  467. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +423 -0
  468. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +1088 -0
  469. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +798 -0
  470. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +607 -0
  471. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1418 -0
  472. package/package.json +24 -3
  473. package/specs/dx-scripts-v1.yaml +409 -0
  474. package/specs/merchant-roles-v1.yaml +1085 -0
  475. package/specs/merchant-users-v1.yaml +398 -0
  476. package/specs/mrt-api-v1.json +105 -0
  477. package/specs/operations-jobs-v1.yaml +793 -0
  478. package/specs/product-catalogs-v1.yaml +111 -0
  479. package/specs/site-sites-v1.yaml +667 -0
  480. package/specs/slas-shopper-v1.yaml +83 -0
  481. package/specs/storefront-deployments-v1.yaml +630 -0
  482. package/specs/storefront-environments-v1.yaml +272 -0
@@ -0,0 +1,1259 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Jobs",
5
+ "version": "1.0.0",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "Operation"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/operation/jobs/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "123456gf"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/job-execution-search": {
21
+ "post": {
22
+ "operationId": "searchJobExecutions",
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
+ "requestBody": {
36
+ "content": {
37
+ "application/json": {
38
+ "schema": {
39
+ "$ref": "#/components/schemas/JobExecutionSearchRequest"
40
+ }
41
+ }
42
+ },
43
+ "required": true
44
+ },
45
+ "responses": {
46
+ "200": {
47
+ "description": "Returns job execution search results",
48
+ "content": {
49
+ "application/json": {
50
+ "schema": {
51
+ "$ref": "#/components/schemas/JobExecutionSearchResult"
52
+ }
53
+ }
54
+ }
55
+ },
56
+ "400": {
57
+ "description": "Bad Request - Malformed search query or invalid parameters",
58
+ "content": {
59
+ "application/problem+json": {
60
+ "schema": {
61
+ "$ref": "#/components/schemas/ErrorResponse"
62
+ }
63
+ }
64
+ }
65
+ },
66
+ "401": {
67
+ "$ref": "#/components/responses/401unauthorized"
68
+ },
69
+ "403": {
70
+ "$ref": "#/components/responses/403forbidden"
71
+ }
72
+ },
73
+ "security": [
74
+ {
75
+ "AmOAuth2": [
76
+ "sfcc.jobs",
77
+ "sfcc.jobs.rw"
78
+ ]
79
+ }
80
+ ]
81
+ }
82
+ },
83
+ "/organizations/{organizationId}/jobs/{jobId}/executions": {
84
+ "post": {
85
+ "operationId": "createJobExecution",
86
+ "parameters": [
87
+ {
88
+ "name": "organizationId",
89
+ "in": "path",
90
+ "required": true,
91
+ "style": "simple",
92
+ "explode": false,
93
+ "schema": {
94
+ "$ref": "#/components/schemas/OrganizationId"
95
+ }
96
+ },
97
+ {
98
+ "name": "jobId",
99
+ "in": "path",
100
+ "required": true,
101
+ "style": "simple",
102
+ "explode": false,
103
+ "schema": {
104
+ "type": "string",
105
+ "maxLength": 256,
106
+ "minLength": 1
107
+ }
108
+ }
109
+ ],
110
+ "requestBody": {
111
+ "content": {
112
+ "application/json": {
113
+ "schema": {
114
+ "$ref": "#/components/schemas/JobExecutionRequest"
115
+ }
116
+ }
117
+ },
118
+ "required": false
119
+ },
120
+ "responses": {
121
+ "200": {
122
+ "description": "The job execution was successfully created",
123
+ "content": {
124
+ "application/json": {
125
+ "schema": {
126
+ "$ref": "#/components/schemas/JobExecution"
127
+ }
128
+ }
129
+ }
130
+ },
131
+ "400": {
132
+ "description": "Bad Request - Invalid job execution request",
133
+ "content": {
134
+ "application/problem+json": {
135
+ "schema": {
136
+ "$ref": "#/components/schemas/ErrorResponse"
137
+ }
138
+ }
139
+ }
140
+ },
141
+ "401": {
142
+ "$ref": "#/components/responses/401unauthorized"
143
+ },
144
+ "403": {
145
+ "$ref": "#/components/responses/403forbidden"
146
+ },
147
+ "404": {
148
+ "description": "Job not found",
149
+ "content": {
150
+ "application/problem+json": {
151
+ "schema": {
152
+ "$ref": "#/components/schemas/ErrorResponse"
153
+ }
154
+ }
155
+ }
156
+ }
157
+ },
158
+ "security": [
159
+ {
160
+ "AmOAuth2": [
161
+ "sfcc.jobs.rw"
162
+ ]
163
+ }
164
+ ]
165
+ }
166
+ },
167
+ "/organizations/{organizationId}/jobs/{jobId}/executions/{executionId}": {
168
+ "get": {
169
+ "operationId": "getJobExecution",
170
+ "parameters": [
171
+ {
172
+ "name": "organizationId",
173
+ "in": "path",
174
+ "required": true,
175
+ "style": "simple",
176
+ "explode": false,
177
+ "schema": {
178
+ "$ref": "#/components/schemas/OrganizationId"
179
+ }
180
+ },
181
+ {
182
+ "name": "jobId",
183
+ "in": "path",
184
+ "required": true,
185
+ "style": "simple",
186
+ "explode": false,
187
+ "schema": {
188
+ "type": "string",
189
+ "maxLength": 256,
190
+ "minLength": 1
191
+ }
192
+ },
193
+ {
194
+ "name": "executionId",
195
+ "in": "path",
196
+ "required": true,
197
+ "style": "simple",
198
+ "explode": false,
199
+ "schema": {
200
+ "type": "string",
201
+ "maxLength": 256,
202
+ "minLength": 1
203
+ }
204
+ }
205
+ ],
206
+ "responses": {
207
+ "200": {
208
+ "description": "Returns the job execution details",
209
+ "content": {
210
+ "application/json": {
211
+ "schema": {
212
+ "$ref": "#/components/schemas/JobExecution"
213
+ }
214
+ }
215
+ }
216
+ },
217
+ "401": {
218
+ "$ref": "#/components/responses/401unauthorized"
219
+ },
220
+ "403": {
221
+ "$ref": "#/components/responses/403forbidden"
222
+ },
223
+ "404": {
224
+ "description": "Job execution not found",
225
+ "content": {
226
+ "application/problem+json": {
227
+ "schema": {
228
+ "$ref": "#/components/schemas/ErrorResponse"
229
+ }
230
+ }
231
+ }
232
+ }
233
+ },
234
+ "security": [
235
+ {
236
+ "AmOAuth2": [
237
+ "sfcc.jobs",
238
+ "sfcc.jobs.rw"
239
+ ]
240
+ }
241
+ ]
242
+ },
243
+ "delete": {
244
+ "operationId": "deleteJobExecution",
245
+ "parameters": [
246
+ {
247
+ "name": "organizationId",
248
+ "in": "path",
249
+ "required": true,
250
+ "style": "simple",
251
+ "explode": false,
252
+ "schema": {
253
+ "$ref": "#/components/schemas/OrganizationId"
254
+ }
255
+ },
256
+ {
257
+ "name": "jobId",
258
+ "in": "path",
259
+ "required": true,
260
+ "style": "simple",
261
+ "explode": false,
262
+ "schema": {
263
+ "type": "string",
264
+ "maxLength": 256,
265
+ "minLength": 1
266
+ }
267
+ },
268
+ {
269
+ "name": "executionId",
270
+ "in": "path",
271
+ "required": true,
272
+ "style": "simple",
273
+ "explode": false,
274
+ "schema": {
275
+ "type": "string",
276
+ "maxLength": 256,
277
+ "minLength": 1
278
+ }
279
+ }
280
+ ],
281
+ "responses": {
282
+ "204": {
283
+ "description": "The job execution was successfully deleted"
284
+ },
285
+ "401": {
286
+ "$ref": "#/components/responses/401unauthorized"
287
+ },
288
+ "403": {
289
+ "$ref": "#/components/responses/403forbidden"
290
+ },
291
+ "404": {
292
+ "description": "Job execution not found",
293
+ "content": {
294
+ "application/problem+json": {
295
+ "schema": {
296
+ "$ref": "#/components/schemas/ErrorResponse"
297
+ }
298
+ }
299
+ }
300
+ }
301
+ },
302
+ "security": [
303
+ {
304
+ "AmOAuth2": [
305
+ "sfcc.jobs.rw"
306
+ ]
307
+ }
308
+ ]
309
+ }
310
+ }
311
+ },
312
+ "components": {
313
+ "schemas": {
314
+ "OrganizationId": {
315
+ "type": "string",
316
+ "maxLength": 32,
317
+ "minLength": 1
318
+ },
319
+ "Query": {
320
+ "type": "object",
321
+ "additionalProperties": false,
322
+ "maxProperties": 1,
323
+ "minProperties": 1,
324
+ "properties": {
325
+ "boolQuery": {
326
+ "$ref": "#/components/schemas/BoolQuery"
327
+ },
328
+ "filteredQuery": {
329
+ "$ref": "#/components/schemas/FilteredQuery"
330
+ },
331
+ "matchAllQuery": {
332
+ "$ref": "#/components/schemas/MatchAllQuery"
333
+ },
334
+ "nestedQuery": {
335
+ "$ref": "#/components/schemas/NestedQuery"
336
+ },
337
+ "termQuery": {
338
+ "$ref": "#/components/schemas/TermQuery"
339
+ },
340
+ "textQuery": {
341
+ "$ref": "#/components/schemas/TextQuery"
342
+ }
343
+ }
344
+ },
345
+ "BoolQuery": {
346
+ "type": "object",
347
+ "additionalProperties": false,
348
+ "properties": {
349
+ "must": {
350
+ "type": "array",
351
+ "items": {
352
+ "$ref": "#/components/schemas/Query"
353
+ }
354
+ },
355
+ "mustNot": {
356
+ "type": "array",
357
+ "items": {
358
+ "$ref": "#/components/schemas/Query"
359
+ }
360
+ },
361
+ "should": {
362
+ "type": "array",
363
+ "items": {
364
+ "$ref": "#/components/schemas/Query"
365
+ }
366
+ }
367
+ }
368
+ },
369
+ "Filter": {
370
+ "type": "object",
371
+ "additionalProperties": false,
372
+ "maxProperties": 1,
373
+ "minProperties": 1,
374
+ "properties": {
375
+ "boolFilter": {
376
+ "$ref": "#/components/schemas/BoolFilter"
377
+ },
378
+ "queryFilter": {
379
+ "$ref": "#/components/schemas/QueryFilter"
380
+ },
381
+ "range2Filter": {
382
+ "$ref": "#/components/schemas/Range2Filter"
383
+ },
384
+ "rangeFilter": {
385
+ "$ref": "#/components/schemas/RangeFilter"
386
+ },
387
+ "termFilter": {
388
+ "$ref": "#/components/schemas/TermFilter"
389
+ }
390
+ }
391
+ },
392
+ "BoolFilter": {
393
+ "type": "object",
394
+ "additionalProperties": false,
395
+ "properties": {
396
+ "filters": {
397
+ "type": "array",
398
+ "items": {
399
+ "$ref": "#/components/schemas/Filter"
400
+ }
401
+ },
402
+ "operator": {
403
+ "type": "string",
404
+ "enum": [
405
+ "and",
406
+ "or",
407
+ "not"
408
+ ]
409
+ }
410
+ },
411
+ "required": [
412
+ "operator"
413
+ ]
414
+ },
415
+ "QueryFilter": {
416
+ "type": "object",
417
+ "properties": {
418
+ "query": {
419
+ "$ref": "#/components/schemas/Query"
420
+ }
421
+ },
422
+ "required": [
423
+ "query"
424
+ ]
425
+ },
426
+ "Field": {
427
+ "type": "string",
428
+ "maxLength": 260
429
+ },
430
+ "Range2Filter": {
431
+ "type": "object",
432
+ "additionalProperties": false,
433
+ "properties": {
434
+ "filterMode": {
435
+ "type": "string",
436
+ "default": "overlap",
437
+ "enum": [
438
+ "overlap",
439
+ "containing",
440
+ "contained"
441
+ ]
442
+ },
443
+ "fromField": {
444
+ "allOf": [
445
+ {
446
+ "$ref": "#/components/schemas/Field"
447
+ }
448
+ ]
449
+ },
450
+ "fromInclusive": {
451
+ "type": "boolean",
452
+ "default": true
453
+ },
454
+ "fromValue": {},
455
+ "toField": {
456
+ "allOf": [
457
+ {
458
+ "$ref": "#/components/schemas/Field"
459
+ }
460
+ ]
461
+ },
462
+ "toInclusive": {
463
+ "type": "boolean",
464
+ "default": true
465
+ },
466
+ "toValue": {}
467
+ },
468
+ "required": [
469
+ "fromField",
470
+ "toField"
471
+ ]
472
+ },
473
+ "RangeFilter": {
474
+ "type": "object",
475
+ "properties": {
476
+ "field": {
477
+ "allOf": [
478
+ {
479
+ "$ref": "#/components/schemas/Field"
480
+ }
481
+ ]
482
+ },
483
+ "from": {
484
+ "oneOf": [
485
+ {
486
+ "type": "string",
487
+ "format": "date-time"
488
+ },
489
+ {
490
+ "type": "integer"
491
+ },
492
+ {
493
+ "type": "number"
494
+ }
495
+ ]
496
+ },
497
+ "fromInclusive": {
498
+ "type": "boolean",
499
+ "default": true
500
+ },
501
+ "to": {
502
+ "oneOf": [
503
+ {
504
+ "type": "string",
505
+ "format": "date-time"
506
+ },
507
+ {
508
+ "type": "integer"
509
+ },
510
+ {
511
+ "type": "number"
512
+ }
513
+ ]
514
+ },
515
+ "toInclusive": {
516
+ "type": "boolean",
517
+ "default": true
518
+ }
519
+ },
520
+ "required": [
521
+ "field"
522
+ ]
523
+ },
524
+ "TermFilter": {
525
+ "type": "object",
526
+ "additionalProperties": false,
527
+ "properties": {
528
+ "field": {
529
+ "allOf": [
530
+ {
531
+ "$ref": "#/components/schemas/Field"
532
+ }
533
+ ]
534
+ },
535
+ "operator": {
536
+ "type": "string",
537
+ "enum": [
538
+ "is",
539
+ "one_of",
540
+ "is_null",
541
+ "is_not_null",
542
+ "less",
543
+ "greater",
544
+ "not_in",
545
+ "neq"
546
+ ]
547
+ },
548
+ "values": {
549
+ "type": "array",
550
+ "items": {
551
+ "type": "string"
552
+ }
553
+ }
554
+ },
555
+ "required": [
556
+ "field",
557
+ "operator"
558
+ ]
559
+ },
560
+ "FilteredQuery": {
561
+ "type": "object",
562
+ "additionalProperties": false,
563
+ "properties": {
564
+ "filter": {
565
+ "$ref": "#/components/schemas/Filter"
566
+ },
567
+ "query": {
568
+ "$ref": "#/components/schemas/Query"
569
+ }
570
+ },
571
+ "required": [
572
+ "filter",
573
+ "query"
574
+ ]
575
+ },
576
+ "MatchAllQuery": {
577
+ "type": "object"
578
+ },
579
+ "NestedQuery": {
580
+ "type": "object",
581
+ "additionalProperties": false,
582
+ "properties": {
583
+ "path": {
584
+ "type": "string",
585
+ "maxLength": 2048
586
+ },
587
+ "query": {
588
+ "$ref": "#/components/schemas/Query"
589
+ },
590
+ "scoreMode": {
591
+ "type": "string",
592
+ "enum": [
593
+ "avg",
594
+ "total",
595
+ "max",
596
+ "none"
597
+ ]
598
+ }
599
+ },
600
+ "required": [
601
+ "path",
602
+ "query"
603
+ ]
604
+ },
605
+ "TermQuery": {
606
+ "type": "object",
607
+ "properties": {
608
+ "fields": {
609
+ "type": "array",
610
+ "items": {
611
+ "$ref": "#/components/schemas/Field"
612
+ },
613
+ "minItems": 1
614
+ },
615
+ "operator": {
616
+ "type": "string",
617
+ "enum": [
618
+ "is",
619
+ "one_of",
620
+ "is_null",
621
+ "is_not_null",
622
+ "less",
623
+ "greater",
624
+ "not_in",
625
+ "neq"
626
+ ]
627
+ },
628
+ "values": {
629
+ "type": "array",
630
+ "items": {
631
+ "oneOf": [
632
+ {
633
+ "type": "string"
634
+ },
635
+ {
636
+ "type": "number"
637
+ },
638
+ {
639
+ "type": "boolean"
640
+ },
641
+ {
642
+ "type": "integer"
643
+ }
644
+ ]
645
+ }
646
+ }
647
+ },
648
+ "required": [
649
+ "fields",
650
+ "operator"
651
+ ]
652
+ },
653
+ "TextQuery": {
654
+ "type": "object",
655
+ "additionalProperties": false,
656
+ "properties": {
657
+ "fields": {
658
+ "type": "array",
659
+ "items": {
660
+ "$ref": "#/components/schemas/Field"
661
+ },
662
+ "minItems": 1
663
+ },
664
+ "searchPhrase": {
665
+ "type": "string"
666
+ }
667
+ },
668
+ "required": [
669
+ "fields",
670
+ "searchPhrase"
671
+ ]
672
+ },
673
+ "Sort": {
674
+ "type": "object",
675
+ "additionalProperties": false,
676
+ "properties": {
677
+ "field": {
678
+ "type": "string",
679
+ "maxLength": 256
680
+ },
681
+ "sortOrder": {
682
+ "type": "string",
683
+ "default": "asc",
684
+ "enum": [
685
+ "asc",
686
+ "desc"
687
+ ]
688
+ }
689
+ },
690
+ "required": [
691
+ "field"
692
+ ]
693
+ },
694
+ "Offset": {
695
+ "type": "integer",
696
+ "format": "int32",
697
+ "default": 0,
698
+ "minimum": 0
699
+ },
700
+ "SearchRequest": {
701
+ "type": "object",
702
+ "properties": {
703
+ "limit": {
704
+ "type": "integer",
705
+ "format": "int32",
706
+ "maximum": 200,
707
+ "minimum": 1
708
+ },
709
+ "query": {
710
+ "$ref": "#/components/schemas/Query"
711
+ },
712
+ "sorts": {
713
+ "type": "array",
714
+ "items": {
715
+ "$ref": "#/components/schemas/Sort"
716
+ }
717
+ },
718
+ "offset": {
719
+ "$ref": "#/components/schemas/Offset"
720
+ }
721
+ },
722
+ "required": [
723
+ "query"
724
+ ]
725
+ },
726
+ "JobExecutionSearchRequest": {
727
+ "allOf": [
728
+ {
729
+ "$ref": "#/components/schemas/SearchRequest"
730
+ }
731
+ ]
732
+ },
733
+ "Total": {
734
+ "type": "integer",
735
+ "format": "int32",
736
+ "default": 0,
737
+ "minimum": 0
738
+ },
739
+ "ResultBase": {
740
+ "type": "object",
741
+ "properties": {
742
+ "limit": {
743
+ "type": "integer",
744
+ "format": "int32"
745
+ },
746
+ "total": {
747
+ "$ref": "#/components/schemas/Total"
748
+ }
749
+ },
750
+ "required": [
751
+ "limit",
752
+ "total"
753
+ ]
754
+ },
755
+ "PaginatedResultBase": {
756
+ "allOf": [
757
+ {
758
+ "$ref": "#/components/schemas/ResultBase"
759
+ }
760
+ ],
761
+ "properties": {
762
+ "offset": {
763
+ "$ref": "#/components/schemas/Offset"
764
+ }
765
+ },
766
+ "required": [
767
+ "limit",
768
+ "offset",
769
+ "total"
770
+ ]
771
+ },
772
+ "PaginatedSearchResult": {
773
+ "additionalProperties": false,
774
+ "allOf": [
775
+ {
776
+ "$ref": "#/components/schemas/PaginatedResultBase"
777
+ }
778
+ ],
779
+ "properties": {
780
+ "query": {
781
+ "$ref": "#/components/schemas/Query"
782
+ },
783
+ "sorts": {
784
+ "type": "array",
785
+ "items": {
786
+ "$ref": "#/components/schemas/Sort"
787
+ }
788
+ },
789
+ "hits": {
790
+ "type": "array",
791
+ "items": {
792
+ "type": "object"
793
+ }
794
+ }
795
+ },
796
+ "required": [
797
+ "query"
798
+ ]
799
+ },
800
+ "ExecutionStatus": {
801
+ "type": "string",
802
+ "enum": [
803
+ "pending",
804
+ "running",
805
+ "pausing",
806
+ "paused",
807
+ "resuming",
808
+ "resumed",
809
+ "restarting",
810
+ "restarted",
811
+ "retrying",
812
+ "retried",
813
+ "aborting",
814
+ "aborted",
815
+ "finished",
816
+ "unknown"
817
+ ]
818
+ },
819
+ "ExitStatus": {
820
+ "type": "object",
821
+ "properties": {
822
+ "code": {
823
+ "type": "string",
824
+ "maxLength": 256
825
+ },
826
+ "message": {
827
+ "type": "string",
828
+ "maxLength": 4000
829
+ },
830
+ "status": {
831
+ "type": "string",
832
+ "enum": [
833
+ "ok",
834
+ "error"
835
+ ]
836
+ }
837
+ }
838
+ },
839
+ "StatusMetadata": {
840
+ "type": "object",
841
+ "properties": {
842
+ "clientId": {
843
+ "type": "string",
844
+ "maxLength": 256
845
+ },
846
+ "reason": {
847
+ "type": "string",
848
+ "maxLength": 4000
849
+ },
850
+ "userLogin": {
851
+ "type": "string",
852
+ "maxLength": 256
853
+ }
854
+ }
855
+ },
856
+ "JobParameter": {
857
+ "type": "object",
858
+ "properties": {
859
+ "name": {
860
+ "type": "string",
861
+ "maxLength": 256,
862
+ "minLength": 1,
863
+ "pattern": "\\S|(\\S(.*)\\S)"
864
+ },
865
+ "value": {
866
+ "type": "string",
867
+ "maxLength": 1000,
868
+ "minLength": 0,
869
+ "pattern": "\\S|(\\S(.*)\\S)"
870
+ }
871
+ },
872
+ "required": [
873
+ "name",
874
+ "value"
875
+ ]
876
+ },
877
+ "JobExecutionRetryInformation": {
878
+ "type": "object",
879
+ "properties": {
880
+ "currentRetryAttempt": {
881
+ "type": "integer",
882
+ "format": "int32"
883
+ },
884
+ "maxRetries": {
885
+ "type": "integer",
886
+ "format": "int32"
887
+ }
888
+ }
889
+ },
890
+ "JobExecutionContinueInformation": {
891
+ "type": "object",
892
+ "properties": {
893
+ "isPending": {
894
+ "type": "boolean"
895
+ },
896
+ "continueStatus": {
897
+ "type": "string",
898
+ "maxLength": 256
899
+ }
900
+ }
901
+ },
902
+ "JobStepExecution": {
903
+ "type": "object",
904
+ "properties": {
905
+ "id": {
906
+ "type": "string",
907
+ "maxLength": 256,
908
+ "minLength": 1
909
+ },
910
+ "stepId": {
911
+ "type": "string",
912
+ "maxLength": 256,
913
+ "minLength": 1
914
+ },
915
+ "stepDescription": {
916
+ "type": "string",
917
+ "maxLength": 4000
918
+ },
919
+ "stepTypeId": {
920
+ "type": "string",
921
+ "maxLength": 256
922
+ },
923
+ "stepTypeInfo": {
924
+ "type": "string",
925
+ "maxLength": 4000
926
+ },
927
+ "executionScope": {
928
+ "type": "string",
929
+ "maxLength": 256
930
+ },
931
+ "executionStatus": {
932
+ "allOf": [
933
+ {
934
+ "$ref": "#/components/schemas/ExecutionStatus"
935
+ }
936
+ ]
937
+ },
938
+ "status": {
939
+ "type": "string",
940
+ "maxLength": 256
941
+ },
942
+ "startTime": {
943
+ "type": "string",
944
+ "format": "date-time"
945
+ },
946
+ "endTime": {
947
+ "type": "string",
948
+ "format": "date-time"
949
+ },
950
+ "duration": {
951
+ "type": "integer",
952
+ "format": "int64"
953
+ },
954
+ "modificationTime": {
955
+ "type": "string",
956
+ "format": "date-time"
957
+ },
958
+ "statusMetadata": {
959
+ "allOf": [
960
+ {
961
+ "$ref": "#/components/schemas/StatusMetadata"
962
+ }
963
+ ]
964
+ },
965
+ "exitStatus": {
966
+ "allOf": [
967
+ {
968
+ "$ref": "#/components/schemas/ExitStatus"
969
+ }
970
+ ]
971
+ },
972
+ "includeStepsFromJobId": {
973
+ "type": "string",
974
+ "maxLength": 256
975
+ },
976
+ "isChunkOriented": {
977
+ "type": "boolean"
978
+ },
979
+ "chunkSize": {
980
+ "type": "integer",
981
+ "format": "int32"
982
+ },
983
+ "itemFilterCount": {
984
+ "type": "integer",
985
+ "format": "int32"
986
+ },
987
+ "itemWriteCount": {
988
+ "type": "integer",
989
+ "format": "int32"
990
+ },
991
+ "totalItemCount": {
992
+ "type": "integer",
993
+ "format": "int64"
994
+ }
995
+ }
996
+ },
997
+ "JobExecution": {
998
+ "type": "object",
999
+ "properties": {
1000
+ "id": {
1001
+ "type": "string",
1002
+ "maxLength": 256,
1003
+ "minLength": 1
1004
+ },
1005
+ "jobId": {
1006
+ "type": "string",
1007
+ "maxLength": 256,
1008
+ "minLength": 1
1009
+ },
1010
+ "jobDescription": {
1011
+ "type": "string",
1012
+ "maxLength": 4000
1013
+ },
1014
+ "clientId": {
1015
+ "type": "string",
1016
+ "maxLength": 256
1017
+ },
1018
+ "userLogin": {
1019
+ "type": "string",
1020
+ "maxLength": 256
1021
+ },
1022
+ "executionStatus": {
1023
+ "allOf": [
1024
+ {
1025
+ "$ref": "#/components/schemas/ExecutionStatus"
1026
+ }
1027
+ ]
1028
+ },
1029
+ "status": {
1030
+ "type": "string",
1031
+ "maxLength": 256
1032
+ },
1033
+ "startTime": {
1034
+ "type": "string",
1035
+ "format": "date-time"
1036
+ },
1037
+ "endTime": {
1038
+ "type": "string",
1039
+ "format": "date-time"
1040
+ },
1041
+ "creationDate": {
1042
+ "type": "string",
1043
+ "format": "date-time"
1044
+ },
1045
+ "duration": {
1046
+ "type": "integer",
1047
+ "format": "int64"
1048
+ },
1049
+ "effectiveDuration": {
1050
+ "type": "integer",
1051
+ "format": "int64"
1052
+ },
1053
+ "modificationTime": {
1054
+ "type": "string",
1055
+ "format": "date-time"
1056
+ },
1057
+ "lastModified": {
1058
+ "type": "string",
1059
+ "format": "date-time"
1060
+ },
1061
+ "executedServerId": {
1062
+ "type": "string",
1063
+ "maxLength": 256
1064
+ },
1065
+ "exitStatus": {
1066
+ "allOf": [
1067
+ {
1068
+ "$ref": "#/components/schemas/ExitStatus"
1069
+ }
1070
+ ]
1071
+ },
1072
+ "statusMetadata": {
1073
+ "allOf": [
1074
+ {
1075
+ "$ref": "#/components/schemas/StatusMetadata"
1076
+ }
1077
+ ]
1078
+ },
1079
+ "isLogFileExisting": {
1080
+ "type": "boolean"
1081
+ },
1082
+ "isRestart": {
1083
+ "type": "boolean"
1084
+ },
1085
+ "logFilePath": {
1086
+ "type": "string",
1087
+ "maxLength": 4000
1088
+ },
1089
+ "parameters": {
1090
+ "type": "array",
1091
+ "items": {
1092
+ "$ref": "#/components/schemas/JobParameter"
1093
+ }
1094
+ },
1095
+ "executionScopes": {
1096
+ "type": "array",
1097
+ "items": {
1098
+ "type": "string",
1099
+ "maxLength": 256
1100
+ }
1101
+ },
1102
+ "retryInformation": {
1103
+ "allOf": [
1104
+ {
1105
+ "$ref": "#/components/schemas/JobExecutionRetryInformation"
1106
+ }
1107
+ ]
1108
+ },
1109
+ "continueInformation": {
1110
+ "allOf": [
1111
+ {
1112
+ "$ref": "#/components/schemas/JobExecutionContinueInformation"
1113
+ }
1114
+ ]
1115
+ },
1116
+ "stepExecutions": {
1117
+ "type": "array",
1118
+ "items": {
1119
+ "$ref": "#/components/schemas/JobStepExecution"
1120
+ }
1121
+ }
1122
+ },
1123
+ "required": [
1124
+ "id",
1125
+ "jobId",
1126
+ "status"
1127
+ ]
1128
+ },
1129
+ "JobExecutionSearchResult": {
1130
+ "allOf": [
1131
+ {
1132
+ "$ref": "#/components/schemas/PaginatedSearchResult"
1133
+ }
1134
+ ],
1135
+ "properties": {
1136
+ "hits": {
1137
+ "type": "array",
1138
+ "items": {
1139
+ "$ref": "#/components/schemas/JobExecution"
1140
+ }
1141
+ }
1142
+ },
1143
+ "required": [
1144
+ "hits",
1145
+ "query"
1146
+ ]
1147
+ },
1148
+ "ErrorResponse": {
1149
+ "type": "object",
1150
+ "additionalProperties": true,
1151
+ "properties": {
1152
+ "title": {
1153
+ "type": "string",
1154
+ "maxLength": 256
1155
+ },
1156
+ "type": {
1157
+ "type": "string",
1158
+ "maxLength": 2048
1159
+ },
1160
+ "detail": {
1161
+ "type": "string"
1162
+ },
1163
+ "instance": {
1164
+ "type": "string",
1165
+ "maxLength": 2048
1166
+ }
1167
+ },
1168
+ "required": [
1169
+ "detail",
1170
+ "title",
1171
+ "type"
1172
+ ]
1173
+ },
1174
+ "JobExecutionRequest": {
1175
+ "type": "object",
1176
+ "properties": {
1177
+ "parameters": {
1178
+ "type": "array",
1179
+ "items": {
1180
+ "$ref": "#/components/schemas/JobParameter"
1181
+ }
1182
+ }
1183
+ }
1184
+ }
1185
+ },
1186
+ "responses": {
1187
+ "401unauthorized": {
1188
+ "description": "Your access token is invalid or expired and can’t be used to identify a user.",
1189
+ "content": {
1190
+ "application/problem+json": {
1191
+ "schema": {
1192
+ "$ref": "#/components/schemas/ErrorResponse"
1193
+ }
1194
+ }
1195
+ }
1196
+ },
1197
+ "403forbidden": {
1198
+ "description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
1199
+ "content": {
1200
+ "application/problem+json": {
1201
+ "schema": {
1202
+ "$ref": "#/components/schemas/ErrorResponse"
1203
+ }
1204
+ }
1205
+ }
1206
+ }
1207
+ },
1208
+ "parameters": {
1209
+ "organizationId": {
1210
+ "name": "organizationId",
1211
+ "in": "path",
1212
+ "required": true,
1213
+ "style": "simple",
1214
+ "explode": false,
1215
+ "schema": {
1216
+ "$ref": "#/components/schemas/OrganizationId"
1217
+ }
1218
+ },
1219
+ "jobId": {
1220
+ "name": "jobId",
1221
+ "in": "path",
1222
+ "required": true,
1223
+ "style": "simple",
1224
+ "explode": false,
1225
+ "schema": {
1226
+ "type": "string",
1227
+ "maxLength": 256,
1228
+ "minLength": 1
1229
+ }
1230
+ },
1231
+ "executionId": {
1232
+ "name": "executionId",
1233
+ "in": "path",
1234
+ "required": true,
1235
+ "style": "simple",
1236
+ "explode": false,
1237
+ "schema": {
1238
+ "type": "string",
1239
+ "maxLength": 256,
1240
+ "minLength": 1
1241
+ }
1242
+ }
1243
+ },
1244
+ "securitySchemes": {
1245
+ "AmOAuth2": {
1246
+ "type": "oauth2",
1247
+ "flows": {
1248
+ "clientCredentials": {
1249
+ "tokenUrl": "https://account.demandware.com/dw/oauth2/access_token",
1250
+ "scopes": {
1251
+ "sfcc.jobs": "Read access to job resources",
1252
+ "sfcc.jobs.rw": "Read and write access to job resources"
1253
+ }
1254
+ }
1255
+ }
1256
+ }
1257
+ }
1258
+ }
1259
+ }