|
| 1 | +from symphony.bdk.core.auth.auth_session import AuthSession |
| 2 | +from symphony.bdk.gen.agent_api.signals_api import SignalsApi |
| 3 | +from symphony.bdk.gen.agent_model.base_signal import BaseSignal |
| 4 | +from symphony.bdk.gen.agent_model.channel_subscriber import ChannelSubscriber |
| 5 | +from symphony.bdk.gen.agent_model.channel_subscription_response import ChannelSubscriptionResponse |
| 6 | +from symphony.bdk.gen.agent_model.signal import Signal |
| 7 | +from symphony.bdk.gen.agent_model.signal_list import SignalList |
| 8 | + |
| 9 | + |
| 10 | +class OboSignalService: |
| 11 | + """Service class exposing OBO-enabled endpoints to manage signal information. |
| 12 | +
|
| 13 | + This service is used for listing signals related to the OBO user, get information of a specified signal |
| 14 | + or perform some actions related to the signal like: |
| 15 | +
|
| 16 | + * List signals |
| 17 | + * Get a signal |
| 18 | + * Create a signal |
| 19 | + * Update a signal |
| 20 | + * Delete a signal |
| 21 | + * Subscribe or unsubscribe a signal |
| 22 | + """ |
| 23 | + |
| 24 | + def __init__(self, signals_api: SignalsApi, auth_session: AuthSession): |
| 25 | + self._signals_api = signals_api |
| 26 | + self._auth_session = auth_session |
| 27 | + |
| 28 | + async def list_signals(self, skip: int = 0, limit: int = 50) -> SignalList: |
| 29 | + """ Lists signals on behalf of the user. The response includes signals that the user has created and |
| 30 | + public signals to which they have subscribed. |
| 31 | +
|
| 32 | + See: 'List signals <https://developers.symphony.com/restapi/reference#list-signals>'_ |
| 33 | +
|
| 34 | + :param skip: The number of signals to skip. |
| 35 | + :param limit: Maximum number of signals to return. Default is 50, maximum value is 500. |
| 36 | + :return: List of signals found. |
| 37 | + """ |
| 38 | + |
| 39 | + return await self._signals_api.v1_signals_list_get( |
| 40 | + skip=skip, limit=limit, session_token=await self._auth_session.session_token, |
| 41 | + key_manager_token=await self._auth_session.key_manager_token) |
| 42 | + |
| 43 | + async def get_signal(self, signal_id: str) -> Signal: |
| 44 | + """ Gets details about the specified signal. |
| 45 | +
|
| 46 | + See: 'Get signal <https://developers.symphony.com/restapi/reference#get-signal>'_ |
| 47 | +
|
| 48 | + :param signal_id: Id of the signal to display. |
| 49 | + :return: The signal found. |
| 50 | + """ |
| 51 | + |
| 52 | + return await self._signals_api.v1_signals_id_get_get( |
| 53 | + id=signal_id, session_token=await self._auth_session.session_token, |
| 54 | + key_manager_token=await self._auth_session.key_manager_token) |
| 55 | + |
| 56 | + async def create_signal(self, signal: BaseSignal) -> Signal: |
| 57 | + """ Creates a new Signal. |
| 58 | +
|
| 59 | + See: 'Create signal <https://developers.symphony.com/restapi/reference#create-signal>'_ |
| 60 | +
|
| 61 | + :param signal: The new Signal object to be created. |
| 62 | + :return: The signal created. |
| 63 | + """ |
| 64 | + |
| 65 | + return await self._signals_api.v1_signals_create_post( |
| 66 | + signal=signal, session_token=await self._auth_session.session_token, |
| 67 | + key_manager_token=await self._auth_session.key_manager_token) |
| 68 | + |
| 69 | + async def update_signal(self, signal_id: str, signal: BaseSignal) -> Signal: |
| 70 | + """ Updates an existing Signal. |
| 71 | +
|
| 72 | + See: 'Update signal <https://developers.symphony.com/restapi/reference#update-signal>'_ |
| 73 | +
|
| 74 | + :param signal_id: The Id of the signal to be modified. |
| 75 | + :param signal: The Signal object to be updated. |
| 76 | + :return: The updated signal. |
| 77 | + """ |
| 78 | + |
| 79 | + return await self._signals_api.v1_signals_id_update_post( |
| 80 | + id=signal_id, signal=signal, session_token=await self._auth_session.session_token, |
| 81 | + key_manager_token=await self._auth_session.key_manager_token) |
| 82 | + |
| 83 | + async def delete_signal(self, signal_id: str) -> None: |
| 84 | + """ Deletes an existing Signal. |
| 85 | +
|
| 86 | + See: 'Delete signal <https://developers.symphony.com/restapi/reference#delete-signal>'_ |
| 87 | +
|
| 88 | + :param signal_id: The Id of the existing signal to be deleted. |
| 89 | + """ |
| 90 | + |
| 91 | + return await self._signals_api.v1_signals_id_delete_post( |
| 92 | + id=signal_id, session_token=await self._auth_session.session_token, |
| 93 | + key_manager_token=await self._auth_session.key_manager_token) |
| 94 | + |
| 95 | + async def subscribe_users_to_signal(self, signal_id: str, pushed: bool, |
| 96 | + user_ids: [int]) -> ChannelSubscriptionResponse: |
| 97 | + """ Subscribe an array of users to a Signal. |
| 98 | +
|
| 99 | + See: 'Subscribe signal <https://developers.symphony.com/restapi/reference#subscribe-signal>'_ |
| 100 | +
|
| 101 | + :param signal_id: The Id of the signal to be subscribed. |
| 102 | + :param pushed: Prevents the user from unsubscribing from the Signal |
| 103 | + :param user_ids: An array of User Ids to subscribe to the Signal |
| 104 | + :return: Result of the bulk subscriptions |
| 105 | + """ |
| 106 | + |
| 107 | + return await self._signals_api.v1_signals_id_subscribe_post( |
| 108 | + id=signal_id, pushed=pushed, users=user_ids, session_token=await self._auth_session.session_token, |
| 109 | + key_manager_token=await self._auth_session.key_manager_token) |
| 110 | + |
| 111 | + async def unsubscribe_users_to_signal(self, signal_id: str, user_ids: [int]) -> ChannelSubscriptionResponse: |
| 112 | + """ Unsubscribes an array of users from the specified Signal. |
| 113 | +
|
| 114 | + See: 'Unsubscribe signal <https://developers.symphony.com/restapi/reference#unsubscribe-signal>'_ |
| 115 | +
|
| 116 | + :param signal_id: The Id of the signal to be subscribed. |
| 117 | + :param user_ids: An array of User Ids to subscribe to the Signal |
| 118 | + :return: Result of the bulk unsubscriptions |
| 119 | + """ |
| 120 | + |
| 121 | + return await self._signals_api.v1_signals_id_unsubscribe_post( |
| 122 | + id=signal_id, users=user_ids, session_token=await self._auth_session.session_token, |
| 123 | + key_manager_token=await self._auth_session.key_manager_token) |
| 124 | + |
| 125 | + async def list_subscribers(self, signal_id: str, skip: int = 0, limit: int = 50) -> [ChannelSubscriber]: |
| 126 | + """ Gets the subscribers for the specified signal. |
| 127 | +
|
| 128 | + See: 'Subscribers <https://developers.symphony.com/restapi/reference#subscribers>'_ |
| 129 | +
|
| 130 | + :param signal_id: The Id of the signal. |
| 131 | + :param skip: The number of results to skip. |
| 132 | + :param limit: The maximum number of subscribers to return. The maximum value accepted for this parameter is 100 |
| 133 | + and the default value is 50. |
| 134 | + :return: The list of users subscribed to the signal. |
| 135 | + """ |
| 136 | + |
| 137 | + return await self._signals_api.v1_signals_id_subscribers_get( |
| 138 | + id=signal_id, skip=skip, limit=limit, session_token=await self._auth_session.session_token, |
| 139 | + key_manager_token=await self._auth_session.key_manager_token) |
| 140 | + |
| 141 | + |
| 142 | +class SignalService(OboSignalService): |
| 143 | + """Service class for managing signal information. |
| 144 | + This service is used for listing signals related to the user, get information of a specified signal |
| 145 | + or perform some actions related to the signal like: |
| 146 | +
|
| 147 | + * List signals |
| 148 | + * Get a signal |
| 149 | + * Create a signal |
| 150 | + * Update a signal |
| 151 | + * Delete a signal |
| 152 | + * Subscribe or unsubscribe a signal |
| 153 | + """ |
0 commit comments