Skip to content

Commit

Permalink
Alert notification API (#1202)
Browse files Browse the repository at this point in the history
* 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](grpc/grpc-go@v1.54.0...v1.56.3)

---
updated-dependencies:
- dependency-name: google.golang.org/grpc
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
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](golang/image@v0.7.0...v0.10.0)

---
updated-dependencies:
- dependency-name: golang.org/x/image
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
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] <[email protected]>
Co-authored-by: Nejra Selimović <[email protected]>
Co-authored-by: Krishna Iyer <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
4 people committed Jan 17, 2024
1 parent 509d016 commit 0a7b682
Show file tree
Hide file tree
Showing 43 changed files with 1,639 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/content/reference/api/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down
58 changes: 58 additions & 0 deletions doc/content/reference/api/identity_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down Expand Up @@ -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" >}}
Expand Down
2 changes: 2 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
62 changes: 62 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles.md
Original file line number Diff line number Diff line change
@@ -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)

Original file line number Diff line number Diff line change
@@ -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)

Original file line number Diff line number Diff line change
@@ -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)

Loading

0 comments on commit 0a7b682

Please sign in to comment.