@platformatic/watt-extra 0.1.9 → 1.0.1-alpha.0

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.
Files changed (10) hide show
  1. package/LICENSE +201 -0
  2. package/clients/compliance/compliance-types.d.ts +1125 -725
  3. package/clients/compliance/compliance.mjs +780 -449
  4. package/clients/compliance/compliance.openapi.json +509 -447
  5. package/package.json +8 -2
  6. package/plugins/compliancy.js +9 -3
  7. package/plugins/init.js +4 -1
  8. package/test/compliancy.test.js +3 -2
  9. package/test/helper.js +2 -9
  10. package/test/init.test.js +2 -0
package/clients/compliance/compliance-types.d.ts CHANGED
@@ -5,812 +5,1021 @@ export interface FullResponse<T, U extends number> {
5
5
  }
6
6
 
7
7
  export type GetReportsRequest = {
8
- 'limit'?: number;
9
- 'offset'?: number;
10
- 'totalCount'?: boolean;
11
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
12
- 'where.applicationId.eq'?: string;
13
- 'where.applicationId.neq'?: string;
14
- 'where.applicationId.gt'?: string;
15
- 'where.applicationId.gte'?: string;
16
- 'where.applicationId.lt'?: string;
17
- 'where.applicationId.lte'?: string;
18
- 'where.applicationId.like'?: string;
19
- 'where.applicationId.in'?: string;
20
- 'where.applicationId.nin'?: string;
21
- 'where.applicationId.contains'?: string;
22
- 'where.applicationId.contained'?: string;
23
- 'where.applicationId.overlaps'?: string;
24
- 'where.bundleId.eq'?: string;
25
- 'where.bundleId.neq'?: string;
26
- 'where.bundleId.gt'?: string;
27
- 'where.bundleId.gte'?: string;
28
- 'where.bundleId.lt'?: string;
29
- 'where.bundleId.lte'?: string;
30
- 'where.bundleId.like'?: string;
31
- 'where.bundleId.in'?: string;
32
- 'where.bundleId.nin'?: string;
33
- 'where.bundleId.contains'?: string;
34
- 'where.bundleId.contained'?: string;
35
- 'where.bundleId.overlaps'?: string;
36
- 'where.createdAt.eq'?: string;
37
- 'where.createdAt.neq'?: string;
38
- 'where.createdAt.gt'?: string;
39
- 'where.createdAt.gte'?: string;
40
- 'where.createdAt.lt'?: string;
41
- 'where.createdAt.lte'?: string;
42
- 'where.createdAt.like'?: string;
43
- 'where.createdAt.in'?: string;
44
- 'where.createdAt.nin'?: string;
45
- 'where.createdAt.contains'?: string;
46
- 'where.createdAt.contained'?: string;
47
- 'where.createdAt.overlaps'?: string;
48
- 'where.id.eq'?: string;
49
- 'where.id.neq'?: string;
50
- 'where.id.gt'?: string;
51
- 'where.id.gte'?: string;
52
- 'where.id.lt'?: string;
53
- 'where.id.lte'?: string;
54
- 'where.id.like'?: string;
55
- 'where.id.in'?: string;
56
- 'where.id.nin'?: string;
57
- 'where.id.contains'?: string;
58
- 'where.id.contained'?: string;
59
- 'where.id.overlaps'?: string;
60
- 'where.result.eq'?: boolean;
61
- 'where.result.neq'?: boolean;
62
- 'where.result.gt'?: boolean;
63
- 'where.result.gte'?: boolean;
64
- 'where.result.lt'?: boolean;
65
- 'where.result.lte'?: boolean;
66
- 'where.result.like'?: boolean;
67
- 'where.result.in'?: string;
68
- 'where.result.nin'?: string;
69
- 'where.result.contains'?: string;
70
- 'where.result.contained'?: string;
71
- 'where.result.overlaps'?: string;
72
- 'where.ruleSet.eq'?: string;
73
- 'where.ruleSet.neq'?: string;
74
- 'where.ruleSet.gt'?: string;
75
- 'where.ruleSet.gte'?: string;
76
- 'where.ruleSet.lt'?: string;
77
- 'where.ruleSet.lte'?: string;
78
- 'where.ruleSet.like'?: string;
79
- 'where.ruleSet.in'?: string;
80
- 'where.ruleSet.nin'?: string;
81
- 'where.ruleSet.contains'?: string;
82
- 'where.ruleSet.contained'?: string;
83
- 'where.ruleSet.overlaps'?: string;
84
- 'where.or'?: Array<string>;
85
- 'orderby.applicationId'?: 'asc' | 'desc';
86
- 'orderby.bundleId'?: 'asc' | 'desc';
87
- 'orderby.createdAt'?: 'asc' | 'desc';
88
- 'orderby.id'?: 'asc' | 'desc';
89
- 'orderby.result'?: 'asc' | 'desc';
90
- 'orderby.ruleSet'?: 'asc' | 'desc';
8
+ query?: {
9
+ /**
10
+ * Limit will be applied by default if not passed. If the provided value exceeds the maximum allowed value a validation error will be thrown
11
+ */
12
+ 'limit'?: number;
13
+ 'offset'?: number;
14
+ 'totalCount'?: boolean;
15
+ /**
16
+ * Include cursor headers in response. Cursor keys built from orderBy clause
17
+ */
18
+ 'cursor'?: boolean;
19
+ /**
20
+ * Cursor for forward pagination. List objects after this cursor position
21
+ */
22
+ 'startAfter'?: string;
23
+ /**
24
+ * Cursor for backward pagination. List objects before this cursor position
25
+ */
26
+ 'endBefore'?: string;
27
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
28
+ 'where.applicationId.eq'?: string;
29
+ 'where.applicationId.neq'?: string;
30
+ 'where.applicationId.gt'?: string;
31
+ 'where.applicationId.gte'?: string;
32
+ 'where.applicationId.lt'?: string;
33
+ 'where.applicationId.lte'?: string;
34
+ 'where.applicationId.like'?: string;
35
+ 'where.applicationId.ilike'?: string;
36
+ 'where.applicationId.in'?: string;
37
+ 'where.applicationId.nin'?: string;
38
+ 'where.applicationId.contains'?: string;
39
+ 'where.applicationId.contained'?: string;
40
+ 'where.applicationId.overlaps'?: string;
41
+ 'where.createdAt.eq'?: string;
42
+ 'where.createdAt.neq'?: string;
43
+ 'where.createdAt.gt'?: string;
44
+ 'where.createdAt.gte'?: string;
45
+ 'where.createdAt.lt'?: string;
46
+ 'where.createdAt.lte'?: string;
47
+ 'where.createdAt.like'?: string;
48
+ 'where.createdAt.ilike'?: string;
49
+ 'where.createdAt.in'?: string;
50
+ 'where.createdAt.nin'?: string;
51
+ 'where.createdAt.contains'?: string;
52
+ 'where.createdAt.contained'?: string;
53
+ 'where.createdAt.overlaps'?: string;
54
+ 'where.id.eq'?: string;
55
+ 'where.id.neq'?: string;
56
+ 'where.id.gt'?: string;
57
+ 'where.id.gte'?: string;
58
+ 'where.id.lt'?: string;
59
+ 'where.id.lte'?: string;
60
+ 'where.id.like'?: string;
61
+ 'where.id.ilike'?: string;
62
+ 'where.id.in'?: string;
63
+ 'where.id.nin'?: string;
64
+ 'where.id.contains'?: string;
65
+ 'where.id.contained'?: string;
66
+ 'where.id.overlaps'?: string;
67
+ 'where.result.eq'?: boolean;
68
+ 'where.result.neq'?: boolean;
69
+ 'where.result.gt'?: boolean;
70
+ 'where.result.gte'?: boolean;
71
+ 'where.result.lt'?: boolean;
72
+ 'where.result.lte'?: boolean;
73
+ 'where.result.like'?: boolean;
74
+ 'where.result.ilike'?: boolean;
75
+ 'where.result.in'?: string;
76
+ 'where.result.nin'?: string;
77
+ 'where.result.contains'?: string;
78
+ 'where.result.contained'?: string;
79
+ 'where.result.overlaps'?: string;
80
+ 'where.ruleSet.eq'?: string;
81
+ 'where.ruleSet.neq'?: string;
82
+ 'where.ruleSet.gt'?: string;
83
+ 'where.ruleSet.gte'?: string;
84
+ 'where.ruleSet.lt'?: string;
85
+ 'where.ruleSet.lte'?: string;
86
+ 'where.ruleSet.like'?: string;
87
+ 'where.ruleSet.ilike'?: string;
88
+ 'where.ruleSet.in'?: string;
89
+ 'where.ruleSet.nin'?: string;
90
+ 'where.ruleSet.contains'?: string;
91
+ 'where.ruleSet.contained'?: string;
92
+ 'where.ruleSet.overlaps'?: string;
93
+ 'where.or'?: Array<string>;
94
+ 'orderby.applicationId'?: 'asc' | 'desc';
95
+ 'orderby.createdAt'?: 'asc' | 'desc';
96
+ 'orderby.id'?: 'asc' | 'desc';
97
+ 'orderby.result'?: 'asc' | 'desc';
98
+ 'orderby.ruleSet'?: 'asc' | 'desc';
99
+ }
91
100
  }
92
101
 
93
- export type GetReportsResponseOK = Array<{ 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object; 'createdAt'?: string | null }>
102
+ /**
103
+ * Default Response
104
+ */
105
+ export type GetReportsResponseOK = Array<{ 'id'?: string | null; 'applicationId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object | null; 'createdAt'?: string | null }>
94
106
  export type GetReportsResponses =
95
- GetReportsResponseOK
107
+ FullResponse<GetReportsResponseOK, 200>
96
108
 
97
109
  export type CreateReportRequest = {
98
- 'id'?: string;
99
- 'applicationId'?: string | null;
100
- 'bundleId'?: string | null;
101
- 'result': boolean;
102
- 'ruleSet': object;
103
- 'createdAt'?: string | null;
110
+ query?: {
111
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
112
+ }
113
+ body: {
114
+ 'id'?: string;
115
+ 'applicationId'?: string | null;
116
+ 'result': boolean;
117
+ 'ruleSet': object;
118
+ 'createdAt'?: string | null;
119
+ }
104
120
  }
105
121
 
106
- export type CreateReportResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object; 'createdAt'?: string | null }
122
+ /**
123
+ * A Report
124
+ */
125
+ export type CreateReportResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object | null; 'createdAt'?: string | null }
107
126
  export type CreateReportResponses =
108
- CreateReportResponseOK
127
+ FullResponse<CreateReportResponseOK, 200>
109
128
 
110
129
  export type UpdateReportsRequest = {
111
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
112
- 'where.applicationId.eq'?: string;
113
- 'where.applicationId.neq'?: string;
114
- 'where.applicationId.gt'?: string;
115
- 'where.applicationId.gte'?: string;
116
- 'where.applicationId.lt'?: string;
117
- 'where.applicationId.lte'?: string;
118
- 'where.applicationId.like'?: string;
119
- 'where.applicationId.in'?: string;
120
- 'where.applicationId.nin'?: string;
121
- 'where.applicationId.contains'?: string;
122
- 'where.applicationId.contained'?: string;
123
- 'where.applicationId.overlaps'?: string;
124
- 'where.bundleId.eq'?: string;
125
- 'where.bundleId.neq'?: string;
126
- 'where.bundleId.gt'?: string;
127
- 'where.bundleId.gte'?: string;
128
- 'where.bundleId.lt'?: string;
129
- 'where.bundleId.lte'?: string;
130
- 'where.bundleId.like'?: string;
131
- 'where.bundleId.in'?: string;
132
- 'where.bundleId.nin'?: string;
133
- 'where.bundleId.contains'?: string;
134
- 'where.bundleId.contained'?: string;
135
- 'where.bundleId.overlaps'?: string;
136
- 'where.createdAt.eq'?: string;
137
- 'where.createdAt.neq'?: string;
138
- 'where.createdAt.gt'?: string;
139
- 'where.createdAt.gte'?: string;
140
- 'where.createdAt.lt'?: string;
141
- 'where.createdAt.lte'?: string;
142
- 'where.createdAt.like'?: string;
143
- 'where.createdAt.in'?: string;
144
- 'where.createdAt.nin'?: string;
145
- 'where.createdAt.contains'?: string;
146
- 'where.createdAt.contained'?: string;
147
- 'where.createdAt.overlaps'?: string;
148
- 'where.id.eq'?: string;
149
- 'where.id.neq'?: string;
150
- 'where.id.gt'?: string;
151
- 'where.id.gte'?: string;
152
- 'where.id.lt'?: string;
153
- 'where.id.lte'?: string;
154
- 'where.id.like'?: string;
155
- 'where.id.in'?: string;
156
- 'where.id.nin'?: string;
157
- 'where.id.contains'?: string;
158
- 'where.id.contained'?: string;
159
- 'where.id.overlaps'?: string;
160
- 'where.result.eq'?: boolean;
161
- 'where.result.neq'?: boolean;
162
- 'where.result.gt'?: boolean;
163
- 'where.result.gte'?: boolean;
164
- 'where.result.lt'?: boolean;
165
- 'where.result.lte'?: boolean;
166
- 'where.result.like'?: boolean;
167
- 'where.result.in'?: string;
168
- 'where.result.nin'?: string;
169
- 'where.result.contains'?: string;
170
- 'where.result.contained'?: string;
171
- 'where.result.overlaps'?: string;
172
- 'where.ruleSet.eq'?: string;
173
- 'where.ruleSet.neq'?: string;
174
- 'where.ruleSet.gt'?: string;
175
- 'where.ruleSet.gte'?: string;
176
- 'where.ruleSet.lt'?: string;
177
- 'where.ruleSet.lte'?: string;
178
- 'where.ruleSet.like'?: string;
179
- 'where.ruleSet.in'?: string;
180
- 'where.ruleSet.nin'?: string;
181
- 'where.ruleSet.contains'?: string;
182
- 'where.ruleSet.contained'?: string;
183
- 'where.ruleSet.overlaps'?: string;
184
- 'where.or'?: Array<string>;
185
- 'id'?: string;
186
- 'applicationId'?: string | null;
187
- 'bundleId'?: string | null;
188
- 'result': boolean;
189
- 'ruleSet': object;
190
- 'createdAt'?: string | null;
130
+ query?: {
131
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
132
+ 'where.applicationId.eq'?: string;
133
+ 'where.applicationId.neq'?: string;
134
+ 'where.applicationId.gt'?: string;
135
+ 'where.applicationId.gte'?: string;
136
+ 'where.applicationId.lt'?: string;
137
+ 'where.applicationId.lte'?: string;
138
+ 'where.applicationId.like'?: string;
139
+ 'where.applicationId.ilike'?: string;
140
+ 'where.applicationId.in'?: string;
141
+ 'where.applicationId.nin'?: string;
142
+ 'where.applicationId.contains'?: string;
143
+ 'where.applicationId.contained'?: string;
144
+ 'where.applicationId.overlaps'?: string;
145
+ 'where.createdAt.eq'?: string;
146
+ 'where.createdAt.neq'?: string;
147
+ 'where.createdAt.gt'?: string;
148
+ 'where.createdAt.gte'?: string;
149
+ 'where.createdAt.lt'?: string;
150
+ 'where.createdAt.lte'?: string;
151
+ 'where.createdAt.like'?: string;
152
+ 'where.createdAt.ilike'?: string;
153
+ 'where.createdAt.in'?: string;
154
+ 'where.createdAt.nin'?: string;
155
+ 'where.createdAt.contains'?: string;
156
+ 'where.createdAt.contained'?: string;
157
+ 'where.createdAt.overlaps'?: string;
158
+ 'where.id.eq'?: string;
159
+ 'where.id.neq'?: string;
160
+ 'where.id.gt'?: string;
161
+ 'where.id.gte'?: string;
162
+ 'where.id.lt'?: string;
163
+ 'where.id.lte'?: string;
164
+ 'where.id.like'?: string;
165
+ 'where.id.ilike'?: string;
166
+ 'where.id.in'?: string;
167
+ 'where.id.nin'?: string;
168
+ 'where.id.contains'?: string;
169
+ 'where.id.contained'?: string;
170
+ 'where.id.overlaps'?: string;
171
+ 'where.result.eq'?: boolean;
172
+ 'where.result.neq'?: boolean;
173
+ 'where.result.gt'?: boolean;
174
+ 'where.result.gte'?: boolean;
175
+ 'where.result.lt'?: boolean;
176
+ 'where.result.lte'?: boolean;
177
+ 'where.result.like'?: boolean;
178
+ 'where.result.ilike'?: boolean;
179
+ 'where.result.in'?: string;
180
+ 'where.result.nin'?: string;
181
+ 'where.result.contains'?: string;
182
+ 'where.result.contained'?: string;
183
+ 'where.result.overlaps'?: string;
184
+ 'where.ruleSet.eq'?: string;
185
+ 'where.ruleSet.neq'?: string;
186
+ 'where.ruleSet.gt'?: string;
187
+ 'where.ruleSet.gte'?: string;
188
+ 'where.ruleSet.lt'?: string;
189
+ 'where.ruleSet.lte'?: string;
190
+ 'where.ruleSet.like'?: string;
191
+ 'where.ruleSet.ilike'?: string;
192
+ 'where.ruleSet.in'?: string;
193
+ 'where.ruleSet.nin'?: string;
194
+ 'where.ruleSet.contains'?: string;
195
+ 'where.ruleSet.contained'?: string;
196
+ 'where.ruleSet.overlaps'?: string;
197
+ 'where.or'?: Array<string>;
198
+ }
199
+ body: {
200
+ 'id'?: string;
201
+ 'applicationId'?: string | null;
202
+ 'result': boolean;
203
+ 'ruleSet': object;
204
+ 'createdAt'?: string | null;
205
+ }
191
206
  }
192
207
 
193
- export type UpdateReportsResponseOK = Array<{ 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object; 'createdAt'?: string | null }>
208
+ /**
209
+ * Default Response
210
+ */
211
+ export type UpdateReportsResponseOK = Array<{ 'id'?: string | null; 'applicationId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object | null; 'createdAt'?: string | null }>
194
212
  export type UpdateReportsResponses =
195
- UpdateReportsResponseOK
213
+ FullResponse<UpdateReportsResponseOK, 200>
196
214
 
197
215
  export type GetReportByIdRequest = {
198
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
199
- 'id': string;
216
+ path: {
217
+ 'id': string;
218
+ }
219
+ query?: {
220
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
221
+ }
200
222
  }
201
223
 
202
- export type GetReportByIdResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object; 'createdAt'?: string | null }
224
+ /**
225
+ * A Report
226
+ */
227
+ export type GetReportByIdResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object | null; 'createdAt'?: string | null }
203
228
  export type GetReportByIdResponses =
204
- GetReportByIdResponseOK
229
+ FullResponse<GetReportByIdResponseOK, 200>
205
230
 
206
231
  export type UpdateReportRequest = {
207
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
208
- 'id': string;
209
- 'applicationId'?: string | null;
210
- 'bundleId'?: string | null;
211
- 'result': boolean;
212
- 'ruleSet': object;
213
- 'createdAt'?: string | null;
232
+ path: {
233
+ 'id': string;
234
+ }
235
+ query?: {
236
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
237
+ }
238
+ body: {
239
+ 'applicationId'?: string | null;
240
+ 'result': boolean;
241
+ 'ruleSet': object;
242
+ 'createdAt'?: string | null;
243
+ }
214
244
  }
215
245
 
216
- export type UpdateReportResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object; 'createdAt'?: string | null }
246
+ /**
247
+ * A Report
248
+ */
249
+ export type UpdateReportResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object | null; 'createdAt'?: string | null }
217
250
  export type UpdateReportResponses =
218
- UpdateReportResponseOK
251
+ FullResponse<UpdateReportResponseOK, 200>
219
252
 
220
253
  export type DeleteReportsRequest = {
221
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
222
- 'id': string;
254
+ path: {
255
+ 'id': string;
256
+ }
257
+ query?: {
258
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'id' | 'result' | 'ruleSet'>;
259
+ }
223
260
  }
224
261
 
225
- export type DeleteReportsResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object; 'createdAt'?: string | null }
262
+ /**
263
+ * A Report
264
+ */
265
+ export type DeleteReportsResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'result'?: boolean | null; 'ruleSet'?: object | null; 'createdAt'?: string | null }
226
266
  export type DeleteReportsResponses =
227
- DeleteReportsResponseOK
267
+ FullResponse<DeleteReportsResponseOK, 200>
228
268
 
229
269
  export type CreateRuleRequest = {
230
- 'id'?: string;
231
- 'name'?: string | null;
232
- 'description'?: string | null;
233
- 'label'?: string | null;
234
- 'config': object;
235
- 'createdAt'?: string | null;
270
+ query?: {
271
+ 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
272
+ }
273
+ body: {
274
+ 'id'?: string;
275
+ 'name'?: string | null;
276
+ 'description'?: string | null;
277
+ 'label'?: string | null;
278
+ 'config': object;
279
+ 'createdAt'?: string | null;
280
+ }
236
281
  }
237
282
 
238
- export type CreateRuleResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object; 'createdAt'?: string | null }
283
+ /**
284
+ * A Rule
285
+ */
286
+ export type CreateRuleResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object | null; 'createdAt'?: string | null }
239
287
  export type CreateRuleResponses =
240
- CreateRuleResponseOK
288
+ FullResponse<CreateRuleResponseOK, 200>
241
289
 
242
290
  export type UpdateRulesRequest = {
243
- 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
244
- 'where.config.eq'?: string;
245
- 'where.config.neq'?: string;
246
- 'where.config.gt'?: string;
247
- 'where.config.gte'?: string;
248
- 'where.config.lt'?: string;
249
- 'where.config.lte'?: string;
250
- 'where.config.like'?: string;
251
- 'where.config.in'?: string;
252
- 'where.config.nin'?: string;
253
- 'where.config.contains'?: string;
254
- 'where.config.contained'?: string;
255
- 'where.config.overlaps'?: string;
256
- 'where.createdAt.eq'?: string;
257
- 'where.createdAt.neq'?: string;
258
- 'where.createdAt.gt'?: string;
259
- 'where.createdAt.gte'?: string;
260
- 'where.createdAt.lt'?: string;
261
- 'where.createdAt.lte'?: string;
262
- 'where.createdAt.like'?: string;
263
- 'where.createdAt.in'?: string;
264
- 'where.createdAt.nin'?: string;
265
- 'where.createdAt.contains'?: string;
266
- 'where.createdAt.contained'?: string;
267
- 'where.createdAt.overlaps'?: string;
268
- 'where.description.eq'?: string;
269
- 'where.description.neq'?: string;
270
- 'where.description.gt'?: string;
271
- 'where.description.gte'?: string;
272
- 'where.description.lt'?: string;
273
- 'where.description.lte'?: string;
274
- 'where.description.like'?: string;
275
- 'where.description.in'?: string;
276
- 'where.description.nin'?: string;
277
- 'where.description.contains'?: string;
278
- 'where.description.contained'?: string;
279
- 'where.description.overlaps'?: string;
280
- 'where.id.eq'?: string;
281
- 'where.id.neq'?: string;
282
- 'where.id.gt'?: string;
283
- 'where.id.gte'?: string;
284
- 'where.id.lt'?: string;
285
- 'where.id.lte'?: string;
286
- 'where.id.like'?: string;
287
- 'where.id.in'?: string;
288
- 'where.id.nin'?: string;
289
- 'where.id.contains'?: string;
290
- 'where.id.contained'?: string;
291
- 'where.id.overlaps'?: string;
292
- 'where.label.eq'?: string;
293
- 'where.label.neq'?: string;
294
- 'where.label.gt'?: string;
295
- 'where.label.gte'?: string;
296
- 'where.label.lt'?: string;
297
- 'where.label.lte'?: string;
298
- 'where.label.like'?: string;
299
- 'where.label.in'?: string;
300
- 'where.label.nin'?: string;
301
- 'where.label.contains'?: string;
302
- 'where.label.contained'?: string;
303
- 'where.label.overlaps'?: string;
304
- 'where.name.eq'?: string;
305
- 'where.name.neq'?: string;
306
- 'where.name.gt'?: string;
307
- 'where.name.gte'?: string;
308
- 'where.name.lt'?: string;
309
- 'where.name.lte'?: string;
310
- 'where.name.like'?: string;
311
- 'where.name.in'?: string;
312
- 'where.name.nin'?: string;
313
- 'where.name.contains'?: string;
314
- 'where.name.contained'?: string;
315
- 'where.name.overlaps'?: string;
316
- 'where.or'?: Array<string>;
317
- 'id'?: string;
318
- 'name'?: string | null;
319
- 'description'?: string | null;
320
- 'label'?: string | null;
321
- 'config': object;
322
- 'createdAt'?: string | null;
291
+ query?: {
292
+ 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
293
+ 'where.config.eq'?: string;
294
+ 'where.config.neq'?: string;
295
+ 'where.config.gt'?: string;
296
+ 'where.config.gte'?: string;
297
+ 'where.config.lt'?: string;
298
+ 'where.config.lte'?: string;
299
+ 'where.config.like'?: string;
300
+ 'where.config.ilike'?: string;
301
+ 'where.config.in'?: string;
302
+ 'where.config.nin'?: string;
303
+ 'where.config.contains'?: string;
304
+ 'where.config.contained'?: string;
305
+ 'where.config.overlaps'?: string;
306
+ 'where.createdAt.eq'?: string;
307
+ 'where.createdAt.neq'?: string;
308
+ 'where.createdAt.gt'?: string;
309
+ 'where.createdAt.gte'?: string;
310
+ 'where.createdAt.lt'?: string;
311
+ 'where.createdAt.lte'?: string;
312
+ 'where.createdAt.like'?: string;
313
+ 'where.createdAt.ilike'?: string;
314
+ 'where.createdAt.in'?: string;
315
+ 'where.createdAt.nin'?: string;
316
+ 'where.createdAt.contains'?: string;
317
+ 'where.createdAt.contained'?: string;
318
+ 'where.createdAt.overlaps'?: string;
319
+ 'where.description.eq'?: string;
320
+ 'where.description.neq'?: string;
321
+ 'where.description.gt'?: string;
322
+ 'where.description.gte'?: string;
323
+ 'where.description.lt'?: string;
324
+ 'where.description.lte'?: string;
325
+ 'where.description.like'?: string;
326
+ 'where.description.ilike'?: string;
327
+ 'where.description.in'?: string;
328
+ 'where.description.nin'?: string;
329
+ 'where.description.contains'?: string;
330
+ 'where.description.contained'?: string;
331
+ 'where.description.overlaps'?: string;
332
+ 'where.id.eq'?: string;
333
+ 'where.id.neq'?: string;
334
+ 'where.id.gt'?: string;
335
+ 'where.id.gte'?: string;
336
+ 'where.id.lt'?: string;
337
+ 'where.id.lte'?: string;
338
+ 'where.id.like'?: string;
339
+ 'where.id.ilike'?: string;
340
+ 'where.id.in'?: string;
341
+ 'where.id.nin'?: string;
342
+ 'where.id.contains'?: string;
343
+ 'where.id.contained'?: string;
344
+ 'where.id.overlaps'?: string;
345
+ 'where.label.eq'?: string;
346
+ 'where.label.neq'?: string;
347
+ 'where.label.gt'?: string;
348
+ 'where.label.gte'?: string;
349
+ 'where.label.lt'?: string;
350
+ 'where.label.lte'?: string;
351
+ 'where.label.like'?: string;
352
+ 'where.label.ilike'?: string;
353
+ 'where.label.in'?: string;
354
+ 'where.label.nin'?: string;
355
+ 'where.label.contains'?: string;
356
+ 'where.label.contained'?: string;
357
+ 'where.label.overlaps'?: string;
358
+ 'where.name.eq'?: string;
359
+ 'where.name.neq'?: string;
360
+ 'where.name.gt'?: string;
361
+ 'where.name.gte'?: string;
362
+ 'where.name.lt'?: string;
363
+ 'where.name.lte'?: string;
364
+ 'where.name.like'?: string;
365
+ 'where.name.ilike'?: string;
366
+ 'where.name.in'?: string;
367
+ 'where.name.nin'?: string;
368
+ 'where.name.contains'?: string;
369
+ 'where.name.contained'?: string;
370
+ 'where.name.overlaps'?: string;
371
+ 'where.or'?: Array<string>;
372
+ }
373
+ body: {
374
+ 'id'?: string;
375
+ 'name'?: string | null;
376
+ 'description'?: string | null;
377
+ 'label'?: string | null;
378
+ 'config': object;
379
+ 'createdAt'?: string | null;
380
+ }
323
381
  }
324
382
 
325
- export type UpdateRulesResponseOK = Array<{ 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object; 'createdAt'?: string | null }>
383
+ /**
384
+ * Default Response
385
+ */
386
+ export type UpdateRulesResponseOK = Array<{ 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object | null; 'createdAt'?: string | null }>
326
387
  export type UpdateRulesResponses =
327
- UpdateRulesResponseOK
388
+ FullResponse<UpdateRulesResponseOK, 200>
328
389
 
329
390
  export type GetRuleByIdRequest = {
330
- 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
331
- 'id': string;
391
+ path: {
392
+ 'id': string;
393
+ }
394
+ query?: {
395
+ 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
396
+ }
332
397
  }
333
398
 
334
- export type GetRuleByIdResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object; 'createdAt'?: string | null }
399
+ /**
400
+ * A Rule
401
+ */
402
+ export type GetRuleByIdResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object | null; 'createdAt'?: string | null }
335
403
  export type GetRuleByIdResponses =
336
- GetRuleByIdResponseOK
404
+ FullResponse<GetRuleByIdResponseOK, 200>
337
405
 
338
406
  export type UpdateRuleRequest = {
339
- 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
340
- 'id': string;
341
- 'name'?: string | null;
342
- 'description'?: string | null;
343
- 'label'?: string | null;
344
- 'config': object;
345
- 'createdAt'?: string | null;
407
+ path: {
408
+ 'id': string;
409
+ }
410
+ query?: {
411
+ 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
412
+ }
413
+ body: {
414
+ 'name'?: string | null;
415
+ 'description'?: string | null;
416
+ 'label'?: string | null;
417
+ 'config': object;
418
+ 'createdAt'?: string | null;
419
+ }
346
420
  }
347
421
 
348
- export type UpdateRuleResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object; 'createdAt'?: string | null }
422
+ /**
423
+ * A Rule
424
+ */
425
+ export type UpdateRuleResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object | null; 'createdAt'?: string | null }
349
426
  export type UpdateRuleResponses =
350
- UpdateRuleResponseOK
427
+ FullResponse<UpdateRuleResponseOK, 200>
351
428
 
352
429
  export type DeleteRulesRequest = {
353
- 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
354
- 'id': string;
430
+ path: {
431
+ 'id': string;
432
+ }
433
+ query?: {
434
+ 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
435
+ }
355
436
  }
356
437
 
357
- export type DeleteRulesResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object; 'createdAt'?: string | null }
438
+ /**
439
+ * A Rule
440
+ */
441
+ export type DeleteRulesResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object | null; 'createdAt'?: string | null }
358
442
  export type DeleteRulesResponses =
359
- DeleteRulesResponseOK
443
+ FullResponse<DeleteRulesResponseOK, 200>
360
444
 
361
445
  export type GetRuleConfigsForRuleRequest = {
362
- 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
363
- 'id': string;
446
+ path: {
447
+ 'id': string;
448
+ }
449
+ query?: {
450
+ /**
451
+ * Limit will be applied by default if not passed. If the provided value exceeds the maximum allowed value a validation error will be thrown
452
+ */
453
+ 'limit'?: number;
454
+ 'offset'?: number;
455
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
456
+ 'totalCount'?: boolean;
457
+ }
364
458
  }
365
459
 
366
- export type GetRuleConfigsForRuleResponseOK = Array<{ 'id'?: string | null; 'type'?: 'global' | 'local'; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object; 'createdAt'?: string | null }>
460
+ /**
461
+ * Default Response
462
+ */
463
+ export type GetRuleConfigsForRuleResponseOK = Array<{ 'id'?: string | null; 'type'?: 'global' | 'local' | null; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object | null; 'createdAt'?: string | null }>
367
464
  export type GetRuleConfigsForRuleResponses =
368
- GetRuleConfigsForRuleResponseOK
465
+ FullResponse<GetRuleConfigsForRuleResponseOK, 200>
369
466
 
370
467
  export type GetRuleConfigsRequest = {
371
- 'limit'?: number;
372
- 'offset'?: number;
373
- 'totalCount'?: boolean;
374
- 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
375
- 'where.applicationId.eq'?: string;
376
- 'where.applicationId.neq'?: string;
377
- 'where.applicationId.gt'?: string;
378
- 'where.applicationId.gte'?: string;
379
- 'where.applicationId.lt'?: string;
380
- 'where.applicationId.lte'?: string;
381
- 'where.applicationId.like'?: string;
382
- 'where.applicationId.in'?: string;
383
- 'where.applicationId.nin'?: string;
384
- 'where.applicationId.contains'?: string;
385
- 'where.applicationId.contained'?: string;
386
- 'where.applicationId.overlaps'?: string;
387
- 'where.createdAt.eq'?: string;
388
- 'where.createdAt.neq'?: string;
389
- 'where.createdAt.gt'?: string;
390
- 'where.createdAt.gte'?: string;
391
- 'where.createdAt.lt'?: string;
392
- 'where.createdAt.lte'?: string;
393
- 'where.createdAt.like'?: string;
394
- 'where.createdAt.in'?: string;
395
- 'where.createdAt.nin'?: string;
396
- 'where.createdAt.contains'?: string;
397
- 'where.createdAt.contained'?: string;
398
- 'where.createdAt.overlaps'?: string;
399
- 'where.enabled.eq'?: boolean;
400
- 'where.enabled.neq'?: boolean;
401
- 'where.enabled.gt'?: boolean;
402
- 'where.enabled.gte'?: boolean;
403
- 'where.enabled.lt'?: boolean;
404
- 'where.enabled.lte'?: boolean;
405
- 'where.enabled.like'?: boolean;
406
- 'where.enabled.in'?: string;
407
- 'where.enabled.nin'?: string;
408
- 'where.enabled.contains'?: string;
409
- 'where.enabled.contained'?: string;
410
- 'where.enabled.overlaps'?: string;
411
- 'where.id.eq'?: string;
412
- 'where.id.neq'?: string;
413
- 'where.id.gt'?: string;
414
- 'where.id.gte'?: string;
415
- 'where.id.lt'?: string;
416
- 'where.id.lte'?: string;
417
- 'where.id.like'?: string;
418
- 'where.id.in'?: string;
419
- 'where.id.nin'?: string;
420
- 'where.id.contains'?: string;
421
- 'where.id.contained'?: string;
422
- 'where.id.overlaps'?: string;
423
- 'where.options.eq'?: string;
424
- 'where.options.neq'?: string;
425
- 'where.options.gt'?: string;
426
- 'where.options.gte'?: string;
427
- 'where.options.lt'?: string;
428
- 'where.options.lte'?: string;
429
- 'where.options.like'?: string;
430
- 'where.options.in'?: string;
431
- 'where.options.nin'?: string;
432
- 'where.options.contains'?: string;
433
- 'where.options.contained'?: string;
434
- 'where.options.overlaps'?: string;
435
- 'where.ruleId.eq'?: string;
436
- 'where.ruleId.neq'?: string;
437
- 'where.ruleId.gt'?: string;
438
- 'where.ruleId.gte'?: string;
439
- 'where.ruleId.lt'?: string;
440
- 'where.ruleId.lte'?: string;
441
- 'where.ruleId.like'?: string;
442
- 'where.ruleId.in'?: string;
443
- 'where.ruleId.nin'?: string;
444
- 'where.ruleId.contains'?: string;
445
- 'where.ruleId.contained'?: string;
446
- 'where.ruleId.overlaps'?: string;
447
- 'where.type.eq'?: 'global' | 'local';
448
- 'where.type.neq'?: 'global' | 'local';
449
- 'where.type.gt'?: 'global' | 'local';
450
- 'where.type.gte'?: 'global' | 'local';
451
- 'where.type.lt'?: 'global' | 'local';
452
- 'where.type.lte'?: 'global' | 'local';
453
- 'where.type.like'?: 'global' | 'local';
454
- 'where.type.in'?: string;
455
- 'where.type.nin'?: string;
456
- 'where.type.contains'?: string;
457
- 'where.type.contained'?: string;
458
- 'where.type.overlaps'?: string;
459
- 'where.or'?: Array<string>;
460
- 'orderby.applicationId'?: 'asc' | 'desc';
461
- 'orderby.createdAt'?: 'asc' | 'desc';
462
- 'orderby.enabled'?: 'asc' | 'desc';
463
- 'orderby.id'?: 'asc' | 'desc';
464
- 'orderby.options'?: 'asc' | 'desc';
465
- 'orderby.ruleId'?: 'asc' | 'desc';
466
- 'orderby.type'?: 'asc' | 'desc';
468
+ query?: {
469
+ /**
470
+ * Limit will be applied by default if not passed. If the provided value exceeds the maximum allowed value a validation error will be thrown
471
+ */
472
+ 'limit'?: number;
473
+ 'offset'?: number;
474
+ 'totalCount'?: boolean;
475
+ /**
476
+ * Include cursor headers in response. Cursor keys built from orderBy clause
477
+ */
478
+ 'cursor'?: boolean;
479
+ /**
480
+ * Cursor for forward pagination. List objects after this cursor position
481
+ */
482
+ 'startAfter'?: string;
483
+ /**
484
+ * Cursor for backward pagination. List objects before this cursor position
485
+ */
486
+ 'endBefore'?: string;
487
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
488
+ 'where.applicationId.eq'?: string;
489
+ 'where.applicationId.neq'?: string;
490
+ 'where.applicationId.gt'?: string;
491
+ 'where.applicationId.gte'?: string;
492
+ 'where.applicationId.lt'?: string;
493
+ 'where.applicationId.lte'?: string;
494
+ 'where.applicationId.like'?: string;
495
+ 'where.applicationId.ilike'?: string;
496
+ 'where.applicationId.in'?: string;
497
+ 'where.applicationId.nin'?: string;
498
+ 'where.applicationId.contains'?: string;
499
+ 'where.applicationId.contained'?: string;
500
+ 'where.applicationId.overlaps'?: string;
501
+ 'where.createdAt.eq'?: string;
502
+ 'where.createdAt.neq'?: string;
503
+ 'where.createdAt.gt'?: string;
504
+ 'where.createdAt.gte'?: string;
505
+ 'where.createdAt.lt'?: string;
506
+ 'where.createdAt.lte'?: string;
507
+ 'where.createdAt.like'?: string;
508
+ 'where.createdAt.ilike'?: string;
509
+ 'where.createdAt.in'?: string;
510
+ 'where.createdAt.nin'?: string;
511
+ 'where.createdAt.contains'?: string;
512
+ 'where.createdAt.contained'?: string;
513
+ 'where.createdAt.overlaps'?: string;
514
+ 'where.enabled.eq'?: boolean;
515
+ 'where.enabled.neq'?: boolean;
516
+ 'where.enabled.gt'?: boolean;
517
+ 'where.enabled.gte'?: boolean;
518
+ 'where.enabled.lt'?: boolean;
519
+ 'where.enabled.lte'?: boolean;
520
+ 'where.enabled.like'?: boolean;
521
+ 'where.enabled.ilike'?: boolean;
522
+ 'where.enabled.in'?: string;
523
+ 'where.enabled.nin'?: string;
524
+ 'where.enabled.contains'?: string;
525
+ 'where.enabled.contained'?: string;
526
+ 'where.enabled.overlaps'?: string;
527
+ 'where.id.eq'?: string;
528
+ 'where.id.neq'?: string;
529
+ 'where.id.gt'?: string;
530
+ 'where.id.gte'?: string;
531
+ 'where.id.lt'?: string;
532
+ 'where.id.lte'?: string;
533
+ 'where.id.like'?: string;
534
+ 'where.id.ilike'?: string;
535
+ 'where.id.in'?: string;
536
+ 'where.id.nin'?: string;
537
+ 'where.id.contains'?: string;
538
+ 'where.id.contained'?: string;
539
+ 'where.id.overlaps'?: string;
540
+ 'where.options.eq'?: string;
541
+ 'where.options.neq'?: string;
542
+ 'where.options.gt'?: string;
543
+ 'where.options.gte'?: string;
544
+ 'where.options.lt'?: string;
545
+ 'where.options.lte'?: string;
546
+ 'where.options.like'?: string;
547
+ 'where.options.ilike'?: string;
548
+ 'where.options.in'?: string;
549
+ 'where.options.nin'?: string;
550
+ 'where.options.contains'?: string;
551
+ 'where.options.contained'?: string;
552
+ 'where.options.overlaps'?: string;
553
+ 'where.ruleId.eq'?: string;
554
+ 'where.ruleId.neq'?: string;
555
+ 'where.ruleId.gt'?: string;
556
+ 'where.ruleId.gte'?: string;
557
+ 'where.ruleId.lt'?: string;
558
+ 'where.ruleId.lte'?: string;
559
+ 'where.ruleId.like'?: string;
560
+ 'where.ruleId.ilike'?: string;
561
+ 'where.ruleId.in'?: string;
562
+ 'where.ruleId.nin'?: string;
563
+ 'where.ruleId.contains'?: string;
564
+ 'where.ruleId.contained'?: string;
565
+ 'where.ruleId.overlaps'?: string;
566
+ 'where.type.eq'?: 'global' | 'local';
567
+ 'where.type.neq'?: 'global' | 'local';
568
+ 'where.type.gt'?: 'global' | 'local';
569
+ 'where.type.gte'?: 'global' | 'local';
570
+ 'where.type.lt'?: 'global' | 'local';
571
+ 'where.type.lte'?: 'global' | 'local';
572
+ 'where.type.like'?: 'global' | 'local';
573
+ 'where.type.ilike'?: 'global' | 'local';
574
+ 'where.type.in'?: string;
575
+ 'where.type.nin'?: string;
576
+ 'where.type.contains'?: string;
577
+ 'where.type.contained'?: string;
578
+ 'where.type.overlaps'?: string;
579
+ 'where.or'?: Array<string>;
580
+ 'orderby.applicationId'?: 'asc' | 'desc';
581
+ 'orderby.createdAt'?: 'asc' | 'desc';
582
+ 'orderby.enabled'?: 'asc' | 'desc';
583
+ 'orderby.id'?: 'asc' | 'desc';
584
+ 'orderby.options'?: 'asc' | 'desc';
585
+ 'orderby.ruleId'?: 'asc' | 'desc';
586
+ 'orderby.type'?: 'asc' | 'desc';
587
+ }
467
588
  }
468
589
 
469
- export type GetRuleConfigsResponseOK = Array<{ 'id'?: string | null; 'type'?: 'global' | 'local'; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object; 'createdAt'?: string | null }>
590
+ /**
591
+ * Default Response
592
+ */
593
+ export type GetRuleConfigsResponseOK = Array<{ 'id'?: string | null; 'type'?: 'global' | 'local' | null; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object | null; 'createdAt'?: string | null }>
470
594
  export type GetRuleConfigsResponses =
471
- GetRuleConfigsResponseOK
595
+ FullResponse<GetRuleConfigsResponseOK, 200>
472
596
 
473
597
  export type CreateRuleConfigRequest = {
474
- 'id'?: string;
475
- 'type': 'global' | 'local';
476
- 'applicationId'?: string | null;
477
- 'enabled'?: boolean | null;
478
- 'ruleId': string;
479
- 'options': object;
480
- 'createdAt'?: string | null;
598
+ query?: {
599
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
600
+ }
601
+ body: {
602
+ 'id'?: string;
603
+ 'type': 'global' | 'local';
604
+ 'applicationId'?: string | null;
605
+ 'enabled'?: boolean | null;
606
+ 'ruleId': string;
607
+ 'options': object;
608
+ 'createdAt'?: string | null;
609
+ }
481
610
  }
482
611
 
483
- export type CreateRuleConfigResponseOK = { 'id'?: string | null; 'type'?: 'global' | 'local'; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object; 'createdAt'?: string | null }
612
+ /**
613
+ * A RuleConfig
614
+ */
615
+ export type CreateRuleConfigResponseOK = { 'id'?: string | null; 'type'?: 'global' | 'local' | null; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object | null; 'createdAt'?: string | null }
484
616
  export type CreateRuleConfigResponses =
485
- CreateRuleConfigResponseOK
617
+ FullResponse<CreateRuleConfigResponseOK, 200>
486
618
 
487
619
  export type UpdateRuleConfigsRequest = {
488
- 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
489
- 'where.applicationId.eq'?: string;
490
- 'where.applicationId.neq'?: string;
491
- 'where.applicationId.gt'?: string;
492
- 'where.applicationId.gte'?: string;
493
- 'where.applicationId.lt'?: string;
494
- 'where.applicationId.lte'?: string;
495
- 'where.applicationId.like'?: string;
496
- 'where.applicationId.in'?: string;
497
- 'where.applicationId.nin'?: string;
498
- 'where.applicationId.contains'?: string;
499
- 'where.applicationId.contained'?: string;
500
- 'where.applicationId.overlaps'?: string;
501
- 'where.createdAt.eq'?: string;
502
- 'where.createdAt.neq'?: string;
503
- 'where.createdAt.gt'?: string;
504
- 'where.createdAt.gte'?: string;
505
- 'where.createdAt.lt'?: string;
506
- 'where.createdAt.lte'?: string;
507
- 'where.createdAt.like'?: string;
508
- 'where.createdAt.in'?: string;
509
- 'where.createdAt.nin'?: string;
510
- 'where.createdAt.contains'?: string;
511
- 'where.createdAt.contained'?: string;
512
- 'where.createdAt.overlaps'?: string;
513
- 'where.enabled.eq'?: boolean;
514
- 'where.enabled.neq'?: boolean;
515
- 'where.enabled.gt'?: boolean;
516
- 'where.enabled.gte'?: boolean;
517
- 'where.enabled.lt'?: boolean;
518
- 'where.enabled.lte'?: boolean;
519
- 'where.enabled.like'?: boolean;
520
- 'where.enabled.in'?: string;
521
- 'where.enabled.nin'?: string;
522
- 'where.enabled.contains'?: string;
523
- 'where.enabled.contained'?: string;
524
- 'where.enabled.overlaps'?: string;
525
- 'where.id.eq'?: string;
526
- 'where.id.neq'?: string;
527
- 'where.id.gt'?: string;
528
- 'where.id.gte'?: string;
529
- 'where.id.lt'?: string;
530
- 'where.id.lte'?: string;
531
- 'where.id.like'?: string;
532
- 'where.id.in'?: string;
533
- 'where.id.nin'?: string;
534
- 'where.id.contains'?: string;
535
- 'where.id.contained'?: string;
536
- 'where.id.overlaps'?: string;
537
- 'where.options.eq'?: string;
538
- 'where.options.neq'?: string;
539
- 'where.options.gt'?: string;
540
- 'where.options.gte'?: string;
541
- 'where.options.lt'?: string;
542
- 'where.options.lte'?: string;
543
- 'where.options.like'?: string;
544
- 'where.options.in'?: string;
545
- 'where.options.nin'?: string;
546
- 'where.options.contains'?: string;
547
- 'where.options.contained'?: string;
548
- 'where.options.overlaps'?: string;
549
- 'where.ruleId.eq'?: string;
550
- 'where.ruleId.neq'?: string;
551
- 'where.ruleId.gt'?: string;
552
- 'where.ruleId.gte'?: string;
553
- 'where.ruleId.lt'?: string;
554
- 'where.ruleId.lte'?: string;
555
- 'where.ruleId.like'?: string;
556
- 'where.ruleId.in'?: string;
557
- 'where.ruleId.nin'?: string;
558
- 'where.ruleId.contains'?: string;
559
- 'where.ruleId.contained'?: string;
560
- 'where.ruleId.overlaps'?: string;
561
- 'where.type.eq'?: 'global' | 'local';
562
- 'where.type.neq'?: 'global' | 'local';
563
- 'where.type.gt'?: 'global' | 'local';
564
- 'where.type.gte'?: 'global' | 'local';
565
- 'where.type.lt'?: 'global' | 'local';
566
- 'where.type.lte'?: 'global' | 'local';
567
- 'where.type.like'?: 'global' | 'local';
568
- 'where.type.in'?: string;
569
- 'where.type.nin'?: string;
570
- 'where.type.contains'?: string;
571
- 'where.type.contained'?: string;
572
- 'where.type.overlaps'?: string;
573
- 'where.or'?: Array<string>;
574
- 'id'?: string;
575
- 'type': 'global' | 'local';
576
- 'applicationId'?: string | null;
577
- 'enabled'?: boolean | null;
578
- 'ruleId': string;
579
- 'options': object;
580
- 'createdAt'?: string | null;
620
+ query?: {
621
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
622
+ 'where.applicationId.eq'?: string;
623
+ 'where.applicationId.neq'?: string;
624
+ 'where.applicationId.gt'?: string;
625
+ 'where.applicationId.gte'?: string;
626
+ 'where.applicationId.lt'?: string;
627
+ 'where.applicationId.lte'?: string;
628
+ 'where.applicationId.like'?: string;
629
+ 'where.applicationId.ilike'?: string;
630
+ 'where.applicationId.in'?: string;
631
+ 'where.applicationId.nin'?: string;
632
+ 'where.applicationId.contains'?: string;
633
+ 'where.applicationId.contained'?: string;
634
+ 'where.applicationId.overlaps'?: string;
635
+ 'where.createdAt.eq'?: string;
636
+ 'where.createdAt.neq'?: string;
637
+ 'where.createdAt.gt'?: string;
638
+ 'where.createdAt.gte'?: string;
639
+ 'where.createdAt.lt'?: string;
640
+ 'where.createdAt.lte'?: string;
641
+ 'where.createdAt.like'?: string;
642
+ 'where.createdAt.ilike'?: string;
643
+ 'where.createdAt.in'?: string;
644
+ 'where.createdAt.nin'?: string;
645
+ 'where.createdAt.contains'?: string;
646
+ 'where.createdAt.contained'?: string;
647
+ 'where.createdAt.overlaps'?: string;
648
+ 'where.enabled.eq'?: boolean;
649
+ 'where.enabled.neq'?: boolean;
650
+ 'where.enabled.gt'?: boolean;
651
+ 'where.enabled.gte'?: boolean;
652
+ 'where.enabled.lt'?: boolean;
653
+ 'where.enabled.lte'?: boolean;
654
+ 'where.enabled.like'?: boolean;
655
+ 'where.enabled.ilike'?: boolean;
656
+ 'where.enabled.in'?: string;
657
+ 'where.enabled.nin'?: string;
658
+ 'where.enabled.contains'?: string;
659
+ 'where.enabled.contained'?: string;
660
+ 'where.enabled.overlaps'?: string;
661
+ 'where.id.eq'?: string;
662
+ 'where.id.neq'?: string;
663
+ 'where.id.gt'?: string;
664
+ 'where.id.gte'?: string;
665
+ 'where.id.lt'?: string;
666
+ 'where.id.lte'?: string;
667
+ 'where.id.like'?: string;
668
+ 'where.id.ilike'?: string;
669
+ 'where.id.in'?: string;
670
+ 'where.id.nin'?: string;
671
+ 'where.id.contains'?: string;
672
+ 'where.id.contained'?: string;
673
+ 'where.id.overlaps'?: string;
674
+ 'where.options.eq'?: string;
675
+ 'where.options.neq'?: string;
676
+ 'where.options.gt'?: string;
677
+ 'where.options.gte'?: string;
678
+ 'where.options.lt'?: string;
679
+ 'where.options.lte'?: string;
680
+ 'where.options.like'?: string;
681
+ 'where.options.ilike'?: string;
682
+ 'where.options.in'?: string;
683
+ 'where.options.nin'?: string;
684
+ 'where.options.contains'?: string;
685
+ 'where.options.contained'?: string;
686
+ 'where.options.overlaps'?: string;
687
+ 'where.ruleId.eq'?: string;
688
+ 'where.ruleId.neq'?: string;
689
+ 'where.ruleId.gt'?: string;
690
+ 'where.ruleId.gte'?: string;
691
+ 'where.ruleId.lt'?: string;
692
+ 'where.ruleId.lte'?: string;
693
+ 'where.ruleId.like'?: string;
694
+ 'where.ruleId.ilike'?: string;
695
+ 'where.ruleId.in'?: string;
696
+ 'where.ruleId.nin'?: string;
697
+ 'where.ruleId.contains'?: string;
698
+ 'where.ruleId.contained'?: string;
699
+ 'where.ruleId.overlaps'?: string;
700
+ 'where.type.eq'?: 'global' | 'local';
701
+ 'where.type.neq'?: 'global' | 'local';
702
+ 'where.type.gt'?: 'global' | 'local';
703
+ 'where.type.gte'?: 'global' | 'local';
704
+ 'where.type.lt'?: 'global' | 'local';
705
+ 'where.type.lte'?: 'global' | 'local';
706
+ 'where.type.like'?: 'global' | 'local';
707
+ 'where.type.ilike'?: 'global' | 'local';
708
+ 'where.type.in'?: string;
709
+ 'where.type.nin'?: string;
710
+ 'where.type.contains'?: string;
711
+ 'where.type.contained'?: string;
712
+ 'where.type.overlaps'?: string;
713
+ 'where.or'?: Array<string>;
714
+ }
715
+ body: {
716
+ 'id'?: string;
717
+ 'type': 'global' | 'local';
718
+ 'applicationId'?: string | null;
719
+ 'enabled'?: boolean | null;
720
+ 'ruleId': string;
721
+ 'options': object;
722
+ 'createdAt'?: string | null;
723
+ }
581
724
  }
582
725
 
583
- export type UpdateRuleConfigsResponseOK = Array<{ 'id'?: string | null; 'type'?: 'global' | 'local'; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object; 'createdAt'?: string | null }>
726
+ /**
727
+ * Default Response
728
+ */
729
+ export type UpdateRuleConfigsResponseOK = Array<{ 'id'?: string | null; 'type'?: 'global' | 'local' | null; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object | null; 'createdAt'?: string | null }>
584
730
  export type UpdateRuleConfigsResponses =
585
- UpdateRuleConfigsResponseOK
731
+ FullResponse<UpdateRuleConfigsResponseOK, 200>
586
732
 
587
733
  export type GetRuleConfigByIdRequest = {
588
- 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
589
- 'id': string;
734
+ path: {
735
+ 'id': string;
736
+ }
737
+ query?: {
738
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
739
+ }
590
740
  }
591
741
 
592
- export type GetRuleConfigByIdResponseOK = { 'id'?: string | null; 'type'?: 'global' | 'local'; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object; 'createdAt'?: string | null }
742
+ /**
743
+ * A RuleConfig
744
+ */
745
+ export type GetRuleConfigByIdResponseOK = { 'id'?: string | null; 'type'?: 'global' | 'local' | null; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object | null; 'createdAt'?: string | null }
593
746
  export type GetRuleConfigByIdResponses =
594
- GetRuleConfigByIdResponseOK
747
+ FullResponse<GetRuleConfigByIdResponseOK, 200>
595
748
 
596
749
  export type UpdateRuleConfigRequest = {
597
- 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
598
- 'id': string;
599
- 'type': 'global' | 'local';
600
- 'applicationId'?: string | null;
601
- 'enabled'?: boolean | null;
602
- 'ruleId': string;
603
- 'options': object;
604
- 'createdAt'?: string | null;
750
+ path: {
751
+ 'id': string;
752
+ }
753
+ query?: {
754
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
755
+ }
756
+ body: {
757
+ 'type': 'global' | 'local';
758
+ 'applicationId'?: string | null;
759
+ 'enabled'?: boolean | null;
760
+ 'ruleId': string;
761
+ 'options': object;
762
+ 'createdAt'?: string | null;
763
+ }
605
764
  }
606
765
 
607
- export type UpdateRuleConfigResponseOK = { 'id'?: string | null; 'type'?: 'global' | 'local'; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object; 'createdAt'?: string | null }
766
+ /**
767
+ * A RuleConfig
768
+ */
769
+ export type UpdateRuleConfigResponseOK = { 'id'?: string | null; 'type'?: 'global' | 'local' | null; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object | null; 'createdAt'?: string | null }
608
770
  export type UpdateRuleConfigResponses =
609
- UpdateRuleConfigResponseOK
771
+ FullResponse<UpdateRuleConfigResponseOK, 200>
610
772
 
611
773
  export type DeleteRuleConfigsRequest = {
612
- 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
613
- 'id': string;
774
+ path: {
775
+ 'id': string;
776
+ }
777
+ query?: {
778
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'enabled' | 'id' | 'options' | 'ruleId' | 'type'>;
779
+ }
614
780
  }
615
781
 
616
- export type DeleteRuleConfigsResponseOK = { 'id'?: string | null; 'type'?: 'global' | 'local'; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object; 'createdAt'?: string | null }
782
+ /**
783
+ * A RuleConfig
784
+ */
785
+ export type DeleteRuleConfigsResponseOK = { 'id'?: string | null; 'type'?: 'global' | 'local' | null; 'applicationId'?: string | null; 'enabled'?: boolean | null; 'ruleId'?: string | null; 'options'?: object | null; 'createdAt'?: string | null }
617
786
  export type DeleteRuleConfigsResponses =
618
- DeleteRuleConfigsResponseOK
787
+ FullResponse<DeleteRuleConfigsResponseOK, 200>
619
788
 
620
789
  export type GetRuleForRuleConfigRequest = {
621
- 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
622
- 'id': string;
790
+ path: {
791
+ 'id': string;
792
+ }
793
+ query?: {
794
+ 'fields'?: Array<'config' | 'createdAt' | 'description' | 'id' | 'label' | 'name'>;
795
+ }
623
796
  }
624
797
 
625
- export type GetRuleForRuleConfigResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object; 'createdAt'?: string | null }
798
+ /**
799
+ * A Rule
800
+ */
801
+ export type GetRuleForRuleConfigResponseOK = { 'id'?: string | null; 'name'?: string | null; 'description'?: string | null; 'label'?: string | null; 'config'?: object | null; 'createdAt'?: string | null }
626
802
  export type GetRuleForRuleConfigResponses =
627
- GetRuleForRuleConfigResponseOK
803
+ FullResponse<GetRuleForRuleConfigResponseOK, 200>
628
804
 
629
805
  export type GetMetadataRequest = {
630
- 'limit'?: number;
631
- 'offset'?: number;
632
- 'totalCount'?: boolean;
633
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'data' | 'id'>;
634
- 'where.applicationId.eq'?: string;
635
- 'where.applicationId.neq'?: string;
636
- 'where.applicationId.gt'?: string;
637
- 'where.applicationId.gte'?: string;
638
- 'where.applicationId.lt'?: string;
639
- 'where.applicationId.lte'?: string;
640
- 'where.applicationId.like'?: string;
641
- 'where.applicationId.in'?: string;
642
- 'where.applicationId.nin'?: string;
643
- 'where.applicationId.contains'?: string;
644
- 'where.applicationId.contained'?: string;
645
- 'where.applicationId.overlaps'?: string;
646
- 'where.bundleId.eq'?: string;
647
- 'where.bundleId.neq'?: string;
648
- 'where.bundleId.gt'?: string;
649
- 'where.bundleId.gte'?: string;
650
- 'where.bundleId.lt'?: string;
651
- 'where.bundleId.lte'?: string;
652
- 'where.bundleId.like'?: string;
653
- 'where.bundleId.in'?: string;
654
- 'where.bundleId.nin'?: string;
655
- 'where.bundleId.contains'?: string;
656
- 'where.bundleId.contained'?: string;
657
- 'where.bundleId.overlaps'?: string;
658
- 'where.createdAt.eq'?: string;
659
- 'where.createdAt.neq'?: string;
660
- 'where.createdAt.gt'?: string;
661
- 'where.createdAt.gte'?: string;
662
- 'where.createdAt.lt'?: string;
663
- 'where.createdAt.lte'?: string;
664
- 'where.createdAt.like'?: string;
665
- 'where.createdAt.in'?: string;
666
- 'where.createdAt.nin'?: string;
667
- 'where.createdAt.contains'?: string;
668
- 'where.createdAt.contained'?: string;
669
- 'where.createdAt.overlaps'?: string;
670
- 'where.data.eq'?: string;
671
- 'where.data.neq'?: string;
672
- 'where.data.gt'?: string;
673
- 'where.data.gte'?: string;
674
- 'where.data.lt'?: string;
675
- 'where.data.lte'?: string;
676
- 'where.data.like'?: string;
677
- 'where.data.in'?: string;
678
- 'where.data.nin'?: string;
679
- 'where.data.contains'?: string;
680
- 'where.data.contained'?: string;
681
- 'where.data.overlaps'?: string;
682
- 'where.id.eq'?: string;
683
- 'where.id.neq'?: string;
684
- 'where.id.gt'?: string;
685
- 'where.id.gte'?: string;
686
- 'where.id.lt'?: string;
687
- 'where.id.lte'?: string;
688
- 'where.id.like'?: string;
689
- 'where.id.in'?: string;
690
- 'where.id.nin'?: string;
691
- 'where.id.contains'?: string;
692
- 'where.id.contained'?: string;
693
- 'where.id.overlaps'?: string;
694
- 'where.or'?: Array<string>;
695
- 'orderby.applicationId'?: 'asc' | 'desc';
696
- 'orderby.bundleId'?: 'asc' | 'desc';
697
- 'orderby.createdAt'?: 'asc' | 'desc';
698
- 'orderby.data'?: 'asc' | 'desc';
699
- 'orderby.id'?: 'asc' | 'desc';
806
+ query?: {
807
+ /**
808
+ * Limit will be applied by default if not passed. If the provided value exceeds the maximum allowed value a validation error will be thrown
809
+ */
810
+ 'limit'?: number;
811
+ 'offset'?: number;
812
+ 'totalCount'?: boolean;
813
+ /**
814
+ * Include cursor headers in response. Cursor keys built from orderBy clause
815
+ */
816
+ 'cursor'?: boolean;
817
+ /**
818
+ * Cursor for forward pagination. List objects after this cursor position
819
+ */
820
+ 'startAfter'?: string;
821
+ /**
822
+ * Cursor for backward pagination. List objects before this cursor position
823
+ */
824
+ 'endBefore'?: string;
825
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'data' | 'id'>;
826
+ 'where.applicationId.eq'?: string;
827
+ 'where.applicationId.neq'?: string;
828
+ 'where.applicationId.gt'?: string;
829
+ 'where.applicationId.gte'?: string;
830
+ 'where.applicationId.lt'?: string;
831
+ 'where.applicationId.lte'?: string;
832
+ 'where.applicationId.like'?: string;
833
+ 'where.applicationId.ilike'?: string;
834
+ 'where.applicationId.in'?: string;
835
+ 'where.applicationId.nin'?: string;
836
+ 'where.applicationId.contains'?: string;
837
+ 'where.applicationId.contained'?: string;
838
+ 'where.applicationId.overlaps'?: string;
839
+ 'where.createdAt.eq'?: string;
840
+ 'where.createdAt.neq'?: string;
841
+ 'where.createdAt.gt'?: string;
842
+ 'where.createdAt.gte'?: string;
843
+ 'where.createdAt.lt'?: string;
844
+ 'where.createdAt.lte'?: string;
845
+ 'where.createdAt.like'?: string;
846
+ 'where.createdAt.ilike'?: string;
847
+ 'where.createdAt.in'?: string;
848
+ 'where.createdAt.nin'?: string;
849
+ 'where.createdAt.contains'?: string;
850
+ 'where.createdAt.contained'?: string;
851
+ 'where.createdAt.overlaps'?: string;
852
+ 'where.data.eq'?: string;
853
+ 'where.data.neq'?: string;
854
+ 'where.data.gt'?: string;
855
+ 'where.data.gte'?: string;
856
+ 'where.data.lt'?: string;
857
+ 'where.data.lte'?: string;
858
+ 'where.data.like'?: string;
859
+ 'where.data.ilike'?: string;
860
+ 'where.data.in'?: string;
861
+ 'where.data.nin'?: string;
862
+ 'where.data.contains'?: string;
863
+ 'where.data.contained'?: string;
864
+ 'where.data.overlaps'?: string;
865
+ 'where.id.eq'?: string;
866
+ 'where.id.neq'?: string;
867
+ 'where.id.gt'?: string;
868
+ 'where.id.gte'?: string;
869
+ 'where.id.lt'?: string;
870
+ 'where.id.lte'?: string;
871
+ 'where.id.like'?: string;
872
+ 'where.id.ilike'?: string;
873
+ 'where.id.in'?: string;
874
+ 'where.id.nin'?: string;
875
+ 'where.id.contains'?: string;
876
+ 'where.id.contained'?: string;
877
+ 'where.id.overlaps'?: string;
878
+ 'where.or'?: Array<string>;
879
+ 'orderby.applicationId'?: 'asc' | 'desc';
880
+ 'orderby.createdAt'?: 'asc' | 'desc';
881
+ 'orderby.data'?: 'asc' | 'desc';
882
+ 'orderby.id'?: 'asc' | 'desc';
883
+ }
700
884
  }
701
885
 
702
- export type GetMetadataResponseOK = Array<{ 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'data'?: object; 'createdAt'?: string | null }>
886
+ /**
887
+ * Default Response
888
+ */
889
+ export type GetMetadataResponseOK = Array<{ 'id'?: string | null; 'applicationId'?: string | null; 'data'?: object | null; 'createdAt'?: string | null }>
703
890
  export type GetMetadataResponses =
704
- GetMetadataResponseOK
891
+ FullResponse<GetMetadataResponseOK, 200>
705
892
 
706
893
  export type UpdateMetadataRequest = {
707
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'data' | 'id'>;
708
- 'where.applicationId.eq'?: string;
709
- 'where.applicationId.neq'?: string;
710
- 'where.applicationId.gt'?: string;
711
- 'where.applicationId.gte'?: string;
712
- 'where.applicationId.lt'?: string;
713
- 'where.applicationId.lte'?: string;
714
- 'where.applicationId.like'?: string;
715
- 'where.applicationId.in'?: string;
716
- 'where.applicationId.nin'?: string;
717
- 'where.applicationId.contains'?: string;
718
- 'where.applicationId.contained'?: string;
719
- 'where.applicationId.overlaps'?: string;
720
- 'where.bundleId.eq'?: string;
721
- 'where.bundleId.neq'?: string;
722
- 'where.bundleId.gt'?: string;
723
- 'where.bundleId.gte'?: string;
724
- 'where.bundleId.lt'?: string;
725
- 'where.bundleId.lte'?: string;
726
- 'where.bundleId.like'?: string;
727
- 'where.bundleId.in'?: string;
728
- 'where.bundleId.nin'?: string;
729
- 'where.bundleId.contains'?: string;
730
- 'where.bundleId.contained'?: string;
731
- 'where.bundleId.overlaps'?: string;
732
- 'where.createdAt.eq'?: string;
733
- 'where.createdAt.neq'?: string;
734
- 'where.createdAt.gt'?: string;
735
- 'where.createdAt.gte'?: string;
736
- 'where.createdAt.lt'?: string;
737
- 'where.createdAt.lte'?: string;
738
- 'where.createdAt.like'?: string;
739
- 'where.createdAt.in'?: string;
740
- 'where.createdAt.nin'?: string;
741
- 'where.createdAt.contains'?: string;
742
- 'where.createdAt.contained'?: string;
743
- 'where.createdAt.overlaps'?: string;
744
- 'where.data.eq'?: string;
745
- 'where.data.neq'?: string;
746
- 'where.data.gt'?: string;
747
- 'where.data.gte'?: string;
748
- 'where.data.lt'?: string;
749
- 'where.data.lte'?: string;
750
- 'where.data.like'?: string;
751
- 'where.data.in'?: string;
752
- 'where.data.nin'?: string;
753
- 'where.data.contains'?: string;
754
- 'where.data.contained'?: string;
755
- 'where.data.overlaps'?: string;
756
- 'where.id.eq'?: string;
757
- 'where.id.neq'?: string;
758
- 'where.id.gt'?: string;
759
- 'where.id.gte'?: string;
760
- 'where.id.lt'?: string;
761
- 'where.id.lte'?: string;
762
- 'where.id.like'?: string;
763
- 'where.id.in'?: string;
764
- 'where.id.nin'?: string;
765
- 'where.id.contains'?: string;
766
- 'where.id.contained'?: string;
767
- 'where.id.overlaps'?: string;
768
- 'where.or'?: Array<string>;
769
- 'id'?: string;
770
- 'applicationId'?: string | null;
771
- 'bundleId'?: string | null;
772
- 'data': object;
773
- 'createdAt'?: string | null;
894
+ query?: {
895
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'data' | 'id'>;
896
+ 'where.applicationId.eq'?: string;
897
+ 'where.applicationId.neq'?: string;
898
+ 'where.applicationId.gt'?: string;
899
+ 'where.applicationId.gte'?: string;
900
+ 'where.applicationId.lt'?: string;
901
+ 'where.applicationId.lte'?: string;
902
+ 'where.applicationId.like'?: string;
903
+ 'where.applicationId.ilike'?: string;
904
+ 'where.applicationId.in'?: string;
905
+ 'where.applicationId.nin'?: string;
906
+ 'where.applicationId.contains'?: string;
907
+ 'where.applicationId.contained'?: string;
908
+ 'where.applicationId.overlaps'?: string;
909
+ 'where.createdAt.eq'?: string;
910
+ 'where.createdAt.neq'?: string;
911
+ 'where.createdAt.gt'?: string;
912
+ 'where.createdAt.gte'?: string;
913
+ 'where.createdAt.lt'?: string;
914
+ 'where.createdAt.lte'?: string;
915
+ 'where.createdAt.like'?: string;
916
+ 'where.createdAt.ilike'?: string;
917
+ 'where.createdAt.in'?: string;
918
+ 'where.createdAt.nin'?: string;
919
+ 'where.createdAt.contains'?: string;
920
+ 'where.createdAt.contained'?: string;
921
+ 'where.createdAt.overlaps'?: string;
922
+ 'where.data.eq'?: string;
923
+ 'where.data.neq'?: string;
924
+ 'where.data.gt'?: string;
925
+ 'where.data.gte'?: string;
926
+ 'where.data.lt'?: string;
927
+ 'where.data.lte'?: string;
928
+ 'where.data.like'?: string;
929
+ 'where.data.ilike'?: string;
930
+ 'where.data.in'?: string;
931
+ 'where.data.nin'?: string;
932
+ 'where.data.contains'?: string;
933
+ 'where.data.contained'?: string;
934
+ 'where.data.overlaps'?: string;
935
+ 'where.id.eq'?: string;
936
+ 'where.id.neq'?: string;
937
+ 'where.id.gt'?: string;
938
+ 'where.id.gte'?: string;
939
+ 'where.id.lt'?: string;
940
+ 'where.id.lte'?: string;
941
+ 'where.id.like'?: string;
942
+ 'where.id.ilike'?: string;
943
+ 'where.id.in'?: string;
944
+ 'where.id.nin'?: string;
945
+ 'where.id.contains'?: string;
946
+ 'where.id.contained'?: string;
947
+ 'where.id.overlaps'?: string;
948
+ 'where.or'?: Array<string>;
949
+ }
950
+ body: {
951
+ 'id'?: string;
952
+ 'applicationId'?: string | null;
953
+ 'data': object;
954
+ 'createdAt'?: string | null;
955
+ }
774
956
  }
775
957
 
776
- export type UpdateMetadataResponseOK = Array<{ 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'data'?: object; 'createdAt'?: string | null }>
958
+ /**
959
+ * Default Response
960
+ */
961
+ export type UpdateMetadataResponseOK = Array<{ 'id'?: string | null; 'applicationId'?: string | null; 'data'?: object | null; 'createdAt'?: string | null }>
777
962
  export type UpdateMetadataResponses =
778
- UpdateMetadataResponseOK
963
+ FullResponse<UpdateMetadataResponseOK, 200>
779
964
 
780
965
  export type GetMetadatumByIdRequest = {
781
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'data' | 'id'>;
782
- 'id': string;
966
+ path: {
967
+ 'id': string;
968
+ }
969
+ query?: {
970
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'data' | 'id'>;
971
+ }
783
972
  }
784
973
 
785
- export type GetMetadatumByIdResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'data'?: object; 'createdAt'?: string | null }
974
+ /**
975
+ * A Metadatum
976
+ */
977
+ export type GetMetadatumByIdResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'data'?: object | null; 'createdAt'?: string | null }
786
978
  export type GetMetadatumByIdResponses =
787
- GetMetadatumByIdResponseOK
979
+ FullResponse<GetMetadatumByIdResponseOK, 200>
788
980
 
789
981
  export type UpdateMetadatumRequest = {
790
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'data' | 'id'>;
791
- 'id': string;
792
- 'applicationId'?: string | null;
793
- 'bundleId'?: string | null;
794
- 'data': object;
795
- 'createdAt'?: string | null;
982
+ path: {
983
+ 'id': string;
984
+ }
985
+ query?: {
986
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'data' | 'id'>;
987
+ }
988
+ body: {
989
+ 'applicationId'?: string | null;
990
+ 'data': object;
991
+ 'createdAt'?: string | null;
992
+ }
796
993
  }
797
994
 
798
- export type UpdateMetadatumResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'data'?: object; 'createdAt'?: string | null }
995
+ /**
996
+ * A Metadatum
997
+ */
998
+ export type UpdateMetadatumResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'data'?: object | null; 'createdAt'?: string | null }
799
999
  export type UpdateMetadatumResponses =
800
- UpdateMetadatumResponseOK
1000
+ FullResponse<UpdateMetadatumResponseOK, 200>
801
1001
 
802
1002
  export type DeleteMetadataRequest = {
803
- 'fields'?: Array<'applicationId' | 'bundleId' | 'createdAt' | 'data' | 'id'>;
804
- 'id': string;
1003
+ path: {
1004
+ 'id': string;
1005
+ }
1006
+ query?: {
1007
+ 'fields'?: Array<'applicationId' | 'createdAt' | 'data' | 'id'>;
1008
+ }
805
1009
  }
806
1010
 
807
- export type DeleteMetadataResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'bundleId'?: string | null; 'data'?: object; 'createdAt'?: string | null }
1011
+ /**
1012
+ * A Metadatum
1013
+ */
1014
+ export type DeleteMetadataResponseOK = { 'id'?: string | null; 'applicationId'?: string | null; 'data'?: object | null; 'createdAt'?: string | null }
808
1015
  export type DeleteMetadataResponses =
809
- DeleteMetadataResponseOK
1016
+ FullResponse<DeleteMetadataResponseOK, 200>
810
1017
 
811
1018
  export type PostComplianceRequest = {
812
- 'applicationId': string;
813
- 'bundleId': string;
1019
+ body: {
1020
+ 'applicationId': string;
1021
+ 'podId': string;
1022
+ }
814
1023
  }
815
1024
 
816
1025
  export type PostComplianceResponseOK = unknown
@@ -818,9 +1027,11 @@ export type PostComplianceResponses =
818
1027
  FullResponse<PostComplianceResponseOK, 200>
819
1028
 
820
1029
  export type PostMetadataRequest = {
821
- 'applicationId': string;
822
- 'bundleId': string;
823
- 'data': object;
1030
+ body: {
1031
+ 'applicationId': string;
1032
+ 'podId': string;
1033
+ 'data': object;
1034
+ }
824
1035
  }
825
1036
 
826
1037
  export type PostMetadataResponseOK = unknown
@@ -828,10 +1039,14 @@ export type PostMetadataResponses =
828
1039
  FullResponse<PostMetadataResponseOK, 200>
829
1040
 
830
1041
  export type PostRulesNameRequest = {
831
- 'name': string;
832
- 'applicationId': string;
833
- 'enabled': boolean;
834
- 'options': object;
1042
+ path: {
1043
+ 'name': string;
1044
+ }
1045
+ body: {
1046
+ 'applicationId': string;
1047
+ 'enabled': boolean;
1048
+ 'options': object;
1049
+ }
835
1050
  }
836
1051
 
837
1052
  export type PostRulesNameResponseOK = unknown
@@ -839,7 +1054,7 @@ export type PostRulesNameResponses =
839
1054
  FullResponse<PostRulesNameResponseOK, 200>
840
1055
 
841
1056
  export type GetRulesRequest = {
842
- unknown
1057
+
843
1058
  }
844
1059
 
845
1060
  export type GetRulesResponseOK = unknown
@@ -849,39 +1064,224 @@ export type GetRulesResponses =
849
1064
 
850
1065
 
851
1066
  export interface Compliance {
852
- setBaseUrl(newUrl: string) : void;
853
- setDefaultHeaders(headers: Object) : void;
854
- getReports(req?: GetReportsRequest): Promise<GetReportsResponses>;
855
- createReport(req?: CreateReportRequest): Promise<CreateReportResponses>;
856
- updateReports(req?: UpdateReportsRequest): Promise<UpdateReportsResponses>;
857
- getReportById(req?: GetReportByIdRequest): Promise<GetReportByIdResponses>;
858
- updateReport(req?: UpdateReportRequest): Promise<UpdateReportResponses>;
859
- deleteReports(req?: DeleteReportsRequest): Promise<DeleteReportsResponses>;
860
- createRule(req?: CreateRuleRequest): Promise<CreateRuleResponses>;
861
- updateRules(req?: UpdateRulesRequest): Promise<UpdateRulesResponses>;
862
- getRuleById(req?: GetRuleByIdRequest): Promise<GetRuleByIdResponses>;
863
- updateRule(req?: UpdateRuleRequest): Promise<UpdateRuleResponses>;
864
- deleteRules(req?: DeleteRulesRequest): Promise<DeleteRulesResponses>;
865
- getRuleConfigsForRule(req?: GetRuleConfigsForRuleRequest): Promise<GetRuleConfigsForRuleResponses>;
866
- getRuleConfigs(req?: GetRuleConfigsRequest): Promise<GetRuleConfigsResponses>;
867
- createRuleConfig(req?: CreateRuleConfigRequest): Promise<CreateRuleConfigResponses>;
868
- updateRuleConfigs(req?: UpdateRuleConfigsRequest): Promise<UpdateRuleConfigsResponses>;
869
- getRuleConfigById(req?: GetRuleConfigByIdRequest): Promise<GetRuleConfigByIdResponses>;
870
- updateRuleConfig(req?: UpdateRuleConfigRequest): Promise<UpdateRuleConfigResponses>;
871
- deleteRuleConfigs(req?: DeleteRuleConfigsRequest): Promise<DeleteRuleConfigsResponses>;
872
- getRuleForRuleConfig(req?: GetRuleForRuleConfigRequest): Promise<GetRuleForRuleConfigResponses>;
873
- getMetadata(req?: GetMetadataRequest): Promise<GetMetadataResponses>;
874
- updateMetadata(req?: UpdateMetadataRequest): Promise<UpdateMetadataResponses>;
875
- getMetadatumById(req?: GetMetadatumByIdRequest): Promise<GetMetadatumByIdResponses>;
876
- updateMetadatum(req?: UpdateMetadatumRequest): Promise<UpdateMetadatumResponses>;
877
- deleteMetadata(req?: DeleteMetadataRequest): Promise<DeleteMetadataResponses>;
878
- postCompliance(req?: PostComplianceRequest): Promise<PostComplianceResponses>;
879
- postMetadata(req?: PostMetadataRequest): Promise<PostMetadataResponses>;
880
- postRulesName(req?: PostRulesNameRequest): Promise<PostRulesNameResponses>;
881
- getRules(req?: GetRulesRequest): Promise<GetRulesResponses>;
1067
+ setBaseUrl(newUrl: string): void;
1068
+ setDefaultHeaders(headers: object): void;
1069
+ setDefaultFetchParams(fetchParams: RequestInit): void;
1070
+ /**
1071
+ * Get reports.
1072
+ *
1073
+ * Fetch reports from the database.
1074
+ * @param req - request parameters object
1075
+ * @returns the API response
1076
+ */
1077
+ getReports(req: GetReportsRequest): Promise<GetReportsResponses>;
1078
+ /**
1079
+ * Create report.
1080
+ *
1081
+ * Add new report to the database.
1082
+ * @param req - request parameters object
1083
+ * @returns the API response
1084
+ */
1085
+ createReport(req: CreateReportRequest): Promise<CreateReportResponses>;
1086
+ /**
1087
+ * Update reports.
1088
+ *
1089
+ * Update one or more reports in the database.
1090
+ * @param req - request parameters object
1091
+ * @returns the API response
1092
+ */
1093
+ updateReports(req: UpdateReportsRequest): Promise<UpdateReportsResponses>;
1094
+ /**
1095
+ * Get Report by id.
1096
+ *
1097
+ * Fetch Report using its id from the database.
1098
+ * @param req - request parameters object
1099
+ * @returns the API response
1100
+ */
1101
+ getReportById(req: GetReportByIdRequest): Promise<GetReportByIdResponses>;
1102
+ /**
1103
+ * Update report.
1104
+ *
1105
+ * Update report in the database.
1106
+ * @param req - request parameters object
1107
+ * @returns the API response
1108
+ */
1109
+ updateReport(req: UpdateReportRequest): Promise<UpdateReportResponses>;
1110
+ /**
1111
+ * Delete reports.
1112
+ *
1113
+ * Delete one or more reports from the Database.
1114
+ * @param req - request parameters object
1115
+ * @returns the API response
1116
+ */
1117
+ deleteReports(req: DeleteReportsRequest): Promise<DeleteReportsResponses>;
1118
+ /**
1119
+ * Create rule.
1120
+ *
1121
+ * Add new rule to the database.
1122
+ * @param req - request parameters object
1123
+ * @returns the API response
1124
+ */
1125
+ createRule(req: CreateRuleRequest): Promise<CreateRuleResponses>;
1126
+ /**
1127
+ * Update rules.
1128
+ *
1129
+ * Update one or more rules in the database.
1130
+ * @param req - request parameters object
1131
+ * @returns the API response
1132
+ */
1133
+ updateRules(req: UpdateRulesRequest): Promise<UpdateRulesResponses>;
1134
+ /**
1135
+ * Get Rule by id.
1136
+ *
1137
+ * Fetch Rule using its id from the database.
1138
+ * @param req - request parameters object
1139
+ * @returns the API response
1140
+ */
1141
+ getRuleById(req: GetRuleByIdRequest): Promise<GetRuleByIdResponses>;
1142
+ /**
1143
+ * Update rule.
1144
+ *
1145
+ * Update rule in the database.
1146
+ * @param req - request parameters object
1147
+ * @returns the API response
1148
+ */
1149
+ updateRule(req: UpdateRuleRequest): Promise<UpdateRuleResponses>;
1150
+ /**
1151
+ * Delete rules.
1152
+ *
1153
+ * Delete one or more rules from the Database.
1154
+ * @param req - request parameters object
1155
+ * @returns the API response
1156
+ */
1157
+ deleteRules(req: DeleteRulesRequest): Promise<DeleteRulesResponses>;
1158
+ /**
1159
+ * Get ruleConfigs for rule.
1160
+ *
1161
+ * Fetch all the ruleConfigs for rule from the database.
1162
+ * @param req - request parameters object
1163
+ * @returns the API response
1164
+ */
1165
+ getRuleConfigsForRule(req: GetRuleConfigsForRuleRequest): Promise<GetRuleConfigsForRuleResponses>;
1166
+ /**
1167
+ * Get ruleConfigs.
1168
+ *
1169
+ * Fetch ruleConfigs from the database.
1170
+ * @param req - request parameters object
1171
+ * @returns the API response
1172
+ */
1173
+ getRuleConfigs(req: GetRuleConfigsRequest): Promise<GetRuleConfigsResponses>;
1174
+ /**
1175
+ * Create ruleConfig.
1176
+ *
1177
+ * Add new ruleConfig to the database.
1178
+ * @param req - request parameters object
1179
+ * @returns the API response
1180
+ */
1181
+ createRuleConfig(req: CreateRuleConfigRequest): Promise<CreateRuleConfigResponses>;
1182
+ /**
1183
+ * Update ruleConfigs.
1184
+ *
1185
+ * Update one or more ruleConfigs in the database.
1186
+ * @param req - request parameters object
1187
+ * @returns the API response
1188
+ */
1189
+ updateRuleConfigs(req: UpdateRuleConfigsRequest): Promise<UpdateRuleConfigsResponses>;
1190
+ /**
1191
+ * Get RuleConfig by id.
1192
+ *
1193
+ * Fetch RuleConfig using its id from the database.
1194
+ * @param req - request parameters object
1195
+ * @returns the API response
1196
+ */
1197
+ getRuleConfigById(req: GetRuleConfigByIdRequest): Promise<GetRuleConfigByIdResponses>;
1198
+ /**
1199
+ * Update ruleConfig.
1200
+ *
1201
+ * Update ruleConfig in the database.
1202
+ * @param req - request parameters object
1203
+ * @returns the API response
1204
+ */
1205
+ updateRuleConfig(req: UpdateRuleConfigRequest): Promise<UpdateRuleConfigResponses>;
1206
+ /**
1207
+ * Delete ruleConfigs.
1208
+ *
1209
+ * Delete one or more ruleConfigs from the Database.
1210
+ * @param req - request parameters object
1211
+ * @returns the API response
1212
+ */
1213
+ deleteRuleConfigs(req: DeleteRuleConfigsRequest): Promise<DeleteRuleConfigsResponses>;
1214
+ /**
1215
+ * Get rule for ruleConfig.
1216
+ *
1217
+ * Fetch the rule for ruleConfig from the database.
1218
+ * @param req - request parameters object
1219
+ * @returns the API response
1220
+ */
1221
+ getRuleForRuleConfig(req: GetRuleForRuleConfigRequest): Promise<GetRuleForRuleConfigResponses>;
1222
+ /**
1223
+ * Get metadata.
1224
+ *
1225
+ * Fetch metadata from the database.
1226
+ * @param req - request parameters object
1227
+ * @returns the API response
1228
+ */
1229
+ getMetadata(req: GetMetadataRequest): Promise<GetMetadataResponses>;
1230
+ /**
1231
+ * Update metadata.
1232
+ *
1233
+ * Update one or more metadata in the database.
1234
+ * @param req - request parameters object
1235
+ * @returns the API response
1236
+ */
1237
+ updateMetadata(req: UpdateMetadataRequest): Promise<UpdateMetadataResponses>;
1238
+ /**
1239
+ * Get Metadatum by id.
1240
+ *
1241
+ * Fetch Metadatum using its id from the database.
1242
+ * @param req - request parameters object
1243
+ * @returns the API response
1244
+ */
1245
+ getMetadatumById(req: GetMetadatumByIdRequest): Promise<GetMetadatumByIdResponses>;
1246
+ /**
1247
+ * Update metadatum.
1248
+ *
1249
+ * Update metadatum in the database.
1250
+ * @param req - request parameters object
1251
+ * @returns the API response
1252
+ */
1253
+ updateMetadatum(req: UpdateMetadatumRequest): Promise<UpdateMetadatumResponses>;
1254
+ /**
1255
+ * Delete metadata.
1256
+ *
1257
+ * Delete one or more metadata from the Database.
1258
+ * @param req - request parameters object
1259
+ * @returns the API response
1260
+ */
1261
+ deleteMetadata(req: DeleteMetadataRequest): Promise<DeleteMetadataResponses>;
1262
+ /**
1263
+ * @param req - request parameters object
1264
+ * @returns the API response
1265
+ */
1266
+ postCompliance(req: PostComplianceRequest): Promise<PostComplianceResponses>;
1267
+ /**
1268
+ * @param req - request parameters object
1269
+ * @returns the API response
1270
+ */
1271
+ postMetadata(req: PostMetadataRequest): Promise<PostMetadataResponses>;
1272
+ /**
1273
+ * @param req - request parameters object
1274
+ * @returns the API response
1275
+ */
1276
+ postRulesName(req: PostRulesNameRequest): Promise<PostRulesNameResponses>;
1277
+ /**
1278
+ * @param req - request parameters object
1279
+ * @returns the API response
1280
+ */
1281
+ getRules(req: GetRulesRequest): Promise<GetRulesResponses>;
882
1282
  }
883
1283
  type PlatformaticFrontendClient = Omit<Compliance, 'setBaseUrl'>
884
1284
  type BuildOptions = {
885
- headers?: Object
1285
+ headers?: object
886
1286
  }
887
1287
  export default function build(url: string, options?: BuildOptions): PlatformaticFrontendClient