@wix/export-async-job 1.0.2 → 1.0.4
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/build/cjs/context.d.ts +1 -0
- package/build/cjs/{index.typings.js → context.js} +7 -3
- package/build/cjs/context.js.map +1 -0
- package/build/cjs/index.d.ts +1 -1
- package/build/cjs/index.js +6 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -1
- package/build/cjs/meta.js +6 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +1 -0
- package/build/es/context.js +2 -0
- package/build/es/context.js.map +1 -0
- package/build/es/index.d.ts +1 -1
- package/build/es/index.js +1 -1
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +1 -1
- package/build/es/meta.js +1 -1
- package/build/es/meta.js.map +1 -1
- package/context/package.json +7 -0
- package/meta/package.json +2 -1
- package/package.json +21 -8
- package/{build/cjs/src/fedinfra-exportservice-v1-export-async-job.universal.d.ts → type-bundles/context.bundle.d.ts} +312 -256
- package/{build/es/src/fedinfra-exportservice-v1-export-async-job.universal.d.ts → type-bundles/index.bundle.d.ts} +312 -256
- package/type-bundles/meta.bundle.d.ts +687 -0
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.http.d.ts +0 -7
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.http.js +0 -111
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.http.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.meta.d.ts +0 -19
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.meta.js +0 -81
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.meta.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.public.d.ts +0 -10
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.public.js +0 -36
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.public.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.types.d.ts +0 -1009
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.types.js +0 -121
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.types.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.universal.js +0 -334
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.universal.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.http.d.ts +0 -7
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.http.js +0 -105
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.http.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.meta.d.ts +0 -19
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.meta.js +0 -56
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.meta.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.public.d.ts +0 -10
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.public.js +0 -19
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.public.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.types.d.ts +0 -1009
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.types.js +0 -118
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.types.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.universal.js +0 -309
- package/build/es/src/fedinfra-exportservice-v1-export-async-job.universal.js.map +0 -1
|
@@ -0,0 +1,687 @@
|
|
|
1
|
+
interface ExportAsyncJob$1 {
|
|
2
|
+
/** @readonly */
|
|
3
|
+
id?: string;
|
|
4
|
+
data?: ExportAsyncJobData$1;
|
|
5
|
+
status?: Status$1;
|
|
6
|
+
/** @readonly */
|
|
7
|
+
createDate?: Date;
|
|
8
|
+
/** @readonly */
|
|
9
|
+
updateDate?: Date;
|
|
10
|
+
}
|
|
11
|
+
interface ExportAsyncJobData$1 {
|
|
12
|
+
/** original request data for the export */
|
|
13
|
+
query?: ExportQueryV2$1;
|
|
14
|
+
/** translated CSV headers */
|
|
15
|
+
fields?: FieldDescriptor$1[];
|
|
16
|
+
arrayFieldDelimiter?: ArrayFieldDelimiter$1;
|
|
17
|
+
/** The target method to query data from */
|
|
18
|
+
methodMetadata?: MethodMetadata$1;
|
|
19
|
+
/** Custom spec for the target method's request/response */
|
|
20
|
+
methodSpec?: MethodSpec$1;
|
|
21
|
+
userId?: string;
|
|
22
|
+
subDir?: string | null;
|
|
23
|
+
format?: string;
|
|
24
|
+
uploadId?: string;
|
|
25
|
+
saveAs?: string | null;
|
|
26
|
+
/** the progress of fetching all data update during the process multiple times */
|
|
27
|
+
pagingMetadata?: PagingMetadataV2$1;
|
|
28
|
+
iterationsCount?: number;
|
|
29
|
+
processedItemsCount?: number;
|
|
30
|
+
completionStep?: string | null;
|
|
31
|
+
/** how many times the export was reset */
|
|
32
|
+
resetCount?: number;
|
|
33
|
+
/** at final step update the signed_url to download the result from */
|
|
34
|
+
signedUrl?: string;
|
|
35
|
+
/** when failed during the process update the error details */
|
|
36
|
+
error?: Details$1;
|
|
37
|
+
testParams?: Record<string, any> | null;
|
|
38
|
+
}
|
|
39
|
+
interface ExportQueryV2$1 extends ExportQueryV2PagingMethodOneOf$1 {
|
|
40
|
+
/** Paging options to limit and skip the number of items. */
|
|
41
|
+
paging?: Paging$1;
|
|
42
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
43
|
+
cursorPaging?: ExportCursorPaging$1;
|
|
44
|
+
/**
|
|
45
|
+
* Filter object in the following format:
|
|
46
|
+
* `"filter" : {
|
|
47
|
+
* "fieldName1": "value1",
|
|
48
|
+
* "fieldName2":{"$operator":"value2"}
|
|
49
|
+
* }`
|
|
50
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
51
|
+
*/
|
|
52
|
+
filter?: Record<string, any> | null;
|
|
53
|
+
/**
|
|
54
|
+
* Sort object in the following format:
|
|
55
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
56
|
+
*/
|
|
57
|
+
sort?: Sorting$1[];
|
|
58
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
59
|
+
fields?: string[];
|
|
60
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
61
|
+
fieldsets?: string[];
|
|
62
|
+
}
|
|
63
|
+
/** @oneof */
|
|
64
|
+
interface ExportQueryV2PagingMethodOneOf$1 {
|
|
65
|
+
/** Paging options to limit and skip the number of items. */
|
|
66
|
+
paging?: Paging$1;
|
|
67
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
68
|
+
cursorPaging?: ExportCursorPaging$1;
|
|
69
|
+
}
|
|
70
|
+
interface Sorting$1 {
|
|
71
|
+
/** Name of the field to sort by. */
|
|
72
|
+
fieldName?: string;
|
|
73
|
+
/** Sort order. */
|
|
74
|
+
order?: SortOrder$1;
|
|
75
|
+
}
|
|
76
|
+
declare enum SortOrder$1 {
|
|
77
|
+
ASC = "ASC",
|
|
78
|
+
DESC = "DESC"
|
|
79
|
+
}
|
|
80
|
+
interface Paging$1 {
|
|
81
|
+
/** Number of items to load. */
|
|
82
|
+
limit?: number | null;
|
|
83
|
+
/** Number of items to skip in the current sort order. */
|
|
84
|
+
offset?: number | null;
|
|
85
|
+
}
|
|
86
|
+
interface ExportCursorPaging$1 {
|
|
87
|
+
limit?: number | null;
|
|
88
|
+
cursor?: string | null;
|
|
89
|
+
}
|
|
90
|
+
interface FieldDescriptor$1 {
|
|
91
|
+
/** the path to the field out of the query response items */
|
|
92
|
+
id?: string;
|
|
93
|
+
/** how to present the filed in the CSV headers (translated) */
|
|
94
|
+
header?: string;
|
|
95
|
+
}
|
|
96
|
+
declare enum ArrayFieldDelimiter$1 {
|
|
97
|
+
SEMICOLON = "SEMICOLON",
|
|
98
|
+
SEMICOLON_AND_SPACE = "SEMICOLON_AND_SPACE"
|
|
99
|
+
}
|
|
100
|
+
interface MethodMetadata$1 {
|
|
101
|
+
artifact?: string;
|
|
102
|
+
service?: string;
|
|
103
|
+
method?: string;
|
|
104
|
+
}
|
|
105
|
+
interface MethodSpec$1 {
|
|
106
|
+
requestQueryFieldNumber?: QueryFieldNumber$1;
|
|
107
|
+
responseRepeatedFieldName?: string | null;
|
|
108
|
+
responsePagingMetadataFieldName?: string | null;
|
|
109
|
+
}
|
|
110
|
+
declare enum QueryFieldNumber$1 {
|
|
111
|
+
/** message QuerySomethingRequest { .wix.common.QueryV2 query = 1; } */
|
|
112
|
+
DEFAULT = "DEFAULT",
|
|
113
|
+
FIELD_2 = "FIELD_2",
|
|
114
|
+
FIELD_3 = "FIELD_3",
|
|
115
|
+
FIELD_4 = "FIELD_4",
|
|
116
|
+
FIELD_5 = "FIELD_5",
|
|
117
|
+
FIELD_6 = "FIELD_6",
|
|
118
|
+
FIELD_7 = "FIELD_7",
|
|
119
|
+
/** message QuerySomethingRequest { .wix.common.QueryV2 query = 8; } */
|
|
120
|
+
FIELD_8 = "FIELD_8",
|
|
121
|
+
FIELD_9 = "FIELD_9"
|
|
122
|
+
}
|
|
123
|
+
interface PagingMetadataV2$1 {
|
|
124
|
+
/** Number of items returned in the response. */
|
|
125
|
+
count?: number | null;
|
|
126
|
+
/** Offset that was requested. */
|
|
127
|
+
offset?: number | null;
|
|
128
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
129
|
+
total?: number | null;
|
|
130
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
131
|
+
tooManyToCount?: boolean | null;
|
|
132
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
133
|
+
cursors?: Cursors$1;
|
|
134
|
+
}
|
|
135
|
+
interface Cursors$1 {
|
|
136
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
137
|
+
next?: string | null;
|
|
138
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
139
|
+
prev?: string | null;
|
|
140
|
+
}
|
|
141
|
+
interface Details$1 extends DetailsKindOneOf$1 {
|
|
142
|
+
applicationError?: ApplicationError$1;
|
|
143
|
+
validationError?: ValidationError$1;
|
|
144
|
+
systemError?: SystemError$1;
|
|
145
|
+
/**
|
|
146
|
+
* deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
|
|
147
|
+
* @deprecated
|
|
148
|
+
*/
|
|
149
|
+
tracing?: Record<string, string>;
|
|
150
|
+
}
|
|
151
|
+
/** @oneof */
|
|
152
|
+
interface DetailsKindOneOf$1 {
|
|
153
|
+
applicationError?: ApplicationError$1;
|
|
154
|
+
validationError?: ValidationError$1;
|
|
155
|
+
systemError?: SystemError$1;
|
|
156
|
+
}
|
|
157
|
+
interface ApplicationError$1 {
|
|
158
|
+
/** Error code. */
|
|
159
|
+
code?: string;
|
|
160
|
+
/** Description of the error. */
|
|
161
|
+
description?: string;
|
|
162
|
+
/** Data related to the error. */
|
|
163
|
+
data?: Record<string, any> | null;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* example result:
|
|
167
|
+
* {
|
|
168
|
+
* "fieldViolations": [
|
|
169
|
+
* {
|
|
170
|
+
* "field": "fieldA",
|
|
171
|
+
* "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
|
|
172
|
+
* "violatedRule": "OTHER",
|
|
173
|
+
* "ruleName": "INVALID_NOTE",
|
|
174
|
+
* "data": {
|
|
175
|
+
* "value": "FI"
|
|
176
|
+
* }
|
|
177
|
+
* },
|
|
178
|
+
* {
|
|
179
|
+
* "field": "fieldB",
|
|
180
|
+
* "description": "field value out of range. supported range: [0-20]",
|
|
181
|
+
* "violatedRule": "MAX",
|
|
182
|
+
* "data": {
|
|
183
|
+
* "threshold": 20
|
|
184
|
+
* }
|
|
185
|
+
* },
|
|
186
|
+
* {
|
|
187
|
+
* "field": "fieldC",
|
|
188
|
+
* "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
|
|
189
|
+
* "violatedRule": "FORMAT",
|
|
190
|
+
* "data": {
|
|
191
|
+
* "type": "PHONE"
|
|
192
|
+
* }
|
|
193
|
+
* }
|
|
194
|
+
* ]
|
|
195
|
+
* }
|
|
196
|
+
*/
|
|
197
|
+
interface ValidationError$1 {
|
|
198
|
+
fieldViolations?: FieldViolation$1[];
|
|
199
|
+
}
|
|
200
|
+
declare enum RuleType$1 {
|
|
201
|
+
VALIDATION = "VALIDATION",
|
|
202
|
+
OTHER = "OTHER",
|
|
203
|
+
MAX = "MAX",
|
|
204
|
+
MIN = "MIN",
|
|
205
|
+
MAX_LENGTH = "MAX_LENGTH",
|
|
206
|
+
MIN_LENGTH = "MIN_LENGTH",
|
|
207
|
+
MAX_SIZE = "MAX_SIZE",
|
|
208
|
+
MIN_SIZE = "MIN_SIZE",
|
|
209
|
+
FORMAT = "FORMAT",
|
|
210
|
+
DECIMAL_LTE = "DECIMAL_LTE",
|
|
211
|
+
DECIMAL_GTE = "DECIMAL_GTE",
|
|
212
|
+
DECIMAL_LT = "DECIMAL_LT",
|
|
213
|
+
DECIMAL_GT = "DECIMAL_GT",
|
|
214
|
+
DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
|
|
215
|
+
INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
|
|
216
|
+
REQUIRED_FIELD = "REQUIRED_FIELD",
|
|
217
|
+
FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
|
|
218
|
+
ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT"
|
|
219
|
+
}
|
|
220
|
+
interface FieldViolation$1 {
|
|
221
|
+
field?: string;
|
|
222
|
+
description?: string;
|
|
223
|
+
violatedRule?: RuleType$1;
|
|
224
|
+
/** applicable when violated_rule=OTHER */
|
|
225
|
+
ruleName?: string | null;
|
|
226
|
+
data?: Record<string, any> | null;
|
|
227
|
+
}
|
|
228
|
+
interface SystemError$1 {
|
|
229
|
+
/** Error code. */
|
|
230
|
+
errorCode?: string | null;
|
|
231
|
+
}
|
|
232
|
+
declare enum Status$1 {
|
|
233
|
+
UNKNOWN = "UNKNOWN",
|
|
234
|
+
/** Job was created, but not started yet. */
|
|
235
|
+
INITIALIZED = "INITIALIZED",
|
|
236
|
+
/** Job has started and is in progress. */
|
|
237
|
+
PROCESSING = "PROCESSING",
|
|
238
|
+
/** Job is finished. */
|
|
239
|
+
FINISHED = "FINISHED",
|
|
240
|
+
/** Job has failed. */
|
|
241
|
+
FAILED = "FAILED"
|
|
242
|
+
}
|
|
243
|
+
interface CreateExportAsyncJobRequest$1 {
|
|
244
|
+
/** WQL expression */
|
|
245
|
+
query: ExportQueryV2$1;
|
|
246
|
+
/** translated CSV headers */
|
|
247
|
+
fields: FieldDescriptor$1[];
|
|
248
|
+
arrayFieldDelimiter?: ArrayFieldDelimiter$1;
|
|
249
|
+
/** The target method to query data from */
|
|
250
|
+
methodMetadata: MethodMetadata$1;
|
|
251
|
+
/** The target method to query data from */
|
|
252
|
+
methodSpec?: MethodSpec$1;
|
|
253
|
+
saveAs?: string | null;
|
|
254
|
+
/** Test params */
|
|
255
|
+
testParams?: Record<string, any> | null;
|
|
256
|
+
}
|
|
257
|
+
interface CreateExportAsyncJobResponse$1 {
|
|
258
|
+
/** The retrieved Exports */
|
|
259
|
+
job?: ExportAsyncJob$1;
|
|
260
|
+
}
|
|
261
|
+
interface GetExportAsyncJobRequest$1 {
|
|
262
|
+
/** Id of the Export to retrieve */
|
|
263
|
+
jobId: string;
|
|
264
|
+
}
|
|
265
|
+
interface GetExportAsyncJobResponse$1 {
|
|
266
|
+
/** The retrieved ExportAsyncJob */
|
|
267
|
+
job?: ExportAsyncJob$1;
|
|
268
|
+
}
|
|
269
|
+
interface SortingNonNullableFields$1 {
|
|
270
|
+
fieldName: string;
|
|
271
|
+
order: SortOrder$1;
|
|
272
|
+
}
|
|
273
|
+
interface ExportQueryV2NonNullableFields$1 {
|
|
274
|
+
sort: SortingNonNullableFields$1[];
|
|
275
|
+
fields: string[];
|
|
276
|
+
fieldsets: string[];
|
|
277
|
+
}
|
|
278
|
+
interface FieldDescriptorNonNullableFields$1 {
|
|
279
|
+
id: string;
|
|
280
|
+
header: string;
|
|
281
|
+
}
|
|
282
|
+
interface MethodMetadataNonNullableFields$1 {
|
|
283
|
+
artifact: string;
|
|
284
|
+
service: string;
|
|
285
|
+
method: string;
|
|
286
|
+
}
|
|
287
|
+
interface MethodSpecNonNullableFields$1 {
|
|
288
|
+
requestQueryFieldNumber: QueryFieldNumber$1;
|
|
289
|
+
}
|
|
290
|
+
interface ApplicationErrorNonNullableFields$1 {
|
|
291
|
+
code: string;
|
|
292
|
+
description: string;
|
|
293
|
+
}
|
|
294
|
+
interface FieldViolationNonNullableFields$1 {
|
|
295
|
+
field: string;
|
|
296
|
+
description: string;
|
|
297
|
+
violatedRule: RuleType$1;
|
|
298
|
+
}
|
|
299
|
+
interface ValidationErrorNonNullableFields$1 {
|
|
300
|
+
fieldViolations: FieldViolationNonNullableFields$1[];
|
|
301
|
+
}
|
|
302
|
+
interface DetailsNonNullableFields$1 {
|
|
303
|
+
applicationError?: ApplicationErrorNonNullableFields$1;
|
|
304
|
+
validationError?: ValidationErrorNonNullableFields$1;
|
|
305
|
+
}
|
|
306
|
+
interface ExportAsyncJobDataNonNullableFields$1 {
|
|
307
|
+
query?: ExportQueryV2NonNullableFields$1;
|
|
308
|
+
fields: FieldDescriptorNonNullableFields$1[];
|
|
309
|
+
arrayFieldDelimiter: ArrayFieldDelimiter$1;
|
|
310
|
+
methodMetadata?: MethodMetadataNonNullableFields$1;
|
|
311
|
+
methodSpec?: MethodSpecNonNullableFields$1;
|
|
312
|
+
userId: string;
|
|
313
|
+
format: string;
|
|
314
|
+
uploadId: string;
|
|
315
|
+
iterationsCount: number;
|
|
316
|
+
processedItemsCount: number;
|
|
317
|
+
resetCount: number;
|
|
318
|
+
signedUrl: string;
|
|
319
|
+
error?: DetailsNonNullableFields$1;
|
|
320
|
+
}
|
|
321
|
+
interface ExportAsyncJobNonNullableFields$1 {
|
|
322
|
+
id: string;
|
|
323
|
+
data?: ExportAsyncJobDataNonNullableFields$1;
|
|
324
|
+
status: Status$1;
|
|
325
|
+
}
|
|
326
|
+
interface CreateExportAsyncJobResponseNonNullableFields$1 {
|
|
327
|
+
job?: ExportAsyncJobNonNullableFields$1;
|
|
328
|
+
}
|
|
329
|
+
interface GetExportAsyncJobResponseNonNullableFields$1 {
|
|
330
|
+
job?: ExportAsyncJobNonNullableFields$1;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
interface ExportAsyncJob {
|
|
334
|
+
/** @readonly */
|
|
335
|
+
_id?: string;
|
|
336
|
+
data?: ExportAsyncJobData;
|
|
337
|
+
status?: Status;
|
|
338
|
+
/** @readonly */
|
|
339
|
+
createDate?: Date;
|
|
340
|
+
/** @readonly */
|
|
341
|
+
updateDate?: Date;
|
|
342
|
+
}
|
|
343
|
+
interface ExportAsyncJobData {
|
|
344
|
+
/** original request data for the export */
|
|
345
|
+
query?: ExportQueryV2;
|
|
346
|
+
/** translated CSV headers */
|
|
347
|
+
fields?: FieldDescriptor[];
|
|
348
|
+
arrayFieldDelimiter?: ArrayFieldDelimiter;
|
|
349
|
+
/** The target method to query data from */
|
|
350
|
+
methodMetadata?: MethodMetadata;
|
|
351
|
+
/** Custom spec for the target method's request/response */
|
|
352
|
+
methodSpec?: MethodSpec;
|
|
353
|
+
userId?: string;
|
|
354
|
+
subDir?: string | null;
|
|
355
|
+
format?: string;
|
|
356
|
+
uploadId?: string;
|
|
357
|
+
saveAs?: string | null;
|
|
358
|
+
/** the progress of fetching all data update during the process multiple times */
|
|
359
|
+
pagingMetadata?: PagingMetadataV2;
|
|
360
|
+
iterationsCount?: number;
|
|
361
|
+
processedItemsCount?: number;
|
|
362
|
+
completionStep?: string | null;
|
|
363
|
+
/** how many times the export was reset */
|
|
364
|
+
resetCount?: number;
|
|
365
|
+
/** at final step update the signed_url to download the result from */
|
|
366
|
+
signedUrl?: string;
|
|
367
|
+
/** when failed during the process update the error details */
|
|
368
|
+
error?: Details;
|
|
369
|
+
testParams?: Record<string, any> | null;
|
|
370
|
+
}
|
|
371
|
+
interface ExportQueryV2 extends ExportQueryV2PagingMethodOneOf {
|
|
372
|
+
/** Paging options to limit and skip the number of items. */
|
|
373
|
+
paging?: Paging;
|
|
374
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
375
|
+
cursorPaging?: ExportCursorPaging;
|
|
376
|
+
/**
|
|
377
|
+
* Filter object in the following format:
|
|
378
|
+
* `"filter" : {
|
|
379
|
+
* "fieldName1": "value1",
|
|
380
|
+
* "fieldName2":{"$operator":"value2"}
|
|
381
|
+
* }`
|
|
382
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
383
|
+
*/
|
|
384
|
+
filter?: Record<string, any> | null;
|
|
385
|
+
/**
|
|
386
|
+
* Sort object in the following format:
|
|
387
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
388
|
+
*/
|
|
389
|
+
sort?: Sorting[];
|
|
390
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
391
|
+
fields?: string[];
|
|
392
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
393
|
+
fieldsets?: string[];
|
|
394
|
+
}
|
|
395
|
+
/** @oneof */
|
|
396
|
+
interface ExportQueryV2PagingMethodOneOf {
|
|
397
|
+
/** Paging options to limit and skip the number of items. */
|
|
398
|
+
paging?: Paging;
|
|
399
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
400
|
+
cursorPaging?: ExportCursorPaging;
|
|
401
|
+
}
|
|
402
|
+
interface Sorting {
|
|
403
|
+
/** Name of the field to sort by. */
|
|
404
|
+
fieldName?: string;
|
|
405
|
+
/** Sort order. */
|
|
406
|
+
order?: SortOrder;
|
|
407
|
+
}
|
|
408
|
+
declare enum SortOrder {
|
|
409
|
+
ASC = "ASC",
|
|
410
|
+
DESC = "DESC"
|
|
411
|
+
}
|
|
412
|
+
interface Paging {
|
|
413
|
+
/** Number of items to load. */
|
|
414
|
+
limit?: number | null;
|
|
415
|
+
/** Number of items to skip in the current sort order. */
|
|
416
|
+
offset?: number | null;
|
|
417
|
+
}
|
|
418
|
+
interface ExportCursorPaging {
|
|
419
|
+
limit?: number | null;
|
|
420
|
+
cursor?: string | null;
|
|
421
|
+
}
|
|
422
|
+
interface FieldDescriptor {
|
|
423
|
+
/** the path to the field out of the query response items */
|
|
424
|
+
_id?: string;
|
|
425
|
+
/** how to present the filed in the CSV headers (translated) */
|
|
426
|
+
header?: string;
|
|
427
|
+
}
|
|
428
|
+
declare enum ArrayFieldDelimiter {
|
|
429
|
+
SEMICOLON = "SEMICOLON",
|
|
430
|
+
SEMICOLON_AND_SPACE = "SEMICOLON_AND_SPACE"
|
|
431
|
+
}
|
|
432
|
+
interface MethodMetadata {
|
|
433
|
+
artifact?: string;
|
|
434
|
+
service?: string;
|
|
435
|
+
method?: string;
|
|
436
|
+
}
|
|
437
|
+
interface MethodSpec {
|
|
438
|
+
requestQueryFieldNumber?: QueryFieldNumber;
|
|
439
|
+
responseRepeatedFieldName?: string | null;
|
|
440
|
+
responsePagingMetadataFieldName?: string | null;
|
|
441
|
+
}
|
|
442
|
+
declare enum QueryFieldNumber {
|
|
443
|
+
/** message QuerySomethingRequest { .wix.common.QueryV2 query = 1; } */
|
|
444
|
+
DEFAULT = "DEFAULT",
|
|
445
|
+
FIELD_2 = "FIELD_2",
|
|
446
|
+
FIELD_3 = "FIELD_3",
|
|
447
|
+
FIELD_4 = "FIELD_4",
|
|
448
|
+
FIELD_5 = "FIELD_5",
|
|
449
|
+
FIELD_6 = "FIELD_6",
|
|
450
|
+
FIELD_7 = "FIELD_7",
|
|
451
|
+
/** message QuerySomethingRequest { .wix.common.QueryV2 query = 8; } */
|
|
452
|
+
FIELD_8 = "FIELD_8",
|
|
453
|
+
FIELD_9 = "FIELD_9"
|
|
454
|
+
}
|
|
455
|
+
interface PagingMetadataV2 {
|
|
456
|
+
/** Number of items returned in the response. */
|
|
457
|
+
count?: number | null;
|
|
458
|
+
/** Offset that was requested. */
|
|
459
|
+
offset?: number | null;
|
|
460
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
461
|
+
total?: number | null;
|
|
462
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
463
|
+
tooManyToCount?: boolean | null;
|
|
464
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
465
|
+
cursors?: Cursors;
|
|
466
|
+
}
|
|
467
|
+
interface Cursors {
|
|
468
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
469
|
+
next?: string | null;
|
|
470
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
471
|
+
prev?: string | null;
|
|
472
|
+
}
|
|
473
|
+
interface Details extends DetailsKindOneOf {
|
|
474
|
+
applicationError?: ApplicationError;
|
|
475
|
+
validationError?: ValidationError;
|
|
476
|
+
systemError?: SystemError;
|
|
477
|
+
/**
|
|
478
|
+
* deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
|
|
479
|
+
* @deprecated
|
|
480
|
+
*/
|
|
481
|
+
tracing?: Record<string, string>;
|
|
482
|
+
}
|
|
483
|
+
/** @oneof */
|
|
484
|
+
interface DetailsKindOneOf {
|
|
485
|
+
applicationError?: ApplicationError;
|
|
486
|
+
validationError?: ValidationError;
|
|
487
|
+
systemError?: SystemError;
|
|
488
|
+
}
|
|
489
|
+
interface ApplicationError {
|
|
490
|
+
/** Error code. */
|
|
491
|
+
code?: string;
|
|
492
|
+
/** Description of the error. */
|
|
493
|
+
description?: string;
|
|
494
|
+
/** Data related to the error. */
|
|
495
|
+
data?: Record<string, any> | null;
|
|
496
|
+
}
|
|
497
|
+
/**
|
|
498
|
+
* example result:
|
|
499
|
+
* {
|
|
500
|
+
* "fieldViolations": [
|
|
501
|
+
* {
|
|
502
|
+
* "field": "fieldA",
|
|
503
|
+
* "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
|
|
504
|
+
* "violatedRule": "OTHER",
|
|
505
|
+
* "ruleName": "INVALID_NOTE",
|
|
506
|
+
* "data": {
|
|
507
|
+
* "value": "FI"
|
|
508
|
+
* }
|
|
509
|
+
* },
|
|
510
|
+
* {
|
|
511
|
+
* "field": "fieldB",
|
|
512
|
+
* "description": "field value out of range. supported range: [0-20]",
|
|
513
|
+
* "violatedRule": "MAX",
|
|
514
|
+
* "data": {
|
|
515
|
+
* "threshold": 20
|
|
516
|
+
* }
|
|
517
|
+
* },
|
|
518
|
+
* {
|
|
519
|
+
* "field": "fieldC",
|
|
520
|
+
* "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
|
|
521
|
+
* "violatedRule": "FORMAT",
|
|
522
|
+
* "data": {
|
|
523
|
+
* "type": "PHONE"
|
|
524
|
+
* }
|
|
525
|
+
* }
|
|
526
|
+
* ]
|
|
527
|
+
* }
|
|
528
|
+
*/
|
|
529
|
+
interface ValidationError {
|
|
530
|
+
fieldViolations?: FieldViolation[];
|
|
531
|
+
}
|
|
532
|
+
declare enum RuleType {
|
|
533
|
+
VALIDATION = "VALIDATION",
|
|
534
|
+
OTHER = "OTHER",
|
|
535
|
+
MAX = "MAX",
|
|
536
|
+
MIN = "MIN",
|
|
537
|
+
MAX_LENGTH = "MAX_LENGTH",
|
|
538
|
+
MIN_LENGTH = "MIN_LENGTH",
|
|
539
|
+
MAX_SIZE = "MAX_SIZE",
|
|
540
|
+
MIN_SIZE = "MIN_SIZE",
|
|
541
|
+
FORMAT = "FORMAT",
|
|
542
|
+
DECIMAL_LTE = "DECIMAL_LTE",
|
|
543
|
+
DECIMAL_GTE = "DECIMAL_GTE",
|
|
544
|
+
DECIMAL_LT = "DECIMAL_LT",
|
|
545
|
+
DECIMAL_GT = "DECIMAL_GT",
|
|
546
|
+
DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
|
|
547
|
+
INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
|
|
548
|
+
REQUIRED_FIELD = "REQUIRED_FIELD",
|
|
549
|
+
FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
|
|
550
|
+
ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT"
|
|
551
|
+
}
|
|
552
|
+
interface FieldViolation {
|
|
553
|
+
field?: string;
|
|
554
|
+
description?: string;
|
|
555
|
+
violatedRule?: RuleType;
|
|
556
|
+
/** applicable when violated_rule=OTHER */
|
|
557
|
+
ruleName?: string | null;
|
|
558
|
+
data?: Record<string, any> | null;
|
|
559
|
+
}
|
|
560
|
+
interface SystemError {
|
|
561
|
+
/** Error code. */
|
|
562
|
+
errorCode?: string | null;
|
|
563
|
+
}
|
|
564
|
+
declare enum Status {
|
|
565
|
+
UNKNOWN = "UNKNOWN",
|
|
566
|
+
/** Job was created, but not started yet. */
|
|
567
|
+
INITIALIZED = "INITIALIZED",
|
|
568
|
+
/** Job has started and is in progress. */
|
|
569
|
+
PROCESSING = "PROCESSING",
|
|
570
|
+
/** Job is finished. */
|
|
571
|
+
FINISHED = "FINISHED",
|
|
572
|
+
/** Job has failed. */
|
|
573
|
+
FAILED = "FAILED"
|
|
574
|
+
}
|
|
575
|
+
interface CreateExportAsyncJobRequest {
|
|
576
|
+
/** WQL expression */
|
|
577
|
+
query: ExportQueryV2;
|
|
578
|
+
/** translated CSV headers */
|
|
579
|
+
fields: FieldDescriptor[];
|
|
580
|
+
arrayFieldDelimiter?: ArrayFieldDelimiter;
|
|
581
|
+
/** The target method to query data from */
|
|
582
|
+
methodMetadata: MethodMetadata;
|
|
583
|
+
/** The target method to query data from */
|
|
584
|
+
methodSpec?: MethodSpec;
|
|
585
|
+
saveAs?: string | null;
|
|
586
|
+
/** Test params */
|
|
587
|
+
testParams?: Record<string, any> | null;
|
|
588
|
+
}
|
|
589
|
+
interface CreateExportAsyncJobResponse {
|
|
590
|
+
/** The retrieved Exports */
|
|
591
|
+
job?: ExportAsyncJob;
|
|
592
|
+
}
|
|
593
|
+
interface GetExportAsyncJobRequest {
|
|
594
|
+
/** Id of the Export to retrieve */
|
|
595
|
+
jobId: string;
|
|
596
|
+
}
|
|
597
|
+
interface GetExportAsyncJobResponse {
|
|
598
|
+
/** The retrieved ExportAsyncJob */
|
|
599
|
+
job?: ExportAsyncJob;
|
|
600
|
+
}
|
|
601
|
+
interface SortingNonNullableFields {
|
|
602
|
+
fieldName: string;
|
|
603
|
+
order: SortOrder;
|
|
604
|
+
}
|
|
605
|
+
interface ExportQueryV2NonNullableFields {
|
|
606
|
+
sort: SortingNonNullableFields[];
|
|
607
|
+
fields: string[];
|
|
608
|
+
fieldsets: string[];
|
|
609
|
+
}
|
|
610
|
+
interface FieldDescriptorNonNullableFields {
|
|
611
|
+
_id: string;
|
|
612
|
+
header: string;
|
|
613
|
+
}
|
|
614
|
+
interface MethodMetadataNonNullableFields {
|
|
615
|
+
artifact: string;
|
|
616
|
+
service: string;
|
|
617
|
+
method: string;
|
|
618
|
+
}
|
|
619
|
+
interface MethodSpecNonNullableFields {
|
|
620
|
+
requestQueryFieldNumber: QueryFieldNumber;
|
|
621
|
+
}
|
|
622
|
+
interface ApplicationErrorNonNullableFields {
|
|
623
|
+
code: string;
|
|
624
|
+
description: string;
|
|
625
|
+
}
|
|
626
|
+
interface FieldViolationNonNullableFields {
|
|
627
|
+
field: string;
|
|
628
|
+
description: string;
|
|
629
|
+
violatedRule: RuleType;
|
|
630
|
+
}
|
|
631
|
+
interface ValidationErrorNonNullableFields {
|
|
632
|
+
fieldViolations: FieldViolationNonNullableFields[];
|
|
633
|
+
}
|
|
634
|
+
interface DetailsNonNullableFields {
|
|
635
|
+
applicationError?: ApplicationErrorNonNullableFields;
|
|
636
|
+
validationError?: ValidationErrorNonNullableFields;
|
|
637
|
+
}
|
|
638
|
+
interface ExportAsyncJobDataNonNullableFields {
|
|
639
|
+
query?: ExportQueryV2NonNullableFields;
|
|
640
|
+
fields: FieldDescriptorNonNullableFields[];
|
|
641
|
+
arrayFieldDelimiter: ArrayFieldDelimiter;
|
|
642
|
+
methodMetadata?: MethodMetadataNonNullableFields;
|
|
643
|
+
methodSpec?: MethodSpecNonNullableFields;
|
|
644
|
+
userId: string;
|
|
645
|
+
format: string;
|
|
646
|
+
uploadId: string;
|
|
647
|
+
iterationsCount: number;
|
|
648
|
+
processedItemsCount: number;
|
|
649
|
+
resetCount: number;
|
|
650
|
+
signedUrl: string;
|
|
651
|
+
error?: DetailsNonNullableFields;
|
|
652
|
+
}
|
|
653
|
+
interface ExportAsyncJobNonNullableFields {
|
|
654
|
+
_id: string;
|
|
655
|
+
data?: ExportAsyncJobDataNonNullableFields;
|
|
656
|
+
status: Status;
|
|
657
|
+
}
|
|
658
|
+
interface CreateExportAsyncJobResponseNonNullableFields {
|
|
659
|
+
job?: ExportAsyncJobNonNullableFields;
|
|
660
|
+
}
|
|
661
|
+
interface GetExportAsyncJobResponseNonNullableFields {
|
|
662
|
+
job?: ExportAsyncJobNonNullableFields;
|
|
663
|
+
}
|
|
664
|
+
|
|
665
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
666
|
+
getUrl: (context: any) => string;
|
|
667
|
+
httpMethod: K;
|
|
668
|
+
path: string;
|
|
669
|
+
pathParams: M;
|
|
670
|
+
__requestType: T;
|
|
671
|
+
__originalRequestType: S;
|
|
672
|
+
__responseType: Q;
|
|
673
|
+
__originalResponseType: R;
|
|
674
|
+
};
|
|
675
|
+
declare function createExportAsyncJob(): __PublicMethodMetaInfo<'POST', {}, CreateExportAsyncJobRequest, CreateExportAsyncJobRequest$1, CreateExportAsyncJobResponse & CreateExportAsyncJobResponseNonNullableFields, CreateExportAsyncJobResponse$1 & CreateExportAsyncJobResponseNonNullableFields$1>;
|
|
676
|
+
declare function getExportAsyncJob(): __PublicMethodMetaInfo<'GET', {
|
|
677
|
+
jobId: string;
|
|
678
|
+
}, GetExportAsyncJobRequest, GetExportAsyncJobRequest$1, GetExportAsyncJobResponse & GetExportAsyncJobResponseNonNullableFields, GetExportAsyncJobResponse$1 & GetExportAsyncJobResponseNonNullableFields$1>;
|
|
679
|
+
|
|
680
|
+
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
681
|
+
declare const meta_createExportAsyncJob: typeof createExportAsyncJob;
|
|
682
|
+
declare const meta_getExportAsyncJob: typeof getExportAsyncJob;
|
|
683
|
+
declare namespace meta {
|
|
684
|
+
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createExportAsyncJob as createExportAsyncJob, meta_getExportAsyncJob as getExportAsyncJob };
|
|
685
|
+
}
|
|
686
|
+
|
|
687
|
+
export { meta as exportAsyncJob };
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * as exportAsyncJob from './src/fedinfra-exportservice-v1-export-async-job.universal';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6GAA6F"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
|
-
import { CancelExportAsyncJobRequest, CancelExportAsyncJobResponse, CreateExportAsyncJobRequest, CreateExportAsyncJobResponse, GetExportAsyncJobRequest, GetExportAsyncJobResponse, CreateExportAsyncJobResponseNonNullableFields, GetExportAsyncJobResponseNonNullableFields, CancelExportAsyncJobResponseNonNullableFields } from './fedinfra-exportservice-v1-export-async-job.types';
|
|
3
|
-
/** Creates a new Export */
|
|
4
|
-
export declare function createExportAsyncJob(payload: CreateExportAsyncJobRequest): RequestOptionsFactory<CreateExportAsyncJobResponse & CreateExportAsyncJobResponseNonNullableFields>;
|
|
5
|
-
/** Get a Export by id */
|
|
6
|
-
export declare function getExportAsyncJob(payload: GetExportAsyncJobRequest): RequestOptionsFactory<GetExportAsyncJobResponse & GetExportAsyncJobResponseNonNullableFields>;
|
|
7
|
-
export declare function cancelExportAsyncJob(payload: CancelExportAsyncJobRequest): RequestOptionsFactory<CancelExportAsyncJobResponse & CancelExportAsyncJobResponseNonNullableFields>;
|