From 0a7b6820e062291d856eb853577f3f80b18e5292 Mon Sep 17 00:00:00 2001 From: Nicholas Cristofaro Date: Tue, 14 Nov 2023 12:52:25 -0300 Subject: [PATCH] Alert notification API (#1202) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * doc: Update TTS Plans info (#1190) * doc: Update TTS Plans info * fixup! doc: Update TTS Plans info * fixup! doc: Update TTS Plans info * doc: Add downgrading plan info * doc: Update redirects (#1204) * build(deps): bump google.golang.org/grpc from 1.54.0 to 1.56.3 (#1203) Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.54.0 to 1.56.3. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](https://github.com/grpc/grpc-go/compare/v1.54.0...v1.56.3) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * doc: Add v3.28.0 release docs (#1206) * doc: Add v3.28.0 release docs * doc: Add new services to IS API docs * build(deps): bump golang.org/x/image from 0.7.0 to 0.10.0 (#1207) Bumps [golang.org/x/image](https://github.com/golang/image) from 0.7.0 to 0.10.0. - [Commits](https://github.com/golang/image/compare/v0.7.0...v0.10.0) --- updated-dependencies: - dependency-name: golang.org/x/image dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * doc: Subscription and billing mgmt FAQ update (#1211) * Restructure and update `devices` section (#1210) * doc: Use cards in sub sections * doc: Move best practices * doc: Expand concepts * doc: Move models to a sub section * doc: Add configuration content * doc: Restructure adding devices * doc: Recreate adding devices * doc: Add other sections * doc: Update aliases * doc: Update introductory passage * doc: Update guide * doc: Add receiver methods to identity_server api * doc: Add profile methods to identity_server api * doc: Add alertNotificationProfileIdentifiers to gateway api * doc: Add TTES's hugo generated docs --------- Signed-off-by: dependabot[bot] Co-authored-by: Nejra Selimović Co-authored-by: Krishna Iyer Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- doc/content/reference/api/gateway.md | 2 + doc/content/reference/api/identity_server.md | 58 +++++ doc/content/ttn-lw-cli/ttn-lw-cli.md | 2 + .../ttn-lw-cli_alert-notification-profiles.md | 62 +++++ ...-cli_alert-notification-profiles_create.md | 66 +++++ ...-cli_alert-notification-profiles_delete.md | 60 +++++ ...alert-notification-profiles_get-default.md | 65 +++++ ...-lw-cli_alert-notification-profiles_get.md | 65 +++++ ...lw-cli_alert-notification-profiles_list.md | 68 +++++ ...-cli_alert-notification-profiles_update.md | 67 +++++ ...ttn-lw-cli_alert-notification-receivers.md | 61 +++++ ...cli_alert-notification-receivers_create.md | 67 +++++ ...cli_alert-notification-receivers_delete.md | 60 +++++ ...lw-cli_alert-notification-receivers_get.md | 69 +++++ ...w-cli_alert-notification-receivers_list.md | 72 ++++++ ...cli_alert-notification-receivers_update.md | 68 +++++ .../ttn-lw-cli/ttn-lw-cli_gateways_create.md | 1 + .../ttn-lw-cli/ttn-lw-cli_gateways_get.md | 2 + .../ttn-lw-cli/ttn-lw-cli_gateways_list.md | 2 + .../ttn-lw-cli/ttn-lw-cli_gateways_search.md | 2 + .../ttn-lw-cli/ttn-lw-cli_gateways_set.md | 1 + .../messages/AlertNotificationProfile.yml | 47 ++++ .../messages/AlertNotificationProfiles.yml | 7 + .../AlertNotificationReceiver.Email.yml | 7 + .../AlertNotificationReceiver.SMS.yml | 11 + .../AlertNotificationReceiver.Webhook.yml | 20 ++ .../messages/AlertNotificationReceiver.yml | 43 ++++ .../AlertNotificationReceiverIdentifiers.yml | 8 + .../messages/AlertNotificationReceivers.yml | 7 + .../CreateAlertNotificationProfileRequest.yml | 8 + ...CreateAlertNotificationReceiverRequest.yml | 8 + .../GetAlertNotificationProfileRequest.yml | 14 + .../GetAlertNotificationReceiverRequest.yml | 13 + ...DefaultAlertNotificationProfileRequest.yml | 7 + .../ListAlertNotificationProfilesRequest.yml | 32 +++ .../ListAlertNotificationReceiversRequest.yml | 32 +++ .../UpdateAlertNotificationProfileRequest.yml | 13 + ...UpdateAlertNotificationReceiverRequest.yml | 13 + .../AlertNotificationProfileRegistry.yml | 69 +++++ .../AlertNotificationReceiverRegistry.yml | 57 +++++ .../AlertNotificationProfileIdentifiers.yml | 8 + doc/data/commands/ttn-lw-cli.json | 56 ++++ doc/data/ttn-lw-cli.yml | 239 ++++++++++++++++++ 43 files changed, 1639 insertions(+) create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_create.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_delete.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get-default.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_list.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_update.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_create.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_delete.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_list.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_update.md create mode 100644 doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfile.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfiles.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Email.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.SMS.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Webhook.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiverIdentifiers.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceivers.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationProfileRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationReceiverRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationProfileRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationReceiverRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/GetDefaultAlertNotificationProfileRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationProfilesRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationReceiversRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationProfileRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationReceiverRequest.yml create mode 100644 doc/data/api/tti.lorawan.v3/services/AlertNotificationProfileRegistry.yml create mode 100644 doc/data/api/tti.lorawan.v3/services/AlertNotificationReceiverRegistry.yml create mode 100644 doc/data/api/ttn.lorawan.v3/messages/AlertNotificationProfileIdentifiers.yml diff --git a/doc/content/reference/api/gateway.md b/doc/content/reference/api/gateway.md index 90c182811e..210d289c09 100644 --- a/doc/content/reference/api/gateway.md +++ b/doc/content/reference/api/gateway.md @@ -69,6 +69,8 @@ The Gateway Server exposes the list of available frequency plans with the `Confi ## Messages +{{< proto/message message="AlertNotificationProfileIdentifiers" >}} + {{< proto/message message="APIKey" >}} {{< proto/message message="APIKeys" >}} diff --git a/doc/content/reference/api/identity_server.md b/doc/content/reference/api/identity_server.md index 084a9e6ab6..ee0ee7dd05 100644 --- a/doc/content/reference/api/identity_server.md +++ b/doc/content/reference/api/identity_server.md @@ -3,6 +3,32 @@ title: "Identity Server APIs" description: "" --- +## The `AlertNotificationProfileRegistry` service + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Create" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Get" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Update" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Delete" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="List" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="GetDefault" >}} + +## The `AlertNotificationReceiverRegistry` service + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Create" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Get" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Update" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Delete" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="List" >}} + ## The `AuthenticationProviderRegistry` service {{< proto/method package="tti.lorawan.v3" service="AuthenticationProviderRegistry" method="Create" >}} @@ -53,6 +79,38 @@ description: "" ## Messages +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationProfile" >}} + +{{< proto/message message="AlertNotificationProfileIdentifiers" >}} + +{{< proto/message package="tti.lorawan.v3" message="CreateAlertNotificationProfileRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="GetAlertNotificationProfileRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="ListAlertNotificationProfilesRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="UpdateAlertNotificationProfileRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="GetDefaultAlertNotificationProfileRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiverIdentifiers" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.Email" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.SMS" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.Webhook" >}} + +{{< proto/message package="tti.lorawan.v3" message="CreateAlertNotificationReceiverRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="GetAlertNotificationReceiverRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="ListAlertNotificationReceiversRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="UpdateAlertNotificationReceiverRequest" >}} + {{< proto/message message="AssertGatewayRightsRequest" >}} {{< proto/message package="tti.lorawan.v3" message="AuthenticationProvider" >}} diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli.md b/doc/content/ttn-lw-cli/ttn-lw-cli.md index 4e0e362b6e..053ff4fd9d 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli.md @@ -47,6 +47,8 @@ The Things Industries Command-line Interface ### SEE ALSO +* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) * [ttn-lw-cli applications]({{< relref "ttn-lw-cli_applications" >}}) - Application commands * [ttn-lw-cli authentication-providers]({{< relref "ttn-lw-cli_authentication-providers" >}}) - Authentication Provider commands * [ttn-lw-cli clients]({{< relref "ttn-lw-cli_clients" >}}) - Client commands diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles.md new file mode 100644 index 0000000000..2e39455999 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles.md @@ -0,0 +1,62 @@ +--- +title: "ttn-lw-cli alert-notification-profiles" +slug: ttn-lw-cli_alert-notification-profiles +--- + +## ttn-lw-cli alert-notification-profiles + +Alert Notification Profile commands (EXPERIMENTAL) + +### Options + +``` + -h, --help help for alert-notification-profiles +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface +* [ttn-lw-cli alert-notification-profiles create]({{< relref "ttn-lw-cli_alert-notification-profiles_create" >}}) - Create an alert notification profile (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles delete]({{< relref "ttn-lw-cli_alert-notification-profiles_delete" >}}) - Delete an alert notification profile (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles get]({{< relref "ttn-lw-cli_alert-notification-profiles_get" >}}) - Get an alert notification profile (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles get-default]({{< relref "ttn-lw-cli_alert-notification-profiles_get-default" >}}) - Get default alert notification profile (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles list]({{< relref "ttn-lw-cli_alert-notification-profiles_list" >}}) - List alert notification profiles (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles update]({{< relref "ttn-lw-cli_alert-notification-profiles_update" >}}) - Update an alert notification profile (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_create.md new file mode 100644 index 0000000000..fa60adf8ef --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_create.md @@ -0,0 +1,66 @@ +--- +title: "ttn-lw-cli alert-notification-profiles create" +slug: ttn-lw-cli_alert-notification-profiles_create +--- + +## ttn-lw-cli alert-notification-profiles create + +Create an alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles create [profile-id] [flags] +``` + +### Options + +``` + --description string + -h, --help help for create + --ids.profile-id string + --is-default + --name string + --profile-id string + --receivers-ids strings set profile receiver IDs +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_delete.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_delete.md new file mode 100644 index 0000000000..cf523af95c --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_delete.md @@ -0,0 +1,60 @@ +--- +title: "ttn-lw-cli alert-notification-profiles delete" +slug: ttn-lw-cli_alert-notification-profiles_delete +--- + +## ttn-lw-cli alert-notification-profiles delete + +Delete an alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles delete [profile-id] [flags] +``` + +### Options + +``` + -h, --help help for delete +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get-default.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get-default.md new file mode 100644 index 0000000000..612c927978 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get-default.md @@ -0,0 +1,65 @@ +--- +title: "ttn-lw-cli alert-notification-profiles get-default" +slug: ttn-lw-cli_alert-notification-profiles_get-default +--- + +## ttn-lw-cli alert-notification-profiles get-default + +Get default alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles get-default [flags] +``` + +### Options + +``` + --description select the description field + -h, --help help for get-default + --is-default select the is_default field + --name select the name field + --profile-id select the profile_id field + --receivers-ids select the receivers_ids field +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get.md new file mode 100644 index 0000000000..d0f5364d0e --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get.md @@ -0,0 +1,65 @@ +--- +title: "ttn-lw-cli alert-notification-profiles get" +slug: ttn-lw-cli_alert-notification-profiles_get +--- + +## ttn-lw-cli alert-notification-profiles get + +Get an alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles get [profile-id] [flags] +``` + +### Options + +``` + --description select the description field + -h, --help help for get + --is-default select the is_default field + --name select the name field + --profile-id select the profile_id field + --receivers-ids select the receivers_ids field +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_list.md new file mode 100644 index 0000000000..2df1f54ad0 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_list.md @@ -0,0 +1,68 @@ +--- +title: "ttn-lw-cli alert-notification-profiles list" +slug: ttn-lw-cli_alert-notification-profiles_list +--- + +## ttn-lw-cli alert-notification-profiles list + +List alert notification profiles (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles list [flags] +``` + +### Options + +``` + --description select the description field + -h, --help help for list + --is-default select the is_default field + --limit uint32 maximum number of results to get (default 50) + --name select the name field + --order string order by this field + --page uint32 results page number (default 1) + --profile-id select the profile_id field + --receivers-ids select the receivers_ids field +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_update.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_update.md new file mode 100644 index 0000000000..2b7c69d47d --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_update.md @@ -0,0 +1,67 @@ +--- +title: "ttn-lw-cli alert-notification-profiles update" +slug: ttn-lw-cli_alert-notification-profiles_update +--- + +## ttn-lw-cli alert-notification-profiles update + +Update an alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles update [profile-id] [flags] +``` + +### Options + +``` + --description string + -h, --help help for update + --ids.profile-id string + --is-default + --name string + --profile-id string + --receivers-ids strings set profile receiver IDs + --unset strings list of fields to unset +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers.md new file mode 100644 index 0000000000..e450c3d696 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers.md @@ -0,0 +1,61 @@ +--- +title: "ttn-lw-cli alert-notification-receivers" +slug: ttn-lw-cli_alert-notification-receivers +--- + +## ttn-lw-cli alert-notification-receivers + +Alert Notification Receiver commands (EXPERIMENTAL) + +### Options + +``` + -h, --help help for alert-notification-receivers +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface +* [ttn-lw-cli alert-notification-receivers create]({{< relref "ttn-lw-cli_alert-notification-receivers_create" >}}) - Create an alert notification receiver (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers delete]({{< relref "ttn-lw-cli_alert-notification-receivers_delete" >}}) - Delete an alert notification receiver (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers get]({{< relref "ttn-lw-cli_alert-notification-receivers_get" >}}) - Get an alert notification receiver (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers list]({{< relref "ttn-lw-cli_alert-notification-receivers_list" >}}) - List alert notification receivers (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers update]({{< relref "ttn-lw-cli_alert-notification-receivers_update" >}}) - Update an alert notification receiver (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_create.md new file mode 100644 index 0000000000..45107a2f8b --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_create.md @@ -0,0 +1,67 @@ +--- +title: "ttn-lw-cli alert-notification-receivers create" +slug: ttn-lw-cli_alert-notification-receivers_create +--- + +## ttn-lw-cli alert-notification-receivers create + +Create an alert notification receiver (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers create [receiver-id] [flags] +``` + +### Options + +``` + --contact-method.email.recipient string + --contact-method.sms.phone-number string + --contact-method.webhook.headers stringToString + --contact-method.webhook.url string + -h, --help help for create + --ids.receiver-id string + --name string + --receiver-id string +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_delete.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_delete.md new file mode 100644 index 0000000000..f0805b7c63 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_delete.md @@ -0,0 +1,60 @@ +--- +title: "ttn-lw-cli alert-notification-receivers delete" +slug: ttn-lw-cli_alert-notification-receivers_delete +--- + +## ttn-lw-cli alert-notification-receivers delete + +Delete an alert notification receiver (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers delete [receiver-id] [flags] +``` + +### Options + +``` + -h, --help help for delete +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get.md new file mode 100644 index 0000000000..0a9d6f152d --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get.md @@ -0,0 +1,69 @@ +--- +title: "ttn-lw-cli alert-notification-receivers get" +slug: ttn-lw-cli_alert-notification-receivers_get +--- + +## ttn-lw-cli alert-notification-receivers get + +Get an alert notification receiver (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers get [receiver-id] [flags] +``` + +### Options + +``` + --contact-method.email select the contact_method.email field and all allowed sub-fields + --contact-method.email.recipient select the contact_method.email.recipient field + --contact-method.sms select the contact_method.sms field and all allowed sub-fields + --contact-method.sms.phone-number select the contact_method.sms.phone_number field + --contact-method.webhook select the contact_method.webhook field and all allowed sub-fields + --contact-method.webhook.headers select the contact_method.webhook.headers field + --contact-method.webhook.url select the contact_method.webhook.url field + -h, --help help for get + --name select the name field + --receiver-id select the receiver_id field +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_list.md new file mode 100644 index 0000000000..178b8565df --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_list.md @@ -0,0 +1,72 @@ +--- +title: "ttn-lw-cli alert-notification-receivers list" +slug: ttn-lw-cli_alert-notification-receivers_list +--- + +## ttn-lw-cli alert-notification-receivers list + +List alert notification receivers (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers list [flags] +``` + +### Options + +``` + --contact-method.email select the contact_method.email field and all allowed sub-fields + --contact-method.email.recipient select the contact_method.email.recipient field + --contact-method.sms select the contact_method.sms field and all allowed sub-fields + --contact-method.sms.phone-number select the contact_method.sms.phone_number field + --contact-method.webhook select the contact_method.webhook field and all allowed sub-fields + --contact-method.webhook.headers select the contact_method.webhook.headers field + --contact-method.webhook.url select the contact_method.webhook.url field + -h, --help help for list + --limit uint32 maximum number of results to get (default 50) + --name select the name field + --order string order by this field + --page uint32 results page number (default 1) + --receiver-id select the receiver_id field +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_update.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_update.md new file mode 100644 index 0000000000..e293b4617a --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_update.md @@ -0,0 +1,68 @@ +--- +title: "ttn-lw-cli alert-notification-receivers update" +slug: ttn-lw-cli_alert-notification-receivers_update +--- + +## ttn-lw-cli alert-notification-receivers update + +Update an alert notification receiver (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers update [receiver-id] [flags] +``` + +### Options + +``` + --contact-method.email.recipient string + --contact-method.sms.phone-number string + --contact-method.webhook.headers stringToString + --contact-method.webhook.url string + -h, --help help for update + --ids.receiver-id string + --name string + --receiver-id string + --unset strings list of fields to unset +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") +``` + +### SEE ALSO + +* [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_create.md index 5037afb37b..7617d9285d 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_create.md @@ -16,6 +16,7 @@ ttn-lw-cli gateways create [gateway-id] [flags] ``` --administrative-contact.ids.organization-ids.organization-id string --administrative-contact.ids.user-ids.user-id string + --alert-notification-profile-ids.profile-id string --antenna.attributes stringToString --antenna.gain float32 --antenna.location.accuracy int32 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_get.md index 13a31f8899..0bccb95370 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_get.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_get.md @@ -19,6 +19,8 @@ ttn-lw-cli gateways get [gateway-id] [flags] --administrative-contact.ids.organization-ids.organization-id select the administrative_contact.ids.organization_ids.organization_id field --administrative-contact.ids.user-ids select the administrative_contact.ids.user_ids field and all allowed sub-fields --administrative-contact.ids.user-ids.user-id select the administrative_contact.ids.user_ids.user_id field + --alert-notification-profile-ids select the alert_notification_profile_ids field and all allowed sub-fields + --alert-notification-profile-ids.profile-id select the alert_notification_profile_ids.profile_id field --all select all gateway fields --antennas select the antennas field --attributes select the attributes field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list.md index 3a245d34cc..fe52e1648f 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list.md @@ -19,6 +19,8 @@ ttn-lw-cli gateways list [flags] --administrative-contact.ids.organization-ids.organization-id select the administrative_contact.ids.organization_ids.organization_id field --administrative-contact.ids.user-ids select the administrative_contact.ids.user_ids field and all allowed sub-fields --administrative-contact.ids.user-ids.user-id select the administrative_contact.ids.user_ids.user_id field + --alert-notification-profile-ids select the alert_notification_profile_ids field and all allowed sub-fields + --alert-notification-profile-ids.profile-id select the alert_notification_profile_ids.profile_id field --all select all gateway fields --antennas select the antennas field --attributes select the attributes field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_search.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_search.md index 9fc657c3d1..d8e274438b 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_search.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_search.md @@ -19,6 +19,8 @@ ttn-lw-cli gateways search [flags] --administrative-contact.ids.organization-ids.organization-id select the administrative_contact.ids.organization_ids.organization_id field --administrative-contact.ids.user-ids select the administrative_contact.ids.user_ids field and all allowed sub-fields --administrative-contact.ids.user-ids.user-id select the administrative_contact.ids.user_ids.user_id field + --alert-notification-profile-ids select the alert_notification_profile_ids field and all allowed sub-fields + --alert-notification-profile-ids.profile-id select the alert_notification_profile_ids.profile_id field --all select all gateway fields --antennas select the antennas field --attributes select the attributes field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_set.md index bf2feaa103..164a8cd85b 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_set.md @@ -16,6 +16,7 @@ ttn-lw-cli gateways set [gateway-id] [flags] ``` --administrative-contact.ids.organization-ids.organization-id string --administrative-contact.ids.user-ids.user-id string + --alert-notification-profile-ids.profile-id string --antenna.add add an extra antenna --antenna.attributes stringToString --antenna.gain float32 diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfile.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfile.yml new file mode 100644 index 0000000000..39d788b426 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfile.yml @@ -0,0 +1,47 @@ +name: AlertNotificationProfile +fields: +- name: ids + comment: The identifiers of the profile. These are public and can be seen by any + authenticated user in the network. + message: + package: ttn.lorawan.v3 + name: AlertNotificationProfileIdentifiers + rules: + required: true + default: {} +- name: created_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: updated_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: is_default + comment: Whether this profile is the default alert notification profile for the + network. + message: + package: google.protobuf + name: BoolValue + default: null +- name: name + type: string + rules: + max_len: 50 + default: "" +- name: description + type: string + rules: + max_len: 256 + default: "" +- name: receivers_ids + comment: List of receivers that will be notified when an alert is triggered for + this profile. + rules: + max_items: 20 + repeated: + message: + name: AlertNotificationReceiverIdentifiers + default: [] diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfiles.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfiles.yml new file mode 100644 index 0000000000..f6fccfde5c --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfiles.yml @@ -0,0 +1,7 @@ +name: AlertNotificationProfiles +fields: +- name: profiles + repeated: + message: + name: AlertNotificationProfile + default: [] diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Email.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Email.yml new file mode 100644 index 0000000000..f91bf288be --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Email.yml @@ -0,0 +1,7 @@ +name: AlertNotificationReceiver.Email +fields: +- name: recipient + type: string + rules: + email: true + default: "" diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.SMS.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.SMS.yml new file mode 100644 index 0000000000..62ac4c3169 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.SMS.yml @@ -0,0 +1,11 @@ +name: AlertNotificationReceiver.SMS +fields: +- name: phone_number + comment: |- + According to the international phone numbering plan (ITU-T E. 164) + phone numbers cannot contain less than 7 digits and more than 15 digits. + The validation is done via an regex and accounts for the '+' formating character. + type: string + rules: + pattern: ^[+]?[0-9]{7,15}$ + default: "" diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Webhook.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Webhook.yml new file mode 100644 index 0000000000..312e7d7e3b --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Webhook.yml @@ -0,0 +1,20 @@ +name: AlertNotificationReceiver.Webhook +fields: +- name: url + type: string + rules: + uri: true + default: "" +- name: headers + rules: + max_pairs: 50 + ignore_empty: true + map_key: + type: string + rules: + max_len: 64 + map_value: + type: string + rules: + max_len: 4096 + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.yml new file mode 100644 index 0000000000..db7e3d2c0f --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.yml @@ -0,0 +1,43 @@ +name: AlertNotificationReceiver +fields: +- name: ids + comment: The identifiers of the receiver. These can be seen by any admin user in + the network. + message: + name: AlertNotificationReceiverIdentifiers + rules: + required: true + default: {} +- name: created_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: updated_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: name + type: string + rules: + max_len: 50 + default: "" +- name: email + message: + name: AlertNotificationReceiver.Email + default: {} +- name: sms + message: + name: AlertNotificationReceiver.SMS + default: {} +- name: webhook + message: + name: AlertNotificationReceiver.Webhook + default: {} +oneofs: +- name: contact_method + field_names: + - email + - sms + - webhook diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiverIdentifiers.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiverIdentifiers.yml new file mode 100644 index 0000000000..9e88cad7fe --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiverIdentifiers.yml @@ -0,0 +1,8 @@ +name: AlertNotificationReceiverIdentifiers +fields: +- name: receiver_id + type: string + rules: + max_len: 36 + pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$ + default: "" diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceivers.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceivers.yml new file mode 100644 index 0000000000..08c42335eb --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceivers.yml @@ -0,0 +1,7 @@ +name: AlertNotificationReceivers +fields: +- name: receivers + repeated: + message: + name: AlertNotificationReceiver + default: [] diff --git a/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationProfileRequest.yml b/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationProfileRequest.yml new file mode 100644 index 0000000000..865e98a1b9 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationProfileRequest.yml @@ -0,0 +1,8 @@ +name: CreateAlertNotificationProfileRequest +fields: +- name: profile + message: + name: AlertNotificationProfile + rules: + required: true + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationReceiverRequest.yml b/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationReceiverRequest.yml new file mode 100644 index 0000000000..5936774d27 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationReceiverRequest.yml @@ -0,0 +1,8 @@ +name: CreateAlertNotificationReceiverRequest +fields: +- name: receiver + message: + name: AlertNotificationReceiver + rules: + required: true + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationProfileRequest.yml b/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationProfileRequest.yml new file mode 100644 index 0000000000..893d909532 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationProfileRequest.yml @@ -0,0 +1,14 @@ +name: GetAlertNotificationProfileRequest +fields: +- name: ids + message: + package: ttn.lorawan.v3 + name: AlertNotificationProfileIdentifiers + rules: + required: true + default: {} +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationReceiverRequest.yml b/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationReceiverRequest.yml new file mode 100644 index 0000000000..3a5c4367c4 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationReceiverRequest.yml @@ -0,0 +1,13 @@ +name: GetAlertNotificationReceiverRequest +fields: +- name: ids + message: + name: AlertNotificationReceiverIdentifiers + rules: + required: true + default: {} +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/GetDefaultAlertNotificationProfileRequest.yml b/doc/data/api/tti.lorawan.v3/messages/GetDefaultAlertNotificationProfileRequest.yml new file mode 100644 index 0000000000..f0e04826da --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/GetDefaultAlertNotificationProfileRequest.yml @@ -0,0 +1,7 @@ +name: GetDefaultAlertNotificationProfileRequest +fields: +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationProfilesRequest.yml b/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationProfilesRequest.yml new file mode 100644 index 0000000000..dd2a9dbc88 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationProfilesRequest.yml @@ -0,0 +1,32 @@ +name: ListAlertNotificationProfilesRequest +fields: +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} +- name: order + comment: |- + Order the results by this field path (must be present in the field mask). + Default ordering is by ID. Prepend with a minus (-) to reverse the order. + type: string + rules: + in: + - "" + - "profile_id" + - "-profile_id" + - "name" + - "-name" + - "created_at" + - "-created_at" + default: "" +- name: limit + comment: Limit the number of results per page. + type: uint32 + rules: + lte: 1000 + default: 0 +- name: page + comment: Page number for pagination. 0 is interpreted as 1. + type: uint32 + default: 0 diff --git a/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationReceiversRequest.yml b/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationReceiversRequest.yml new file mode 100644 index 0000000000..d0b5b8fa02 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationReceiversRequest.yml @@ -0,0 +1,32 @@ +name: ListAlertNotificationReceiversRequest +fields: +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} +- name: order + comment: |- + Order the results by this field path (must be present in the field mask). + Default ordering is by ID. Prepend with a minus (-) to reverse the order. + type: string + rules: + in: + - "" + - "receiver_id" + - "-receiver_id" + - "name" + - "-name" + - "created_at" + - "-created_at" + default: "" +- name: limit + comment: Limit the number of results per page. + type: uint32 + rules: + lte: 1000 + default: 0 +- name: page + comment: Page number for pagination. 0 is interpreted as 1. + type: uint32 + default: 0 diff --git a/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationProfileRequest.yml b/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationProfileRequest.yml new file mode 100644 index 0000000000..b3a801f0fa --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationProfileRequest.yml @@ -0,0 +1,13 @@ +name: UpdateAlertNotificationProfileRequest +fields: +- name: profile + message: + name: AlertNotificationProfile + rules: + required: true + default: {} +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationReceiverRequest.yml b/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationReceiverRequest.yml new file mode 100644 index 0000000000..b657e73fae --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationReceiverRequest.yml @@ -0,0 +1,13 @@ +name: UpdateAlertNotificationReceiverRequest +fields: +- name: receiver + message: + name: AlertNotificationReceiver + rules: + required: true + default: {} +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/services/AlertNotificationProfileRegistry.yml b/doc/data/api/tti.lorawan.v3/services/AlertNotificationProfileRegistry.yml new file mode 100644 index 0000000000..12aed31bda --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/services/AlertNotificationProfileRegistry.yml @@ -0,0 +1,69 @@ +name: AlertNotificationProfileRegistry +comment: |- + The AlertNotificationProfileRegistry service, exposed by the Identity Server. + Is used to manage alert notification profiles. +methods: + Create: + name: Create + comment: Create a new alert notification profile. + input: + name: CreateAlertNotificationProfileRequest + output: + name: AlertNotificationProfile + http: + - method: POST + path: /alerts/notifications/profiles + Get: + name: Get + comment: Get an existing alert notification profile. + input: + name: GetAlertNotificationProfileRequest + output: + name: AlertNotificationProfile + http: + - method: GET + path: /alerts/notifications/profiles/{ids.profile_id} + List: + name: List + comment: |- + List existing alert notification profiles. Returns all profiles if no identifiers are provided. + If provided, the identifiers are used to filter which profiles are returned. + input: + name: ListAlertNotificationProfilesRequest + output: + name: AlertNotificationProfiles + http: + - method: GET + path: /alerts/notifications/profiles + Update: + name: Update + comment: Update an existing alert notification profile. + input: + name: UpdateAlertNotificationProfileRequest + output: + name: AlertNotificationProfile + http: + - method: PUT + path: /alerts/notifications/profiles/{profile.ids.profile_id} + Delete: + name: Delete + comment: Delete an existing alert notification profile. + input: + package: ttn.lorawan.v3 + name: AlertNotificationProfileIdentifiers + output: + package: google.protobuf + name: Empty + http: + - method: DELETE + path: /alerts/notifications/profiles/{profile_id} + GetDefault: + name: GetDefault + comment: Get the default alert notification profile. + input: + name: GetDefaultAlertNotificationProfileRequest + output: + name: AlertNotificationProfile + http: + - method: GET + path: /alerts/notifications/profiles/default diff --git a/doc/data/api/tti.lorawan.v3/services/AlertNotificationReceiverRegistry.yml b/doc/data/api/tti.lorawan.v3/services/AlertNotificationReceiverRegistry.yml new file mode 100644 index 0000000000..f5880397e9 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/services/AlertNotificationReceiverRegistry.yml @@ -0,0 +1,57 @@ +name: AlertNotificationReceiverRegistry +comment: |- + The AlertNotificationReceiverRegistry service, exposed by the Identity Server. + Is used to manage alert notification receivers. +methods: + Create: + name: Create + comment: Create a new alert notification receiver. + input: + name: CreateAlertNotificationReceiverRequest + output: + name: AlertNotificationReceiver + http: + - method: POST + path: /alerts/notifications/receivers + Get: + name: Get + comment: Get an existing alert notification receiver. + input: + name: GetAlertNotificationReceiverRequest + output: + name: AlertNotificationReceiver + http: + - method: GET + path: /alerts/notifications/receivers/{ids.receiver_id} + List: + name: List + comment: List existing alert notification receivers. Returns all receivers if + no identifiers are provided. + input: + name: ListAlertNotificationReceiversRequest + output: + name: AlertNotificationReceivers + http: + - method: GET + path: /alerts/notifications/receivers + Update: + name: Update + comment: Update an existing alert notification receiver. + input: + name: UpdateAlertNotificationReceiverRequest + output: + name: AlertNotificationReceiver + http: + - method: PUT + path: /alerts/notifications/receivers/{receiver.ids.receiver_id} + Delete: + name: Delete + comment: Delete an existing alert notification receiver. + input: + name: AlertNotificationReceiverIdentifiers + output: + package: google.protobuf + name: Empty + http: + - method: DELETE + path: /alerts/notifications/receivers/{receiver_id} diff --git a/doc/data/api/ttn.lorawan.v3/messages/AlertNotificationProfileIdentifiers.yml b/doc/data/api/ttn.lorawan.v3/messages/AlertNotificationProfileIdentifiers.yml new file mode 100644 index 0000000000..681617a1c5 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/AlertNotificationProfileIdentifiers.yml @@ -0,0 +1,8 @@ +name: AlertNotificationProfileIdentifiers +fields: +- name: profile_id + type: string + rules: + max_len: 36 + pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$ + default: "" diff --git a/doc/data/commands/ttn-lw-cli.json b/doc/data/commands/ttn-lw-cli.json index 12ea6f53de..fc899944ca 100644 --- a/doc/data/commands/ttn-lw-cli.json +++ b/doc/data/commands/ttn-lw-cli.json @@ -3,6 +3,62 @@ "short": "The Things Industries Command-line Interface", "path": "ttn-lw-cli", "subCommands": { + "alert-notification-profiles": { + "short": "Alert Notification Profile commands (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles", + "subCommands": { + "create": { + "short": "Create an alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles create" + }, + "delete": { + "short": "Delete an alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles delete" + }, + "get": { + "short": "Get an alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles get" + }, + "get-default": { + "short": "Get default alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles get-default" + }, + "list": { + "short": "List alert notification profiles (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles list" + }, + "update": { + "short": "Update an alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles update" + } + } + }, + "alert-notification-receivers": { + "short": "Alert Notification Receiver commands (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers", + "subCommands": { + "create": { + "short": "Create an alert notification receiver (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers create" + }, + "delete": { + "short": "Delete an alert notification receiver (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers delete" + }, + "get": { + "short": "Get an alert notification receiver (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers get" + }, + "list": { + "short": "List alert notification receivers (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers list" + }, + "update": { + "short": "Update an alert notification receiver (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers update" + } + } + }, "applications": { "short": "Application commands", "path": "ttn-lw-cli applications", diff --git a/doc/data/ttn-lw-cli.yml b/doc/data/ttn-lw-cli.yml index b66cca0136..b488be16d6 100644 --- a/doc/data/ttn-lw-cli.yml +++ b/doc/data/ttn-lw-cli.yml @@ -102,6 +102,245 @@ ttn-lw-cli: type: bool usage: Do not perform version checks default_value: "false" +ttn-lw-cli alert-notification-profiles: + path: ttn-lw-cli alert-notification-profiles + parent_path: ttn-lw-cli + name: alert-notification-profiles + aliases: + - anp + - alert-profiles + short: Alert Notification Profile commands (EXPERIMENTAL) +ttn-lw-cli alert-notification-profiles create: + path: ttn-lw-cli alert-notification-profiles create + parent_path: ttn-lw-cli alert-notification-profiles + name: create + use: '[profile-id] [flags]' + aliases: + - add + - register + short: Create an alert notification profile (EXPERIMENTAL) + command_flags: + - name: description + type: string + - name: profile-id + type: string + - name: is-default + type: bool + - name: name + type: string + - name: receivers-ids + type: stringSlice + usage: key=value + default_value: '[]' +ttn-lw-cli alert-notification-profiles get: + path: ttn-lw-cli alert-notification-profiles get + parent_path: ttn-lw-cli alert-notification-profiles + name: get + use: '[profile-id] [flags]' + aliases: + - info + short: Get an alert notification profile (EXPERIMENTAL) + command_flags: + - name: description + type: bool + - name: profile-id + type: bool + - name: is-default + type: bool + - name: name + type: bool + - name: receivers-ids + type: bool +ttn-lw-cli alert-notification-profiles update: + path: ttn-lw-cli alert-notification-profiles update + parent_path: ttn-lw-cli alert-notification-profiles + name: update + use: '[profile-id] [flags]' + aliases: + - set + short: Update an alert notification profile (EXPERIMENTAL) + command_flags: + - name: description + type: string + - name: profile-id + type: string + - name: is-default + type: bool + - name: name + type: string + - name: receivers-ids + type: stringSlice + usage: key=value + default_value: '[]' +ttn-lw-cli alert-notification-profiles delete: + path: ttn-lw-cli alert-notification-profiles delete + parent_path: ttn-lw-cli alert-notification-profiles + name: delete + use: '[profile-id]' + short: Delete an alert notification profile (EXPERIMENTAL) +ttn-lw-cli alert-notification-profiles list: + path: ttn-lw-cli alert-notification-profiles list + parent_path: ttn-lw-cli alert-notification-profiles + name: list + use: '[flags]' + aliases: + - ls + short: List alert notification profiles (EXPERIMENTAL) + command_flags: + - name: description + type: bool + - name: profile-id + type: bool + - name: is-default + type: bool + - name: name + type: bool + - name: receivers-ids + type: bool + - name: limit + type: uint32 + usage: maximum number of results to get + default_value: "50" + - name: order + type: string + usage: order by this field + - name: page + type: uint32 + usage: results page number + default_value: "1" +ttn-lw-cli alert-notification-profiles get-default: + path: ttn-lw-cli alert-notification-profiles get-default + parent_path: ttn-lw-cli alert-notification-profiles + name: get-default + use: '[flags]' + aliases: + - default + short: Get default alert notification profile (EXPERIMENTAL) + command_flags: + - name: description + type: bool + - name: profile-id + type: bool + - name: is-default + type: bool + - name: name + type: bool + - name: receivers-ids + type: bool +ttn-lw-cli alert-notification-receivers: + path: ttn-lw-cli alert-notification-receivers + parent_path: ttn-lw-cli + name: alert-notification-receivers + aliases: + - anp + - alert-receivers + short: Alert Notification receiver commands (EXPERIMENTAL) +ttn-lw-cli alert-notification-receivers create: + path: ttn-lw-cli alert-notification-receivers create + parent_path: ttn-lw-cli alert-notification-receivers + name: create + use: '[receiver-id] [flags]' + aliases: + - add + - register + short: Create an alert notification receiver (EXPERIMENTAL) + command_flags: + - name: contact-method.email.recipient + type: string + - name: contact-method.sms.phone-number + type: string + - name: contact-method.webhook.headers + type: stringToString + - name: contact-method.webhook.url + type: string + - name: name + type: string + - name: receiver-id + type: string +ttn-lw-cli alert-notification-receivers get: + path: ttn-lw-cli alert-notification-receivers get + parent_path: ttn-lw-cli alert-notification-receivers + name: get + use: '[receiver-id] [flags]' + aliases: + - info + short: Get an alert notification receiver (EXPERIMENTAL) + command_flags: + - name: contact-method.email + type: bool + - name: contact-method.email.recipient + type: bool + - name: contact-method.sms + type: bool + - name: contact-method.sms.phone-number + type: bool + - name: contact-method.webhook + type: bool + - name: contact-method.webhook.headers + type: bool + - name: contact-method.webhook.url + type: bool + - name: name + type: bool + - name: receiver-id + type: bool +ttn-lw-cli alert-notification-receivers update: + path: ttn-lw-cli alert-notification-receivers update + parent_path: ttn-lw-cli alert-notification-receivers + name: update + use: '[receiver-id] [flags]' + aliases: + - set + short: Update an alert notification receiver (EXPERIMENTAL) + command_flags: + - name: contact-method.email.recipient + type: string + - name: contact-method.sms.phone-number + type: string + - name: contact-method.webhook.headers + type: stringToString + - name: contact-method.webhook.url + type: string + - name: name + type: string + - name: receiver-id + type: string +ttn-lw-cli alert-notification-receivers delete: + path: ttn-lw-cli alert-notification-receivers delete + parent_path: ttn-lw-cli alert-notification-receivers + name: delete + use: '[receiver-id]' + short: Delete an alert notification receiver (EXPERIMENTAL) +ttn-lw-cli alert-notification-receivers list: + path: ttn-lw-cli alert-notification-receivers list + parent_path: ttn-lw-cli alert-notification-receivers + name: list + use: '[flags]' + aliases: + - ls + short: List alert notification receivers (EXPERIMENTAL) + command_flags: + - name: description + type: bool + - name: receiver-id + type: bool + - name: is-default + type: bool + - name: name + type: bool + - name: receivers-ids + type: bool + - name: limit + type: uint32 + usage: maximum number of results to get + default_value: "50" + - name: order + type: string + usage: order by this field + - name: page + type: uint32 + usage: results page number + default_value: "1" ttn-lw-cli applications: path: ttn-lw-cli applications parent_path: ttn-lw-cli