@commercelayer/cli-plugin-provisioning 1.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 (42) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +413 -0
  3. package/bin/dev +18 -0
  4. package/bin/dev.cmd +3 -0
  5. package/bin/run +5 -0
  6. package/bin/run.cmd +3 -0
  7. package/lib/base.d.ts +59 -0
  8. package/lib/base.js +496 -0
  9. package/lib/commands/provisioning/create.d.ts +21 -0
  10. package/lib/commands/provisioning/create.js +137 -0
  11. package/lib/commands/provisioning/delete.d.ts +20 -0
  12. package/lib/commands/provisioning/delete.js +52 -0
  13. package/lib/commands/provisioning/exec.d.ts +15 -0
  14. package/lib/commands/provisioning/exec.js +55 -0
  15. package/lib/commands/provisioning/fetch.d.ts +28 -0
  16. package/lib/commands/provisioning/fetch.js +57 -0
  17. package/lib/commands/provisioning/get.d.ts +27 -0
  18. package/lib/commands/provisioning/get.js +31 -0
  19. package/lib/commands/provisioning/list.d.ts +22 -0
  20. package/lib/commands/provisioning/list.js +137 -0
  21. package/lib/commands/provisioning/noc.d.ts +6 -0
  22. package/lib/commands/provisioning/noc.js +13 -0
  23. package/lib/commands/provisioning/relationship.d.ts +30 -0
  24. package/lib/commands/provisioning/relationship.js +114 -0
  25. package/lib/commands/provisioning/resources.d.ts +11 -0
  26. package/lib/commands/provisioning/resources.js +36 -0
  27. package/lib/commands/provisioning/retrieve.d.ts +21 -0
  28. package/lib/commands/provisioning/retrieve.js +95 -0
  29. package/lib/commands/provisioning/update.d.ts +26 -0
  30. package/lib/commands/provisioning/update.js +157 -0
  31. package/lib/csv.d.ts +3 -0
  32. package/lib/csv.js +98 -0
  33. package/lib/output.d.ts +5 -0
  34. package/lib/output.js +15 -0
  35. package/lib/util/resources/available.d.ts +35 -0
  36. package/lib/util/resources/available.js +13 -0
  37. package/lib/util/resources/build.d.ts +1 -0
  38. package/lib/util/resources/build.js +47 -0
  39. package/lib/util/resources/index.d.ts +12 -0
  40. package/lib/util/resources/index.js +19 -0
  41. package/oclif.manifest.json +1502 -0
  42. package/package.json +86 -0
@@ -0,0 +1,1502 @@
1
+ {
2
+ "commands": {
3
+ "provisioning:create": {
4
+ "aliases": [
5
+ "prov:create",
6
+ "pc",
7
+ "pcreate"
8
+ ],
9
+ "args": {
10
+ "resource": {
11
+ "description": "the resource type",
12
+ "name": "resource",
13
+ "required": true
14
+ }
15
+ },
16
+ "description": "create a new resource",
17
+ "examples": [
18
+ "$ commercelayer provisioning:create organizations -a name=MyOrg",
19
+ "$ clayer prov:create subscriptions -r plan=plans/<planId>",
20
+ "$ cl prov:create organization -a name=MyOrg -m meta_key=\"meta value\"",
21
+ "$ cl pc roles -D /path/to/data/file/data.json"
22
+ ],
23
+ "flags": {
24
+ "domain": {
25
+ "char": "d",
26
+ "env": "CL_CLI_DOMAIN",
27
+ "hidden": true,
28
+ "name": "domain",
29
+ "required": false,
30
+ "hasDynamicHelp": false,
31
+ "multiple": false,
32
+ "type": "option"
33
+ },
34
+ "accessToken": {
35
+ "env": "CL_CLI_ACCESS_TOKEN",
36
+ "hidden": true,
37
+ "name": "accessToken",
38
+ "required": true,
39
+ "hasDynamicHelp": false,
40
+ "multiple": false,
41
+ "type": "option"
42
+ },
43
+ "include": {
44
+ "char": "i",
45
+ "description": "comma separated resources to include",
46
+ "name": "include",
47
+ "hasDynamicHelp": false,
48
+ "multiple": true,
49
+ "type": "option"
50
+ },
51
+ "fields": {
52
+ "char": "f",
53
+ "description": "comma separeted list of fields in the format [resourceType/]field1,field2...",
54
+ "name": "fields",
55
+ "hasDynamicHelp": false,
56
+ "multiple": true,
57
+ "type": "option"
58
+ },
59
+ "json": {
60
+ "char": "j",
61
+ "description": "convert output in standard JSON format",
62
+ "name": "json",
63
+ "allowNo": false,
64
+ "type": "boolean"
65
+ },
66
+ "unformatted": {
67
+ "char": "u",
68
+ "dependsOn": [
69
+ "json"
70
+ ],
71
+ "description": "print unformatted JSON output",
72
+ "name": "unformatted",
73
+ "allowNo": false,
74
+ "type": "boolean"
75
+ },
76
+ "raw": {
77
+ "char": "R",
78
+ "description": "print out the raw API response",
79
+ "hidden": false,
80
+ "name": "raw",
81
+ "allowNo": false,
82
+ "type": "boolean"
83
+ },
84
+ "headers": {
85
+ "char": "H",
86
+ "dependsOn": [
87
+ "raw"
88
+ ],
89
+ "description": "show response headers",
90
+ "exclusive": [
91
+ "headers-only"
92
+ ],
93
+ "name": "headers",
94
+ "allowNo": false,
95
+ "type": "boolean"
96
+ },
97
+ "headers-only": {
98
+ "char": "Y",
99
+ "dependsOn": [
100
+ "raw"
101
+ ],
102
+ "description": "show only response headers",
103
+ "exclusive": [
104
+ "headers",
105
+ "fields",
106
+ "include"
107
+ ],
108
+ "name": "headers-only",
109
+ "allowNo": false,
110
+ "type": "boolean"
111
+ },
112
+ "attribute": {
113
+ "char": "a",
114
+ "description": "define a resource attribute",
115
+ "name": "attribute",
116
+ "hasDynamicHelp": false,
117
+ "multiple": true,
118
+ "type": "option"
119
+ },
120
+ "object": {
121
+ "char": "O",
122
+ "description": "define a resource object attribute",
123
+ "name": "object",
124
+ "hasDynamicHelp": false,
125
+ "multiple": true,
126
+ "type": "option"
127
+ },
128
+ "relationship": {
129
+ "char": "r",
130
+ "description": "define a relationship with another resource",
131
+ "name": "relationship",
132
+ "hasDynamicHelp": false,
133
+ "multiple": true,
134
+ "type": "option"
135
+ },
136
+ "metadata": {
137
+ "char": "m",
138
+ "description": "define a metadata attribute or a set of metadata attributes",
139
+ "name": "metadata",
140
+ "hasDynamicHelp": false,
141
+ "multiple": true,
142
+ "type": "option"
143
+ },
144
+ "data": {
145
+ "char": "D",
146
+ "description": "the data file to use as request body",
147
+ "exclusive": [
148
+ "attribute",
149
+ "relationship",
150
+ "metadata",
151
+ "doc"
152
+ ],
153
+ "name": "data",
154
+ "hasDynamicHelp": false,
155
+ "multiple": false,
156
+ "type": "option"
157
+ }
158
+ },
159
+ "hasDynamicHelp": false,
160
+ "hiddenAliases": [],
161
+ "id": "provisioning:create",
162
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
163
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
164
+ "pluginType": "core",
165
+ "strict": true,
166
+ "isESM": false,
167
+ "relativePath": [
168
+ "lib",
169
+ "commands",
170
+ "provisioning",
171
+ "create.js"
172
+ ]
173
+ },
174
+ "provisioning:delete": {
175
+ "aliases": [
176
+ "prov:delete",
177
+ "pd",
178
+ "pdelete",
179
+ "pdel"
180
+ ],
181
+ "args": {
182
+ "resource": {
183
+ "description": "the resource type",
184
+ "name": "resource",
185
+ "required": true
186
+ },
187
+ "id": {
188
+ "description": "id of the resource to delete",
189
+ "name": "id",
190
+ "required": false
191
+ }
192
+ },
193
+ "description": "delete an existing resource",
194
+ "examples": [
195
+ "$ commercelayer provisioning:delete api_credentials/<id>",
196
+ "$ cl prov:delete api_credentials <id>"
197
+ ],
198
+ "flags": {
199
+ "domain": {
200
+ "char": "d",
201
+ "env": "CL_CLI_DOMAIN",
202
+ "hidden": true,
203
+ "name": "domain",
204
+ "required": false,
205
+ "hasDynamicHelp": false,
206
+ "multiple": false,
207
+ "type": "option"
208
+ },
209
+ "accessToken": {
210
+ "env": "CL_CLI_ACCESS_TOKEN",
211
+ "hidden": true,
212
+ "name": "accessToken",
213
+ "required": true,
214
+ "hasDynamicHelp": false,
215
+ "multiple": false,
216
+ "type": "option"
217
+ },
218
+ "include": {
219
+ "char": "i",
220
+ "description": "comma separated resources to include",
221
+ "name": "include",
222
+ "hasDynamicHelp": false,
223
+ "multiple": true,
224
+ "type": "option"
225
+ },
226
+ "fields": {
227
+ "char": "f",
228
+ "description": "comma separeted list of fields in the format [resourceType/]field1,field2...",
229
+ "name": "fields",
230
+ "hasDynamicHelp": false,
231
+ "multiple": true,
232
+ "type": "option"
233
+ },
234
+ "json": {
235
+ "char": "j",
236
+ "description": "convert output in standard JSON format",
237
+ "name": "json",
238
+ "allowNo": false,
239
+ "type": "boolean"
240
+ },
241
+ "unformatted": {
242
+ "char": "u",
243
+ "dependsOn": [
244
+ "json"
245
+ ],
246
+ "description": "print unformatted JSON output",
247
+ "name": "unformatted",
248
+ "allowNo": false,
249
+ "type": "boolean"
250
+ },
251
+ "raw": {
252
+ "char": "R",
253
+ "description": "print out the raw API response",
254
+ "hidden": false,
255
+ "name": "raw",
256
+ "allowNo": false,
257
+ "type": "boolean"
258
+ },
259
+ "headers": {
260
+ "char": "H",
261
+ "dependsOn": [
262
+ "raw"
263
+ ],
264
+ "description": "show response headers",
265
+ "exclusive": [
266
+ "headers-only"
267
+ ],
268
+ "name": "headers",
269
+ "allowNo": false,
270
+ "type": "boolean"
271
+ },
272
+ "headers-only": {
273
+ "char": "Y",
274
+ "dependsOn": [
275
+ "raw"
276
+ ],
277
+ "description": "show only response headers",
278
+ "exclusive": [
279
+ "headers",
280
+ "fields",
281
+ "include"
282
+ ],
283
+ "name": "headers-only",
284
+ "allowNo": false,
285
+ "type": "boolean"
286
+ }
287
+ },
288
+ "hasDynamicHelp": false,
289
+ "hiddenAliases": [],
290
+ "id": "provisioning:delete",
291
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
292
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
293
+ "pluginType": "core",
294
+ "strict": true,
295
+ "isESM": false,
296
+ "relativePath": [
297
+ "lib",
298
+ "commands",
299
+ "provisioning",
300
+ "delete.js"
301
+ ]
302
+ },
303
+ "provisioning:exec": {
304
+ "aliases": [
305
+ "prov:exec",
306
+ "pe",
307
+ "pexec"
308
+ ],
309
+ "args": {
310
+ "resource": {
311
+ "description": "the resource type",
312
+ "name": "resource",
313
+ "required": true
314
+ },
315
+ "id": {
316
+ "description": "id of the resource on which to execute the action",
317
+ "name": "id",
318
+ "required": false
319
+ },
320
+ "action": {
321
+ "description": "action to execute on resource",
322
+ "name": "action",
323
+ "required": false
324
+ }
325
+ },
326
+ "description": "execute an action on a resource",
327
+ "examples": [
328
+ "$ commercelayer provisioning:exec organizations <organizationId> transfer_ownership",
329
+ "$ cl prov:exec memberships <membershipId> resend"
330
+ ],
331
+ "flags": {
332
+ "domain": {
333
+ "char": "d",
334
+ "env": "CL_CLI_DOMAIN",
335
+ "hidden": true,
336
+ "name": "domain",
337
+ "required": false,
338
+ "hasDynamicHelp": false,
339
+ "multiple": false,
340
+ "type": "option"
341
+ },
342
+ "accessToken": {
343
+ "env": "CL_CLI_ACCESS_TOKEN",
344
+ "hidden": true,
345
+ "name": "accessToken",
346
+ "required": true,
347
+ "hasDynamicHelp": false,
348
+ "multiple": false,
349
+ "type": "option"
350
+ },
351
+ "attribute": {
352
+ "char": "a",
353
+ "description": "define a resource attribute",
354
+ "name": "attribute",
355
+ "hasDynamicHelp": false,
356
+ "multiple": true,
357
+ "type": "option"
358
+ }
359
+ },
360
+ "hasDynamicHelp": false,
361
+ "hiddenAliases": [],
362
+ "id": "provisioning:exec",
363
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
364
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
365
+ "pluginType": "core",
366
+ "strict": true,
367
+ "isESM": false,
368
+ "relativePath": [
369
+ "lib",
370
+ "commands",
371
+ "provisioning",
372
+ "exec.js"
373
+ ]
374
+ },
375
+ "provisioning:fetch": {
376
+ "aliases": [
377
+ "prov:fetch",
378
+ "pf"
379
+ ],
380
+ "args": {
381
+ "path": {
382
+ "description": "path (or URL) of the resource(s) to fetch",
383
+ "name": "path",
384
+ "required": true
385
+ },
386
+ "id": {
387
+ "description": "resource id",
388
+ "name": "id",
389
+ "required": false
390
+ }
391
+ },
392
+ "description": "retrieve a resource or list a set of resources",
393
+ "examples": [
394
+ "$ commercelayer provisioning:fetch roles",
395
+ "$ commercelayer prov:fetch roles",
396
+ "$ clayer prov:fetch roles/<roleId>",
397
+ "$ cl prov:fetch roles/<roleId>/<roleRelationship>",
398
+ "$ cl pf roles/{roleId}/permissions aBcdEkYWx"
399
+ ],
400
+ "flags": {
401
+ "domain": {
402
+ "char": "d",
403
+ "env": "CL_CLI_DOMAIN",
404
+ "hidden": true,
405
+ "name": "domain",
406
+ "required": false,
407
+ "hasDynamicHelp": false,
408
+ "multiple": false,
409
+ "type": "option"
410
+ },
411
+ "accessToken": {
412
+ "env": "CL_CLI_ACCESS_TOKEN",
413
+ "hidden": true,
414
+ "name": "accessToken",
415
+ "required": true,
416
+ "hasDynamicHelp": false,
417
+ "multiple": false,
418
+ "type": "option"
419
+ },
420
+ "include": {
421
+ "char": "i",
422
+ "description": "comma separated resources to include",
423
+ "name": "include",
424
+ "hasDynamicHelp": false,
425
+ "multiple": true,
426
+ "type": "option"
427
+ },
428
+ "fields": {
429
+ "char": "f",
430
+ "description": "comma separeted list of fields in the format [resourceType/]field1,field2...",
431
+ "name": "fields",
432
+ "hasDynamicHelp": false,
433
+ "multiple": true,
434
+ "type": "option"
435
+ },
436
+ "json": {
437
+ "char": "j",
438
+ "description": "convert output in standard JSON format",
439
+ "name": "json",
440
+ "allowNo": false,
441
+ "type": "boolean"
442
+ },
443
+ "unformatted": {
444
+ "char": "u",
445
+ "dependsOn": [
446
+ "json"
447
+ ],
448
+ "description": "print unformatted JSON output",
449
+ "name": "unformatted",
450
+ "allowNo": false,
451
+ "type": "boolean"
452
+ },
453
+ "raw": {
454
+ "char": "R",
455
+ "description": "print out the raw API response",
456
+ "hidden": false,
457
+ "name": "raw",
458
+ "allowNo": false,
459
+ "type": "boolean"
460
+ },
461
+ "headers": {
462
+ "char": "H",
463
+ "dependsOn": [
464
+ "raw"
465
+ ],
466
+ "description": "show response headers",
467
+ "exclusive": [
468
+ "headers-only"
469
+ ],
470
+ "name": "headers",
471
+ "allowNo": false,
472
+ "type": "boolean"
473
+ },
474
+ "headers-only": {
475
+ "char": "Y",
476
+ "dependsOn": [
477
+ "raw"
478
+ ],
479
+ "description": "show only response headers",
480
+ "exclusive": [
481
+ "headers",
482
+ "fields",
483
+ "include"
484
+ ],
485
+ "name": "headers-only",
486
+ "allowNo": false,
487
+ "type": "boolean"
488
+ },
489
+ "extract": {
490
+ "char": "e",
491
+ "description": "extract subfields from object attributes",
492
+ "exclusive": [
493
+ "raw"
494
+ ],
495
+ "name": "extract",
496
+ "hasDynamicHelp": false,
497
+ "multiple": true,
498
+ "type": "option"
499
+ },
500
+ "where": {
501
+ "char": "w",
502
+ "description": "comma separated list of query filters",
503
+ "name": "where",
504
+ "hasDynamicHelp": false,
505
+ "multiple": true,
506
+ "type": "option"
507
+ },
508
+ "page": {
509
+ "char": "p",
510
+ "description": "page number",
511
+ "name": "page",
512
+ "hasDynamicHelp": false,
513
+ "multiple": false,
514
+ "type": "option"
515
+ },
516
+ "pageSize": {
517
+ "char": "n",
518
+ "description": "number of elements per page",
519
+ "name": "pageSize",
520
+ "hasDynamicHelp": false,
521
+ "multiple": false,
522
+ "type": "option"
523
+ },
524
+ "sort": {
525
+ "char": "s",
526
+ "description": "defines results ordering",
527
+ "name": "sort",
528
+ "hasDynamicHelp": false,
529
+ "multiple": true,
530
+ "type": "option"
531
+ },
532
+ "force-include": {
533
+ "char": "I",
534
+ "dependsOn": [
535
+ "include"
536
+ ],
537
+ "description": "force resources inclusion beyound the 3rd level",
538
+ "hidden": true,
539
+ "name": "force-include",
540
+ "allowNo": false,
541
+ "type": "boolean"
542
+ }
543
+ },
544
+ "hasDynamicHelp": false,
545
+ "hiddenAliases": [],
546
+ "id": "provisioning:fetch",
547
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
548
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
549
+ "pluginType": "core",
550
+ "strict": false,
551
+ "isESM": false,
552
+ "relativePath": [
553
+ "lib",
554
+ "commands",
555
+ "provisioning",
556
+ "fetch.js"
557
+ ]
558
+ },
559
+ "provisioning:get": {
560
+ "aliases": [
561
+ "prov:get",
562
+ "pg",
563
+ "pget"
564
+ ],
565
+ "args": {
566
+ "resource": {
567
+ "description": "the resource type",
568
+ "name": "resource",
569
+ "required": true
570
+ },
571
+ "id": {
572
+ "description": "id of the resource to retrieve",
573
+ "name": "id",
574
+ "required": false
575
+ }
576
+ },
577
+ "description": "retrieve a resource or list a set of resources",
578
+ "examples": [
579
+ "$ commercelayer provisioning:get roles",
580
+ "$ commercelayer prov:get roles",
581
+ "$ clayer prov:get roles/<roleId>",
582
+ "$ cl prov:get roles <roleId>"
583
+ ],
584
+ "flags": {
585
+ "domain": {
586
+ "char": "d",
587
+ "env": "CL_CLI_DOMAIN",
588
+ "hidden": true,
589
+ "name": "domain",
590
+ "required": false,
591
+ "hasDynamicHelp": false,
592
+ "multiple": false,
593
+ "type": "option"
594
+ },
595
+ "accessToken": {
596
+ "env": "CL_CLI_ACCESS_TOKEN",
597
+ "hidden": true,
598
+ "name": "accessToken",
599
+ "required": true,
600
+ "hasDynamicHelp": false,
601
+ "multiple": false,
602
+ "type": "option"
603
+ },
604
+ "include": {
605
+ "char": "i",
606
+ "description": "comma separated resources to include",
607
+ "name": "include",
608
+ "hasDynamicHelp": false,
609
+ "multiple": true,
610
+ "type": "option"
611
+ },
612
+ "fields": {
613
+ "char": "f",
614
+ "description": "comma separeted list of fields in the format [resourceType/]field1,field2...",
615
+ "name": "fields",
616
+ "hasDynamicHelp": false,
617
+ "multiple": true,
618
+ "type": "option"
619
+ },
620
+ "json": {
621
+ "char": "j",
622
+ "description": "convert output in standard JSON format",
623
+ "name": "json",
624
+ "allowNo": false,
625
+ "type": "boolean"
626
+ },
627
+ "unformatted": {
628
+ "char": "u",
629
+ "dependsOn": [
630
+ "json"
631
+ ],
632
+ "description": "print unformatted JSON output",
633
+ "name": "unformatted",
634
+ "allowNo": false,
635
+ "type": "boolean"
636
+ },
637
+ "raw": {
638
+ "char": "R",
639
+ "description": "print out the raw API response",
640
+ "hidden": false,
641
+ "name": "raw",
642
+ "allowNo": false,
643
+ "type": "boolean"
644
+ },
645
+ "headers": {
646
+ "char": "H",
647
+ "dependsOn": [
648
+ "raw"
649
+ ],
650
+ "description": "show response headers",
651
+ "exclusive": [
652
+ "headers-only"
653
+ ],
654
+ "name": "headers",
655
+ "allowNo": false,
656
+ "type": "boolean"
657
+ },
658
+ "headers-only": {
659
+ "char": "Y",
660
+ "dependsOn": [
661
+ "raw"
662
+ ],
663
+ "description": "show only response headers",
664
+ "exclusive": [
665
+ "headers",
666
+ "fields",
667
+ "include"
668
+ ],
669
+ "name": "headers-only",
670
+ "allowNo": false,
671
+ "type": "boolean"
672
+ },
673
+ "where": {
674
+ "char": "w",
675
+ "description": "comma separated list of query filters",
676
+ "name": "where",
677
+ "hasDynamicHelp": false,
678
+ "multiple": true,
679
+ "type": "option"
680
+ },
681
+ "page": {
682
+ "char": "p",
683
+ "description": "page number",
684
+ "name": "page",
685
+ "hasDynamicHelp": false,
686
+ "multiple": false,
687
+ "type": "option"
688
+ },
689
+ "pageSize": {
690
+ "char": "n",
691
+ "description": "number of elements per page",
692
+ "name": "pageSize",
693
+ "hasDynamicHelp": false,
694
+ "multiple": false,
695
+ "type": "option"
696
+ },
697
+ "sort": {
698
+ "char": "s",
699
+ "description": "defines results ordering",
700
+ "name": "sort",
701
+ "hasDynamicHelp": false,
702
+ "multiple": true,
703
+ "type": "option"
704
+ },
705
+ "extract": {
706
+ "char": "e",
707
+ "description": "extract subfields from object attributes",
708
+ "exclusive": [
709
+ "raw"
710
+ ],
711
+ "name": "extract",
712
+ "hasDynamicHelp": false,
713
+ "multiple": true,
714
+ "type": "option"
715
+ },
716
+ "force-include": {
717
+ "char": "I",
718
+ "dependsOn": [
719
+ "include"
720
+ ],
721
+ "description": "force resources inclusion beyound the 3rd level",
722
+ "hidden": true,
723
+ "name": "force-include",
724
+ "allowNo": false,
725
+ "type": "boolean"
726
+ }
727
+ },
728
+ "hasDynamicHelp": false,
729
+ "hiddenAliases": [],
730
+ "id": "provisioning:get",
731
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
732
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
733
+ "pluginType": "core",
734
+ "strict": false,
735
+ "isESM": false,
736
+ "relativePath": [
737
+ "lib",
738
+ "commands",
739
+ "provisioning",
740
+ "get.js"
741
+ ]
742
+ },
743
+ "provisioning:list": {
744
+ "aliases": [
745
+ "pl",
746
+ "prov:list",
747
+ "plist",
748
+ "pls"
749
+ ],
750
+ "args": {
751
+ "resource": {
752
+ "description": "the resource type",
753
+ "name": "resource",
754
+ "required": true
755
+ }
756
+ },
757
+ "description": "fetch a collection of resources",
758
+ "examples": [
759
+ "$ commercelayer provisioning:list roles -f id,name -i organization -s updated_at",
760
+ "$ cl prov:list roles -i organization -f name -f organizations/name -w organization_name_eq=\"ORG NAME\"",
761
+ "$ cl prov:list roles -p 5 -n 10 -s -created_at --raw"
762
+ ],
763
+ "flags": {
764
+ "domain": {
765
+ "char": "d",
766
+ "env": "CL_CLI_DOMAIN",
767
+ "hidden": true,
768
+ "name": "domain",
769
+ "required": false,
770
+ "hasDynamicHelp": false,
771
+ "multiple": false,
772
+ "type": "option"
773
+ },
774
+ "accessToken": {
775
+ "env": "CL_CLI_ACCESS_TOKEN",
776
+ "hidden": true,
777
+ "name": "accessToken",
778
+ "required": true,
779
+ "hasDynamicHelp": false,
780
+ "multiple": false,
781
+ "type": "option"
782
+ },
783
+ "include": {
784
+ "char": "i",
785
+ "description": "comma separated resources to include",
786
+ "name": "include",
787
+ "hasDynamicHelp": false,
788
+ "multiple": true,
789
+ "type": "option"
790
+ },
791
+ "fields": {
792
+ "char": "f",
793
+ "description": "comma separeted list of fields in the format [resourceType/]field1,field2...",
794
+ "name": "fields",
795
+ "hasDynamicHelp": false,
796
+ "multiple": true,
797
+ "type": "option"
798
+ },
799
+ "json": {
800
+ "char": "j",
801
+ "description": "convert output in standard JSON format",
802
+ "name": "json",
803
+ "allowNo": false,
804
+ "type": "boolean"
805
+ },
806
+ "unformatted": {
807
+ "char": "u",
808
+ "dependsOn": [
809
+ "json"
810
+ ],
811
+ "description": "print unformatted JSON output",
812
+ "name": "unformatted",
813
+ "allowNo": false,
814
+ "type": "boolean"
815
+ },
816
+ "raw": {
817
+ "char": "R",
818
+ "description": "print out the raw API response",
819
+ "hidden": false,
820
+ "name": "raw",
821
+ "allowNo": false,
822
+ "type": "boolean"
823
+ },
824
+ "headers": {
825
+ "char": "H",
826
+ "dependsOn": [
827
+ "raw"
828
+ ],
829
+ "description": "show response headers",
830
+ "exclusive": [
831
+ "headers-only"
832
+ ],
833
+ "name": "headers",
834
+ "allowNo": false,
835
+ "type": "boolean"
836
+ },
837
+ "headers-only": {
838
+ "char": "Y",
839
+ "dependsOn": [
840
+ "raw"
841
+ ],
842
+ "description": "show only response headers",
843
+ "exclusive": [
844
+ "headers",
845
+ "fields",
846
+ "include"
847
+ ],
848
+ "name": "headers-only",
849
+ "allowNo": false,
850
+ "type": "boolean"
851
+ },
852
+ "where": {
853
+ "char": "w",
854
+ "description": "comma separated list of query filters",
855
+ "name": "where",
856
+ "hasDynamicHelp": false,
857
+ "multiple": true,
858
+ "type": "option"
859
+ },
860
+ "page": {
861
+ "char": "p",
862
+ "description": "page number",
863
+ "name": "page",
864
+ "hasDynamicHelp": false,
865
+ "multiple": false,
866
+ "type": "option"
867
+ },
868
+ "pageSize": {
869
+ "char": "n",
870
+ "description": "number of elements per page",
871
+ "name": "pageSize",
872
+ "hasDynamicHelp": false,
873
+ "multiple": false,
874
+ "type": "option"
875
+ },
876
+ "sort": {
877
+ "char": "s",
878
+ "description": "defines results ordering",
879
+ "name": "sort",
880
+ "hasDynamicHelp": false,
881
+ "multiple": true,
882
+ "type": "option"
883
+ },
884
+ "extract": {
885
+ "char": "e",
886
+ "description": "extract subfields from object attributes",
887
+ "exclusive": [
888
+ "raw"
889
+ ],
890
+ "name": "extract",
891
+ "hasDynamicHelp": false,
892
+ "multiple": true,
893
+ "type": "option"
894
+ },
895
+ "force-include": {
896
+ "char": "I",
897
+ "dependsOn": [
898
+ "include"
899
+ ],
900
+ "description": "force resources inclusion beyound the 3rd level",
901
+ "hidden": true,
902
+ "name": "force-include",
903
+ "allowNo": false,
904
+ "type": "boolean"
905
+ }
906
+ },
907
+ "hasDynamicHelp": false,
908
+ "hiddenAliases": [],
909
+ "id": "provisioning:list",
910
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
911
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
912
+ "pluginType": "core",
913
+ "strict": true,
914
+ "isESM": false,
915
+ "relativePath": [
916
+ "lib",
917
+ "commands",
918
+ "provisioning",
919
+ "list.js"
920
+ ]
921
+ },
922
+ "provisioning:noc": {
923
+ "aliases": [],
924
+ "args": {},
925
+ "flags": {},
926
+ "hasDynamicHelp": false,
927
+ "hidden": true,
928
+ "hiddenAliases": [],
929
+ "id": "provisioning:noc",
930
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
931
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
932
+ "pluginType": "core",
933
+ "strict": true,
934
+ "isESM": false,
935
+ "relativePath": [
936
+ "lib",
937
+ "commands",
938
+ "provisioning",
939
+ "noc.js"
940
+ ]
941
+ },
942
+ "provisioning:relationship": {
943
+ "aliases": [
944
+ "provisioning:rel",
945
+ "prov:rel",
946
+ "prov:relationship"
947
+ ],
948
+ "args": {
949
+ "resource": {
950
+ "description": "the resource type",
951
+ "name": "resource",
952
+ "required": true
953
+ },
954
+ "id": {
955
+ "description": "id of the resource to retrieve",
956
+ "name": "id",
957
+ "required": true
958
+ },
959
+ "relationship": {
960
+ "description": "name of the relationship field",
961
+ "name": "relationship",
962
+ "required": true
963
+ }
964
+ },
965
+ "description": "fetch a resource relationship",
966
+ "examples": [
967
+ "$ commercelayer provisioning:relationship roles <roleId> organization",
968
+ "$ clayer prov:relationship roles <roleId> permissions",
969
+ "$ cl prov:rel roles <roleId> permisions -w subject_eq=testsub"
970
+ ],
971
+ "flags": {
972
+ "domain": {
973
+ "char": "d",
974
+ "env": "CL_CLI_DOMAIN",
975
+ "hidden": true,
976
+ "name": "domain",
977
+ "required": false,
978
+ "hasDynamicHelp": false,
979
+ "multiple": false,
980
+ "type": "option"
981
+ },
982
+ "accessToken": {
983
+ "env": "CL_CLI_ACCESS_TOKEN",
984
+ "hidden": true,
985
+ "name": "accessToken",
986
+ "required": true,
987
+ "hasDynamicHelp": false,
988
+ "multiple": false,
989
+ "type": "option"
990
+ },
991
+ "include": {
992
+ "char": "i",
993
+ "description": "comma separated resources to include",
994
+ "name": "include",
995
+ "hasDynamicHelp": false,
996
+ "multiple": true,
997
+ "type": "option"
998
+ },
999
+ "fields": {
1000
+ "char": "f",
1001
+ "description": "comma separeted list of fields in the format [resourceType/]field1,field2...",
1002
+ "name": "fields",
1003
+ "hasDynamicHelp": false,
1004
+ "multiple": true,
1005
+ "type": "option"
1006
+ },
1007
+ "json": {
1008
+ "char": "j",
1009
+ "description": "convert output in standard JSON format",
1010
+ "name": "json",
1011
+ "allowNo": false,
1012
+ "type": "boolean"
1013
+ },
1014
+ "unformatted": {
1015
+ "char": "u",
1016
+ "dependsOn": [
1017
+ "json"
1018
+ ],
1019
+ "description": "print unformatted JSON output",
1020
+ "name": "unformatted",
1021
+ "allowNo": false,
1022
+ "type": "boolean"
1023
+ },
1024
+ "raw": {
1025
+ "char": "R",
1026
+ "description": "print out the raw API response",
1027
+ "hidden": false,
1028
+ "name": "raw",
1029
+ "allowNo": false,
1030
+ "type": "boolean"
1031
+ },
1032
+ "headers": {
1033
+ "char": "H",
1034
+ "dependsOn": [
1035
+ "raw"
1036
+ ],
1037
+ "description": "show response headers",
1038
+ "exclusive": [
1039
+ "headers-only"
1040
+ ],
1041
+ "name": "headers",
1042
+ "allowNo": false,
1043
+ "type": "boolean"
1044
+ },
1045
+ "headers-only": {
1046
+ "char": "Y",
1047
+ "dependsOn": [
1048
+ "raw"
1049
+ ],
1050
+ "description": "show only response headers",
1051
+ "exclusive": [
1052
+ "headers",
1053
+ "fields",
1054
+ "include"
1055
+ ],
1056
+ "name": "headers-only",
1057
+ "allowNo": false,
1058
+ "type": "boolean"
1059
+ },
1060
+ "where": {
1061
+ "char": "w",
1062
+ "description": "comma separated list of query filters",
1063
+ "name": "where",
1064
+ "hasDynamicHelp": false,
1065
+ "multiple": true,
1066
+ "type": "option"
1067
+ },
1068
+ "page": {
1069
+ "char": "p",
1070
+ "description": "page number",
1071
+ "name": "page",
1072
+ "hasDynamicHelp": false,
1073
+ "multiple": false,
1074
+ "type": "option"
1075
+ },
1076
+ "pageSize": {
1077
+ "char": "n",
1078
+ "description": "number of elements per page",
1079
+ "name": "pageSize",
1080
+ "hasDynamicHelp": false,
1081
+ "multiple": false,
1082
+ "type": "option"
1083
+ },
1084
+ "sort": {
1085
+ "char": "s",
1086
+ "description": "defines results ordering",
1087
+ "name": "sort",
1088
+ "hasDynamicHelp": false,
1089
+ "multiple": true,
1090
+ "type": "option"
1091
+ },
1092
+ "extract": {
1093
+ "char": "e",
1094
+ "description": "extract subfields from object attributes",
1095
+ "exclusive": [
1096
+ "raw"
1097
+ ],
1098
+ "name": "extract",
1099
+ "hasDynamicHelp": false,
1100
+ "multiple": true,
1101
+ "type": "option"
1102
+ },
1103
+ "force-include": {
1104
+ "char": "I",
1105
+ "dependsOn": [
1106
+ "include"
1107
+ ],
1108
+ "description": "force resources inclusion beyound the 3rd level",
1109
+ "hidden": true,
1110
+ "name": "force-include",
1111
+ "allowNo": false,
1112
+ "type": "boolean"
1113
+ }
1114
+ },
1115
+ "hasDynamicHelp": false,
1116
+ "hidden": true,
1117
+ "hiddenAliases": [],
1118
+ "id": "provisioning:relationship",
1119
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
1120
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
1121
+ "pluginType": "core",
1122
+ "strict": true,
1123
+ "isESM": false,
1124
+ "relativePath": [
1125
+ "lib",
1126
+ "commands",
1127
+ "provisioning",
1128
+ "relationship.js"
1129
+ ]
1130
+ },
1131
+ "provisioning:resources": {
1132
+ "aliases": [
1133
+ "prov:resources",
1134
+ "pres"
1135
+ ],
1136
+ "args": {},
1137
+ "description": "list all the available Provisioning API resources",
1138
+ "examples": [
1139
+ "$ commercelayer provisioning:resources",
1140
+ "$ cl prov:resources"
1141
+ ],
1142
+ "flags": {
1143
+ "help": {
1144
+ "char": "h",
1145
+ "description": "Show CLI help.",
1146
+ "name": "help",
1147
+ "allowNo": false,
1148
+ "type": "boolean"
1149
+ }
1150
+ },
1151
+ "hasDynamicHelp": false,
1152
+ "hiddenAliases": [],
1153
+ "id": "provisioning:resources",
1154
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
1155
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
1156
+ "pluginType": "core",
1157
+ "strict": true,
1158
+ "isESM": false,
1159
+ "relativePath": [
1160
+ "lib",
1161
+ "commands",
1162
+ "provisioning",
1163
+ "resources.js"
1164
+ ]
1165
+ },
1166
+ "provisioning:retrieve": {
1167
+ "aliases": [
1168
+ "prov:retrieve",
1169
+ "pr",
1170
+ "pretrieve"
1171
+ ],
1172
+ "args": {
1173
+ "resource": {
1174
+ "description": "the resource type",
1175
+ "name": "resource",
1176
+ "required": true
1177
+ },
1178
+ "id": {
1179
+ "description": "id of the resource to retrieve",
1180
+ "name": "id",
1181
+ "required": false
1182
+ }
1183
+ },
1184
+ "description": "fetch a single resource",
1185
+ "examples": [
1186
+ "$ commercelayer provisioning:retrieve roles/<roleId>",
1187
+ "$ commercelayer prov:retrieve roles <roleId>",
1188
+ "$ cl prov:retrieve roles <roleId>",
1189
+ "$ clayer pr roles/<roleId>"
1190
+ ],
1191
+ "flags": {
1192
+ "domain": {
1193
+ "char": "d",
1194
+ "env": "CL_CLI_DOMAIN",
1195
+ "hidden": true,
1196
+ "name": "domain",
1197
+ "required": false,
1198
+ "hasDynamicHelp": false,
1199
+ "multiple": false,
1200
+ "type": "option"
1201
+ },
1202
+ "accessToken": {
1203
+ "env": "CL_CLI_ACCESS_TOKEN",
1204
+ "hidden": true,
1205
+ "name": "accessToken",
1206
+ "required": true,
1207
+ "hasDynamicHelp": false,
1208
+ "multiple": false,
1209
+ "type": "option"
1210
+ },
1211
+ "include": {
1212
+ "char": "i",
1213
+ "description": "comma separated resources to include",
1214
+ "name": "include",
1215
+ "hasDynamicHelp": false,
1216
+ "multiple": true,
1217
+ "type": "option"
1218
+ },
1219
+ "fields": {
1220
+ "char": "f",
1221
+ "description": "comma separeted list of fields in the format [resourceType/]field1,field2...",
1222
+ "name": "fields",
1223
+ "hasDynamicHelp": false,
1224
+ "multiple": true,
1225
+ "type": "option"
1226
+ },
1227
+ "json": {
1228
+ "char": "j",
1229
+ "description": "convert output in standard JSON format",
1230
+ "name": "json",
1231
+ "allowNo": false,
1232
+ "type": "boolean"
1233
+ },
1234
+ "unformatted": {
1235
+ "char": "u",
1236
+ "dependsOn": [
1237
+ "json"
1238
+ ],
1239
+ "description": "print unformatted JSON output",
1240
+ "name": "unformatted",
1241
+ "allowNo": false,
1242
+ "type": "boolean"
1243
+ },
1244
+ "raw": {
1245
+ "char": "R",
1246
+ "description": "print out the raw API response",
1247
+ "hidden": false,
1248
+ "name": "raw",
1249
+ "allowNo": false,
1250
+ "type": "boolean"
1251
+ },
1252
+ "headers": {
1253
+ "char": "H",
1254
+ "dependsOn": [
1255
+ "raw"
1256
+ ],
1257
+ "description": "show response headers",
1258
+ "exclusive": [
1259
+ "headers-only"
1260
+ ],
1261
+ "name": "headers",
1262
+ "allowNo": false,
1263
+ "type": "boolean"
1264
+ },
1265
+ "headers-only": {
1266
+ "char": "Y",
1267
+ "dependsOn": [
1268
+ "raw"
1269
+ ],
1270
+ "description": "show only response headers",
1271
+ "exclusive": [
1272
+ "headers",
1273
+ "fields",
1274
+ "include"
1275
+ ],
1276
+ "name": "headers-only",
1277
+ "allowNo": false,
1278
+ "type": "boolean"
1279
+ },
1280
+ "extract": {
1281
+ "char": "e",
1282
+ "description": "extract subfields from object attributes",
1283
+ "exclusive": [
1284
+ "raw"
1285
+ ],
1286
+ "name": "extract",
1287
+ "hasDynamicHelp": false,
1288
+ "multiple": true,
1289
+ "type": "option"
1290
+ }
1291
+ },
1292
+ "hasDynamicHelp": false,
1293
+ "hiddenAliases": [],
1294
+ "id": "provisioning:retrieve",
1295
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
1296
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
1297
+ "pluginType": "core",
1298
+ "strict": true,
1299
+ "isESM": false,
1300
+ "relativePath": [
1301
+ "lib",
1302
+ "commands",
1303
+ "provisioning",
1304
+ "retrieve.js"
1305
+ ]
1306
+ },
1307
+ "provisioning:update": {
1308
+ "aliases": [
1309
+ "prov:update",
1310
+ "pu",
1311
+ "pupdate",
1312
+ "pupd"
1313
+ ],
1314
+ "args": {
1315
+ "resource": {
1316
+ "description": "the resource type",
1317
+ "name": "resource",
1318
+ "required": true
1319
+ },
1320
+ "id": {
1321
+ "description": "id of the resource to update",
1322
+ "name": "id",
1323
+ "required": false
1324
+ }
1325
+ },
1326
+ "description": "update an existing resource",
1327
+ "examples": [
1328
+ "$ commercelayer provisioning:update roles/<roleId> -a reference=referenceId",
1329
+ "$ commercelayer prov:update roles <roleId> -a reference_origin=\"Ref Origin\"",
1330
+ "$ cl prov:update roles/<roleId> -m meta_key=\"meta value\"",
1331
+ "$ cl pu roles <roleId> -M meta_key=\"metadata overwrite",
1332
+ "$ clayer prov:update roles <roleId> -D /path/to/data/file/data.json"
1333
+ ],
1334
+ "flags": {
1335
+ "domain": {
1336
+ "char": "d",
1337
+ "env": "CL_CLI_DOMAIN",
1338
+ "hidden": true,
1339
+ "name": "domain",
1340
+ "required": false,
1341
+ "hasDynamicHelp": false,
1342
+ "multiple": false,
1343
+ "type": "option"
1344
+ },
1345
+ "accessToken": {
1346
+ "env": "CL_CLI_ACCESS_TOKEN",
1347
+ "hidden": true,
1348
+ "name": "accessToken",
1349
+ "required": true,
1350
+ "hasDynamicHelp": false,
1351
+ "multiple": false,
1352
+ "type": "option"
1353
+ },
1354
+ "include": {
1355
+ "char": "i",
1356
+ "description": "comma separated resources to include",
1357
+ "name": "include",
1358
+ "hasDynamicHelp": false,
1359
+ "multiple": true,
1360
+ "type": "option"
1361
+ },
1362
+ "fields": {
1363
+ "char": "f",
1364
+ "description": "comma separeted list of fields in the format [resourceType/]field1,field2...",
1365
+ "name": "fields",
1366
+ "hasDynamicHelp": false,
1367
+ "multiple": true,
1368
+ "type": "option"
1369
+ },
1370
+ "json": {
1371
+ "char": "j",
1372
+ "description": "convert output in standard JSON format",
1373
+ "name": "json",
1374
+ "allowNo": false,
1375
+ "type": "boolean"
1376
+ },
1377
+ "unformatted": {
1378
+ "char": "u",
1379
+ "dependsOn": [
1380
+ "json"
1381
+ ],
1382
+ "description": "print unformatted JSON output",
1383
+ "name": "unformatted",
1384
+ "allowNo": false,
1385
+ "type": "boolean"
1386
+ },
1387
+ "raw": {
1388
+ "char": "R",
1389
+ "description": "print out the raw API response",
1390
+ "hidden": false,
1391
+ "name": "raw",
1392
+ "allowNo": false,
1393
+ "type": "boolean"
1394
+ },
1395
+ "headers": {
1396
+ "char": "H",
1397
+ "dependsOn": [
1398
+ "raw"
1399
+ ],
1400
+ "description": "show response headers",
1401
+ "exclusive": [
1402
+ "headers-only"
1403
+ ],
1404
+ "name": "headers",
1405
+ "allowNo": false,
1406
+ "type": "boolean"
1407
+ },
1408
+ "headers-only": {
1409
+ "char": "Y",
1410
+ "dependsOn": [
1411
+ "raw"
1412
+ ],
1413
+ "description": "show only response headers",
1414
+ "exclusive": [
1415
+ "headers",
1416
+ "fields",
1417
+ "include"
1418
+ ],
1419
+ "name": "headers-only",
1420
+ "allowNo": false,
1421
+ "type": "boolean"
1422
+ },
1423
+ "attribute": {
1424
+ "char": "a",
1425
+ "description": "define a resource attribute",
1426
+ "name": "attribute",
1427
+ "hasDynamicHelp": false,
1428
+ "multiple": true,
1429
+ "type": "option"
1430
+ },
1431
+ "object": {
1432
+ "char": "O",
1433
+ "description": "define a resource object attribute",
1434
+ "name": "object",
1435
+ "hasDynamicHelp": false,
1436
+ "multiple": true,
1437
+ "type": "option"
1438
+ },
1439
+ "relationship": {
1440
+ "char": "r",
1441
+ "description": "define a relationship with another resource",
1442
+ "name": "relationship",
1443
+ "hasDynamicHelp": false,
1444
+ "multiple": true,
1445
+ "type": "option"
1446
+ },
1447
+ "metadata": {
1448
+ "char": "m",
1449
+ "description": "define a metadata attribute and merge it with the metadata already present in the remote resource",
1450
+ "exclusive": [
1451
+ "metadata-replace"
1452
+ ],
1453
+ "name": "metadata",
1454
+ "hasDynamicHelp": false,
1455
+ "multiple": true,
1456
+ "type": "option"
1457
+ },
1458
+ "metadata-replace": {
1459
+ "char": "M",
1460
+ "description": "define a metadata attribute and replace every item already present in the remote resource",
1461
+ "exclusive": [
1462
+ "metadata"
1463
+ ],
1464
+ "name": "metadata-replace",
1465
+ "hasDynamicHelp": false,
1466
+ "multiple": true,
1467
+ "type": "option"
1468
+ },
1469
+ "data": {
1470
+ "char": "D",
1471
+ "description": "the data file to use as request body",
1472
+ "exclusive": [
1473
+ "attribute",
1474
+ "relationship",
1475
+ "metadata",
1476
+ "metadata-replace",
1477
+ "doc"
1478
+ ],
1479
+ "name": "data",
1480
+ "hasDynamicHelp": false,
1481
+ "multiple": false,
1482
+ "type": "option"
1483
+ }
1484
+ },
1485
+ "hasDynamicHelp": false,
1486
+ "hiddenAliases": [],
1487
+ "id": "provisioning:update",
1488
+ "pluginAlias": "@commercelayer/cli-plugin-provisioning",
1489
+ "pluginName": "@commercelayer/cli-plugin-provisioning",
1490
+ "pluginType": "core",
1491
+ "strict": true,
1492
+ "isESM": false,
1493
+ "relativePath": [
1494
+ "lib",
1495
+ "commands",
1496
+ "provisioning",
1497
+ "update.js"
1498
+ ]
1499
+ }
1500
+ },
1501
+ "version": "1.0.0"
1502
+ }