@adobe/aio-commerce-lib-app 1.6.0 → 1.7.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 (54) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/dist/cjs/actions/app-config/index.cjs +202 -0
  3. package/dist/cjs/actions/app-config/index.d.cts +31 -0
  4. package/dist/cjs/actions/{config.cjs → config/index.cjs} +61 -33
  5. package/dist/{es/actions/config.d.mts → cjs/actions/config/index.d.cts} +10 -7
  6. package/dist/cjs/actions/{installation.cjs → installation/index.cjs} +43 -30
  7. package/dist/{es/actions/installation.d.mts → cjs/actions/installation/index.d.cts} +10 -8
  8. package/dist/cjs/actions/{registration.cjs → registration/index.cjs} +16 -6
  9. package/dist/cjs/actions/{registration.d.cts → registration/index.d.cts} +8 -8
  10. package/dist/cjs/actions/{scope-tree.cjs → scope-tree/index.cjs} +51 -14
  11. package/dist/cjs/actions/{scope-tree.d.cts → scope-tree/index.d.cts} +1 -1
  12. package/dist/cjs/{admin-ui-sdk-DZZJCrdT.d.cts → admin-ui-sdk-EU915zlR.d.cts} +7 -8
  13. package/dist/cjs/app-DrYHK-z1.d.cts +1629 -0
  14. package/dist/cjs/commands/index.cjs +12 -18
  15. package/dist/cjs/config/index.cjs +2 -2
  16. package/dist/cjs/config/index.d.cts +36 -976
  17. package/dist/cjs/{config-FNMclIFO.cjs → config-D-s0GSep.cjs} +1 -1
  18. package/dist/cjs/{index-Dw2NvVOY.d.cts → index-B5gJ-q4U.d.cts} +172 -3
  19. package/dist/{es/actions/app-config.d.mts → cjs/index-BXm8UbK7.d.cts} +1 -13
  20. package/dist/cjs/management/index.cjs +1 -1
  21. package/dist/cjs/management/index.d.cts +1 -2
  22. package/dist/cjs/{management-Cvsz4VMf.cjs → management-Dehz9qSJ.cjs} +81 -43
  23. package/dist/cjs/openapi-Cux6K4ZD.cjs +3072 -0
  24. package/dist/cjs/{validate-DydOAZha.cjs → validate-oAOpyFyb.cjs} +46 -14
  25. package/dist/es/actions/app-config/index.d.mts +31 -0
  26. package/dist/es/actions/app-config/index.mjs +199 -0
  27. package/dist/{cjs/actions/config.d.cts → es/actions/config/index.d.mts} +10 -7
  28. package/dist/es/actions/{config.mjs → config/index.mjs} +60 -32
  29. package/dist/{cjs/actions/installation.d.cts → es/actions/installation/index.d.mts} +10 -8
  30. package/dist/es/actions/{installation.mjs → installation/index.mjs} +42 -30
  31. package/dist/es/actions/{registration.d.mts → registration/index.d.mts} +8 -8
  32. package/dist/es/actions/{registration.mjs → registration/index.mjs} +16 -6
  33. package/dist/es/actions/{scope-tree.d.mts → scope-tree/index.d.mts} +1 -1
  34. package/dist/es/actions/{scope-tree.mjs → scope-tree/index.mjs} +50 -13
  35. package/dist/es/{admin-ui-sdk-hu6iWr0A.d.mts → admin-ui-sdk-BwnD0xjK.d.mts} +6 -9
  36. package/dist/es/app-DrYHK-z1.d.mts +1629 -0
  37. package/dist/es/commands/index.mjs +12 -18
  38. package/dist/es/config/index.d.mts +36 -975
  39. package/dist/es/config/index.mjs +2 -2
  40. package/dist/es/{config-CcE0EBG7.mjs → config-3I4eLyyR.mjs} +1 -1
  41. package/dist/{cjs/actions/app-config.d.cts → es/index-B0XqHwY5.d.mts} +2 -14
  42. package/dist/es/{index-Bo0tQsVq.d.mts → index-DLMbTtKS.d.mts} +172 -3
  43. package/dist/es/management/index.d.mts +1 -2
  44. package/dist/es/management/index.mjs +1 -1
  45. package/dist/es/{management-BZ4Y6lVp.mjs → management-BUX-w2Ji.mjs} +81 -44
  46. package/dist/es/openapi-B6uP0SRn.mjs +3024 -0
  47. package/dist/es/{validate-Du3LhCre.mjs → validate-Dfajrp99.mjs} +35 -15
  48. package/package.json +17 -10
  49. package/dist/cjs/actions/app-config.cjs +0 -54
  50. package/dist/cjs/app-CakwxQvs.d.cts +0 -673
  51. package/dist/cjs/step-CKVE0aJi.d.cts +0 -187
  52. package/dist/es/actions/app-config.mjs +0 -53
  53. package/dist/es/app-CakwxQvs.d.mts +0 -673
  54. package/dist/es/step-D64mMPrt.d.mts +0 -187
@@ -0,0 +1,3024 @@
1
+ /**
2
+ * @license
3
+ *
4
+ * Copyright 2026 Adobe. All rights reserved.
5
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License. You may obtain a copy
7
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software distributed under
10
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
11
+ * OF ANY KIND, either express or implied. See the License for the specific language
12
+ * governing permissions and limitations under the License.
13
+ */
14
+
15
+ //#region docs/openapi.json
16
+ var openapi = "3.1.0";
17
+ var info = {
18
+ "title": "App Management API",
19
+ "description": "REST API for managing Adobe Commerce App Builder apps: resolving app configuration, managing configuration values, running the installation and uninstallation lifecycle, exposing the Admin UI SDK registration, and managing the scope tree.",
20
+ "version": "1.0.0",
21
+ "contact": {},
22
+ "license": {
23
+ "identifier": "Apache-2.0",
24
+ "name": "Apache-2.0"
25
+ },
26
+ "x-meta": { "packageVersion": "1.7.0" }
27
+ };
28
+ var servers = [{ "url": "/" }];
29
+ var paths = {
30
+ "/app-config": { "get": {
31
+ "operationId": "getAppConfig",
32
+ "summary": "Get Commerce App Configuration",
33
+ "description": "Returns the Commerce App configuration after resolving and validating it against the schema.",
34
+ "parameters": [{
35
+ "name": "x-gw-ims-org-id",
36
+ "in": "header",
37
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
38
+ "required": true,
39
+ "schema": { "type": "string" }
40
+ }],
41
+ "responses": {
42
+ "200": {
43
+ "description": "The resolved and validated Commerce App configuration.",
44
+ "content": { "application/json": { "schema": {
45
+ "description": "Current app configuration",
46
+ "type": "object",
47
+ "properties": {
48
+ "metadata": {
49
+ "type": "object",
50
+ "properties": {
51
+ "id": {
52
+ "type": "string",
53
+ "maxLength": 100,
54
+ "pattern": "^[a-zA-Z0-9-]+$"
55
+ },
56
+ "displayName": {
57
+ "type": "string",
58
+ "maxLength": 50,
59
+ "minLength": 1
60
+ },
61
+ "description": {
62
+ "type": "string",
63
+ "maxLength": 255,
64
+ "minLength": 1
65
+ },
66
+ "version": {
67
+ "type": "string",
68
+ "minLength": 1,
69
+ "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$"
70
+ }
71
+ },
72
+ "required": [
73
+ "id",
74
+ "displayName",
75
+ "description",
76
+ "version"
77
+ ]
78
+ },
79
+ "businessConfig": {
80
+ "type": "object",
81
+ "properties": { "schema": {
82
+ "type": "array",
83
+ "items": { "oneOf": [
84
+ { "oneOf": [{
85
+ "type": "object",
86
+ "properties": {
87
+ "name": {
88
+ "type": "string",
89
+ "minLength": 1
90
+ },
91
+ "label": { "type": "string" },
92
+ "description": { "type": "string" },
93
+ "env": {
94
+ "type": "array",
95
+ "items": {
96
+ "enum": ["paas", "saas"],
97
+ "type": "string"
98
+ },
99
+ "minItems": 1
100
+ },
101
+ "type": { "const": "list" },
102
+ "options": {
103
+ "type": "array",
104
+ "items": {
105
+ "type": "object",
106
+ "properties": {
107
+ "label": { "type": "string" },
108
+ "value": { "type": "string" }
109
+ },
110
+ "required": ["label", "value"]
111
+ }
112
+ },
113
+ "selectionMode": { "const": "single" },
114
+ "default": {
115
+ "type": "string",
116
+ "minLength": 1
117
+ }
118
+ },
119
+ "required": [
120
+ "name",
121
+ "type",
122
+ "options",
123
+ "selectionMode",
124
+ "default"
125
+ ]
126
+ }, {
127
+ "type": "object",
128
+ "properties": {
129
+ "name": {
130
+ "type": "string",
131
+ "minLength": 1
132
+ },
133
+ "label": { "type": "string" },
134
+ "description": { "type": "string" },
135
+ "env": {
136
+ "type": "array",
137
+ "items": {
138
+ "enum": ["paas", "saas"],
139
+ "type": "string"
140
+ },
141
+ "minItems": 1
142
+ },
143
+ "type": { "const": "list" },
144
+ "options": {
145
+ "type": "array",
146
+ "items": {
147
+ "type": "object",
148
+ "properties": {
149
+ "label": { "type": "string" },
150
+ "value": { "type": "string" }
151
+ },
152
+ "required": ["label", "value"]
153
+ }
154
+ },
155
+ "selectionMode": { "const": "multiple" },
156
+ "default": {
157
+ "type": "array",
158
+ "items": {
159
+ "type": "string",
160
+ "minLength": 1
161
+ }
162
+ }
163
+ },
164
+ "required": [
165
+ "name",
166
+ "type",
167
+ "options",
168
+ "selectionMode",
169
+ "default"
170
+ ]
171
+ }] },
172
+ {
173
+ "type": "object",
174
+ "properties": {
175
+ "name": {
176
+ "type": "string",
177
+ "minLength": 1
178
+ },
179
+ "label": { "type": "string" },
180
+ "description": { "type": "string" },
181
+ "env": {
182
+ "type": "array",
183
+ "items": {
184
+ "enum": ["paas", "saas"],
185
+ "type": "string"
186
+ },
187
+ "minItems": 1
188
+ },
189
+ "type": { "const": "text" },
190
+ "default": { "type": "string" }
191
+ },
192
+ "required": [
193
+ "name",
194
+ "type",
195
+ "default"
196
+ ]
197
+ },
198
+ {
199
+ "type": "object",
200
+ "properties": {
201
+ "name": {
202
+ "type": "string",
203
+ "minLength": 1
204
+ },
205
+ "label": { "type": "string" },
206
+ "description": { "type": "string" },
207
+ "env": {
208
+ "type": "array",
209
+ "items": {
210
+ "enum": ["paas", "saas"],
211
+ "type": "string"
212
+ },
213
+ "minItems": 1
214
+ },
215
+ "type": { "const": "password" },
216
+ "default": { "const": "" }
217
+ },
218
+ "required": [
219
+ "name",
220
+ "type",
221
+ "default"
222
+ ]
223
+ },
224
+ {
225
+ "type": "object",
226
+ "properties": {
227
+ "name": {
228
+ "type": "string",
229
+ "minLength": 1
230
+ },
231
+ "label": { "type": "string" },
232
+ "description": { "type": "string" },
233
+ "env": {
234
+ "type": "array",
235
+ "items": {
236
+ "enum": ["paas", "saas"],
237
+ "type": "string"
238
+ },
239
+ "minItems": 1
240
+ },
241
+ "type": { "const": "email" },
242
+ "default": { "anyOf": [{ "const": "" }, {
243
+ "type": "string",
244
+ "format": "email"
245
+ }] }
246
+ },
247
+ "required": [
248
+ "name",
249
+ "type",
250
+ "default"
251
+ ]
252
+ },
253
+ {
254
+ "type": "object",
255
+ "properties": {
256
+ "name": {
257
+ "type": "string",
258
+ "minLength": 1
259
+ },
260
+ "label": { "type": "string" },
261
+ "description": { "type": "string" },
262
+ "env": {
263
+ "type": "array",
264
+ "items": {
265
+ "enum": ["paas", "saas"],
266
+ "type": "string"
267
+ },
268
+ "minItems": 1
269
+ },
270
+ "type": { "const": "url" },
271
+ "default": { "anyOf": [{ "const": "" }, {
272
+ "type": "string",
273
+ "format": "uri"
274
+ }] }
275
+ },
276
+ "required": [
277
+ "name",
278
+ "type",
279
+ "default"
280
+ ]
281
+ },
282
+ {
283
+ "type": "object",
284
+ "properties": {
285
+ "name": {
286
+ "type": "string",
287
+ "minLength": 1
288
+ },
289
+ "label": { "type": "string" },
290
+ "description": { "type": "string" },
291
+ "env": {
292
+ "type": "array",
293
+ "items": {
294
+ "enum": ["paas", "saas"],
295
+ "type": "string"
296
+ },
297
+ "minItems": 1
298
+ },
299
+ "type": { "const": "tel" },
300
+ "default": { "anyOf": [{ "const": "" }, {
301
+ "type": "string",
302
+ "pattern": "^\\+?[0-9\\s\\-()]+$"
303
+ }] }
304
+ },
305
+ "required": [
306
+ "name",
307
+ "type",
308
+ "default"
309
+ ]
310
+ },
311
+ {
312
+ "type": "object",
313
+ "properties": {
314
+ "name": {
315
+ "type": "string",
316
+ "minLength": 1
317
+ },
318
+ "label": { "type": "string" },
319
+ "description": { "type": "string" },
320
+ "env": {
321
+ "type": "array",
322
+ "items": {
323
+ "enum": ["paas", "saas"],
324
+ "type": "string"
325
+ },
326
+ "minItems": 1
327
+ },
328
+ "type": { "const": "boolean" },
329
+ "default": { "type": "boolean" }
330
+ },
331
+ "required": [
332
+ "name",
333
+ "type",
334
+ "default"
335
+ ]
336
+ }
337
+ ] },
338
+ "minItems": 1
339
+ } },
340
+ "required": []
341
+ },
342
+ "eventing": {
343
+ "type": "object",
344
+ "properties": {
345
+ "commerce": {
346
+ "type": "array",
347
+ "items": {
348
+ "type": "object",
349
+ "properties": {
350
+ "provider": { "$ref": "#/components/schemas/EventProvider" },
351
+ "events": {
352
+ "type": "array",
353
+ "items": {
354
+ "type": "object",
355
+ "properties": {
356
+ "label": {
357
+ "type": "string",
358
+ "maxLength": 100,
359
+ "minLength": 1,
360
+ "pattern": "^[a-zA-Z0-9 _.:()\\-,@/]+$"
361
+ },
362
+ "description": {
363
+ "type": "string",
364
+ "maxLength": 255,
365
+ "minLength": 1,
366
+ "pattern": "^[a-zA-Z0-9 _.:()\\-,@/]+$"
367
+ },
368
+ "runtimeActions": {
369
+ "type": "array",
370
+ "items": {
371
+ "type": "string",
372
+ "minLength": 1,
373
+ "pattern": "^[a-zA-Z0-9-]+\\/[a-zA-Z0-9-]+$"
374
+ }
375
+ },
376
+ "name": {
377
+ "type": "string",
378
+ "maxLength": 180,
379
+ "minLength": 1,
380
+ "pattern": "^(?:plugin|observer)\\.[a-z_]+(?:\\.[a-z_]+)*$"
381
+ },
382
+ "fields": {
383
+ "type": "array",
384
+ "items": { "$ref": "#/components/schemas/CommerceEventField" },
385
+ "minItems": 1
386
+ },
387
+ "rules": {
388
+ "type": "array",
389
+ "items": { "$ref": "#/components/schemas/CommerceEventRule" }
390
+ },
391
+ "destination": {
392
+ "type": "string",
393
+ "minLength": 1
394
+ },
395
+ "hipaa_audit_required": { "type": "boolean" },
396
+ "priority": { "type": "boolean" },
397
+ "force": { "type": "boolean" }
398
+ },
399
+ "required": [
400
+ "label",
401
+ "description",
402
+ "runtimeActions",
403
+ "name",
404
+ "fields"
405
+ ]
406
+ }
407
+ }
408
+ },
409
+ "required": ["provider", "events"]
410
+ }
411
+ },
412
+ "external": {
413
+ "type": "array",
414
+ "items": {
415
+ "type": "object",
416
+ "properties": {
417
+ "provider": { "$ref": "#/components/schemas/EventProvider" },
418
+ "events": {
419
+ "type": "array",
420
+ "items": {
421
+ "type": "object",
422
+ "properties": {
423
+ "label": {
424
+ "type": "string",
425
+ "maxLength": 100,
426
+ "minLength": 1,
427
+ "pattern": "^[a-zA-Z0-9 _.:()\\-,@/]+$"
428
+ },
429
+ "description": {
430
+ "type": "string",
431
+ "maxLength": 255,
432
+ "minLength": 1,
433
+ "pattern": "^[a-zA-Z0-9 _.:()\\-,@/]+$"
434
+ },
435
+ "runtimeActions": {
436
+ "type": "array",
437
+ "items": {
438
+ "type": "string",
439
+ "minLength": 1,
440
+ "pattern": "^[a-zA-Z0-9-]+\\/[a-zA-Z0-9-]+$"
441
+ }
442
+ },
443
+ "name": {
444
+ "type": "string",
445
+ "maxLength": 180,
446
+ "minLength": 1,
447
+ "pattern": "^[\\w\\-_.]+$"
448
+ }
449
+ },
450
+ "required": [
451
+ "label",
452
+ "description",
453
+ "runtimeActions",
454
+ "name"
455
+ ]
456
+ }
457
+ }
458
+ },
459
+ "required": ["provider", "events"]
460
+ }
461
+ }
462
+ },
463
+ "required": []
464
+ },
465
+ "adminUiSdk": {
466
+ "type": "object",
467
+ "properties": { "registration": { "$ref": "#/components/schemas/AdminUiSdkRegistration" } },
468
+ "required": ["registration"]
469
+ },
470
+ "installation": {
471
+ "type": "object",
472
+ "properties": {
473
+ "messages": {
474
+ "type": "object",
475
+ "properties": {
476
+ "preInstallation": {
477
+ "type": "string",
478
+ "maxLength": 1e3,
479
+ "minLength": 1
480
+ },
481
+ "postInstallation": {
482
+ "type": "string",
483
+ "maxLength": 1e3,
484
+ "minLength": 1
485
+ }
486
+ },
487
+ "required": []
488
+ },
489
+ "customInstallationSteps": {
490
+ "type": "array",
491
+ "items": {
492
+ "type": "object",
493
+ "properties": {
494
+ "script": {
495
+ "type": "string",
496
+ "minLength": 1,
497
+ "pattern": "^(?:\\.{0,2}\\/)*[\\w-/]*[\\w-]+\\.js$"
498
+ },
499
+ "name": {
500
+ "type": "string",
501
+ "maxLength": 255,
502
+ "minLength": 1
503
+ },
504
+ "description": {
505
+ "type": "string",
506
+ "maxLength": 255,
507
+ "minLength": 1
508
+ }
509
+ },
510
+ "required": [
511
+ "script",
512
+ "name",
513
+ "description"
514
+ ]
515
+ }
516
+ }
517
+ },
518
+ "required": []
519
+ },
520
+ "webhooks": {
521
+ "type": "array",
522
+ "items": { "oneOf": [{ "$ref": "#/components/schemas/RuntimeActionWebhookConfig" }, { "$ref": "#/components/schemas/ExternalUrlWebhookConfig" }] },
523
+ "minItems": 1
524
+ },
525
+ "openApiSpecUrl": {
526
+ "description": "URL of the OpenAPI spec for this deployment, scoped to the active capabilities. Includes a content-addressed cache key as a query parameter.",
527
+ "type": "string",
528
+ "format": "uri",
529
+ "examples": ["https://123456-projectname-workspacename.adobeioruntime.net/api/v1/web/app-management/app-config/openapi.json?ck=4f6a2b9c"]
530
+ }
531
+ },
532
+ "additionalProperties": true,
533
+ "required": ["metadata", "openApiSpecUrl"]
534
+ } } }
535
+ },
536
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
537
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
538
+ "500": {
539
+ "description": "An unexpected server error occurred.",
540
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
541
+ }
542
+ },
543
+ "tags": ["App Metadata"]
544
+ } },
545
+ "/config": {
546
+ "get": {
547
+ "operationId": "getConfiguration",
548
+ "summary": "Get Configuration Values",
549
+ "description": "Returns the application configuration schema and the stored values for the requested scope.",
550
+ "parameters": [
551
+ {
552
+ "name": "scopeId",
553
+ "in": "query",
554
+ "required": true,
555
+ "schema": {
556
+ "type": "string",
557
+ "minLength": 1
558
+ }
559
+ },
560
+ {
561
+ "name": "commerceEnv",
562
+ "in": "query",
563
+ "required": false,
564
+ "schema": {
565
+ "type": "string",
566
+ "enum": ["paas", "saas"]
567
+ }
568
+ },
569
+ {
570
+ "name": "x-gw-ims-org-id",
571
+ "in": "header",
572
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
573
+ "required": true,
574
+ "schema": { "type": "string" }
575
+ }
576
+ ],
577
+ "responses": {
578
+ "200": {
579
+ "description": "The configuration schema and the stored configuration values for the requested scope. Password fields are masked in the response.",
580
+ "content": { "application/json": { "schema": {
581
+ "description": "Current configuration values for the given scope",
582
+ "type": "object",
583
+ "properties": {
584
+ "schema": {
585
+ "type": "array",
586
+ "items": { "oneOf": [
587
+ { "oneOf": [{
588
+ "type": "object",
589
+ "properties": {
590
+ "name": {
591
+ "type": "string",
592
+ "minLength": 1
593
+ },
594
+ "label": { "type": "string" },
595
+ "description": { "type": "string" },
596
+ "env": {
597
+ "type": "array",
598
+ "items": {
599
+ "enum": ["paas", "saas"],
600
+ "type": "string"
601
+ },
602
+ "minItems": 1
603
+ },
604
+ "type": { "const": "list" },
605
+ "options": {
606
+ "type": "array",
607
+ "items": {
608
+ "type": "object",
609
+ "properties": {
610
+ "label": { "type": "string" },
611
+ "value": { "type": "string" }
612
+ },
613
+ "required": ["label", "value"]
614
+ }
615
+ },
616
+ "selectionMode": { "const": "single" },
617
+ "default": {
618
+ "type": "string",
619
+ "minLength": 1
620
+ }
621
+ },
622
+ "required": [
623
+ "name",
624
+ "type",
625
+ "options",
626
+ "selectionMode",
627
+ "default"
628
+ ]
629
+ }, {
630
+ "type": "object",
631
+ "properties": {
632
+ "name": {
633
+ "type": "string",
634
+ "minLength": 1
635
+ },
636
+ "label": { "type": "string" },
637
+ "description": { "type": "string" },
638
+ "env": {
639
+ "type": "array",
640
+ "items": {
641
+ "enum": ["paas", "saas"],
642
+ "type": "string"
643
+ },
644
+ "minItems": 1
645
+ },
646
+ "type": { "const": "list" },
647
+ "options": {
648
+ "type": "array",
649
+ "items": {
650
+ "type": "object",
651
+ "properties": {
652
+ "label": { "type": "string" },
653
+ "value": { "type": "string" }
654
+ },
655
+ "required": ["label", "value"]
656
+ }
657
+ },
658
+ "selectionMode": { "const": "multiple" },
659
+ "default": {
660
+ "type": "array",
661
+ "items": {
662
+ "type": "string",
663
+ "minLength": 1
664
+ }
665
+ }
666
+ },
667
+ "required": [
668
+ "name",
669
+ "type",
670
+ "options",
671
+ "selectionMode",
672
+ "default"
673
+ ]
674
+ }] },
675
+ {
676
+ "type": "object",
677
+ "properties": {
678
+ "name": {
679
+ "type": "string",
680
+ "minLength": 1
681
+ },
682
+ "label": { "type": "string" },
683
+ "description": { "type": "string" },
684
+ "env": {
685
+ "type": "array",
686
+ "items": {
687
+ "enum": ["paas", "saas"],
688
+ "type": "string"
689
+ },
690
+ "minItems": 1
691
+ },
692
+ "type": { "const": "text" },
693
+ "default": { "type": "string" }
694
+ },
695
+ "required": [
696
+ "name",
697
+ "type",
698
+ "default"
699
+ ]
700
+ },
701
+ {
702
+ "type": "object",
703
+ "properties": {
704
+ "name": {
705
+ "type": "string",
706
+ "minLength": 1
707
+ },
708
+ "label": { "type": "string" },
709
+ "description": { "type": "string" },
710
+ "env": {
711
+ "type": "array",
712
+ "items": {
713
+ "enum": ["paas", "saas"],
714
+ "type": "string"
715
+ },
716
+ "minItems": 1
717
+ },
718
+ "type": { "const": "password" },
719
+ "default": { "const": "" }
720
+ },
721
+ "required": [
722
+ "name",
723
+ "type",
724
+ "default"
725
+ ]
726
+ },
727
+ {
728
+ "type": "object",
729
+ "properties": {
730
+ "name": {
731
+ "type": "string",
732
+ "minLength": 1
733
+ },
734
+ "label": { "type": "string" },
735
+ "description": { "type": "string" },
736
+ "env": {
737
+ "type": "array",
738
+ "items": {
739
+ "enum": ["paas", "saas"],
740
+ "type": "string"
741
+ },
742
+ "minItems": 1
743
+ },
744
+ "type": { "const": "email" },
745
+ "default": { "anyOf": [{ "const": "" }, {
746
+ "type": "string",
747
+ "format": "email"
748
+ }] }
749
+ },
750
+ "required": [
751
+ "name",
752
+ "type",
753
+ "default"
754
+ ]
755
+ },
756
+ {
757
+ "type": "object",
758
+ "properties": {
759
+ "name": {
760
+ "type": "string",
761
+ "minLength": 1
762
+ },
763
+ "label": { "type": "string" },
764
+ "description": { "type": "string" },
765
+ "env": {
766
+ "type": "array",
767
+ "items": {
768
+ "enum": ["paas", "saas"],
769
+ "type": "string"
770
+ },
771
+ "minItems": 1
772
+ },
773
+ "type": { "const": "url" },
774
+ "default": { "anyOf": [{ "const": "" }, {
775
+ "type": "string",
776
+ "format": "uri"
777
+ }] }
778
+ },
779
+ "required": [
780
+ "name",
781
+ "type",
782
+ "default"
783
+ ]
784
+ },
785
+ {
786
+ "type": "object",
787
+ "properties": {
788
+ "name": {
789
+ "type": "string",
790
+ "minLength": 1
791
+ },
792
+ "label": { "type": "string" },
793
+ "description": { "type": "string" },
794
+ "env": {
795
+ "type": "array",
796
+ "items": {
797
+ "enum": ["paas", "saas"],
798
+ "type": "string"
799
+ },
800
+ "minItems": 1
801
+ },
802
+ "type": { "const": "tel" },
803
+ "default": { "anyOf": [{ "const": "" }, {
804
+ "type": "string",
805
+ "pattern": "^\\+?[0-9\\s\\-()]+$"
806
+ }] }
807
+ },
808
+ "required": [
809
+ "name",
810
+ "type",
811
+ "default"
812
+ ]
813
+ },
814
+ {
815
+ "type": "object",
816
+ "properties": {
817
+ "name": {
818
+ "type": "string",
819
+ "minLength": 1
820
+ },
821
+ "label": { "type": "string" },
822
+ "description": { "type": "string" },
823
+ "env": {
824
+ "type": "array",
825
+ "items": {
826
+ "enum": ["paas", "saas"],
827
+ "type": "string"
828
+ },
829
+ "minItems": 1
830
+ },
831
+ "type": { "const": "boolean" },
832
+ "default": { "type": "boolean" }
833
+ },
834
+ "required": [
835
+ "name",
836
+ "type",
837
+ "default"
838
+ ]
839
+ }
840
+ ] }
841
+ },
842
+ "values": {
843
+ "type": "object",
844
+ "properties": {
845
+ "scope": { "$ref": "#/components/schemas/ConfigScope" },
846
+ "config": {
847
+ "type": "array",
848
+ "items": { "$ref": "#/components/schemas/ConfigValue" }
849
+ }
850
+ },
851
+ "required": ["scope", "config"]
852
+ }
853
+ },
854
+ "required": ["schema", "values"]
855
+ } } }
856
+ },
857
+ "400": {
858
+ "description": "The request is invalid or could not be parsed.",
859
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }
860
+ },
861
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
862
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
863
+ "500": {
864
+ "description": "An unexpected server error occurred.",
865
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
866
+ }
867
+ },
868
+ "tags": ["Business Configuration"]
869
+ },
870
+ "put": {
871
+ "operationId": "putConfiguration",
872
+ "summary": "Set Configuration Values (Deprecated)",
873
+ "description": "Replaces all configuration values for a scope. This endpoint is deprecated in favor of PATCH.",
874
+ "parameters": [{
875
+ "name": "x-gw-ims-org-id",
876
+ "in": "header",
877
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
878
+ "required": true,
879
+ "schema": { "type": "string" }
880
+ }],
881
+ "requestBody": {
882
+ "required": true,
883
+ "content": { "application/json": { "schema": {
884
+ "type": "object",
885
+ "properties": {
886
+ "scopeId": {
887
+ "type": "string",
888
+ "minLength": 1
889
+ },
890
+ "config": {
891
+ "type": "array",
892
+ "items": {
893
+ "type": "object",
894
+ "properties": {
895
+ "name": {
896
+ "type": "string",
897
+ "minLength": 1
898
+ },
899
+ "value": { "anyOf": [{ "type": "string" }, {
900
+ "type": "array",
901
+ "items": { "type": "string" }
902
+ }] }
903
+ },
904
+ "required": ["name", "value"]
905
+ }
906
+ }
907
+ },
908
+ "required": ["scopeId", "config"]
909
+ } } }
910
+ },
911
+ "responses": {
912
+ "200": {
913
+ "description": "The configuration values were successfully updated. Returns the updated configuration with password fields masked.",
914
+ "headers": {
915
+ "Cache-Control": {
916
+ "description": "Prevents clients from caching configuration mutation responses.",
917
+ "schema": { "const": "no-store" }
918
+ },
919
+ "Deprecation": {
920
+ "description": "Date when the deprecated PUT configuration endpoint was marked deprecated.",
921
+ "schema": {
922
+ "type": "string",
923
+ "pattern": "^[A-Z][a-z]{2}, \\d{2} [A-Z][a-z]{2} \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$"
924
+ }
925
+ }
926
+ },
927
+ "content": { "application/json": { "schema": {
928
+ "description": "Configuration values updated. Use PATCH instead.",
929
+ "type": "object",
930
+ "properties": {
931
+ "message": { "type": "string" },
932
+ "timestamp": {
933
+ "type": "string",
934
+ "format": "date-time"
935
+ },
936
+ "scope": { "$ref": "#/components/schemas/ConfigScope" },
937
+ "config": {
938
+ "type": "array",
939
+ "items": { "$ref": "#/components/schemas/ConfigUpdateEntry" }
940
+ }
941
+ },
942
+ "required": [
943
+ "message",
944
+ "timestamp",
945
+ "scope",
946
+ "config"
947
+ ]
948
+ } } }
949
+ },
950
+ "400": {
951
+ "description": "The request is invalid or could not be parsed.",
952
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }
953
+ },
954
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
955
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
956
+ "500": {
957
+ "description": "An unexpected server error occurred.",
958
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
959
+ }
960
+ },
961
+ "deprecated": true,
962
+ "tags": ["Business Configuration"]
963
+ },
964
+ "patch": {
965
+ "operationId": "patchConfiguration",
966
+ "summary": "Patch Configuration Values",
967
+ "description": "Partially updates configuration values for a scope. Unsets those values that are sent with a null value.",
968
+ "parameters": [{
969
+ "name": "x-gw-ims-org-id",
970
+ "in": "header",
971
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
972
+ "required": true,
973
+ "schema": { "type": "string" }
974
+ }],
975
+ "requestBody": {
976
+ "required": true,
977
+ "content": { "application/json": { "schema": {
978
+ "type": "object",
979
+ "properties": {
980
+ "scopeId": {
981
+ "type": "string",
982
+ "minLength": 1
983
+ },
984
+ "config": {
985
+ "type": "array",
986
+ "items": {
987
+ "type": "object",
988
+ "properties": {
989
+ "name": {
990
+ "type": "string",
991
+ "minLength": 1
992
+ },
993
+ "value": { "anyOf": [{ "anyOf": [
994
+ { "type": "boolean" },
995
+ { "type": "string" },
996
+ {
997
+ "type": "array",
998
+ "items": { "type": "string" }
999
+ }
1000
+ ] }, { "type": "null" }] }
1001
+ },
1002
+ "required": ["name", "value"]
1003
+ }
1004
+ }
1005
+ },
1006
+ "required": ["scopeId", "config"]
1007
+ } } }
1008
+ },
1009
+ "responses": {
1010
+ "200": {
1011
+ "description": "The configuration values were successfully updated. Returns the updated configuration with password fields masked.",
1012
+ "headers": { "Cache-Control": {
1013
+ "description": "Prevents clients from caching configuration mutation responses.",
1014
+ "schema": { "const": "no-store" }
1015
+ } },
1016
+ "content": { "application/json": { "schema": {
1017
+ "description": "Configuration values updated for the given scope",
1018
+ "type": "object",
1019
+ "properties": {
1020
+ "message": { "type": "string" },
1021
+ "timestamp": {
1022
+ "type": "string",
1023
+ "format": "date-time"
1024
+ },
1025
+ "scope": { "$ref": "#/components/schemas/ConfigScope" },
1026
+ "config": {
1027
+ "type": "array",
1028
+ "items": { "$ref": "#/components/schemas/ConfigUpdateEntry" }
1029
+ }
1030
+ },
1031
+ "required": [
1032
+ "message",
1033
+ "timestamp",
1034
+ "scope",
1035
+ "config"
1036
+ ]
1037
+ } } }
1038
+ },
1039
+ "400": {
1040
+ "description": "The request is invalid or could not be parsed.",
1041
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }
1042
+ },
1043
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1044
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1045
+ "500": {
1046
+ "description": "An unexpected server error occurred.",
1047
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1048
+ }
1049
+ },
1050
+ "tags": ["Business Configuration"]
1051
+ }
1052
+ },
1053
+ "/installation": {
1054
+ "get": {
1055
+ "operationId": "getInstallationState",
1056
+ "summary": "Get Installation State",
1057
+ "description": "Returns the current installation workflow state if an installation has been started.",
1058
+ "parameters": [{
1059
+ "name": "x-gw-ims-org-id",
1060
+ "in": "header",
1061
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1062
+ "required": true,
1063
+ "schema": { "type": "string" }
1064
+ }],
1065
+ "responses": {
1066
+ "200": {
1067
+ "description": "The current installation workflow state.",
1068
+ "content": { "application/json": { "schema": {
1069
+ "discriminator": { "propertyName": "status" },
1070
+ "oneOf": [
1071
+ {
1072
+ "type": "object",
1073
+ "properties": {
1074
+ "id": { "type": "string" },
1075
+ "status": { "const": "in-progress" },
1076
+ "startedAt": {
1077
+ "type": "string",
1078
+ "format": "date-time"
1079
+ },
1080
+ "step": { "$ref": "#/components/schemas/StepStatus" },
1081
+ "data": { "anyOf": [{
1082
+ "type": "object",
1083
+ "propertyNames": { "type": "string" },
1084
+ "additionalProperties": {}
1085
+ }, { "type": "null" }] }
1086
+ },
1087
+ "required": [
1088
+ "id",
1089
+ "status",
1090
+ "startedAt",
1091
+ "step",
1092
+ "data"
1093
+ ]
1094
+ },
1095
+ {
1096
+ "type": "object",
1097
+ "properties": {
1098
+ "id": { "type": "string" },
1099
+ "status": { "const": "succeeded" },
1100
+ "startedAt": {
1101
+ "type": "string",
1102
+ "format": "date-time"
1103
+ },
1104
+ "completedAt": {
1105
+ "type": "string",
1106
+ "format": "date-time"
1107
+ },
1108
+ "step": { "$ref": "#/components/schemas/StepStatus" },
1109
+ "data": { "anyOf": [{
1110
+ "type": "object",
1111
+ "propertyNames": { "type": "string" },
1112
+ "additionalProperties": {}
1113
+ }, { "type": "null" }] },
1114
+ "metadata": {
1115
+ "type": "object",
1116
+ "properties": { "isRetry": { "type": "boolean" } },
1117
+ "required": ["isRetry"]
1118
+ }
1119
+ },
1120
+ "required": [
1121
+ "id",
1122
+ "status",
1123
+ "startedAt",
1124
+ "completedAt",
1125
+ "step",
1126
+ "data"
1127
+ ]
1128
+ },
1129
+ {
1130
+ "type": "object",
1131
+ "properties": {
1132
+ "id": { "type": "string" },
1133
+ "status": { "const": "failed" },
1134
+ "startedAt": {
1135
+ "type": "string",
1136
+ "format": "date-time"
1137
+ },
1138
+ "completedAt": {
1139
+ "type": "string",
1140
+ "format": "date-time"
1141
+ },
1142
+ "step": { "$ref": "#/components/schemas/StepStatus" },
1143
+ "data": { "anyOf": [{
1144
+ "type": "object",
1145
+ "propertyNames": { "type": "string" },
1146
+ "additionalProperties": {}
1147
+ }, { "type": "null" }] },
1148
+ "error": {
1149
+ "type": "object",
1150
+ "properties": {
1151
+ "path": {
1152
+ "type": "array",
1153
+ "items": { "type": "string" }
1154
+ },
1155
+ "key": { "type": "string" },
1156
+ "message": { "type": "string" },
1157
+ "payload": {}
1158
+ },
1159
+ "required": ["path", "key"]
1160
+ },
1161
+ "metadata": {
1162
+ "type": "object",
1163
+ "properties": { "isRetry": { "type": "boolean" } },
1164
+ "required": ["isRetry"]
1165
+ }
1166
+ },
1167
+ "required": [
1168
+ "id",
1169
+ "status",
1170
+ "startedAt",
1171
+ "completedAt",
1172
+ "step",
1173
+ "data",
1174
+ "error"
1175
+ ]
1176
+ }
1177
+ ]
1178
+ } } }
1179
+ },
1180
+ "204": { "description": "No installation workflow state has been stored yet." },
1181
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1182
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1183
+ "500": {
1184
+ "description": "An unexpected server error occurred.",
1185
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1186
+ }
1187
+ },
1188
+ "tags": ["Management"]
1189
+ },
1190
+ "post": {
1191
+ "operationId": "startInstallation",
1192
+ "summary": "Start Installation",
1193
+ "description": "Starts the installation workflow and stores the initial execution state.",
1194
+ "parameters": [{
1195
+ "name": "x-gw-ims-org-id",
1196
+ "in": "header",
1197
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1198
+ "required": true,
1199
+ "schema": { "type": "string" }
1200
+ }],
1201
+ "requestBody": {
1202
+ "required": true,
1203
+ "content": { "application/json": { "schema": {
1204
+ "type": "object",
1205
+ "properties": {
1206
+ "appData": { "$ref": "#/components/schemas/AppData" },
1207
+ "commerceBaseUrl": { "type": "string" },
1208
+ "commerceEnv": { "type": "string" },
1209
+ "ioEventsUrl": { "type": "string" },
1210
+ "ioEventsEnv": { "type": "string" }
1211
+ },
1212
+ "required": [
1213
+ "appData",
1214
+ "commerceBaseUrl",
1215
+ "commerceEnv",
1216
+ "ioEventsUrl",
1217
+ "ioEventsEnv"
1218
+ ]
1219
+ } } }
1220
+ },
1221
+ "responses": {
1222
+ "202": {
1223
+ "description": "The installation workflow was accepted and queued for asynchronous execution.",
1224
+ "content": { "application/json": { "schema": {
1225
+ "type": "object",
1226
+ "properties": {
1227
+ "message": { "type": "string" },
1228
+ "activationId": { "type": "string" },
1229
+ "id": { "type": "string" },
1230
+ "status": { "const": "in-progress" },
1231
+ "startedAt": {
1232
+ "type": "string",
1233
+ "format": "date-time"
1234
+ },
1235
+ "step": { "$ref": "#/components/schemas/StepStatus" },
1236
+ "data": { "anyOf": [{
1237
+ "type": "object",
1238
+ "propertyNames": { "type": "string" },
1239
+ "additionalProperties": {}
1240
+ }, { "type": "null" }] }
1241
+ },
1242
+ "required": [
1243
+ "message",
1244
+ "activationId",
1245
+ "id",
1246
+ "status",
1247
+ "startedAt",
1248
+ "step",
1249
+ "data"
1250
+ ]
1251
+ } } }
1252
+ },
1253
+ "400": {
1254
+ "description": "The request is invalid or could not be parsed.",
1255
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }
1256
+ },
1257
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1258
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1259
+ "409": {
1260
+ "description": "The installation workflow is already running or has already completed successfully.",
1261
+ "content": { "application/json": { "schema": {
1262
+ "type": "object",
1263
+ "properties": { "message": { "type": "string" } },
1264
+ "required": ["message"]
1265
+ } } }
1266
+ },
1267
+ "500": {
1268
+ "description": "An unexpected server error occurred.",
1269
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1270
+ }
1271
+ },
1272
+ "tags": ["Management"]
1273
+ }
1274
+ },
1275
+ "/installation/validation": { "post": {
1276
+ "operationId": "validateInstallation",
1277
+ "summary": "Validate Installation",
1278
+ "description": "Validates the installation inputs and workflow steps without starting installation.",
1279
+ "parameters": [{
1280
+ "name": "x-gw-ims-org-id",
1281
+ "in": "header",
1282
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1283
+ "required": true,
1284
+ "schema": { "type": "string" }
1285
+ }],
1286
+ "requestBody": {
1287
+ "required": true,
1288
+ "content": { "application/json": { "schema": {
1289
+ "type": "object",
1290
+ "properties": {
1291
+ "appData": { "$ref": "#/components/schemas/AppData" },
1292
+ "commerceBaseUrl": { "type": "string" },
1293
+ "commerceEnv": { "type": "string" },
1294
+ "ioEventsUrl": { "type": "string" },
1295
+ "ioEventsEnv": { "type": "string" }
1296
+ },
1297
+ "required": [
1298
+ "appData",
1299
+ "commerceBaseUrl",
1300
+ "commerceEnv",
1301
+ "ioEventsUrl",
1302
+ "ioEventsEnv"
1303
+ ]
1304
+ } } }
1305
+ },
1306
+ "responses": {
1307
+ "200": {
1308
+ "description": "The validation result, including issue counts and per-step validation results.",
1309
+ "content": { "application/json": { "schema": {
1310
+ "type": "object",
1311
+ "properties": {
1312
+ "valid": { "type": "boolean" },
1313
+ "summary": {
1314
+ "type": "object",
1315
+ "properties": {
1316
+ "totalIssues": { "type": "number" },
1317
+ "errors": { "type": "number" },
1318
+ "warnings": { "type": "number" }
1319
+ },
1320
+ "required": [
1321
+ "totalIssues",
1322
+ "errors",
1323
+ "warnings"
1324
+ ]
1325
+ },
1326
+ "result": { "$ref": "#/components/schemas/StepValidationResult" }
1327
+ },
1328
+ "required": [
1329
+ "valid",
1330
+ "summary",
1331
+ "result"
1332
+ ]
1333
+ } } }
1334
+ },
1335
+ "400": {
1336
+ "description": "The request is invalid or could not be parsed.",
1337
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }
1338
+ },
1339
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1340
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1341
+ "500": {
1342
+ "description": "An unexpected server error occurred.",
1343
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1344
+ }
1345
+ },
1346
+ "tags": ["Management"]
1347
+ } },
1348
+ "/installation/uninstallation": {
1349
+ "get": {
1350
+ "operationId": "getUninstallationState",
1351
+ "summary": "Get Uninstallation State",
1352
+ "description": "Returns the current uninstallation workflow state if an uninstallation has been started.",
1353
+ "parameters": [{
1354
+ "name": "x-gw-ims-org-id",
1355
+ "in": "header",
1356
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1357
+ "required": true,
1358
+ "schema": { "type": "string" }
1359
+ }],
1360
+ "responses": {
1361
+ "200": {
1362
+ "description": "The current uninstallation workflow state.",
1363
+ "content": { "application/json": { "schema": {
1364
+ "discriminator": { "propertyName": "status" },
1365
+ "oneOf": [
1366
+ {
1367
+ "type": "object",
1368
+ "properties": {
1369
+ "id": { "type": "string" },
1370
+ "status": { "const": "in-progress" },
1371
+ "startedAt": {
1372
+ "type": "string",
1373
+ "format": "date-time"
1374
+ },
1375
+ "step": { "$ref": "#/components/schemas/StepStatus" },
1376
+ "data": { "anyOf": [{
1377
+ "type": "object",
1378
+ "propertyNames": { "type": "string" },
1379
+ "additionalProperties": {}
1380
+ }, { "type": "null" }] }
1381
+ },
1382
+ "required": [
1383
+ "id",
1384
+ "status",
1385
+ "startedAt",
1386
+ "step",
1387
+ "data"
1388
+ ]
1389
+ },
1390
+ {
1391
+ "type": "object",
1392
+ "properties": {
1393
+ "id": { "type": "string" },
1394
+ "status": { "const": "succeeded" },
1395
+ "startedAt": {
1396
+ "type": "string",
1397
+ "format": "date-time"
1398
+ },
1399
+ "completedAt": {
1400
+ "type": "string",
1401
+ "format": "date-time"
1402
+ },
1403
+ "step": { "$ref": "#/components/schemas/StepStatus" },
1404
+ "data": { "anyOf": [{
1405
+ "type": "object",
1406
+ "propertyNames": { "type": "string" },
1407
+ "additionalProperties": {}
1408
+ }, { "type": "null" }] },
1409
+ "metadata": {
1410
+ "type": "object",
1411
+ "properties": { "isRetry": { "type": "boolean" } },
1412
+ "required": ["isRetry"]
1413
+ }
1414
+ },
1415
+ "required": [
1416
+ "id",
1417
+ "status",
1418
+ "startedAt",
1419
+ "completedAt",
1420
+ "step",
1421
+ "data"
1422
+ ]
1423
+ },
1424
+ {
1425
+ "type": "object",
1426
+ "properties": {
1427
+ "id": { "type": "string" },
1428
+ "status": { "const": "failed" },
1429
+ "startedAt": {
1430
+ "type": "string",
1431
+ "format": "date-time"
1432
+ },
1433
+ "completedAt": {
1434
+ "type": "string",
1435
+ "format": "date-time"
1436
+ },
1437
+ "step": { "$ref": "#/components/schemas/StepStatus" },
1438
+ "data": { "anyOf": [{
1439
+ "type": "object",
1440
+ "propertyNames": { "type": "string" },
1441
+ "additionalProperties": {}
1442
+ }, { "type": "null" }] },
1443
+ "error": {
1444
+ "type": "object",
1445
+ "properties": {
1446
+ "path": {
1447
+ "type": "array",
1448
+ "items": { "type": "string" }
1449
+ },
1450
+ "key": { "type": "string" },
1451
+ "message": { "type": "string" },
1452
+ "payload": {}
1453
+ },
1454
+ "required": ["path", "key"]
1455
+ },
1456
+ "metadata": {
1457
+ "type": "object",
1458
+ "properties": { "isRetry": { "type": "boolean" } },
1459
+ "required": ["isRetry"]
1460
+ }
1461
+ },
1462
+ "required": [
1463
+ "id",
1464
+ "status",
1465
+ "startedAt",
1466
+ "completedAt",
1467
+ "step",
1468
+ "data",
1469
+ "error"
1470
+ ]
1471
+ }
1472
+ ]
1473
+ } } }
1474
+ },
1475
+ "204": { "description": "No uninstallation workflow state has been stored yet." },
1476
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1477
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1478
+ "500": {
1479
+ "description": "An unexpected server error occurred.",
1480
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1481
+ }
1482
+ },
1483
+ "tags": ["Management"]
1484
+ },
1485
+ "post": {
1486
+ "operationId": "startUninstallation",
1487
+ "summary": "Start Uninstallation",
1488
+ "description": "Starts the uninstallation workflow and stores the initial execution state.",
1489
+ "parameters": [{
1490
+ "name": "x-gw-ims-org-id",
1491
+ "in": "header",
1492
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1493
+ "required": true,
1494
+ "schema": { "type": "string" }
1495
+ }],
1496
+ "requestBody": {
1497
+ "required": true,
1498
+ "content": { "application/json": { "schema": {
1499
+ "type": "object",
1500
+ "properties": {
1501
+ "appData": { "$ref": "#/components/schemas/AppData" },
1502
+ "commerceBaseUrl": { "type": "string" },
1503
+ "commerceEnv": { "type": "string" },
1504
+ "ioEventsUrl": { "type": "string" },
1505
+ "ioEventsEnv": { "type": "string" }
1506
+ },
1507
+ "required": [
1508
+ "appData",
1509
+ "commerceBaseUrl",
1510
+ "commerceEnv",
1511
+ "ioEventsUrl",
1512
+ "ioEventsEnv"
1513
+ ]
1514
+ } } }
1515
+ },
1516
+ "responses": {
1517
+ "202": {
1518
+ "description": "The uninstallation workflow was accepted and queued for asynchronous execution.",
1519
+ "content": { "application/json": { "schema": {
1520
+ "type": "object",
1521
+ "properties": {
1522
+ "message": { "type": "string" },
1523
+ "activationId": { "type": "string" },
1524
+ "id": { "type": "string" },
1525
+ "status": { "const": "in-progress" },
1526
+ "startedAt": {
1527
+ "type": "string",
1528
+ "format": "date-time"
1529
+ },
1530
+ "step": { "$ref": "#/components/schemas/StepStatus" },
1531
+ "data": { "anyOf": [{
1532
+ "type": "object",
1533
+ "propertyNames": { "type": "string" },
1534
+ "additionalProperties": {}
1535
+ }, { "type": "null" }] }
1536
+ },
1537
+ "required": [
1538
+ "message",
1539
+ "activationId",
1540
+ "id",
1541
+ "status",
1542
+ "startedAt",
1543
+ "step",
1544
+ "data"
1545
+ ]
1546
+ } } }
1547
+ },
1548
+ "400": {
1549
+ "description": "The request is invalid or could not be parsed.",
1550
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }
1551
+ },
1552
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1553
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1554
+ "409": {
1555
+ "description": "The uninstallation workflow is already running.",
1556
+ "content": { "application/json": { "schema": {
1557
+ "type": "object",
1558
+ "properties": { "message": { "type": "string" } },
1559
+ "required": ["message"]
1560
+ } } }
1561
+ },
1562
+ "500": {
1563
+ "description": "An unexpected server error occurred.",
1564
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1565
+ }
1566
+ },
1567
+ "tags": ["Management"]
1568
+ },
1569
+ "delete": {
1570
+ "operationId": "clearUninstallationState",
1571
+ "summary": "Clear Uninstallation State",
1572
+ "description": "Clears the stored uninstallation workflow state without starting offboarding.",
1573
+ "parameters": [{
1574
+ "name": "x-gw-ims-org-id",
1575
+ "in": "header",
1576
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1577
+ "required": true,
1578
+ "schema": { "type": "string" }
1579
+ }],
1580
+ "responses": {
1581
+ "204": { "description": "The stored uninstallation workflow state was cleared." },
1582
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1583
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1584
+ "500": {
1585
+ "description": "An unexpected server error occurred.",
1586
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1587
+ }
1588
+ },
1589
+ "tags": ["Management"]
1590
+ }
1591
+ },
1592
+ "/registration": { "get": {
1593
+ "operationId": "getRegistration",
1594
+ "summary": "Get Registration",
1595
+ "description": "Returns the Admin UI SDK registration object configured for this app.",
1596
+ "parameters": [{
1597
+ "name": "x-gw-ims-org-id",
1598
+ "in": "header",
1599
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1600
+ "required": true,
1601
+ "schema": { "type": "string" }
1602
+ }],
1603
+ "responses": {
1604
+ "200": {
1605
+ "description": "The Admin UI SDK registration payload.",
1606
+ "content": { "application/json": { "schema": {
1607
+ "type": "object",
1608
+ "properties": { "registration": { "$ref": "#/components/schemas/AdminUiSdkRegistration" } },
1609
+ "required": ["registration"]
1610
+ } } }
1611
+ },
1612
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1613
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1614
+ "500": {
1615
+ "description": "An unexpected server error occurred.",
1616
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1617
+ }
1618
+ },
1619
+ "tags": ["Admin UI"]
1620
+ } },
1621
+ "/scope-tree": {
1622
+ "get": {
1623
+ "operationId": "getScopeTree",
1624
+ "summary": "Get Scope Tree",
1625
+ "description": "Returns the scope tree used by Commerce configuration flows.",
1626
+ "parameters": [{
1627
+ "name": "x-gw-ims-org-id",
1628
+ "in": "header",
1629
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1630
+ "required": true,
1631
+ "schema": { "type": "string" }
1632
+ }],
1633
+ "responses": {
1634
+ "200": {
1635
+ "description": "The current scope tree, freshly fetched.",
1636
+ "content": { "application/json": { "schema": {
1637
+ "type": "object",
1638
+ "properties": { "scopes": {
1639
+ "type": "array",
1640
+ "items": { "$ref": "#/components/schemas/ScopeNode" }
1641
+ } },
1642
+ "required": ["scopes"]
1643
+ } } }
1644
+ },
1645
+ "203": {
1646
+ "description": "The scope tree returned from cache or persisted storage.",
1647
+ "headers": { "x-cache": {
1648
+ "description": "Indicates that the returned scope tree came from cache.",
1649
+ "schema": { "const": "hit" }
1650
+ } },
1651
+ "content": { "application/json": { "schema": {
1652
+ "description": "Cached scope tree",
1653
+ "type": "object",
1654
+ "properties": { "scopes": {
1655
+ "type": "array",
1656
+ "items": { "$ref": "#/components/schemas/ScopeNode" }
1657
+ } },
1658
+ "required": ["scopes"]
1659
+ } } }
1660
+ },
1661
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1662
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1663
+ "500": {
1664
+ "description": "An unexpected server error occurred.",
1665
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1666
+ }
1667
+ },
1668
+ "tags": ["Business Configuration"]
1669
+ },
1670
+ "put": {
1671
+ "operationId": "setCustomScopeTree",
1672
+ "summary": "Set Custom Scope Tree",
1673
+ "description": "Stores a custom scope tree to override the synchronized Commerce scope tree.",
1674
+ "parameters": [{
1675
+ "name": "x-gw-ims-org-id",
1676
+ "in": "header",
1677
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1678
+ "required": true,
1679
+ "schema": { "type": "string" }
1680
+ }],
1681
+ "requestBody": {
1682
+ "required": true,
1683
+ "content": { "application/json": { "schema": {
1684
+ "type": "object",
1685
+ "properties": { "scopes": {
1686
+ "description": "Custom scopes to store. Each code+level combination must be unique across the entire recursive tree.",
1687
+ "type": "array",
1688
+ "items": { "$ref": "#/components/schemas/CustomScopeInput" }
1689
+ } },
1690
+ "required": ["scopes"]
1691
+ } } }
1692
+ },
1693
+ "responses": {
1694
+ "200": {
1695
+ "description": "The stored custom scope tree result.",
1696
+ "headers": { "Cache-Control": {
1697
+ "description": "Prevents clients from caching custom scope tree mutation responses.",
1698
+ "schema": { "const": "no-store" }
1699
+ } },
1700
+ "content": { "application/json": { "schema": {
1701
+ "type": "object",
1702
+ "properties": { "result": {
1703
+ "type": "object",
1704
+ "properties": {
1705
+ "message": { "const": "Custom scope tree updated successfully" },
1706
+ "timestamp": {
1707
+ "type": "string",
1708
+ "format": "date-time"
1709
+ },
1710
+ "scopes": {
1711
+ "type": "array",
1712
+ "items": { "$ref": "#/components/schemas/CustomScopeOutput" }
1713
+ }
1714
+ },
1715
+ "required": [
1716
+ "message",
1717
+ "timestamp",
1718
+ "scopes"
1719
+ ]
1720
+ } },
1721
+ "required": ["result"]
1722
+ } } }
1723
+ },
1724
+ "400": {
1725
+ "description": "The request body is invalid: the scopes array is missing or not an array, a scope is missing a required field or has an invalid type, a scope uses a reserved code (commerce or global), or two scopes share the same code and level.",
1726
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }
1727
+ },
1728
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1729
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1730
+ "500": {
1731
+ "description": "An unexpected server error occurred.",
1732
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1733
+ }
1734
+ },
1735
+ "tags": ["Business Configuration"]
1736
+ }
1737
+ },
1738
+ "/scope-tree/commerce": {
1739
+ "post": {
1740
+ "operationId": "syncCommerceScopes",
1741
+ "summary": "Sync Commerce Scopes",
1742
+ "description": "Synchronizes scope data from Adobe Commerce and updates the local scope tree.",
1743
+ "parameters": [{
1744
+ "name": "x-gw-ims-org-id",
1745
+ "in": "header",
1746
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1747
+ "required": true,
1748
+ "schema": { "type": "string" }
1749
+ }],
1750
+ "requestBody": {
1751
+ "required": true,
1752
+ "content": { "application/json": { "schema": {
1753
+ "type": "object",
1754
+ "properties": {
1755
+ "commerceBaseUrl": {
1756
+ "type": "string",
1757
+ "minLength": 1
1758
+ },
1759
+ "commerceEnv": {
1760
+ "type": "string",
1761
+ "minLength": 1
1762
+ }
1763
+ },
1764
+ "required": ["commerceBaseUrl"]
1765
+ } } }
1766
+ },
1767
+ "responses": {
1768
+ "200": {
1769
+ "description": "The synchronized Commerce scope tree.",
1770
+ "content": { "application/json": { "schema": {
1771
+ "type": "object",
1772
+ "properties": {
1773
+ "scopes": {
1774
+ "type": "array",
1775
+ "items": { "$ref": "#/components/schemas/ScopeNode" }
1776
+ },
1777
+ "synced": { "const": true }
1778
+ },
1779
+ "required": ["scopes", "synced"]
1780
+ } } }
1781
+ },
1782
+ "203": {
1783
+ "description": "The cached scope tree returned when Commerce scopes could not be freshly fetched.",
1784
+ "headers": { "x-cache": {
1785
+ "description": "Indicates that the returned scope tree came from cache.",
1786
+ "schema": { "const": "hit" }
1787
+ } },
1788
+ "content": { "application/json": { "schema": {
1789
+ "type": "object",
1790
+ "properties": {
1791
+ "scopes": {
1792
+ "type": "array",
1793
+ "items": { "$ref": "#/components/schemas/ScopeNode" }
1794
+ },
1795
+ "synced": { "const": false }
1796
+ },
1797
+ "required": ["scopes", "synced"]
1798
+ } } }
1799
+ },
1800
+ "400": {
1801
+ "description": "The request is invalid or could not be parsed.",
1802
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }
1803
+ },
1804
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1805
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1806
+ "500": {
1807
+ "description": "An unexpected server error occurred.",
1808
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1809
+ }
1810
+ },
1811
+ "tags": ["Business Configuration"]
1812
+ },
1813
+ "delete": {
1814
+ "operationId": "unsyncCommerceScopes",
1815
+ "summary": "Unsync Commerce Scopes",
1816
+ "description": "Removes the synchronized Commerce scope tree and returns the unsync result (or a no-op message if no scopes were stored).",
1817
+ "parameters": [{
1818
+ "name": "x-gw-ims-org-id",
1819
+ "in": "header",
1820
+ "description": "Adobe IMS organization ID that identifies the organization for the request.",
1821
+ "required": true,
1822
+ "schema": { "type": "string" }
1823
+ }],
1824
+ "responses": {
1825
+ "200": {
1826
+ "description": "The result of removing synchronized Commerce scope data.",
1827
+ "content": { "application/json": { "schema": {
1828
+ "type": "object",
1829
+ "properties": { "message": { "enum": ["Commerce scopes unsynced successfully", "No commerce scopes to unsync"] } },
1830
+ "required": ["message"]
1831
+ } } }
1832
+ },
1833
+ "401": { "description": "You are not authorized to access this resource. Ensure the IMS token and the x-gw-ims-org-id header are correctly set and valid." },
1834
+ "403": { "description": "The access token is valid, but it is not allowed to access the requested organization or operation." },
1835
+ "500": {
1836
+ "description": "An unexpected server error occurred.",
1837
+ "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
1838
+ }
1839
+ },
1840
+ "tags": ["Business Configuration"]
1841
+ }
1842
+ }
1843
+ };
1844
+ var components = {
1845
+ "schemas": {
1846
+ "ErrorResponse": {
1847
+ "type": "object",
1848
+ "properties": {
1849
+ "message": { "type": "string" },
1850
+ "error": { "type": "string" }
1851
+ },
1852
+ "required": ["message"]
1853
+ },
1854
+ "ValidationErrorResponse": {
1855
+ "type": "object",
1856
+ "properties": {
1857
+ "message": { "type": "string" },
1858
+ "issues": {
1859
+ "type": "array",
1860
+ "items": {
1861
+ "type": "object",
1862
+ "additionalProperties": true
1863
+ }
1864
+ }
1865
+ },
1866
+ "required": ["message"]
1867
+ },
1868
+ "AppData": {
1869
+ "type": "object",
1870
+ "properties": {
1871
+ "consumerOrgId": {
1872
+ "type": "string",
1873
+ "minLength": 1
1874
+ },
1875
+ "orgName": {
1876
+ "type": "string",
1877
+ "minLength": 1
1878
+ },
1879
+ "projectId": {
1880
+ "type": "string",
1881
+ "minLength": 1
1882
+ },
1883
+ "projectName": {
1884
+ "type": "string",
1885
+ "minLength": 1
1886
+ },
1887
+ "projectTitle": {
1888
+ "type": "string",
1889
+ "minLength": 1
1890
+ },
1891
+ "workspaceId": {
1892
+ "type": "string",
1893
+ "minLength": 1
1894
+ },
1895
+ "workspaceName": {
1896
+ "type": "string",
1897
+ "minLength": 1
1898
+ },
1899
+ "workspaceTitle": {
1900
+ "type": "string",
1901
+ "minLength": 1
1902
+ }
1903
+ },
1904
+ "required": [
1905
+ "consumerOrgId",
1906
+ "orgName",
1907
+ "projectId",
1908
+ "projectName",
1909
+ "projectTitle",
1910
+ "workspaceId",
1911
+ "workspaceName",
1912
+ "workspaceTitle"
1913
+ ]
1914
+ },
1915
+ "ConfigScope": {
1916
+ "type": "object",
1917
+ "properties": {
1918
+ "id": { "type": "string" },
1919
+ "code": { "type": "string" },
1920
+ "level": { "type": "string" }
1921
+ },
1922
+ "required": [
1923
+ "id",
1924
+ "code",
1925
+ "level"
1926
+ ]
1927
+ },
1928
+ "ConfigOrigin": {
1929
+ "type": "object",
1930
+ "properties": {
1931
+ "code": { "type": "string" },
1932
+ "level": { "type": "string" }
1933
+ },
1934
+ "required": ["code", "level"]
1935
+ },
1936
+ "ConfigValue": {
1937
+ "type": "object",
1938
+ "properties": {
1939
+ "name": { "type": "string" },
1940
+ "value": { "anyOf": [
1941
+ { "type": "boolean" },
1942
+ { "type": "string" },
1943
+ {
1944
+ "type": "array",
1945
+ "items": { "type": "string" }
1946
+ }
1947
+ ] },
1948
+ "origin": { "$ref": "#/components/schemas/ConfigOrigin" }
1949
+ },
1950
+ "required": [
1951
+ "name",
1952
+ "value",
1953
+ "origin"
1954
+ ]
1955
+ },
1956
+ "ConfigUpdateEntry": {
1957
+ "type": "object",
1958
+ "properties": {
1959
+ "name": { "type": "string" },
1960
+ "value": { "anyOf": [
1961
+ { "type": "boolean" },
1962
+ { "type": "string" },
1963
+ {
1964
+ "type": "array",
1965
+ "items": { "type": "string" }
1966
+ }
1967
+ ] }
1968
+ },
1969
+ "required": ["name", "value"]
1970
+ },
1971
+ "StepMetaInfo": {
1972
+ "type": "object",
1973
+ "properties": {
1974
+ "label": { "type": "string" },
1975
+ "description": { "type": "string" }
1976
+ },
1977
+ "required": ["label"]
1978
+ },
1979
+ "ValidationIssue": {
1980
+ "type": "object",
1981
+ "properties": {
1982
+ "code": { "type": "string" },
1983
+ "message": { "type": "string" },
1984
+ "severity": { "enum": [
1985
+ "error",
1986
+ "warning",
1987
+ "info"
1988
+ ] },
1989
+ "details": {
1990
+ "type": "object",
1991
+ "additionalProperties": {},
1992
+ "propertyNames": { "type": "string" }
1993
+ }
1994
+ },
1995
+ "required": [
1996
+ "code",
1997
+ "message",
1998
+ "severity"
1999
+ ]
2000
+ },
2001
+ "EventProvider": {
2002
+ "type": "object",
2003
+ "properties": {
2004
+ "label": {
2005
+ "type": "string",
2006
+ "maxLength": 100,
2007
+ "minLength": 1,
2008
+ "pattern": "^[a-zA-Z0-9 _.:()\\-,@/]+$"
2009
+ },
2010
+ "description": {
2011
+ "type": "string",
2012
+ "maxLength": 255,
2013
+ "minLength": 1,
2014
+ "pattern": "^[a-zA-Z0-9 _.:()\\-,@/]+$"
2015
+ },
2016
+ "key": {
2017
+ "type": "string",
2018
+ "maxLength": 50,
2019
+ "pattern": "^[a-zA-Z0-9-]+$"
2020
+ }
2021
+ },
2022
+ "required": ["label", "description"]
2023
+ },
2024
+ "CommerceEventField": {
2025
+ "type": "object",
2026
+ "properties": {
2027
+ "name": {
2028
+ "type": "string",
2029
+ "minLength": 1,
2030
+ "pattern": "^([a-zA-Z0-9_\\-.[\\]]+|\\*)$"
2031
+ },
2032
+ "source": { "type": "string" }
2033
+ },
2034
+ "required": ["name"]
2035
+ },
2036
+ "CommerceEventRule": {
2037
+ "type": "object",
2038
+ "properties": {
2039
+ "field": {
2040
+ "type": "string",
2041
+ "minLength": 1
2042
+ },
2043
+ "operator": { "enum": [
2044
+ "greaterThan",
2045
+ "lessThan",
2046
+ "equal",
2047
+ "regex",
2048
+ "in",
2049
+ "onChange"
2050
+ ] },
2051
+ "value": {
2052
+ "type": "string",
2053
+ "minLength": 1
2054
+ }
2055
+ },
2056
+ "required": [
2057
+ "field",
2058
+ "operator",
2059
+ "value"
2060
+ ]
2061
+ },
2062
+ "WebhookField": {
2063
+ "type": "object",
2064
+ "properties": {
2065
+ "name": {
2066
+ "type": "string",
2067
+ "minLength": 1
2068
+ },
2069
+ "source": { "type": "string" }
2070
+ },
2071
+ "required": ["name"]
2072
+ },
2073
+ "WebhookRule": {
2074
+ "type": "object",
2075
+ "properties": {
2076
+ "field": {
2077
+ "type": "string",
2078
+ "minLength": 1
2079
+ },
2080
+ "operator": {
2081
+ "type": "string",
2082
+ "minLength": 1
2083
+ },
2084
+ "value": {
2085
+ "type": "string",
2086
+ "minLength": 1
2087
+ }
2088
+ },
2089
+ "required": [
2090
+ "field",
2091
+ "operator",
2092
+ "value"
2093
+ ]
2094
+ },
2095
+ "WebhookHeader": {
2096
+ "type": "object",
2097
+ "properties": {
2098
+ "name": {
2099
+ "type": "string",
2100
+ "minLength": 1
2101
+ },
2102
+ "value": {
2103
+ "type": "string",
2104
+ "minLength": 1
2105
+ }
2106
+ },
2107
+ "required": ["name", "value"]
2108
+ },
2109
+ "WebhookDefinition": {
2110
+ "type": "object",
2111
+ "properties": {
2112
+ "webhook_method": {
2113
+ "type": "string",
2114
+ "minLength": 1
2115
+ },
2116
+ "webhook_type": {
2117
+ "type": "string",
2118
+ "minLength": 1
2119
+ },
2120
+ "batch_name": {
2121
+ "type": "string",
2122
+ "minLength": 1,
2123
+ "pattern": "^[a-zA-Z0-9_]+$"
2124
+ },
2125
+ "batch_order": {
2126
+ "type": "number",
2127
+ "minimum": 0
2128
+ },
2129
+ "hook_name": {
2130
+ "type": "string",
2131
+ "minLength": 1,
2132
+ "pattern": "^[a-zA-Z0-9_]+$"
2133
+ },
2134
+ "priority": {
2135
+ "type": "number",
2136
+ "minimum": 0
2137
+ },
2138
+ "required": { "type": "boolean" },
2139
+ "soft_timeout": {
2140
+ "type": "number",
2141
+ "minimum": 0
2142
+ },
2143
+ "timeout": {
2144
+ "type": "number",
2145
+ "minimum": 0
2146
+ },
2147
+ "method": {
2148
+ "type": "string",
2149
+ "minLength": 1
2150
+ },
2151
+ "fallback_error_message": { "type": "string" },
2152
+ "ttl": {
2153
+ "type": "number",
2154
+ "minimum": 0
2155
+ },
2156
+ "fields": {
2157
+ "type": "array",
2158
+ "items": { "$ref": "#/components/schemas/WebhookField" }
2159
+ },
2160
+ "rules": {
2161
+ "type": "array",
2162
+ "items": { "$ref": "#/components/schemas/WebhookRule" }
2163
+ },
2164
+ "headers": {
2165
+ "type": "array",
2166
+ "items": { "$ref": "#/components/schemas/WebhookHeader" }
2167
+ }
2168
+ },
2169
+ "required": [
2170
+ "webhook_method",
2171
+ "webhook_type",
2172
+ "batch_name",
2173
+ "hook_name",
2174
+ "method"
2175
+ ]
2176
+ },
2177
+ "RuntimeActionWebhookConfig": {
2178
+ "type": "object",
2179
+ "properties": {
2180
+ "label": {
2181
+ "type": "string",
2182
+ "minLength": 1
2183
+ },
2184
+ "description": {
2185
+ "type": "string",
2186
+ "minLength": 1
2187
+ },
2188
+ "category": {
2189
+ "type": "string",
2190
+ "enum": [
2191
+ "validation",
2192
+ "append",
2193
+ "modification"
2194
+ ]
2195
+ },
2196
+ "runtimeAction": {
2197
+ "type": "string",
2198
+ "minLength": 1
2199
+ },
2200
+ "requireAdobeAuth": { "type": "boolean" },
2201
+ "webhook": { "$ref": "#/components/schemas/WebhookDefinition" }
2202
+ },
2203
+ "required": [
2204
+ "label",
2205
+ "description",
2206
+ "runtimeAction",
2207
+ "webhook"
2208
+ ]
2209
+ },
2210
+ "ExternalUrlWebhookConfig": {
2211
+ "type": "object",
2212
+ "properties": {
2213
+ "label": {
2214
+ "type": "string",
2215
+ "minLength": 1
2216
+ },
2217
+ "description": {
2218
+ "type": "string",
2219
+ "minLength": 1
2220
+ },
2221
+ "category": {
2222
+ "type": "string",
2223
+ "enum": [
2224
+ "validation",
2225
+ "append",
2226
+ "modification"
2227
+ ]
2228
+ },
2229
+ "webhook": { "allOf": [{ "$ref": "#/components/schemas/WebhookDefinition" }, {
2230
+ "properties": { "url": {
2231
+ "type": "string",
2232
+ "format": "uri"
2233
+ } },
2234
+ "required": ["url"]
2235
+ }] }
2236
+ },
2237
+ "required": [
2238
+ "label",
2239
+ "description",
2240
+ "webhook"
2241
+ ]
2242
+ },
2243
+ "StepStatus": {
2244
+ "type": "object",
2245
+ "properties": {
2246
+ "name": { "type": "string" },
2247
+ "id": { "type": "string" },
2248
+ "path": {
2249
+ "type": "array",
2250
+ "items": { "type": "string" }
2251
+ },
2252
+ "meta": { "$ref": "#/components/schemas/StepMetaInfo" },
2253
+ "status": { "enum": [
2254
+ "pending",
2255
+ "in-progress",
2256
+ "succeeded",
2257
+ "failed"
2258
+ ] },
2259
+ "children": {
2260
+ "type": "array",
2261
+ "items": { "$ref": "#/components/schemas/StepStatus" }
2262
+ }
2263
+ },
2264
+ "required": [
2265
+ "name",
2266
+ "id",
2267
+ "path",
2268
+ "meta",
2269
+ "status",
2270
+ "children"
2271
+ ],
2272
+ "title": "StepStatus"
2273
+ },
2274
+ "StepValidationResult": {
2275
+ "type": "object",
2276
+ "properties": {
2277
+ "name": { "type": "string" },
2278
+ "path": {
2279
+ "type": "array",
2280
+ "items": { "type": "string" }
2281
+ },
2282
+ "meta": { "$ref": "#/components/schemas/StepMetaInfo" },
2283
+ "issues": {
2284
+ "type": "array",
2285
+ "items": { "$ref": "#/components/schemas/ValidationIssue" }
2286
+ },
2287
+ "children": {
2288
+ "type": "array",
2289
+ "items": { "$ref": "#/components/schemas/StepValidationResult" }
2290
+ }
2291
+ },
2292
+ "required": [
2293
+ "name",
2294
+ "path",
2295
+ "meta",
2296
+ "issues",
2297
+ "children"
2298
+ ],
2299
+ "title": "StepValidationResult"
2300
+ },
2301
+ "ScopeNode": {
2302
+ "type": "object",
2303
+ "properties": {
2304
+ "id": { "type": "string" },
2305
+ "code": { "type": "string" },
2306
+ "label": { "type": "string" },
2307
+ "level": { "type": "string" },
2308
+ "is_editable": { "type": "boolean" },
2309
+ "is_final": { "type": "boolean" },
2310
+ "is_removable": { "type": "boolean" },
2311
+ "commerce_id": { "type": "number" },
2312
+ "children": {
2313
+ "type": "array",
2314
+ "items": { "$ref": "#/components/schemas/ScopeNode" }
2315
+ }
2316
+ },
2317
+ "required": [
2318
+ "id",
2319
+ "code",
2320
+ "label",
2321
+ "level",
2322
+ "is_editable",
2323
+ "is_final",
2324
+ "is_removable"
2325
+ ],
2326
+ "title": "ScopeNode"
2327
+ },
2328
+ "CustomScopeOutput": {
2329
+ "type": "object",
2330
+ "properties": {
2331
+ "id": { "type": "string" },
2332
+ "code": { "type": "string" },
2333
+ "label": { "type": "string" },
2334
+ "level": { "type": "string" },
2335
+ "is_editable": { "type": "boolean" },
2336
+ "is_final": { "type": "boolean" },
2337
+ "children": {
2338
+ "type": "array",
2339
+ "items": { "$ref": "#/components/schemas/CustomScopeOutput" }
2340
+ }
2341
+ },
2342
+ "required": [
2343
+ "id",
2344
+ "code",
2345
+ "label",
2346
+ "level",
2347
+ "is_editable",
2348
+ "is_final"
2349
+ ],
2350
+ "title": "CustomScopeOutput"
2351
+ },
2352
+ "AdminUiSdkRegistration": {
2353
+ "type": "object",
2354
+ "properties": {
2355
+ "menuItems": {
2356
+ "type": "array",
2357
+ "items": {
2358
+ "type": "object",
2359
+ "properties": {
2360
+ "id": {
2361
+ "type": "string",
2362
+ "minLength": 1
2363
+ },
2364
+ "title": {
2365
+ "type": "string",
2366
+ "minLength": 1
2367
+ },
2368
+ "parent": {
2369
+ "type": "string",
2370
+ "minLength": 1
2371
+ },
2372
+ "sortOrder": { "type": "number" },
2373
+ "isSection": { "type": "boolean" },
2374
+ "sandbox": {
2375
+ "type": "string",
2376
+ "pattern": "^(?:allow-downloads|allow-modals|allow-popups)(?: (?:allow-downloads|allow-modals|allow-popups))*$"
2377
+ }
2378
+ },
2379
+ "required": ["id"]
2380
+ }
2381
+ },
2382
+ "order": {
2383
+ "type": "object",
2384
+ "properties": {
2385
+ "massActions": {
2386
+ "type": "array",
2387
+ "items": {
2388
+ "type": "object",
2389
+ "properties": {
2390
+ "actionId": {
2391
+ "type": "string",
2392
+ "minLength": 1
2393
+ },
2394
+ "label": {
2395
+ "type": "string",
2396
+ "minLength": 1
2397
+ },
2398
+ "title": {
2399
+ "type": "string",
2400
+ "minLength": 1
2401
+ },
2402
+ "confirm": {
2403
+ "type": "object",
2404
+ "properties": {
2405
+ "title": {
2406
+ "type": "string",
2407
+ "minLength": 1
2408
+ },
2409
+ "message": {
2410
+ "type": "string",
2411
+ "minLength": 1
2412
+ }
2413
+ },
2414
+ "required": []
2415
+ },
2416
+ "path": {
2417
+ "type": "string",
2418
+ "minLength": 1
2419
+ },
2420
+ "displayIframe": { "type": "boolean" },
2421
+ "timeout": {
2422
+ "type": "number",
2423
+ "minimum": 0
2424
+ },
2425
+ "sandbox": {
2426
+ "type": "string",
2427
+ "pattern": "^(?:allow-downloads|allow-modals|allow-popups)(?: (?:allow-downloads|allow-modals|allow-popups))*$"
2428
+ },
2429
+ "selectionLimit": {
2430
+ "type": "number",
2431
+ "minimum": 0
2432
+ }
2433
+ },
2434
+ "required": [
2435
+ "actionId",
2436
+ "label",
2437
+ "path"
2438
+ ],
2439
+ "additionalProperties": false,
2440
+ "dependentSchemas": { "sandbox": {
2441
+ "required": ["displayIframe"],
2442
+ "properties": { "displayIframe": { "const": true } }
2443
+ } }
2444
+ }
2445
+ },
2446
+ "gridColumns": {
2447
+ "type": "object",
2448
+ "properties": {
2449
+ "data": {
2450
+ "type": "object",
2451
+ "properties": { "meshId": {
2452
+ "type": "string",
2453
+ "minLength": 1
2454
+ } },
2455
+ "required": ["meshId"]
2456
+ },
2457
+ "properties": {
2458
+ "type": "array",
2459
+ "items": {
2460
+ "type": "object",
2461
+ "properties": {
2462
+ "label": {
2463
+ "type": "string",
2464
+ "minLength": 1
2465
+ },
2466
+ "columnId": {
2467
+ "type": "string",
2468
+ "minLength": 1
2469
+ },
2470
+ "type": {
2471
+ "type": "string",
2472
+ "enum": [
2473
+ "boolean",
2474
+ "date",
2475
+ "float",
2476
+ "integer",
2477
+ "string"
2478
+ ]
2479
+ },
2480
+ "align": {
2481
+ "type": "string",
2482
+ "enum": [
2483
+ "left",
2484
+ "right",
2485
+ "center"
2486
+ ]
2487
+ }
2488
+ },
2489
+ "required": [
2490
+ "label",
2491
+ "columnId",
2492
+ "type",
2493
+ "align"
2494
+ ]
2495
+ },
2496
+ "minItems": 1
2497
+ }
2498
+ },
2499
+ "required": ["data", "properties"]
2500
+ },
2501
+ "viewButtons": {
2502
+ "type": "array",
2503
+ "items": {
2504
+ "type": "object",
2505
+ "properties": {
2506
+ "buttonId": {
2507
+ "type": "string",
2508
+ "minLength": 1
2509
+ },
2510
+ "label": {
2511
+ "type": "string",
2512
+ "minLength": 1
2513
+ },
2514
+ "confirm": {
2515
+ "type": "object",
2516
+ "properties": { "message": {
2517
+ "type": "string",
2518
+ "minLength": 1
2519
+ } },
2520
+ "required": []
2521
+ },
2522
+ "path": {
2523
+ "type": "string",
2524
+ "minLength": 1
2525
+ },
2526
+ "level": {
2527
+ "type": "number",
2528
+ "enum": [
2529
+ -1,
2530
+ 0,
2531
+ 1
2532
+ ]
2533
+ },
2534
+ "sortOrder": {
2535
+ "type": "number",
2536
+ "minimum": 0
2537
+ },
2538
+ "displayIframe": { "type": "boolean" },
2539
+ "timeout": {
2540
+ "type": "number",
2541
+ "minimum": 0
2542
+ },
2543
+ "sandbox": {
2544
+ "type": "string",
2545
+ "pattern": "^(?:allow-downloads|allow-modals|allow-popups)(?: (?:allow-downloads|allow-modals|allow-popups))*$"
2546
+ }
2547
+ },
2548
+ "required": [
2549
+ "buttonId",
2550
+ "label",
2551
+ "path"
2552
+ ],
2553
+ "dependentSchemas": { "sandbox": {
2554
+ "required": ["displayIframe"],
2555
+ "properties": { "displayIframe": { "const": true } }
2556
+ } }
2557
+ }
2558
+ },
2559
+ "customFees": {
2560
+ "type": "array",
2561
+ "items": {
2562
+ "type": "object",
2563
+ "properties": {
2564
+ "id": {
2565
+ "type": "string",
2566
+ "minLength": 1
2567
+ },
2568
+ "label": {
2569
+ "type": "string",
2570
+ "minLength": 1
2571
+ },
2572
+ "value": { "type": "number" },
2573
+ "orderMinimumAmount": { "type": "number" },
2574
+ "applyFeeOnLastInvoice": { "type": "boolean" },
2575
+ "applyFeeOnLastCreditMemo": { "type": "boolean" }
2576
+ },
2577
+ "required": [
2578
+ "id",
2579
+ "label",
2580
+ "value"
2581
+ ]
2582
+ }
2583
+ }
2584
+ },
2585
+ "required": []
2586
+ },
2587
+ "product": {
2588
+ "type": "object",
2589
+ "properties": {
2590
+ "massActions": {
2591
+ "type": "array",
2592
+ "items": {
2593
+ "type": "object",
2594
+ "properties": {
2595
+ "actionId": {
2596
+ "type": "string",
2597
+ "minLength": 1
2598
+ },
2599
+ "label": {
2600
+ "type": "string",
2601
+ "minLength": 1
2602
+ },
2603
+ "title": {
2604
+ "type": "string",
2605
+ "minLength": 1
2606
+ },
2607
+ "confirm": {
2608
+ "type": "object",
2609
+ "properties": {
2610
+ "title": {
2611
+ "type": "string",
2612
+ "minLength": 1
2613
+ },
2614
+ "message": {
2615
+ "type": "string",
2616
+ "minLength": 1
2617
+ }
2618
+ },
2619
+ "required": []
2620
+ },
2621
+ "path": {
2622
+ "type": "string",
2623
+ "minLength": 1
2624
+ },
2625
+ "displayIframe": { "type": "boolean" },
2626
+ "timeout": {
2627
+ "type": "number",
2628
+ "minimum": 0
2629
+ },
2630
+ "sandbox": {
2631
+ "type": "string",
2632
+ "pattern": "^(?:allow-downloads|allow-modals|allow-popups)(?: (?:allow-downloads|allow-modals|allow-popups))*$"
2633
+ },
2634
+ "productSelectLimit": {
2635
+ "type": "number",
2636
+ "minimum": 0
2637
+ }
2638
+ },
2639
+ "required": [
2640
+ "actionId",
2641
+ "label",
2642
+ "path"
2643
+ ],
2644
+ "additionalProperties": false,
2645
+ "dependentSchemas": { "sandbox": {
2646
+ "required": ["displayIframe"],
2647
+ "properties": { "displayIframe": { "const": true } }
2648
+ } }
2649
+ }
2650
+ },
2651
+ "gridColumns": {
2652
+ "type": "object",
2653
+ "properties": {
2654
+ "data": {
2655
+ "type": "object",
2656
+ "properties": { "meshId": {
2657
+ "type": "string",
2658
+ "minLength": 1
2659
+ } },
2660
+ "required": ["meshId"]
2661
+ },
2662
+ "properties": {
2663
+ "type": "array",
2664
+ "items": {
2665
+ "type": "object",
2666
+ "properties": {
2667
+ "label": {
2668
+ "type": "string",
2669
+ "minLength": 1
2670
+ },
2671
+ "columnId": {
2672
+ "type": "string",
2673
+ "minLength": 1
2674
+ },
2675
+ "type": {
2676
+ "type": "string",
2677
+ "enum": [
2678
+ "boolean",
2679
+ "date",
2680
+ "float",
2681
+ "integer",
2682
+ "string"
2683
+ ]
2684
+ },
2685
+ "align": {
2686
+ "type": "string",
2687
+ "enum": [
2688
+ "left",
2689
+ "right",
2690
+ "center"
2691
+ ]
2692
+ }
2693
+ },
2694
+ "required": [
2695
+ "label",
2696
+ "columnId",
2697
+ "type",
2698
+ "align"
2699
+ ]
2700
+ },
2701
+ "minItems": 1
2702
+ }
2703
+ },
2704
+ "required": ["data", "properties"]
2705
+ }
2706
+ },
2707
+ "required": []
2708
+ },
2709
+ "customer": {
2710
+ "type": "object",
2711
+ "properties": {
2712
+ "massActions": {
2713
+ "type": "array",
2714
+ "items": {
2715
+ "type": "object",
2716
+ "properties": {
2717
+ "actionId": {
2718
+ "type": "string",
2719
+ "minLength": 1
2720
+ },
2721
+ "label": {
2722
+ "type": "string",
2723
+ "minLength": 1
2724
+ },
2725
+ "title": {
2726
+ "type": "string",
2727
+ "minLength": 1
2728
+ },
2729
+ "confirm": {
2730
+ "type": "object",
2731
+ "properties": {
2732
+ "title": {
2733
+ "type": "string",
2734
+ "minLength": 1
2735
+ },
2736
+ "message": {
2737
+ "type": "string",
2738
+ "minLength": 1
2739
+ }
2740
+ },
2741
+ "required": []
2742
+ },
2743
+ "path": {
2744
+ "type": "string",
2745
+ "minLength": 1
2746
+ },
2747
+ "displayIframe": { "type": "boolean" },
2748
+ "timeout": {
2749
+ "type": "number",
2750
+ "minimum": 0
2751
+ },
2752
+ "sandbox": {
2753
+ "type": "string",
2754
+ "pattern": "^(?:allow-downloads|allow-modals|allow-popups)(?: (?:allow-downloads|allow-modals|allow-popups))*$"
2755
+ },
2756
+ "customerSelectLimit": {
2757
+ "type": "number",
2758
+ "minimum": 0
2759
+ }
2760
+ },
2761
+ "required": [
2762
+ "actionId",
2763
+ "label",
2764
+ "path"
2765
+ ],
2766
+ "additionalProperties": false,
2767
+ "dependentSchemas": { "sandbox": {
2768
+ "required": ["displayIframe"],
2769
+ "properties": { "displayIframe": { "const": true } }
2770
+ } }
2771
+ }
2772
+ },
2773
+ "gridColumns": {
2774
+ "type": "object",
2775
+ "properties": {
2776
+ "data": {
2777
+ "type": "object",
2778
+ "properties": { "meshId": {
2779
+ "type": "string",
2780
+ "minLength": 1
2781
+ } },
2782
+ "required": ["meshId"]
2783
+ },
2784
+ "properties": {
2785
+ "type": "array",
2786
+ "items": {
2787
+ "type": "object",
2788
+ "properties": {
2789
+ "label": {
2790
+ "type": "string",
2791
+ "minLength": 1
2792
+ },
2793
+ "columnId": {
2794
+ "type": "string",
2795
+ "minLength": 1
2796
+ },
2797
+ "type": {
2798
+ "type": "string",
2799
+ "enum": [
2800
+ "boolean",
2801
+ "date",
2802
+ "float",
2803
+ "integer",
2804
+ "string"
2805
+ ]
2806
+ },
2807
+ "align": {
2808
+ "type": "string",
2809
+ "enum": [
2810
+ "left",
2811
+ "right",
2812
+ "center"
2813
+ ]
2814
+ }
2815
+ },
2816
+ "required": [
2817
+ "label",
2818
+ "columnId",
2819
+ "type",
2820
+ "align"
2821
+ ]
2822
+ },
2823
+ "minItems": 1
2824
+ }
2825
+ },
2826
+ "required": ["data", "properties"]
2827
+ }
2828
+ },
2829
+ "required": []
2830
+ },
2831
+ "bannerNotification": {
2832
+ "type": "object",
2833
+ "properties": {
2834
+ "massActions": {
2835
+ "type": "object",
2836
+ "properties": {
2837
+ "order": {
2838
+ "type": "array",
2839
+ "items": {
2840
+ "type": "object",
2841
+ "properties": {
2842
+ "actionId": {
2843
+ "type": "string",
2844
+ "minLength": 1
2845
+ },
2846
+ "successMessage": {
2847
+ "type": "string",
2848
+ "minLength": 1
2849
+ },
2850
+ "errorMessage": {
2851
+ "type": "string",
2852
+ "minLength": 1
2853
+ }
2854
+ },
2855
+ "required": ["actionId"]
2856
+ }
2857
+ },
2858
+ "product": {
2859
+ "type": "array",
2860
+ "items": {
2861
+ "type": "object",
2862
+ "properties": {
2863
+ "actionId": {
2864
+ "type": "string",
2865
+ "minLength": 1
2866
+ },
2867
+ "successMessage": {
2868
+ "type": "string",
2869
+ "minLength": 1
2870
+ },
2871
+ "errorMessage": {
2872
+ "type": "string",
2873
+ "minLength": 1
2874
+ }
2875
+ },
2876
+ "required": ["actionId"]
2877
+ }
2878
+ },
2879
+ "customer": {
2880
+ "type": "array",
2881
+ "items": {
2882
+ "type": "object",
2883
+ "properties": {
2884
+ "actionId": {
2885
+ "type": "string",
2886
+ "minLength": 1
2887
+ },
2888
+ "successMessage": {
2889
+ "type": "string",
2890
+ "minLength": 1
2891
+ },
2892
+ "errorMessage": {
2893
+ "type": "string",
2894
+ "minLength": 1
2895
+ }
2896
+ },
2897
+ "required": ["actionId"]
2898
+ }
2899
+ }
2900
+ },
2901
+ "required": []
2902
+ },
2903
+ "orderViewButtons": {
2904
+ "type": "array",
2905
+ "items": {
2906
+ "type": "object",
2907
+ "properties": {
2908
+ "buttonId": {
2909
+ "type": "string",
2910
+ "minLength": 1
2911
+ },
2912
+ "successMessage": {
2913
+ "type": "string",
2914
+ "minLength": 1
2915
+ },
2916
+ "errorMessage": {
2917
+ "type": "string",
2918
+ "minLength": 1
2919
+ }
2920
+ },
2921
+ "required": ["buttonId"]
2922
+ }
2923
+ }
2924
+ },
2925
+ "required": []
2926
+ }
2927
+ },
2928
+ "required": []
2929
+ },
2930
+ "CustomScopeInput": {
2931
+ "type": "object",
2932
+ "properties": {
2933
+ "id": {
2934
+ "type": "string",
2935
+ "pattern": ".*\\S.*"
2936
+ },
2937
+ "code": {
2938
+ "type": "string",
2939
+ "pattern": "^(?!\\s*(?:commerce|global)\\s*$).*\\S.*$"
2940
+ },
2941
+ "label": {
2942
+ "type": "string",
2943
+ "pattern": ".*\\S.*"
2944
+ },
2945
+ "level": {
2946
+ "type": "string",
2947
+ "default": "base",
2948
+ "pattern": ".*\\S.*"
2949
+ },
2950
+ "is_editable": { "type": "boolean" },
2951
+ "is_final": { "type": "boolean" },
2952
+ "children": {
2953
+ "type": "array",
2954
+ "items": { "$ref": "#/components/schemas/CustomScopeInput" }
2955
+ }
2956
+ },
2957
+ "required": [
2958
+ "code",
2959
+ "label",
2960
+ "is_editable",
2961
+ "is_final"
2962
+ ],
2963
+ "title": "CustomScopeInput"
2964
+ }
2965
+ },
2966
+ "securitySchemes": { "imsOAuth": {
2967
+ "type": "oauth2",
2968
+ "description": "Adobe IMS OAuth 2.0 access token. Send it as Authorization: Bearer <IMS access token>.",
2969
+ "flows": { "clientCredentials": {
2970
+ "scopes": {
2971
+ "AdobeID": "Identifies the user with their Adobe ID",
2972
+ "openid": "Authenticates the user via OpenID Connect"
2973
+ },
2974
+ "tokenUrl": "https://ims-na1.adobelogin.com/ims/token/v3"
2975
+ } }
2976
+ } }
2977
+ };
2978
+ var tags = [
2979
+ {
2980
+ "name": "App Metadata",
2981
+ "description": "Resolve and inspect the Commerce App configuration.",
2982
+ "externalDocs": {
2983
+ "description": "Documentation",
2984
+ "url": "https://developer.adobe.com/commerce/extensibility/app-management/define-app"
2985
+ }
2986
+ },
2987
+ {
2988
+ "name": "Business Configuration",
2989
+ "description": "Manage app configuration values and the Commerce scope tree.",
2990
+ "externalDocs": {
2991
+ "description": "Documentation",
2992
+ "url": "https://developer.adobe.com/commerce/extensibility/app-management/configuration-schema"
2993
+ }
2994
+ },
2995
+ {
2996
+ "name": "Management",
2997
+ "description": "Installation and uninstallation lifecycle.",
2998
+ "externalDocs": {
2999
+ "description": "Documentation",
3000
+ "url": "https://developer.adobe.com/commerce/extensibility/app-management/installation/"
3001
+ }
3002
+ },
3003
+ {
3004
+ "name": "Admin UI",
3005
+ "description": "Admin UI SDK registration.",
3006
+ "externalDocs": {
3007
+ "description": "Documentation",
3008
+ "url": "https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/"
3009
+ }
3010
+ }
3011
+ ];
3012
+ var security = [{ "imsOAuth": ["AdobeID", "openid"] }];
3013
+ var openapi_default = {
3014
+ openapi,
3015
+ info,
3016
+ servers,
3017
+ paths,
3018
+ components,
3019
+ tags,
3020
+ security
3021
+ };
3022
+
3023
+ //#endregion
3024
+ export { components, openapi_default as default, info, openapi, paths, security, servers, tags };