@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,2537 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Object Definitions",
5
+ "version": "1.1.2",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "DX"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/dx/object-definitions/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/organizations/{organizationId}/system/object-types": {
21
+ "get": {
22
+ "operationId": "getSystemObjectTypes",
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": "select",
36
+ "in": "query",
37
+ "required": false,
38
+ "style": "form",
39
+ "explode": true,
40
+ "schema": {
41
+ "$ref": "#/components/schemas/Select"
42
+ }
43
+ },
44
+ {
45
+ "name": "limit",
46
+ "in": "query",
47
+ "required": false,
48
+ "style": "form",
49
+ "explode": true,
50
+ "schema": {
51
+ "type": "integer",
52
+ "format": "int32",
53
+ "default": 25,
54
+ "maximum": 200,
55
+ "minimum": 1
56
+ }
57
+ },
58
+ {
59
+ "name": "offset",
60
+ "in": "query",
61
+ "required": false,
62
+ "style": "form",
63
+ "explode": true,
64
+ "schema": {
65
+ "type": "integer",
66
+ "format": "int32",
67
+ "default": 0,
68
+ "minimum": 0
69
+ }
70
+ }
71
+ ],
72
+ "responses": {
73
+ "200": {
74
+ "description": "Successfully returned system object types",
75
+ "content": {
76
+ "application/json": {
77
+ "schema": {
78
+ "$ref": "#/components/schemas/ObjectTypeDefinitionResult"
79
+ }
80
+ }
81
+ }
82
+ },
83
+ "401": {
84
+ "$ref": "#/components/responses/401unauthorized"
85
+ },
86
+ "403": {
87
+ "$ref": "#/components/responses/403forbidden"
88
+ },
89
+ "404": {
90
+ "description": "Object Type Not Found",
91
+ "content": {
92
+ "application/problem+json": {
93
+ "schema": {
94
+ "$ref": "#/components/schemas/ErrorResponse"
95
+ }
96
+ }
97
+ }
98
+ }
99
+ },
100
+ "security": [
101
+ {
102
+ "AmOAuth2": [
103
+ "sfcc.object-definitions",
104
+ "sfcc.object-definitions.rw"
105
+ ]
106
+ }
107
+ ]
108
+ }
109
+ },
110
+ "/organizations/{organizationId}/system/object-types-search": {
111
+ "post": {
112
+ "operationId": "searchSystemObjectTypes",
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
+ "requestBody": {
126
+ "content": {
127
+ "application/json": {
128
+ "schema": {
129
+ "$ref": "#/components/schemas/SearchRequest"
130
+ }
131
+ }
132
+ },
133
+ "required": true
134
+ },
135
+ "responses": {
136
+ "200": {
137
+ "description": "Successfully returned system object type search results",
138
+ "content": {
139
+ "application/json": {
140
+ "schema": {
141
+ "$ref": "#/components/schemas/ObjectTypeDefinitionSearchResult"
142
+ }
143
+ }
144
+ }
145
+ },
146
+ "400": {
147
+ "description": "Field Not Sortable",
148
+ "content": {
149
+ "application/problem+json": {
150
+ "schema": {
151
+ "$ref": "#/components/schemas/ErrorResponse"
152
+ }
153
+ }
154
+ }
155
+ },
156
+ "401": {
157
+ "$ref": "#/components/responses/401unauthorized"
158
+ },
159
+ "403": {
160
+ "$ref": "#/components/responses/403forbidden"
161
+ }
162
+ },
163
+ "security": [
164
+ {
165
+ "AmOAuth2": [
166
+ "sfcc.object-definitions",
167
+ "sfcc.object-definitions.rw"
168
+ ]
169
+ }
170
+ ]
171
+ }
172
+ },
173
+ "/organizations/{organizationId}/system/object-types/{objectType}": {
174
+ "get": {
175
+ "operationId": "getSystemObjectType",
176
+ "parameters": [
177
+ {
178
+ "name": "organizationId",
179
+ "in": "path",
180
+ "required": true,
181
+ "style": "simple",
182
+ "explode": false,
183
+ "schema": {
184
+ "$ref": "#/components/schemas/OrganizationId"
185
+ }
186
+ },
187
+ {
188
+ "name": "objectType",
189
+ "in": "path",
190
+ "required": true,
191
+ "style": "simple",
192
+ "explode": false,
193
+ "schema": {
194
+ "type": "string",
195
+ "maxLength": 256,
196
+ "minLength": 1
197
+ }
198
+ }
199
+ ],
200
+ "responses": {
201
+ "200": {
202
+ "description": "Successfully returned the system object type",
203
+ "content": {
204
+ "application/json": {
205
+ "schema": {
206
+ "$ref": "#/components/schemas/ObjectTypeDefinition"
207
+ }
208
+ }
209
+ }
210
+ },
211
+ "401": {
212
+ "$ref": "#/components/responses/401unauthorized"
213
+ },
214
+ "403": {
215
+ "$ref": "#/components/responses/403forbidden"
216
+ },
217
+ "404": {
218
+ "description": "Object Type Not Found",
219
+ "content": {
220
+ "application/problem+json": {
221
+ "schema": {
222
+ "$ref": "#/components/schemas/ErrorResponse"
223
+ }
224
+ }
225
+ }
226
+ }
227
+ },
228
+ "security": [
229
+ {
230
+ "AmOAuth2": [
231
+ "sfcc.object-definitions",
232
+ "sfcc.object-definitions.rw"
233
+ ]
234
+ }
235
+ ]
236
+ }
237
+ },
238
+ "/organizations/{organizationId}/system/object-types/{objectType}/attribute-definition-search": {
239
+ "post": {
240
+ "operationId": "searchAttributeDefinitionForSystemObject",
241
+ "parameters": [
242
+ {
243
+ "name": "organizationId",
244
+ "in": "path",
245
+ "required": true,
246
+ "style": "simple",
247
+ "explode": false,
248
+ "schema": {
249
+ "$ref": "#/components/schemas/OrganizationId"
250
+ }
251
+ },
252
+ {
253
+ "name": "objectType",
254
+ "in": "path",
255
+ "required": true,
256
+ "style": "simple",
257
+ "explode": false,
258
+ "schema": {
259
+ "type": "string",
260
+ "maxLength": 256,
261
+ "minLength": 1
262
+ }
263
+ }
264
+ ],
265
+ "requestBody": {
266
+ "content": {
267
+ "application/json": {
268
+ "schema": {
269
+ "$ref": "#/components/schemas/SearchRequest"
270
+ }
271
+ }
272
+ },
273
+ "required": true
274
+ },
275
+ "responses": {
276
+ "200": {
277
+ "description": "Successfully returned attribute definition search results",
278
+ "content": {
279
+ "application/json": {
280
+ "schema": {
281
+ "$ref": "#/components/schemas/ObjectAttributeDefinitionSearchResult"
282
+ }
283
+ }
284
+ }
285
+ },
286
+ "400": {
287
+ "description": "Field Not Sortable",
288
+ "content": {
289
+ "application/problem+json": {
290
+ "schema": {
291
+ "$ref": "#/components/schemas/ErrorResponse"
292
+ }
293
+ }
294
+ }
295
+ },
296
+ "401": {
297
+ "$ref": "#/components/responses/401unauthorized"
298
+ },
299
+ "403": {
300
+ "$ref": "#/components/responses/403forbidden"
301
+ },
302
+ "404": {
303
+ "description": "Object Type Not Found",
304
+ "content": {
305
+ "application/problem+json": {
306
+ "schema": {
307
+ "$ref": "#/components/schemas/ErrorResponse"
308
+ }
309
+ }
310
+ }
311
+ }
312
+ },
313
+ "security": [
314
+ {
315
+ "AmOAuth2": [
316
+ "sfcc.object-definitions.rw"
317
+ ]
318
+ }
319
+ ]
320
+ }
321
+ },
322
+ "/organizations/{organizationId}/system/object-types/{objectType}/attribute-group-search": {
323
+ "post": {
324
+ "operationId": "searchAttributeGroupsForSystemObject",
325
+ "parameters": [
326
+ {
327
+ "name": "organizationId",
328
+ "in": "path",
329
+ "required": true,
330
+ "style": "simple",
331
+ "explode": false,
332
+ "schema": {
333
+ "$ref": "#/components/schemas/OrganizationId"
334
+ }
335
+ },
336
+ {
337
+ "name": "objectType",
338
+ "in": "path",
339
+ "required": true,
340
+ "style": "simple",
341
+ "explode": false,
342
+ "schema": {
343
+ "type": "string",
344
+ "maxLength": 256,
345
+ "minLength": 1
346
+ }
347
+ }
348
+ ],
349
+ "requestBody": {
350
+ "content": {
351
+ "application/json": {
352
+ "schema": {
353
+ "$ref": "#/components/schemas/SearchRequest"
354
+ }
355
+ }
356
+ },
357
+ "required": true
358
+ },
359
+ "responses": {
360
+ "200": {
361
+ "description": "Successfully returned attribute group search results",
362
+ "content": {
363
+ "application/json": {
364
+ "schema": {
365
+ "$ref": "#/components/schemas/ObjectAttributeGroupSearchResult"
366
+ }
367
+ }
368
+ }
369
+ },
370
+ "400": {
371
+ "description": "Field Not Sortable",
372
+ "content": {
373
+ "application/problem+json": {
374
+ "schema": {
375
+ "$ref": "#/components/schemas/ErrorResponse"
376
+ }
377
+ }
378
+ }
379
+ },
380
+ "401": {
381
+ "$ref": "#/components/responses/401unauthorized"
382
+ },
383
+ "403": {
384
+ "$ref": "#/components/responses/403forbidden"
385
+ },
386
+ "404": {
387
+ "description": "Object Type Not Found",
388
+ "content": {
389
+ "application/problem+json": {
390
+ "schema": {
391
+ "$ref": "#/components/schemas/ErrorResponse"
392
+ }
393
+ }
394
+ }
395
+ }
396
+ },
397
+ "security": [
398
+ {
399
+ "AmOAuth2": [
400
+ "sfcc.object-definitions.rw"
401
+ ]
402
+ }
403
+ ]
404
+ }
405
+ },
406
+ "/organizations/{organizationId}/system/object-types/{objectType}/attribute-groups": {
407
+ "get": {
408
+ "operationId": "getAttributeGroups",
409
+ "parameters": [
410
+ {
411
+ "name": "organizationId",
412
+ "in": "path",
413
+ "required": true,
414
+ "style": "simple",
415
+ "explode": false,
416
+ "schema": {
417
+ "$ref": "#/components/schemas/OrganizationId"
418
+ }
419
+ },
420
+ {
421
+ "name": "objectType",
422
+ "in": "path",
423
+ "required": true,
424
+ "style": "simple",
425
+ "explode": false,
426
+ "schema": {
427
+ "type": "string",
428
+ "maxLength": 256,
429
+ "minLength": 1
430
+ }
431
+ },
432
+ {
433
+ "name": "select",
434
+ "in": "query",
435
+ "required": false,
436
+ "style": "form",
437
+ "explode": true,
438
+ "schema": {
439
+ "$ref": "#/components/schemas/Select"
440
+ }
441
+ },
442
+ {
443
+ "name": "expand",
444
+ "in": "query",
445
+ "required": false,
446
+ "style": "form",
447
+ "explode": true,
448
+ "schema": {
449
+ "type": "string",
450
+ "maxLength": 256
451
+ }
452
+ },
453
+ {
454
+ "name": "limit",
455
+ "in": "query",
456
+ "required": false,
457
+ "style": "form",
458
+ "explode": true,
459
+ "schema": {
460
+ "type": "integer",
461
+ "format": "int32",
462
+ "default": 25,
463
+ "maximum": 200,
464
+ "minimum": 1
465
+ }
466
+ },
467
+ {
468
+ "name": "offset",
469
+ "in": "query",
470
+ "required": false,
471
+ "style": "form",
472
+ "explode": true,
473
+ "schema": {
474
+ "type": "integer",
475
+ "format": "int32",
476
+ "default": 0,
477
+ "minimum": 0
478
+ }
479
+ }
480
+ ],
481
+ "responses": {
482
+ "200": {
483
+ "description": "Successfully returned attribute groups",
484
+ "content": {
485
+ "application/json": {
486
+ "schema": {
487
+ "$ref": "#/components/schemas/ObjectAttributeGroupResult"
488
+ }
489
+ }
490
+ }
491
+ },
492
+ "401": {
493
+ "$ref": "#/components/responses/401unauthorized"
494
+ },
495
+ "403": {
496
+ "$ref": "#/components/responses/403forbidden"
497
+ },
498
+ "404": {
499
+ "description": "Object Type Not Found",
500
+ "content": {
501
+ "application/problem+json": {
502
+ "schema": {
503
+ "$ref": "#/components/schemas/ErrorResponse"
504
+ }
505
+ }
506
+ }
507
+ }
508
+ },
509
+ "security": [
510
+ {
511
+ "AmOAuth2": [
512
+ "sfcc.object-definitions",
513
+ "sfcc.object-definitions.rw"
514
+ ]
515
+ }
516
+ ]
517
+ }
518
+ },
519
+ "/organizations/{organizationId}/system/object-types/{objectType}/attribute-groups/{id}": {
520
+ "get": {
521
+ "operationId": "getAttributeGroup",
522
+ "parameters": [
523
+ {
524
+ "name": "organizationId",
525
+ "in": "path",
526
+ "required": true,
527
+ "style": "simple",
528
+ "explode": false,
529
+ "schema": {
530
+ "$ref": "#/components/schemas/OrganizationId"
531
+ }
532
+ },
533
+ {
534
+ "name": "objectType",
535
+ "in": "path",
536
+ "required": true,
537
+ "style": "simple",
538
+ "explode": false,
539
+ "schema": {
540
+ "type": "string",
541
+ "maxLength": 256,
542
+ "minLength": 1
543
+ }
544
+ },
545
+ {
546
+ "name": "id",
547
+ "in": "path",
548
+ "required": true,
549
+ "style": "simple",
550
+ "explode": false,
551
+ "schema": {
552
+ "type": "string",
553
+ "maxLength": 256,
554
+ "minLength": 1
555
+ }
556
+ },
557
+ {
558
+ "name": "select",
559
+ "in": "query",
560
+ "required": false,
561
+ "style": "form",
562
+ "explode": true,
563
+ "schema": {
564
+ "$ref": "#/components/schemas/Select"
565
+ }
566
+ },
567
+ {
568
+ "name": "expand",
569
+ "in": "query",
570
+ "required": false,
571
+ "style": "form",
572
+ "explode": true,
573
+ "schema": {
574
+ "type": "string",
575
+ "maxLength": 256
576
+ }
577
+ }
578
+ ],
579
+ "responses": {
580
+ "200": {
581
+ "description": "Successfully returned the attribute group",
582
+ "content": {
583
+ "application/json": {
584
+ "schema": {
585
+ "$ref": "#/components/schemas/ObjectAttributeGroup"
586
+ }
587
+ }
588
+ }
589
+ },
590
+ "401": {
591
+ "$ref": "#/components/responses/401unauthorized"
592
+ },
593
+ "403": {
594
+ "$ref": "#/components/responses/403forbidden"
595
+ },
596
+ "404": {
597
+ "description": "Attribute Group Not Found",
598
+ "content": {
599
+ "application/problem+json": {
600
+ "schema": {
601
+ "$ref": "#/components/schemas/ErrorResponse"
602
+ }
603
+ }
604
+ }
605
+ }
606
+ },
607
+ "security": [
608
+ {
609
+ "AmOAuth2": [
610
+ "sfcc.object-definitions",
611
+ "sfcc.object-definitions.rw"
612
+ ]
613
+ }
614
+ ]
615
+ },
616
+ "put": {
617
+ "operationId": "createOrReplaceAttributeGroup",
618
+ "parameters": [
619
+ {
620
+ "name": "organizationId",
621
+ "in": "path",
622
+ "required": true,
623
+ "style": "simple",
624
+ "explode": false,
625
+ "schema": {
626
+ "$ref": "#/components/schemas/OrganizationId"
627
+ }
628
+ },
629
+ {
630
+ "name": "objectType",
631
+ "in": "path",
632
+ "required": true,
633
+ "style": "simple",
634
+ "explode": false,
635
+ "schema": {
636
+ "type": "string",
637
+ "maxLength": 256,
638
+ "minLength": 1
639
+ }
640
+ },
641
+ {
642
+ "name": "id",
643
+ "in": "path",
644
+ "required": true,
645
+ "style": "simple",
646
+ "explode": false,
647
+ "schema": {
648
+ "type": "string",
649
+ "maxLength": 256,
650
+ "minLength": 1
651
+ }
652
+ }
653
+ ],
654
+ "requestBody": {
655
+ "content": {
656
+ "application/json": {
657
+ "schema": {
658
+ "$ref": "#/components/schemas/ObjectAttributeGroup"
659
+ }
660
+ }
661
+ },
662
+ "required": true
663
+ },
664
+ "responses": {
665
+ "200": {
666
+ "description": "Successfully replaced the attribute group",
667
+ "content": {
668
+ "application/json": {
669
+ "schema": {
670
+ "$ref": "#/components/schemas/ObjectAttributeGroup"
671
+ }
672
+ }
673
+ }
674
+ },
675
+ "201": {
676
+ "description": "Successfully created the attribute group",
677
+ "content": {
678
+ "application/json": {
679
+ "schema": {
680
+ "$ref": "#/components/schemas/ObjectAttributeGroup"
681
+ }
682
+ }
683
+ }
684
+ },
685
+ "400": {
686
+ "description": "Invalid Request",
687
+ "content": {
688
+ "application/problem+json": {
689
+ "schema": {
690
+ "$ref": "#/components/schemas/ErrorResponse"
691
+ }
692
+ }
693
+ }
694
+ },
695
+ "401": {
696
+ "$ref": "#/components/responses/401unauthorized"
697
+ },
698
+ "403": {
699
+ "$ref": "#/components/responses/403forbidden"
700
+ },
701
+ "404": {
702
+ "description": "Object Type Not Found",
703
+ "content": {
704
+ "application/problem+json": {
705
+ "schema": {
706
+ "$ref": "#/components/schemas/ErrorResponse"
707
+ }
708
+ }
709
+ }
710
+ }
711
+ },
712
+ "security": [
713
+ {
714
+ "AmOAuth2": [
715
+ "sfcc.object-definitions.rw"
716
+ ]
717
+ }
718
+ ]
719
+ },
720
+ "delete": {
721
+ "operationId": "deleteAttributeGroup",
722
+ "parameters": [
723
+ {
724
+ "name": "organizationId",
725
+ "in": "path",
726
+ "required": true,
727
+ "style": "simple",
728
+ "explode": false,
729
+ "schema": {
730
+ "$ref": "#/components/schemas/OrganizationId"
731
+ }
732
+ },
733
+ {
734
+ "name": "objectType",
735
+ "in": "path",
736
+ "required": true,
737
+ "style": "simple",
738
+ "explode": false,
739
+ "schema": {
740
+ "type": "string",
741
+ "maxLength": 256,
742
+ "minLength": 1
743
+ }
744
+ },
745
+ {
746
+ "name": "id",
747
+ "in": "path",
748
+ "required": true,
749
+ "style": "simple",
750
+ "explode": false,
751
+ "schema": {
752
+ "type": "string",
753
+ "maxLength": 256,
754
+ "minLength": 1
755
+ }
756
+ }
757
+ ],
758
+ "responses": {
759
+ "204": {
760
+ "description": "Successfully deleted the attribute group"
761
+ },
762
+ "401": {
763
+ "$ref": "#/components/responses/401unauthorized"
764
+ },
765
+ "403": {
766
+ "$ref": "#/components/responses/403forbidden"
767
+ },
768
+ "404": {
769
+ "description": "Attribute Group Not Found",
770
+ "content": {
771
+ "application/problem+json": {
772
+ "schema": {
773
+ "$ref": "#/components/schemas/ErrorResponse"
774
+ }
775
+ }
776
+ }
777
+ }
778
+ },
779
+ "security": [
780
+ {
781
+ "AmOAuth2": [
782
+ "sfcc.object-definitions.rw"
783
+ ]
784
+ }
785
+ ]
786
+ },
787
+ "patch": {
788
+ "operationId": "updateAttributeGroup",
789
+ "parameters": [
790
+ {
791
+ "name": "organizationId",
792
+ "in": "path",
793
+ "required": true,
794
+ "style": "simple",
795
+ "explode": false,
796
+ "schema": {
797
+ "$ref": "#/components/schemas/OrganizationId"
798
+ }
799
+ },
800
+ {
801
+ "name": "objectType",
802
+ "in": "path",
803
+ "required": true,
804
+ "style": "simple",
805
+ "explode": false,
806
+ "schema": {
807
+ "type": "string",
808
+ "maxLength": 256,
809
+ "minLength": 1
810
+ }
811
+ },
812
+ {
813
+ "name": "id",
814
+ "in": "path",
815
+ "required": true,
816
+ "style": "simple",
817
+ "explode": false,
818
+ "schema": {
819
+ "type": "string",
820
+ "maxLength": 256,
821
+ "minLength": 1
822
+ }
823
+ }
824
+ ],
825
+ "requestBody": {
826
+ "content": {
827
+ "application/json": {
828
+ "schema": {
829
+ "$ref": "#/components/schemas/ObjectAttributeGroup"
830
+ }
831
+ }
832
+ },
833
+ "required": true
834
+ },
835
+ "responses": {
836
+ "200": {
837
+ "description": "Successfully updated the attribute group",
838
+ "content": {
839
+ "application/json": {
840
+ "schema": {
841
+ "$ref": "#/components/schemas/ObjectAttributeGroup"
842
+ }
843
+ }
844
+ }
845
+ },
846
+ "400": {
847
+ "description": "Invalid Request",
848
+ "content": {
849
+ "application/problem+json": {
850
+ "schema": {
851
+ "$ref": "#/components/schemas/ErrorResponse"
852
+ }
853
+ }
854
+ }
855
+ },
856
+ "401": {
857
+ "$ref": "#/components/responses/401unauthorized"
858
+ },
859
+ "403": {
860
+ "$ref": "#/components/responses/403forbidden"
861
+ },
862
+ "404": {
863
+ "description": "Attribute Group Not Found",
864
+ "content": {
865
+ "application/problem+json": {
866
+ "schema": {
867
+ "$ref": "#/components/schemas/ErrorResponse"
868
+ }
869
+ }
870
+ }
871
+ }
872
+ },
873
+ "security": [
874
+ {
875
+ "AmOAuth2": [
876
+ "sfcc.object-definitions.rw"
877
+ ]
878
+ }
879
+ ]
880
+ }
881
+ },
882
+ "/organizations/{organizationId}/system/object-types/{objectType}/attribute-groups/{groupId}/attribute-definitions/{defId}": {
883
+ "put": {
884
+ "operationId": "assignAttributeDefinitionToGroup",
885
+ "parameters": [
886
+ {
887
+ "name": "organizationId",
888
+ "in": "path",
889
+ "required": true,
890
+ "style": "simple",
891
+ "explode": false,
892
+ "schema": {
893
+ "$ref": "#/components/schemas/OrganizationId"
894
+ }
895
+ },
896
+ {
897
+ "name": "objectType",
898
+ "in": "path",
899
+ "required": true,
900
+ "style": "simple",
901
+ "explode": false,
902
+ "schema": {
903
+ "type": "string",
904
+ "maxLength": 256,
905
+ "minLength": 1
906
+ }
907
+ },
908
+ {
909
+ "name": "groupId",
910
+ "in": "path",
911
+ "required": true,
912
+ "style": "simple",
913
+ "explode": false,
914
+ "schema": {
915
+ "type": "string",
916
+ "maxLength": 256,
917
+ "minLength": 1
918
+ }
919
+ },
920
+ {
921
+ "name": "defId",
922
+ "in": "path",
923
+ "required": true,
924
+ "style": "simple",
925
+ "explode": false,
926
+ "schema": {
927
+ "type": "string",
928
+ "maxLength": 256,
929
+ "minLength": 1
930
+ }
931
+ }
932
+ ],
933
+ "responses": {
934
+ "204": {
935
+ "description": "Successfully assigned the attribute definition to the group"
936
+ },
937
+ "401": {
938
+ "$ref": "#/components/responses/401unauthorized"
939
+ },
940
+ "403": {
941
+ "$ref": "#/components/responses/403forbidden"
942
+ },
943
+ "404": {
944
+ "description": "Resource Not Found",
945
+ "content": {
946
+ "application/problem+json": {
947
+ "schema": {
948
+ "$ref": "#/components/schemas/ErrorResponse"
949
+ }
950
+ }
951
+ }
952
+ }
953
+ },
954
+ "security": [
955
+ {
956
+ "AmOAuth2": [
957
+ "sfcc.object-definitions.rw"
958
+ ]
959
+ }
960
+ ]
961
+ },
962
+ "delete": {
963
+ "operationId": "unassignAttributeDefinitionFromGroup",
964
+ "parameters": [
965
+ {
966
+ "name": "organizationId",
967
+ "in": "path",
968
+ "required": true,
969
+ "style": "simple",
970
+ "explode": false,
971
+ "schema": {
972
+ "$ref": "#/components/schemas/OrganizationId"
973
+ }
974
+ },
975
+ {
976
+ "name": "objectType",
977
+ "in": "path",
978
+ "required": true,
979
+ "style": "simple",
980
+ "explode": false,
981
+ "schema": {
982
+ "type": "string",
983
+ "maxLength": 256,
984
+ "minLength": 1
985
+ }
986
+ },
987
+ {
988
+ "name": "groupId",
989
+ "in": "path",
990
+ "required": true,
991
+ "style": "simple",
992
+ "explode": false,
993
+ "schema": {
994
+ "type": "string",
995
+ "maxLength": 256,
996
+ "minLength": 1
997
+ }
998
+ },
999
+ {
1000
+ "name": "defId",
1001
+ "in": "path",
1002
+ "required": true,
1003
+ "style": "simple",
1004
+ "explode": false,
1005
+ "schema": {
1006
+ "type": "string",
1007
+ "maxLength": 256,
1008
+ "minLength": 1
1009
+ }
1010
+ }
1011
+ ],
1012
+ "responses": {
1013
+ "204": {
1014
+ "description": "Successfully unassigned the attribute definition from the group"
1015
+ },
1016
+ "401": {
1017
+ "$ref": "#/components/responses/401unauthorized"
1018
+ },
1019
+ "403": {
1020
+ "$ref": "#/components/responses/403forbidden"
1021
+ },
1022
+ "404": {
1023
+ "description": "Resource Not Found",
1024
+ "content": {
1025
+ "application/problem+json": {
1026
+ "schema": {
1027
+ "$ref": "#/components/schemas/ErrorResponse"
1028
+ }
1029
+ }
1030
+ }
1031
+ }
1032
+ },
1033
+ "security": [
1034
+ {
1035
+ "AmOAuth2": [
1036
+ "sfcc.object-definitions.rw"
1037
+ ]
1038
+ }
1039
+ ]
1040
+ }
1041
+ },
1042
+ "/organizations/{organizationId}/system/object-types/{objectType}/attribute-definitions": {
1043
+ "get": {
1044
+ "operationId": "getAttributeDefinitions",
1045
+ "parameters": [
1046
+ {
1047
+ "name": "organizationId",
1048
+ "in": "path",
1049
+ "required": true,
1050
+ "style": "simple",
1051
+ "explode": false,
1052
+ "schema": {
1053
+ "$ref": "#/components/schemas/OrganizationId"
1054
+ }
1055
+ },
1056
+ {
1057
+ "name": "objectType",
1058
+ "in": "path",
1059
+ "required": true,
1060
+ "style": "simple",
1061
+ "explode": false,
1062
+ "schema": {
1063
+ "type": "string",
1064
+ "maxLength": 256,
1065
+ "minLength": 1
1066
+ }
1067
+ },
1068
+ {
1069
+ "name": "select",
1070
+ "in": "query",
1071
+ "required": false,
1072
+ "style": "form",
1073
+ "explode": true,
1074
+ "schema": {
1075
+ "$ref": "#/components/schemas/Select"
1076
+ }
1077
+ },
1078
+ {
1079
+ "name": "limit",
1080
+ "in": "query",
1081
+ "required": false,
1082
+ "style": "form",
1083
+ "explode": true,
1084
+ "schema": {
1085
+ "type": "integer",
1086
+ "format": "int32",
1087
+ "default": 25,
1088
+ "maximum": 200,
1089
+ "minimum": 1
1090
+ }
1091
+ },
1092
+ {
1093
+ "name": "offset",
1094
+ "in": "query",
1095
+ "required": false,
1096
+ "style": "form",
1097
+ "explode": true,
1098
+ "schema": {
1099
+ "type": "integer",
1100
+ "format": "int32",
1101
+ "default": 0,
1102
+ "minimum": 0
1103
+ }
1104
+ }
1105
+ ],
1106
+ "responses": {
1107
+ "200": {
1108
+ "description": "Successfully returned attribute definitions",
1109
+ "content": {
1110
+ "application/json": {
1111
+ "schema": {
1112
+ "$ref": "#/components/schemas/ObjectAttributeDefinitionResult"
1113
+ }
1114
+ }
1115
+ }
1116
+ },
1117
+ "401": {
1118
+ "$ref": "#/components/responses/401unauthorized"
1119
+ },
1120
+ "403": {
1121
+ "$ref": "#/components/responses/403forbidden"
1122
+ },
1123
+ "404": {
1124
+ "description": "Object Type Not Found",
1125
+ "content": {
1126
+ "application/problem+json": {
1127
+ "schema": {
1128
+ "$ref": "#/components/schemas/ErrorResponse"
1129
+ }
1130
+ }
1131
+ }
1132
+ }
1133
+ },
1134
+ "security": [
1135
+ {
1136
+ "AmOAuth2": [
1137
+ "sfcc.object-definitions",
1138
+ "sfcc.object-definitions.rw"
1139
+ ]
1140
+ }
1141
+ ]
1142
+ }
1143
+ },
1144
+ "/organizations/{organizationId}/system/object-types/{objectType}/attribute-definitions/{id}": {
1145
+ "get": {
1146
+ "operationId": "getAttributeDefinition",
1147
+ "parameters": [
1148
+ {
1149
+ "name": "organizationId",
1150
+ "in": "path",
1151
+ "required": true,
1152
+ "style": "simple",
1153
+ "explode": false,
1154
+ "schema": {
1155
+ "$ref": "#/components/schemas/OrganizationId"
1156
+ }
1157
+ },
1158
+ {
1159
+ "name": "objectType",
1160
+ "in": "path",
1161
+ "required": true,
1162
+ "style": "simple",
1163
+ "explode": false,
1164
+ "schema": {
1165
+ "type": "string",
1166
+ "maxLength": 256,
1167
+ "minLength": 1
1168
+ }
1169
+ },
1170
+ {
1171
+ "name": "id",
1172
+ "in": "path",
1173
+ "required": true,
1174
+ "style": "simple",
1175
+ "explode": false,
1176
+ "schema": {
1177
+ "type": "string",
1178
+ "maxLength": 256,
1179
+ "minLength": 1
1180
+ }
1181
+ },
1182
+ {
1183
+ "name": "select",
1184
+ "in": "query",
1185
+ "required": false,
1186
+ "style": "form",
1187
+ "explode": true,
1188
+ "schema": {
1189
+ "$ref": "#/components/schemas/Select"
1190
+ }
1191
+ },
1192
+ {
1193
+ "name": "expand",
1194
+ "in": "query",
1195
+ "required": false,
1196
+ "style": "form",
1197
+ "explode": true,
1198
+ "schema": {
1199
+ "type": "string",
1200
+ "maxLength": 256
1201
+ }
1202
+ }
1203
+ ],
1204
+ "responses": {
1205
+ "200": {
1206
+ "description": "Successfully returned the attribute definition",
1207
+ "content": {
1208
+ "application/json": {
1209
+ "schema": {
1210
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
1211
+ }
1212
+ }
1213
+ }
1214
+ },
1215
+ "401": {
1216
+ "$ref": "#/components/responses/401unauthorized"
1217
+ },
1218
+ "403": {
1219
+ "$ref": "#/components/responses/403forbidden"
1220
+ },
1221
+ "404": {
1222
+ "description": "Attribute Definition Not Found",
1223
+ "content": {
1224
+ "application/problem+json": {
1225
+ "schema": {
1226
+ "$ref": "#/components/schemas/ErrorResponse"
1227
+ }
1228
+ }
1229
+ }
1230
+ }
1231
+ },
1232
+ "security": [
1233
+ {
1234
+ "AmOAuth2": [
1235
+ "sfcc.object-definitions",
1236
+ "sfcc.object-definitions.rw"
1237
+ ]
1238
+ }
1239
+ ]
1240
+ },
1241
+ "put": {
1242
+ "operationId": "createOrReplaceAttributeDefinition",
1243
+ "parameters": [
1244
+ {
1245
+ "name": "organizationId",
1246
+ "in": "path",
1247
+ "required": true,
1248
+ "style": "simple",
1249
+ "explode": false,
1250
+ "schema": {
1251
+ "$ref": "#/components/schemas/OrganizationId"
1252
+ }
1253
+ },
1254
+ {
1255
+ "name": "objectType",
1256
+ "in": "path",
1257
+ "required": true,
1258
+ "style": "simple",
1259
+ "explode": false,
1260
+ "schema": {
1261
+ "type": "string",
1262
+ "maxLength": 256,
1263
+ "minLength": 1
1264
+ }
1265
+ },
1266
+ {
1267
+ "name": "id",
1268
+ "in": "path",
1269
+ "required": true,
1270
+ "style": "simple",
1271
+ "explode": false,
1272
+ "schema": {
1273
+ "type": "string",
1274
+ "maxLength": 256,
1275
+ "minLength": 1
1276
+ }
1277
+ }
1278
+ ],
1279
+ "requestBody": {
1280
+ "content": {
1281
+ "application/json": {
1282
+ "schema": {
1283
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
1284
+ }
1285
+ }
1286
+ },
1287
+ "required": true
1288
+ },
1289
+ "responses": {
1290
+ "200": {
1291
+ "description": "Successfully replaced the attribute definition",
1292
+ "content": {
1293
+ "application/json": {
1294
+ "schema": {
1295
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
1296
+ }
1297
+ }
1298
+ }
1299
+ },
1300
+ "201": {
1301
+ "description": "Successfully created the attribute definition",
1302
+ "content": {
1303
+ "application/json": {
1304
+ "schema": {
1305
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
1306
+ }
1307
+ }
1308
+ }
1309
+ },
1310
+ "400": {
1311
+ "description": "Invalid Request",
1312
+ "content": {
1313
+ "application/problem+json": {
1314
+ "schema": {
1315
+ "$ref": "#/components/schemas/ErrorResponse"
1316
+ }
1317
+ }
1318
+ }
1319
+ },
1320
+ "401": {
1321
+ "$ref": "#/components/responses/401unauthorized"
1322
+ },
1323
+ "403": {
1324
+ "$ref": "#/components/responses/403forbidden"
1325
+ },
1326
+ "404": {
1327
+ "description": "Object Type Not Found",
1328
+ "content": {
1329
+ "application/problem+json": {
1330
+ "schema": {
1331
+ "$ref": "#/components/schemas/ErrorResponse"
1332
+ }
1333
+ }
1334
+ }
1335
+ }
1336
+ },
1337
+ "security": [
1338
+ {
1339
+ "AmOAuth2": [
1340
+ "sfcc.object-definitions.rw"
1341
+ ]
1342
+ }
1343
+ ]
1344
+ },
1345
+ "delete": {
1346
+ "operationId": "deleteAttributeDefinition",
1347
+ "parameters": [
1348
+ {
1349
+ "name": "organizationId",
1350
+ "in": "path",
1351
+ "required": true,
1352
+ "style": "simple",
1353
+ "explode": false,
1354
+ "schema": {
1355
+ "$ref": "#/components/schemas/OrganizationId"
1356
+ }
1357
+ },
1358
+ {
1359
+ "name": "objectType",
1360
+ "in": "path",
1361
+ "required": true,
1362
+ "style": "simple",
1363
+ "explode": false,
1364
+ "schema": {
1365
+ "type": "string",
1366
+ "maxLength": 256,
1367
+ "minLength": 1
1368
+ }
1369
+ },
1370
+ {
1371
+ "name": "id",
1372
+ "in": "path",
1373
+ "required": true,
1374
+ "style": "simple",
1375
+ "explode": false,
1376
+ "schema": {
1377
+ "type": "string",
1378
+ "maxLength": 256,
1379
+ "minLength": 1
1380
+ }
1381
+ }
1382
+ ],
1383
+ "responses": {
1384
+ "204": {
1385
+ "description": "Successfully deleted the attribute definition"
1386
+ },
1387
+ "401": {
1388
+ "$ref": "#/components/responses/401unauthorized"
1389
+ },
1390
+ "403": {
1391
+ "$ref": "#/components/responses/403forbidden"
1392
+ },
1393
+ "404": {
1394
+ "description": "Attribute Definition Not Found",
1395
+ "content": {
1396
+ "application/problem+json": {
1397
+ "schema": {
1398
+ "$ref": "#/components/schemas/ErrorResponse"
1399
+ }
1400
+ }
1401
+ }
1402
+ }
1403
+ },
1404
+ "security": [
1405
+ {
1406
+ "AmOAuth2": [
1407
+ "sfcc.object-definitions.rw"
1408
+ ]
1409
+ }
1410
+ ]
1411
+ },
1412
+ "patch": {
1413
+ "operationId": "updateAttributeDefinition",
1414
+ "parameters": [
1415
+ {
1416
+ "name": "organizationId",
1417
+ "in": "path",
1418
+ "required": true,
1419
+ "style": "simple",
1420
+ "explode": false,
1421
+ "schema": {
1422
+ "$ref": "#/components/schemas/OrganizationId"
1423
+ }
1424
+ },
1425
+ {
1426
+ "name": "objectType",
1427
+ "in": "path",
1428
+ "required": true,
1429
+ "style": "simple",
1430
+ "explode": false,
1431
+ "schema": {
1432
+ "type": "string",
1433
+ "maxLength": 256,
1434
+ "minLength": 1
1435
+ }
1436
+ },
1437
+ {
1438
+ "name": "id",
1439
+ "in": "path",
1440
+ "required": true,
1441
+ "style": "simple",
1442
+ "explode": false,
1443
+ "schema": {
1444
+ "type": "string",
1445
+ "maxLength": 256,
1446
+ "minLength": 1
1447
+ }
1448
+ }
1449
+ ],
1450
+ "requestBody": {
1451
+ "content": {
1452
+ "application/json": {
1453
+ "schema": {
1454
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
1455
+ }
1456
+ }
1457
+ },
1458
+ "required": true
1459
+ },
1460
+ "responses": {
1461
+ "200": {
1462
+ "description": "Successfully updated the attribute definition",
1463
+ "content": {
1464
+ "application/json": {
1465
+ "schema": {
1466
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
1467
+ }
1468
+ }
1469
+ }
1470
+ },
1471
+ "400": {
1472
+ "description": "Invalid Request",
1473
+ "content": {
1474
+ "application/problem+json": {
1475
+ "schema": {
1476
+ "$ref": "#/components/schemas/ErrorResponse"
1477
+ }
1478
+ }
1479
+ }
1480
+ },
1481
+ "401": {
1482
+ "$ref": "#/components/responses/401unauthorized"
1483
+ },
1484
+ "403": {
1485
+ "$ref": "#/components/responses/403forbidden"
1486
+ },
1487
+ "404": {
1488
+ "description": "Attribute Definition Not Found",
1489
+ "content": {
1490
+ "application/problem+json": {
1491
+ "schema": {
1492
+ "$ref": "#/components/schemas/ErrorResponse"
1493
+ }
1494
+ }
1495
+ }
1496
+ }
1497
+ },
1498
+ "security": [
1499
+ {
1500
+ "AmOAuth2": [
1501
+ "sfcc.object-definitions.rw"
1502
+ ]
1503
+ }
1504
+ ]
1505
+ }
1506
+ }
1507
+ },
1508
+ "components": {
1509
+ "schemas": {
1510
+ "OrganizationId": {
1511
+ "type": "string",
1512
+ "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
1513
+ },
1514
+ "Select": {
1515
+ "type": "string",
1516
+ "minLength": 1,
1517
+ "pattern": "^[(].*[)]$"
1518
+ },
1519
+ "Total": {
1520
+ "type": "integer",
1521
+ "format": "int32",
1522
+ "default": 0,
1523
+ "minimum": 0
1524
+ },
1525
+ "ResultBase": {
1526
+ "type": "object",
1527
+ "properties": {
1528
+ "limit": {
1529
+ "type": "integer",
1530
+ "format": "int32"
1531
+ },
1532
+ "total": {
1533
+ "$ref": "#/components/schemas/Total"
1534
+ }
1535
+ },
1536
+ "required": [
1537
+ "limit",
1538
+ "total"
1539
+ ]
1540
+ },
1541
+ "Offset": {
1542
+ "type": "integer",
1543
+ "format": "int32",
1544
+ "default": 0,
1545
+ "minimum": 0
1546
+ },
1547
+ "PaginatedResultBase": {
1548
+ "allOf": [
1549
+ {
1550
+ "$ref": "#/components/schemas/ResultBase"
1551
+ }
1552
+ ],
1553
+ "properties": {
1554
+ "offset": {
1555
+ "$ref": "#/components/schemas/Offset"
1556
+ }
1557
+ },
1558
+ "required": [
1559
+ "limit",
1560
+ "offset",
1561
+ "total"
1562
+ ]
1563
+ },
1564
+ "ObjectTypeDefinition": {
1565
+ "type": "object",
1566
+ "properties": {
1567
+ "objectType": {
1568
+ "type": "string",
1569
+ "maxLength": 256
1570
+ },
1571
+ "displayName": {
1572
+ "type": "object",
1573
+ "additionalProperties": {
1574
+ "type": "string",
1575
+ "maxLength": 4000
1576
+ }
1577
+ },
1578
+ "description": {
1579
+ "type": "object",
1580
+ "additionalProperties": {
1581
+ "type": "string",
1582
+ "maxLength": 4000
1583
+ }
1584
+ },
1585
+ "readOnly": {
1586
+ "type": "boolean",
1587
+ "readOnly": true
1588
+ },
1589
+ "queryable": {
1590
+ "type": "boolean"
1591
+ },
1592
+ "searchable": {
1593
+ "type": "boolean"
1594
+ },
1595
+ "contentObject": {
1596
+ "type": "boolean"
1597
+ },
1598
+ "attributeDefinitionCount": {
1599
+ "type": "integer",
1600
+ "format": "int32",
1601
+ "readOnly": true
1602
+ },
1603
+ "attributeGroupCount": {
1604
+ "type": "integer",
1605
+ "format": "int32",
1606
+ "readOnly": true
1607
+ }
1608
+ }
1609
+ },
1610
+ "ObjectTypeDefinitionResult": {
1611
+ "allOf": [
1612
+ {
1613
+ "$ref": "#/components/schemas/PaginatedResultBase"
1614
+ }
1615
+ ],
1616
+ "properties": {
1617
+ "data": {
1618
+ "type": "array",
1619
+ "items": {
1620
+ "$ref": "#/components/schemas/ObjectTypeDefinition"
1621
+ }
1622
+ }
1623
+ }
1624
+ },
1625
+ "ErrorResponse": {
1626
+ "type": "object",
1627
+ "additionalProperties": true,
1628
+ "properties": {
1629
+ "title": {
1630
+ "type": "string",
1631
+ "maxLength": 256
1632
+ },
1633
+ "type": {
1634
+ "type": "string",
1635
+ "maxLength": 2048
1636
+ },
1637
+ "detail": {
1638
+ "type": "string"
1639
+ },
1640
+ "instance": {
1641
+ "type": "string",
1642
+ "maxLength": 2048
1643
+ }
1644
+ },
1645
+ "required": [
1646
+ "detail",
1647
+ "title",
1648
+ "type"
1649
+ ]
1650
+ },
1651
+ "Query": {
1652
+ "type": "object",
1653
+ "additionalProperties": false,
1654
+ "maxProperties": 1,
1655
+ "minProperties": 1,
1656
+ "properties": {
1657
+ "boolQuery": {
1658
+ "$ref": "#/components/schemas/BoolQuery"
1659
+ },
1660
+ "filteredQuery": {
1661
+ "$ref": "#/components/schemas/FilteredQuery"
1662
+ },
1663
+ "matchAllQuery": {
1664
+ "$ref": "#/components/schemas/MatchAllQuery"
1665
+ },
1666
+ "nestedQuery": {
1667
+ "$ref": "#/components/schemas/NestedQuery"
1668
+ },
1669
+ "termQuery": {
1670
+ "$ref": "#/components/schemas/TermQuery"
1671
+ },
1672
+ "textQuery": {
1673
+ "$ref": "#/components/schemas/TextQuery"
1674
+ }
1675
+ }
1676
+ },
1677
+ "BoolQuery": {
1678
+ "type": "object",
1679
+ "additionalProperties": false,
1680
+ "properties": {
1681
+ "must": {
1682
+ "type": "array",
1683
+ "items": {
1684
+ "$ref": "#/components/schemas/Query"
1685
+ }
1686
+ },
1687
+ "mustNot": {
1688
+ "type": "array",
1689
+ "items": {
1690
+ "$ref": "#/components/schemas/Query"
1691
+ }
1692
+ },
1693
+ "should": {
1694
+ "type": "array",
1695
+ "items": {
1696
+ "$ref": "#/components/schemas/Query"
1697
+ }
1698
+ }
1699
+ }
1700
+ },
1701
+ "Filter": {
1702
+ "type": "object",
1703
+ "additionalProperties": false,
1704
+ "maxProperties": 1,
1705
+ "minProperties": 1,
1706
+ "properties": {
1707
+ "boolFilter": {
1708
+ "$ref": "#/components/schemas/BoolFilter"
1709
+ },
1710
+ "queryFilter": {
1711
+ "$ref": "#/components/schemas/QueryFilter"
1712
+ },
1713
+ "range2Filter": {
1714
+ "$ref": "#/components/schemas/Range2Filter"
1715
+ },
1716
+ "rangeFilter": {
1717
+ "$ref": "#/components/schemas/RangeFilter"
1718
+ },
1719
+ "termFilter": {
1720
+ "$ref": "#/components/schemas/TermFilter"
1721
+ }
1722
+ }
1723
+ },
1724
+ "BoolFilter": {
1725
+ "type": "object",
1726
+ "additionalProperties": false,
1727
+ "properties": {
1728
+ "filters": {
1729
+ "type": "array",
1730
+ "items": {
1731
+ "$ref": "#/components/schemas/Filter"
1732
+ }
1733
+ },
1734
+ "operator": {
1735
+ "type": "string",
1736
+ "enum": [
1737
+ "and",
1738
+ "or",
1739
+ "not"
1740
+ ]
1741
+ }
1742
+ },
1743
+ "required": [
1744
+ "operator"
1745
+ ]
1746
+ },
1747
+ "QueryFilter": {
1748
+ "type": "object",
1749
+ "properties": {
1750
+ "query": {
1751
+ "$ref": "#/components/schemas/Query"
1752
+ }
1753
+ },
1754
+ "required": [
1755
+ "query"
1756
+ ]
1757
+ },
1758
+ "Field": {
1759
+ "type": "string",
1760
+ "maxLength": 260
1761
+ },
1762
+ "Range2Filter": {
1763
+ "type": "object",
1764
+ "additionalProperties": false,
1765
+ "properties": {
1766
+ "filterMode": {
1767
+ "type": "string",
1768
+ "default": "overlap",
1769
+ "enum": [
1770
+ "overlap",
1771
+ "containing",
1772
+ "contained"
1773
+ ]
1774
+ },
1775
+ "fromField": {
1776
+ "allOf": [
1777
+ {
1778
+ "$ref": "#/components/schemas/Field"
1779
+ }
1780
+ ]
1781
+ },
1782
+ "fromInclusive": {
1783
+ "type": "boolean",
1784
+ "default": true
1785
+ },
1786
+ "fromValue": {},
1787
+ "toField": {
1788
+ "allOf": [
1789
+ {
1790
+ "$ref": "#/components/schemas/Field"
1791
+ }
1792
+ ]
1793
+ },
1794
+ "toInclusive": {
1795
+ "type": "boolean",
1796
+ "default": true
1797
+ },
1798
+ "toValue": {}
1799
+ },
1800
+ "required": [
1801
+ "fromField",
1802
+ "toField"
1803
+ ]
1804
+ },
1805
+ "RangeFilter": {
1806
+ "type": "object",
1807
+ "properties": {
1808
+ "field": {
1809
+ "allOf": [
1810
+ {
1811
+ "$ref": "#/components/schemas/Field"
1812
+ }
1813
+ ]
1814
+ },
1815
+ "from": {
1816
+ "oneOf": [
1817
+ {
1818
+ "type": "string",
1819
+ "format": "date-time"
1820
+ },
1821
+ {
1822
+ "type": "integer"
1823
+ },
1824
+ {
1825
+ "type": "number"
1826
+ }
1827
+ ]
1828
+ },
1829
+ "fromInclusive": {
1830
+ "type": "boolean",
1831
+ "default": true
1832
+ },
1833
+ "to": {
1834
+ "oneOf": [
1835
+ {
1836
+ "type": "string",
1837
+ "format": "date-time"
1838
+ },
1839
+ {
1840
+ "type": "integer"
1841
+ },
1842
+ {
1843
+ "type": "number"
1844
+ }
1845
+ ]
1846
+ },
1847
+ "toInclusive": {
1848
+ "type": "boolean",
1849
+ "default": true
1850
+ }
1851
+ },
1852
+ "required": [
1853
+ "field"
1854
+ ]
1855
+ },
1856
+ "TermFilter": {
1857
+ "type": "object",
1858
+ "additionalProperties": false,
1859
+ "properties": {
1860
+ "field": {
1861
+ "allOf": [
1862
+ {
1863
+ "$ref": "#/components/schemas/Field"
1864
+ }
1865
+ ]
1866
+ },
1867
+ "operator": {
1868
+ "type": "string",
1869
+ "enum": [
1870
+ "is",
1871
+ "one_of",
1872
+ "is_null",
1873
+ "is_not_null",
1874
+ "less",
1875
+ "greater",
1876
+ "not_in",
1877
+ "neq"
1878
+ ]
1879
+ },
1880
+ "values": {
1881
+ "type": "array",
1882
+ "items": {
1883
+ "type": "string"
1884
+ }
1885
+ }
1886
+ },
1887
+ "required": [
1888
+ "field",
1889
+ "operator"
1890
+ ]
1891
+ },
1892
+ "FilteredQuery": {
1893
+ "type": "object",
1894
+ "additionalProperties": false,
1895
+ "properties": {
1896
+ "filter": {
1897
+ "$ref": "#/components/schemas/Filter"
1898
+ },
1899
+ "query": {
1900
+ "$ref": "#/components/schemas/Query"
1901
+ }
1902
+ },
1903
+ "required": [
1904
+ "filter",
1905
+ "query"
1906
+ ]
1907
+ },
1908
+ "MatchAllQuery": {
1909
+ "type": "object"
1910
+ },
1911
+ "NestedQuery": {
1912
+ "type": "object",
1913
+ "additionalProperties": false,
1914
+ "properties": {
1915
+ "path": {
1916
+ "type": "string",
1917
+ "maxLength": 2048
1918
+ },
1919
+ "query": {
1920
+ "$ref": "#/components/schemas/Query"
1921
+ },
1922
+ "scoreMode": {
1923
+ "type": "string",
1924
+ "enum": [
1925
+ "avg",
1926
+ "total",
1927
+ "max",
1928
+ "none"
1929
+ ]
1930
+ }
1931
+ },
1932
+ "required": [
1933
+ "path",
1934
+ "query"
1935
+ ]
1936
+ },
1937
+ "TermQuery": {
1938
+ "type": "object",
1939
+ "properties": {
1940
+ "fields": {
1941
+ "type": "array",
1942
+ "items": {
1943
+ "$ref": "#/components/schemas/Field"
1944
+ },
1945
+ "minItems": 1
1946
+ },
1947
+ "operator": {
1948
+ "type": "string",
1949
+ "enum": [
1950
+ "is",
1951
+ "one_of",
1952
+ "is_null",
1953
+ "is_not_null",
1954
+ "less",
1955
+ "greater",
1956
+ "not_in",
1957
+ "neq"
1958
+ ]
1959
+ },
1960
+ "values": {
1961
+ "type": "array",
1962
+ "items": {
1963
+ "oneOf": [
1964
+ {
1965
+ "type": "string"
1966
+ },
1967
+ {
1968
+ "type": "number"
1969
+ },
1970
+ {
1971
+ "type": "boolean"
1972
+ },
1973
+ {
1974
+ "type": "integer"
1975
+ }
1976
+ ]
1977
+ }
1978
+ }
1979
+ },
1980
+ "required": [
1981
+ "fields",
1982
+ "operator"
1983
+ ]
1984
+ },
1985
+ "TextQuery": {
1986
+ "type": "object",
1987
+ "additionalProperties": false,
1988
+ "properties": {
1989
+ "fields": {
1990
+ "type": "array",
1991
+ "items": {
1992
+ "$ref": "#/components/schemas/Field"
1993
+ },
1994
+ "minItems": 1
1995
+ },
1996
+ "searchPhrase": {
1997
+ "type": "string"
1998
+ }
1999
+ },
2000
+ "required": [
2001
+ "fields",
2002
+ "searchPhrase"
2003
+ ]
2004
+ },
2005
+ "Sort": {
2006
+ "type": "object",
2007
+ "additionalProperties": false,
2008
+ "properties": {
2009
+ "field": {
2010
+ "type": "string",
2011
+ "maxLength": 256
2012
+ },
2013
+ "sortOrder": {
2014
+ "type": "string",
2015
+ "default": "asc",
2016
+ "enum": [
2017
+ "asc",
2018
+ "desc"
2019
+ ]
2020
+ }
2021
+ },
2022
+ "required": [
2023
+ "field"
2024
+ ]
2025
+ },
2026
+ "SearchRequest": {
2027
+ "type": "object",
2028
+ "properties": {
2029
+ "limit": {
2030
+ "type": "integer",
2031
+ "format": "int32",
2032
+ "maximum": 200,
2033
+ "minimum": 1
2034
+ },
2035
+ "query": {
2036
+ "$ref": "#/components/schemas/Query"
2037
+ },
2038
+ "sorts": {
2039
+ "type": "array",
2040
+ "items": {
2041
+ "$ref": "#/components/schemas/Sort"
2042
+ }
2043
+ },
2044
+ "offset": {
2045
+ "$ref": "#/components/schemas/Offset"
2046
+ }
2047
+ },
2048
+ "required": [
2049
+ "query"
2050
+ ]
2051
+ },
2052
+ "ObjectTypeDefinitionSearchResult": {
2053
+ "allOf": [
2054
+ {
2055
+ "$ref": "#/components/schemas/PaginatedResultBase"
2056
+ }
2057
+ ],
2058
+ "properties": {
2059
+ "hits": {
2060
+ "type": "array",
2061
+ "items": {
2062
+ "$ref": "#/components/schemas/ObjectTypeDefinition"
2063
+ }
2064
+ }
2065
+ },
2066
+ "required": [
2067
+ "hits"
2068
+ ]
2069
+ },
2070
+ "ValueType": {
2071
+ "type": "string",
2072
+ "enum": [
2073
+ "string",
2074
+ "int",
2075
+ "double",
2076
+ "text",
2077
+ "html",
2078
+ "date",
2079
+ "image",
2080
+ "boolean",
2081
+ "money",
2082
+ "quantity",
2083
+ "datetime",
2084
+ "email",
2085
+ "password",
2086
+ "set_of_string",
2087
+ "set_of_int",
2088
+ "set_of_double",
2089
+ "enum_of_string",
2090
+ "enum_of_int"
2091
+ ]
2092
+ },
2093
+ "ObjectAttributeValueDefinition": {
2094
+ "type": "object",
2095
+ "properties": {
2096
+ "id": {
2097
+ "type": "string",
2098
+ "maxLength": 256,
2099
+ "readOnly": true
2100
+ },
2101
+ "value": {
2102
+ "type": "string",
2103
+ "maxLength": 4000,
2104
+ "readOnly": true
2105
+ },
2106
+ "displayValue": {
2107
+ "type": "object",
2108
+ "additionalProperties": {
2109
+ "type": "string",
2110
+ "maxLength": 4000
2111
+ },
2112
+ "readOnly": true
2113
+ },
2114
+ "description": {
2115
+ "type": "object",
2116
+ "additionalProperties": {
2117
+ "type": "string",
2118
+ "maxLength": 4000
2119
+ },
2120
+ "readOnly": true
2121
+ },
2122
+ "position": {
2123
+ "type": "number",
2124
+ "format": "double",
2125
+ "readOnly": true
2126
+ }
2127
+ }
2128
+ },
2129
+ "ObjectAttributeDefinition": {
2130
+ "type": "object",
2131
+ "properties": {
2132
+ "id": {
2133
+ "type": "string",
2134
+ "maxLength": 256,
2135
+ "minLength": 1
2136
+ },
2137
+ "effectiveId": {
2138
+ "type": "string",
2139
+ "maxLength": 256,
2140
+ "readOnly": true
2141
+ },
2142
+ "displayName": {
2143
+ "type": "object",
2144
+ "additionalProperties": {
2145
+ "type": "string",
2146
+ "maxLength": 4000
2147
+ }
2148
+ },
2149
+ "description": {
2150
+ "type": "object",
2151
+ "additionalProperties": {
2152
+ "type": "string",
2153
+ "maxLength": 4000
2154
+ }
2155
+ },
2156
+ "key": {
2157
+ "type": "boolean"
2158
+ },
2159
+ "mandatory": {
2160
+ "type": "boolean"
2161
+ },
2162
+ "localizable": {
2163
+ "type": "boolean"
2164
+ },
2165
+ "siteSpecific": {
2166
+ "type": "boolean"
2167
+ },
2168
+ "searchable": {
2169
+ "type": "boolean"
2170
+ },
2171
+ "queryable": {
2172
+ "type": "boolean",
2173
+ "readOnly": true
2174
+ },
2175
+ "valueType": {
2176
+ "$ref": "#/components/schemas/ValueType"
2177
+ },
2178
+ "visible": {
2179
+ "type": "boolean"
2180
+ },
2181
+ "system": {
2182
+ "type": "boolean"
2183
+ },
2184
+ "unit": {
2185
+ "type": "object",
2186
+ "additionalProperties": {
2187
+ "type": "string",
2188
+ "maxLength": 4000
2189
+ }
2190
+ },
2191
+ "requiresEncoding": {
2192
+ "type": "boolean",
2193
+ "readOnly": true
2194
+ },
2195
+ "multiValueType": {
2196
+ "type": "boolean"
2197
+ },
2198
+ "setValueType": {
2199
+ "type": "boolean",
2200
+ "readOnly": true
2201
+ },
2202
+ "externallyManaged": {
2203
+ "type": "boolean"
2204
+ },
2205
+ "externallyDefined": {
2206
+ "type": "boolean"
2207
+ },
2208
+ "orderRequired": {
2209
+ "type": "boolean"
2210
+ },
2211
+ "regularExpression": {
2212
+ "type": "string",
2213
+ "maxLength": 4000,
2214
+ "readOnly": true
2215
+ },
2216
+ "fieldLength": {
2217
+ "type": "integer",
2218
+ "format": "int32",
2219
+ "readOnly": true
2220
+ },
2221
+ "fieldHeight": {
2222
+ "type": "integer",
2223
+ "format": "int32",
2224
+ "readOnly": true
2225
+ },
2226
+ "minLength": {
2227
+ "type": "integer",
2228
+ "format": "int32",
2229
+ "readOnly": true
2230
+ },
2231
+ "readOnly": {
2232
+ "type": "boolean",
2233
+ "readOnly": true
2234
+ },
2235
+ "minValue": {
2236
+ "type": "number",
2237
+ "format": "double",
2238
+ "readOnly": true
2239
+ },
2240
+ "maxValue": {
2241
+ "type": "number",
2242
+ "format": "double",
2243
+ "readOnly": true
2244
+ },
2245
+ "scale": {
2246
+ "type": "integer",
2247
+ "format": "int32",
2248
+ "readOnly": true
2249
+ },
2250
+ "defaultValue": {
2251
+ "allOf": [
2252
+ {
2253
+ "$ref": "#/components/schemas/ObjectAttributeValueDefinition"
2254
+ }
2255
+ ]
2256
+ },
2257
+ "valueDefinitions": {
2258
+ "type": "array",
2259
+ "items": {
2260
+ "$ref": "#/components/schemas/ObjectAttributeValueDefinition"
2261
+ },
2262
+ "readOnly": true
2263
+ },
2264
+ "creationDate": {
2265
+ "type": "string",
2266
+ "format": "date-time",
2267
+ "readOnly": true
2268
+ },
2269
+ "lastModified": {
2270
+ "type": "string",
2271
+ "format": "date-time",
2272
+ "readOnly": true
2273
+ }
2274
+ },
2275
+ "required": [
2276
+ "id"
2277
+ ]
2278
+ },
2279
+ "ObjectAttributeDefinitionSearchResult": {
2280
+ "allOf": [
2281
+ {
2282
+ "$ref": "#/components/schemas/PaginatedResultBase"
2283
+ }
2284
+ ],
2285
+ "properties": {
2286
+ "hits": {
2287
+ "type": "array",
2288
+ "items": {
2289
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
2290
+ }
2291
+ }
2292
+ },
2293
+ "required": [
2294
+ "hits"
2295
+ ]
2296
+ },
2297
+ "ObjectAttributeGroup": {
2298
+ "type": "object",
2299
+ "properties": {
2300
+ "id": {
2301
+ "type": "string",
2302
+ "maxLength": 256,
2303
+ "minLength": 1
2304
+ },
2305
+ "displayName": {
2306
+ "type": "object",
2307
+ "additionalProperties": {
2308
+ "type": "string",
2309
+ "maxLength": 4000
2310
+ }
2311
+ },
2312
+ "description": {
2313
+ "type": "object",
2314
+ "additionalProperties": {
2315
+ "type": "string",
2316
+ "maxLength": 4000
2317
+ }
2318
+ },
2319
+ "position": {
2320
+ "type": "number",
2321
+ "format": "double"
2322
+ },
2323
+ "internal": {
2324
+ "type": "boolean",
2325
+ "readOnly": true
2326
+ },
2327
+ "attributeDefinitionsCount": {
2328
+ "type": "integer",
2329
+ "format": "int32",
2330
+ "readOnly": true
2331
+ },
2332
+ "attributeDefinitions": {
2333
+ "type": "array",
2334
+ "items": {
2335
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
2336
+ }
2337
+ },
2338
+ "creationDate": {
2339
+ "type": "string",
2340
+ "format": "date-time",
2341
+ "readOnly": true
2342
+ },
2343
+ "lastModified": {
2344
+ "type": "string",
2345
+ "format": "date-time",
2346
+ "readOnly": true
2347
+ }
2348
+ }
2349
+ },
2350
+ "ObjectAttributeGroupSearchResult": {
2351
+ "allOf": [
2352
+ {
2353
+ "$ref": "#/components/schemas/PaginatedResultBase"
2354
+ }
2355
+ ],
2356
+ "properties": {
2357
+ "hits": {
2358
+ "type": "array",
2359
+ "items": {
2360
+ "$ref": "#/components/schemas/ObjectAttributeGroup"
2361
+ }
2362
+ }
2363
+ },
2364
+ "required": [
2365
+ "hits"
2366
+ ]
2367
+ },
2368
+ "ObjectAttributeGroupResult": {
2369
+ "allOf": [
2370
+ {
2371
+ "$ref": "#/components/schemas/PaginatedResultBase"
2372
+ }
2373
+ ],
2374
+ "properties": {
2375
+ "data": {
2376
+ "type": "array",
2377
+ "items": {
2378
+ "$ref": "#/components/schemas/ObjectAttributeGroup"
2379
+ }
2380
+ }
2381
+ }
2382
+ },
2383
+ "ObjectAttributeDefinitionResult": {
2384
+ "allOf": [
2385
+ {
2386
+ "$ref": "#/components/schemas/PaginatedResultBase"
2387
+ }
2388
+ ],
2389
+ "properties": {
2390
+ "data": {
2391
+ "type": "array",
2392
+ "items": {
2393
+ "$ref": "#/components/schemas/ObjectAttributeDefinition"
2394
+ }
2395
+ }
2396
+ }
2397
+ }
2398
+ },
2399
+ "responses": {
2400
+ "401unauthorized": {
2401
+ "description": "Your access token is invalid or expired and can’t be used to identify a user.",
2402
+ "content": {
2403
+ "application/problem+json": {
2404
+ "schema": {
2405
+ "$ref": "#/components/schemas/ErrorResponse"
2406
+ }
2407
+ }
2408
+ }
2409
+ },
2410
+ "403forbidden": {
2411
+ "description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
2412
+ "content": {
2413
+ "application/problem+json": {
2414
+ "schema": {
2415
+ "$ref": "#/components/schemas/ErrorResponse"
2416
+ }
2417
+ }
2418
+ }
2419
+ }
2420
+ },
2421
+ "parameters": {
2422
+ "organizationId": {
2423
+ "name": "organizationId",
2424
+ "in": "path",
2425
+ "required": true,
2426
+ "style": "simple",
2427
+ "explode": false,
2428
+ "schema": {
2429
+ "$ref": "#/components/schemas/OrganizationId"
2430
+ }
2431
+ },
2432
+ "select": {
2433
+ "name": "select",
2434
+ "in": "query",
2435
+ "required": false,
2436
+ "style": "form",
2437
+ "explode": true,
2438
+ "schema": {
2439
+ "$ref": "#/components/schemas/Select"
2440
+ }
2441
+ },
2442
+ "objectType": {
2443
+ "name": "objectType",
2444
+ "in": "path",
2445
+ "required": true,
2446
+ "style": "simple",
2447
+ "explode": false,
2448
+ "schema": {
2449
+ "type": "string",
2450
+ "maxLength": 256,
2451
+ "minLength": 1
2452
+ }
2453
+ },
2454
+ "expand": {
2455
+ "name": "expand",
2456
+ "in": "query",
2457
+ "required": false,
2458
+ "style": "form",
2459
+ "explode": true,
2460
+ "schema": {
2461
+ "type": "string",
2462
+ "maxLength": 256
2463
+ }
2464
+ },
2465
+ "attributeGroupId": {
2466
+ "name": "id",
2467
+ "in": "path",
2468
+ "required": true,
2469
+ "style": "simple",
2470
+ "explode": false,
2471
+ "schema": {
2472
+ "type": "string",
2473
+ "maxLength": 256,
2474
+ "minLength": 1
2475
+ }
2476
+ },
2477
+ "groupId": {
2478
+ "name": "groupId",
2479
+ "in": "path",
2480
+ "required": true,
2481
+ "style": "simple",
2482
+ "explode": false,
2483
+ "schema": {
2484
+ "type": "string",
2485
+ "maxLength": 256,
2486
+ "minLength": 1
2487
+ }
2488
+ },
2489
+ "defId": {
2490
+ "name": "defId",
2491
+ "in": "path",
2492
+ "required": true,
2493
+ "style": "simple",
2494
+ "explode": false,
2495
+ "schema": {
2496
+ "type": "string",
2497
+ "maxLength": 256,
2498
+ "minLength": 1
2499
+ }
2500
+ },
2501
+ "attributeDefinitionId": {
2502
+ "name": "id",
2503
+ "in": "path",
2504
+ "required": true,
2505
+ "style": "simple",
2506
+ "explode": false,
2507
+ "schema": {
2508
+ "type": "string",
2509
+ "maxLength": 256,
2510
+ "minLength": 1
2511
+ }
2512
+ }
2513
+ },
2514
+ "securitySchemes": {
2515
+ "AmOAuth2": {
2516
+ "type": "oauth2",
2517
+ "flows": {
2518
+ "clientCredentials": {
2519
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
2520
+ "scopes": {
2521
+ "sfcc.object-definitions": "System Object Definitions Read SCOPE",
2522
+ "sfcc.object-definitions.rw": "System Object Definitions Read and Write SCOPE"
2523
+ }
2524
+ },
2525
+ "authorizationCode": {
2526
+ "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
2527
+ "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
2528
+ "scopes": {
2529
+ "sfcc.object-definitions": "System Object Definitions Read SCOPE",
2530
+ "sfcc.object-definitions.rw": "System Object Definitions Read and Write SCOPE"
2531
+ }
2532
+ }
2533
+ }
2534
+ }
2535
+ }
2536
+ }
2537
+ }