@emilgroup/validation-rules-sdk-node 1.0.1-beta.0 → 1.0.1-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +10 -0
- package/README.md +2 -2
- package/api/investigation-blocks-api.ts +231 -25
- package/api/validation-rules-api.ts +447 -12
- package/dist/api/investigation-blocks-api.d.ts +132 -20
- package/dist/api/investigation-blocks-api.js +209 -25
- package/dist/api/validation-rules-api.d.ts +244 -12
- package/dist/api/validation-rules-api.js +383 -9
- package/dist/models/cancel-investigation-block-response-class.d.ts +25 -0
- package/dist/models/cancel-investigation-block-response-class.js +15 -0
- package/dist/models/create-validation-rule-request-dto.d.ts +17 -12
- package/dist/models/create-validation-rule-request-dto.js +5 -1
- package/dist/models/execute-rule-request-dto.d.ts +41 -0
- package/dist/models/execute-rule-request-dto.js +20 -0
- package/dist/models/execute-rule-response-class.d.ts +54 -0
- package/dist/models/execute-rule-response-class.js +20 -0
- package/dist/models/execute-rule-result-class.d.ts +53 -0
- package/dist/models/execute-rule-result-class.js +20 -0
- package/dist/models/execute-rule-with-dry-run-request-dto.d.ts +30 -0
- package/dist/models/execute-rule-with-dry-run-request-dto.js +15 -0
- package/dist/models/execute-rule-with-dry-run-response-class.d.ts +36 -0
- package/dist/models/execute-rule-with-dry-run-response-class.js +15 -0
- package/dist/models/execute-rules-by-type-request-dto.d.ts +35 -0
- package/dist/models/execute-rules-by-type-request-dto.js +20 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/investigation-block-class.d.ts +25 -2
- package/dist/models/investigation-block-class.js +10 -0
- package/dist/models/resolve-investigation-block-response-class.d.ts +25 -0
- package/dist/models/resolve-investigation-block-response-class.js +15 -0
- package/dist/models/update-investigation-block-request-dto.d.ts +1 -1
- package/dist/models/update-investigation-block-request-dto.js +1 -1
- package/dist/models/update-validation-rule-request-dto.d.ts +88 -0
- package/dist/models/update-validation-rule-request-dto.js +24 -0
- package/dist/models/update-validation-rule-response-class.d.ts +25 -0
- package/dist/models/update-validation-rule-response-class.js +15 -0
- package/dist/models/validation-rule-class.d.ts +16 -5
- package/dist/models/validation-rule-class.js +5 -1
- package/models/cancel-investigation-block-response-class.ts +31 -0
- package/models/create-validation-rule-request-dto.ts +18 -12
- package/models/execute-rule-request-dto.ts +50 -0
- package/models/execute-rule-response-class.ts +63 -0
- package/models/execute-rule-result-class.ts +62 -0
- package/models/execute-rule-with-dry-run-request-dto.ts +36 -0
- package/models/execute-rule-with-dry-run-response-class.ts +42 -0
- package/models/execute-rules-by-type-request-dto.ts +44 -0
- package/models/index.ts +10 -0
- package/models/investigation-block-class.ts +29 -2
- package/models/resolve-investigation-block-response-class.ts +31 -0
- package/models/update-investigation-block-request-dto.ts +1 -1
- package/models/update-validation-rule-request-dto.ts +98 -0
- package/models/update-validation-rule-response-class.ts +31 -0
- package/models/validation-rule-class.ts +17 -5
- package/package.json +1 -1
|
@@ -14,8 +14,15 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateValidationRuleRequestDto } from '../models';
|
|
16
16
|
import { CreateValidationRuleResponseClass } from '../models';
|
|
17
|
+
import { ExecuteRuleRequestDto } from '../models';
|
|
18
|
+
import { ExecuteRuleResponseClass } from '../models';
|
|
19
|
+
import { ExecuteRuleWithDryRunRequestDto } from '../models';
|
|
20
|
+
import { ExecuteRuleWithDryRunResponseClass } from '../models';
|
|
21
|
+
import { ExecuteRulesByTypeRequestDto } from '../models';
|
|
17
22
|
import { GetValidationRuleResponseClass } from '../models';
|
|
18
23
|
import { ListValidationRulesResponseClass } from '../models';
|
|
24
|
+
import { UpdateValidationRuleRequestDto } from '../models';
|
|
25
|
+
import { UpdateValidationRuleResponseClass } from '../models';
|
|
19
26
|
/**
|
|
20
27
|
* ValidationRulesApi - axios parameter creator
|
|
21
28
|
* @export
|
|
@@ -39,6 +46,33 @@ export declare const ValidationRulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
39
46
|
* @throws {RequiredError}
|
|
40
47
|
*/
|
|
41
48
|
deleteValidationRule: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
+
/**
|
|
50
|
+
* Executes all enabled validation rules for a given entity type and entity code **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
51
|
+
* @summary Create the execute rule
|
|
52
|
+
* @param {ExecuteRuleRequestDto} executeRuleRequestDto
|
|
53
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
executeRule: (executeRuleRequestDto: ExecuteRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
/**
|
|
59
|
+
* Tests a FEEL expression against provided sample data **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
60
|
+
* @summary Create the test rule
|
|
61
|
+
* @param {ExecuteRuleWithDryRunRequestDto} executeRuleWithDryRunRequestDto
|
|
62
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
63
|
+
* @param {*} [options] Override http request option.
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
executeRuleWithDryRun: (executeRuleWithDryRunRequestDto: ExecuteRuleWithDryRunRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
|
+
/**
|
|
68
|
+
* Executes all enabled validation rules matching a given entity type and product version **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
69
|
+
* @summary Create the execute rules by type
|
|
70
|
+
* @param {ExecuteRulesByTypeRequestDto} executeRulesByTypeRequestDto
|
|
71
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
72
|
+
* @param {*} [options] Override http request option.
|
|
73
|
+
* @throws {RequiredError}
|
|
74
|
+
*/
|
|
75
|
+
executeRulesByType: (executeRulesByTypeRequestDto: ExecuteRulesByTypeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
76
|
/**
|
|
43
77
|
* Retrieves a validation rule by its code **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
44
78
|
* @summary Retrieve the validation rule
|
|
@@ -54,15 +88,24 @@ export declare const ValidationRulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
54
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
55
89
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
56
90
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
57
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
91
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
58
92
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
59
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug,
|
|
93
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, severity, isEnabled, createdAt, updatedAt</i>
|
|
60
94
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
61
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
95
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
62
96
|
* @param {*} [options] Override http request option.
|
|
63
97
|
* @throws {RequiredError}
|
|
64
98
|
*/
|
|
65
99
|
listValidationRules: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
100
|
+
/**
|
|
101
|
+
* undefined **Required Permissions** \"validation-rules-management.validation-rules.update\"
|
|
102
|
+
* @param {string} code
|
|
103
|
+
* @param {UpdateValidationRuleRequestDto} updateValidationRuleRequestDto
|
|
104
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
updateValidationRule: (code: string, updateValidationRuleRequestDto: UpdateValidationRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
109
|
};
|
|
67
110
|
/**
|
|
68
111
|
* ValidationRulesApi - functional programming interface
|
|
@@ -87,6 +130,33 @@ export declare const ValidationRulesApiFp: (configuration?: Configuration) => {
|
|
|
87
130
|
* @throws {RequiredError}
|
|
88
131
|
*/
|
|
89
132
|
deleteValidationRule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
133
|
+
/**
|
|
134
|
+
* Executes all enabled validation rules for a given entity type and entity code **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
135
|
+
* @summary Create the execute rule
|
|
136
|
+
* @param {ExecuteRuleRequestDto} executeRuleRequestDto
|
|
137
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
138
|
+
* @param {*} [options] Override http request option.
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
*/
|
|
141
|
+
executeRule(executeRuleRequestDto: ExecuteRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteRuleResponseClass>>;
|
|
142
|
+
/**
|
|
143
|
+
* Tests a FEEL expression against provided sample data **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
144
|
+
* @summary Create the test rule
|
|
145
|
+
* @param {ExecuteRuleWithDryRunRequestDto} executeRuleWithDryRunRequestDto
|
|
146
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
*/
|
|
150
|
+
executeRuleWithDryRun(executeRuleWithDryRunRequestDto: ExecuteRuleWithDryRunRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteRuleWithDryRunResponseClass>>;
|
|
151
|
+
/**
|
|
152
|
+
* Executes all enabled validation rules matching a given entity type and product version **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
153
|
+
* @summary Create the execute rules by type
|
|
154
|
+
* @param {ExecuteRulesByTypeRequestDto} executeRulesByTypeRequestDto
|
|
155
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
executeRulesByType(executeRulesByTypeRequestDto: ExecuteRulesByTypeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteRuleResponseClass>>;
|
|
90
160
|
/**
|
|
91
161
|
* Retrieves a validation rule by its code **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
92
162
|
* @summary Retrieve the validation rule
|
|
@@ -102,15 +172,24 @@ export declare const ValidationRulesApiFp: (configuration?: Configuration) => {
|
|
|
102
172
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
103
173
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
104
174
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
105
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
175
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
106
176
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
107
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug,
|
|
177
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, severity, isEnabled, createdAt, updatedAt</i>
|
|
108
178
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
109
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
179
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
110
180
|
* @param {*} [options] Override http request option.
|
|
111
181
|
* @throws {RequiredError}
|
|
112
182
|
*/
|
|
113
183
|
listValidationRules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListValidationRulesResponseClass>>;
|
|
184
|
+
/**
|
|
185
|
+
* undefined **Required Permissions** \"validation-rules-management.validation-rules.update\"
|
|
186
|
+
* @param {string} code
|
|
187
|
+
* @param {UpdateValidationRuleRequestDto} updateValidationRuleRequestDto
|
|
188
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
+
* @param {*} [options] Override http request option.
|
|
190
|
+
* @throws {RequiredError}
|
|
191
|
+
*/
|
|
192
|
+
updateValidationRule(code: string, updateValidationRuleRequestDto: UpdateValidationRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateValidationRuleResponseClass>>;
|
|
114
193
|
};
|
|
115
194
|
/**
|
|
116
195
|
* ValidationRulesApi - factory interface
|
|
@@ -135,6 +214,33 @@ export declare const ValidationRulesApiFactory: (configuration?: Configuration,
|
|
|
135
214
|
* @throws {RequiredError}
|
|
136
215
|
*/
|
|
137
216
|
deleteValidationRule(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
217
|
+
/**
|
|
218
|
+
* Executes all enabled validation rules for a given entity type and entity code **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
219
|
+
* @summary Create the execute rule
|
|
220
|
+
* @param {ExecuteRuleRequestDto} executeRuleRequestDto
|
|
221
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
222
|
+
* @param {*} [options] Override http request option.
|
|
223
|
+
* @throws {RequiredError}
|
|
224
|
+
*/
|
|
225
|
+
executeRule(executeRuleRequestDto: ExecuteRuleRequestDto, authorization?: string, options?: any): AxiosPromise<ExecuteRuleResponseClass>;
|
|
226
|
+
/**
|
|
227
|
+
* Tests a FEEL expression against provided sample data **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
228
|
+
* @summary Create the test rule
|
|
229
|
+
* @param {ExecuteRuleWithDryRunRequestDto} executeRuleWithDryRunRequestDto
|
|
230
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
|
+
* @param {*} [options] Override http request option.
|
|
232
|
+
* @throws {RequiredError}
|
|
233
|
+
*/
|
|
234
|
+
executeRuleWithDryRun(executeRuleWithDryRunRequestDto: ExecuteRuleWithDryRunRequestDto, authorization?: string, options?: any): AxiosPromise<ExecuteRuleWithDryRunResponseClass>;
|
|
235
|
+
/**
|
|
236
|
+
* Executes all enabled validation rules matching a given entity type and product version **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
237
|
+
* @summary Create the execute rules by type
|
|
238
|
+
* @param {ExecuteRulesByTypeRequestDto} executeRulesByTypeRequestDto
|
|
239
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
240
|
+
* @param {*} [options] Override http request option.
|
|
241
|
+
* @throws {RequiredError}
|
|
242
|
+
*/
|
|
243
|
+
executeRulesByType(executeRulesByTypeRequestDto: ExecuteRulesByTypeRequestDto, authorization?: string, options?: any): AxiosPromise<ExecuteRuleResponseClass>;
|
|
138
244
|
/**
|
|
139
245
|
* Retrieves a validation rule by its code **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
140
246
|
* @summary Retrieve the validation rule
|
|
@@ -150,15 +256,24 @@ export declare const ValidationRulesApiFactory: (configuration?: Configuration,
|
|
|
150
256
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
151
257
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
152
258
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
153
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
259
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
154
260
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
155
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug,
|
|
261
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, severity, isEnabled, createdAt, updatedAt</i>
|
|
156
262
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
157
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
263
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
158
264
|
* @param {*} [options] Override http request option.
|
|
159
265
|
* @throws {RequiredError}
|
|
160
266
|
*/
|
|
161
267
|
listValidationRules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListValidationRulesResponseClass>;
|
|
268
|
+
/**
|
|
269
|
+
* undefined **Required Permissions** \"validation-rules-management.validation-rules.update\"
|
|
270
|
+
* @param {string} code
|
|
271
|
+
* @param {UpdateValidationRuleRequestDto} updateValidationRuleRequestDto
|
|
272
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
273
|
+
* @param {*} [options] Override http request option.
|
|
274
|
+
* @throws {RequiredError}
|
|
275
|
+
*/
|
|
276
|
+
updateValidationRule(code: string, updateValidationRuleRequestDto: UpdateValidationRuleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateValidationRuleResponseClass>;
|
|
162
277
|
};
|
|
163
278
|
/**
|
|
164
279
|
* Request parameters for createValidationRule operation in ValidationRulesApi.
|
|
@@ -198,6 +313,63 @@ export interface ValidationRulesApiDeleteValidationRuleRequest {
|
|
|
198
313
|
*/
|
|
199
314
|
readonly authorization?: string;
|
|
200
315
|
}
|
|
316
|
+
/**
|
|
317
|
+
* Request parameters for executeRule operation in ValidationRulesApi.
|
|
318
|
+
* @export
|
|
319
|
+
* @interface ValidationRulesApiExecuteRuleRequest
|
|
320
|
+
*/
|
|
321
|
+
export interface ValidationRulesApiExecuteRuleRequest {
|
|
322
|
+
/**
|
|
323
|
+
*
|
|
324
|
+
* @type {ExecuteRuleRequestDto}
|
|
325
|
+
* @memberof ValidationRulesApiExecuteRule
|
|
326
|
+
*/
|
|
327
|
+
readonly executeRuleRequestDto: ExecuteRuleRequestDto;
|
|
328
|
+
/**
|
|
329
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
330
|
+
* @type {string}
|
|
331
|
+
* @memberof ValidationRulesApiExecuteRule
|
|
332
|
+
*/
|
|
333
|
+
readonly authorization?: string;
|
|
334
|
+
}
|
|
335
|
+
/**
|
|
336
|
+
* Request parameters for executeRuleWithDryRun operation in ValidationRulesApi.
|
|
337
|
+
* @export
|
|
338
|
+
* @interface ValidationRulesApiExecuteRuleWithDryRunRequest
|
|
339
|
+
*/
|
|
340
|
+
export interface ValidationRulesApiExecuteRuleWithDryRunRequest {
|
|
341
|
+
/**
|
|
342
|
+
*
|
|
343
|
+
* @type {ExecuteRuleWithDryRunRequestDto}
|
|
344
|
+
* @memberof ValidationRulesApiExecuteRuleWithDryRun
|
|
345
|
+
*/
|
|
346
|
+
readonly executeRuleWithDryRunRequestDto: ExecuteRuleWithDryRunRequestDto;
|
|
347
|
+
/**
|
|
348
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
349
|
+
* @type {string}
|
|
350
|
+
* @memberof ValidationRulesApiExecuteRuleWithDryRun
|
|
351
|
+
*/
|
|
352
|
+
readonly authorization?: string;
|
|
353
|
+
}
|
|
354
|
+
/**
|
|
355
|
+
* Request parameters for executeRulesByType operation in ValidationRulesApi.
|
|
356
|
+
* @export
|
|
357
|
+
* @interface ValidationRulesApiExecuteRulesByTypeRequest
|
|
358
|
+
*/
|
|
359
|
+
export interface ValidationRulesApiExecuteRulesByTypeRequest {
|
|
360
|
+
/**
|
|
361
|
+
*
|
|
362
|
+
* @type {ExecuteRulesByTypeRequestDto}
|
|
363
|
+
* @memberof ValidationRulesApiExecuteRulesByType
|
|
364
|
+
*/
|
|
365
|
+
readonly executeRulesByTypeRequestDto: ExecuteRulesByTypeRequestDto;
|
|
366
|
+
/**
|
|
367
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
368
|
+
* @type {string}
|
|
369
|
+
* @memberof ValidationRulesApiExecuteRulesByType
|
|
370
|
+
*/
|
|
371
|
+
readonly authorization?: string;
|
|
372
|
+
}
|
|
201
373
|
/**
|
|
202
374
|
* Request parameters for getValidationRule operation in ValidationRulesApi.
|
|
203
375
|
* @export
|
|
@@ -242,7 +414,7 @@ export interface ValidationRulesApiListValidationRulesRequest {
|
|
|
242
414
|
*/
|
|
243
415
|
readonly pageToken?: string;
|
|
244
416
|
/**
|
|
245
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
417
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
246
418
|
* @type {string}
|
|
247
419
|
* @memberof ValidationRulesApiListValidationRules
|
|
248
420
|
*/
|
|
@@ -254,7 +426,7 @@ export interface ValidationRulesApiListValidationRulesRequest {
|
|
|
254
426
|
*/
|
|
255
427
|
readonly search?: string;
|
|
256
428
|
/**
|
|
257
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug,
|
|
429
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, severity, isEnabled, createdAt, updatedAt</i>
|
|
258
430
|
* @type {string}
|
|
259
431
|
* @memberof ValidationRulesApiListValidationRules
|
|
260
432
|
*/
|
|
@@ -266,12 +438,37 @@ export interface ValidationRulesApiListValidationRulesRequest {
|
|
|
266
438
|
*/
|
|
267
439
|
readonly expand?: string;
|
|
268
440
|
/**
|
|
269
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
441
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, productSlug, productVersionId, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
270
442
|
* @type {string}
|
|
271
443
|
* @memberof ValidationRulesApiListValidationRules
|
|
272
444
|
*/
|
|
273
445
|
readonly filters?: string;
|
|
274
446
|
}
|
|
447
|
+
/**
|
|
448
|
+
* Request parameters for updateValidationRule operation in ValidationRulesApi.
|
|
449
|
+
* @export
|
|
450
|
+
* @interface ValidationRulesApiUpdateValidationRuleRequest
|
|
451
|
+
*/
|
|
452
|
+
export interface ValidationRulesApiUpdateValidationRuleRequest {
|
|
453
|
+
/**
|
|
454
|
+
*
|
|
455
|
+
* @type {string}
|
|
456
|
+
* @memberof ValidationRulesApiUpdateValidationRule
|
|
457
|
+
*/
|
|
458
|
+
readonly code: string;
|
|
459
|
+
/**
|
|
460
|
+
*
|
|
461
|
+
* @type {UpdateValidationRuleRequestDto}
|
|
462
|
+
* @memberof ValidationRulesApiUpdateValidationRule
|
|
463
|
+
*/
|
|
464
|
+
readonly updateValidationRuleRequestDto: UpdateValidationRuleRequestDto;
|
|
465
|
+
/**
|
|
466
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
467
|
+
* @type {string}
|
|
468
|
+
* @memberof ValidationRulesApiUpdateValidationRule
|
|
469
|
+
*/
|
|
470
|
+
readonly authorization?: string;
|
|
471
|
+
}
|
|
275
472
|
/**
|
|
276
473
|
* ValidationRulesApi - object-oriented interface
|
|
277
474
|
* @export
|
|
@@ -297,6 +494,33 @@ export declare class ValidationRulesApi extends BaseAPI {
|
|
|
297
494
|
* @memberof ValidationRulesApi
|
|
298
495
|
*/
|
|
299
496
|
deleteValidationRule(requestParameters: ValidationRulesApiDeleteValidationRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
497
|
+
/**
|
|
498
|
+
* Executes all enabled validation rules for a given entity type and entity code **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
499
|
+
* @summary Create the execute rule
|
|
500
|
+
* @param {ValidationRulesApiExecuteRuleRequest} requestParameters Request parameters.
|
|
501
|
+
* @param {*} [options] Override http request option.
|
|
502
|
+
* @throws {RequiredError}
|
|
503
|
+
* @memberof ValidationRulesApi
|
|
504
|
+
*/
|
|
505
|
+
executeRule(requestParameters: ValidationRulesApiExecuteRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteRuleResponseClass, any, {}>>;
|
|
506
|
+
/**
|
|
507
|
+
* Tests a FEEL expression against provided sample data **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
508
|
+
* @summary Create the test rule
|
|
509
|
+
* @param {ValidationRulesApiExecuteRuleWithDryRunRequest} requestParameters Request parameters.
|
|
510
|
+
* @param {*} [options] Override http request option.
|
|
511
|
+
* @throws {RequiredError}
|
|
512
|
+
* @memberof ValidationRulesApi
|
|
513
|
+
*/
|
|
514
|
+
executeRuleWithDryRun(requestParameters: ValidationRulesApiExecuteRuleWithDryRunRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteRuleWithDryRunResponseClass, any, {}>>;
|
|
515
|
+
/**
|
|
516
|
+
* Executes all enabled validation rules matching a given entity type and product version **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
517
|
+
* @summary Create the execute rules by type
|
|
518
|
+
* @param {ValidationRulesApiExecuteRulesByTypeRequest} requestParameters Request parameters.
|
|
519
|
+
* @param {*} [options] Override http request option.
|
|
520
|
+
* @throws {RequiredError}
|
|
521
|
+
* @memberof ValidationRulesApi
|
|
522
|
+
*/
|
|
523
|
+
executeRulesByType(requestParameters: ValidationRulesApiExecuteRulesByTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteRuleResponseClass, any, {}>>;
|
|
300
524
|
/**
|
|
301
525
|
* Retrieves a validation rule by its code **Required Permissions** \"validation-rules-management.validation-rules.view\"
|
|
302
526
|
* @summary Retrieve the validation rule
|
|
@@ -315,4 +539,12 @@ export declare class ValidationRulesApi extends BaseAPI {
|
|
|
315
539
|
* @memberof ValidationRulesApi
|
|
316
540
|
*/
|
|
317
541
|
listValidationRules(requestParameters?: ValidationRulesApiListValidationRulesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListValidationRulesResponseClass, any, {}>>;
|
|
542
|
+
/**
|
|
543
|
+
* undefined **Required Permissions** \"validation-rules-management.validation-rules.update\"
|
|
544
|
+
* @param {ValidationRulesApiUpdateValidationRuleRequest} requestParameters Request parameters.
|
|
545
|
+
* @param {*} [options] Override http request option.
|
|
546
|
+
* @throws {RequiredError}
|
|
547
|
+
* @memberof ValidationRulesApi
|
|
548
|
+
*/
|
|
549
|
+
updateValidationRule(requestParameters: ValidationRulesApiUpdateValidationRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateValidationRuleResponseClass, any, {}>>;
|
|
318
550
|
}
|