Package com.mypurecloud.sdk.v2.api

Class DataPrivacyApi

java.lang.Object

com.mypurecloud.sdk.v2.api.DataPrivacyApi

public class DataPrivacyApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DataPrivacyApi()
DataPrivacyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteDataprivacyMaskingrule(DeleteDataprivacyMaskingruleRequest request)	Delete a masking rule.
ApiResponse<Void>	deleteDataprivacyMaskingrule(ApiRequest<Void> request)	Delete a masking rule.
void	deleteDataprivacyMaskingrule(String ruleId)	Delete a masking rule.
ApiResponse<Void>	deleteDataprivacyMaskingruleWithHttpInfo(String ruleId)	Delete a masking rule.
MaskingRule	getDataprivacyMaskingrule(GetDataprivacyMaskingruleRequest request)	Fetch details about a masking rule.
ApiResponse<MaskingRule>	getDataprivacyMaskingrule(ApiRequest<Void> request)	Fetch details about a masking rule.
MaskingRule	getDataprivacyMaskingrule(String ruleId)	Fetch details about a masking rule.
MaskingRuleListing	getDataprivacyMaskingrules()	Retrieve the list of masking rules.
MaskingRuleListing	getDataprivacyMaskingrules(GetDataprivacyMaskingrulesRequest request)	Retrieve the list of masking rules.
ApiResponse<MaskingRuleListing>	getDataprivacyMaskingrules(ApiRequest<Void> request)	Retrieve the list of masking rules.
ApiResponse<MaskingRuleListing>	getDataprivacyMaskingrulesWithHttpInfo()	Retrieve the list of masking rules.
ApiResponse<MaskingRule>	getDataprivacyMaskingruleWithHttpInfo(String ruleId)	Fetch details about a masking rule.
MaskingRule	patchDataprivacyMaskingrule(PatchDataprivacyMaskingruleRequest request)	Update information about a masking rule.
ApiResponse<MaskingRule>	patchDataprivacyMaskingrule(ApiRequest<MaskingRule> request)	Update information about a masking rule.
MaskingRule	patchDataprivacyMaskingrule(String ruleId, MaskingRule body)	Update information about a masking rule.
ApiResponse<MaskingRule>	patchDataprivacyMaskingruleWithHttpInfo(String ruleId, MaskingRule body)	Update information about a masking rule.
MaskingRule	postDataprivacyMaskingrules(PostDataprivacyMaskingrulesRequest request)	Create a new masking rule resource.
ApiResponse<MaskingRule>	postDataprivacyMaskingrules(ApiRequest<MaskingRule> request)	Create a new masking rule resource.
MaskingRule	postDataprivacyMaskingrules(MaskingRule body)	Create a new masking rule resource.
MaskingRuleValidateResponse	postDataprivacyMaskingrulesValidate(PostDataprivacyMaskingrulesValidateRequest request)	Validate masking before creating.
ApiResponse<MaskingRuleValidateResponse>	postDataprivacyMaskingrulesValidate(ApiRequest<MaskingRuleValidateRequest> request)	Validate masking before creating.
MaskingRuleValidateResponse	postDataprivacyMaskingrulesValidate(MaskingRuleValidateRequest body)	Validate masking before creating.
ApiResponse<MaskingRuleValidateResponse>	postDataprivacyMaskingrulesValidateWithHttpInfo(MaskingRuleValidateRequest body)	Validate masking before creating.
ApiResponse<MaskingRule>	postDataprivacyMaskingrulesWithHttpInfo(MaskingRule body)	Create a new masking rule resource.

Methods inherited from class java.lang.Object

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

Constructor Details

DataPrivacyApi

public DataPrivacyApi()

DataPrivacyApi

public DataPrivacyApi(ApiClient apiClient)

Method Details

deleteDataprivacyMaskingrule

public void deleteDataprivacyMaskingrule(String ruleId)
                                  throws IOException,
ApiException

Delete a masking rule.

Parameters:

ruleId - ruleId (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteDataprivacyMaskingruleWithHttpInfo

public ApiResponse<Void> deleteDataprivacyMaskingruleWithHttpInfo(String ruleId)
                                                           throws IOException

Delete a masking rule.

Parameters:

ruleId - ruleId (required)

Throws:

IOException - if the request fails to be processed

deleteDataprivacyMaskingrule

public void deleteDataprivacyMaskingrule(DeleteDataprivacyMaskingruleRequest request)
                                  throws IOException,
ApiException

Delete a masking rule.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteDataprivacyMaskingrule

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

Delete a masking rule.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getDataprivacyMaskingrule

public MaskingRule getDataprivacyMaskingrule(String ruleId)
                                      throws IOException,
ApiException

Fetch details about a masking rule.

Parameters:

ruleId - ruleId (required)

Returns:

MaskingRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDataprivacyMaskingruleWithHttpInfo

public ApiResponse<MaskingRule> getDataprivacyMaskingruleWithHttpInfo(String ruleId)
                                                               throws IOException

Fetch details about a masking rule.

Parameters:

ruleId - ruleId (required)

Returns:

MaskingRule

Throws:

IOException - if the request fails to be processed

getDataprivacyMaskingrule

public MaskingRule getDataprivacyMaskingrule(GetDataprivacyMaskingruleRequest request)
                                      throws IOException,
ApiException

Fetch details about a masking rule.

Parameters:

request - The request object

Returns:

MaskingRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDataprivacyMaskingrule

public ApiResponse<MaskingRule> getDataprivacyMaskingrule(ApiRequest<Void> request)
                                                   throws IOException

Fetch details about a masking rule.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getDataprivacyMaskingrules

public MaskingRuleListing getDataprivacyMaskingrules()
                                              throws IOException,
ApiException

Retrieve the list of masking rules.

Returns:

MaskingRuleListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDataprivacyMaskingrulesWithHttpInfo

public ApiResponse<MaskingRuleListing> getDataprivacyMaskingrulesWithHttpInfo()
                                                                       throws IOException

Retrieve the list of masking rules.

Returns:

MaskingRuleListing

Throws:

IOException - if the request fails to be processed

getDataprivacyMaskingrules

public MaskingRuleListing getDataprivacyMaskingrules(GetDataprivacyMaskingrulesRequest request)
                                              throws IOException,
ApiException

Retrieve the list of masking rules.

Parameters:

request - The request object

Returns:

MaskingRuleListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getDataprivacyMaskingrules

public ApiResponse<MaskingRuleListing> getDataprivacyMaskingrules(ApiRequest<Void> request)
                                                           throws IOException

Retrieve the list of masking rules.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchDataprivacyMaskingrule

public MaskingRule patchDataprivacyMaskingrule(String ruleId,
 MaskingRule body)
                                        throws IOException,
ApiException

Update information about a masking rule.

Parameters:

ruleId - ruleId (required)

body - (optional)

Returns:

MaskingRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchDataprivacyMaskingruleWithHttpInfo

public ApiResponse<MaskingRule> patchDataprivacyMaskingruleWithHttpInfo(String ruleId,
 MaskingRule body)
                                                                 throws IOException

Update information about a masking rule.

Parameters:

ruleId - ruleId (required)

body - (optional)

Returns:

MaskingRule

Throws:

IOException - if the request fails to be processed

patchDataprivacyMaskingrule

public MaskingRule patchDataprivacyMaskingrule(PatchDataprivacyMaskingruleRequest request)
                                        throws IOException,
ApiException

Update information about a masking rule.

Parameters:

request - The request object

Returns:

MaskingRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchDataprivacyMaskingrule

public ApiResponse<MaskingRule> patchDataprivacyMaskingrule(ApiRequest<MaskingRule> request)
                                                     throws IOException

Update information about a masking rule.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postDataprivacyMaskingrules

public MaskingRule postDataprivacyMaskingrules(MaskingRule body)
                                        throws IOException,
ApiException

Create a new masking rule resource.

Parameters:

body - Details for creating masking rule resource (required)

Returns:

MaskingRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDataprivacyMaskingrulesWithHttpInfo

public ApiResponse<MaskingRule> postDataprivacyMaskingrulesWithHttpInfo(MaskingRule body)
                                                                 throws IOException

Create a new masking rule resource.

Parameters:

body - Details for creating masking rule resource (required)

Returns:

MaskingRule

Throws:

IOException - if the request fails to be processed

postDataprivacyMaskingrules

public MaskingRule postDataprivacyMaskingrules(PostDataprivacyMaskingrulesRequest request)
                                        throws IOException,
ApiException

Create a new masking rule resource.

Parameters:

request - The request object

Returns:

MaskingRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDataprivacyMaskingrules

public ApiResponse<MaskingRule> postDataprivacyMaskingrules(ApiRequest<MaskingRule> request)
                                                     throws IOException

Create a new masking rule resource.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postDataprivacyMaskingrulesValidate

public MaskingRuleValidateResponse postDataprivacyMaskingrulesValidate(MaskingRuleValidateRequest body)
                                                                throws IOException,
ApiException

Validate masking before creating.

Parameters:

body - Text to be masked (required)

Returns:

MaskingRuleValidateResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDataprivacyMaskingrulesValidateWithHttpInfo

public ApiResponse<MaskingRuleValidateResponse> postDataprivacyMaskingrulesValidateWithHttpInfo(MaskingRuleValidateRequest body)
                                                                                         throws IOException

Validate masking before creating.

Parameters:

body - Text to be masked (required)

Returns:

MaskingRuleValidateResponse

Throws:

IOException - if the request fails to be processed

postDataprivacyMaskingrulesValidate

public MaskingRuleValidateResponse postDataprivacyMaskingrulesValidate(PostDataprivacyMaskingrulesValidateRequest request)
                                                                throws IOException,
ApiException

Validate masking before creating.

Parameters:

request - The request object

Returns:

MaskingRuleValidateResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postDataprivacyMaskingrulesValidate

public ApiResponse<MaskingRuleValidateResponse> postDataprivacyMaskingrulesValidate(ApiRequest<MaskingRuleValidateRequest> request)
                                                                             throws IOException

Validate masking before creating.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed