@adobe/aio-cli-plugin-events

4.0.1 • Public • Published

oclif Version Downloads/week Build Status License Codecov Coverage pre-release version

Adobe I/O Events CLI Plugin

Adobe I/O Events Plugin for the Adobe I/O CLI

Usage

$ aio plugins:install -g @adobe/aio-cli-plugin-events
$ # OR
$ aio discover -i
$ aio event --help

Commands

aio event

Manage your Adobe I/O Events

USAGE
  $ aio event [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events

See code: src/commands/event/index.js

aio event eventmetadata

Manage your Adobe I/O Events Providers' Event Metadata

USAGE
  $ aio event eventmetadata [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events Providers' Event Metadata

See code: src/commands/event/eventmetadata/index.js

aio event eventmetadata create PROVIDERID

Create an Event Metadata for a Provider

USAGE
  $ aio event eventmetadata create PROVIDERID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested eventmetadata event code

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Create an Event Metadata for a Provider

See code: src/commands/event/eventmetadata/create.js

aio event eventmetadata delete PROVIDERID [EVENTCODE]

Delete Event Metadata for a Provider

USAGE
  $ aio event eventmetadata delete PROVIDERID [EVENTCODE] [--help] [-v] [--version]

ARGUMENTS
  PROVIDERID  The requested provider ID
  EVENTCODE   The requested eventmetadata event code

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Delete Event Metadata for a Provider

See code: src/commands/event/eventmetadata/delete.js

aio event eventmetadata get PROVIDERID EVENTCODE

Get details of an Event Code of a Provider

USAGE
  $ aio event eventmetadata get PROVIDERID EVENTCODE [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID
  EVENTCODE   The requested eventmetadata event code

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Get details of an Event Code of a Provider

See code: src/commands/event/eventmetadata/get.js

aio event eventmetadata list PROVIDERID

List all Event Metadata for a Provider

USAGE
  $ aio event eventmetadata list PROVIDERID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  List all Event Metadata for a Provider

ALIASES
  $ aio event eventmetadata ls

See code: src/commands/event/eventmetadata/list.js

aio event eventmetadata update PROVIDERID EVENTCODE

Update an Event Metadata for a Provider

USAGE
  $ aio event eventmetadata update PROVIDERID EVENTCODE [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID
  EVENTCODE   The requested eventmetadata event code

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Update an Event Metadata for a Provider

See code: src/commands/event/eventmetadata/update.js

aio event provider

Manage your Adobe I/O Events Providers

USAGE
  $ aio event provider [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events Providers

See code: src/commands/event/provider/index.js

aio event provider create

Create a new Provider

USAGE
  $ aio event provider create [--help] [-v] [--version] [-j | -y]

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Create a new Provider

See code: src/commands/event/provider/create.js

aio event provider delete PROVIDERID

Delete Provider by id

USAGE
  $ aio event provider delete PROVIDERID [--help] [-v] [--version]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Delete Provider by id

See code: src/commands/event/provider/delete.js

aio event provider get PROVIDERID

Get details of Provider by id

USAGE
  $ aio event provider get PROVIDERID [--help] [-v] [--version] [--fetchEventMetadata] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -j, --json            Output json
  -v, --verbose         Verbose output
  -y, --yml             Output yml
  --fetchEventMetadata  Fetch event metadata with provider
  --help                Show help
  --version             Show version

DESCRIPTION
  Get details of Provider by id

See code: src/commands/event/provider/get.js

aio event provider list

Get list of all Providers for the Organization

USAGE
  $ aio event provider list [--help] [-v] [--version] [--fetchEventMetadata] [--providerMetadataId <value> | -p <value>]
    [--instanceId <value>] [-j | -y]

FLAGS
  -j, --json                            Output json
  -p, --providerMetadataIds=<value>...  Filter providers for org by list of provider metadata ids
  -v, --verbose                         Verbose output
  -y, --yml                             Output yml
  --fetchEventMetadata                  Fetch event metadata with provider
  --help                                Show help
  --instanceId=<value>                  Filter providers for org by provider metadata id (and instance id if applicable)
  --providerMetadataId=<value>          Filter providers for org by provider metadata id (and instance id if applicable)
  --version                             Show version

DESCRIPTION
  Get list of all Providers for the Organization

ALIASES
  $ aio event provider ls

See code: src/commands/event/provider/list.js

aio event provider update PROVIDERID

Update an existing Provider

USAGE
  $ aio event provider update PROVIDERID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Update an existing Provider

See code: src/commands/event/provider/update.js

aio event registration

Manage your Adobe I/O Events Registrations

USAGE
  $ aio event registration [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events Registrations

ALIASES
  $ aio event reg

See code: src/commands/event/registration/index.js

aio event registration create BODYJSONFILE

Create a new Event Registration in your Workspace

USAGE
  $ aio event registration create BODYJSONFILE [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  BODYJSONFILE
      Path to a file in JSON format with the information to create a new Event Registration.
      The JSON should follow the following format:
      {
      "name": "<event registration name>",
      "description": "<event registration description>",
      "delivery_type": "webhook|webhook_batch|journal",
      "webhook_url": "<webhook URL responding to challenge>",
      "events_of_interest": [{
      "provider_id": "<event provider id>",
      "event_code": "<event provider event_code metadata>"
      }, { /* ...more events */ }]
      }

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Create a new Event Registration in your Workspace

ALIASES
  $ aio event reg create

See code: src/commands/event/registration/create.js

aio event registration delete REGISTRATIONID

Delete Registration

USAGE
  $ aio event registration delete REGISTRATIONID [--help] [-v] [--version]

ARGUMENTS
  REGISTRATIONID  The requested registration ID

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Delete Registration

ALIASES
  $ aio event reg delete

See code: src/commands/event/registration/delete.js

aio event registration get REGISTRATIONID

Get an Event Registration in your Workspace

USAGE
  $ aio event registration get REGISTRATIONID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  REGISTRATIONID  The requested registration ID

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Get an Event Registration in your Workspace

ALIASES
  $ aio event reg get

See code: src/commands/event/registration/get.js

aio event registration list

List your Event Registrations in your Workspace

USAGE
  $ aio event registration list [--help] [-v] [--version] [-j | -y]

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  List your Event Registrations in your Workspace

ALIASES
  $ aio event registration ls
  $ aio event reg list
  $ aio event reg ls

See code: src/commands/event/registration/list.js

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

Readme

Keywords

Package Sidebar

Install

npm i @adobe/aio-cli-plugin-events

Weekly Downloads

3,347

Version

4.0.1

License

Apache-2.0

Unpacked Size

127 kB

Total Files

29

Last publish

Collaborators

  • dylandepass
  • djaeggi
  • adobehalls
  • fullcolorcoder
  • marbec
  • tripod
  • garthdb
  • lazd
  • adobe-admin
  • patrickfulton
  • trieloff
  • shazron
  • krisnye
  • dcpfsdk
  • natebaldwin
  • devongovett
  • aspro83
  • symanovi
  • dpfister
  • stefan-guggisberg
  • korra
  • rofe
  • kptdobe