Package com.symphony.bdk.gen.api

Class SignalsApi

java.lang.Object
com.symphony.bdk.gen.api.SignalsApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-26T16:14:53.869723549Z[Etc/UTC]") public class SignalsApi extends Object

  • Constructor Details

    • SignalsApi

      public SignalsApi(com.symphony.bdk.http.api.ApiClient apiClient)

  • Method Details

    • getApiClient

      public com.symphony.bdk.http.api.ApiClient getApiClient()
      Get the API cilent
      Returns:
      API client

    • setApiClient

      public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
      Set the API cilent
      Parameters:
      apiClient - an instance of API client

    • v1InfoGet

      public AgentInfo v1InfoGet() throws com.symphony.bdk.http.api.ApiException
      Get information about the Agent
      Returns:
      AgentInfo
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1InfoGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<AgentInfo> v1InfoGetWithHttpInfo() throws com.symphony.bdk.http.api.ApiException
      Get information about the Agent
      Returns:
      ApiResponse<AgentInfo>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsCreatePost

      public Signal v1SignalsCreatePost(String sessionToken, BaseSignal signal, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Create a signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      signal - Signal definition. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      Returns:
      Signal
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsCreatePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Signal> v1SignalsCreatePostWithHttpInfo(String sessionToken, BaseSignal signal, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Create a signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      signal - Signal definition. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      Returns:
      ApiResponse<Signal>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdDeletePost

      public SuccessResponse v1SignalsIdDeletePost(String sessionToken, String id, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Delete a signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      Returns:
      SuccessResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdDeletePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1SignalsIdDeletePostWithHttpInfo(String sessionToken, String id, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Delete a signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      Returns:
      ApiResponse<SuccessResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdGetGet

      public Signal v1SignalsIdGetGet(String sessionToken, String id, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Get details of the requested signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The ID of the signal to display. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      Returns:
      Signal
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdGetGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Signal> v1SignalsIdGetGetWithHttpInfo(String sessionToken, String id, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Get details of the requested signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The ID of the signal to display. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      Returns:
      ApiResponse<Signal>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdSubscribePost

      public ChannelSubscriptionResponse v1SignalsIdSubscribePost(String sessionToken, String id, String keyManagerToken, Boolean pushed, List<Long> users) throws com.symphony.bdk.http.api.ApiException
      Subscribe to a Signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      pushed - Prevent the user to unsubscribe (only for bulk subscription) (optional)
      users - UserIds to subscribe (only for bulk subscription) (optional)
      Returns:
      ChannelSubscriptionResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdSubscribePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<ChannelSubscriptionResponse> v1SignalsIdSubscribePostWithHttpInfo(String sessionToken, String id, String keyManagerToken, Boolean pushed, List<Long> users) throws com.symphony.bdk.http.api.ApiException
      Subscribe to a Signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      pushed - Prevent the user to unsubscribe (only for bulk subscription) (optional)
      users - UserIds to subscribe (only for bulk subscription) (optional)
      Returns:
      ApiResponse<ChannelSubscriptionResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdSubscribersGet

      public ChannelSubscriberResponse v1SignalsIdSubscribersGet(String sessionToken, String id, String keyManagerToken, Integer skip, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get the subscribers of a signal
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      skip - No. of results to skip. (optional, default to 0)
      limit - Max No. of subscribers to return. If no value is provided, 100 is the default. (optional, default to 100)
      Returns:
      ChannelSubscriberResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdSubscribersGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<ChannelSubscriberResponse> v1SignalsIdSubscribersGetWithHttpInfo(String sessionToken, String id, String keyManagerToken, Integer skip, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get the subscribers of a signal
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      skip - No. of results to skip. (optional, default to 0)
      limit - Max No. of subscribers to return. If no value is provided, 100 is the default. (optional, default to 100)
      Returns:
      ApiResponse<ChannelSubscriberResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdUnsubscribePost

      public ChannelSubscriptionResponse v1SignalsIdUnsubscribePost(String sessionToken, String id, String keyManagerToken, List<Long> users) throws com.symphony.bdk.http.api.ApiException
      Unsubscribe to a Signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      users - UserIds to unsubscribe (only for bulk unsubscription) (optional)
      Returns:
      ChannelSubscriptionResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdUnsubscribePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<ChannelSubscriptionResponse> v1SignalsIdUnsubscribePostWithHttpInfo(String sessionToken, String id, String keyManagerToken, List<Long> users) throws com.symphony.bdk.http.api.ApiException
      Unsubscribe to a Signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      users - UserIds to unsubscribe (only for bulk unsubscription) (optional)
      Returns:
      ApiResponse<ChannelSubscriptionResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdUpdatePost

      public Signal v1SignalsIdUpdatePost(String sessionToken, String id, BaseSignal signal, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Update a signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      signal - Signal definition. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      Returns:
      Signal
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsIdUpdatePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Signal> v1SignalsIdUpdatePostWithHttpInfo(String sessionToken, String id, BaseSignal signal, String keyManagerToken) throws com.symphony.bdk.http.api.ApiException
      Update a signal.
      Parameters:
      sessionToken - Session authentication token. (required)
      id - The id of the signal. (required)
      signal - Signal definition. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      Returns:
      ApiResponse<Signal>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsListGet

      public List<Signal> v1SignalsListGet(String sessionToken, String keyManagerToken, Integer skip, Integer limit) throws com.symphony.bdk.http.api.ApiException
      List signals for the requesting user. This includes signals that the user has created and public signals to which they subscribed.
      Parameters:
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      skip - No. of signals to skip. (optional)
      limit - Max no. of signals to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      List<Signal>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1SignalsListGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<List<Signal>> v1SignalsListGetWithHttpInfo(String sessionToken, String keyManagerToken, Integer skip, Integer limit) throws com.symphony.bdk.http.api.ApiException
      List signals for the requesting user. This includes signals that the user has created and public signals to which they subscribed.
      Parameters:
      sessionToken - Session authentication token. (required)
      keyManagerToken - Key Manager authentication token. (optional)
      skip - No. of signals to skip. (optional)
      limit - Max no. of signals to return. If no value is provided, 50 is the default. The maximum supported value is 500. (optional)
      Returns:
      ApiResponse<List<Signal>>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call