@salesforce/b2c-tooling-sdk 1.24.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (464) 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 +81 -117
  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 +7 -0
  15. package/dist/esm/auth/oauth-implicit.js +2 -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 +3 -0
  21. package/dist/esm/auth/oauth-pkce-fallback.js +27 -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 +2 -1
  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/session-store.d.ts +7 -0
  33. package/dist/esm/auth/session-store.js.map +1 -1
  34. package/dist/esm/auth/types.d.ts +44 -0
  35. package/dist/esm/auth/types.js.map +1 -1
  36. package/dist/esm/cli/base-command.d.ts +9 -0
  37. package/dist/esm/cli/base-command.js +31 -0
  38. package/dist/esm/cli/base-command.js.map +1 -1
  39. package/dist/esm/cli/bm-command.d.ts +15 -0
  40. package/dist/esm/cli/bm-command.js +25 -0
  41. package/dist/esm/cli/bm-command.js.map +1 -0
  42. package/dist/esm/cli/code-command.d.ts +14 -0
  43. package/dist/esm/cli/code-command.js +22 -0
  44. package/dist/esm/cli/code-command.js.map +1 -0
  45. package/dist/esm/cli/config.js +3 -0
  46. package/dist/esm/cli/config.js.map +1 -1
  47. package/dist/esm/cli/index.d.ts +5 -1
  48. package/dist/esm/cli/index.js +7 -1
  49. package/dist/esm/cli/index.js.map +1 -1
  50. package/dist/esm/cli/instance-command.d.ts +45 -0
  51. package/dist/esm/cli/instance-command.js +66 -1
  52. package/dist/esm/cli/instance-command.js.map +1 -1
  53. package/dist/esm/cli/job-command.d.ts +37 -16
  54. package/dist/esm/cli/job-command.js +73 -23
  55. package/dist/esm/cli/job-command.js.map +1 -1
  56. package/dist/esm/cli/mrt-command.d.ts +138 -9
  57. package/dist/esm/cli/mrt-command.js +277 -16
  58. package/dist/esm/cli/mrt-command.js.map +1 -1
  59. package/dist/esm/cli/oauth-command.d.ts +1 -1
  60. package/dist/esm/cli/oauth-command.js +2 -0
  61. package/dist/esm/cli/oauth-command.js.map +1 -1
  62. package/dist/esm/cli/webdav-command.d.ts +1 -0
  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 +28 -3
  79. package/dist/esm/clients/index.js +24 -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 +56 -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/webdav.js +4 -1
  160. package/dist/esm/clients/webdav.js.map +1 -1
  161. package/dist/esm/compat/dispatcher.d.ts +49 -0
  162. package/dist/esm/compat/dispatcher.js +124 -0
  163. package/dist/esm/compat/dispatcher.js.map +1 -0
  164. package/dist/esm/compat/index.d.ts +10 -0
  165. package/dist/esm/compat/index.js +15 -0
  166. package/dist/esm/compat/index.js.map +1 -0
  167. package/dist/esm/compat/jobs-backend.d.ts +31 -0
  168. package/dist/esm/compat/jobs-backend.js +76 -0
  169. package/dist/esm/compat/jobs-backend.js.map +1 -0
  170. package/dist/esm/config/dw-json.d.ts +4 -0
  171. package/dist/esm/config/dw-json.js.map +1 -1
  172. package/dist/esm/config/index.d.ts +1 -1
  173. package/dist/esm/config/index.js.map +1 -1
  174. package/dist/esm/config/mapping.d.ts +2 -5
  175. package/dist/esm/config/mapping.js +25 -1
  176. package/dist/esm/config/mapping.js.map +1 -1
  177. package/dist/esm/config/resolved-config.d.ts +2 -2
  178. package/dist/esm/config/resolved-config.js.map +1 -1
  179. package/dist/esm/config/sources/env-source.js +17 -0
  180. package/dist/esm/config/sources/env-source.js.map +1 -1
  181. package/dist/esm/config/types.d.ts +21 -2
  182. package/dist/esm/docs/search.js +2 -25
  183. package/dist/esm/docs/search.js.map +1 -1
  184. package/dist/esm/guidance/catalog.d.ts +37 -0
  185. package/dist/esm/guidance/catalog.js +282 -0
  186. package/dist/esm/guidance/catalog.js.map +1 -0
  187. package/dist/esm/guidance/index.d.ts +8 -0
  188. package/dist/esm/guidance/index.js +14 -0
  189. package/dist/esm/guidance/index.js.map +1 -0
  190. package/dist/esm/guidance/markdown.d.ts +10 -0
  191. package/dist/esm/guidance/markdown.js +52 -0
  192. package/dist/esm/guidance/markdown.js.map +1 -0
  193. package/dist/esm/guidance/types.d.ts +92 -0
  194. package/dist/esm/guidance/types.js +17 -0
  195. package/dist/esm/guidance/types.js.map +1 -0
  196. package/dist/esm/index.d.ts +14 -5
  197. package/dist/esm/index.js +14 -2
  198. package/dist/esm/index.js.map +1 -1
  199. package/dist/esm/instance/index.d.ts +96 -2
  200. package/dist/esm/instance/index.js +98 -5
  201. package/dist/esm/instance/index.js.map +1 -1
  202. package/dist/esm/operations/bm-roles/backend.d.ts +4 -0
  203. package/dist/esm/operations/bm-roles/backend.js +11 -0
  204. package/dist/esm/operations/bm-roles/backend.js.map +1 -0
  205. package/dist/esm/operations/bm-roles/index.d.ts +6 -0
  206. package/dist/esm/operations/bm-roles/index.js +4 -0
  207. package/dist/esm/operations/bm-roles/index.js.map +1 -1
  208. package/dist/esm/operations/bm-roles/ocapi-backend.d.ts +17 -0
  209. package/dist/esm/operations/bm-roles/ocapi-backend.js +151 -0
  210. package/dist/esm/operations/bm-roles/ocapi-backend.js.map +1 -0
  211. package/dist/esm/operations/bm-roles/roles.js +13 -17
  212. package/dist/esm/operations/bm-roles/roles.js.map +1 -1
  213. package/dist/esm/operations/bm-roles/scapi-backend.d.ts +27 -0
  214. package/dist/esm/operations/bm-roles/scapi-backend.js +138 -0
  215. package/dist/esm/operations/bm-roles/scapi-backend.js.map +1 -0
  216. package/dist/esm/operations/bm-roles/types.d.ts +49 -0
  217. package/dist/esm/operations/bm-roles/types.js +2 -0
  218. package/dist/esm/operations/bm-roles/types.js.map +1 -0
  219. package/dist/esm/operations/bm-users/backend.d.ts +4 -0
  220. package/dist/esm/operations/bm-users/backend.js +11 -0
  221. package/dist/esm/operations/bm-users/backend.js.map +1 -0
  222. package/dist/esm/operations/bm-users/index.d.ts +11 -3
  223. package/dist/esm/operations/bm-users/index.js +9 -3
  224. package/dist/esm/operations/bm-users/index.js.map +1 -1
  225. package/dist/esm/operations/bm-users/ocapi-backend.d.ts +13 -0
  226. package/dist/esm/operations/bm-users/ocapi-backend.js +92 -0
  227. package/dist/esm/operations/bm-users/ocapi-backend.js.map +1 -0
  228. package/dist/esm/operations/bm-users/scapi-backend.d.ts +23 -0
  229. package/dist/esm/operations/bm-users/scapi-backend.js +199 -0
  230. package/dist/esm/operations/bm-users/scapi-backend.js.map +1 -0
  231. package/dist/esm/operations/bm-users/types.d.ts +99 -0
  232. package/dist/esm/operations/bm-users/types.js +2 -0
  233. package/dist/esm/operations/bm-users/types.js.map +1 -0
  234. package/dist/esm/operations/bm-users/users.d.ts +4 -3
  235. package/dist/esm/operations/bm-users/users.js +23 -19
  236. package/dist/esm/operations/bm-users/users.js.map +1 -1
  237. package/dist/esm/operations/cap/install.js +23 -45
  238. package/dist/esm/operations/cap/install.js.map +1 -1
  239. package/dist/esm/operations/cap/list.js +4 -8
  240. package/dist/esm/operations/cap/list.js.map +1 -1
  241. package/dist/esm/operations/cap/uninstall.js +17 -37
  242. package/dist/esm/operations/cap/uninstall.js.map +1 -1
  243. package/dist/esm/operations/catalogs/catalogs-backend.d.ts +4 -0
  244. package/dist/esm/operations/catalogs/catalogs-backend.js +16 -0
  245. package/dist/esm/operations/catalogs/catalogs-backend.js.map +1 -0
  246. package/dist/esm/operations/catalogs/catalogs-types.d.ts +14 -0
  247. package/dist/esm/operations/catalogs/catalogs-types.js +2 -0
  248. package/dist/esm/operations/catalogs/catalogs-types.js.map +1 -0
  249. package/dist/esm/operations/catalogs/index.d.ts +7 -0
  250. package/dist/esm/operations/catalogs/index.js +10 -0
  251. package/dist/esm/operations/catalogs/index.js.map +1 -0
  252. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.d.ts +8 -0
  253. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js +36 -0
  254. package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js.map +1 -0
  255. package/dist/esm/operations/catalogs/scapi-catalogs-backend.d.ts +15 -0
  256. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js +42 -0
  257. package/dist/esm/operations/catalogs/scapi-catalogs-backend.js.map +1 -0
  258. package/dist/esm/operations/cip/index.js +10 -2
  259. package/dist/esm/operations/cip/index.js.map +1 -1
  260. package/dist/esm/operations/cip/reports.js +19 -3
  261. package/dist/esm/operations/cip/reports.js.map +1 -1
  262. package/dist/esm/operations/cip/types.d.ts +8 -4
  263. package/dist/esm/operations/code/deploy.d.ts +3 -0
  264. package/dist/esm/operations/code/deploy.js +5 -3
  265. package/dist/esm/operations/code/deploy.js.map +1 -1
  266. package/dist/esm/operations/code/download.d.ts +3 -0
  267. package/dist/esm/operations/code/download.js +5 -5
  268. package/dist/esm/operations/code/download.js.map +1 -1
  269. package/dist/esm/operations/code/index.d.ts +7 -1
  270. package/dist/esm/operations/code/index.js +5 -1
  271. package/dist/esm/operations/code/index.js.map +1 -1
  272. package/dist/esm/operations/code/ocapi-scripts-backend.d.ts +12 -0
  273. package/dist/esm/operations/code/ocapi-scripts-backend.js +40 -0
  274. package/dist/esm/operations/code/ocapi-scripts-backend.js.map +1 -0
  275. package/dist/esm/operations/code/scapi-scripts-backend.d.ts +22 -0
  276. package/dist/esm/operations/code/scapi-scripts-backend.js +94 -0
  277. package/dist/esm/operations/code/scapi-scripts-backend.js.map +1 -0
  278. package/dist/esm/operations/code/scripts-backend.d.ts +17 -0
  279. package/dist/esm/operations/code/scripts-backend.js +40 -0
  280. package/dist/esm/operations/code/scripts-backend.js.map +1 -0
  281. package/dist/esm/operations/code/scripts-types.d.ts +43 -0
  282. package/dist/esm/operations/code/scripts-types.js +2 -0
  283. package/dist/esm/operations/code/scripts-types.js.map +1 -0
  284. package/dist/esm/operations/code/upload-files.d.ts +6 -0
  285. package/dist/esm/operations/code/upload-files.js +58 -7
  286. package/dist/esm/operations/code/upload-files.js.map +1 -1
  287. package/dist/esm/operations/code/versions.d.ts +0 -20
  288. package/dist/esm/operations/code/versions.js +16 -51
  289. package/dist/esm/operations/code/versions.js.map +1 -1
  290. package/dist/esm/operations/code/watch.d.ts +3 -0
  291. package/dist/esm/operations/code/watch.js +3 -2
  292. package/dist/esm/operations/code/watch.js.map +1 -1
  293. package/dist/esm/operations/debug/debug-session.js +0 -8
  294. package/dist/esm/operations/debug/debug-session.js.map +1 -1
  295. package/dist/esm/operations/jobs/discover.d.ts +1 -1
  296. package/dist/esm/operations/jobs/discover.js +51 -21
  297. package/dist/esm/operations/jobs/discover.js.map +1 -1
  298. package/dist/esm/operations/jobs/index.d.ts +14 -57
  299. package/dist/esm/operations/jobs/index.js +15 -59
  300. package/dist/esm/operations/jobs/index.js.map +1 -1
  301. package/dist/esm/operations/jobs/ocapi-mapping.d.ts +34 -0
  302. package/dist/esm/operations/jobs/ocapi-mapping.js +100 -0
  303. package/dist/esm/operations/jobs/ocapi-mapping.js.map +1 -0
  304. package/dist/esm/operations/jobs/run-system-job.d.ts +81 -0
  305. package/dist/esm/operations/jobs/run-system-job.js +137 -0
  306. package/dist/esm/operations/jobs/run-system-job.js.map +1 -0
  307. package/dist/esm/operations/jobs/run.js +16 -4
  308. package/dist/esm/operations/jobs/run.js.map +1 -1
  309. package/dist/esm/operations/jobs/scapi-ops.d.ts +61 -0
  310. package/dist/esm/operations/jobs/scapi-ops.js +214 -0
  311. package/dist/esm/operations/jobs/scapi-ops.js.map +1 -0
  312. package/dist/esm/operations/jobs/site-archive.js +28 -66
  313. package/dist/esm/operations/jobs/site-archive.js.map +1 -1
  314. package/dist/esm/operations/jobs/types.d.ts +46 -0
  315. package/dist/esm/operations/jobs/types.js +2 -0
  316. package/dist/esm/operations/jobs/types.js.map +1 -0
  317. package/dist/esm/operations/jobs/wait-canonical.d.ts +28 -0
  318. package/dist/esm/operations/jobs/wait-canonical.js +48 -0
  319. package/dist/esm/operations/jobs/wait-canonical.js.map +1 -0
  320. package/dist/esm/operations/mrt/bundle.d.ts +164 -2
  321. package/dist/esm/operations/mrt/bundle.js +315 -9
  322. package/dist/esm/operations/mrt/bundle.js.map +1 -1
  323. package/dist/esm/operations/mrt/deployment.d.ts +221 -0
  324. package/dist/esm/operations/mrt/deployment.js +239 -0
  325. package/dist/esm/operations/mrt/deployment.js.map +1 -1
  326. package/dist/esm/operations/mrt/index.d.ts +8 -6
  327. package/dist/esm/operations/mrt/index.js +5 -3
  328. package/dist/esm/operations/mrt/index.js.map +1 -1
  329. package/dist/esm/operations/mrt/mrt-backend.d.ts +117 -0
  330. package/dist/esm/operations/mrt/mrt-backend.js +84 -0
  331. package/dist/esm/operations/mrt/mrt-backend.js.map +1 -0
  332. package/dist/esm/operations/mrt/push.d.ts +83 -1
  333. package/dist/esm/operations/mrt/push.js +102 -1
  334. package/dist/esm/operations/mrt/push.js.map +1 -1
  335. package/dist/esm/operations/sites/cartridges.d.ts +10 -8
  336. package/dist/esm/operations/sites/cartridges.js +35 -67
  337. package/dist/esm/operations/sites/cartridges.js.map +1 -1
  338. package/dist/esm/operations/sites/index.d.ts +10 -6
  339. package/dist/esm/operations/sites/index.js +9 -6
  340. package/dist/esm/operations/sites/index.js.map +1 -1
  341. package/dist/esm/operations/sites/ocapi-sites-backend.d.ts +20 -0
  342. package/dist/esm/operations/sites/ocapi-sites-backend.js +98 -0
  343. package/dist/esm/operations/sites/ocapi-sites-backend.js.map +1 -0
  344. package/dist/esm/operations/sites/scapi-sites-backend.d.ts +33 -0
  345. package/dist/esm/operations/sites/scapi-sites-backend.js +166 -0
  346. package/dist/esm/operations/sites/scapi-sites-backend.js.map +1 -0
  347. package/dist/esm/operations/sites/sites-backend.d.ts +9 -0
  348. package/dist/esm/operations/sites/sites-backend.js +16 -0
  349. package/dist/esm/operations/sites/sites-backend.js.map +1 -0
  350. package/dist/esm/operations/sites/sites-scopes.d.ts +2 -0
  351. package/dist/esm/operations/sites/sites-scopes.js +16 -0
  352. package/dist/esm/operations/sites/sites-scopes.js.map +1 -0
  353. package/dist/esm/operations/sites/sites-types.d.ts +50 -0
  354. package/dist/esm/operations/sites/sites-types.js +2 -0
  355. package/dist/esm/operations/sites/sites-types.js.map +1 -0
  356. package/dist/esm/safety/safety-middleware.d.ts +7 -3
  357. package/dist/esm/safety/safety-middleware.js +13 -9
  358. package/dist/esm/safety/safety-middleware.js.map +1 -1
  359. package/dist/esm/scaffold/sources.js +6 -9
  360. package/dist/esm/scaffold/sources.js.map +1 -1
  361. package/dist/esm/scapi/auth-primitives.d.ts +3 -0
  362. package/dist/esm/scapi/auth-primitives.js +104 -0
  363. package/dist/esm/scapi/auth-primitives.js.map +1 -0
  364. package/dist/esm/scapi/authentication.d.ts +30 -0
  365. package/dist/esm/scapi/authentication.js +136 -0
  366. package/dist/esm/scapi/authentication.js.map +1 -0
  367. package/dist/esm/scapi/catalog.d.ts +29 -0
  368. package/dist/esm/scapi/catalog.js +81 -0
  369. package/dist/esm/scapi/catalog.js.map +1 -0
  370. package/dist/esm/scapi/index.d.ts +12 -0
  371. package/dist/esm/scapi/index.js +13 -0
  372. package/dist/esm/scapi/index.js.map +1 -0
  373. package/dist/esm/scapi/request.d.ts +15 -0
  374. package/dist/esm/scapi/request.js +239 -0
  375. package/dist/esm/scapi/request.js.map +1 -0
  376. package/dist/esm/scapi/runtime.d.ts +20 -0
  377. package/dist/esm/scapi/runtime.js +131 -0
  378. package/dist/esm/scapi/runtime.js.map +1 -0
  379. package/dist/esm/scapi/snippets.d.ts +22 -0
  380. package/dist/esm/scapi/snippets.js +140 -0
  381. package/dist/esm/scapi/snippets.js.map +1 -0
  382. package/dist/esm/scapi/worker-source.d.ts +2 -0
  383. package/dist/esm/scapi/worker-source.js +101 -0
  384. package/dist/esm/scapi/worker-source.js.map +1 -0
  385. package/dist/esm/search/ranking.d.ts +12 -0
  386. package/dist/esm/search/ranking.js +28 -0
  387. package/dist/esm/search/ranking.js.map +1 -0
  388. package/dist/esm/skills/sources.d.ts +2 -2
  389. package/dist/esm/skills/sources.js +10 -2
  390. package/dist/esm/skills/sources.js.map +1 -1
  391. package/dist/esm/skills/types.d.ts +1 -1
  392. package/dist/esm/slas/token.js +33 -94
  393. package/dist/esm/slas/token.js.map +1 -1
  394. package/dist/esm/slas/types.d.ts +5 -0
  395. package/node_modules/@salesforce/b2c-api-schemas/README.md +23 -0
  396. package/node_modules/@salesforce/b2c-api-schemas/manifest.json +576 -0
  397. package/node_modules/@salesforce/b2c-api-schemas/package.json +15 -0
  398. package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +11490 -0
  399. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +3589 -0
  400. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +6544 -0
  401. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +7148 -0
  402. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +4411 -0
  403. package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +643 -0
  404. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +295 -0
  405. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +2036 -0
  406. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +327 -0
  407. package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +234 -0
  408. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +1542 -0
  409. package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +405 -0
  410. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +2531 -0
  411. package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +7944 -0
  412. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +292 -0
  413. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +2537 -0
  414. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +517 -0
  415. package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +589 -0
  416. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +3600 -0
  417. package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +2319 -0
  418. package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +658 -0
  419. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +2649 -0
  420. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +6615 -0
  421. package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +2103 -0
  422. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1760 -0
  423. package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +640 -0
  424. package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1263 -0
  425. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1259 -0
  426. package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +760 -0
  427. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +1047 -0
  428. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1929 -0
  429. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +1542 -0
  430. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +1093 -0
  431. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +1324 -0
  432. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +325 -0
  433. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +631 -0
  434. package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +1036 -0
  435. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +5175 -0
  436. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +866 -0
  437. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +747 -0
  438. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +5076 -0
  439. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +509 -0
  440. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +517 -0
  441. package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +2961 -0
  442. package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1889 -0
  443. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +7014 -0
  444. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1898 -0
  445. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +622 -0
  446. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +192 -0
  447. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +913 -0
  448. package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +630 -0
  449. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +223 -0
  450. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +423 -0
  451. package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +1088 -0
  452. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +798 -0
  453. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +607 -0
  454. package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1418 -0
  455. package/package.json +24 -3
  456. package/specs/dx-scripts-v1.yaml +409 -0
  457. package/specs/merchant-roles-v1.yaml +1085 -0
  458. package/specs/merchant-users-v1.yaml +398 -0
  459. package/specs/mrt-api-v1.json +105 -0
  460. package/specs/operations-jobs-v1.yaml +793 -0
  461. package/specs/product-catalogs-v1.yaml +111 -0
  462. package/specs/site-sites-v1.yaml +667 -0
  463. package/specs/slas-shopper-v1.yaml +83 -0
  464. package/specs/storefront-deployments-v1.yaml +630 -0
@@ -0,0 +1,1898 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Auth Admin",
5
+ "version": "1.18.0",
6
+ "x-api-type": "Admin",
7
+ "x-api-family": "Shopper"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth-admin/v1",
12
+ "variables": {
13
+ "shortCode": {
14
+ "default": "shortCode"
15
+ }
16
+ }
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/tenants/{tenantId}": {
21
+ "get": {
22
+ "operationId": "retrieveTenant",
23
+ "parameters": [
24
+ {
25
+ "name": "tenantId",
26
+ "in": "path",
27
+ "required": true,
28
+ "style": "simple",
29
+ "explode": false,
30
+ "schema": {
31
+ "type": "string",
32
+ "maxLength": 32
33
+ }
34
+ }
35
+ ],
36
+ "responses": {
37
+ "200": {
38
+ "description": "The tenant was retrieved successfully.",
39
+ "content": {
40
+ "application/json": {
41
+ "schema": {
42
+ "$ref": "#/components/schemas/Tenant"
43
+ }
44
+ }
45
+ }
46
+ },
47
+ "400": {
48
+ "description": "Bad request",
49
+ "content": {
50
+ "application/json": {
51
+ "schema": {
52
+ "$ref": "#/components/schemas/ErrorResponse"
53
+ }
54
+ }
55
+ }
56
+ },
57
+ "401": {
58
+ "description": "Unauthorized. Wrong tenant",
59
+ "content": {
60
+ "application/json": {
61
+ "schema": {
62
+ "$ref": "#/components/schemas/ErrorResponse"
63
+ }
64
+ }
65
+ }
66
+ },
67
+ "404": {
68
+ "description": "Not found",
69
+ "content": {
70
+ "application/json": {
71
+ "schema": {
72
+ "$ref": "#/components/schemas/ErrorResponse"
73
+ }
74
+ }
75
+ }
76
+ }
77
+ },
78
+ "security": [
79
+ {
80
+ "BearerToken": [
81
+ "SLAS_SERVICE_ADMIN",
82
+ "SLAS_ORGANIZATION_ADMIN"
83
+ ]
84
+ }
85
+ ]
86
+ },
87
+ "put": {
88
+ "operationId": "registerTenant",
89
+ "parameters": [
90
+ {
91
+ "name": "tenantId",
92
+ "in": "path",
93
+ "required": true,
94
+ "style": "simple",
95
+ "explode": false,
96
+ "schema": {
97
+ "type": "string",
98
+ "maxLength": 32
99
+ }
100
+ }
101
+ ],
102
+ "requestBody": {
103
+ "content": {
104
+ "application/json": {
105
+ "schema": {
106
+ "$ref": "#/components/schemas/TenantDto"
107
+ }
108
+ }
109
+ },
110
+ "required": true
111
+ },
112
+ "responses": {
113
+ "200": {
114
+ "description": "The tenant was updated successfully.",
115
+ "content": {
116
+ "application/json": {
117
+ "schema": {
118
+ "$ref": "#/components/schemas/Tenant"
119
+ }
120
+ }
121
+ }
122
+ },
123
+ "201": {
124
+ "description": "The tenant was created successfully.",
125
+ "content": {
126
+ "application/json": {
127
+ "schema": {
128
+ "$ref": "#/components/schemas/Tenant"
129
+ }
130
+ }
131
+ }
132
+ },
133
+ "400": {
134
+ "description": "Bad request",
135
+ "content": {
136
+ "application/json": {
137
+ "schema": {
138
+ "$ref": "#/components/schemas/ErrorResponse"
139
+ }
140
+ }
141
+ }
142
+ },
143
+ "401": {
144
+ "description": "Unauthorized. Wrong tenant",
145
+ "content": {
146
+ "application/json": {
147
+ "schema": {
148
+ "$ref": "#/components/schemas/ErrorResponse"
149
+ }
150
+ }
151
+ }
152
+ },
153
+ "404": {
154
+ "description": "Not found",
155
+ "content": {
156
+ "application/json": {
157
+ "schema": {
158
+ "$ref": "#/components/schemas/ErrorResponse"
159
+ }
160
+ }
161
+ }
162
+ },
163
+ "409": {
164
+ "description": "Conflict",
165
+ "content": {
166
+ "application/json": {
167
+ "schema": {
168
+ "$ref": "#/components/schemas/ErrorResponse"
169
+ }
170
+ }
171
+ }
172
+ }
173
+ },
174
+ "security": [
175
+ {
176
+ "BearerToken": [
177
+ "SLAS_SERVICE_ADMIN",
178
+ "SLAS_ORGANIZATION_ADMIN"
179
+ ]
180
+ }
181
+ ]
182
+ }
183
+ },
184
+ "/tenants/{tenantId}/clients": {
185
+ "get": {
186
+ "operationId": "retrieveClients",
187
+ "parameters": [
188
+ {
189
+ "name": "tenantId",
190
+ "in": "path",
191
+ "required": true,
192
+ "style": "simple",
193
+ "explode": false,
194
+ "schema": {
195
+ "type": "string",
196
+ "maxLength": 32
197
+ }
198
+ }
199
+ ],
200
+ "responses": {
201
+ "200": {
202
+ "description": "All tenant clients retrieved successfully.",
203
+ "content": {
204
+ "application/json": {
205
+ "schema": {
206
+ "$ref": "#/components/schemas/ClientListResponse"
207
+ }
208
+ }
209
+ }
210
+ },
211
+ "401": {
212
+ "description": "Unauthorized. Wrong tenant",
213
+ "content": {
214
+ "application/json": {
215
+ "schema": {
216
+ "$ref": "#/components/schemas/ErrorResponse"
217
+ }
218
+ }
219
+ }
220
+ },
221
+ "404": {
222
+ "description": "Not found",
223
+ "content": {
224
+ "application/json": {
225
+ "schema": {
226
+ "$ref": "#/components/schemas/ErrorResponse"
227
+ }
228
+ }
229
+ }
230
+ }
231
+ },
232
+ "security": [
233
+ {
234
+ "BearerToken": [
235
+ "SLAS_SERVICE_ADMIN"
236
+ ]
237
+ }
238
+ ]
239
+ }
240
+ },
241
+ "/tenants/{tenantId}/clients/{clientId}": {
242
+ "get": {
243
+ "operationId": "retrieveClient",
244
+ "parameters": [
245
+ {
246
+ "name": "clientId",
247
+ "in": "path",
248
+ "required": true,
249
+ "style": "simple",
250
+ "explode": false,
251
+ "schema": {
252
+ "type": "string",
253
+ "maxLength": 36
254
+ }
255
+ },
256
+ {
257
+ "name": "tenantId",
258
+ "in": "path",
259
+ "required": true,
260
+ "style": "simple",
261
+ "explode": false,
262
+ "schema": {
263
+ "type": "string",
264
+ "maxLength": 32
265
+ }
266
+ }
267
+ ],
268
+ "responses": {
269
+ "200": {
270
+ "description": "The client was retrieved successfully.",
271
+ "content": {
272
+ "application/json": {
273
+ "schema": {
274
+ "$ref": "#/components/schemas/Client"
275
+ }
276
+ }
277
+ }
278
+ },
279
+ "400": {
280
+ "description": "Bad request",
281
+ "content": {
282
+ "application/json": {
283
+ "schema": {
284
+ "$ref": "#/components/schemas/ErrorResponse"
285
+ }
286
+ }
287
+ }
288
+ },
289
+ "401": {
290
+ "description": "Unauthorized. Wrong tenant",
291
+ "content": {
292
+ "application/json": {
293
+ "schema": {
294
+ "$ref": "#/components/schemas/ErrorResponse"
295
+ }
296
+ }
297
+ }
298
+ },
299
+ "404": {
300
+ "description": "Not found",
301
+ "content": {
302
+ "application/json": {
303
+ "schema": {
304
+ "$ref": "#/components/schemas/ErrorResponse"
305
+ }
306
+ }
307
+ }
308
+ }
309
+ },
310
+ "security": [
311
+ {
312
+ "BearerToken": [
313
+ "SLAS_SERVICE_ADMIN"
314
+ ]
315
+ }
316
+ ]
317
+ },
318
+ "put": {
319
+ "operationId": "registerClient",
320
+ "parameters": [
321
+ {
322
+ "name": "clientId",
323
+ "in": "path",
324
+ "required": true,
325
+ "style": "simple",
326
+ "explode": false,
327
+ "schema": {
328
+ "type": "string",
329
+ "maxLength": 36
330
+ }
331
+ },
332
+ {
333
+ "name": "tenantId",
334
+ "in": "path",
335
+ "required": true,
336
+ "style": "simple",
337
+ "explode": false,
338
+ "schema": {
339
+ "type": "string",
340
+ "maxLength": 32
341
+ }
342
+ }
343
+ ],
344
+ "requestBody": {
345
+ "content": {
346
+ "application/json": {
347
+ "schema": {
348
+ "$ref": "#/components/schemas/ClientRequest"
349
+ }
350
+ }
351
+ },
352
+ "required": true
353
+ },
354
+ "responses": {
355
+ "200": {
356
+ "description": "The client was updated successfully. A secret is only returned when a secret was sent with the update request.",
357
+ "content": {
358
+ "application/json": {
359
+ "schema": {
360
+ "$ref": "#/components/schemas/Client"
361
+ }
362
+ }
363
+ }
364
+ },
365
+ "201": {
366
+ "description": "The client was created successfully. This is the only time the secret is returned.",
367
+ "content": {
368
+ "application/json": {
369
+ "schema": {
370
+ "$ref": "#/components/schemas/Client"
371
+ }
372
+ }
373
+ }
374
+ },
375
+ "400": {
376
+ "description": "Bad request",
377
+ "content": {
378
+ "application/json": {
379
+ "schema": {
380
+ "$ref": "#/components/schemas/ErrorResponse"
381
+ }
382
+ }
383
+ }
384
+ },
385
+ "401": {
386
+ "description": "Unauthorized. Wrong tenant",
387
+ "content": {
388
+ "application/json": {
389
+ "schema": {
390
+ "$ref": "#/components/schemas/ErrorResponse"
391
+ }
392
+ }
393
+ }
394
+ },
395
+ "404": {
396
+ "description": "Not found",
397
+ "content": {
398
+ "application/json": {
399
+ "schema": {
400
+ "$ref": "#/components/schemas/ErrorResponse"
401
+ }
402
+ }
403
+ }
404
+ },
405
+ "409": {
406
+ "description": "Conflict",
407
+ "content": {
408
+ "application/json": {
409
+ "schema": {
410
+ "$ref": "#/components/schemas/ErrorResponse"
411
+ }
412
+ }
413
+ }
414
+ }
415
+ },
416
+ "security": [
417
+ {
418
+ "BearerToken": [
419
+ "SLAS_SERVICE_ADMIN",
420
+ "SLAS_ORGANIZATION_ADMIN"
421
+ ]
422
+ }
423
+ ]
424
+ },
425
+ "delete": {
426
+ "operationId": "deleteClient",
427
+ "parameters": [
428
+ {
429
+ "name": "clientId",
430
+ "in": "path",
431
+ "required": true,
432
+ "style": "simple",
433
+ "explode": false,
434
+ "schema": {
435
+ "type": "string",
436
+ "maxLength": 36
437
+ }
438
+ },
439
+ {
440
+ "name": "tenantId",
441
+ "in": "path",
442
+ "required": true,
443
+ "style": "simple",
444
+ "explode": false,
445
+ "schema": {
446
+ "type": "string",
447
+ "maxLength": 32
448
+ }
449
+ }
450
+ ],
451
+ "responses": {
452
+ "204": {
453
+ "description": "No content"
454
+ },
455
+ "400": {
456
+ "description": "Bad request",
457
+ "content": {
458
+ "application/json": {
459
+ "schema": {
460
+ "$ref": "#/components/schemas/ErrorResponse"
461
+ }
462
+ }
463
+ }
464
+ },
465
+ "401": {
466
+ "description": "Unauthorized. Wrong tenant",
467
+ "content": {
468
+ "application/json": {
469
+ "schema": {
470
+ "$ref": "#/components/schemas/ErrorResponse"
471
+ }
472
+ }
473
+ }
474
+ },
475
+ "404": {
476
+ "description": "Not found",
477
+ "content": {
478
+ "application/json": {
479
+ "schema": {
480
+ "$ref": "#/components/schemas/ErrorResponse"
481
+ }
482
+ }
483
+ }
484
+ }
485
+ },
486
+ "security": [
487
+ {
488
+ "BearerToken": [
489
+ "SLAS_SERVICE_ADMIN",
490
+ "SLAS_ORGANIZATION_ADMIN"
491
+ ]
492
+ }
493
+ ]
494
+ }
495
+ },
496
+ "/tenants/{tenantId}/clients/{clientId}/password-action-templates": {
497
+ "get": {
498
+ "operationId": "retrievePwdActionTemplate",
499
+ "parameters": [
500
+ {
501
+ "name": "clientId",
502
+ "in": "path",
503
+ "required": true,
504
+ "style": "simple",
505
+ "explode": false,
506
+ "schema": {
507
+ "type": "string",
508
+ "maxLength": 36
509
+ }
510
+ },
511
+ {
512
+ "name": "tenantId",
513
+ "in": "path",
514
+ "required": true,
515
+ "style": "simple",
516
+ "explode": false,
517
+ "schema": {
518
+ "type": "string",
519
+ "maxLength": 32
520
+ }
521
+ },
522
+ {
523
+ "name": "channelId",
524
+ "in": "query",
525
+ "required": true,
526
+ "style": "form",
527
+ "explode": true,
528
+ "schema": {
529
+ "type": "string",
530
+ "maxLength": 100
531
+ }
532
+ },
533
+ {
534
+ "name": "actionType",
535
+ "in": "query",
536
+ "required": true,
537
+ "style": "form",
538
+ "explode": true,
539
+ "schema": {
540
+ "type": "string",
541
+ "enum": [
542
+ "PWDLESS_LOGIN",
543
+ "PWD_RESET_ACTION",
544
+ "PWD_RESET_CROSS_DEVICE_ACTION"
545
+ ],
546
+ "maxLength": 36
547
+ }
548
+ },
549
+ {
550
+ "name": "templateType",
551
+ "in": "query",
552
+ "required": true,
553
+ "style": "form",
554
+ "explode": true,
555
+ "schema": {
556
+ "type": "string",
557
+ "enum": [
558
+ "EMAIL",
559
+ "SMS"
560
+ ],
561
+ "maxLength": 8
562
+ }
563
+ }
564
+ ],
565
+ "responses": {
566
+ "200": {
567
+ "description": "The password action template was retrieved successfully.",
568
+ "content": {
569
+ "application/json": {
570
+ "schema": {
571
+ "$ref": "#/components/schemas/PasswordActionTemplate"
572
+ }
573
+ }
574
+ }
575
+ },
576
+ "400": {
577
+ "description": "Bad request",
578
+ "content": {
579
+ "application/json": {
580
+ "schema": {
581
+ "$ref": "#/components/schemas/ErrorResponse"
582
+ }
583
+ }
584
+ }
585
+ },
586
+ "401": {
587
+ "description": "Unauthorized. Wrong tenant",
588
+ "content": {
589
+ "application/json": {
590
+ "schema": {
591
+ "$ref": "#/components/schemas/ErrorResponse"
592
+ }
593
+ }
594
+ }
595
+ },
596
+ "404": {
597
+ "description": "Not found",
598
+ "content": {
599
+ "application/json": {
600
+ "schema": {
601
+ "$ref": "#/components/schemas/ErrorResponse"
602
+ }
603
+ }
604
+ }
605
+ }
606
+ },
607
+ "security": [
608
+ {
609
+ "BearerToken": [
610
+ "SLAS_SERVICE_ADMIN",
611
+ "SLAS_ORGANIZATION_ADMIN"
612
+ ]
613
+ }
614
+ ]
615
+ },
616
+ "put": {
617
+ "operationId": "registerPwdActionTemplate",
618
+ "parameters": [
619
+ {
620
+ "name": "clientId",
621
+ "in": "path",
622
+ "required": true,
623
+ "style": "simple",
624
+ "explode": false,
625
+ "schema": {
626
+ "type": "string",
627
+ "maxLength": 36
628
+ }
629
+ },
630
+ {
631
+ "name": "tenantId",
632
+ "in": "path",
633
+ "required": true,
634
+ "style": "simple",
635
+ "explode": false,
636
+ "schema": {
637
+ "type": "string",
638
+ "maxLength": 32
639
+ }
640
+ }
641
+ ],
642
+ "requestBody": {
643
+ "content": {
644
+ "application/json": {
645
+ "schema": {
646
+ "$ref": "#/components/schemas/PasswordActionTemplate"
647
+ }
648
+ }
649
+ },
650
+ "required": true
651
+ },
652
+ "responses": {
653
+ "200": {
654
+ "description": "The password action template was updated successfully.",
655
+ "content": {
656
+ "application/json": {
657
+ "schema": {
658
+ "$ref": "#/components/schemas/PasswordActionTemplate"
659
+ }
660
+ }
661
+ }
662
+ },
663
+ "201": {
664
+ "description": "A password action template was created successfully.",
665
+ "content": {
666
+ "application/json": {
667
+ "schema": {
668
+ "$ref": "#/components/schemas/PasswordActionTemplate"
669
+ }
670
+ }
671
+ }
672
+ },
673
+ "400": {
674
+ "description": "Bad request",
675
+ "content": {
676
+ "application/json": {
677
+ "schema": {
678
+ "$ref": "#/components/schemas/ErrorResponse"
679
+ }
680
+ }
681
+ }
682
+ },
683
+ "401": {
684
+ "description": "Unauthorized. Wrong tenant",
685
+ "content": {
686
+ "application/json": {
687
+ "schema": {
688
+ "$ref": "#/components/schemas/ErrorResponse"
689
+ }
690
+ }
691
+ }
692
+ },
693
+ "404": {
694
+ "description": "Not found",
695
+ "content": {
696
+ "application/json": {
697
+ "schema": {
698
+ "$ref": "#/components/schemas/ErrorResponse"
699
+ }
700
+ }
701
+ }
702
+ }
703
+ },
704
+ "security": [
705
+ {
706
+ "BearerToken": [
707
+ "SLAS_SERVICE_ADMIN",
708
+ "SLAS_ORGANIZATION_ADMIN"
709
+ ]
710
+ }
711
+ ]
712
+ },
713
+ "delete": {
714
+ "operationId": "deletePwdActionTemplate",
715
+ "parameters": [
716
+ {
717
+ "name": "clientId",
718
+ "in": "path",
719
+ "required": true,
720
+ "style": "simple",
721
+ "explode": false,
722
+ "schema": {
723
+ "type": "string",
724
+ "maxLength": 36
725
+ }
726
+ },
727
+ {
728
+ "name": "tenantId",
729
+ "in": "path",
730
+ "required": true,
731
+ "style": "simple",
732
+ "explode": false,
733
+ "schema": {
734
+ "type": "string",
735
+ "maxLength": 32
736
+ }
737
+ },
738
+ {
739
+ "name": "channelId",
740
+ "in": "query",
741
+ "required": true,
742
+ "style": "form",
743
+ "explode": true,
744
+ "schema": {
745
+ "type": "string",
746
+ "maxLength": 100
747
+ }
748
+ },
749
+ {
750
+ "name": "actionType",
751
+ "in": "query",
752
+ "required": true,
753
+ "style": "form",
754
+ "explode": true,
755
+ "schema": {
756
+ "type": "string",
757
+ "enum": [
758
+ "PWDLESS_LOGIN",
759
+ "PWD_RESET_ACTION",
760
+ "PWD_RESET_CROSS_DEVICE_ACTION"
761
+ ],
762
+ "maxLength": 36
763
+ }
764
+ },
765
+ {
766
+ "name": "templateType",
767
+ "in": "query",
768
+ "required": true,
769
+ "style": "form",
770
+ "explode": true,
771
+ "schema": {
772
+ "type": "string",
773
+ "enum": [
774
+ "EMAIL",
775
+ "SMS"
776
+ ],
777
+ "maxLength": 8
778
+ }
779
+ },
780
+ {
781
+ "name": "locale",
782
+ "in": "query",
783
+ "required": true,
784
+ "style": "form",
785
+ "explode": true,
786
+ "schema": {
787
+ "type": "string",
788
+ "pattern": "^[a-z][a-z]-[A-Z][A-Z]$"
789
+ }
790
+ }
791
+ ],
792
+ "responses": {
793
+ "204": {
794
+ "description": "No content"
795
+ },
796
+ "400": {
797
+ "description": "Bad request",
798
+ "content": {
799
+ "application/json": {
800
+ "schema": {
801
+ "$ref": "#/components/schemas/ErrorResponse"
802
+ }
803
+ }
804
+ }
805
+ },
806
+ "401": {
807
+ "description": "Unauthorized. Wrong tenant",
808
+ "content": {
809
+ "application/json": {
810
+ "schema": {
811
+ "$ref": "#/components/schemas/ErrorResponse"
812
+ }
813
+ }
814
+ }
815
+ },
816
+ "404": {
817
+ "description": "Not found",
818
+ "content": {
819
+ "application/json": {
820
+ "schema": {
821
+ "$ref": "#/components/schemas/ErrorResponse"
822
+ }
823
+ }
824
+ }
825
+ }
826
+ },
827
+ "security": [
828
+ {
829
+ "BearerToken": [
830
+ "SLAS_SERVICE_ADMIN",
831
+ "SLAS_ORGANIZATION_ADMIN"
832
+ ]
833
+ }
834
+ ]
835
+ }
836
+ },
837
+ "/tenants/{tenantId}/idps": {
838
+ "get": {
839
+ "operationId": "retrieveIdentityProviders",
840
+ "parameters": [
841
+ {
842
+ "name": "tenantId",
843
+ "in": "path",
844
+ "required": true,
845
+ "style": "simple",
846
+ "explode": false,
847
+ "schema": {
848
+ "type": "string",
849
+ "maxLength": 32
850
+ }
851
+ }
852
+ ],
853
+ "responses": {
854
+ "200": {
855
+ "description": "All tenant identity providers retrieved successfully.",
856
+ "content": {
857
+ "application/json": {
858
+ "schema": {
859
+ "$ref": "#/components/schemas/IdpListResponse"
860
+ }
861
+ }
862
+ }
863
+ },
864
+ "400": {
865
+ "description": "Bad request",
866
+ "content": {
867
+ "application/json": {
868
+ "schema": {
869
+ "$ref": "#/components/schemas/ErrorResponse"
870
+ }
871
+ }
872
+ }
873
+ },
874
+ "401": {
875
+ "description": "Unauthorized. Wrong tenant",
876
+ "content": {
877
+ "application/json": {
878
+ "schema": {
879
+ "$ref": "#/components/schemas/ErrorResponse"
880
+ }
881
+ }
882
+ }
883
+ },
884
+ "404": {
885
+ "description": "Not found",
886
+ "content": {
887
+ "application/json": {
888
+ "schema": {
889
+ "$ref": "#/components/schemas/ErrorResponse"
890
+ }
891
+ }
892
+ }
893
+ }
894
+ },
895
+ "security": [
896
+ {
897
+ "BearerToken": [
898
+ "SLAS_SERVICE_ADMIN"
899
+ ]
900
+ }
901
+ ]
902
+ }
903
+ },
904
+ "/tenants/{tenantId}/idps/{name}": {
905
+ "get": {
906
+ "operationId": "retrieveIdentityProvider",
907
+ "parameters": [
908
+ {
909
+ "name": "name",
910
+ "in": "path",
911
+ "required": true,
912
+ "style": "simple",
913
+ "explode": false,
914
+ "schema": {
915
+ "type": "string",
916
+ "maxLength": 256
917
+ }
918
+ },
919
+ {
920
+ "name": "tenantId",
921
+ "in": "path",
922
+ "required": true,
923
+ "style": "simple",
924
+ "explode": false,
925
+ "schema": {
926
+ "type": "string",
927
+ "maxLength": 32
928
+ }
929
+ }
930
+ ],
931
+ "responses": {
932
+ "200": {
933
+ "description": "The identity provider was retrieved successfully.",
934
+ "content": {
935
+ "application/json": {
936
+ "schema": {
937
+ "$ref": "#/components/schemas/IdentityProvider"
938
+ }
939
+ }
940
+ }
941
+ },
942
+ "400": {
943
+ "description": "Bad request",
944
+ "content": {
945
+ "application/json": {
946
+ "schema": {
947
+ "$ref": "#/components/schemas/ErrorResponse"
948
+ }
949
+ }
950
+ }
951
+ },
952
+ "401": {
953
+ "description": "Unauthorized. Wrong tenant",
954
+ "content": {
955
+ "application/json": {
956
+ "schema": {
957
+ "$ref": "#/components/schemas/ErrorResponse"
958
+ }
959
+ }
960
+ }
961
+ },
962
+ "404": {
963
+ "description": "Not found",
964
+ "content": {
965
+ "application/json": {
966
+ "schema": {
967
+ "$ref": "#/components/schemas/ErrorResponse"
968
+ }
969
+ }
970
+ }
971
+ }
972
+ },
973
+ "security": [
974
+ {
975
+ "BearerToken": [
976
+ "SLAS_SERVICE_ADMIN",
977
+ "SLAS_ORGANIZATION_ADMIN"
978
+ ]
979
+ }
980
+ ]
981
+ },
982
+ "put": {
983
+ "operationId": "registerIdentityProvider",
984
+ "parameters": [
985
+ {
986
+ "name": "name",
987
+ "in": "path",
988
+ "required": true,
989
+ "style": "simple",
990
+ "explode": false,
991
+ "schema": {
992
+ "type": "string",
993
+ "maxLength": 256
994
+ }
995
+ },
996
+ {
997
+ "name": "tenantId",
998
+ "in": "path",
999
+ "required": true,
1000
+ "style": "simple",
1001
+ "explode": false,
1002
+ "schema": {
1003
+ "type": "string",
1004
+ "maxLength": 32
1005
+ }
1006
+ }
1007
+ ],
1008
+ "requestBody": {
1009
+ "content": {
1010
+ "application/json": {
1011
+ "schema": {
1012
+ "$ref": "#/components/schemas/IdentityProvider"
1013
+ }
1014
+ }
1015
+ },
1016
+ "required": true
1017
+ },
1018
+ "responses": {
1019
+ "200": {
1020
+ "description": "The identity provider was updated successfully.",
1021
+ "content": {
1022
+ "application/json": {
1023
+ "schema": {
1024
+ "$ref": "#/components/schemas/IdentityProviderResponse"
1025
+ }
1026
+ }
1027
+ }
1028
+ },
1029
+ "201": {
1030
+ "description": "The identity provider was created successfully.",
1031
+ "content": {
1032
+ "application/json": {
1033
+ "schema": {
1034
+ "$ref": "#/components/schemas/IdentityProviderResponse"
1035
+ }
1036
+ }
1037
+ }
1038
+ },
1039
+ "400": {
1040
+ "description": "Bad request",
1041
+ "content": {
1042
+ "application/json": {
1043
+ "schema": {
1044
+ "$ref": "#/components/schemas/ErrorResponse"
1045
+ }
1046
+ }
1047
+ }
1048
+ },
1049
+ "401": {
1050
+ "description": "Unauthorized. Wrong tenant",
1051
+ "content": {
1052
+ "application/json": {
1053
+ "schema": {
1054
+ "$ref": "#/components/schemas/ErrorResponse"
1055
+ }
1056
+ }
1057
+ }
1058
+ },
1059
+ "404": {
1060
+ "description": "Not found",
1061
+ "content": {
1062
+ "application/json": {
1063
+ "schema": {
1064
+ "$ref": "#/components/schemas/ErrorResponse"
1065
+ }
1066
+ }
1067
+ }
1068
+ },
1069
+ "409": {
1070
+ "description": "Conflict. Duplicate",
1071
+ "content": {
1072
+ "application/json": {
1073
+ "schema": {
1074
+ "$ref": "#/components/schemas/ErrorResponse"
1075
+ }
1076
+ }
1077
+ }
1078
+ }
1079
+ },
1080
+ "security": [
1081
+ {
1082
+ "BearerToken": [
1083
+ "SLAS_SERVICE_ADMIN",
1084
+ "SLAS_ORGANIZATION_ADMIN"
1085
+ ]
1086
+ }
1087
+ ]
1088
+ },
1089
+ "delete": {
1090
+ "operationId": "deleteIdentityProvider",
1091
+ "parameters": [
1092
+ {
1093
+ "name": "name",
1094
+ "in": "path",
1095
+ "required": true,
1096
+ "style": "simple",
1097
+ "explode": false,
1098
+ "schema": {
1099
+ "type": "string",
1100
+ "maxLength": 256
1101
+ }
1102
+ },
1103
+ {
1104
+ "name": "tenantId",
1105
+ "in": "path",
1106
+ "required": true,
1107
+ "style": "simple",
1108
+ "explode": false,
1109
+ "schema": {
1110
+ "type": "string",
1111
+ "maxLength": 32
1112
+ }
1113
+ }
1114
+ ],
1115
+ "responses": {
1116
+ "204": {
1117
+ "description": "No content"
1118
+ },
1119
+ "400": {
1120
+ "description": "Bad request",
1121
+ "content": {
1122
+ "application/json": {
1123
+ "schema": {
1124
+ "$ref": "#/components/schemas/ErrorResponse"
1125
+ }
1126
+ }
1127
+ }
1128
+ },
1129
+ "401": {
1130
+ "description": "Unauthorized. Wrong tenant",
1131
+ "content": {
1132
+ "application/json": {
1133
+ "schema": {
1134
+ "$ref": "#/components/schemas/ErrorResponse"
1135
+ }
1136
+ }
1137
+ }
1138
+ },
1139
+ "404": {
1140
+ "description": "Not found",
1141
+ "content": {
1142
+ "application/json": {
1143
+ "schema": {
1144
+ "$ref": "#/components/schemas/ErrorResponse"
1145
+ }
1146
+ }
1147
+ }
1148
+ }
1149
+ },
1150
+ "security": [
1151
+ {
1152
+ "BearerToken": [
1153
+ "SLAS_SERVICE_ADMIN",
1154
+ "SLAS_ORGANIZATION_ADMIN"
1155
+ ]
1156
+ }
1157
+ ]
1158
+ }
1159
+ },
1160
+ "/tenants/{tenantId}/customers/{customerId}": {
1161
+ "delete": {
1162
+ "operationId": "deleteShopper",
1163
+ "parameters": [
1164
+ {
1165
+ "name": "customerId",
1166
+ "in": "path",
1167
+ "required": true,
1168
+ "style": "simple",
1169
+ "explode": false,
1170
+ "schema": {
1171
+ "type": "string",
1172
+ "maxLength": 28
1173
+ }
1174
+ },
1175
+ {
1176
+ "name": "tenantId",
1177
+ "in": "path",
1178
+ "required": true,
1179
+ "style": "simple",
1180
+ "explode": false,
1181
+ "schema": {
1182
+ "type": "string",
1183
+ "maxLength": 32
1184
+ }
1185
+ },
1186
+ {
1187
+ "name": "emailAddress",
1188
+ "in": "query",
1189
+ "required": false,
1190
+ "style": "form",
1191
+ "explode": true,
1192
+ "schema": {
1193
+ "type": "string",
1194
+ "maxLength": 256
1195
+ }
1196
+ }
1197
+ ],
1198
+ "responses": {
1199
+ "204": {
1200
+ "description": "No content"
1201
+ },
1202
+ "400": {
1203
+ "description": "Bad request",
1204
+ "content": {
1205
+ "application/json": {
1206
+ "schema": {
1207
+ "$ref": "#/components/schemas/ErrorResponse"
1208
+ }
1209
+ }
1210
+ }
1211
+ },
1212
+ "404": {
1213
+ "description": "Not found",
1214
+ "content": {
1215
+ "application/json": {
1216
+ "schema": {
1217
+ "$ref": "#/components/schemas/ErrorResponse"
1218
+ }
1219
+ }
1220
+ }
1221
+ }
1222
+ },
1223
+ "security": [
1224
+ {
1225
+ "BearerToken": [
1226
+ "SLAS_SERVICE_ADMIN",
1227
+ "SLAS_ORGANIZATION_ADMIN"
1228
+ ]
1229
+ }
1230
+ ]
1231
+ }
1232
+ }
1233
+ },
1234
+ "components": {
1235
+ "schemas": {
1236
+ "Tenant": {
1237
+ "type": "object",
1238
+ "additionalProperties": true,
1239
+ "properties": {
1240
+ "tenantId": {
1241
+ "type": "string",
1242
+ "maxLength": 8
1243
+ },
1244
+ "merchantId": {
1245
+ "type": "integer",
1246
+ "minimum": 0
1247
+ },
1248
+ "description": {
1249
+ "type": "string",
1250
+ "maxLength": 256
1251
+ },
1252
+ "contact": {
1253
+ "type": "string",
1254
+ "maxLength": 256
1255
+ },
1256
+ "emailAddress": {
1257
+ "type": "string",
1258
+ "maxLength": 200
1259
+ },
1260
+ "phoneNo": {
1261
+ "type": "string",
1262
+ "maxLength": 50
1263
+ },
1264
+ "isDeleted": {
1265
+ "type": "boolean",
1266
+ "maxLength": 1
1267
+ },
1268
+ "status": {
1269
+ "type": "string",
1270
+ "maxLength": 16
1271
+ },
1272
+ "tier": {
1273
+ "type": "string",
1274
+ "enum": [
1275
+ "XS",
1276
+ "S",
1277
+ "M",
1278
+ "L"
1279
+ ]
1280
+ },
1281
+ "requestQuotaPerMinute": {
1282
+ "type": "number"
1283
+ }
1284
+ },
1285
+ "required": [
1286
+ "contact",
1287
+ "description",
1288
+ "emailAddress",
1289
+ "isDeleted",
1290
+ "merchantId",
1291
+ "phoneNo",
1292
+ "requestQuotaPerMinute",
1293
+ "status",
1294
+ "tenantId",
1295
+ "tier"
1296
+ ]
1297
+ },
1298
+ "ErrorResponse": {
1299
+ "type": "object",
1300
+ "additionalProperties": true,
1301
+ "properties": {
1302
+ "title": {
1303
+ "type": "string",
1304
+ "maxLength": 256
1305
+ },
1306
+ "type": {
1307
+ "type": "string",
1308
+ "maxLength": 2048
1309
+ },
1310
+ "detail": {
1311
+ "type": "string"
1312
+ },
1313
+ "instance": {
1314
+ "type": "string",
1315
+ "maxLength": 2048
1316
+ }
1317
+ },
1318
+ "required": [
1319
+ "detail",
1320
+ "title",
1321
+ "type"
1322
+ ]
1323
+ },
1324
+ "TenantDto": {
1325
+ "type": "object",
1326
+ "properties": {
1327
+ "tenantId": {
1328
+ "type": "string",
1329
+ "maxLength": 8
1330
+ },
1331
+ "merchantName": {
1332
+ "type": "string",
1333
+ "maxLength": 256
1334
+ },
1335
+ "description": {
1336
+ "type": "string",
1337
+ "maxLength": 256
1338
+ },
1339
+ "contact": {
1340
+ "type": "string",
1341
+ "maxLength": 256
1342
+ },
1343
+ "emailAddress": {
1344
+ "type": "string",
1345
+ "maxLength": 200
1346
+ },
1347
+ "phoneNo": {
1348
+ "type": "string",
1349
+ "maxLength": 50
1350
+ }
1351
+ },
1352
+ "required": [
1353
+ "contact",
1354
+ "description",
1355
+ "emailAddress",
1356
+ "merchantName",
1357
+ "phoneNo",
1358
+ "tenantId"
1359
+ ]
1360
+ },
1361
+ "Client": {
1362
+ "type": "object",
1363
+ "properties": {
1364
+ "clientId": {
1365
+ "type": "string",
1366
+ "maxLength": 100
1367
+ },
1368
+ "name": {
1369
+ "type": "string",
1370
+ "maxLength": 100
1371
+ },
1372
+ "secret": {
1373
+ "type": "string",
1374
+ "maxLength": 256
1375
+ },
1376
+ "scopes": {
1377
+ "type": "array",
1378
+ "items": {
1379
+ "type": "string",
1380
+ "maxLength": 100
1381
+ }
1382
+ },
1383
+ "redirectUri": {
1384
+ "type": "string",
1385
+ "maxLength": 2048
1386
+ },
1387
+ "callbackUri": {
1388
+ "type": "string",
1389
+ "maxLength": 2048
1390
+ },
1391
+ "channels": {
1392
+ "type": "array",
1393
+ "items": {
1394
+ "type": "string",
1395
+ "maxLength": 1024
1396
+ }
1397
+ },
1398
+ "isPrivateClient": {
1399
+ "type": "boolean"
1400
+ },
1401
+ "loginEpRestrict": {
1402
+ "type": "boolean",
1403
+ "maxLength": 1
1404
+ },
1405
+ "isSixDigitOtp": {
1406
+ "type": "boolean"
1407
+ },
1408
+ "strictClientAuth": {
1409
+ "type": "boolean"
1410
+ }
1411
+ },
1412
+ "required": [
1413
+ "callbackUri",
1414
+ "channels",
1415
+ "clientId",
1416
+ "name",
1417
+ "redirectUri",
1418
+ "scopes",
1419
+ "secret"
1420
+ ]
1421
+ },
1422
+ "ClientListResponse": {
1423
+ "type": "object",
1424
+ "properties": {
1425
+ "data": {
1426
+ "type": "array",
1427
+ "items": {
1428
+ "$ref": "#/components/schemas/Client"
1429
+ }
1430
+ }
1431
+ },
1432
+ "required": [
1433
+ "data"
1434
+ ]
1435
+ },
1436
+ "ClientRequest": {
1437
+ "type": "object",
1438
+ "properties": {
1439
+ "name": {
1440
+ "type": "string",
1441
+ "maxLength": 100
1442
+ },
1443
+ "clientId": {
1444
+ "type": "string",
1445
+ "maxLength": 100
1446
+ },
1447
+ "secret": {
1448
+ "type": "string",
1449
+ "maxLength": 256
1450
+ },
1451
+ "scopes": {
1452
+ "type": "array",
1453
+ "items": {
1454
+ "type": "string",
1455
+ "maxLength": 4096
1456
+ }
1457
+ },
1458
+ "redirectUri": {
1459
+ "type": "array",
1460
+ "items": {
1461
+ "type": "string",
1462
+ "maxLength": 2048
1463
+ }
1464
+ },
1465
+ "callbackUri": {
1466
+ "type": "array",
1467
+ "items": {
1468
+ "type": "string",
1469
+ "maxLength": 2048
1470
+ }
1471
+ },
1472
+ "channels": {
1473
+ "type": "array",
1474
+ "items": {
1475
+ "type": "string",
1476
+ "maxLength": 1024
1477
+ }
1478
+ },
1479
+ "isPrivateClient": {
1480
+ "type": "boolean"
1481
+ },
1482
+ "loginEpRestrict": {
1483
+ "type": "boolean"
1484
+ },
1485
+ "isSixDigitOtp": {
1486
+ "type": "boolean"
1487
+ },
1488
+ "strictClientAuth": {
1489
+ "type": "boolean"
1490
+ }
1491
+ },
1492
+ "required": [
1493
+ "channels",
1494
+ "clientId",
1495
+ "isPrivateClient",
1496
+ "name",
1497
+ "redirectUri",
1498
+ "scopes",
1499
+ "secret"
1500
+ ]
1501
+ },
1502
+ "PasswordTemplateActionType": {
1503
+ "type": "string",
1504
+ "enum": [
1505
+ "PWDLESS_LOGIN",
1506
+ "PWD_RESET_ACTION",
1507
+ "PWD_RESET_CROSS_DEVICE_ACTION",
1508
+ "WEBAUTHN_AUTHORIZE_USER"
1509
+ ]
1510
+ },
1511
+ "PasswordTemplateType": {
1512
+ "type": "string",
1513
+ "enum": [
1514
+ "SMS",
1515
+ "EMAIL"
1516
+ ]
1517
+ },
1518
+ "PasswordActionTemplate": {
1519
+ "type": "object",
1520
+ "properties": {
1521
+ "channelId": {
1522
+ "type": "string",
1523
+ "maxLength": 36
1524
+ },
1525
+ "name": {
1526
+ "type": "string",
1527
+ "maxLength": 128
1528
+ },
1529
+ "subject": {
1530
+ "type": "string",
1531
+ "maxLength": 128
1532
+ },
1533
+ "link": {
1534
+ "type": "string",
1535
+ "maxLength": 2048
1536
+ },
1537
+ "locale": {
1538
+ "type": "string",
1539
+ "maxLength": 16
1540
+ },
1541
+ "actionType": {
1542
+ "$ref": "#/components/schemas/PasswordTemplateActionType"
1543
+ },
1544
+ "templateType": {
1545
+ "$ref": "#/components/schemas/PasswordTemplateType"
1546
+ },
1547
+ "template": {
1548
+ "type": "string",
1549
+ "maxLength": 2048
1550
+ }
1551
+ },
1552
+ "required": [
1553
+ "actionType",
1554
+ "channelId",
1555
+ "link",
1556
+ "locale",
1557
+ "name",
1558
+ "subject",
1559
+ "template",
1560
+ "templateType"
1561
+ ]
1562
+ },
1563
+ "IdentityProviderResponse": {
1564
+ "type": "object",
1565
+ "properties": {
1566
+ "name": {
1567
+ "type": "string",
1568
+ "maxLength": 200
1569
+ },
1570
+ "authUrl": {
1571
+ "type": "string",
1572
+ "maxLength": 256
1573
+ },
1574
+ "tokenUrl": {
1575
+ "type": "string",
1576
+ "maxLength": 256
1577
+ },
1578
+ "tokenInfoUrl": {
1579
+ "type": "string",
1580
+ "maxLength": 256
1581
+ },
1582
+ "userInfoUrl": {
1583
+ "type": "string",
1584
+ "maxLength": 256
1585
+ },
1586
+ "redirectUrl": {
1587
+ "type": "string",
1588
+ "maxLength": 256
1589
+ },
1590
+ "wellKnownUrl": {
1591
+ "type": "string",
1592
+ "maxLength": 256
1593
+ },
1594
+ "clientId": {
1595
+ "type": "string",
1596
+ "maxLength": 128
1597
+ },
1598
+ "clientSecret": {
1599
+ "type": "string",
1600
+ "maxLength": 512
1601
+ },
1602
+ "isPreferred": {
1603
+ "type": "boolean",
1604
+ "maxLength": 1
1605
+ },
1606
+ "isClientCredsBody": {
1607
+ "type": "boolean",
1608
+ "maxLength": 1
1609
+ },
1610
+ "scopes": {
1611
+ "type": "array",
1612
+ "items": {
1613
+ "type": "string",
1614
+ "maxLength": 8192
1615
+ }
1616
+ },
1617
+ "teamId": {
1618
+ "type": "string",
1619
+ "maxLength": 32
1620
+ },
1621
+ "keyId": {
1622
+ "type": "string",
1623
+ "maxLength": 8192
1624
+ },
1625
+ "loginMergeClaims": {
1626
+ "type": "array",
1627
+ "items": {
1628
+ "type": "string",
1629
+ "maxLength": 256
1630
+ }
1631
+ },
1632
+ "oidcClaimMapper": {
1633
+ "type": "array",
1634
+ "items": {
1635
+ "type": "string",
1636
+ "maxLength": 1024
1637
+ }
1638
+ }
1639
+ },
1640
+ "required": [
1641
+ "authUrl",
1642
+ "clientId",
1643
+ "clientSecret",
1644
+ "isClientCredsBody",
1645
+ "isPreferred",
1646
+ "name",
1647
+ "redirectUrl",
1648
+ "scopes",
1649
+ "tokenInfoUrl",
1650
+ "tokenUrl",
1651
+ "userInfoUrl"
1652
+ ]
1653
+ },
1654
+ "IdpListResponse": {
1655
+ "type": "object",
1656
+ "properties": {
1657
+ "data": {
1658
+ "type": "array",
1659
+ "items": {
1660
+ "$ref": "#/components/schemas/IdentityProviderResponse"
1661
+ }
1662
+ }
1663
+ },
1664
+ "required": [
1665
+ "data"
1666
+ ]
1667
+ },
1668
+ "IdentityProvider": {
1669
+ "type": "object",
1670
+ "properties": {
1671
+ "name": {
1672
+ "type": "string",
1673
+ "enum": [
1674
+ "adfs",
1675
+ "apple",
1676
+ "auth0",
1677
+ "azure",
1678
+ "cognito",
1679
+ "facebook",
1680
+ "forgerock",
1681
+ "gigya",
1682
+ "gigya_social",
1683
+ "google",
1684
+ "okta",
1685
+ "ping",
1686
+ "salesforce"
1687
+ ],
1688
+ "maxLength": 200
1689
+ },
1690
+ "authUrl": {
1691
+ "type": "string",
1692
+ "maxLength": 256
1693
+ },
1694
+ "tokenUrl": {
1695
+ "type": "string",
1696
+ "maxLength": 256
1697
+ },
1698
+ "tokenInfoUrl": {
1699
+ "type": "string",
1700
+ "maxLength": 256
1701
+ },
1702
+ "userInfoUrl": {
1703
+ "type": "string",
1704
+ "maxLength": 256
1705
+ },
1706
+ "redirectUrl": {
1707
+ "type": "string",
1708
+ "maxLength": 256
1709
+ },
1710
+ "wellKnownUrl": {
1711
+ "type": "string",
1712
+ "maxLength": 256
1713
+ },
1714
+ "clientId": {
1715
+ "type": "string",
1716
+ "maxLength": 128
1717
+ },
1718
+ "clientSecret": {
1719
+ "type": "string",
1720
+ "maxLength": 512
1721
+ },
1722
+ "preferenceValue": {
1723
+ "type": "boolean",
1724
+ "maxLength": 1
1725
+ },
1726
+ "isClientCredsBody": {
1727
+ "type": "boolean",
1728
+ "maxLength": 1
1729
+ },
1730
+ "useWellKnown": {
1731
+ "type": "boolean",
1732
+ "maxLength": 1
1733
+ },
1734
+ "scopes": {
1735
+ "type": "array",
1736
+ "items": {
1737
+ "type": "string",
1738
+ "maxLength": 8192
1739
+ }
1740
+ },
1741
+ "teamId": {
1742
+ "type": "string",
1743
+ "maxLength": 32
1744
+ },
1745
+ "keyId": {
1746
+ "type": "string",
1747
+ "maxLength": 32
1748
+ },
1749
+ "loginMergeClaims": {
1750
+ "type": "array",
1751
+ "items": {
1752
+ "type": "string",
1753
+ "maxLength": 256
1754
+ }
1755
+ },
1756
+ "oidcClaimMapper": {
1757
+ "type": "array",
1758
+ "items": {
1759
+ "type": "string",
1760
+ "maxLength": 1024
1761
+ }
1762
+ }
1763
+ },
1764
+ "required": [
1765
+ "authUrl",
1766
+ "clientId",
1767
+ "clientSecret",
1768
+ "isClientCredsBody",
1769
+ "name",
1770
+ "redirectUrl",
1771
+ "scopes",
1772
+ "tokenInfoUrl",
1773
+ "tokenUrl",
1774
+ "userInfoUrl",
1775
+ "wellKnownUrl"
1776
+ ]
1777
+ }
1778
+ },
1779
+ "parameters": {
1780
+ "tenantId": {
1781
+ "name": "tenantId",
1782
+ "in": "path",
1783
+ "required": true,
1784
+ "style": "simple",
1785
+ "explode": false,
1786
+ "schema": {
1787
+ "type": "string",
1788
+ "maxLength": 32
1789
+ }
1790
+ },
1791
+ "clientId": {
1792
+ "name": "clientId",
1793
+ "in": "path",
1794
+ "required": true,
1795
+ "style": "simple",
1796
+ "explode": false,
1797
+ "schema": {
1798
+ "type": "string",
1799
+ "maxLength": 36
1800
+ }
1801
+ },
1802
+ "channelId": {
1803
+ "name": "channelId",
1804
+ "in": "query",
1805
+ "required": true,
1806
+ "style": "form",
1807
+ "explode": true,
1808
+ "schema": {
1809
+ "type": "string",
1810
+ "maxLength": 100
1811
+ }
1812
+ },
1813
+ "actionType": {
1814
+ "name": "actionType",
1815
+ "in": "query",
1816
+ "required": true,
1817
+ "style": "form",
1818
+ "explode": true,
1819
+ "schema": {
1820
+ "type": "string",
1821
+ "enum": [
1822
+ "PWDLESS_LOGIN",
1823
+ "PWD_RESET_ACTION",
1824
+ "PWD_RESET_CROSS_DEVICE_ACTION"
1825
+ ],
1826
+ "maxLength": 36
1827
+ }
1828
+ },
1829
+ "templateType": {
1830
+ "name": "templateType",
1831
+ "in": "query",
1832
+ "required": true,
1833
+ "style": "form",
1834
+ "explode": true,
1835
+ "schema": {
1836
+ "type": "string",
1837
+ "enum": [
1838
+ "EMAIL",
1839
+ "SMS"
1840
+ ],
1841
+ "maxLength": 8
1842
+ }
1843
+ },
1844
+ "locale": {
1845
+ "name": "locale",
1846
+ "in": "query",
1847
+ "required": true,
1848
+ "style": "form",
1849
+ "explode": true,
1850
+ "schema": {
1851
+ "type": "string",
1852
+ "pattern": "^[a-z][a-z]-[A-Z][A-Z]$"
1853
+ }
1854
+ },
1855
+ "name": {
1856
+ "name": "name",
1857
+ "in": "path",
1858
+ "required": true,
1859
+ "style": "simple",
1860
+ "explode": false,
1861
+ "schema": {
1862
+ "type": "string",
1863
+ "maxLength": 256
1864
+ }
1865
+ },
1866
+ "customerId": {
1867
+ "name": "customerId",
1868
+ "in": "path",
1869
+ "required": true,
1870
+ "style": "simple",
1871
+ "explode": false,
1872
+ "schema": {
1873
+ "type": "string",
1874
+ "maxLength": 28
1875
+ }
1876
+ },
1877
+ "emailAddress": {
1878
+ "name": "emailAddress",
1879
+ "in": "query",
1880
+ "required": false,
1881
+ "style": "form",
1882
+ "explode": true,
1883
+ "schema": {
1884
+ "type": "string",
1885
+ "maxLength": 256
1886
+ }
1887
+ }
1888
+ },
1889
+ "securitySchemes": {
1890
+ "BearerToken": {
1891
+ "type": "http",
1892
+ "scheme": "bearer",
1893
+ "bearerFormat": "JWT"
1894
+ }
1895
+ }
1896
+ },
1897
+ "x-sdk-classname": "SlasAdmin"
1898
+ }