Package com.mypurecloud.sdk.v2.api
Class SettingsApi
java.lang.Object
com.mypurecloud.sdk.v2.api.SettingsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidReset email threading settings to defaultvoidReset email threading settings to defaultdeleteEmailsSettingsThreading(ApiRequest<Void> request) Reset email threading settings to defaultReset email threading settings to defaultDelete settingsDelete settingsdeleteExternalcontactsSettings(ApiRequest<Void> request) Delete settingsDelete settingsvoiddeleteUsersAgentuiAgentsAutoanswerAgentIdSettings(DeleteUsersAgentuiAgentsAutoanswerAgentIdSettingsRequest request) Delete agent auto answer settingsDelete agent auto answer settingsvoidDelete agent auto answer settingsDelete agent auto answer settingsGet email Contact Center settingsGet email Contact Center settingsgetEmailsSettings(ApiRequest<Void> request) Get email Contact Center settingsGet email threading settingsGet email threading settingsgetEmailsSettingsThreading(ApiRequest<Void> request) Get email threading settingsGet email threading settingsGet email Contact Center settingsGet settingsGet settingsgetExternalcontactsSettings(ApiRequest<Void> request) Get settingsGet settingsGet the execution history enabled setting.Get the execution history enabled setting.getSettingsExecutiondata(ApiRequest<Void> request) Get the execution history enabled setting.Get the execution history enabled setting.getUsersAgentuiAgentsAutoanswerAgentIdSettings(GetUsersAgentuiAgentsAutoanswerAgentIdSettingsRequest request) Get agent auto answer settingsGet agent auto answer settingsGet agent auto answer settingsGet agent auto answer settingsPatch email Contact Center settingspatchEmailsSettings(ApiRequest<EmailSettings> request) Patch email Contact Center settingsPatch email Contact Center settingsPatch email threading settingsPatch email threading settingsPatch email threading settingsPatch email threading settingsPatch email Contact Center settingsEdit the execution history on off setting.Edit the execution history on off setting.Edit the execution history on off setting.Edit the execution history on off setting.patchUsersAgentuiAgentsAutoanswerAgentIdSettings(PatchUsersAgentuiAgentsAutoanswerAgentIdSettingsRequest request) Update agent auto answer settingsUpdate agent auto answer settingsUpdate agent auto answer settingspatchUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo(String agentId, AutoAnswerSettings body) Update agent auto answer settingsSet settingsSet settingsSet settingsSet settingsputUsersAgentuiAgentsAutoanswerAgentIdSettings(PutUsersAgentuiAgentsAutoanswerAgentIdSettingsRequest request) Set agent auto answer settingsSet agent auto answer settingsSet agent auto answer settingsSet agent auto answer settings
-
Constructor Details
-
SettingsApi
public SettingsApi() -
SettingsApi
-
-
Method Details
-
deleteEmailsSettingsThreading
Reset email threading settings to default- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteEmailsSettingsThreadingWithHttpInfo
Reset email threading settings to default- Throws:
IOException- if the request fails to be processed
-
deleteEmailsSettingsThreading
public void deleteEmailsSettingsThreading(DeleteEmailsSettingsThreadingRequest request) throws IOException, ApiException Reset email threading settings to default- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteEmailsSettingsThreading
Reset email threading settings to default- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteExternalcontactsSettings
Delete settings- Returns:
- UpdatedSettingsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteExternalcontactsSettingsWithHttpInfo
public ApiResponse<UpdatedSettingsResponse> deleteExternalcontactsSettingsWithHttpInfo() throws IOExceptionDelete settings- Returns:
- UpdatedSettingsResponse
- Throws:
IOException- if the request fails to be processed
-
deleteExternalcontactsSettings
public UpdatedSettingsResponse deleteExternalcontactsSettings(DeleteExternalcontactsSettingsRequest request) throws IOException, ApiException Delete settings- Parameters:
request- The request object- Returns:
- UpdatedSettingsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteExternalcontactsSettings
public ApiResponse<UpdatedSettingsResponse> deleteExternalcontactsSettings(ApiRequest<Void> request) throws IOException Delete settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings
public void deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(String agentId) throws IOException, ApiException Delete agent auto answer settings- Parameters:
agentId- The agent to apply the auto answer settings to (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo
public ApiResponse<Void> deleteUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo(String agentId) throws IOException Delete agent auto answer settings- Parameters:
agentId- The agent to apply the auto answer settings to (required)- Throws:
IOException- if the request fails to be processed
-
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings
public void deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(DeleteUsersAgentuiAgentsAutoanswerAgentIdSettingsRequest request) throws IOException, ApiException Delete agent auto answer settings- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings
public ApiResponse<Void> deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(ApiRequest<Void> request) throws IOException Delete agent auto answer settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getEmailsSettings
Get email Contact Center settings- Returns:
- EmailSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getEmailsSettingsWithHttpInfo
Get email Contact Center settings- Returns:
- EmailSettings
- Throws:
IOException- if the request fails to be processed
-
getEmailsSettings
public EmailSettings getEmailsSettings(GetEmailsSettingsRequest request) throws IOException, ApiException Get email Contact Center settings- Parameters:
request- The request object- Returns:
- EmailSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getEmailsSettings
Get email Contact Center settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getEmailsSettingsThreading
Get email threading settings- Returns:
- EmailThreadingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getEmailsSettingsThreadingWithHttpInfo
public ApiResponse<EmailThreadingSettings> getEmailsSettingsThreadingWithHttpInfo() throws IOExceptionGet email threading settings- Returns:
- EmailThreadingSettings
- Throws:
IOException- if the request fails to be processed
-
getEmailsSettingsThreading
public EmailThreadingSettings getEmailsSettingsThreading(GetEmailsSettingsThreadingRequest request) throws IOException, ApiException Get email threading settings- Parameters:
request- The request object- Returns:
- EmailThreadingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getEmailsSettingsThreading
public ApiResponse<EmailThreadingSettings> getEmailsSettingsThreading(ApiRequest<Void> request) throws IOException Get email threading settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getExternalcontactsSettings
Get settings- Returns:
- ExternalContactsSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getExternalcontactsSettingsWithHttpInfo
public ApiResponse<ExternalContactsSettings> getExternalcontactsSettingsWithHttpInfo() throws IOExceptionGet settings- Returns:
- ExternalContactsSettings
- Throws:
IOException- if the request fails to be processed
-
getExternalcontactsSettings
public ExternalContactsSettings getExternalcontactsSettings(GetExternalcontactsSettingsRequest request) throws IOException, ApiException Get settings- Parameters:
request- The request object- Returns:
- ExternalContactsSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getExternalcontactsSettings
public ApiResponse<ExternalContactsSettings> getExternalcontactsSettings(ApiRequest<Void> request) throws IOException Get settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getSettingsExecutiondata
public ExecutionDataGlobalSettingsResponse getSettingsExecutiondata() throws IOException, ApiExceptionGet the execution history enabled setting. Get the execution history enabled setting.- Returns:
- ExecutionDataGlobalSettingsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getSettingsExecutiondataWithHttpInfo
public ApiResponse<ExecutionDataGlobalSettingsResponse> getSettingsExecutiondataWithHttpInfo() throws IOExceptionGet the execution history enabled setting. Get the execution history enabled setting.- Returns:
- ExecutionDataGlobalSettingsResponse
- Throws:
IOException- if the request fails to be processed
-
getSettingsExecutiondata
public ExecutionDataGlobalSettingsResponse getSettingsExecutiondata(GetSettingsExecutiondataRequest request) throws IOException, ApiException Get the execution history enabled setting. Get the execution history enabled setting.- Parameters:
request- The request object- Returns:
- ExecutionDataGlobalSettingsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getSettingsExecutiondata
public ApiResponse<ExecutionDataGlobalSettingsResponse> getSettingsExecutiondata(ApiRequest<Void> request) throws IOException Get the execution history enabled setting. Get the execution history enabled setting.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersAgentuiAgentsAutoanswerAgentIdSettings
public AutoAnswerSettings getUsersAgentuiAgentsAutoanswerAgentIdSettings(String agentId) throws IOException, ApiException Get agent auto answer settings- Parameters:
agentId- The agent to apply the auto answer settings to (required)- Returns:
- AutoAnswerSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo
public ApiResponse<AutoAnswerSettings> getUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo(String agentId) throws IOException Get agent auto answer settings- Parameters:
agentId- The agent to apply the auto answer settings to (required)- Returns:
- AutoAnswerSettings
- Throws:
IOException- if the request fails to be processed
-
getUsersAgentuiAgentsAutoanswerAgentIdSettings
public AutoAnswerSettings getUsersAgentuiAgentsAutoanswerAgentIdSettings(GetUsersAgentuiAgentsAutoanswerAgentIdSettingsRequest request) throws IOException, ApiException Get agent auto answer settings- Parameters:
request- The request object- Returns:
- AutoAnswerSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersAgentuiAgentsAutoanswerAgentIdSettings
public ApiResponse<AutoAnswerSettings> getUsersAgentuiAgentsAutoanswerAgentIdSettings(ApiRequest<Void> request) throws IOException Get agent auto answer settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchEmailsSettings
Patch email Contact Center settings- Parameters:
body- (optional)- Returns:
- EmailSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchEmailsSettingsWithHttpInfo
public ApiResponse<EmailSettings> patchEmailsSettingsWithHttpInfo(EmailSettings body) throws IOException Patch email Contact Center settings- Parameters:
body- (optional)- Returns:
- EmailSettings
- Throws:
IOException- if the request fails to be processed
-
patchEmailsSettings
public EmailSettings patchEmailsSettings(PatchEmailsSettingsRequest request) throws IOException, ApiException Patch email Contact Center settings- Parameters:
request- The request object- Returns:
- EmailSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchEmailsSettings
public ApiResponse<EmailSettings> patchEmailsSettings(ApiRequest<EmailSettings> request) throws IOException Patch email Contact Center settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchEmailsSettingsThreading
public EmailThreadingSettings patchEmailsSettingsThreading(EmailThreadingSettings body) throws IOException, ApiException Patch email threading settings- Parameters:
body- (optional)- Returns:
- EmailThreadingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchEmailsSettingsThreadingWithHttpInfo
public ApiResponse<EmailThreadingSettings> patchEmailsSettingsThreadingWithHttpInfo(EmailThreadingSettings body) throws IOException Patch email threading settings- Parameters:
body- (optional)- Returns:
- EmailThreadingSettings
- Throws:
IOException- if the request fails to be processed
-
patchEmailsSettingsThreading
public EmailThreadingSettings patchEmailsSettingsThreading(PatchEmailsSettingsThreadingRequest request) throws IOException, ApiException Patch email threading settings- Parameters:
request- The request object- Returns:
- EmailThreadingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchEmailsSettingsThreading
public ApiResponse<EmailThreadingSettings> patchEmailsSettingsThreading(ApiRequest<EmailThreadingSettings> request) throws IOException Patch email threading settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchSettingsExecutiondata
public ExecutionDataGlobalSettingsResponse patchSettingsExecutiondata(ExecutionDataSettingsRequest body) throws IOException, ApiException Edit the execution history on off setting. Edit the execution history on off setting.- Parameters:
body- New Execution Data Setting (required)- Returns:
- ExecutionDataGlobalSettingsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchSettingsExecutiondataWithHttpInfo
public ApiResponse<ExecutionDataGlobalSettingsResponse> patchSettingsExecutiondataWithHttpInfo(ExecutionDataSettingsRequest body) throws IOException Edit the execution history on off setting. Edit the execution history on off setting.- Parameters:
body- New Execution Data Setting (required)- Returns:
- ExecutionDataGlobalSettingsResponse
- Throws:
IOException- if the request fails to be processed
-
patchSettingsExecutiondata
public ExecutionDataGlobalSettingsResponse patchSettingsExecutiondata(PatchSettingsExecutiondataRequest request) throws IOException, ApiException Edit the execution history on off setting. Edit the execution history on off setting.- Parameters:
request- The request object- Returns:
- ExecutionDataGlobalSettingsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchSettingsExecutiondata
public ApiResponse<ExecutionDataGlobalSettingsResponse> patchSettingsExecutiondata(ApiRequest<ExecutionDataSettingsRequest> request) throws IOException Edit the execution history on off setting. Edit the execution history on off setting.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUsersAgentuiAgentsAutoanswerAgentIdSettings
public AutoAnswerSettings patchUsersAgentuiAgentsAutoanswerAgentIdSettings(String agentId, AutoAnswerSettings body) throws IOException, ApiException Update agent auto answer settings- Parameters:
agentId- The agent to apply the auto answer settings to (required)body- AutoAnswerSettings (required)- Returns:
- AutoAnswerSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo
public ApiResponse<AutoAnswerSettings> patchUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo(String agentId, AutoAnswerSettings body) throws IOException Update agent auto answer settings- Parameters:
agentId- The agent to apply the auto answer settings to (required)body- AutoAnswerSettings (required)- Returns:
- AutoAnswerSettings
- Throws:
IOException- if the request fails to be processed
-
patchUsersAgentuiAgentsAutoanswerAgentIdSettings
public AutoAnswerSettings patchUsersAgentuiAgentsAutoanswerAgentIdSettings(PatchUsersAgentuiAgentsAutoanswerAgentIdSettingsRequest request) throws IOException, ApiException Update agent auto answer settings- Parameters:
request- The request object- Returns:
- AutoAnswerSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUsersAgentuiAgentsAutoanswerAgentIdSettings
public ApiResponse<AutoAnswerSettings> patchUsersAgentuiAgentsAutoanswerAgentIdSettings(ApiRequest<AutoAnswerSettings> request) throws IOException Update agent auto answer settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putExternalcontactsSettings
public UpdatedSettingsResponse putExternalcontactsSettings(ExternalContactsSettings body) throws IOException, ApiException Set settings- Parameters:
body- (optional)- Returns:
- UpdatedSettingsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putExternalcontactsSettingsWithHttpInfo
public ApiResponse<UpdatedSettingsResponse> putExternalcontactsSettingsWithHttpInfo(ExternalContactsSettings body) throws IOException Set settings- Parameters:
body- (optional)- Returns:
- UpdatedSettingsResponse
- Throws:
IOException- if the request fails to be processed
-
putExternalcontactsSettings
public UpdatedSettingsResponse putExternalcontactsSettings(PutExternalcontactsSettingsRequest request) throws IOException, ApiException Set settings- Parameters:
request- The request object- Returns:
- UpdatedSettingsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putExternalcontactsSettings
public ApiResponse<UpdatedSettingsResponse> putExternalcontactsSettings(ApiRequest<ExternalContactsSettings> request) throws IOException Set settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUsersAgentuiAgentsAutoanswerAgentIdSettings
public AutoAnswerSettings putUsersAgentuiAgentsAutoanswerAgentIdSettings(String agentId, AutoAnswerSettings body) throws IOException, ApiException Set agent auto answer settings- Parameters:
agentId- The agent to apply the auto answer settings to (required)body- AutoAnswerSettings (required)- Returns:
- AutoAnswerSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo
public ApiResponse<AutoAnswerSettings> putUsersAgentuiAgentsAutoanswerAgentIdSettingsWithHttpInfo(String agentId, AutoAnswerSettings body) throws IOException Set agent auto answer settings- Parameters:
agentId- The agent to apply the auto answer settings to (required)body- AutoAnswerSettings (required)- Returns:
- AutoAnswerSettings
- Throws:
IOException- if the request fails to be processed
-
putUsersAgentuiAgentsAutoanswerAgentIdSettings
public AutoAnswerSettings putUsersAgentuiAgentsAutoanswerAgentIdSettings(PutUsersAgentuiAgentsAutoanswerAgentIdSettingsRequest request) throws IOException, ApiException Set agent auto answer settings- Parameters:
request- The request object- Returns:
- AutoAnswerSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUsersAgentuiAgentsAutoanswerAgentIdSettings
public ApiResponse<AutoAnswerSettings> putUsersAgentuiAgentsAutoanswerAgentIdSettings(ApiRequest<AutoAnswerSettings> request) throws IOException Set agent auto answer settings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-