Package io.voucherify.client.api
Class ValidationRulesApi
java.lang.Object
io.voucherify.client.api.ValidationRulesApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateValidationRuleAssignment(String validationRuleId, Boolean force, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody) Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution.okhttp3.CallcreateValidationRuleAssignmentAsync(String validationRuleId, Boolean force, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, ApiCallback<ValidationRulesAssignmentsCreateResponseBody> _callback) Create Validation Rules Assignments (asynchronously) Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution.okhttp3.CallcreateValidationRuleAssignmentCall(String validationRuleId, Boolean force, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, ApiCallback _callback) Build call for createValidationRuleAssignmentcreateValidationRuleAssignmentWithHttpInfo(String validationRuleId, Boolean force, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody) Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution.createValidationRules(ValidationRulesCreateRequestBody validationRulesCreateRequestBody) Create Validation Rules Create validation rules.okhttp3.CallcreateValidationRulesAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, ApiCallback<ValidationRulesCreateResponseBody> _callback) Create Validation Rules (asynchronously) Create validation rules.okhttp3.CallcreateValidationRulesCall(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, ApiCallback _callback) Build call for createValidationRulescreateValidationRulesWithHttpInfo(ValidationRulesCreateRequestBody validationRulesCreateRequestBody) Create Validation Rules Create validation rules.voiddeleteValidationRuleAssignment(String validationRuleId, String assignmentId) Delete Validation Rule Assignment This method deletes a validation rule assignment.okhttp3.CalldeleteValidationRuleAssignmentAsync(String validationRuleId, String assignmentId, ApiCallback<Void> _callback) Delete Validation Rule Assignment (asynchronously) This method deletes a validation rule assignment.okhttp3.CalldeleteValidationRuleAssignmentCall(String validationRuleId, String assignmentId, ApiCallback _callback) Build call for deleteValidationRuleAssignmentdeleteValidationRuleAssignmentWithHttpInfo(String validationRuleId, String assignmentId) Delete Validation Rule Assignment This method deletes a validation rule assignment.voiddeleteValidationRules(String validationRuleId) Delete Validation Rule This method deletes a validation rule.okhttp3.CalldeleteValidationRulesAsync(String validationRuleId, ApiCallback<Void> _callback) Delete Validation Rule (asynchronously) This method deletes a validation rule.okhttp3.CalldeleteValidationRulesCall(String validationRuleId, ApiCallback _callback) Build call for deleteValidationRulesdeleteValidationRulesWithHttpInfo(String validationRuleId) Delete Validation Rule This method deletes a validation rule.intgetValidationRule(String validationRuleId) Get Validation Rule Retrieve the details of a validation rule.okhttp3.CallgetValidationRuleAsync(String validationRuleId, ApiCallback<ValidationRulesGetResponseBody> _callback) Get Validation Rule (asynchronously) Retrieve the details of a validation rule.okhttp3.CallgetValidationRuleCall(String validationRuleId, ApiCallback _callback) Build call for getValidationRulegetValidationRuleWithHttpInfo(String validationRuleId) Get Validation Rule Retrieve the details of a validation rule.listValidationRuleAssignments(String validationRuleId, Integer limit, Integer page, ParameterOrderListValidationRuleAssignments order) List Validation Rule Assignments Retrieve validation rule assignments for a specific validation rule.okhttp3.CalllistValidationRuleAssignmentsAsync(String validationRuleId, Integer limit, Integer page, ParameterOrderListValidationRuleAssignments order, ApiCallback<ValidationRulesAssignmentsListResponseBody> _callback) List Validation Rule Assignments (asynchronously) Retrieve validation rule assignments for a specific validation rule.okhttp3.CalllistValidationRuleAssignmentsCall(String validationRuleId, Integer limit, Integer page, ParameterOrderListValidationRuleAssignments order, ApiCallback _callback) Build call for listValidationRuleAssignmentslistValidationRuleAssignmentsWithHttpInfo(String validationRuleId, Integer limit, Integer page, ParameterOrderListValidationRuleAssignments order) List Validation Rule Assignments Retrieve validation rule assignments for a specific validation rule.listValidationRules(Integer limit, Integer page, ParameterOrderListValidationRules order, OffsetDateTime startDate, OffsetDateTime endDate) List Validation Rules Retrieve validation rules.listValidationRulesAssignments(String relatedObjectId, String rule, Integer page, Integer limit, String order) List Validation Rules' Assignment(s) List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters.okhttp3.CalllistValidationRulesAssignmentsAsync(String relatedObjectId, String rule, Integer page, Integer limit, String order, ApiCallback<ValidationRulesAssignmentsListResponseBody> _callback) List Validation Rules' Assignment(s) (asynchronously) List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters.okhttp3.CalllistValidationRulesAssignmentsCall(String relatedObjectId, String rule, Integer page, Integer limit, String order, ApiCallback _callback) Build call for listValidationRulesAssignmentslistValidationRulesAssignmentsWithHttpInfo(String relatedObjectId, String rule, Integer page, Integer limit, String order) List Validation Rules' Assignment(s) List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters.okhttp3.CalllistValidationRulesAsync(Integer limit, Integer page, ParameterOrderListValidationRules order, OffsetDateTime startDate, OffsetDateTime endDate, ApiCallback<ValidationRulesListResponseBody> _callback) List Validation Rules (asynchronously) Retrieve validation rules.okhttp3.CalllistValidationRulesCall(Integer limit, Integer page, ParameterOrderListValidationRules order, OffsetDateTime startDate, OffsetDateTime endDate, ApiCallback _callback) Build call for listValidationRuleslistValidationRulesWithHttpInfo(Integer limit, Integer page, ParameterOrderListValidationRules order, OffsetDateTime startDate, OffsetDateTime endDate) List Validation Rules Retrieve validation rules.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex) updateValidationRule(String validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody) Update Validation Rule Update validation rule parameters.okhttp3.CallupdateValidationRuleAsync(String validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, ApiCallback<ValidationRulesUpdateResponseBody> _callback) Update Validation Rule (asynchronously) Update validation rule parameters.okhttp3.CallupdateValidationRuleCall(String validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, ApiCallback _callback) Build call for updateValidationRuleupdateValidationRuleWithHttpInfo(String validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody) Update Validation Rule Update validation rule parameters.
-
Constructor Details
-
ValidationRulesApi
public ValidationRulesApi() -
ValidationRulesApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
createValidationRuleAssignmentCall
public okhttp3.Call createValidationRuleAssignmentCall(String validationRuleId, Boolean force, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, ApiCallback _callback) throws ApiException Build call for createValidationRuleAssignment- Parameters:
validationRuleId- Unique validation rule ID. (required)force- If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional)validationRulesAssignmentsCreateRequestBody- Specify the resource that you would like to assign the validation rule to. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
createValidationRuleAssignment
public ValidationRulesAssignmentsCreateResponseBody createValidationRuleAssignment(String validationRuleId, Boolean force, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody) throws ApiException Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution.- Parameters:
validationRuleId- Unique validation rule ID. (required)force- If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional)validationRulesAssignmentsCreateRequestBody- Specify the resource that you would like to assign the validation rule to. (optional)- Returns:
- ValidationRulesAssignmentsCreateResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createValidationRuleAssignmentWithHttpInfo
public ApiResponse<ValidationRulesAssignmentsCreateResponseBody> createValidationRuleAssignmentWithHttpInfo(String validationRuleId, Boolean force, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody) throws ApiException Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution.- Parameters:
validationRuleId- Unique validation rule ID. (required)force- If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional)validationRulesAssignmentsCreateRequestBody- Specify the resource that you would like to assign the validation rule to. (optional)- Returns:
- ApiResponse<ValidationRulesAssignmentsCreateResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createValidationRuleAssignmentAsync
public okhttp3.Call createValidationRuleAssignmentAsync(String validationRuleId, Boolean force, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, ApiCallback<ValidationRulesAssignmentsCreateResponseBody> _callback) throws ApiException Create Validation Rules Assignments (asynchronously) Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution.- Parameters:
validationRuleId- Unique validation rule ID. (required)force- If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional)validationRulesAssignmentsCreateRequestBody- Specify the resource that you would like to assign the validation rule to. (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
-
createValidationRulesCall
public okhttp3.Call createValidationRulesCall(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, ApiCallback _callback) throws ApiException Build call for createValidationRules- Parameters:
validationRulesCreateRequestBody- Specify the validation rules parameters. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
createValidationRules
public ValidationRulesCreateResponseBody createValidationRules(ValidationRulesCreateRequestBody validationRulesCreateRequestBody) throws ApiException Create Validation Rules Create validation rules.- Parameters:
validationRulesCreateRequestBody- Specify the validation rules parameters. (optional)- Returns:
- ValidationRulesCreateResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createValidationRulesWithHttpInfo
public ApiResponse<ValidationRulesCreateResponseBody> createValidationRulesWithHttpInfo(ValidationRulesCreateRequestBody validationRulesCreateRequestBody) throws ApiException Create Validation Rules Create validation rules.- Parameters:
validationRulesCreateRequestBody- Specify the validation rules parameters. (optional)- Returns:
- ApiResponse<ValidationRulesCreateResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createValidationRulesAsync
public okhttp3.Call createValidationRulesAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, ApiCallback<ValidationRulesCreateResponseBody> _callback) throws ApiException Create Validation Rules (asynchronously) Create validation rules.- Parameters:
validationRulesCreateRequestBody- Specify the validation rules parameters. (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
-
deleteValidationRuleAssignmentCall
public okhttp3.Call deleteValidationRuleAssignmentCall(String validationRuleId, String assignmentId, ApiCallback _callback) throws ApiException Build call for deleteValidationRuleAssignment- Parameters:
validationRuleId- A unique validation rule ID. (required)assignmentId- A unique validation rule assignment ID. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
deleteValidationRuleAssignment
public void deleteValidationRuleAssignment(String validationRuleId, String assignmentId) throws ApiException Delete Validation Rule Assignment This method deletes a validation rule assignment.- Parameters:
validationRuleId- A unique validation rule ID. (required)assignmentId- A unique validation rule assignment ID. (required)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteValidationRuleAssignmentWithHttpInfo
public ApiResponse<Void> deleteValidationRuleAssignmentWithHttpInfo(String validationRuleId, String assignmentId) throws ApiException Delete Validation Rule Assignment This method deletes a validation rule assignment.- Parameters:
validationRuleId- A unique validation rule ID. (required)assignmentId- A unique validation rule assignment ID. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteValidationRuleAssignmentAsync
public okhttp3.Call deleteValidationRuleAssignmentAsync(String validationRuleId, String assignmentId, ApiCallback<Void> _callback) throws ApiException Delete Validation Rule Assignment (asynchronously) This method deletes a validation rule assignment.- Parameters:
validationRuleId- A unique validation rule ID. (required)assignmentId- A unique validation rule assignment ID. (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
-
deleteValidationRulesCall
public okhttp3.Call deleteValidationRulesCall(String validationRuleId, ApiCallback _callback) throws ApiException Build call for deleteValidationRules- Parameters:
validationRuleId- A unique validation rule ID. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
deleteValidationRules
Delete Validation Rule This method deletes a validation rule.- Parameters:
validationRuleId- A unique validation rule ID. (required)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteValidationRulesWithHttpInfo
public ApiResponse<Void> deleteValidationRulesWithHttpInfo(String validationRuleId) throws ApiException Delete Validation Rule This method deletes a validation rule.- Parameters:
validationRuleId- A unique validation rule ID. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteValidationRulesAsync
public okhttp3.Call deleteValidationRulesAsync(String validationRuleId, ApiCallback<Void> _callback) throws ApiException Delete Validation Rule (asynchronously) This method deletes a validation rule.- Parameters:
validationRuleId- A unique validation rule ID. (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
-
getValidationRuleCall
public okhttp3.Call getValidationRuleCall(String validationRuleId, ApiCallback _callback) throws ApiException Build call for getValidationRule- Parameters:
validationRuleId- A unique validation rule ID. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getValidationRule
public ValidationRulesGetResponseBody getValidationRule(String validationRuleId) throws ApiException Get Validation Rule Retrieve the details of a validation rule.- Parameters:
validationRuleId- A unique validation rule ID. (required)- Returns:
- ValidationRulesGetResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getValidationRuleWithHttpInfo
public ApiResponse<ValidationRulesGetResponseBody> getValidationRuleWithHttpInfo(String validationRuleId) throws ApiException Get Validation Rule Retrieve the details of a validation rule.- Parameters:
validationRuleId- A unique validation rule ID. (required)- Returns:
- ApiResponse<ValidationRulesGetResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getValidationRuleAsync
public okhttp3.Call getValidationRuleAsync(String validationRuleId, ApiCallback<ValidationRulesGetResponseBody> _callback) throws ApiException Get Validation Rule (asynchronously) Retrieve the details of a validation rule.- Parameters:
validationRuleId- A unique validation rule ID. (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
-
listValidationRuleAssignmentsCall
public okhttp3.Call listValidationRuleAssignmentsCall(String validationRuleId, Integer limit, Integer page, ParameterOrderListValidationRuleAssignments order, ApiCallback _callback) throws ApiException Build call for listValidationRuleAssignments- Parameters:
validationRuleId- Unique validation rule ID. (required)limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)page- Which page of results to return. The lowest value is 1. (optional)order- This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
listValidationRuleAssignments
public ValidationRulesAssignmentsListResponseBody listValidationRuleAssignments(String validationRuleId, Integer limit, Integer page, ParameterOrderListValidationRuleAssignments order) throws ApiException List Validation Rule Assignments Retrieve validation rule assignments for a specific validation rule.- Parameters:
validationRuleId- Unique validation rule ID. (required)limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)page- Which page of results to return. The lowest value is 1. (optional)order- This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)- Returns:
- ValidationRulesAssignmentsListResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listValidationRuleAssignmentsWithHttpInfo
public ApiResponse<ValidationRulesAssignmentsListResponseBody> listValidationRuleAssignmentsWithHttpInfo(String validationRuleId, Integer limit, Integer page, ParameterOrderListValidationRuleAssignments order) throws ApiException List Validation Rule Assignments Retrieve validation rule assignments for a specific validation rule.- Parameters:
validationRuleId- Unique validation rule ID. (required)limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)page- Which page of results to return. The lowest value is 1. (optional)order- This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)- Returns:
- ApiResponse<ValidationRulesAssignmentsListResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listValidationRuleAssignmentsAsync
public okhttp3.Call listValidationRuleAssignmentsAsync(String validationRuleId, Integer limit, Integer page, ParameterOrderListValidationRuleAssignments order, ApiCallback<ValidationRulesAssignmentsListResponseBody> _callback) throws ApiException List Validation Rule Assignments (asynchronously) Retrieve validation rule assignments for a specific validation rule.- Parameters:
validationRuleId- Unique validation rule ID. (required)limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)page- Which page of results to return. The lowest value is 1. (optional)order- This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (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
-
listValidationRulesCall
public okhttp3.Call listValidationRulesCall(Integer limit, Integer page, ParameterOrderListValidationRules order, OffsetDateTime startDate, OffsetDateTime endDate, ApiCallback _callback) throws ApiException Build call for listValidationRules- Parameters:
limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)page- Which page of results to return. The lowest value is 1. (optional)order- This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)startDate- Timestamp representing the date and time which results must start on. Represented in ISO 8601 format. (optional)endDate- Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
listValidationRules
public ValidationRulesListResponseBody listValidationRules(Integer limit, Integer page, ParameterOrderListValidationRules order, OffsetDateTime startDate, OffsetDateTime endDate) throws ApiException List Validation Rules Retrieve validation rules.- Parameters:
limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)page- Which page of results to return. The lowest value is 1. (optional)order- This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)startDate- Timestamp representing the date and time which results must start on. Represented in ISO 8601 format. (optional)endDate- Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. (optional)- Returns:
- ValidationRulesListResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listValidationRulesWithHttpInfo
public ApiResponse<ValidationRulesListResponseBody> listValidationRulesWithHttpInfo(Integer limit, Integer page, ParameterOrderListValidationRules order, OffsetDateTime startDate, OffsetDateTime endDate) throws ApiException List Validation Rules Retrieve validation rules.- Parameters:
limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)page- Which page of results to return. The lowest value is 1. (optional)order- This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)startDate- Timestamp representing the date and time which results must start on. Represented in ISO 8601 format. (optional)endDate- Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. (optional)- Returns:
- ApiResponse<ValidationRulesListResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listValidationRulesAsync
public okhttp3.Call listValidationRulesAsync(Integer limit, Integer page, ParameterOrderListValidationRules order, OffsetDateTime startDate, OffsetDateTime endDate, ApiCallback<ValidationRulesListResponseBody> _callback) throws ApiException List Validation Rules (asynchronously) Retrieve validation rules.- Parameters:
limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)page- Which page of results to return. The lowest value is 1. (optional)order- This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)startDate- Timestamp representing the date and time which results must start on. Represented in ISO 8601 format. (optional)endDate- Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. (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
-
listValidationRulesAssignmentsCall
public okhttp3.Call listValidationRulesAssignmentsCall(String relatedObjectId, String rule, Integer page, Integer limit, String order, ApiCallback _callback) throws ApiException Build call for listValidationRulesAssignments- Parameters:
relatedObjectId- The resource ID to which the validation rule was assigned; this could be, for example, a resource ID of a voucher, campaign, earning rule, reward assignment, promotion tier, or distribution. (optional)rule- Validation rule ID. (optional)page- Which page of results to return. The lowest value is 1. (optional)limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)order- Sorts the results using one of the filtering options: -created_at, created_at, where the dash - preceding a sorting option means sorting in a descending order. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
listValidationRulesAssignments
public ValidationRulesAssignmentsListResponseBody listValidationRulesAssignments(String relatedObjectId, String rule, Integer page, Integer limit, String order) throws ApiException List Validation Rules' Assignment(s) List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters. # How to retrieve specific validation rule assignments(s) ## Related object ID To find an assignment for a particular resource, you can use the ID of the object to which the validation rule was assigned. This could be, for example, an ID of a: voucher, campaign, distribution, reward assignment, earning rule, promotion tier. ## Validation rule ID You can use the validation rule ID to find assignment(s) for a specific validation rule.- Parameters:
relatedObjectId- The resource ID to which the validation rule was assigned; this could be, for example, a resource ID of a voucher, campaign, earning rule, reward assignment, promotion tier, or distribution. (optional)rule- Validation rule ID. (optional)page- Which page of results to return. The lowest value is 1. (optional)limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)order- Sorts the results using one of the filtering options: -created_at, created_at, where the dash - preceding a sorting option means sorting in a descending order. (optional)- Returns:
- ValidationRulesAssignmentsListResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listValidationRulesAssignmentsWithHttpInfo
public ApiResponse<ValidationRulesAssignmentsListResponseBody> listValidationRulesAssignmentsWithHttpInfo(String relatedObjectId, String rule, Integer page, Integer limit, String order) throws ApiException List Validation Rules' Assignment(s) List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters. # How to retrieve specific validation rule assignments(s) ## Related object ID To find an assignment for a particular resource, you can use the ID of the object to which the validation rule was assigned. This could be, for example, an ID of a: voucher, campaign, distribution, reward assignment, earning rule, promotion tier. ## Validation rule ID You can use the validation rule ID to find assignment(s) for a specific validation rule.- Parameters:
relatedObjectId- The resource ID to which the validation rule was assigned; this could be, for example, a resource ID of a voucher, campaign, earning rule, reward assignment, promotion tier, or distribution. (optional)rule- Validation rule ID. (optional)page- Which page of results to return. The lowest value is 1. (optional)limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)order- Sorts the results using one of the filtering options: -created_at, created_at, where the dash - preceding a sorting option means sorting in a descending order. (optional)- Returns:
- ApiResponse<ValidationRulesAssignmentsListResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listValidationRulesAssignmentsAsync
public okhttp3.Call listValidationRulesAssignmentsAsync(String relatedObjectId, String rule, Integer page, Integer limit, String order, ApiCallback<ValidationRulesAssignmentsListResponseBody> _callback) throws ApiException List Validation Rules' Assignment(s) (asynchronously) List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters. # How to retrieve specific validation rule assignments(s) ## Related object ID To find an assignment for a particular resource, you can use the ID of the object to which the validation rule was assigned. This could be, for example, an ID of a: voucher, campaign, distribution, reward assignment, earning rule, promotion tier. ## Validation rule ID You can use the validation rule ID to find assignment(s) for a specific validation rule.- Parameters:
relatedObjectId- The resource ID to which the validation rule was assigned; this could be, for example, a resource ID of a voucher, campaign, earning rule, reward assignment, promotion tier, or distribution. (optional)rule- Validation rule ID. (optional)page- Which page of results to return. The lowest value is 1. (optional)limit- Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)order- Sorts the results using one of the filtering options: -created_at, created_at, where the dash - preceding a sorting option means sorting in a descending order. (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
-
updateValidationRuleCall
public okhttp3.Call updateValidationRuleCall(String validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, ApiCallback _callback) throws ApiException Build call for updateValidationRule- Parameters:
validationRuleId- A unique validation rule ID. (required)validationRulesUpdateRequestBody- Specify the parameters to be updated. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateValidationRule
public ValidationRulesUpdateResponseBody updateValidationRule(String validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody) throws ApiException Update Validation Rule Update validation rule parameters.- Parameters:
validationRuleId- A unique validation rule ID. (required)validationRulesUpdateRequestBody- Specify the parameters to be updated. (optional)- Returns:
- ValidationRulesUpdateResponseBody
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateValidationRuleWithHttpInfo
public ApiResponse<ValidationRulesUpdateResponseBody> updateValidationRuleWithHttpInfo(String validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody) throws ApiException Update Validation Rule Update validation rule parameters.- Parameters:
validationRuleId- A unique validation rule ID. (required)validationRulesUpdateRequestBody- Specify the parameters to be updated. (optional)- Returns:
- ApiResponse<ValidationRulesUpdateResponseBody>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateValidationRuleAsync
public okhttp3.Call updateValidationRuleAsync(String validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, ApiCallback<ValidationRulesUpdateResponseBody> _callback) throws ApiException Update Validation Rule (asynchronously) Update validation rule parameters.- Parameters:
validationRuleId- A unique validation rule ID. (required)validationRulesUpdateRequestBody- Specify the parameters to be updated. (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
-