Package com.mypurecloud.sdk.v2.api

Class UserRecordingsApi

java.lang.Object

com.mypurecloud.sdk.v2.api.UserRecordingsApi

public class UserRecordingsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
UserRecordingsApi()
UserRecordingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteUserrecording(DeleteUserrecordingRequest request)	Delete a user recording.
ApiResponse<Void>	deleteUserrecording(ApiRequest<Void> request)	Delete a user recording.
void	deleteUserrecording(String recordingId)	Delete a user recording.
ApiResponse<Void>	deleteUserrecordingWithHttpInfo(String recordingId)	Delete a user recording.
UserRecording	getUserrecording(GetUserrecordingRequest request)	Get a user recording.
ApiResponse<UserRecording>	getUserrecording(ApiRequest<Void> request)	Get a user recording.
UserRecording	getUserrecording(String recordingId, List<String> expand)	Get a user recording.
UserRecordingEntityListing	getUserrecordings(GetUserrecordingsRequest request)	Get a list of user recordings.
ApiResponse<UserRecordingEntityListing>	getUserrecordings(ApiRequest<Void> request)	Get a list of user recordings.
UserRecordingEntityListing	getUserrecordings(Integer pageSize, Integer pageNumber, List<String> expand)	Get a list of user recordings.
FaxSummary	getUserrecordingsSummary()	Get user recording summary
FaxSummary	getUserrecordingsSummary(GetUserrecordingsSummaryRequest request)	Get user recording summary
ApiResponse<FaxSummary>	getUserrecordingsSummary(ApiRequest<Void> request)	Get user recording summary
ApiResponse<FaxSummary>	getUserrecordingsSummaryWithHttpInfo()	Get user recording summary
ApiResponse<UserRecordingEntityListing>	getUserrecordingsWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> expand)	Get a list of user recordings.
DownloadResponse	getUserrecordingTranscoding(GetUserrecordingTranscodingRequest request)	Download a user recording.
ApiResponse<DownloadResponse>	getUserrecordingTranscoding(ApiRequest<Void> request)	Download a user recording.
DownloadResponse	getUserrecordingTranscoding(String recordingId, String formatId)	Download a user recording.
ApiResponse<DownloadResponse>	getUserrecordingTranscodingWithHttpInfo(String recordingId, String formatId)	Download a user recording.
ApiResponse<UserRecording>	getUserrecordingWithHttpInfo(String recordingId, List<String> expand)	Get a user recording.
UserRecording	putUserrecording(PutUserrecordingRequest request)	Update a user recording.
ApiResponse<UserRecording>	putUserrecording(ApiRequest<UserRecording> request)	Update a user recording.
UserRecording	putUserrecording(String recordingId, UserRecording body, List<String> expand)	Update a user recording.
ApiResponse<UserRecording>	putUserrecordingWithHttpInfo(String recordingId, UserRecording body, List<String> expand)	Update a user recording.

Methods inherited from class java.lang.Object

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

Constructor Details

UserRecordingsApi

public UserRecordingsApi()

UserRecordingsApi

public UserRecordingsApi(ApiClient apiClient)

Method Details

deleteUserrecording

public void deleteUserrecording(String recordingId)
                         throws IOException,
ApiException

Delete a user recording.

Parameters:

recordingId - User Recording ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteUserrecordingWithHttpInfo

public ApiResponse<Void> deleteUserrecordingWithHttpInfo(String recordingId)
                                                  throws IOException

Delete a user recording.

Parameters:

recordingId - User Recording ID (required)

Throws:

IOException - if the request fails to be processed

deleteUserrecording

public void deleteUserrecording(DeleteUserrecordingRequest request)
                         throws IOException,
ApiException

Delete a user recording.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteUserrecording

public ApiResponse<Void> deleteUserrecording(ApiRequest<Void> request)
                                      throws IOException

Delete a user recording.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getUserrecording

public UserRecording getUserrecording(String recordingId,
 List<String> expand)
                               throws IOException,
ApiException

Get a user recording.

Parameters:

recordingId - User Recording ID (required)

expand - Which fields, if any, to expand. (optional)

Returns:

UserRecording

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUserrecordingWithHttpInfo

public ApiResponse<UserRecording> getUserrecordingWithHttpInfo(String recordingId,
 List<String> expand)
                                                        throws IOException

Get a user recording.

Parameters:

recordingId - User Recording ID (required)

expand - Which fields, if any, to expand. (optional)

Returns:

UserRecording

Throws:

IOException - if the request fails to be processed

getUserrecording

public UserRecording getUserrecording(GetUserrecordingRequest request)
                               throws IOException,
ApiException

Get a user recording.

Parameters:

request - The request object

Returns:

UserRecording

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUserrecording

public ApiResponse<UserRecording> getUserrecording(ApiRequest<Void> request)
                                            throws IOException

Get a user recording.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getUserrecordingTranscoding

public DownloadResponse getUserrecordingTranscoding(String recordingId,
 String formatId)
                                             throws IOException,
ApiException

Download a user recording.

Parameters:

recordingId - User Recording ID (required)

formatId - The desired media format. (optional, default to WEBM)

Returns:

DownloadResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUserrecordingTranscodingWithHttpInfo

public ApiResponse<DownloadResponse> getUserrecordingTranscodingWithHttpInfo(String recordingId,
 String formatId)
                                                                      throws IOException

Download a user recording.

Parameters:

recordingId - User Recording ID (required)

formatId - The desired media format. (optional, default to WEBM)

Returns:

DownloadResponse

Throws:

IOException - if the request fails to be processed

getUserrecordingTranscoding

public DownloadResponse getUserrecordingTranscoding(GetUserrecordingTranscodingRequest request)
                                             throws IOException,
ApiException

Download a user recording.

Parameters:

request - The request object

Returns:

DownloadResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUserrecordingTranscoding

public ApiResponse<DownloadResponse> getUserrecordingTranscoding(ApiRequest<Void> request)
                                                          throws IOException

Download a user recording.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getUserrecordings

public UserRecordingEntityListing getUserrecordings(Integer pageSize,
 Integer pageNumber,
 List<String> expand)
                                             throws IOException,
ApiException

Get a list of user recordings.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

expand - Which fields, if any, to expand. (optional)

Returns:

UserRecordingEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUserrecordingsWithHttpInfo

public ApiResponse<UserRecordingEntityListing> getUserrecordingsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 List<String> expand)
                                                                      throws IOException

Get a list of user recordings.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

expand - Which fields, if any, to expand. (optional)

Returns:

UserRecordingEntityListing

Throws:

IOException - if the request fails to be processed

getUserrecordings

public UserRecordingEntityListing getUserrecordings(GetUserrecordingsRequest request)
                                             throws IOException,
ApiException

Get a list of user recordings.

Parameters:

request - The request object

Returns:

UserRecordingEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUserrecordings

public ApiResponse<UserRecordingEntityListing> getUserrecordings(ApiRequest<Void> request)
                                                          throws IOException

Get a list of user recordings.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getUserrecordingsSummary

public FaxSummary getUserrecordingsSummary()
                                    throws IOException,
ApiException

Get user recording summary

Returns:

FaxSummary

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUserrecordingsSummaryWithHttpInfo

public ApiResponse<FaxSummary> getUserrecordingsSummaryWithHttpInfo()
                                                             throws IOException

Get user recording summary

Returns:

FaxSummary

Throws:

IOException - if the request fails to be processed

getUserrecordingsSummary

public FaxSummary getUserrecordingsSummary(GetUserrecordingsSummaryRequest request)
                                    throws IOException,
ApiException

Get user recording summary

Parameters:

request - The request object

Returns:

FaxSummary

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getUserrecordingsSummary

public ApiResponse<FaxSummary> getUserrecordingsSummary(ApiRequest<Void> request)
                                                 throws IOException

Get user recording summary

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putUserrecording

public UserRecording putUserrecording(String recordingId,
 UserRecording body,
 List<String> expand)
                               throws IOException,
ApiException

Update a user recording.

Parameters:

recordingId - User Recording ID (required)

body - UserRecording (required)

expand - Which fields, if any, to expand. (optional)

Returns:

UserRecording

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putUserrecordingWithHttpInfo

public ApiResponse<UserRecording> putUserrecordingWithHttpInfo(String recordingId,
 UserRecording body,
 List<String> expand)
                                                        throws IOException

Update a user recording.

Parameters:

recordingId - User Recording ID (required)

body - UserRecording (required)

expand - Which fields, if any, to expand. (optional)

Returns:

UserRecording

Throws:

IOException - if the request fails to be processed

putUserrecording

public UserRecording putUserrecording(PutUserrecordingRequest request)
                               throws IOException,
ApiException

Update a user recording.

Parameters:

request - The request object

Returns:

UserRecording

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putUserrecording

public ApiResponse<UserRecording> putUserrecording(ApiRequest<UserRecording> request)
                                            throws IOException

Update a user recording.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed