Skip to content

Commit

Permalink
chore(docs): update Appointment Manager documentation (#1616)
Browse files Browse the repository at this point in the history
* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation

* chore(docs): update Appointment Manager documentation
  • Loading branch information
bot-targa authored Sep 17, 2024
1 parent 0ee383d commit 54660d0
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/runtime_suite/appointment-manager/20_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ If you are looking for instructions to configure the service in appointments or

:::info

**v2.4.0**
Since v2.4.0 a new service configuration field is supported: `isNotificationManagerAsync`.

The `isNotificationManagerAsync` configuration field, disabled by default, allows you to send notification through the [Notification Manager][notification-manager-doc] asynchronously.

:::

:::info

**v2.3.0**
Since v2.3.0 a new service configuration field is supported: `isNotificationManagerAvailable`.

Expand Down Expand Up @@ -119,6 +128,7 @@ A reference presentation of each available field is provided in the following ta
| `isTeleconsultationAvailable` | No | `false` | If the teleconsultation service is available, enable the integration to generate teleconsultation links. |
| `isMessagingAvailable` | No | `false` | If the messaging service is available, enable the integration to send messages and reminders. |
| `isNotificationManagerAvailable` | No | `false` | If the [Notification Manager][notification-manager-doc] service is available, enable the integration to send messages and set reminders. |
| `isNotificationManagerAsync` | No | `false` | If the call to the [Notification Manager][notification-manager-doc] should be executed asynchronously |
| `isTimerAvailable` | No | `false` | If the timer service is available, enable the integration to set reminders. |
| `isUserAvailable` | No | `false` | If the resources crud path is available, enable to recover resource's information for `POST /searches/first-available-slot/` endpoint. |
| `isFlexibleSlotAvailable` | No | `false` | If you can create availabilities without setting a fixed slot duration. |
Expand All @@ -127,6 +137,13 @@ A reference presentation of each available field is provided in the following ta

:::danger

**v2.4.0**
If the configuration filed `isNotificationManagerAsync` is set to true the call to the [Notification Manager][notification-manager-doc] is no longer awaited. If any errors occur during the sending of the notification they will not be present in `errors` array of the response.

:::

:::danger

**v2.3.0**
Starting with version 2.3.0, you can choose if you want to send messages and reminders using the [Messaging Service][messaging-service-doc] or the [Notification Manager][notification-manager-doc], but you can't have them both enabled, so if you set both the `isMessagingAvailable` and `isNotificationManagerAvailable` configuration fields to `true`, the AM service returns an error on startup.

Expand Down
8 changes: 8 additions & 0 deletions docs/runtime_suite/appointment-manager/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.4.0] 2024-08-29

- Update Node.js to v20 (LTS)

### Added

- Add configuration option `isNotificationManagerAsync` that allows to send Notification Manager notification asynchronously

## [2.3.0] 2023-10-03

### Added
Expand Down

0 comments on commit 54660d0

Please sign in to comment.