com.codedx.client.api

Class RuleSetsApi

java.lang.Object

com.codedx.client.api.RuleSetsApi

public class RuleSetsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RuleSetsApi()
RuleSetsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	addRuleCriteria(java.lang.Integer rulesetId, java.lang.Integer ruleId, RuleCriteria ruleCriteria) Add Rule Criteria Allows user to add rule criteria
com.squareup.okhttp.Call	addRuleCriteriaAsync(java.lang.Integer rulesetId, java.lang.Integer ruleId, RuleCriteria ruleCriteria, ApiCallback<java.lang.Void> callback) Add Rule Criteria (asynchronously) Allows user to add rule criteria
com.squareup.okhttp.Call	addRuleCriteriaCall(java.lang.Integer rulesetId, java.lang.Integer ruleId, RuleCriteria ruleCriteria, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for addRuleCriteria
ApiResponse<java.lang.Void>	addRuleCriteriaWithHttpInfo(java.lang.Integer rulesetId, java.lang.Integer ruleId, RuleCriteria ruleCriteria) Add Rule Criteria Allows user to add rule criteria
RuleSet	cloneRuleSet(java.lang.Integer rulesetId, RuleSet ruleSet) Clone Rule Set Allows user to clone a rule set
com.squareup.okhttp.Call	cloneRuleSetAsync(java.lang.Integer rulesetId, RuleSet ruleSet, ApiCallback<RuleSet> callback) Clone Rule Set (asynchronously) Allows user to clone a rule set
com.squareup.okhttp.Call	cloneRuleSetCall(java.lang.Integer rulesetId, RuleSet ruleSet, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for cloneRuleSet
ApiResponse<RuleSet>	cloneRuleSetWithHttpInfo(java.lang.Integer rulesetId, RuleSet ruleSet) Clone Rule Set Allows user to clone a rule set
Rule	createRule(java.lang.Integer rulesetId, CreateRule rule) Create Rule Allows user to create a Rule
com.squareup.okhttp.Call	createRuleAsync(java.lang.Integer rulesetId, CreateRule rule, ApiCallback<Rule> callback) Create Rule (asynchronously) Allows user to create a Rule
com.squareup.okhttp.Call	createRuleCall(java.lang.Integer rulesetId, CreateRule rule, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createRule
RuleSet	createRuleSet(RuleSet ruleSet) Create Rule Set Creates a rule set
com.squareup.okhttp.Call	createRuleSetAsync(RuleSet ruleSet, ApiCallback<RuleSet> callback) Create Rule Set (asynchronously) Creates a rule set
com.squareup.okhttp.Call	createRuleSetCall(RuleSet ruleSet, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createRuleSet
ApiResponse<RuleSet>	createRuleSetWithHttpInfo(RuleSet ruleSet) Create Rule Set Creates a rule set
ApiResponse<Rule>	createRuleWithHttpInfo(java.lang.Integer rulesetId, CreateRule rule) Create Rule Allows user to create a Rule
void	deleteRule(java.lang.Integer rulesetId, java.lang.Integer ruleId) Delete Rule Allows user to delete a rule
com.squareup.okhttp.Call	deleteRuleAsync(java.lang.Integer rulesetId, java.lang.Integer ruleId, ApiCallback<java.lang.Void> callback) Delete Rule (asynchronously) Allows user to delete a rule
com.squareup.okhttp.Call	deleteRuleCall(java.lang.Integer rulesetId, java.lang.Integer ruleId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteRule
void	deleteRuleCriteria(java.lang.Integer rulesetId, java.lang.Integer ruleId, RuleCriteria ruleCriteria) Delete Rule Criteria Allows user to delete rule criteria
com.squareup.okhttp.Call	deleteRuleCriteriaAsync(java.lang.Integer rulesetId, java.lang.Integer ruleId, RuleCriteria ruleCriteria, ApiCallback<java.lang.Void> callback) Delete Rule Criteria (asynchronously) Allows user to delete rule criteria
com.squareup.okhttp.Call	deleteRuleCriteriaCall(java.lang.Integer rulesetId, java.lang.Integer ruleId, RuleCriteria ruleCriteria, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteRuleCriteria
ApiResponse<java.lang.Void>	deleteRuleCriteriaWithHttpInfo(java.lang.Integer rulesetId, java.lang.Integer ruleId, RuleCriteria ruleCriteria) Delete Rule Criteria Allows user to delete rule criteria
RuleSetDeleteResponse	deleteRuleSet(java.lang.Integer rulesetId, java.lang.Boolean force) Delete Rule Set Allows user to delete a rule set
com.squareup.okhttp.Call	deleteRuleSetAsync(java.lang.Integer rulesetId, java.lang.Boolean force, ApiCallback<RuleSetDeleteResponse> callback) Delete Rule Set (asynchronously) Allows user to delete a rule set
com.squareup.okhttp.Call	deleteRuleSetCall(java.lang.Integer rulesetId, java.lang.Boolean force, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteRuleSet
ApiResponse<RuleSetDeleteResponse>	deleteRuleSetWithHttpInfo(java.lang.Integer rulesetId, java.lang.Boolean force) Delete Rule Set Allows user to delete a rule set
ApiResponse<java.lang.Void>	deleteRuleWithHttpInfo(java.lang.Integer rulesetId, java.lang.Integer ruleId) Delete Rule Allows user to delete a rule
java.io.File	exportRuleSet(java.lang.Integer rulesetId) Export Rule Set Allows user to export a rule set as an XML file
com.squareup.okhttp.Call	exportRuleSetAsync(java.lang.Integer rulesetId, ApiCallback<java.io.File> callback) Export Rule Set (asynchronously) Allows user to export a rule set as an XML file
com.squareup.okhttp.Call	exportRuleSetCall(java.lang.Integer rulesetId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for exportRuleSet
ApiResponse<java.io.File>	exportRuleSetWithHttpInfo(java.lang.Integer rulesetId) Export Rule Set Allows user to export a rule set as an XML file
java.util.List<RuleSet>	getAllRuleSets() Get Rule Sets Provides a list of rule sets
com.squareup.okhttp.Call	getAllRuleSetsAsync(ApiCallback<java.util.List<RuleSet>> callback) Get Rule Sets (asynchronously) Provides a list of rule sets
com.squareup.okhttp.Call	getAllRuleSetsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllRuleSets
ApiResponse<java.util.List<RuleSet>>	getAllRuleSetsWithHttpInfo() Get Rule Sets Provides a list of rule sets
ApiClient	getApiClient()
Rule	getRuleData(java.lang.Integer rulesetId, java.lang.Integer ruleId) Get Rule Data Allows user to view a specific rule's data
com.squareup.okhttp.Call	getRuleDataAsync(java.lang.Integer rulesetId, java.lang.Integer ruleId, ApiCallback<Rule> callback) Get Rule Data (asynchronously) Allows user to view a specific rule's data
com.squareup.okhttp.Call	getRuleDataCall(java.lang.Integer rulesetId, java.lang.Integer ruleId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getRuleData
ApiResponse<Rule>	getRuleDataWithHttpInfo(java.lang.Integer rulesetId, java.lang.Integer ruleId) Get Rule Data Allows user to view a specific rule's data
RuleSetContents	getRuleSetContents(java.lang.Integer rulesetId) Get Rule Set Contents Returns an object representing the contents of a rule set
com.squareup.okhttp.Call	getRuleSetContentsAsync(java.lang.Integer rulesetId, ApiCallback<RuleSetContents> callback) Get Rule Set Contents (asynchronously) Returns an object representing the contents of a rule set
com.squareup.okhttp.Call	getRuleSetContentsCall(java.lang.Integer rulesetId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getRuleSetContents
ApiResponse<RuleSetContents>	getRuleSetContentsWithHttpInfo(java.lang.Integer rulesetId) Get Rule Set Contents Returns an object representing the contents of a rule set
ModifyRuleResponse	modifyRuleData(java.lang.Integer rulesetId, java.lang.Integer ruleId, CreateRule rule) Modify Rule Descriptor Allows user to modify a specific rule's data
com.squareup.okhttp.Call	modifyRuleDataAsync(java.lang.Integer rulesetId, java.lang.Integer ruleId, CreateRule rule, ApiCallback<ModifyRuleResponse> callback) Modify Rule Descriptor (asynchronously) Allows user to modify a specific rule's data
com.squareup.okhttp.Call	modifyRuleDataCall(java.lang.Integer rulesetId, java.lang.Integer ruleId, CreateRule rule, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for modifyRuleData
ApiResponse<ModifyRuleResponse>	modifyRuleDataWithHttpInfo(java.lang.Integer rulesetId, java.lang.Integer ruleId, CreateRule rule) Modify Rule Descriptor Allows user to modify a specific rule's data
RuleSet	renameRuleSet(java.lang.Integer rulesetId, RuleSet ruleSet) Rename Rule Set Allows user to rename a rule set
com.squareup.okhttp.Call	renameRuleSetAsync(java.lang.Integer rulesetId, RuleSet ruleSet, ApiCallback<RuleSet> callback) Rename Rule Set (asynchronously) Allows user to rename a rule set
com.squareup.okhttp.Call	renameRuleSetCall(java.lang.Integer rulesetId, RuleSet ruleSet, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for renameRuleSet
ApiResponse<RuleSet>	renameRuleSetWithHttpInfo(java.lang.Integer rulesetId, RuleSet ruleSet) Rename Rule Set Allows user to rename a rule set
void	setApiClient(ApiClient apiClient)
RuleSet	updateRuleSet(java.io.File ruleSetXml, java.lang.Integer rulesetId) Update Rule Set Update rule set using an XML file
com.squareup.okhttp.Call	updateRuleSetAsync(java.io.File ruleSetXml, java.lang.Integer rulesetId, ApiCallback<RuleSet> callback) Update Rule Set (asynchronously) Update rule set using an XML file
com.squareup.okhttp.Call	updateRuleSetCall(java.io.File ruleSetXml, java.lang.Integer rulesetId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateRuleSet
ApiResponse<RuleSet>	updateRuleSetWithHttpInfo(java.io.File ruleSetXml, java.lang.Integer rulesetId) Update Rule Set Update rule set using an XML file
RuleSet	uploadRuleSet(java.io.File ruleSetXml) Import Rule Set Import rule set using an XML file
com.squareup.okhttp.Call	uploadRuleSetAsync(java.io.File ruleSetXml, ApiCallback<RuleSet> callback) Import Rule Set (asynchronously) Import rule set using an XML file
com.squareup.okhttp.Call	uploadRuleSetCall(java.io.File ruleSetXml, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for uploadRuleSet
ApiResponse<RuleSet>	uploadRuleSetWithHttpInfo(java.io.File ruleSetXml) Import Rule Set Import rule set using an XML file

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleSetsApi

public RuleSetsApi()

RuleSetsApi

public RuleSetsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addRuleCriteriaCall

public com.squareup.okhttp.Call addRuleCriteriaCall(java.lang.Integer rulesetId,
                                                    java.lang.Integer ruleId,
                                                    RuleCriteria ruleCriteria,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for addRuleCriteria

Parameters:

rulesetId - (required)

ruleId - (required)

ruleCriteria - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addRuleCriteria

public void addRuleCriteria(java.lang.Integer rulesetId,
                            java.lang.Integer ruleId,
                            RuleCriteria ruleCriteria)
                     throws ApiException

Add Rule Criteria Allows user to add rule criteria

Parameters:

rulesetId - (required)

ruleId - (required)

ruleCriteria - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

addRuleCriteriaWithHttpInfo

public ApiResponse<java.lang.Void> addRuleCriteriaWithHttpInfo(java.lang.Integer rulesetId,
                                                               java.lang.Integer ruleId,
                                                               RuleCriteria ruleCriteria)
                                                        throws ApiException

Add Rule Criteria Allows user to add rule criteria

Parameters:

rulesetId - (required)

ruleId - (required)

ruleCriteria - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

addRuleCriteriaAsync

public com.squareup.okhttp.Call addRuleCriteriaAsync(java.lang.Integer rulesetId,
                                                     java.lang.Integer ruleId,
                                                     RuleCriteria ruleCriteria,
                                                     ApiCallback<java.lang.Void> callback)
                                              throws ApiException

Add Rule Criteria (asynchronously) Allows user to add rule criteria

Parameters:

rulesetId - (required)

ruleId - (required)

ruleCriteria - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

cloneRuleSetCall

public com.squareup.okhttp.Call cloneRuleSetCall(java.lang.Integer rulesetId,
                                                 RuleSet ruleSet,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for cloneRuleSet

Parameters:

rulesetId - (required)

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

cloneRuleSet

public RuleSet cloneRuleSet(java.lang.Integer rulesetId,
                            RuleSet ruleSet)
                     throws ApiException

Clone Rule Set Allows user to clone a rule set

Parameters:

rulesetId - (required)

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

Returns:

RuleSet

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

cloneRuleSetWithHttpInfo

public ApiResponse<RuleSet> cloneRuleSetWithHttpInfo(java.lang.Integer rulesetId,
                                                     RuleSet ruleSet)
                                              throws ApiException

Clone Rule Set Allows user to clone a rule set

Parameters:

rulesetId - (required)

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

Returns:

ApiResponse<RuleSet>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

cloneRuleSetAsync

public com.squareup.okhttp.Call cloneRuleSetAsync(java.lang.Integer rulesetId,
                                                  RuleSet ruleSet,
                                                  ApiCallback<RuleSet> callback)
                                           throws ApiException

Clone Rule Set (asynchronously) Allows user to clone a rule set

Parameters:

rulesetId - (required)

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

createRuleCall

public com.squareup.okhttp.Call createRuleCall(java.lang.Integer rulesetId,
                                               CreateRule rule,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for createRule

Parameters:

rulesetId - (required)

rule - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createRule

public Rule createRule(java.lang.Integer rulesetId,
                       CreateRule rule)
                throws ApiException

Create Rule Allows user to create a Rule

Parameters:

rulesetId - (required)

rule - (required)

Returns:

Rule

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createRuleWithHttpInfo

public ApiResponse<Rule> createRuleWithHttpInfo(java.lang.Integer rulesetId,
                                                CreateRule rule)
                                         throws ApiException

Create Rule Allows user to create a Rule

Parameters:

rulesetId - (required)

rule - (required)

Returns:

ApiResponse<Rule>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createRuleAsync

public com.squareup.okhttp.Call createRuleAsync(java.lang.Integer rulesetId,
                                                CreateRule rule,
                                                ApiCallback<Rule> callback)
                                         throws ApiException

Create Rule (asynchronously) Allows user to create a Rule

Parameters:

rulesetId - (required)

rule - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

createRuleSetCall

public com.squareup.okhttp.Call createRuleSetCall(RuleSet ruleSet,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for createRuleSet

Parameters:

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createRuleSet

public RuleSet createRuleSet(RuleSet ruleSet)
                      throws ApiException

Create Rule Set Creates a rule set

Parameters:

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

Returns:

RuleSet

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createRuleSetWithHttpInfo

public ApiResponse<RuleSet> createRuleSetWithHttpInfo(RuleSet ruleSet)
                                               throws ApiException

Create Rule Set Creates a rule set

Parameters:

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

Returns:

ApiResponse<RuleSet>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createRuleSetAsync

public com.squareup.okhttp.Call createRuleSetAsync(RuleSet ruleSet,
                                                   ApiCallback<RuleSet> callback)
                                            throws ApiException

Create Rule Set (asynchronously) Creates a rule set

Parameters:

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

deleteRuleCall

public com.squareup.okhttp.Call deleteRuleCall(java.lang.Integer rulesetId,
                                               java.lang.Integer ruleId,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for deleteRule

Parameters:

rulesetId - (required)

ruleId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteRule

public void deleteRule(java.lang.Integer rulesetId,
                       java.lang.Integer ruleId)
                throws ApiException

Delete Rule Allows user to delete a rule

Parameters:

rulesetId - (required)

ruleId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteRuleWithHttpInfo

public ApiResponse<java.lang.Void> deleteRuleWithHttpInfo(java.lang.Integer rulesetId,
                                                          java.lang.Integer ruleId)
                                                   throws ApiException

Delete Rule Allows user to delete a rule

Parameters:

rulesetId - (required)

ruleId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteRuleAsync

public com.squareup.okhttp.Call deleteRuleAsync(java.lang.Integer rulesetId,
                                                java.lang.Integer ruleId,
                                                ApiCallback<java.lang.Void> callback)
                                         throws ApiException

Delete Rule (asynchronously) Allows user to delete a rule

Parameters:

rulesetId - (required)

ruleId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

deleteRuleCriteriaCall

public com.squareup.okhttp.Call deleteRuleCriteriaCall(java.lang.Integer rulesetId,
                                                       java.lang.Integer ruleId,
                                                       RuleCriteria ruleCriteria,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for deleteRuleCriteria

Parameters:

rulesetId - (required)

ruleId - (required)

ruleCriteria - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteRuleCriteria

public void deleteRuleCriteria(java.lang.Integer rulesetId,
                               java.lang.Integer ruleId,
                               RuleCriteria ruleCriteria)
                        throws ApiException

Delete Rule Criteria Allows user to delete rule criteria

Parameters:

rulesetId - (required)

ruleId - (required)

ruleCriteria - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteRuleCriteriaWithHttpInfo

public ApiResponse<java.lang.Void> deleteRuleCriteriaWithHttpInfo(java.lang.Integer rulesetId,
                                                                  java.lang.Integer ruleId,
                                                                  RuleCriteria ruleCriteria)
                                                           throws ApiException

Delete Rule Criteria Allows user to delete rule criteria

Parameters:

rulesetId - (required)

ruleId - (required)

ruleCriteria - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteRuleCriteriaAsync

public com.squareup.okhttp.Call deleteRuleCriteriaAsync(java.lang.Integer rulesetId,
                                                        java.lang.Integer ruleId,
                                                        RuleCriteria ruleCriteria,
                                                        ApiCallback<java.lang.Void> callback)
                                                 throws ApiException

Delete Rule Criteria (asynchronously) Allows user to delete rule criteria

Parameters:

rulesetId - (required)

ruleId - (required)

ruleCriteria - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

deleteRuleSetCall

public com.squareup.okhttp.Call deleteRuleSetCall(java.lang.Integer rulesetId,
                                                  java.lang.Boolean force,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for deleteRuleSet

Parameters:

rulesetId - (required)

force - Set to true to force delete the rule set (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteRuleSet

public RuleSetDeleteResponse deleteRuleSet(java.lang.Integer rulesetId,
                                           java.lang.Boolean force)
                                    throws ApiException

Delete Rule Set Allows user to delete a rule set

Parameters:

rulesetId - (required)

force - Set to true to force delete the rule set (optional)

Returns:

RuleSetDeleteResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteRuleSetWithHttpInfo

public ApiResponse<RuleSetDeleteResponse> deleteRuleSetWithHttpInfo(java.lang.Integer rulesetId,
                                                                    java.lang.Boolean force)
                                                             throws ApiException

Delete Rule Set Allows user to delete a rule set

Parameters:

rulesetId - (required)

force - Set to true to force delete the rule set (optional)

Returns:

ApiResponse<RuleSetDeleteResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteRuleSetAsync

public com.squareup.okhttp.Call deleteRuleSetAsync(java.lang.Integer rulesetId,
                                                   java.lang.Boolean force,
                                                   ApiCallback<RuleSetDeleteResponse> callback)
                                            throws ApiException

Delete Rule Set (asynchronously) Allows user to delete a rule set

Parameters:

rulesetId - (required)

force - Set to true to force delete the rule set (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

exportRuleSetCall

public com.squareup.okhttp.Call exportRuleSetCall(java.lang.Integer rulesetId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for exportRuleSet

Parameters:

rulesetId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

exportRuleSet

public java.io.File exportRuleSet(java.lang.Integer rulesetId)
                           throws ApiException

Export Rule Set Allows user to export a rule set as an XML file

Parameters:

rulesetId - (required)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

exportRuleSetWithHttpInfo

public ApiResponse<java.io.File> exportRuleSetWithHttpInfo(java.lang.Integer rulesetId)
                                                    throws ApiException

Export Rule Set Allows user to export a rule set as an XML file

Parameters:

rulesetId - (required)

Returns:

ApiResponse<File>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

exportRuleSetAsync

public com.squareup.okhttp.Call exportRuleSetAsync(java.lang.Integer rulesetId,
                                                   ApiCallback<java.io.File> callback)
                                            throws ApiException

Export Rule Set (asynchronously) Allows user to export a rule set as an XML file

Parameters:

rulesetId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getAllRuleSetsCall

public com.squareup.okhttp.Call getAllRuleSetsCall(ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getAllRuleSets

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllRuleSets

public java.util.List<RuleSet> getAllRuleSets()
                                       throws ApiException

Get Rule Sets Provides a list of rule sets

Returns:

List<RuleSet>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAllRuleSetsWithHttpInfo

public ApiResponse<java.util.List<RuleSet>> getAllRuleSetsWithHttpInfo()
                                                                throws ApiException

Get Rule Sets Provides a list of rule sets

Returns:

ApiResponse<List<RuleSet>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAllRuleSetsAsync

public com.squareup.okhttp.Call getAllRuleSetsAsync(ApiCallback<java.util.List<RuleSet>> callback)
                                             throws ApiException

Get Rule Sets (asynchronously) Provides a list of rule sets

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getRuleDataCall

public com.squareup.okhttp.Call getRuleDataCall(java.lang.Integer rulesetId,
                                                java.lang.Integer ruleId,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getRuleData

Parameters:

rulesetId - (required)

ruleId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getRuleData

public Rule getRuleData(java.lang.Integer rulesetId,
                        java.lang.Integer ruleId)
                 throws ApiException

Get Rule Data Allows user to view a specific rule's data

Parameters:

rulesetId - (required)

ruleId - (required)

Returns:

Rule

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getRuleDataWithHttpInfo

public ApiResponse<Rule> getRuleDataWithHttpInfo(java.lang.Integer rulesetId,
                                                 java.lang.Integer ruleId)
                                          throws ApiException

Get Rule Data Allows user to view a specific rule's data

Parameters:

rulesetId - (required)

ruleId - (required)

Returns:

ApiResponse<Rule>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getRuleDataAsync

public com.squareup.okhttp.Call getRuleDataAsync(java.lang.Integer rulesetId,
                                                 java.lang.Integer ruleId,
                                                 ApiCallback<Rule> callback)
                                          throws ApiException

Get Rule Data (asynchronously) Allows user to view a specific rule's data

Parameters:

rulesetId - (required)

ruleId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getRuleSetContentsCall

public com.squareup.okhttp.Call getRuleSetContentsCall(java.lang.Integer rulesetId,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for getRuleSetContents

Parameters:

rulesetId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getRuleSetContents

public RuleSetContents getRuleSetContents(java.lang.Integer rulesetId)
                                   throws ApiException

Get Rule Set Contents Returns an object representing the contents of a rule set

Parameters:

rulesetId - (required)

Returns:

RuleSetContents

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getRuleSetContentsWithHttpInfo

public ApiResponse<RuleSetContents> getRuleSetContentsWithHttpInfo(java.lang.Integer rulesetId)
                                                            throws ApiException

Get Rule Set Contents Returns an object representing the contents of a rule set

Parameters:

rulesetId - (required)

Returns:

ApiResponse<RuleSetContents>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getRuleSetContentsAsync

public com.squareup.okhttp.Call getRuleSetContentsAsync(java.lang.Integer rulesetId,
                                                        ApiCallback<RuleSetContents> callback)
                                                 throws ApiException

Get Rule Set Contents (asynchronously) Returns an object representing the contents of a rule set

Parameters:

rulesetId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

modifyRuleDataCall

public com.squareup.okhttp.Call modifyRuleDataCall(java.lang.Integer rulesetId,
                                                   java.lang.Integer ruleId,
                                                   CreateRule rule,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for modifyRuleData

Parameters:

rulesetId - (required)

ruleId - (required)

rule - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

modifyRuleData

public ModifyRuleResponse modifyRuleData(java.lang.Integer rulesetId,
                                         java.lang.Integer ruleId,
                                         CreateRule rule)
                                  throws ApiException

Modify Rule Descriptor Allows user to modify a specific rule's data

Parameters:

rulesetId - (required)

ruleId - (required)

rule - (required)

Returns:

ModifyRuleResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

modifyRuleDataWithHttpInfo

public ApiResponse<ModifyRuleResponse> modifyRuleDataWithHttpInfo(java.lang.Integer rulesetId,
                                                                  java.lang.Integer ruleId,
                                                                  CreateRule rule)
                                                           throws ApiException

Modify Rule Descriptor Allows user to modify a specific rule's data

Parameters:

rulesetId - (required)

ruleId - (required)

rule - (required)

Returns:

ApiResponse<ModifyRuleResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

modifyRuleDataAsync

public com.squareup.okhttp.Call modifyRuleDataAsync(java.lang.Integer rulesetId,
                                                    java.lang.Integer ruleId,
                                                    CreateRule rule,
                                                    ApiCallback<ModifyRuleResponse> callback)
                                             throws ApiException

Modify Rule Descriptor (asynchronously) Allows user to modify a specific rule's data

Parameters:

rulesetId - (required)

ruleId - (required)

rule - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

renameRuleSetCall

public com.squareup.okhttp.Call renameRuleSetCall(java.lang.Integer rulesetId,
                                                  RuleSet ruleSet,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for renameRuleSet

Parameters:

rulesetId - (required)

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

renameRuleSet

public RuleSet renameRuleSet(java.lang.Integer rulesetId,
                             RuleSet ruleSet)
                      throws ApiException

Rename Rule Set Allows user to rename a rule set

Parameters:

rulesetId - (required)

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

Returns:

RuleSet

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

renameRuleSetWithHttpInfo

public ApiResponse<RuleSet> renameRuleSetWithHttpInfo(java.lang.Integer rulesetId,
                                                      RuleSet ruleSet)
                                               throws ApiException

Rename Rule Set Allows user to rename a rule set

Parameters:

rulesetId - (required)

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

Returns:

ApiResponse<RuleSet>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

renameRuleSetAsync

public com.squareup.okhttp.Call renameRuleSetAsync(java.lang.Integer rulesetId,
                                                   RuleSet ruleSet,
                                                   ApiCallback<RuleSet> callback)
                                            throws ApiException

Rename Rule Set (asynchronously) Allows user to rename a rule set

Parameters:

rulesetId - (required)

ruleSet - The values for `id` and `canEdit` will be ignored, only `name` is required (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

updateRuleSetCall

public com.squareup.okhttp.Call updateRuleSetCall(java.io.File ruleSetXml,
                                                  java.lang.Integer rulesetId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for updateRuleSet

Parameters:

ruleSetXml - The xml file to be uploaded (required)

rulesetId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateRuleSet

public RuleSet updateRuleSet(java.io.File ruleSetXml,
                             java.lang.Integer rulesetId)
                      throws ApiException

Update Rule Set Update rule set using an XML file

Parameters:

ruleSetXml - The xml file to be uploaded (required)

rulesetId - (required)

Returns:

RuleSet

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateRuleSetWithHttpInfo

public ApiResponse<RuleSet> updateRuleSetWithHttpInfo(java.io.File ruleSetXml,
                                                      java.lang.Integer rulesetId)
                                               throws ApiException

Update Rule Set Update rule set using an XML file

Parameters:

ruleSetXml - The xml file to be uploaded (required)

rulesetId - (required)

Returns:

ApiResponse<RuleSet>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateRuleSetAsync

public com.squareup.okhttp.Call updateRuleSetAsync(java.io.File ruleSetXml,
                                                   java.lang.Integer rulesetId,
                                                   ApiCallback<RuleSet> callback)
                                            throws ApiException

Update Rule Set (asynchronously) Update rule set using an XML file

Parameters:

ruleSetXml - The xml file to be uploaded (required)

rulesetId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

uploadRuleSetCall

public com.squareup.okhttp.Call uploadRuleSetCall(java.io.File ruleSetXml,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for uploadRuleSet

Parameters:

ruleSetXml - The xml file to be uploaded (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

uploadRuleSet

public RuleSet uploadRuleSet(java.io.File ruleSetXml)
                      throws ApiException

Import Rule Set Import rule set using an XML file

Parameters:

ruleSetXml - The xml file to be uploaded (required)

Returns:

RuleSet

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

uploadRuleSetWithHttpInfo

public ApiResponse<RuleSet> uploadRuleSetWithHttpInfo(java.io.File ruleSetXml)
                                               throws ApiException

Import Rule Set Import rule set using an XML file

Parameters:

ruleSetXml - The xml file to be uploaded (required)

Returns:

ApiResponse<RuleSet>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

uploadRuleSetAsync

public com.squareup.okhttp.Call uploadRuleSetAsync(java.io.File ruleSetXml,
                                                   ApiCallback<RuleSet> callback)
                                            throws ApiException

Import Rule Set (asynchronously) Import rule set using an XML file

Parameters:

ruleSetXml - The xml file to be uploaded (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object