Class ValidationRules

Hierarchy

ValidationRules

Index

Constructors

constructor

Methods

Constructors

constructor

new ValidationRules(client: RequestController): ValidationRules

Parameters
- client: RequestController
Returns ValidationRules

Methods

create

create(validationRule: ValidationRulesCreate): Promise<ValidationRulesCreateResponse>

see

https://docs.voucherify.io/reference/create-validation-rules

Parameters
- validationRule: ValidationRulesCreate
Returns Promise<ValidationRulesCreateResponse>

createAssignment

createAssignment(validationRuleId: string, assignment: ValidationRulesCreateAssignment): Promise<ValidationRulesCreateAssignmentResponse>

see

https://docs.voucherify.io/reference/create-validation-rules-assignment

Parameters
- validationRuleId: string
- assignment: ValidationRulesCreateAssignment
Returns Promise<ValidationRulesCreateAssignmentResponse>

delete

delete(validationRuleId: string): Promise<unknown>

see

https://docs.voucherify.io/reference/delete-validation-rules

Parameters
- validationRuleId: string
Returns Promise<unknown>

deleteAssignment

deleteAssignment(validationRuleId: string, assignmentId: string): Promise<unknown>

see

https://docs.voucherify.io/reference/delete-validation-rules-assignment

Parameters
- validationRuleId: string
- assignmentId: string
Returns Promise<unknown>

get

get(validationRuleId: string): Promise<ValidationRulesGetResponse>

see

https://docs.voucherify.io/reference/get-validation-rules

Parameters
- validationRuleId: string
Returns Promise<ValidationRulesGetResponse>

list

list(params?: ValidationRulesListParams): Promise<ValidationRulesListResponse>

see

https://docs.voucherify.io/reference/list-validation-rules

Parameters
- params: ValidationRulesListParams = {}
Returns Promise<ValidationRulesListResponse>

listAssignments

listAssignments(validationRuleId: string, params?: ValidationRulesListAssignmentsParams): Promise<ValidationRulesListAssignmentsResponse>

see

https://docs.voucherify.io/reference/list-validation-rule-assignments

Parameters
- validationRuleId: string
- params: ValidationRulesListAssignmentsParams = {}
Returns Promise<ValidationRulesListAssignmentsResponse>

listRulesAssignments

listRulesAssignments(params?: ValidationRulesListRulesAssignmentsRequestQuery): Promise<ValidationRulesListRulesAssignmentsResponseBody>

see

https://docs.voucherify.io/reference/list-validation-rules-assignments

Parameters
- params: ValidationRulesListRulesAssignmentsRequestQuery = {}
Returns Promise<ValidationRulesListRulesAssignmentsResponseBody>

update

update(validationRule: ValidationRulesUpdate): Promise<ValidationRulesCreateResponse>

see

https://docs.voucherify.io/reference/update-validation-rules

Parameters
- validationRule: ValidationRulesUpdate
Returns Promise<ValidationRulesCreateResponse>

validate

validate(validationRuleId: string, params?: any): Promise<ValidationRulesValidateResponse>

Parameters
- validationRuleId: string
- params: any = {}
Returns Promise<ValidationRulesValidateResponse>