proca 1.8.3 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +211 -195
  2. package/package.json +1 -1
  3. package/src/commands/campaign/add.mjs +7 -10
  4. package/src/commands/campaign/list.mjs +10 -28
  5. package/src/commands/contact/area/count.mjs +38 -0
  6. package/src/commands/contact/list.mjs +1 -5
  7. package/src/commands/widget/update/external.mjs +52 -0
  8. package/src/commands/widget/update/name.mjs +28 -0
  9. package/src/commands/widget/update.mjs +11 -16
  10. package/src/procaCommand.mjs +35 -18
  11. package/src/urql.mjs +1 -1
package/README.md CHANGED
@@ -53,27 +53,28 @@ you should also use the local proca-api in your [widget generator](https://githu
53
53
  * [`proca action list [TITLE]`](#proca-action-list-title)
54
54
  * [`proca action replay`](#proca-action-replay)
55
55
  * [`proca action requeue`](#proca-action-requeue)
56
- * [`proca campaign add [TITLE]`](#proca-campaign-add-title)
56
+ * [`proca campaign add`](#proca-campaign-add)
57
57
  * [`proca campaign close`](#proca-campaign-close)
58
58
  * [`proca campaign copy`](#proca-campaign-copy)
59
59
  * [`proca campaign delete`](#proca-campaign-delete)
60
60
  * [`proca campaign get`](#proca-campaign-get)
61
- * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
61
+ * [`proca campaign list`](#proca-campaign-list)
62
62
  * [`proca campaign mtt`](#proca-campaign-mtt)
63
63
  * [`proca campaign status`](#proca-campaign-status)
64
64
  * [`proca campaign widget archive`](#proca-campaign-widget-archive)
65
65
  * [`proca campaign widget copy`](#proca-campaign-widget-copy)
66
66
  * [`proca campaign widget get`](#proca-campaign-widget-get)
67
67
  * [`proca campaign widget rebuild`](#proca-campaign-widget-rebuild)
68
- * [`proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-markdown-simplify)
68
+ * [`proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-json-csv-markdown-simplify)
69
69
  * [`proca config folder`](#proca-config-folder)
70
- * [`proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-init-env-human-json-csv-markdown-simplify)
70
+ * [`proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-init-env-json-csv-markdown-simplify)
71
71
  * [`proca config server`](#proca-config-server)
72
72
  * [`proca config set [KEY] [VALUE]`](#proca-config-set-key-value)
73
- * [`proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-setup-env-human-json-csv-markdown-simplify)
73
+ * [`proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-setup-env-json-csv-markdown-simplify)
74
74
  * [`proca config user`](#proca-config-user)
75
+ * [`proca contact area count`](#proca-contact-area-count)
75
76
  * [`proca contact count`](#proca-contact-count)
76
- * [`proca contact list [TITLE]`](#proca-contact-list-title)
77
+ * [`proca contact list`](#proca-contact-list)
77
78
  * [`proca help [COMMAND]`](#proca-help-command)
78
79
  * [`proca org add`](#proca-org-add)
79
80
  * [`proca org crm`](#proca-org-crm)
@@ -110,15 +111,17 @@ you should also use the local proca-api in your [widget generator](https://githu
110
111
  * [`proca widget list`](#proca-widget-list)
111
112
  * [`proca widget rebuild`](#proca-widget-rebuild)
112
113
  * [`proca widget update`](#proca-widget-update)
114
+ * [`proca widget update external`](#proca-widget-update-external)
115
+ * [`proca widget update name`](#proca-widget-update-name)
113
116
 
114
117
  ## `proca action add`
115
118
 
116
119
  ```
117
120
  USAGE
118
121
  $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
119
- [--json | --human | --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing]
120
- [--optin] [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>]
121
- [--country <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
122
+ [--json | --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
123
+ [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
124
+ <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
122
125
 
123
126
  FLAGS
124
127
  -i, --id=<value> (required) widget's id
@@ -143,7 +146,6 @@ FLAGS
143
146
 
144
147
  OUTPUT FLAGS
145
148
  --csv Format output as csv
146
- --human Format output to be read on screen by a human [default]
147
149
  --json Format output as json
148
150
  --markdown Format output as markdown table
149
151
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -162,8 +164,8 @@ Should the supporter confirm the action? it can be set either for all the widget
162
164
 
163
165
  ```
164
166
  USAGE
165
- $ proca action confirm [--json | --human | --csv | --markdown] [--env <value>]
166
- [--simplify] [--org <value>] [--campaign <value>] [--confirm] [--template <value>]
167
+ $ proca action confirm [--json | --csv | --markdown] [--env <value>] [--simplify] [--org
168
+ <value>] [--campaign <value>] [--confirm] [--template <value>]
167
169
 
168
170
  FLAGS
169
171
  --campaign=<value> campaign collecting the action
@@ -174,7 +176,6 @@ FLAGS
174
176
 
175
177
  OUTPUT FLAGS
176
178
  --csv Format output as csv
177
- --human Format output to be read on screen by a human [default]
178
179
  --json Format output as json
179
180
  --markdown Format output as markdown table
180
181
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -190,8 +191,8 @@ counter of actions
190
191
 
191
192
  ```
192
193
  USAGE
193
- $ proca action count [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
194
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
194
+ $ proca action count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
195
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
195
196
 
196
197
  FLAGS
197
198
  -i, --id=<value>
@@ -201,7 +202,6 @@ FLAGS
201
202
 
202
203
  OUTPUT FLAGS
203
204
  --csv Format output as csv
204
- --human Format output to be read on screen by a human [default]
205
205
  --json Format output as json
206
206
  --markdown Format output as markdown table
207
207
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -219,9 +219,9 @@ EXAMPLES
219
219
 
220
220
  ```
221
221
  USAGE
222
- $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv |
223
- --markdown] [--env <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin]
224
- [--testing] [--doi] [--utm | --simplify] [--comment | ]
222
+ $ proca action list [TITLE] -o <organisation name> [--json | --csv | --markdown]
223
+ [--env <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi]
224
+ [--utm | --simplify] [--comment | ]
225
225
 
226
226
  ARGUMENTS
227
227
  TITLE name of the campaign, % for wildchar
@@ -241,7 +241,6 @@ FLAGS
241
241
 
242
242
  OUTPUT FLAGS
243
243
  --csv Format output as csv
244
- --human Format output to be read on screen by a human [default]
245
244
  --json Format output as json
246
245
  --markdown Format output as markdown table
247
246
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -254,8 +253,8 @@ EXAMPLES
254
253
 
255
254
  ```
256
255
  USAGE
257
- $ proca action replay -o <organisation name> [--json | --human | --csv | --markdown]
258
- [--env <value>] [--simplify] [-c <campaign title>]
256
+ $ proca action replay -o <organisation name> [--json | --csv | --markdown] [--env
257
+ <value>] [--simplify] [-c <campaign title>]
259
258
 
260
259
  FLAGS
261
260
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
@@ -264,7 +263,6 @@ FLAGS
264
263
 
265
264
  OUTPUT FLAGS
266
265
  --csv Format output as csv
267
- --human Format output to be read on screen by a human [default]
268
266
  --json Format output as json
269
267
  --markdown Format output as markdown table
270
268
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -280,9 +278,9 @@ requeue actions
280
278
  ```
281
279
  USAGE
282
280
  $ proca action requeue -o <org name> -q
283
- CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --human |
284
- --csv | --markdown] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after
285
- 2025-04-09] [--optin] [--testing] [--doi]
281
+ CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --csv |
282
+ --markdown] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09]
283
+ [--optin] [--testing] [--doi]
286
284
 
287
285
  FLAGS
288
286
  -c, --campaign=<campaign name> name of the campaign, % for wildchar
@@ -300,7 +298,6 @@ FLAGS
300
298
 
301
299
  OUTPUT FLAGS
302
300
  --csv Format output as csv
303
- --human Format output to be read on screen by a human [default]
304
301
  --json Format output as json
305
302
  --markdown Format output as markdown table
306
303
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -312,24 +309,21 @@ EXAMPLES
312
309
  $ proca action requeue
313
310
  ```
314
311
 
315
- ## `proca campaign add [TITLE]`
312
+ ## `proca campaign add`
316
313
 
317
314
  ```
318
315
  USAGE
319
- $ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human | --csv
320
- | --markdown] [--env <value>] [--simplify]
321
-
322
- ARGUMENTS
323
- TITLE title of the campaign
316
+ $ proca campaign add -n <campaign name> -o <org name> [--json | --csv | --markdown]
317
+ [--env <value>] [--simplify] [--title <value>...]
324
318
 
325
319
  FLAGS
326
320
  -n, --name=<campaign name> (required) name of the campaign
327
321
  -o, --org=<org name> (required) name of the coordinator
328
322
  --env=<value> [default: default] allow to switch between configurations (server or users)
323
+ --title=<value>... title of the campaign
329
324
 
330
325
  OUTPUT FLAGS
331
326
  --csv Format output as csv
332
- --human Format output to be read on screen by a human [default]
333
327
  --json Format output as json
334
328
  --markdown Format output as markdown table
335
329
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -342,8 +336,8 @@ EXAMPLES
342
336
 
343
337
  ```
344
338
  USAGE
345
- $ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
346
- --human | --csv | --markdown] [--env <value>] [--simplify]
339
+ $ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json | --csv
340
+ | --markdown] [--env <value>] [--simplify]
347
341
 
348
342
  FLAGS
349
343
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -352,7 +346,6 @@ FLAGS
352
346
 
353
347
  OUTPUT FLAGS
354
348
  --csv Format output as csv
355
- --human Format output to be read on screen by a human [default]
356
349
  --json Format output as json
357
350
  --markdown Format output as markdown table
358
351
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -372,9 +365,9 @@ Copy campaign settings to a new campaign
372
365
 
373
366
  ```
374
367
  USAGE
375
- $ proca campaign copy [ID_NAME_DXID] -t <campaign name> [--json | --human | --csv |
376
- --markdown] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-o <org name>] [--title
377
- <campaign title>] [--dry-run]
368
+ $ proca campaign copy [ID_NAME_DXID] -t <campaign name> [--json | --csv | --markdown]
369
+ [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-o <org name>] [--title <campaign
370
+ title>] [--dry-run]
378
371
 
379
372
  FLAGS
380
373
  -i, --id=<value>
@@ -388,7 +381,6 @@ FLAGS
388
381
 
389
382
  OUTPUT FLAGS
390
383
  --csv Format output as csv
391
- --human Format output to be read on screen by a human [default]
392
384
  --json Format output as json
393
385
  --markdown Format output as markdown table
394
386
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -408,8 +400,8 @@ delete a campaign
408
400
 
409
401
  ```
410
402
  USAGE
411
- $ proca campaign delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
412
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
403
+ $ proca campaign delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
404
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
413
405
 
414
406
  FLAGS
415
407
  -i, --id=<value>
@@ -419,7 +411,6 @@ FLAGS
419
411
 
420
412
  OUTPUT FLAGS
421
413
  --csv Format output as csv
422
- --human Format output to be read on screen by a human [default]
423
414
  --json Format output as json
424
415
  --markdown Format output as markdown table
425
416
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -443,8 +434,8 @@ view a campaign
443
434
 
444
435
  ```
445
436
  USAGE
446
- $ proca campaign get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
447
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
437
+ $ proca campaign get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
438
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
448
439
 
449
440
  FLAGS
450
441
  -i, --id=<value>
@@ -457,7 +448,6 @@ FLAGS
457
448
 
458
449
  OUTPUT FLAGS
459
450
  --csv Format output as csv
460
- --human Format output to be read on screen by a human [default]
461
451
  --json Format output as json
462
452
  --markdown Format output as markdown table
463
453
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -469,36 +459,29 @@ EXAMPLES
469
459
  $ proca campaign get -i 42
470
460
  ```
471
461
 
472
- ## `proca campaign list [TITLE]`
462
+ ## `proca campaign list`
473
463
 
474
464
  list all the campaigns
475
465
 
476
466
  ```
477
467
  USAGE
478
- $ proca campaign list [TITLE] [--json | --human | --csv | --markdown] [--env <value>]
479
- [--simplify] [-o <organisation name>] [-t <campaign title>] [--stats]
480
-
481
- ARGUMENTS
482
- TITLE name of the campaign, % for wildchar
468
+ $ proca campaign list [--json | --csv | --markdown] [--env <value>] [--simplify] [-n
469
+ <the_short_name>] [-t <campaign title>...] [--stats]
483
470
 
484
471
  FLAGS
485
- -o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
486
- -t, --title=<campaign title> name of the campaign, % for wildchar
487
- --env=<value> [default: default] allow to switch between configurations (server or users)
488
- --[no-]stats display the stats
472
+ -n, --name=<the_short_name> name of the organisation
473
+ -t, --title=<campaign title>... name of the campaign
474
+ --env=<value> [default: default] allow to switch between configurations (server or users)
475
+ --[no-]stats display the stats
489
476
 
490
477
  OUTPUT FLAGS
491
478
  --csv Format output as csv
492
- --human Format output to be read on screen by a human [default]
493
479
  --json Format output as json
494
480
  --markdown Format output as markdown table
495
481
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
496
482
 
497
483
  DESCRIPTION
498
484
  list all the campaigns
499
-
500
- EXAMPLES
501
- $ proca campaign list %pizza%
502
485
  ```
503
486
 
504
487
  ## `proca campaign mtt`
@@ -507,9 +490,9 @@ set the mail to target (mtt) params
507
490
 
508
491
  ```
509
492
  USAGE
510
- $ proca campaign mtt [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
511
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template
512
- <value>] [--period <value>] [--email <value>] [--cc <value>] [--sender] [--drip]
493
+ $ proca campaign mtt [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
494
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template <value>]
495
+ [--period <value>] [--email <value>] [--cc <value>] [--sender] [--drip]
513
496
 
514
497
  FLAGS
515
498
  -i, --id=<value>
@@ -527,7 +510,6 @@ FLAGS
527
510
 
528
511
  OUTPUT FLAGS
529
512
  --csv Format output as csv
530
- --human Format output to be read on screen by a human [default]
531
513
  --json Format output as json
532
514
  --markdown Format output as markdown table
533
515
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -543,8 +525,8 @@ EXAMPLES
543
525
 
544
526
  ```
545
527
  USAGE
546
- $ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
547
- --human | --csv | --markdown] [--env <value>] [--simplify]
528
+ $ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json | --csv
529
+ | --markdown] [--env <value>] [--simplify]
548
530
 
549
531
  FLAGS
550
532
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -553,7 +535,6 @@ FLAGS
553
535
 
554
536
  OUTPUT FLAGS
555
537
  --csv Format output as csv
556
- --human Format output to be read on screen by a human [default]
557
538
  --json Format output as json
558
539
  --markdown Format output as markdown table
559
540
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -573,8 +554,8 @@ Archive all widgets in the campaign by adding suffix
573
554
 
574
555
  ```
575
556
  USAGE
576
- $ proca campaign widget archive [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
577
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
557
+ $ proca campaign widget archive [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
558
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
578
559
 
579
560
  FLAGS
580
561
  -i, --id=<value>
@@ -586,7 +567,6 @@ FLAGS
586
567
 
587
568
  OUTPUT FLAGS
588
569
  --csv Format output as csv
589
- --human Format output to be read on screen by a human [default]
590
570
  --json Format output as json
591
571
  --markdown Format output as markdown table
592
572
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -608,8 +588,8 @@ Copy widgets from one campaign to another
608
588
 
609
589
  ```
610
590
  USAGE
611
- $ proca campaign widget copy [ID_NAME_DXID] -t <campaign name> [--json | --human | --csv |
612
- --markdown] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
591
+ $ proca campaign widget copy [ID_NAME_DXID] -t <campaign name> [--json | --csv | --markdown]
592
+ [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
613
593
 
614
594
  FLAGS
615
595
  -i, --id=<value>
@@ -622,7 +602,6 @@ FLAGS
622
602
 
623
603
  OUTPUT FLAGS
624
604
  --csv Format output as csv
625
- --human Format output to be read on screen by a human [default]
626
605
  --json Format output as json
627
606
  --markdown Format output as markdown table
628
607
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -646,8 +625,8 @@ List widgets in a campaign
646
625
 
647
626
  ```
648
627
  USAGE
649
- $ proca campaign widget get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
650
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
628
+ $ proca campaign widget get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
629
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
651
630
 
652
631
  FLAGS
653
632
  -i, --id=<value>
@@ -657,7 +636,6 @@ FLAGS
657
636
 
658
637
  OUTPUT FLAGS
659
638
  --csv Format output as csv
660
- --human Format output to be read on screen by a human [default]
661
639
  --json Format output as json
662
640
  --markdown Format output as markdown table
663
641
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -672,8 +650,8 @@ DESCRIPTION
672
650
 
673
651
  ```
674
652
  USAGE
675
- $ proca campaign widget rebuild [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
676
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
653
+ $ proca campaign widget rebuild [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
654
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
677
655
 
678
656
  FLAGS
679
657
  -i, --id=<value>
@@ -683,7 +661,6 @@ FLAGS
683
661
 
684
662
  OUTPUT FLAGS
685
663
  --csv Format output as csv
686
- --human Format output to be read on screen by a human [default]
687
664
  --json Format output as json
688
665
  --markdown Format output as markdown table
689
666
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -695,19 +672,18 @@ EXAMPLES
695
672
  $ proca-cli campaign widget rebuild climate-action
696
673
  ```
697
674
 
698
- ## `proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
675
+ ## `proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
699
676
 
700
677
  create setting to access to a server
701
678
 
702
679
  ```
703
680
  USAGE
704
- $ proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
705
- | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
681
+ $ proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
682
+ --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
706
683
  you@example.org] [--folder /var/www/proca/config.example]
707
684
 
708
685
  ARGUMENTS
709
686
  ENV [default: default] allow to switch between configurations (server or users)
710
- HUMAN [default: true] Format output to be read on screen by a human [default]
711
687
  JSON Format output as json
712
688
  CSV Format output as csv
713
689
  MARKDOWN Format output as markdown table
@@ -722,7 +698,6 @@ FLAGS
722
698
 
723
699
  OUTPUT FLAGS
724
700
  --csv Format output as csv
725
- --human Format output to be read on screen by a human [default]
726
701
  --json Format output as json
727
702
  --markdown Format output as markdown table
728
703
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -744,15 +719,13 @@ Check and create config folders
744
719
 
745
720
  ```
746
721
  USAGE
747
- $ proca config folder [--json | --human | --csv | --markdown] [--env <value>]
748
- [--simplify]
722
+ $ proca config folder [--json | --csv | --markdown] [--env <value>] [--simplify]
749
723
 
750
724
  FLAGS
751
725
  --env=<value> [default: default] allow to switch between configurations (server or users)
752
726
 
753
727
  OUTPUT FLAGS
754
728
  --csv Format output as csv
755
- --human Format output to be read on screen by a human [default]
756
729
  --json Format output as json
757
730
  --markdown Format output as markdown table
758
731
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -763,19 +736,18 @@ DESCRIPTION
763
736
  Check if the PROCA_CONFIG_FOLDER is set up, if it is, check if the required subfolders exists and create if not
764
737
  ```
765
738
 
766
- ## `proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
739
+ ## `proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
767
740
 
768
741
  create setting to access to a server
769
742
 
770
743
  ```
771
744
  USAGE
772
- $ proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
773
- | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
745
+ $ proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
746
+ --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
774
747
  you@example.org] [--folder /var/www/proca/config.example]
775
748
 
776
749
  ARGUMENTS
777
750
  ENV [default: default] allow to switch between configurations (server or users)
778
- HUMAN [default: true] Format output to be read on screen by a human [default]
779
751
  JSON Format output as json
780
752
  CSV Format output as csv
781
753
  MARKDOWN Format output as markdown table
@@ -790,7 +762,6 @@ FLAGS
790
762
 
791
763
  OUTPUT FLAGS
792
764
  --csv Format output as csv
793
- --human Format output to be read on screen by a human [default]
794
765
  --json Format output as json
795
766
  --markdown Format output as markdown table
796
767
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -812,15 +783,13 @@ get the server config
812
783
 
813
784
  ```
814
785
  USAGE
815
- $ proca config server [--json | --human | --csv | --markdown] [--env <value>]
816
- [--simplify]
786
+ $ proca config server [--json | --csv | --markdown] [--env <value>] [--simplify]
817
787
 
818
788
  FLAGS
819
789
  --env=<value> [default: default] allow to switch between configurations (server or users)
820
790
 
821
791
  OUTPUT FLAGS
822
792
  --csv Format output as csv
823
- --human Format output to be read on screen by a human [default]
824
793
  --json Format output as json
825
794
  --markdown Format output as markdown table
826
795
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -835,8 +804,8 @@ update the setting used to authenticate to the servers and services
835
804
 
836
805
  ```
837
806
  USAGE
838
- $ proca config set [KEY] [VALUE] [--json | --human | --csv | --markdown] [--env
839
- <value>] [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
807
+ $ proca config set [KEY] [VALUE] [--json | --csv | --markdown] [--env <value>]
808
+ [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
840
809
 
841
810
  ARGUMENTS
842
811
  KEY variable name
@@ -850,7 +819,6 @@ FLAGS
850
819
 
851
820
  OUTPUT FLAGS
852
821
  --csv Format output as csv
853
- --human Format output to be read on screen by a human [default]
854
822
  --json Format output as json
855
823
  --markdown Format output as markdown table
856
824
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -867,19 +835,18 @@ EXAMPLES
867
835
  $ proca config set VAR1 VALUE
868
836
  ```
869
837
 
870
- ## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
838
+ ## `proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
871
839
 
872
840
  create setting to access to a server
873
841
 
874
842
  ```
875
843
  USAGE
876
- $ proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
877
- | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
844
+ $ proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
845
+ --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
878
846
  you@example.org] [--folder /var/www/proca/config.example]
879
847
 
880
848
  ARGUMENTS
881
849
  ENV [default: default] allow to switch between configurations (server or users)
882
- HUMAN [default: true] Format output to be read on screen by a human [default]
883
850
  JSON Format output as json
884
851
  CSV Format output as csv
885
852
  MARKDOWN Format output as markdown table
@@ -894,7 +861,6 @@ FLAGS
894
861
 
895
862
  OUTPUT FLAGS
896
863
  --csv Format output as csv
897
- --human Format output to be read on screen by a human [default]
898
864
  --json Format output as json
899
865
  --markdown Format output as markdown table
900
866
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -916,15 +882,13 @@ fetch the information about the current user (based on the token)
916
882
 
917
883
  ```
918
884
  USAGE
919
- $ proca config user [--json | --human | --csv | --markdown] [--env <value>]
920
- [--simplify]
885
+ $ proca config user [--json | --csv | --markdown] [--env <value>] [--simplify]
921
886
 
922
887
  FLAGS
923
888
  --env=<value> [default: default] allow to switch between configurations (server or users)
924
889
 
925
890
  OUTPUT FLAGS
926
891
  --csv Format output as csv
927
- --human Format output to be read on screen by a human [default]
928
892
  --json Format output as json
929
893
  --markdown Format output as markdown table
930
894
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -940,14 +904,42 @@ EXAMPLES
940
904
  $ proca config user
941
905
  ```
942
906
 
907
+ ## `proca contact area count`
908
+
909
+ counter of supporters by area (country), disabled for performance reasons
910
+
911
+ ```
912
+ USAGE
913
+ $ proca contact area count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
914
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
915
+
916
+ FLAGS
917
+ -i, --id=<value>
918
+ -n, --name=<the_short_name> name
919
+ -x, --dxid=<value> dxid
920
+ --env=<value> [default: default] allow to switch between configurations (server or users)
921
+
922
+ OUTPUT FLAGS
923
+ --csv Format output as csv
924
+ --json Format output as json
925
+ --markdown Format output as markdown table
926
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
927
+
928
+ DESCRIPTION
929
+ counter of supporters by area (country), disabled for performance reasons
930
+
931
+ EXAMPLES
932
+ $ proca contact area count --name <name of the campaign>
933
+ ```
934
+
943
935
  ## `proca contact count`
944
936
 
945
937
  counter of supporters
946
938
 
947
939
  ```
948
940
  USAGE
949
- $ proca contact count [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
950
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
941
+ $ proca contact count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
942
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
951
943
 
952
944
  FLAGS
953
945
  -i, --id=<value>
@@ -957,7 +949,6 @@ FLAGS
957
949
 
958
950
  OUTPUT FLAGS
959
951
  --csv Format output as csv
960
- --human Format output to be read on screen by a human [default]
961
952
  --json Format output as json
962
953
  --markdown Format output as markdown table
963
954
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -969,16 +960,13 @@ EXAMPLES
969
960
  $ proca contact count --name <name of the campaign>
970
961
  ```
971
962
 
972
- ## `proca contact list [TITLE]`
963
+ ## `proca contact list`
973
964
 
974
965
  ```
975
966
  USAGE
976
- $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv |
977
- --markdown] [--env <value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing]
978
- [--doi] [--utm | --simplify] [--comment | ]
979
-
980
- ARGUMENTS
981
- TITLE name of the campaign, % for wildchar
967
+ $ proca contact list -o <organisation name> [--json | --csv | --markdown] [--env
968
+ <value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm |
969
+ --simplify] [--comment | ]
982
970
 
983
971
  FLAGS
984
972
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
@@ -995,7 +983,6 @@ FLAGS
995
983
 
996
984
  OUTPUT FLAGS
997
985
  --csv Format output as csv
998
- --human Format output to be read on screen by a human [default]
999
986
  --json Format output as json
1000
987
  --markdown Format output as markdown table
1001
988
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1028,8 +1015,8 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.2
1028
1015
 
1029
1016
  ```
1030
1017
  USAGE
1031
- $ proca org add [--json | --human | --csv | --markdown] [--env <value>]
1032
- [--simplify] [--twitter <screen name>] [-n <org acronym/name>] [-t <org full name>]
1018
+ $ proca org add [--json | --csv | --markdown] [--env <value>] [--simplify]
1019
+ [--twitter <screen name>] [-n <org acronym/name>] [-t <org full name>]
1033
1020
 
1034
1021
  FLAGS
1035
1022
  -n, --name=<org acronym/name> short name of the org
@@ -1039,7 +1026,6 @@ FLAGS
1039
1026
 
1040
1027
  OUTPUT FLAGS
1041
1028
  --csv Format output as csv
1042
- --human Format output to be read on screen by a human [default]
1043
1029
  --json Format output as json
1044
1030
  --markdown Format output as markdown table
1045
1031
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1056,8 +1042,8 @@ view a org crm synchroniser
1056
1042
 
1057
1043
  ```
1058
1044
  USAGE
1059
- $ proca org crm -n <org name> [--json | --human | --csv | --markdown] [--env
1060
- <value>] [--simplify] [--synchronize]
1045
+ $ proca org crm -n <org name> [--json | --csv | --markdown] [--env <value>]
1046
+ [--simplify] [--synchronize]
1061
1047
 
1062
1048
  FLAGS
1063
1049
  -n, --name=<org name> (required) name of the org
@@ -1066,7 +1052,6 @@ FLAGS
1066
1052
 
1067
1053
  OUTPUT FLAGS
1068
1054
  --csv Format output as csv
1069
- --human Format output to be read on screen by a human [default]
1070
1055
  --json Format output as json
1071
1056
  --markdown Format output as markdown table
1072
1057
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1079,8 +1064,8 @@ DESCRIPTION
1079
1064
 
1080
1065
  ```
1081
1066
  USAGE
1082
- $ proca org delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1083
- <value>] [--simplify] [-i <value> | -n <org name> | -x <value>]
1067
+ $ proca org delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
1068
+ [--simplify] [-i <value> | -n <org name> | -x <value>]
1084
1069
 
1085
1070
  FLAGS
1086
1071
  -i, --id=<value>
@@ -1090,7 +1075,6 @@ FLAGS
1090
1075
 
1091
1076
  OUTPUT FLAGS
1092
1077
  --csv Format output as csv
1093
- --human Format output to be read on screen by a human [default]
1094
1078
  --json Format output as json
1095
1079
  --markdown Format output as markdown table
1096
1080
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1105,10 +1089,9 @@ Set email service and supporter confirmation for an org
1105
1089
 
1106
1090
  ```
1107
1091
  USAGE
1108
- $ proca org email [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1109
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--mailer mailjet ses stripe test_stripe
1110
- system preview webhook supabase smtp] [--from default <org>@proca.app] [--supporter-confirm]
1111
- [--supporter-confirm-template <value>]
1092
+ $ proca org email [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
1093
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--mailer mailjet ses stripe test_stripe system preview
1094
+ webhook supabase smtp] [--from default <org>@proca.app] [--supporter-confirm] [--supporter-confirm-template <value>]
1112
1095
 
1113
1096
  FLAGS
1114
1097
  -i, --id=<value>
@@ -1126,7 +1109,6 @@ FLAGS
1126
1109
 
1127
1110
  OUTPUT FLAGS
1128
1111
  --csv Format output as csv
1129
- --human Format output to be read on screen by a human [default]
1130
1112
  --json Format output as json
1131
1113
  --markdown Format output as markdown table
1132
1114
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1141,8 +1123,8 @@ view a org
1141
1123
 
1142
1124
  ```
1143
1125
  USAGE
1144
- $ proca org get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1145
- <value>] [--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
1126
+ $ proca org get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
1127
+ [--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
1146
1128
 
1147
1129
  FLAGS
1148
1130
  -n, --name=<org name> name of the org
@@ -1156,7 +1138,6 @@ FLAGS
1156
1138
 
1157
1139
  OUTPUT FLAGS
1158
1140
  --csv Format output as csv
1159
- --human Format output to be read on screen by a human [default]
1160
1141
  --json Format output as json
1161
1142
  --markdown Format output as markdown table
1162
1143
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1174,7 +1155,7 @@ list all the users
1174
1155
 
1175
1156
  ```
1176
1157
  USAGE
1177
- $ proca org user get -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1158
+ $ proca org user get -o <value> [--json | --csv | --markdown] [--env <value>]
1178
1159
  [--simplify]
1179
1160
 
1180
1161
  FLAGS
@@ -1183,7 +1164,6 @@ FLAGS
1183
1164
 
1184
1165
  OUTPUT FLAGS
1185
1166
  --csv Format output as csv
1186
- --human Format output to be read on screen by a human [default]
1187
1167
  --json Format output as json
1188
1168
  --markdown Format output as markdown table
1189
1169
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1495,7 +1475,7 @@ Set service, usually email backend for an org, the specific meaning of each para
1495
1475
  ```
1496
1476
  USAGE
1497
1477
  $ proca service add -o <value> --type
1498
- mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --human | --csv | --markdown] [--env <value>]
1478
+ mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --csv | --markdown] [--env <value>]
1499
1479
  [--simplify] [--user <value>] [--password <value>] [--host <value>] [--path <value>]
1500
1480
 
1501
1481
  FLAGS
@@ -1510,7 +1490,6 @@ FLAGS
1510
1490
 
1511
1491
  OUTPUT FLAGS
1512
1492
  --csv Format output as csv
1513
- --human Format output to be read on screen by a human [default]
1514
1493
  --json Format output as json
1515
1494
  --markdown Format output as markdown table
1516
1495
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1525,7 +1504,7 @@ list services set for an organisation
1525
1504
 
1526
1505
  ```
1527
1506
  USAGE
1528
- $ proca service list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1507
+ $ proca service list -o <value> [--json | --csv | --markdown] [--env <value>]
1529
1508
  [--simplify]
1530
1509
 
1531
1510
  FLAGS
@@ -1534,7 +1513,6 @@ FLAGS
1534
1513
 
1535
1514
  OUTPUT FLAGS
1536
1515
  --csv Format output as csv
1537
- --human Format output to be read on screen by a human [default]
1538
1516
  --json Format output as json
1539
1517
  --markdown Format output as markdown table
1540
1518
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1547,8 +1525,8 @@ DESCRIPTION
1547
1525
 
1548
1526
  ```
1549
1527
  USAGE
1550
- $ proca target add -c <value> --name <value> --email <value> [--json | --human |
1551
- --csv | --markdown] [--env <value>] [--simplify] [--external_id <value>]
1528
+ $ proca target add -c <value> --name <value> --email <value> [--json | --csv |
1529
+ --markdown] [--env <value>] [--simplify] [--external_id <value>]
1552
1530
 
1553
1531
  FLAGS
1554
1532
  -c, --campaign=<value> (required) mtt campaign to add the target
@@ -1559,7 +1537,6 @@ FLAGS
1559
1537
 
1560
1538
  OUTPUT FLAGS
1561
1539
  --csv Format output as csv
1562
- --human Format output to be read on screen by a human [default]
1563
1540
  --json Format output as json
1564
1541
  --markdown Format output as markdown table
1565
1542
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1569,7 +1546,7 @@ OUTPUT FLAGS
1569
1546
 
1570
1547
  ```
1571
1548
  USAGE
1572
- $ proca template add -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1549
+ $ proca template add -o <value> [--json | --csv | --markdown] [--env <value>]
1573
1550
  [--simplify] [--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s
1574
1551
  'template:' + type]
1575
1552
 
@@ -1584,7 +1561,6 @@ FLAGS
1584
1561
 
1585
1562
  OUTPUT FLAGS
1586
1563
  --csv Format output as csv
1587
- --human Format output to be read on screen by a human [default]
1588
1564
  --json Format output as json
1589
1565
  --markdown Format output as markdown table
1590
1566
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1596,7 +1572,7 @@ list services set for an organisation
1596
1572
 
1597
1573
  ```
1598
1574
  USAGE
1599
- $ proca template list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1575
+ $ proca template list -o <value> [--json | --csv | --markdown] [--env <value>]
1600
1576
  [--simplify]
1601
1577
 
1602
1578
  FLAGS
@@ -1605,7 +1581,6 @@ FLAGS
1605
1581
 
1606
1582
  OUTPUT FLAGS
1607
1583
  --csv Format output as csv
1608
- --human Format output to be read on screen by a human [default]
1609
1584
  --json Format output as json
1610
1585
  --markdown Format output as markdown table
1611
1586
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1620,8 +1595,8 @@ fetch the information about a user
1620
1595
 
1621
1596
  ```
1622
1597
  USAGE
1623
- $ proca user get [--json | --human | --csv | --markdown] [--env <value>]
1624
- [--simplify] [--email <value>] [-o <org name>] [-i <value>]
1598
+ $ proca user get [--json | --csv | --markdown] [--env <value>] [--simplify]
1599
+ [--email <value>] [-o <org name>] [-i <value>]
1625
1600
 
1626
1601
  FLAGS
1627
1602
  -i, --id=<value> id of the user
@@ -1631,7 +1606,6 @@ FLAGS
1631
1606
 
1632
1607
  OUTPUT FLAGS
1633
1608
  --csv Format output as csv
1634
- --human Format output to be read on screen by a human [default]
1635
1609
  --json Format output as json
1636
1610
  --markdown Format output as markdown table
1637
1611
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1649,8 +1623,8 @@ invite a user to join an organisation with a role
1649
1623
 
1650
1624
  ```
1651
1625
  USAGE
1652
- $ proca user invite -o <org name> -u <user email> [--json | --human | --csv |
1653
- --markdown] [--env <value>] [--simplify] [--role owner|campaigner|coordinator|translator]
1626
+ $ proca user invite -o <org name> -u <user email> [--json | --csv | --markdown] [--env
1627
+ <value>] [--simplify] [--role owner|campaigner|coordinator|translator]
1654
1628
 
1655
1629
  FLAGS
1656
1630
  -o, --org=<org name> (required) name of the org
@@ -1661,7 +1635,6 @@ FLAGS
1661
1635
 
1662
1636
  OUTPUT FLAGS
1663
1637
  --csv Format output as csv
1664
- --human Format output to be read on screen by a human [default]
1665
1638
  --json Format output as json
1666
1639
  --markdown Format output as markdown table
1667
1640
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1679,8 +1652,8 @@ let a user join an organisation with a role
1679
1652
 
1680
1653
  ```
1681
1654
  USAGE
1682
- $ proca user join -o <org name> [--json | --human | --csv | --markdown] [--env
1683
- <value>] [--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
1655
+ $ proca user join -o <org name> [--json | --csv | --markdown] [--env <value>]
1656
+ [--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
1684
1657
 
1685
1658
  FLAGS
1686
1659
  -o, --org=<org name> (required) name of the org
@@ -1691,7 +1664,6 @@ FLAGS
1691
1664
 
1692
1665
  OUTPUT FLAGS
1693
1666
  --csv Format output as csv
1694
- --human Format output to be read on screen by a human [default]
1695
1667
  --json Format output as json
1696
1668
  --markdown Format output as markdown table
1697
1669
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1709,8 +1681,8 @@ leave a org
1709
1681
 
1710
1682
  ```
1711
1683
  USAGE
1712
- $ proca user leave -o <org name> [--json | --human | --csv | --markdown] [--env
1713
- <value>] [--simplify] [-u <user email>]
1684
+ $ proca user leave -o <org name> [--json | --csv | --markdown] [--env <value>]
1685
+ [--simplify] [-u <user email>]
1714
1686
 
1715
1687
  FLAGS
1716
1688
  -o, --org=<org name> (required) name of the org
@@ -1719,7 +1691,6 @@ FLAGS
1719
1691
 
1720
1692
  OUTPUT FLAGS
1721
1693
  --csv Format output as csv
1722
- --human Format output to be read on screen by a human [default]
1723
1694
  --json Format output as json
1724
1695
  --markdown Format output as markdown table
1725
1696
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1737,7 +1708,7 @@ list all the users
1737
1708
 
1738
1709
  ```
1739
1710
  USAGE
1740
- $ proca user list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1711
+ $ proca user list -o <value> [--json | --csv | --markdown] [--env <value>]
1741
1712
  [--simplify]
1742
1713
 
1743
1714
  FLAGS
@@ -1746,7 +1717,6 @@ FLAGS
1746
1717
 
1747
1718
  OUTPUT FLAGS
1748
1719
  --csv Format output as csv
1749
- --human Format output to be read on screen by a human [default]
1750
1720
  --json Format output as json
1751
1721
  --markdown Format output as markdown table
1752
1722
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1767,15 +1737,13 @@ fetch the information about the current user (based on the token)
1767
1737
 
1768
1738
  ```
1769
1739
  USAGE
1770
- $ proca user me [--json | --human | --csv | --markdown] [--env <value>]
1771
- [--simplify]
1740
+ $ proca user me [--json | --csv | --markdown] [--env <value>] [--simplify]
1772
1741
 
1773
1742
  FLAGS
1774
1743
  --env=<value> [default: default] allow to switch between configurations (server or users)
1775
1744
 
1776
1745
  OUTPUT FLAGS
1777
1746
  --csv Format output as csv
1778
- --human Format output to be read on screen by a human [default]
1779
1747
  --json Format output as json
1780
1748
  --markdown Format output as markdown table
1781
1749
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1797,8 +1765,8 @@ Reset user API token
1797
1765
 
1798
1766
  ```
1799
1767
  USAGE
1800
- $ proca user reset [USER] [--json | --human | --csv | --markdown] [--env <value>]
1801
- [--simplify] [--password <value>] [--url <value>]
1768
+ $ proca user reset [USER] [--json | --csv | --markdown] [--env <value>] [--simplify]
1769
+ [--password <value>] [--url <value>]
1802
1770
 
1803
1771
  ARGUMENTS
1804
1772
  USER Username (email)
@@ -1810,7 +1778,6 @@ FLAGS
1810
1778
 
1811
1779
  OUTPUT FLAGS
1812
1780
  --csv Format output as csv
1813
- --human Format output to be read on screen by a human [default]
1814
1781
  --json Format output as json
1815
1782
  --markdown Format output as markdown table
1816
1783
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1825,15 +1792,13 @@ fetch the information about the current user (based on the token)
1825
1792
 
1826
1793
  ```
1827
1794
  USAGE
1828
- $ proca user whoami [--json | --human | --csv | --markdown] [--env <value>]
1829
- [--simplify]
1795
+ $ proca user whoami [--json | --csv | --markdown] [--env <value>] [--simplify]
1830
1796
 
1831
1797
  FLAGS
1832
1798
  --env=<value> [default: default] allow to switch between configurations (server or users)
1833
1799
 
1834
1800
  OUTPUT FLAGS
1835
1801
  --csv Format output as csv
1836
- --human Format output to be read on screen by a human [default]
1837
1802
  --json Format output as json
1838
1803
  --markdown Format output as markdown table
1839
1804
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1853,8 +1818,8 @@ EXAMPLES
1853
1818
 
1854
1819
  ```
1855
1820
  USAGE
1856
- $ proca widget add -c <campaign name> [--json | --human | --csv | --markdown] [--env
1857
- <value>] [--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
1821
+ $ proca widget add -c <campaign name> [--json | --csv | --markdown] [--env <value>]
1822
+ [--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
1858
1823
 
1859
1824
  FLAGS
1860
1825
  -c, --campaign=<campaign name> (required) name of the campaign
@@ -1866,7 +1831,6 @@ FLAGS
1866
1831
 
1867
1832
  OUTPUT FLAGS
1868
1833
  --csv Format output as csv
1869
- --human Format output to be read on screen by a human [default]
1870
1834
  --json Format output as json
1871
1835
  --markdown Format output as markdown table
1872
1836
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1878,8 +1842,8 @@ Delete a widget
1878
1842
 
1879
1843
  ```
1880
1844
  USAGE
1881
- $ proca widget delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1882
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1845
+ $ proca widget delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
1846
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1883
1847
 
1884
1848
  FLAGS
1885
1849
  -i, --id=<value>
@@ -1889,7 +1853,6 @@ FLAGS
1889
1853
 
1890
1854
  OUTPUT FLAGS
1891
1855
  --csv Format output as csv
1892
- --human Format output to be read on screen by a human [default]
1893
1856
  --json Format output as json
1894
1857
  --markdown Format output as markdown table
1895
1858
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1904,8 +1867,8 @@ view a widget
1904
1867
 
1905
1868
  ```
1906
1869
  USAGE
1907
- $ proca widget get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1908
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
1870
+ $ proca widget get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
1871
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
1909
1872
 
1910
1873
  FLAGS
1911
1874
  -i, --id=<value>
@@ -1916,7 +1879,6 @@ FLAGS
1916
1879
 
1917
1880
  OUTPUT FLAGS
1918
1881
  --csv Format output as csv
1919
- --human Format output to be read on screen by a human [default]
1920
1882
  --json Format output as json
1921
1883
  --markdown Format output as markdown table
1922
1884
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1931,8 +1893,8 @@ list all the widgets of an org or campaign
1931
1893
 
1932
1894
  ```
1933
1895
  USAGE
1934
- $ proca widget list [--json | --human | --csv | --markdown] [--env <value>]
1935
- [--simplify] [-o <organisation name>] [-c <campaign name>] [--config]
1896
+ $ proca widget list [--json | --csv | --markdown] [--env <value>] [--simplify] [-o
1897
+ <organisation name>] [-c <campaign name>] [--config]
1936
1898
 
1937
1899
  FLAGS
1938
1900
  -c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
@@ -1942,7 +1904,6 @@ FLAGS
1942
1904
 
1943
1905
  OUTPUT FLAGS
1944
1906
  --csv Format output as csv
1945
- --human Format output to be read on screen by a human [default]
1946
1907
  --json Format output as json
1947
1908
  --markdown Format output as markdown table
1948
1909
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1960,8 +1921,8 @@ EXAMPLES
1960
1921
 
1961
1922
  ```
1962
1923
  USAGE
1963
- $ proca widget rebuild [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1964
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1924
+ $ proca widget rebuild [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
1925
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1965
1926
 
1966
1927
  FLAGS
1967
1928
  -i, --id=<value>
@@ -1971,7 +1932,6 @@ FLAGS
1971
1932
 
1972
1933
  OUTPUT FLAGS
1973
1934
  --csv Format output as csv
1974
- --human Format output to be read on screen by a human [default]
1975
1935
  --json Format output as json
1976
1936
  --markdown Format output as markdown table
1977
1937
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -1995,15 +1955,14 @@ Update a widget's properties
1995
1955
 
1996
1956
  ```
1997
1957
  USAGE
1998
- $ proca widget update [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1999
- <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-n <widget name>] [-l <locale>] [--color <hex
2000
- code>] [--confirm-optin] [--confirm-action] [--dry-run]
1958
+ $ proca widget update [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
1959
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-l <locale>] [--color <hex code>] [--confirm-optin]
1960
+ [--confirm-action] [--dry-run]
2001
1961
 
2002
1962
  FLAGS
2003
1963
  -i, --id=<value>
2004
1964
  -l, --locale=<locale> change the locale
2005
1965
  -n, --name=<the_short_name> name
2006
- -n, --rename=<widget name> new name for the widget
2007
1966
  -x, --dxid=<value> dxid
2008
1967
  --color=<hex code> update color (not yet implemented)
2009
1968
  --confirm-action add actionConfirm (check email snack) to consent.email component
@@ -2013,7 +1972,6 @@ FLAGS
2013
1972
 
2014
1973
  OUTPUT FLAGS
2015
1974
  --csv Format output as csv
2016
- --human Format output to be read on screen by a human [default]
2017
1975
  --json Format output as json
2018
1976
  --markdown Format output as markdown table
2019
1977
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
@@ -2022,12 +1980,70 @@ DESCRIPTION
2022
1980
  Update a widget's properties
2023
1981
 
2024
1982
  EXAMPLES
2025
- $ proca widget update 4454 --name new_widget_name
1983
+ $ proca widget update -i 42 --rename campaign/new_name
1984
+
1985
+ $ proca widget update -name campaign/widget --locale fr
1986
+
1987
+ $ proca widget update 42 --confirm-optin
1988
+
1989
+ $ proca widget update --dxid=pnc -confirm-optin --dry-run
1990
+ ```
1991
+
1992
+ ## `proca widget update external`
1993
+
1994
+ Update the global counter to add the actions collected elsewhere
1995
+
1996
+ ```
1997
+ USAGE
1998
+ $ proca widget update external [ID_NAME_DXID] -t <value> [--json | --csv | --markdown] [--env
1999
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
2026
2000
 
2027
- $ proca widget update 4454 --locale fr
2001
+ FLAGS
2002
+ -i, --id=<value>
2003
+ -n, --name=<the_short_name> name
2004
+ -t, --total=<value> (required) new total to include
2005
+ -x, --dxid=<value> dxid
2006
+ --env=<value> [default: default] allow to switch between configurations (server or users)
2007
+
2008
+ OUTPUT FLAGS
2009
+ --csv Format output as csv
2010
+ --json Format output as json
2011
+ --markdown Format output as markdown table
2012
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
2028
2013
 
2029
- $ proca widget update 4454 --confirm-optin
2014
+ DESCRIPTION
2015
+ Update the global counter to add the actions collected elsewhere
2030
2016
 
2031
- $ proca widget update 4454 --confirm-optin --dry-run
2017
+ EXAMPLES
2018
+ see also proca contact count
2019
+ ```
2020
+
2021
+ ## `proca widget update name`
2022
+
2023
+ Update the name of a widget
2024
+
2025
+ ```
2026
+ USAGE
2027
+ $ proca widget update name [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
2028
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--rename <widget name>]
2029
+
2030
+ FLAGS
2031
+ -i, --id=<value>
2032
+ -n, --name=<the_short_name> name
2033
+ -x, --dxid=<value> dxid
2034
+ --env=<value> [default: default] allow to switch between configurations (server or users)
2035
+ --rename=<widget name> new name for the widget
2036
+
2037
+ OUTPUT FLAGS
2038
+ --csv Format output as csv
2039
+ --json Format output as json
2040
+ --markdown Format output as markdown table
2041
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
2042
+
2043
+ DESCRIPTION
2044
+ Update the name of a widget
2045
+
2046
+ EXAMPLES
2047
+ see also proca widget update name --name=campaign/old_name --rename=campaign/new_name
2032
2048
  ```
2033
2049
  <!-- commandsstop -->