com.symphony.bdk.gen.api

Class DefaultApi

java.lang.Object

com.symphony.bdk.gen.api.DefaultApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-02-19T08:46:08.823+01:00[Europe/Paris]")
public class DefaultApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DefaultApi(com.symphony.bdk.http.api.ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteAllowedFileExtension(java.lang.String sessionToken, java.lang.String extension) 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.
com.symphony.bdk.http.api.ApiResponse<java.lang.Void>	deleteAllowedFileExtensionWithHttpInfo(java.lang.String sessionToken, java.lang.String extension) 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.
com.symphony.bdk.http.api.ApiClient	getApiClient() Get the API cilent
FileExtensionsResponse	listAllowedFileExtensions(java.lang.Integer limit, java.lang.String before, java.lang.String after) 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.
com.symphony.bdk.http.api.ApiResponse<FileExtensionsResponse>	listAllowedFileExtensionsWithHttpInfo(java.lang.Integer limit, java.lang.String before, java.lang.String after) 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.
FileExtension	putAllowedFileExtension(java.lang.String sessionToken, java.lang.String extension, FileExtension v3FileExtension) 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.
com.symphony.bdk.http.api.ApiResponse<FileExtension>	putAllowedFileExtensionWithHttpInfo(java.lang.String sessionToken, java.lang.String extension, FileExtension v3FileExtension) 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.
MessageMetadataResponse	v1AdminMessagesMessageIdMetadataRelationshipsGet(java.lang.String sessionToken, java.lang.String userAgent, java.lang.String messageId) Get the message metadata relationship
com.symphony.bdk.http.api.ApiResponse<MessageMetadataResponse>	v1AdminMessagesMessageIdMetadataRelationshipsGetWithHttpInfo(java.lang.String sessionToken, java.lang.String userAgent, java.lang.String messageId) Get the message metadata relationship
MessageReceiptDetailResponse	v1AdminMessagesMessageIdReceiptsGet(java.lang.String sessionToken, java.lang.String messageId, java.lang.String before, java.lang.String after) Fetch receipts details from a specific message.
com.symphony.bdk.http.api.ApiResponse<MessageReceiptDetailResponse>	v1AdminMessagesMessageIdReceiptsGetWithHttpInfo(java.lang.String sessionToken, java.lang.String messageId, java.lang.String before, java.lang.String after) Fetch receipts details from a specific message.
java.util.List<MessageDetail>	v1AdminMessagesPost(java.lang.String sessionToken, MessageIds messageIds) Fetch message details
com.symphony.bdk.http.api.ApiResponse<java.util.List<MessageDetail>>	v1AdminMessagesPostWithHttpInfo(java.lang.String sessionToken, MessageIds messageIds) Fetch message details
MessageIdsFromStream	v2AdminStreamsStreamIdMessageIdsGet(java.lang.String sessionToken, java.lang.String streamId, java.lang.Long since, java.lang.Long to, java.lang.Integer limit, java.lang.Integer offset) Fetch message ids using timestamp.
com.symphony.bdk.http.api.ApiResponse<MessageIdsFromStream>	v2AdminStreamsStreamIdMessageIdsGetWithHttpInfo(java.lang.String sessionToken, java.lang.String streamId, java.lang.Long since, java.lang.Long to, java.lang.Integer limit, java.lang.Integer offset) Fetch message ids using timestamp.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultApi

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

Method Detail

getApiClient

public com.symphony.bdk.http.api.ApiClient getApiClient()

Get the API cilent

Returns:

API client

deleteAllowedFileExtension

public void deleteAllowedFileExtension(java.lang.String sessionToken,
                                       java.lang.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<java.lang.Void> deleteAllowedFileExtensionWithHttpInfo(java.lang.String sessionToken,
                                                                                                    java.lang.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(java.lang.Integer limit,
                                                        java.lang.String before,
                                                        java.lang.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(java.lang.Integer limit,
                                                                                                           java.lang.String before,
                                                                                                           java.lang.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(java.lang.String sessionToken,
                                             java.lang.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(java.lang.String sessionToken,
                                                                                                java.lang.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(java.lang.String sessionToken,
                                                                                java.lang.String userAgent,
                                                                                java.lang.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(java.lang.String sessionToken,
                                                                                                                                   java.lang.String userAgent,
                                                                                                                                   java.lang.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(java.lang.String sessionToken,
                                                                        java.lang.String messageId,
                                                                        java.lang.String before,
                                                                        java.lang.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(java.lang.String sessionToken,
                                                                                                                           java.lang.String messageId,
                                                                                                                           java.lang.String before,
                                                                                                                           java.lang.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 java.util.List<MessageDetail> v1AdminMessagesPost(java.lang.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<java.util.List<MessageDetail>> v1AdminMessagesPostWithHttpInfo(java.lang.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(java.lang.String sessionToken,
                                                                java.lang.String streamId,
                                                                java.lang.Long since,
                                                                java.lang.Long to,
                                                                java.lang.Integer limit,
                                                                java.lang.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(java.lang.String sessionToken,
                                                                                                                   java.lang.String streamId,
                                                                                                                   java.lang.Long since,
                                                                                                                   java.lang.Long to,
                                                                                                                   java.lang.Integer limit,
                                                                                                                   java.lang.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