Package com.symphony.bdk.gen.api

Class DefaultApi

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

  • Constructor Details

    • DefaultApi

      public DefaultApi(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

    • deleteAllowedFileExtension

      public void deleteAllowedFileExtension(String sessionToken, String extension) throws com.symphony.bdk.http.api.ApiException
      Allows deletion of a specific file extension supported for upload Provides a method to delete a specific file extension configured for upload support via an admin. The file extension identifying the resource is treated case-insensitively by the API.
      Parameters:
      sessionToken - Session authentication token. (required)
      extension - (required)
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • deleteAllowedFileExtensionWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Void> deleteAllowedFileExtensionWithHttpInfo(String sessionToken, String extension) throws com.symphony.bdk.http.api.ApiException
      Allows deletion of a specific file extension supported for upload Provides a method to delete a specific file extension configured for upload support via an admin. The file extension identifying the resource is treated case-insensitively by the API.
      Parameters:
      sessionToken - Session authentication token. (required)
      extension - (required)
      Returns:
      ApiResponse<Void>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • listAllowedFileExtensions

      public FileExtensionsResponse listAllowedFileExtensions(Integer limit, String before, String after) throws com.symphony.bdk.http.api.ApiException
      Allows iteration of all file extensions supported for upload Provides a RESTful API to iterate all file extensions configured by the tenant admin that are allowed for the upload. Pagination of this list is managed through a combination of the optional request parameters and service-side managed maximums. Pagination of the results is provided through the before or after input paramters and presented through the opaque cursor values provided as output from a previous response. Only one of before or after or neither may be provided. DO NOT store cursors. Cursors can quickly become invalid if items are added or deleted. Use them only during a short-period of time that you are traversing the list.
      Parameters:
      limit - This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering or service-side maximums. Do not depend on the number of results being fewer than the limit value to indicate your query reached the end of the list of data, use the absence of next instead as described below. For example, if you set limit to 10 and 9 results are returned, there may be more data available, but one item was removed due to privacy filtering. Some maximums for limit may be enforced for performance reasons. In all cases, the API returns the correct pagination links. (optional)
      before - Returns results from an opaque \"before\" cursor value as presented via a response cursor (optional)
      after - Returns results from an opaque \"after\" cursor value as presented via a response cursor (optional)
      Returns:
      FileExtensionsResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • listAllowedFileExtensionsWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<FileExtensionsResponse> listAllowedFileExtensionsWithHttpInfo(Integer limit, String before, String after) throws com.symphony.bdk.http.api.ApiException
      Allows iteration of all file extensions supported for upload Provides a RESTful API to iterate all file extensions configured by the tenant admin that are allowed for the upload. Pagination of this list is managed through a combination of the optional request parameters and service-side managed maximums. Pagination of the results is provided through the before or after input paramters and presented through the opaque cursor values provided as output from a previous response. Only one of before or after or neither may be provided. DO NOT store cursors. Cursors can quickly become invalid if items are added or deleted. Use them only during a short-period of time that you are traversing the list.
      Parameters:
      limit - This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering or service-side maximums. Do not depend on the number of results being fewer than the limit value to indicate your query reached the end of the list of data, use the absence of next instead as described below. For example, if you set limit to 10 and 9 results are returned, there may be more data available, but one item was removed due to privacy filtering. Some maximums for limit may be enforced for performance reasons. In all cases, the API returns the correct pagination links. (optional)
      before - Returns results from an opaque \"before\" cursor value as presented via a response cursor (optional)
      after - Returns results from an opaque \"after\" cursor value as presented via a response cursor (optional)
      Returns:
      ApiResponse<FileExtensionsResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • putAllowedFileExtension

      public FileExtension putAllowedFileExtension(String sessionToken, String extension, FileExtension v3FileExtension) throws com.symphony.bdk.http.api.ApiException
      Allows replacement or creation of a specific file extension supported for upload Provides a method to create or replace a specific file extension configured for upload support via an admin. The API treats the file extension in the path case-insensitively by converting it to lowecase.
      Parameters:
      sessionToken - Session authentication token. (required)
      extension - (required)
      v3FileExtension - (required)
      Returns:
      FileExtension
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • putAllowedFileExtensionWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<FileExtension> putAllowedFileExtensionWithHttpInfo(String sessionToken, String extension, FileExtension v3FileExtension) throws com.symphony.bdk.http.api.ApiException
      Allows replacement or creation of a specific file extension supported for upload Provides a method to create or replace a specific file extension configured for upload support via an admin. The API treats the file extension in the path case-insensitively by converting it to lowecase.
      Parameters:
      sessionToken - Session authentication token. (required)
      extension - (required)
      v3FileExtension - (required)
      Returns:
      ApiResponse<FileExtension>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1AdminMessagesMessageIdMetadataRelationshipsGet

      public MessageMetadataResponse v1AdminMessagesMessageIdMetadataRelationshipsGet(String sessionToken, String userAgent, String messageId) throws com.symphony.bdk.http.api.ApiException
      Get the message metadata relationship
      Parameters:
      sessionToken - Session authentication token. (required)
      userAgent - Request user agent. (required)
      messageId - Valid id of a SOCIALMESSAGE (required)
      Returns:
      MessageMetadataResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1AdminMessagesMessageIdMetadataRelationshipsGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<MessageMetadataResponse> v1AdminMessagesMessageIdMetadataRelationshipsGetWithHttpInfo(String sessionToken, String userAgent, String messageId) throws com.symphony.bdk.http.api.ApiException
      Get the message metadata relationship
      Parameters:
      sessionToken - Session authentication token. (required)
      userAgent - Request user agent. (required)
      messageId - Valid id of a SOCIALMESSAGE (required)
      Returns:
      ApiResponse<MessageMetadataResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1AdminMessagesMessageIdReceiptsGet

      public MessageReceiptDetailResponse v1AdminMessagesMessageIdReceiptsGet(String sessionToken, String messageId, String before, String after) throws com.symphony.bdk.http.api.ApiException
      Fetch receipts details from a specific message.
      Parameters:
      sessionToken - Session authentication token. (required)
      messageId - The message ID (required)
      before - Returns results from an opaque “before” cursor value as presented via a response cursor. (optional)
      after - Returns results from an opaque “after” cursor value as presented via a response cursor. (optional)
      Returns:
      MessageReceiptDetailResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1AdminMessagesMessageIdReceiptsGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<MessageReceiptDetailResponse> v1AdminMessagesMessageIdReceiptsGetWithHttpInfo(String sessionToken, String messageId, String before, String after) throws com.symphony.bdk.http.api.ApiException
      Fetch receipts details from a specific message.
      Parameters:
      sessionToken - Session authentication token. (required)
      messageId - The message ID (required)
      before - Returns results from an opaque “before” cursor value as presented via a response cursor. (optional)
      after - Returns results from an opaque “after” cursor value as presented via a response cursor. (optional)
      Returns:
      ApiResponse<MessageReceiptDetailResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1AdminMessagesPost

      public List<MessageDetail> v1AdminMessagesPost(String sessionToken, MessageIds messageIds) throws com.symphony.bdk.http.api.ApiException
      Fetch message details
      Parameters:
      sessionToken - Session authentication token (required)
      messageIds - the ids of the messages to be fetched (required)
      Returns:
      List<MessageDetail>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1AdminMessagesPostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<List<MessageDetail>> v1AdminMessagesPostWithHttpInfo(String sessionToken, MessageIds messageIds) throws com.symphony.bdk.http.api.ApiException
      Fetch message details
      Parameters:
      sessionToken - Session authentication token (required)
      messageIds - the ids of the messages to be fetched (required)
      Returns:
      ApiResponse<List<MessageDetail>>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2AdminStreamsStreamIdMessageIdsGet

      public MessageIdsFromStream v2AdminStreamsStreamIdMessageIdsGet(String sessionToken, String streamId, Long since, Long to, Integer limit, Integer offset) throws com.symphony.bdk.http.api.ApiException
      Fetch message ids using timestamp. Gets all message Ids that matches a given stream defined by a streamId in a specified time frame
      Parameters:
      sessionToken - Session authentication token. (required)
      streamId - The stream from which messages are going to be fetched. (required)
      since - A timestamp in milisseconds that defines the initial time the search will consider when getting the messageIds. (optional)
      to - A timestamp in milisseconds that defines the final time the search will consider when getting the messageIds. (optional)
      limit - The limit of how many messageIds will be retrieved at a time. (optional)
      offset - The pagination offset related to the messageIds search. (optional)
      Returns:
      MessageIdsFromStream
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2AdminStreamsStreamIdMessageIdsGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<MessageIdsFromStream> v2AdminStreamsStreamIdMessageIdsGetWithHttpInfo(String sessionToken, String streamId, Long since, Long to, Integer limit, Integer offset) throws com.symphony.bdk.http.api.ApiException
      Fetch message ids using timestamp. Gets all message Ids that matches a given stream defined by a streamId in a specified time frame
      Parameters:
      sessionToken - Session authentication token. (required)
      streamId - The stream from which messages are going to be fetched. (required)
      since - A timestamp in milisseconds that defines the initial time the search will consider when getting the messageIds. (optional)
      to - A timestamp in milisseconds that defines the final time the search will consider when getting the messageIds. (optional)
      limit - The limit of how many messageIds will be retrieved at a time. (optional)
      offset - The pagination offset related to the messageIds search. (optional)
      Returns:
      ApiResponse<MessageIdsFromStream>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call