@adobe/aio-cli-plugin-events

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

Usage no npm install needed!

<script type="module">
  import adobeAioCliPluginEvents from 'https://cdn.skypack.dev/@adobe/aio-cli-plugin-events';
</script>

README

oclif Version Downloads/week Build Status License Codecov Coverage

Adobe I/O Events CLI Plugin

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

Usage

$ npm install -g @adobe/aio-cli-plugin-events
$ aio COMMAND
running command...
$ aio (-v|--version|version)
@adobe/aio-cli-plugin-events/1.1.5 linux-x64 node-v10.24.1
$ aio --help [COMMAND]
USAGE
  $ aio COMMAND
...

Commands

aio event

Manage your Adobe I/O Events

USAGE
  $ aio event

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

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

aio event:eventmetadata

Manage your Adobe I/O Events Providers' Event Metadata

USAGE
  $ aio event:eventmetadata

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

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

ARGUMENTS
  PROVIDERID  The requested eventmetadata event code

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

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]

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

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

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

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

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

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

ARGUMENTS
  PROVIDERID  The requested provider ID

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

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

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

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

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

aio event:provider

Manage your Adobe I/O Events Providers

USAGE
  $ aio event:provider

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

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

aio event:provider:create

Create a new Provider

USAGE
  $ aio event:provider:create

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

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

aio event:provider:delete PROVIDERID

Delete Provider by id

USAGE
  $ aio event:provider:delete PROVIDERID

ARGUMENTS
  PROVIDERID  The requested provider ID

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

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

ARGUMENTS
  PROVIDERID  The requested provider ID

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

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

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

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

ARGUMENTS
  PROVIDERID  The requested provider ID

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

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

aio event:registration

Manage your Adobe I/O Events Registrations

USAGE
  $ aio event:registration

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

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

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> }]
      }

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

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

ARGUMENTS
  REGISTRATIONID  The requested registration ID

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

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

ARGUMENTS
  REGISTRATIONID  The requested registration ID

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

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

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

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.