diff --git a/README.md b/README.md index cc6d57fe..3809efb6 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # Symphony BDK for Python -This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://developers.symphony.com/restapi/reference). +This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://rest-api.symphony.com). ## Project Overview diff --git a/docsrc/index.md b/docsrc/index.md index 57112758..447e8513 100644 --- a/docsrc/index.md +++ b/docsrc/index.md @@ -33,7 +33,7 @@ Contents This reference guide provides detailed information about the [Symphony BDK](https://github.com/finos/symphony-bdk-python). It provides a comprehensive documentation for all features and abstractions made on top of the -[Symphony REST API](https://developers.symphony.com/restapi/reference). +[Symphony REST API](https://rest-api.symphony.com). If you are just getting started with Symphony Bot developments, you may want to begin reading the [Getting Started](markdown/getting_started.md) guide. diff --git a/docsrc/markdown/configuration.md b/docsrc/markdown/configuration.md index 8ca06665..5c649859 100644 --- a/docsrc/markdown/configuration.md +++ b/docsrc/markdown/configuration.md @@ -118,6 +118,8 @@ retry: initialIntervalMillis: 2000 multiplier: 1.5 maxIntervalMillis: 10000 + +manifest: path/to/manifest.json ``` ### Configuration structure diff --git a/docsrc/markdown/health_service.md b/docsrc/markdown/health_service.md index b36c0fc5..7d2286d3 100644 --- a/docsrc/markdown/health_service.md +++ b/docsrc/markdown/health_service.md @@ -1,9 +1,9 @@ # Health service -The Health Service is a component at the service layer of the BDK which covers the Health Service part of the [REST API documentation](https://developers.symphony.com/restapi/reference). +The Health Service is a component at the service layer of the BDK which covers the Health Service part of the [REST API documentation](https://rest-api.symphony.com/main/info-health-check). More precisely: -* [Health check](https://developers.symphony.com/restapi/reference/health-check-v3) -* [Health check extended](https://developers.symphony.com/restapi/reference/health-check-extended-v3) -* [Agent info](https://developers.symphony.com/restapi/reference/agent-info-v1) +* [Health check](https://rest-api.symphony.com/main/info-health-check/health-check-v3) +* [Health check extended](https://rest-api.symphony.com/main/info-health-check/health-check-extended-v3) +* [Agent info](https://rest-api.symphony.com/main/info-health-check/agent-info-v1) ## How to use diff --git a/docsrc/markdown/session_service.md b/docsrc/markdown/session_service.md index a16e6faa..39b9501e 100644 --- a/docsrc/markdown/session_service.md +++ b/docsrc/markdown/session_service.md @@ -1,7 +1,7 @@ # Session service -The Session Service is a component at the service layer of the BDK which covers the Session part of the [REST API documentation](https://developers.symphony.com/restapi/reference). +The Session Service is a component at the service layer of the BDK which covers the Session part of the [REST API documentation](https://developers.symphony.com/restapi). More precisely: -* [Get session](https://developers.symphony.com/restapi/reference/session-info-v2) +* [Get session](https://rest-api.symphony.com/main/info-health-check/session-info-v2) ## How to use diff --git a/docsrc/markdown/stream_service.md b/docsrc/markdown/stream_service.md index bd66bbac..d3beafb1 100644 --- a/docsrc/markdown/stream_service.md +++ b/docsrc/markdown/stream_service.md @@ -21,6 +21,7 @@ More precisely: * [List user streams](https://rest-api.symphony.com/main/streams-conversations/all-streams-endpoints/list-user-streams) * [List stream members](https://rest-api.symphony.com/main/streams-conversations/all-streams-endpoints/stream-members) * [List room members](https://rest-api.symphony.com/main/streams-conversations/room-endpoints/room-members) +* [List user streams (admin)](https://rest-api.symphony.com/main/streams-conversations/all-streams-endpoints/list-user-streams-admin) ## How to use The central component for the Message Service is the `StreamService` class. diff --git a/docsrc/markdown/user_service.md b/docsrc/markdown/user_service.md index 8f156291..3646be6f 100644 --- a/docsrc/markdown/user_service.md +++ b/docsrc/markdown/user_service.md @@ -1,36 +1,38 @@ # User service -The User Service is a component at the service layer of the BDK which covers the User part of the [REST API documentation](https://developers.symphony.com/restapi/reference). +The User Service is a component at the service layer of the BDK which covers the User part of the [REST API documentation](https://rest-api.symphony.com/main/user-management). More precisely: -* [Create user](https://developers.symphony.com/restapi/reference/create-user-v2) -* [Update user](https://developers.symphony.com/restapi/reference/update-user-v2) -* [Suspend user](https://developers.symphony.com/restapi/v20.10/reference/suspend-user-v1) -* [Unsuspend user](https://developers.symphony.com/restapi/v20.10/reference/suspend-user-v1) -* [Get user details](https://developers.symphony.com/restapi/reference/get-user-v2) -* [List all user details](https://developers.symphony.com/restapi/reference/list-users-v2) -* [List users by ids](https://developers.symphony.com/restapi/reference/users-lookup-v3) -* [List users by emails](https://developers.symphony.com/restapi/reference/users-lookup-v3) -* [List users by usernames](https://developers.symphony.com/restapi/reference/users-lookup-v3) -* [Search users](https://developers.symphony.com/restapi/reference/search-users) -* [Find users by filter](https://developers.symphony.com/restapi/reference/find-users) -* [Add role to user](https://developers.symphony.com/restapi/reference/add-role) -* [List roles](https://developers.symphony.com/restapi/reference/list-roles) -* [Remove a role](https://developers.symphony.com/restapi/reference/remove-role) -* [Get avatar](https://developers.symphony.com/restapi/reference/user-avatar) -* [Update avatar](https://developers.symphony.com/restapi/reference/update-user-avatar) -* [Get disclaimer](https://developers.symphony.com/restapi/reference/user-disclaimer) -* [Remove disclaimer](https://developers.symphony.com/restapi/reference/unassign-user-disclaimer) -* [Add disclaimer](https://developers.symphony.com/restapi/reference/update-disclaimer) -* [Get user delegates](https://developers.symphony.com/restapi/reference/delegates) -* [Update user delegates](https://developers.symphony.com/restapi/reference/update-delegates) -* [Get feature entitlements for a user](https://developers.symphony.com/restapi/reference/features) -* [Update feature entitlements for a user](https://developers.symphony.com/restapi/reference/update-features) -* [Get user status](https://developers.symphony.com/restapi/reference/user-status) -* [Update user status](https://developers.symphony.com/restapi/reference/update-user-status) -* [Follow a user](https://developers.symphony.com/restapi/reference/follow-user) -* [Unfollow a user](https://developers.symphony.com/restapi/reference/unfollow-user) -* [List user followers](https://developers.symphony.com/restapi/reference/list-user-followers) -* [List followed users](https://developers.symphony.com/restapi/reference/list-users-followed) -* [List audit trail](https://developers.symphony.com/restapi/reference/list-audit-trail-v1) +* [Create user](https://rest-api.symphony.com/main/user-management/create-user-v2) +* [Update user](https://rest-api.symphony.com/main/user-management/update-user-v2) +* [Suspend user](https://rest-api.symphony.com/v20.10/main/user-management/suspend-user-v1) +* [Unsuspend user](https://rest-api.symphony.com/v20.10/main/user-management/suspend-user-v1) +* [Get user details](https://rest-api.symphony.com/main/user-management/get-user-v2) +* [List all user details](https://rest-api.symphony.com/main/user-management/list-users-v2) +* [List users by ids](https://rest-api.symphony.com/main/user-management/users-lookup-v3) +* [List users by emails](https://rest-api.symphony.com/main/user-management/users-lookup-v3) +* [List users by usernames](https://rest-api.symphony.com/main/user-management/users-lookup-v3) +* [Search users](https://rest-api.symphony.com/main/user-management/search-users) +* [Find users by filter](https://rest-api.symphony.com/main/user-management/find-users) +* [Add role to user](https://rest-api.symphony.com/main/user-management/add-role) +* [List roles](https://rest-api.symphony.com/main/user-management/list-roles) +* [Remove a role](https://rest-api.symphony.com/main/user-management/remove-role) +* [Get avatar](https://rest-api.symphony.com/main/user-management/user-avatar) +* [Update avatar](https://rest-api.symphony.com/main/user-management/update-user-avatar) +* [Get disclaimer](https://rest-api.symphony.com/main/user-management/user-disclaimer) +* [Remove disclaimer](https://rest-api.symphony.com/main/user-management/unassign-user-disclaimer) +* [Add disclaimer](https://rest-api.symphony.com/main/user-management/update-disclaimer) +* [Get user delegates](https://rest-api.symphony.com/main/user-management/delegates) +* [Update user delegates](https://rest-api.symphony.com/main/user-management/update-delegates) +* [Get feature entitlements for a user](https://rest-api.symphony.com/main/user-management/features) +* [Update feature entitlements for a user](https://rest-api.symphony.com/main/user-management/update-features) +* [Get user status](https://rest-api.symphony.com/main/user-management/user-status) +* [Update user status](https://rest-api.symphony.com/main/user-management/update-user-status) +* [Follow a user](https://rest-api.symphony.com/main/user-management/follow-user) +* [Unfollow a user](https://rest-api.symphony.com/main/user-management/unfollow-user) +* [List user followers](https://rest-api.symphony.com/main/user-management/list-user-followers) +* [List followed users](https://rest-api.symphony.com/main/user-management/list-users-followed) +* [List audit trail](https://rest-api.symphony.com/main/user-management/list-audit-trail-v1) +* [Get user manifest](https://rest-api.symphony.com/main/user-management/user-manifest) +* [Update user manifest](https://rest-api.symphony.com/main/user-management/update-user-manifest) ## How to use