proca 1.7.5 → 1.7.7

package/README.md

@@ -76,14 +76,13 @@ you should also use the local proca-api in your [widget generator](https://githu
 * [`proca org email`](#proca-org-email)
 * [`proca org get`](#proca-org-get)
 * [`proca plugins`](#proca-plugins)
-* [`proca plugins add PLUGIN`](#proca-plugins-add-plugin)
+* [`proca plugins:install PLUGIN...`](#proca-pluginsinstall-plugin)
 * [`proca plugins:inspect PLUGIN...`](#proca-pluginsinspect-plugin)
-* [`proca plugins install PLUGIN`](#proca-plugins-install-plugin)
-* [`proca plugins link PATH`](#proca-plugins-link-path)
-* [`proca plugins remove [PLUGIN]`](#proca-plugins-remove-plugin)
-* [`proca plugins reset`](#proca-plugins-reset)
-* [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
-* [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
+* [`proca plugins:install PLUGIN...`](#proca-pluginsinstall-plugin)
+* [`proca plugins:link PLUGIN`](#proca-pluginslink-plugin)
+* [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
+* [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
+* [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
 * [`proca plugins update`](#proca-plugins-update)
 * [`proca service add`](#proca-service-add)
 * [`proca service list`](#proca-service-list)
@@ -107,10 +106,10 @@ you should also use the local proca-api in your [widget generator](https://githu
 
 ```
 USAGE
-  $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
-    [--json | --human | --csv] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
-    [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
-    <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
+  $ proca action add -i <value> --firstname <value> --email <value> [--json | --human |
+    --csv] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin] [--action_type <value>]
+    [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country <value>] [--utm <value>]
+    [--target <value>] [--subject <value>] [--body <value>]
 
 FLAGS
   -i, --id=<value>             (required) widget's id
@@ -180,8 +179,8 @@ counter of actions
 
 ```
 USAGE
-  $ proca action count [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
-    [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
+  $ proca action count [--json | --human | --csv] [--env <value>] [--simplify] [-i
+    <value> | -n <the_short_name> | -x <value>]
 
 FLAGS
   -i, --id=<value>
@@ -213,7 +212,7 @@ USAGE
     | --simplify] [--comment | ]
 
 ARGUMENTS
-  TITLE  name of the campaign, % for wildchar
+  [TITLE]  name of the campaign, % for wildchar
 
 FLAGS
   -c, --campaign=<campaign name>  name of the campaign, % for wildchar
@@ -306,7 +305,7 @@ USAGE
     --csv] [--env <value>] [--simplify]
 
 ARGUMENTS
-  TITLE  title of the campaign
+  [TITLE]  title of the campaign
 
 FLAGS
   -n, --name=<campaign name>  (required) name of the campaign
@@ -327,12 +326,12 @@ EXAMPLES
 
 ```
 USAGE
-  $ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
-    --human | --csv] [--env <value>] [--simplify]
+  $ proca campaign close --status draft|live|closed|ignored [--json | --human | --csv]
+    [--env <value>] [--simplify]
 
 FLAGS
   --env=<value>      [default: default] allow to switch between configurations (server or users)
-  --status=<option>  (required) Status to set
+  --status=<option>  (required) [env: [object Object]] Status to set
                      <options: draft|live|closed|ignored>
 
 OUTPUT FLAGS
@@ -383,8 +382,8 @@ view a campaign
 
 ```
 USAGE
-  $ proca campaign get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
-    [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
+  $ proca campaign get [--json | --human | --csv] [--env <value>] [--simplify] [-i
+    <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
 
 FLAGS
   -i, --id=<value>
@@ -418,7 +417,7 @@ USAGE
     [-o <organisation name>] [-t <campaign title>] [--stats]
 
 ARGUMENTS
-  TITLE  name of the campaign, % for wildchar
+  [TITLE]  name of the campaign, % for wildchar
 
 FLAGS
   -o, --org=<organisation name>  campaigns of the organisation (coordinator or partner)
@@ -445,15 +444,16 @@ set the mail to target (mtt) params
 
 ```
 USAGE
-  $ proca campaign mtt [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
-    [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template <value>]
-    [--period <value>] [--email <value>] [--cc <value>] [--sender]
+  $ proca campaign mtt [--json | --human | --csv] [--env <value>] [--simplify] [-i
+    <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template <value>] [--period <value>]
+    [--email <value>] [--cc <value>] [--sender] [--drip]
 
 FLAGS
   -i, --id=<value>
   -n, --name=<the_short_name>  name
   -x, --dxid=<value>           dxid
       --cc=<value>             comma-separated list of CC email addresses
+      --drip                   drip delivery or deliver as fast as possible
       --email=<value>          test email address
       --env=<value>            [default: default] allow to switch between configurations (server or users)
       --from=<value>           start date (yyyy-mm-dd)
@@ -479,12 +479,12 @@ EXAMPLES
 
 ```
 USAGE
-  $ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
-    --human | --csv] [--env <value>] [--simplify]
+  $ proca campaign status --status draft|live|closed|ignored [--json | --human | --csv]
+    [--env <value>] [--simplify]
 
 FLAGS
   --env=<value>      [default: default] allow to switch between configurations (server or users)
-  --status=<option>  (required) Status to set
+  --status=<option>  (required) [env: [object Object]] Status to set
                      <options: draft|live|closed|ignored>
 
 OUTPUT FLAGS
@@ -513,11 +513,11 @@ USAGE
     /var/www/proca/config.example]
 
 ARGUMENTS
-  ENV       [default: default] allow to switch between configurations (server or users)
-  HUMAN     [default: true] Format output to be read on screen by a human [default]
-  JSON      Format output as json
-  CSV       Format output as csv
-  SIMPLIFY  flatten and filter to output only the most important attributes, mostly relevant for json
+  [ENV]       [default: default] allow to switch between configurations (server or users)
+  [HUMAN]     [default: true] Format output to be read on screen by a human [default]
+  [JSON]      Format output as json
+  [CSV]       Format output as csv
+  [SIMPLIFY]  flatten and filter to output only the most important attributes, mostly relevant for json
 
 FLAGS
   --email=you@example.org                 user email on proca server
@@ -577,11 +577,11 @@ USAGE
     /var/www/proca/config.example]
 
 ARGUMENTS
-  ENV       [default: default] allow to switch between configurations (server or users)
-  HUMAN     [default: true] Format output to be read on screen by a human [default]
-  JSON      Format output as json
-  CSV       Format output as csv
-  SIMPLIFY  flatten and filter to output only the most important attributes, mostly relevant for json
+  [ENV]       [default: default] allow to switch between configurations (server or users)
+  [HUMAN]     [default: true] Format output to be read on screen by a human [default]
+  [JSON]      Format output as json
+  [CSV]       Format output as csv
+  [SIMPLIFY]  flatten and filter to output only the most important attributes, mostly relevant for json
 
 FLAGS
   --email=you@example.org                 user email on proca server
@@ -638,8 +638,8 @@ USAGE
     [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
 
 ARGUMENTS
-  KEY    variable name
-  VALUE  value
+  [KEY]    variable name
+  [VALUE]  value
 
 FLAGS
   --env=<value>          [default: default] allow to switch between configurations (server or users)
@@ -676,11 +676,11 @@ USAGE
     /var/www/proca/config.example]
 
 ARGUMENTS
-  ENV       [default: default] allow to switch between configurations (server or users)
-  HUMAN     [default: true] Format output to be read on screen by a human [default]
-  JSON      Format output as json
-  CSV       Format output as csv
-  SIMPLIFY  flatten and filter to output only the most important attributes, mostly relevant for json
+  [ENV]       [default: default] allow to switch between configurations (server or users)
+  [HUMAN]     [default: true] Format output to be read on screen by a human [default]
+  [JSON]      Format output as json
+  [CSV]       Format output as csv
+  [SIMPLIFY]  flatten and filter to output only the most important attributes, mostly relevant for json
 
 FLAGS
   --email=you@example.org                 user email on proca server
@@ -740,8 +740,8 @@ counter of supporters
 
 ```
 USAGE
-  $ proca contact count [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
-    [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
+  $ proca contact count [--json | --human | --csv] [--env <value>] [--simplify] [-i
+    <value> | -n <the_short_name> | -x <value>]
 
 FLAGS
   -i, --id=<value>
@@ -773,7 +773,7 @@ USAGE
     --simplify] [--comment | ]
 
 ARGUMENTS
-  TITLE  name of the campaign, % for wildchar
+  [TITLE]  name of the campaign, % for wildchar
 
 FLAGS
   -c, --campaign=<campaign title>  name of the campaign, % for wildchar
@@ -807,7 +807,7 @@ USAGE
   $ proca help [COMMAND...] [-n]
 
 ARGUMENTS
-  COMMAND...  Command to show help for.
+  [COMMAND...]  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -871,8 +871,8 @@ DESCRIPTION
 
 ```
 USAGE
-  $ proca org delete [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
-    [--simplify] [-i <value> | -n <org name> | -x <value>]
+  $ proca org delete [--json | --human | --csv] [--env <value>] [--simplify] [-i
+    <value> | -n <org name> | -x <value>]
 
 FLAGS
   -i, --id=<value>
@@ -896,9 +896,8 @@ Set service, usually email backend for an org
 
 ```
 USAGE
-  $ proca org email [ID_NAME_DXID] --org <value> --mailer mailjet ses stripe
-    test_stripe system preview webhook supabase smtp [--json | --human | --csv] [--env <value>] [--simplify] [--from
-    <value>]
+  $ proca org email --org <value> --mailer mailjet ses stripe test_stripe system
+    preview webhook supabase smtp [--json | --human | --csv] [--env <value>] [--simplify] [--from <value>]
 
 FLAGS
   --env=<value>                                                                 [default: default] allow to switch
@@ -926,15 +925,17 @@ view a org
 
 ```
 USAGE
-  $ proca org get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
-    [--simplify] [-n <org name>] [--config] [--keys] [--campaigns] [--users]
+  $ proca org get [--json | --human | --csv] [--env <value>] [--simplify] [-n <org
+    name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
 
 FLAGS
-  -n, --name=<org name>  name of the org
+  -n, --name=<org name>    name of the org
   --[no-]campaigns
-      --[no-]config      display the config
-      --env=<value>      [default: default] allow to switch between configurations (server or users)
+      --[no-]config        display the config
+      --env=<value>        [default: default] allow to switch between configurations (server or users)
   --[no-]keys
+      --[no-]personaldata  how are the personal data of the supporter processed
+      --[no-]processing    additional processing workflows on the actions
   --[no-]users
 
 OUTPUT FLAGS
@@ -971,53 +972,44 @@ EXAMPLES
   $ proca plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/index.ts)_
 
-## `proca plugins add PLUGIN`
+## `proca plugins:install PLUGIN...`
 
-Installs a plugin into proca.
+Installs a plugin into the CLI.
 
 ```
 USAGE
-  $ proca plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+  $ proca plugins add plugins:install PLUGIN...
 
 ARGUMENTS
   PLUGIN...  Plugin to install.
 
 FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -f, --force    Run yarn install with force flag.
   -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
+  -v, --verbose
 
 DESCRIPTION
-  Installs a plugin into proca.
-
-  Uses npm to install plugins.
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
 
   Installation of a user-installed plugin will override a core plugin.
 
-  Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
 
 ALIASES
   $ proca plugins add
 
 EXAMPLES
-  Install a plugin from npm registry.
-
-    $ proca plugins add myplugin
+  $ proca plugins:install myplugin 
 
-  Install a plugin from a github url.
+  $ proca plugins:install https://github.com/someuser/someplugin
 
-    $ proca plugins add https://github.com/someuser/someplugin
-
-  Install a plugin from a github slug.
-
-    $ proca plugins add someuser/someplugin
+  $ proca plugins:install someuser/someplugin
 ```
 
 ## `proca plugins:inspect PLUGIN...`
@@ -1042,79 +1034,68 @@ DESCRIPTION
   Displays installation properties of a plugin.
 
 EXAMPLES
-  $ proca plugins inspect myplugin
+  $ proca plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/inspect.ts)_
 
-## `proca plugins install PLUGIN`
+## `proca plugins:install PLUGIN...`
 
-Installs a plugin into proca.
+Installs a plugin into the CLI.
 
 ```
 USAGE
-  $ proca plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+  $ proca plugins install PLUGIN...
 
 ARGUMENTS
   PLUGIN...  Plugin to install.
 
 FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -f, --force    Run yarn install with force flag.
   -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
+  -v, --verbose
 
 DESCRIPTION
-  Installs a plugin into proca.
-
-  Uses npm to install plugins.
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
 
   Installation of a user-installed plugin will override a core plugin.
 
-  Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
 
 ALIASES
   $ proca plugins add
 
 EXAMPLES
-  Install a plugin from npm registry.
-
-    $ proca plugins install myplugin
+  $ proca plugins:install myplugin 
 
-  Install a plugin from a github url.
+  $ proca plugins:install https://github.com/someuser/someplugin
 
-    $ proca plugins install https://github.com/someuser/someplugin
-
-  Install a plugin from a github slug.
-
-    $ proca plugins install someuser/someplugin
+  $ proca plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/install.ts)_
 
-## `proca plugins link PATH`
+## `proca plugins:link PLUGIN`
 
 Links a plugin into the CLI for development.
 
 ```
 USAGE
-  $ proca plugins link PATH [-h] [--install] [-v]
+  $ proca plugins link PLUGIN
 
 ARGUMENTS
   PATH  [default: .] path to plugin
 
 FLAGS
-  -h, --help          Show CLI help.
+  -h, --help     Show CLI help.
   -v, --verbose
-      --[no-]install  Install dependencies after linking the plugin.
 
 DESCRIPTION
   Links a plugin into the CLI for development.
-
   Installation of a linked plugin will override a user-installed or core plugin.
 
   e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
@@ -1122,21 +1103,21 @@ DESCRIPTION
 
 
 EXAMPLES
-  $ proca plugins link myplugin
+  $ proca plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/link.ts)_
 
-## `proca plugins remove [PLUGIN]`
+## `proca plugins:uninstall PLUGIN...`
 
 Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ proca plugins remove [PLUGIN...] [-h] [-v]
+  $ proca plugins remove plugins:uninstall PLUGIN...
 
 ARGUMENTS
-  PLUGIN...  plugin to uninstall
+  [PLUGIN]  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.
@@ -1148,36 +1129,18 @@ DESCRIPTION
 ALIASES
   $ proca plugins unlink
   $ proca plugins remove
-
-EXAMPLES
-  $ proca plugins remove myplugin
 ```
 
-## `proca plugins reset`
-
-Remove all user-installed and linked plugins.
-
-```
-USAGE
-  $ proca plugins reset [--hard] [--reinstall]
-
-FLAGS
-  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
-  --reinstall  Reinstall all plugins after uninstalling.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/reset.ts)_
-
-## `proca plugins uninstall [PLUGIN]`
+## `proca plugins:uninstall PLUGIN...`
 
 Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ proca plugins uninstall [PLUGIN...] [-h] [-v]
+  $ proca plugins uninstall PLUGIN...
 
 ARGUMENTS
-  PLUGIN...  plugin to uninstall
+  [PLUGIN]  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.
@@ -1189,23 +1152,20 @@ DESCRIPTION
 ALIASES
   $ proca plugins unlink
   $ proca plugins remove
-
-EXAMPLES
-  $ proca plugins uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/uninstall.ts)_
 
-## `proca plugins unlink [PLUGIN]`
+## `proca plugins:uninstall PLUGIN...`
 
 Removes a plugin from the CLI.
 
 ```
 USAGE
-  $ proca plugins unlink [PLUGIN...] [-h] [-v]
+  $ proca plugins unlink plugins:uninstall PLUGIN...
 
 ARGUMENTS
-  PLUGIN...  plugin to uninstall
+  [PLUGIN]  plugin to uninstall
 
 FLAGS
   -h, --help     Show CLI help.
@@ -1217,9 +1177,6 @@ DESCRIPTION
 ALIASES
   $ proca plugins unlink
   $ proca plugins remove
-
-EXAMPLES
-  $ proca plugins unlink myplugin
 ```
 
 ## `proca plugins update`
@@ -1238,7 +1195,7 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/update.ts)_
 
 ## `proca service add`
 
@@ -1538,7 +1495,7 @@ USAGE
     [--password <value>] [--url <value>]
 
 ARGUMENTS
-  USER  Username (email)
+  [USER]  Username (email)
 
 FLAGS
   --env=<value>       [default: default] allow to switch between configurations (server or users)
@@ -1611,8 +1568,8 @@ Delete a widget
 
 ```
 USAGE
-  $ proca widget delete [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
-    [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
+  $ proca widget delete [--json | --human | --csv] [--env <value>] [--simplify] [-i
+    <value> | -n <the_short_name> | -x <value>]
 
 FLAGS
   -i, --id=<value>
@@ -1636,8 +1593,8 @@ view a widget
 
 ```
 USAGE
-  $ proca widget get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
-    [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
+  $ proca widget get [--json | --human | --csv] [--env <value>] [--simplify] [-i
+    <value> | -n <the_short_name> | -x <value>] [--config]
 
 FLAGS
   -i, --id=<value>