@nir.simionovich/cloudonix-cli/oclif.manifest.json

A CLI tool for the Cloudonix API.Core

{"version":"0.1.8","commands":{"apikeys":{"id":"apikeys","description":"Manage Cloudonix API keys data model\nAn API key represents a Cloudonix API access token. Cloudonix maintains \nvarious API keys, separated to multiple access levels. The following \nis list of API key levels you can use:\n \n\u001b[33mdomain\u001b[0m         A Domain (aka: namespace) level API key. \n              Controls: Domain, Trunk, Applications, \n              Subscribers, DNIDs\n\u001b[33mapplication\u001b[0m    An Application level API key. Controls: \n              Applications control only\n\nThe 'apikeys' module enables the tenant administrator to manage the \ntenants API keys.\n","usage":"apikeys COMMAND [OPTIONS]","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"examples":["Get list of API keys and their information\n$ cloudonix-cli apikeys get --self \\\n  --domain=mydomain.org\n","Generate an API key\n$ cloudonix-cli apikeys create --self --domain=mydomain.org \\\n  --name=my-key-name\n","Revoke an API key\n$ cloudonix-cli apikeys revoke --self --domain=mydomain.org \\\n  --name=my-key-name\n"],"flags":{"tenant":{"name":"tenant","type":"option","description":"Tenant name or ID"},"self":{"name":"self","type":"boolean","description":"[default] Refer to the tenant indicated by\nthe configured\nAPI key","allowNo":false},"domain":{"name":"domain","type":"option","description":"[Default: Environment Variable] Domain name\nor domain ID associated to the API key"},"application":{"name":"application","type":"option","description":"Application name or ID associated to the\nAPI key"},"name":{"name":"name","type":"option","description":"A string value, representing the API key"}},"args":[{"name":"command","description":"Command to execute\n    \n\u001b[33mget\u001b[0m       Get list of API keys\n\u001b[33mcreate\u001b[0m    Create API key\n\u001b[33mrevoke\u001b[0m    Delete API key","required":true,"options":["get","create","revoke"],"default":"get"}]},"applications":{"id":"applications","description":"Manage Cloudonix applications data model\nAn application represents a logic element, implementing one of\nCloudonix's Voice or SMS application APIs.\n\nThe 'applications' module enables the tenant administrator to \nmanage the tenants applications.\n","usage":"applications COMMAND [OPTIONS]","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"examples":["Get list of applications and their information\n$ cloudonix-cli applications get --domain=mydomain.org\n","Get application information\n$ cloudonix-cli applications get --self --domain=mydomain.org \\\n--name=my-app-name\n","Create an application\n$ cloudonix-cli applications create --self --domain=mydomain.org \\\n--name=my-app-name --type=cloudonix --url=https://myurl.com/script\n","Revoke an application\n$ cloudonix-cli applications revoke --self --domain=mydomain.org \\\n--name=my-app-name\n"],"flags":{"tenant":{"name":"tenant","type":"option","description":"Tenant name or ID"},"self":{"name":"self","type":"boolean","description":"[Default] Refer to the tenant indicated by the\nconfigured API key","allowNo":false},"domain":{"name":"domain","type":"option","description":"[Default: Environment Variable] Domain name \nor domain ID associated to the application"},"name":{"name":"name","type":"option","description":"Application name"},"id":{"name":"id","type":"option","description":"Application ID"},"url":{"name":"url","type":"option","description":"Application remote URL"},"type":{"name":"type","type":"option","description":"Application API language","options":["cloudonix","twiml"],"default":"cloudonix"},"enable":{"name":"enable","type":"boolean","description":"Set the application as enabled","allowNo":false},"disable":{"name":"disable","type":"boolean","description":"Set the application as disabled","allowNo":false}},"args":[{"name":"command","description":"Command to execute\n    \n\u001b[33mget\u001b[0m       Get application info or list of\n\u001b[33mcreate\u001b[0m    Create application\n\u001b[33mupdate\u001b[0m    Update application\n\u001b[33mrevoke\u001b[0m    Delete application\n\u001b[33mwizard\u001b[0m    Application wizard - connect with verified compatible\napplication providers or create a custom app","required":true,"options":["get","create","update","revoke","wizard"],"default":"get"}]},"config":{"id":"config","description":"Manage Cloudonix CLI configuration and setup\n\nThe Cloudonix CLI maintains a configuration file named \n.env.cloudonix.cli - normally located under your home directory.\nIf not found, the CLI tool will continue to look for a similar \nfile under your current directory. A third option is to setup an \nenvironment variable called CXCLI, which will point to a configuration \nfile of your choice. \n\n* Multiple configuration files and/or environments are currently not \nsupported.\n","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"flags":{"apikey":{"name":"apikey","type":"option","description":"Cloudonix API key"},"sandbox":{"name":"sandbox","type":"boolean","description":"Enable/Disable sandbox operations","allowNo":false},"domain":{"name":"domain","type":"option","description":"Cloudonix default domain"}},"args":[{"name":"command","description":"Command to execute\n    \n\u001b[33mget\u001b[0m       (Default) Get CLI tool configuration\n\u001b[33mset\u001b[0m       Set your CLI tool configuration\n          (file: ~/.env.cloudonix.cli","required":true,"options":["get","set"],"default":"get"}]},"dnids":{"id":"dnids","description":"Manage Cloudonix DNID data model\nA DNID represents a phone number (or other form of number pattern) \nthat invokes a specific Cloudonix application. The invocation of \nassigned application is performed for any inbound call or SMS that \nis intercepted by the Cloudonix application Core. \n\nThe 'dnids' module enables the tenant administrator to manage the \ntenant DNID application routing.\n","usage":"dnids COMMAND [OPTIONS]","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"examples":[],"flags":{"tenant":{"name":"tenant","type":"option","description":"Tenant name or ID"},"self":{"name":"self","type":"boolean","description":"[Default] Refer to the tenant indicated by\nthe configured API key","allowNo":false},"domain":{"name":"domain","type":"option","description":"[Default: Environment Variable] Domain name\nor domain ID associated to the DNID"},"application":{"name":"application","type":"option","description":"[Default: call-routing] Application name or\nID associated to the DNID"},"dnid":{"name":"dnid","type":"option","description":"The DNID to create"},"global":{"name":"global","type":"boolean","description":"Set DNID as Global","allowNo":false},"regex":{"name":"regex","type":"boolean","description":"The DNID string provided is a Regular\nExpression","allowNo":false},"expression":{"name":"expression","type":"boolean","description":"The DNID string provided is a Character\nClass Expression","allowNo":false},"prefix":{"name":"prefix","type":"boolean","description":"[Default] The DNID string provided is a\nPrefix","allowNo":false},"legacy":{"name":"legacy","type":"boolean","description":"The DNID string provided is an Asterisk style\nextensions matching format","allowNo":false},"enable":{"name":"enable","type":"boolean","description":"[Default] Set the DNID as enabled","allowNo":false},"disable":{"name":"disable","type":"boolean","description":"Set the DNID as disabled","allowNo":false}},"args":[{"name":"command","description":"Command to execute\n    \n\u001b[33mget\u001b[0m       Get DNID of list of\n\u001b[33mcreate\u001b[0m    Create DNID\n\u001b[33mupdate\u001b[0m    Update DNID\n\u001b[33mrevoke\u001b[0m    Delete DNID\n\u001b[33mwizard\u001b[0m    DNID wizard","required":true,"options":["get","create","update","revoke","wizard"],"default":"get"}]},"domains":{"id":"domains","description":"Manage Cloudonix tenant domains data models\n\nA Cloudonix Tenant may have multiple domains associated with it. While \na single tenant may have multiple domains, communications or \ninter-domain data sharing is not available. Domains are treated as \ndiscrete logical elments. Domains may have applications, DNIDs, trunks \nand subscribers associated to them.\n","usage":"domains COMMAND [OPTIONS]","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"examples":["Get list of domains and their information\n$ cloudonix-cli domains get\n","Get domain information\n$ cloudonix-cli domains get --name=mydomain.cloudonix.io\n","Set a domain alias\n$ cloudonix-cli domains config --name=mydomain.cloudonix.io --set \\\n--alias=alias.cloudonix.io\n","Disable a domain\n$ cloudonix-cli domains config --name=mydomain.cloudonix.io --unset \\\n--active\n"],"flags":{"tenant":{"name":"tenant","type":"option","description":"Tenant name or id"},"self":{"name":"self","type":"boolean","description":"[default] Refer to the tenant indicated by\nthe configured API key","allowNo":false},"name":{"name":"name","type":"option","description":"Domain name, aka: namespace"},"id":{"name":"id","type":"option","description":"Domain ID, aka: namespace ID"},"newname":{"name":"newname","type":"option","description":"Rename --name to --newname\n(used with `update` action)"},"active":{"name":"active","type":"boolean","description":"Set the domain as Active or Inactive\n(used with `config` action)","allowNo":false},"regfree":{"name":"regfree","type":"boolean","description":"Set the domain as RegistrationFree\nenabled or disabled (used with `config` action)","allowNo":false},"app":{"name":"app","type":"option","description":"Set the domain default application ID\n(used with `config` action)"},"set":{"name":"set","type":"boolean","description":"Set alias or key:value pair\n(used with `config` action)","allowNo":false},"unset":{"name":"unset","type":"boolean","description":"Unset alias or key:value pair\n(used with `config` action)","allowNo":false},"alias":{"name":"alias","type":"option","description":"Set or unset a domain alias for domain\n(used with `config` action) or get domain\nby alias (used with `get` action)"},"aliases":{"name":"aliases","type":"boolean","description":"Get list of domain aliases\n(used with `get` action)","allowNo":false},"pair":{"name":"pair","type":"option","description":"Set a domain profile key:value\npair, as designated by `pair` and `value`\n(used with `config` action)"},"value":{"name":"value","type":"option","description":"Assign the `value` to the new profile key:value\npair, designated by `pair`\n(used with `config` action)"}},"args":[{"name":"action","description":"Command to execute\n    \n\u001b[33mget\u001b[0m       Get domain or list all\n\u001b[33mcreate\u001b[0m    Create domain\n\u001b[33mupdate\u001b[0m    Update domain\n\u001b[33mrevoke\u001b[0m    Delete domain\n\u001b[33mconfig\u001b[0m    Manipulate domain settings","required":true,"options":["get","config","create","update","revoke"],"default":"get"}]},"subscribers":{"id":"subscribers","description":"Manage Cloudonix subscribers data model\n\nA subscriber represents a single user-agent endpoint that connects to\nthe platform. The user-agent can either be a remote website (using the \nCloudonix WebSDK), a remote SIP phone or a mobile application (using \nthe Cloudonix mobile SDK).\n\nThe 'subscribers' module enables the tenant administrator to manage \nthe tenants subscribers.\n","usage":"subscribers COMMAND [OPTIONS]","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"examples":["Get list of subscriber and their information\n$ cloudonix-cli subscribers get --self --domain=mydomain.org\n","Get subscriber information\n$ cloudonix-cli subscribers get --self --domain=mydomain.org \\\n--msisdn=123455777\n","Revoke a subscriber\n$ cloudonix-cli subscribers revoke --self --domain=mydomain.org \\\n--msisdn=123455777\n"],"flags":{"tenant":{"name":"tenant","type":"option","description":"Tenant name or ID"},"self":{"name":"self","type":"boolean","description":"[default] Refer to the tenant indicated by the\nconfigured API key","allowNo":false},"domain":{"name":"domain","type":"option","description":"[Default: Environment Variable] Domain name or\ndomain ID associated to the subscriber"},"msisdn":{"name":"msisdn","type":"option","description":"A subscriber identified, normally a numerical\nstring. For simplicity, use a phone nubmer."},"enable":{"name":"enable","type":"boolean","description":"[Default] Set the subscriber as enabled","allowNo":false},"disable":{"name":"disable","type":"boolean","description":"Set the subscriber as disabled","allowNo":false},"password":{"name":"password","type":"option","description":"[Default: Empty Password] An assigned password for\nthe subscriber."},"autogenerate":{"name":"autogenerate","type":"boolean","description":"Autogenerate a SIP password","allowNo":false},"reset":{"name":"reset","type":"boolean","description":"Reset a subscribers SIP password","allowNo":false}},"args":[{"name":"command","description":"Command to execute\n    \n\u001b[33mget\u001b[0m       Get subscriber or list of\n\u001b[33mcreate\u001b[0m    Create subscriber\n\u001b[33mupdate\u001b[0m    Update subscriber\n\u001b[33mrevoke\u001b[0m    Delete subscriber","required":true,"options":["get","create","update","revoke"],"default":"get"}]},"tenant":{"id":"tenant","description":"Manage Cloudonix tenant data model\n\nA tenant represents the highest level of authorization a Cloudonix \nplatform customer can have. Tenants maintain multiple sets of \ndomains, applications, trunks, DNIDs and more.\n\nThe 'tenant' module enables the tenant administrator to query the \ntenant configuration and control various teant related settings.\n","usage":"tenant COMMAND [OPTIONS]","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"examples":["Get my tenant information\n$ cloudonix-cli tenant get --self\n","List all tenant associated API keys (all types)\n$ cloudonix-cli tenant apikey --getkey --self\n","Add a tenant setting to your tenant\n$ cloudonix-cli tenant settings --addpair=new-key \\\n--value=new-value --self\n"],"flags":{"name":{"name":"name","type":"option","description":"Tenant name"},"id":{"name":"id","type":"option","description":"Tenant ID"},"self":{"name":"self","type":"boolean","description":"[default] Refer to the tenant indicated\nby the configured API key","allowNo":false},"generate":{"name":"generate","type":"option","description":"Generate a new API key, and set its name"},"revoke":{"name":"revoke","type":"option","description":"Revoke an API key, indicated by its name"},"keyid":{"name":"keyid","type":"option","description":"Get API key information"},"keylist":{"name":"keylist","type":"boolean","description":"[default] Get API key list","allowNo":false},"setpair":{"name":"setpair","type":"option","description":"Set a tenant settings key:value pair,\nas designated by `addpair` and `value`"},"delpair":{"name":"delpair","type":"option","description":"Delete a tenant settings key:value pair,\nas designated by `delkey`"},"value":{"name":"value","type":"option","description":"Assign the `value` to the new settings pair,\ndesignated by `addpair`"}},"args":[{"name":"command","description":"Command to execute","required":true,"options":["get","settings","apikey"],"default":"get"}]},"trunks":{"id":"trunks","description":"Manage Cloudonix trunks data model\nA trunk represents a connection from the Cloudonix switching core, to a remotely located \ncommunications provider or a remotely located communications system. Trunks are IP connections\nbased upon the SIP signalling protocol. Cloudonix trunks support the following voice codecs:\nG711u, G711a, G729, G723, GSM, Speex and Opus. \n\nThe 'trunks' module enables the tenant administrator to manage the tenants trunks.\n","usage":"trunks COMMAND [OPTIONS]","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"examples":["Get list of trunks and their information\n$ cloudonix-cli trunks get --domain=mydomain.org\n","Get trunk information\n$ cloudonix-cli trunks get --self  --domain=mydomain.org --name=my-trunk-name\n","Revoke a trunk\n$ cloudonix-cli trunks revoke --self  --domain=mydomain.org --name=my-trunk-name\n"],"flags":{"tenant":{"name":"tenant","type":"option","description":"Tenant name or ID"},"self":{"name":"self","type":"boolean","description":"[default] Refer to the tenant indicated by the configured API key","allowNo":false},"domain":{"name":"domain","type":"option","description":"[Default: Environment Variable] Domain name or domain ID associated to the trunk"},"name":{"name":"name","type":"option","description":"Trunk name"},"id":{"name":"id","type":"option","description":"Trunk ID"},"ip":{"name":"ip","type":"option","description":"Trunk IP address or FQDN"},"port":{"name":"port","type":"option","description":"[Default: 5060] Trunk port"},"transport":{"name":"transport","type":"option","description":"[Default: udp] Trunk transport","options":["udp","tcp","tls"]},"direction":{"name":"direction","type":"option","description":"[Default: public-outbound] Trunk transport","options":["inbound","outbound","public-inbound","public-outbound"]},"prefix":{"name":"prefix","type":"option","description":"Trunk technical prefix"}},"args":[{"name":"command","description":"Command to execute\n    \n\u001b[33mget\u001b[0m       Get trunk of list of\n\u001b[33mcreate\u001b[0m    Create trunk\n\u001b[33mupdate\u001b[0m    Update trunk\n\u001b[33mrevoke\u001b[0m    Delete trunk\n\u001b[33mwizard\u001b[0m    Trunk wizard - connect with verified compatible service providers","required":true,"options":["get","create","update","revoke","wizard"],"default":"get"}]},"users":{"id":"users","description":"Manage Cloudonix users. \n\nUsers are identified by e-Mail addresses, that can be authenticated \nusing either Google, Facebook, Github or Microsoft365 authentication \nproviders. Users may be associated with a tenant or a domain. \n\nOnce a user is associated with a domain, it has access to domain \nrelated data models only.\n\nThe 'users' module enables the tenant administrator to manage the \ntenants associated users and domain associated users.\n","usage":"users COMMAND [OPTIONS]","pluginName":"@nir.simionovich/cloudonix-cli","pluginType":"core","aliases":[],"examples":["Get list of users and their information\n$ cloudonix-cli users get --self --domain=mydomain.org\n","Revoke a user\n$ cloudonix-cli users revoke --self --domain=mydomain.org \\\n--username=my-username@mydomain.com\n"],"flags":{"tenant":{"name":"tenant","type":"option","description":"Tenant name or ID"},"self":{"name":"self","type":"boolean","description":"[default] Refer to the tenant indicated by\nthe configured API key","allowNo":false},"domain":{"name":"domain","type":"option","description":"Domain name or domain ID associated to the\nusername, if not specified - reference\nto Tenant user"},"username":{"name":"username","type":"option","description":"Username to create or revoke. A username MUST be\na valid e-Mail address"}},"args":[{"name":"command","description":"Command to execute\n    \n\u001b[33mget\u001b[0m       Get user information of list of\n\u001b[33mcreate\u001b[0m    Create user\n\u001b[33mrevoke\u001b[0m    Delete user","required":true,"options":["get","create","update","revoke"],"default":"get"}]}}}