@wix/auto_sdk_export-async-job_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/index.d.ts +30 -1
- package/build/cjs/index.js +365 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1118 -1
- package/build/cjs/index.typings.js +343 -15
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +319 -1
- package/build/cjs/meta.js +167 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +30 -0
- package/build/es/index.mjs +331 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.d.ts → es/index.typings.d.mts} +152 -165
- package/build/es/index.typings.mjs +309 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +319 -0
- package/build/es/meta.mjs +142 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +30 -1
- package/build/internal/cjs/index.js +365 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +1118 -1
- package/build/internal/cjs/index.typings.js +343 -15
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +319 -1
- package/build/internal/cjs/meta.js +167 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +30 -0
- package/build/internal/es/index.mjs +331 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.d.ts → internal/es/index.typings.d.mts} +152 -165
- package/build/internal/es/index.typings.mjs +309 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +319 -0
- package/build/internal/es/meta.mjs +142 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +12 -10
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.d.ts +0 -6
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.js +0 -21
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.d.ts +0 -5
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.js +0 -102
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.d.ts +0 -16
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.js +0 -66
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.d.ts +0 -23
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.js +0 -31
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.d.ts +0 -1132
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.js +0 -146
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.js.map +0 -1
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.js +0 -254
- package/build/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.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/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.d.ts +0 -6
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.js +0 -6
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.d.ts +0 -5
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.js +0 -97
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.d.ts +0 -16
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.js +0 -38
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.d.ts +0 -23
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.js +0 -14
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.d.ts +0 -1132
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.js +0 -143
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.js.map +0 -1
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.d.ts +0 -1131
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.js +0 -226
- package/build/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.js.map +0 -1
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.d.ts +0 -6
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.js +0 -21
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.js.map +0 -1
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.d.ts +0 -5
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.js +0 -102
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.js.map +0 -1
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.d.ts +0 -16
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.js +0 -66
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.js.map +0 -1
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.d.ts +0 -23
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.js +0 -31
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.js.map +0 -1
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.d.ts +0 -1132
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.js +0 -146
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.js.map +0 -1
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.js +0 -254
- package/build/internal/cjs/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.d.ts +0 -6
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.js +0 -6
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.context.js.map +0 -1
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.d.ts +0 -5
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.js +0 -97
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.http.js.map +0 -1
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.d.ts +0 -16
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.js +0 -38
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.meta.js.map +0 -1
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.d.ts +0 -23
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.js +0 -14
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.public.js.map +0 -1
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.d.ts +0 -1132
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.js +0 -143
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.types.js.map +0 -1
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.d.ts +0 -1131
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.js +0 -226
- package/build/internal/es/src/fedinfra-exportservice-v1-export-async-job-export-async-job.universal.js.map +0 -1
|
@@ -1,22 +1,24 @@
|
|
|
1
|
-
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
3
|
+
interface ExportAsyncJob {
|
|
2
4
|
/**
|
|
3
5
|
* @format GUID
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
_id?: string;
|
|
7
9
|
data?: ExportAsyncJobData;
|
|
8
|
-
status?:
|
|
10
|
+
status?: StatusWithLiterals;
|
|
9
11
|
/** @readonly */
|
|
10
12
|
createDate?: Date | null;
|
|
11
13
|
/** @readonly */
|
|
12
14
|
updateDate?: Date | null;
|
|
13
15
|
}
|
|
14
|
-
|
|
16
|
+
interface ExportAsyncJobData {
|
|
15
17
|
/** original request data for the export */
|
|
16
18
|
query?: ExportQueryV2;
|
|
17
19
|
/** translated CSV headers */
|
|
18
20
|
fields?: FieldDescriptor[];
|
|
19
|
-
arrayFieldDelimiter?:
|
|
21
|
+
arrayFieldDelimiter?: ArrayFieldDelimiterWithLiterals;
|
|
20
22
|
/** The target method to query data from */
|
|
21
23
|
methodMetadata?: MethodMetadata;
|
|
22
24
|
/** Custom spec for the target method's request/response */
|
|
@@ -40,7 +42,7 @@ export interface ExportAsyncJobData {
|
|
|
40
42
|
error?: Details;
|
|
41
43
|
testParams?: Record<string, any> | null;
|
|
42
44
|
}
|
|
43
|
-
|
|
45
|
+
interface ExportQueryV2 extends ExportQueryV2PagingMethodOneOf {
|
|
44
46
|
/** Paging options to limit and skip the number of items. */
|
|
45
47
|
paging?: Paging;
|
|
46
48
|
/** 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`. */
|
|
@@ -65,57 +67,61 @@ export interface ExportQueryV2 extends ExportQueryV2PagingMethodOneOf {
|
|
|
65
67
|
fieldsets?: string[];
|
|
66
68
|
}
|
|
67
69
|
/** @oneof */
|
|
68
|
-
|
|
70
|
+
interface ExportQueryV2PagingMethodOneOf {
|
|
69
71
|
/** Paging options to limit and skip the number of items. */
|
|
70
72
|
paging?: Paging;
|
|
71
73
|
/** 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`. */
|
|
72
74
|
cursorPaging?: ExportCursorPaging;
|
|
73
75
|
}
|
|
74
|
-
|
|
76
|
+
interface Sorting {
|
|
75
77
|
/**
|
|
76
78
|
* Name of the field to sort by.
|
|
77
79
|
* @maxLength 512
|
|
78
80
|
*/
|
|
79
81
|
fieldName?: string;
|
|
80
82
|
/** Sort order. */
|
|
81
|
-
order?:
|
|
83
|
+
order?: SortOrderWithLiterals;
|
|
82
84
|
}
|
|
83
|
-
|
|
85
|
+
declare enum SortOrder {
|
|
84
86
|
ASC = "ASC",
|
|
85
87
|
DESC = "DESC"
|
|
86
88
|
}
|
|
87
|
-
|
|
89
|
+
/** @enumType */
|
|
90
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
91
|
+
interface Paging {
|
|
88
92
|
/** Number of items to load. */
|
|
89
93
|
limit?: number | null;
|
|
90
94
|
/** Number of items to skip in the current sort order. */
|
|
91
95
|
offset?: number | null;
|
|
92
96
|
}
|
|
93
|
-
|
|
97
|
+
interface ExportCursorPaging {
|
|
94
98
|
/** @max 10000 */
|
|
95
99
|
limit?: number | null;
|
|
96
100
|
cursor?: string | null;
|
|
97
101
|
}
|
|
98
|
-
|
|
102
|
+
interface FieldDescriptor {
|
|
99
103
|
/** the path to the field out of the query response items */
|
|
100
104
|
_id?: string;
|
|
101
105
|
/** how to present the filed in the CSV headers (translated) */
|
|
102
106
|
header?: string;
|
|
103
107
|
}
|
|
104
|
-
|
|
108
|
+
declare enum ArrayFieldDelimiter {
|
|
105
109
|
SEMICOLON = "SEMICOLON",
|
|
106
110
|
SEMICOLON_AND_SPACE = "SEMICOLON_AND_SPACE"
|
|
107
111
|
}
|
|
108
|
-
|
|
112
|
+
/** @enumType */
|
|
113
|
+
type ArrayFieldDelimiterWithLiterals = ArrayFieldDelimiter | 'SEMICOLON' | 'SEMICOLON_AND_SPACE';
|
|
114
|
+
interface MethodMetadata {
|
|
109
115
|
artifact?: string;
|
|
110
116
|
service?: string;
|
|
111
117
|
method?: string;
|
|
112
118
|
}
|
|
113
|
-
|
|
114
|
-
requestQueryFieldNumber?:
|
|
119
|
+
interface MethodSpec {
|
|
120
|
+
requestQueryFieldNumber?: QueryFieldNumberWithLiterals;
|
|
115
121
|
responseRepeatedFieldName?: string | null;
|
|
116
122
|
responsePagingMetadataFieldName?: string | null;
|
|
117
123
|
}
|
|
118
|
-
|
|
124
|
+
declare enum QueryFieldNumber {
|
|
119
125
|
/** message QuerySomethingRequest { .wix.common.QueryV2 query = 1; } */
|
|
120
126
|
DEFAULT = "DEFAULT",
|
|
121
127
|
FIELD_2 = "FIELD_2",
|
|
@@ -128,7 +134,9 @@ export declare enum QueryFieldNumber {
|
|
|
128
134
|
FIELD_8 = "FIELD_8",
|
|
129
135
|
FIELD_9 = "FIELD_9"
|
|
130
136
|
}
|
|
131
|
-
|
|
137
|
+
/** @enumType */
|
|
138
|
+
type QueryFieldNumberWithLiterals = QueryFieldNumber | 'DEFAULT' | 'FIELD_2' | 'FIELD_3' | 'FIELD_4' | 'FIELD_5' | 'FIELD_6' | 'FIELD_7' | 'FIELD_8' | 'FIELD_9';
|
|
139
|
+
interface PagingMetadataV2 {
|
|
132
140
|
/** Number of items returned in the response. */
|
|
133
141
|
count?: number | null;
|
|
134
142
|
/** Offset that was requested. */
|
|
@@ -140,7 +148,7 @@ export interface PagingMetadataV2 {
|
|
|
140
148
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
141
149
|
cursors?: Cursors;
|
|
142
150
|
}
|
|
143
|
-
|
|
151
|
+
interface Cursors {
|
|
144
152
|
/**
|
|
145
153
|
* Cursor string pointing to the next page in the list of results.
|
|
146
154
|
* @maxLength 16000
|
|
@@ -152,7 +160,7 @@ export interface Cursors {
|
|
|
152
160
|
*/
|
|
153
161
|
prev?: string | null;
|
|
154
162
|
}
|
|
155
|
-
|
|
163
|
+
interface Details extends DetailsKindOneOf {
|
|
156
164
|
applicationError?: ApplicationError;
|
|
157
165
|
validationError?: ValidationError;
|
|
158
166
|
systemError?: SystemError;
|
|
@@ -163,12 +171,12 @@ export interface Details extends DetailsKindOneOf {
|
|
|
163
171
|
tracing?: Record<string, string>;
|
|
164
172
|
}
|
|
165
173
|
/** @oneof */
|
|
166
|
-
|
|
174
|
+
interface DetailsKindOneOf {
|
|
167
175
|
applicationError?: ApplicationError;
|
|
168
176
|
validationError?: ValidationError;
|
|
169
177
|
systemError?: SystemError;
|
|
170
178
|
}
|
|
171
|
-
|
|
179
|
+
interface ApplicationError {
|
|
172
180
|
/** Error code. */
|
|
173
181
|
code?: string;
|
|
174
182
|
/** Description of the error. */
|
|
@@ -208,10 +216,10 @@ export interface ApplicationError {
|
|
|
208
216
|
* ]
|
|
209
217
|
* }
|
|
210
218
|
*/
|
|
211
|
-
|
|
219
|
+
interface ValidationError {
|
|
212
220
|
fieldViolations?: FieldViolation[];
|
|
213
221
|
}
|
|
214
|
-
|
|
222
|
+
declare enum RuleType {
|
|
215
223
|
VALIDATION = "VALIDATION",
|
|
216
224
|
OTHER = "OTHER",
|
|
217
225
|
MAX = "MAX",
|
|
@@ -234,19 +242,21 @@ export declare enum RuleType {
|
|
|
234
242
|
EXACT_SIZE = "EXACT_SIZE",
|
|
235
243
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
236
244
|
}
|
|
237
|
-
|
|
245
|
+
/** @enumType */
|
|
246
|
+
type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
|
|
247
|
+
interface FieldViolation {
|
|
238
248
|
field?: string;
|
|
239
249
|
description?: string;
|
|
240
|
-
violatedRule?:
|
|
250
|
+
violatedRule?: RuleTypeWithLiterals;
|
|
241
251
|
/** applicable when violated_rule=OTHER */
|
|
242
252
|
ruleName?: string | null;
|
|
243
253
|
data?: Record<string, any> | null;
|
|
244
254
|
}
|
|
245
|
-
|
|
255
|
+
interface SystemError {
|
|
246
256
|
/** Error code. */
|
|
247
257
|
errorCode?: string | null;
|
|
248
258
|
}
|
|
249
|
-
|
|
259
|
+
declare enum Status {
|
|
250
260
|
UNKNOWN = "UNKNOWN",
|
|
251
261
|
/** Job is created, but hasn't started yet. */
|
|
252
262
|
INITIALIZED = "INITIALIZED",
|
|
@@ -257,12 +267,14 @@ export declare enum Status {
|
|
|
257
267
|
/** Job has failed. */
|
|
258
268
|
FAILED = "FAILED"
|
|
259
269
|
}
|
|
260
|
-
|
|
270
|
+
/** @enumType */
|
|
271
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'INITIALIZED' | 'PROCESSING' | 'FINISHED' | 'FAILED';
|
|
272
|
+
interface CreateExportAsyncJobRequest {
|
|
261
273
|
/** WQL expression */
|
|
262
274
|
query: ExportQueryV2;
|
|
263
275
|
/** translated CSV headers */
|
|
264
276
|
fields: FieldDescriptor[];
|
|
265
|
-
arrayFieldDelimiter?:
|
|
277
|
+
arrayFieldDelimiter?: ArrayFieldDelimiterWithLiterals;
|
|
266
278
|
/** The target method to query data from */
|
|
267
279
|
methodMetadata: MethodMetadata;
|
|
268
280
|
/** The target method to query data from */
|
|
@@ -272,57 +284,57 @@ export interface CreateExportAsyncJobRequest {
|
|
|
272
284
|
/** Test params */
|
|
273
285
|
testParams?: Record<string, any> | null;
|
|
274
286
|
}
|
|
275
|
-
|
|
287
|
+
interface CreateExportAsyncJobResponse {
|
|
276
288
|
/** The retrieved Exports */
|
|
277
289
|
job?: ExportAsyncJob;
|
|
278
290
|
}
|
|
279
|
-
|
|
291
|
+
interface GetExportAsyncJobRequest {
|
|
280
292
|
/**
|
|
281
293
|
* Id of the Export to retrieve
|
|
282
294
|
* @format GUID
|
|
283
295
|
*/
|
|
284
296
|
jobId: string;
|
|
285
297
|
}
|
|
286
|
-
|
|
298
|
+
interface GetExportAsyncJobResponse {
|
|
287
299
|
/** The retrieved ExportAsyncJob */
|
|
288
300
|
job?: ExportAsyncJob;
|
|
289
301
|
}
|
|
290
|
-
|
|
302
|
+
interface CancelExportAsyncJobRequest {
|
|
291
303
|
/**
|
|
292
304
|
* Id of the Export to retrieve
|
|
293
305
|
* @format GUID
|
|
294
306
|
*/
|
|
295
307
|
jobId?: string;
|
|
296
308
|
}
|
|
297
|
-
|
|
309
|
+
interface CancelExportAsyncJobResponse {
|
|
298
310
|
/** The retrieved ExportAsyncJob */
|
|
299
311
|
job?: ExportAsyncJob;
|
|
300
312
|
}
|
|
301
|
-
|
|
313
|
+
interface GenerateExportAsyncJobDownloadUrlRequest {
|
|
302
314
|
/**
|
|
303
315
|
* Id of the Export to retrieve
|
|
304
316
|
* @format GUID
|
|
305
317
|
*/
|
|
306
318
|
jobId?: string;
|
|
307
319
|
}
|
|
308
|
-
|
|
320
|
+
interface GenerateExportAsyncJobDownloadUrlResponse {
|
|
309
321
|
/** The retrieved ExportAsyncJob */
|
|
310
322
|
job?: ExportAsyncJob;
|
|
311
323
|
}
|
|
312
|
-
|
|
324
|
+
interface QueryRequestLoose {
|
|
313
325
|
/** WQL expression */
|
|
314
326
|
query?: ExportQueryV2;
|
|
315
327
|
}
|
|
316
|
-
|
|
328
|
+
interface QueryVariantsExportSpiResponse {
|
|
317
329
|
items?: ProductOrVariant[];
|
|
318
330
|
pagingMetadata?: PagingMetadataV2;
|
|
319
331
|
}
|
|
320
|
-
|
|
332
|
+
interface ProductOrVariant {
|
|
321
333
|
kind?: string;
|
|
322
334
|
product?: Product;
|
|
323
335
|
variant?: StoreVariant;
|
|
324
336
|
}
|
|
325
|
-
|
|
337
|
+
interface Product {
|
|
326
338
|
/**
|
|
327
339
|
* Product ID (generated automatically by the catalog).
|
|
328
340
|
* @readonly
|
|
@@ -345,7 +357,7 @@ export interface Product {
|
|
|
345
357
|
/** Whether the product is visible to site visitors. */
|
|
346
358
|
visible?: boolean | null;
|
|
347
359
|
/** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
|
|
348
|
-
productType?:
|
|
360
|
+
productType?: ProductTypeWithLiterals;
|
|
349
361
|
/**
|
|
350
362
|
* Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text).
|
|
351
363
|
* @maxLength 8000
|
|
@@ -447,7 +459,7 @@ export interface Product {
|
|
|
447
459
|
*/
|
|
448
460
|
collectionIds?: string[];
|
|
449
461
|
/**
|
|
450
|
-
* Product variants, will be provided if the
|
|
462
|
+
* Product variants, will be provided if the request was sent with the `includeVariants: true`.
|
|
451
463
|
*
|
|
452
464
|
* Max: 1,000 variants
|
|
453
465
|
* @readonly
|
|
@@ -478,18 +490,20 @@ export interface Product {
|
|
|
478
490
|
*/
|
|
479
491
|
brand?: string | null;
|
|
480
492
|
}
|
|
481
|
-
|
|
493
|
+
declare enum ProductType {
|
|
482
494
|
unspecified_product_type = "unspecified_product_type",
|
|
483
495
|
physical = "physical",
|
|
484
496
|
digital = "digital"
|
|
485
497
|
}
|
|
486
|
-
|
|
498
|
+
/** @enumType */
|
|
499
|
+
type ProductTypeWithLiterals = ProductType | 'unspecified_product_type' | 'physical' | 'digital';
|
|
500
|
+
interface NumericPropertyRange {
|
|
487
501
|
/** Minimum value. */
|
|
488
502
|
minValue?: number;
|
|
489
503
|
/** Maximum value. */
|
|
490
504
|
maxValue?: number;
|
|
491
505
|
}
|
|
492
|
-
|
|
506
|
+
interface Stock {
|
|
493
507
|
/** Whether inventory is being tracked */
|
|
494
508
|
trackInventory?: boolean;
|
|
495
509
|
/**
|
|
@@ -509,9 +523,9 @@ export interface Stock {
|
|
|
509
523
|
* + `OUT_OF_STOCK` - Not in stock
|
|
510
524
|
* + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock
|
|
511
525
|
*/
|
|
512
|
-
inventoryStatus?:
|
|
526
|
+
inventoryStatus?: InventoryStatusWithLiterals;
|
|
513
527
|
}
|
|
514
|
-
|
|
528
|
+
declare enum InventoryStatus {
|
|
515
529
|
/** In stock */
|
|
516
530
|
IN_STOCK = "IN_STOCK",
|
|
517
531
|
/** Not in stock */
|
|
@@ -519,7 +533,9 @@ export declare enum InventoryStatus {
|
|
|
519
533
|
/** Some of the variants are not in stock */
|
|
520
534
|
PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
|
|
521
535
|
}
|
|
522
|
-
|
|
536
|
+
/** @enumType */
|
|
537
|
+
type InventoryStatusWithLiterals = InventoryStatus | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
|
|
538
|
+
interface PriceData {
|
|
523
539
|
/**
|
|
524
540
|
* Product price currency
|
|
525
541
|
* @readonly
|
|
@@ -546,7 +562,7 @@ export interface PriceData {
|
|
|
546
562
|
*/
|
|
547
563
|
pricePerUnit?: number | null;
|
|
548
564
|
}
|
|
549
|
-
|
|
565
|
+
interface FormattedPrice {
|
|
550
566
|
/** Product price formatted with the currency */
|
|
551
567
|
price?: string;
|
|
552
568
|
/** Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned) */
|
|
@@ -557,7 +573,7 @@ export interface FormattedPrice {
|
|
|
557
573
|
*/
|
|
558
574
|
pricePerUnit?: string | null;
|
|
559
575
|
}
|
|
560
|
-
|
|
576
|
+
interface CostAndProfitData {
|
|
561
577
|
/**
|
|
562
578
|
* Item cost.
|
|
563
579
|
* @max 999999999.99
|
|
@@ -587,7 +603,7 @@ export interface CostAndProfitData {
|
|
|
587
603
|
*/
|
|
588
604
|
profitMargin?: number;
|
|
589
605
|
}
|
|
590
|
-
|
|
606
|
+
interface PricePerUnitData {
|
|
591
607
|
/**
|
|
592
608
|
* Total quantity
|
|
593
609
|
* @min 0.01
|
|
@@ -595,7 +611,7 @@ export interface PricePerUnitData {
|
|
|
595
611
|
*/
|
|
596
612
|
totalQuantity?: number;
|
|
597
613
|
/** Total measurement unit */
|
|
598
|
-
totalMeasurementUnit?:
|
|
614
|
+
totalMeasurementUnit?: MeasurementUnitWithLiterals;
|
|
599
615
|
/**
|
|
600
616
|
* Base quantity
|
|
601
617
|
* @min 0.01
|
|
@@ -603,9 +619,9 @@ export interface PricePerUnitData {
|
|
|
603
619
|
*/
|
|
604
620
|
baseQuantity?: number;
|
|
605
621
|
/** Base measurement unit */
|
|
606
|
-
baseMeasurementUnit?:
|
|
622
|
+
baseMeasurementUnit?: MeasurementUnitWithLiterals;
|
|
607
623
|
}
|
|
608
|
-
|
|
624
|
+
declare enum MeasurementUnit {
|
|
609
625
|
UNSPECIFIED = "UNSPECIFIED",
|
|
610
626
|
ML = "ML",
|
|
611
627
|
CL = "CL",
|
|
@@ -629,7 +645,9 @@ export declare enum MeasurementUnit {
|
|
|
629
645
|
YD = "YD",
|
|
630
646
|
SQFT = "SQFT"
|
|
631
647
|
}
|
|
632
|
-
|
|
648
|
+
/** @enumType */
|
|
649
|
+
type MeasurementUnitWithLiterals = MeasurementUnit | 'UNSPECIFIED' | 'ML' | 'CL' | 'L' | 'CBM' | 'MG' | 'G' | 'KG' | 'MM' | 'CM' | 'M' | 'SQM' | 'OZ' | 'LB' | 'FLOZ' | 'PT' | 'QT' | 'GAL' | 'IN' | 'FT' | 'YD' | 'SQFT';
|
|
650
|
+
interface AdditionalInfoSection {
|
|
633
651
|
/**
|
|
634
652
|
* Product info section title
|
|
635
653
|
* @maxLength 50
|
|
@@ -641,20 +659,20 @@ export interface AdditionalInfoSection {
|
|
|
641
659
|
*/
|
|
642
660
|
description?: string;
|
|
643
661
|
}
|
|
644
|
-
|
|
662
|
+
interface Ribbon {
|
|
645
663
|
/**
|
|
646
664
|
* Ribbon text
|
|
647
665
|
* @maxLength 30
|
|
648
666
|
*/
|
|
649
667
|
text?: string;
|
|
650
668
|
}
|
|
651
|
-
|
|
669
|
+
interface Media {
|
|
652
670
|
/** Primary media (image, video etc) associated with this product. */
|
|
653
671
|
mainMedia?: MediaItem;
|
|
654
672
|
/** Media (images, videos etc) associated with this product. */
|
|
655
673
|
items?: MediaItem[];
|
|
656
674
|
}
|
|
657
|
-
|
|
675
|
+
interface MediaItem extends MediaItemItemOneOf {
|
|
658
676
|
/** Image data (URL, size). */
|
|
659
677
|
image?: MediaItemUrlAndSize;
|
|
660
678
|
/** Video data (URL, size). */
|
|
@@ -662,20 +680,20 @@ export interface MediaItem extends MediaItemItemOneOf {
|
|
|
662
680
|
/** Media item thumbnail details. */
|
|
663
681
|
thumbnail?: MediaItemUrlAndSize;
|
|
664
682
|
/** Media item type (image, video, etc.). */
|
|
665
|
-
mediaType?:
|
|
683
|
+
mediaType?: MediaItemTypeWithLiterals;
|
|
666
684
|
/** Media item title. */
|
|
667
685
|
title?: string;
|
|
668
686
|
/** Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). */
|
|
669
687
|
_id?: string;
|
|
670
688
|
}
|
|
671
689
|
/** @oneof */
|
|
672
|
-
|
|
690
|
+
interface MediaItemItemOneOf {
|
|
673
691
|
/** Image data (URL, size). */
|
|
674
692
|
image?: MediaItemUrlAndSize;
|
|
675
693
|
/** Video data (URL, size). */
|
|
676
694
|
video?: MediaItemVideo;
|
|
677
695
|
}
|
|
678
|
-
|
|
696
|
+
interface MediaItemUrlAndSize {
|
|
679
697
|
/**
|
|
680
698
|
* Media item URL.
|
|
681
699
|
* @format WEB_URL
|
|
@@ -690,7 +708,7 @@ export interface MediaItemUrlAndSize {
|
|
|
690
708
|
/** Alt text. This text will be shown in case the image is not available. */
|
|
691
709
|
altText?: string | null;
|
|
692
710
|
}
|
|
693
|
-
|
|
711
|
+
declare enum MediaItemType {
|
|
694
712
|
unspecified_media_item_type = "unspecified_media_item_type",
|
|
695
713
|
/** Image media type. */
|
|
696
714
|
image = "image",
|
|
@@ -703,13 +721,15 @@ export declare enum MediaItemType {
|
|
|
703
721
|
/** Zip media type. */
|
|
704
722
|
zip = "zip"
|
|
705
723
|
}
|
|
706
|
-
|
|
724
|
+
/** @enumType */
|
|
725
|
+
type MediaItemTypeWithLiterals = MediaItemType | 'unspecified_media_item_type' | 'image' | 'video' | 'audio' | 'document' | 'zip';
|
|
726
|
+
interface MediaItemVideo {
|
|
707
727
|
/** Data (URL, size) about each resolution for which this video is available. */
|
|
708
728
|
files?: MediaItemUrlAndSize[];
|
|
709
729
|
/** ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. */
|
|
710
730
|
stillFrameMediaId?: string;
|
|
711
731
|
}
|
|
712
|
-
|
|
732
|
+
interface CustomTextField {
|
|
713
733
|
/**
|
|
714
734
|
* Text box title
|
|
715
735
|
* @maxLength 100
|
|
@@ -723,12 +743,12 @@ export interface CustomTextField {
|
|
|
723
743
|
/** Whether this text box is mandatory */
|
|
724
744
|
mandatory?: boolean;
|
|
725
745
|
}
|
|
726
|
-
|
|
746
|
+
interface ProductOption {
|
|
727
747
|
/**
|
|
728
748
|
* Option type.
|
|
729
749
|
* @readonly
|
|
730
750
|
*/
|
|
731
|
-
optionType?:
|
|
751
|
+
optionType?: OptionTypeWithLiterals;
|
|
732
752
|
/**
|
|
733
753
|
* Option name.
|
|
734
754
|
* @minLength 1
|
|
@@ -742,7 +762,7 @@ export interface ProductOption {
|
|
|
742
762
|
*/
|
|
743
763
|
choices?: Choice[];
|
|
744
764
|
}
|
|
745
|
-
|
|
765
|
+
declare enum OptionType {
|
|
746
766
|
/** Unspecified option type. */
|
|
747
767
|
unspecified_option_type = "unspecified_option_type",
|
|
748
768
|
/** Drop down. */
|
|
@@ -750,7 +770,9 @@ export declare enum OptionType {
|
|
|
750
770
|
/** Color. */
|
|
751
771
|
color = "color"
|
|
752
772
|
}
|
|
753
|
-
|
|
773
|
+
/** @enumType */
|
|
774
|
+
type OptionTypeWithLiterals = OptionType | 'unspecified_option_type' | 'drop_down' | 'color';
|
|
775
|
+
interface Choice {
|
|
754
776
|
/**
|
|
755
777
|
* Choice value.
|
|
756
778
|
* @minLength 1
|
|
@@ -779,23 +801,23 @@ export interface Choice {
|
|
|
779
801
|
*/
|
|
780
802
|
visible?: boolean;
|
|
781
803
|
}
|
|
782
|
-
|
|
804
|
+
interface PageUrl {
|
|
783
805
|
/** Base URL. For premium sites, this is the domain. For free sites, this is the site URL (e.g mysite.wixsite.com/mysite). */
|
|
784
806
|
base?: string;
|
|
785
807
|
/** Path to the product page - e.g /product-page/a-product. */
|
|
786
808
|
path?: string;
|
|
787
809
|
}
|
|
788
|
-
|
|
810
|
+
interface Discount {
|
|
789
811
|
/**
|
|
790
812
|
* Discount type:
|
|
791
813
|
* + `"AMOUNT"`
|
|
792
814
|
* + `"PERCENT"`
|
|
793
815
|
*/
|
|
794
|
-
type?:
|
|
816
|
+
type?: DiscountTypeWithLiterals;
|
|
795
817
|
/** Discount value */
|
|
796
818
|
value?: number;
|
|
797
819
|
}
|
|
798
|
-
|
|
820
|
+
declare enum DiscountType {
|
|
799
821
|
UNDEFINED = "UNDEFINED",
|
|
800
822
|
/** No discount */
|
|
801
823
|
NONE = "NONE",
|
|
@@ -804,7 +826,9 @@ export declare enum DiscountType {
|
|
|
804
826
|
/** Discount by a percentage */
|
|
805
827
|
PERCENT = "PERCENT"
|
|
806
828
|
}
|
|
807
|
-
|
|
829
|
+
/** @enumType */
|
|
830
|
+
type DiscountTypeWithLiterals = DiscountType | 'UNDEFINED' | 'NONE' | 'AMOUNT' | 'PERCENT';
|
|
831
|
+
interface Variant {
|
|
808
832
|
/**
|
|
809
833
|
* Requested Variant ID
|
|
810
834
|
* @format GUID
|
|
@@ -819,7 +843,7 @@ export interface Variant {
|
|
|
819
843
|
*/
|
|
820
844
|
stock?: VariantStock;
|
|
821
845
|
}
|
|
822
|
-
|
|
846
|
+
interface VariantDataWithNoStock {
|
|
823
847
|
/** Variant price. */
|
|
824
848
|
priceData?: PriceData;
|
|
825
849
|
/**
|
|
@@ -836,7 +860,7 @@ export interface VariantDataWithNoStock {
|
|
|
836
860
|
/** Whether the variant is visible to customers. */
|
|
837
861
|
visible?: boolean;
|
|
838
862
|
}
|
|
839
|
-
|
|
863
|
+
interface VariantStock {
|
|
840
864
|
/** Whether inventory is being tracked. */
|
|
841
865
|
trackQuantity?: boolean;
|
|
842
866
|
/**
|
|
@@ -852,13 +876,13 @@ export interface VariantStock {
|
|
|
852
876
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
853
877
|
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
854
878
|
*/
|
|
855
|
-
|
|
879
|
+
interface SeoSchema {
|
|
856
880
|
/** SEO tag information. */
|
|
857
881
|
tags?: Tag[];
|
|
858
882
|
/** SEO general settings. */
|
|
859
883
|
settings?: Settings;
|
|
860
884
|
}
|
|
861
|
-
|
|
885
|
+
interface Keyword {
|
|
862
886
|
/** Keyword value. */
|
|
863
887
|
term?: string;
|
|
864
888
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -869,7 +893,7 @@ export interface Keyword {
|
|
|
869
893
|
*/
|
|
870
894
|
origin?: string | null;
|
|
871
895
|
}
|
|
872
|
-
|
|
896
|
+
interface Tag {
|
|
873
897
|
/**
|
|
874
898
|
* SEO tag type.
|
|
875
899
|
*
|
|
@@ -882,21 +906,21 @@ export interface Tag {
|
|
|
882
906
|
* For example: `{"name": "description", "content": "the description itself"}`.
|
|
883
907
|
*/
|
|
884
908
|
props?: Record<string, any> | null;
|
|
885
|
-
/** SEO tag
|
|
909
|
+
/** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
|
|
886
910
|
meta?: Record<string, any> | null;
|
|
887
911
|
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
888
912
|
children?: string;
|
|
889
|
-
/** Whether the tag is a custom tag. */
|
|
913
|
+
/** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
|
|
890
914
|
custom?: boolean;
|
|
891
|
-
/** Whether the tag is disabled. */
|
|
915
|
+
/** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
|
|
892
916
|
disabled?: boolean;
|
|
893
917
|
}
|
|
894
|
-
|
|
918
|
+
interface Settings {
|
|
895
919
|
/**
|
|
896
|
-
* Whether the
|
|
920
|
+
* Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
|
|
897
921
|
*
|
|
898
922
|
*
|
|
899
|
-
* Default: `false` (
|
|
923
|
+
* Default: `false` (automatical redirect is enabled).
|
|
900
924
|
*/
|
|
901
925
|
preventAutoRedirect?: boolean;
|
|
902
926
|
/**
|
|
@@ -905,7 +929,7 @@ export interface Settings {
|
|
|
905
929
|
*/
|
|
906
930
|
keywords?: Keyword[];
|
|
907
931
|
}
|
|
908
|
-
|
|
932
|
+
interface SecuredMedia {
|
|
909
933
|
/**
|
|
910
934
|
* Media ID in Wix Media Manager.
|
|
911
935
|
* @minLength 1
|
|
@@ -919,9 +943,9 @@ export interface SecuredMedia {
|
|
|
919
943
|
*/
|
|
920
944
|
fileName?: string;
|
|
921
945
|
/** File type. */
|
|
922
|
-
fileType?:
|
|
946
|
+
fileType?: FileTypeWithLiterals;
|
|
923
947
|
}
|
|
924
|
-
|
|
948
|
+
declare enum FileType {
|
|
925
949
|
UNSPECIFIED = "UNSPECIFIED",
|
|
926
950
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
927
951
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -929,7 +953,9 @@ export declare enum FileType {
|
|
|
929
953
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
930
954
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
931
955
|
}
|
|
932
|
-
|
|
956
|
+
/** @enumType */
|
|
957
|
+
type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
958
|
+
interface StoreVariant {
|
|
933
959
|
/** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen: {productId}.{variantId}. */
|
|
934
960
|
_id?: string;
|
|
935
961
|
/**
|
|
@@ -975,16 +1001,16 @@ export interface StoreVariant {
|
|
|
975
1001
|
/** Preorder information. */
|
|
976
1002
|
preorderInfo?: PreorderInfo;
|
|
977
1003
|
}
|
|
978
|
-
|
|
1004
|
+
interface PlatformMedia extends PlatformMediaMediaOneOf {
|
|
979
1005
|
image?: string;
|
|
980
1006
|
video?: string;
|
|
981
1007
|
}
|
|
982
1008
|
/** @oneof */
|
|
983
|
-
|
|
1009
|
+
interface PlatformMediaMediaOneOf {
|
|
984
1010
|
image?: string;
|
|
985
1011
|
video?: string;
|
|
986
1012
|
}
|
|
987
|
-
|
|
1013
|
+
interface FocalPoint {
|
|
988
1014
|
/** X-coordinate of the focal point. */
|
|
989
1015
|
x?: number;
|
|
990
1016
|
/** Y-coordinate of the focal point. */
|
|
@@ -994,7 +1020,7 @@ export interface FocalPoint {
|
|
|
994
1020
|
/** crop by width */
|
|
995
1021
|
width?: number | null;
|
|
996
1022
|
}
|
|
997
|
-
|
|
1023
|
+
interface VideoResolution {
|
|
998
1024
|
/** Video URL. */
|
|
999
1025
|
url?: string;
|
|
1000
1026
|
/** Video height. */
|
|
@@ -1004,7 +1030,7 @@ export interface VideoResolution {
|
|
|
1004
1030
|
/** Video format for example, mp4, hls. */
|
|
1005
1031
|
format?: string;
|
|
1006
1032
|
}
|
|
1007
|
-
|
|
1033
|
+
interface PreorderInfo {
|
|
1008
1034
|
/** Whether the item is available for preorder. */
|
|
1009
1035
|
enabled?: boolean;
|
|
1010
1036
|
/**
|
|
@@ -1019,78 +1045,35 @@ export interface PreorderInfo {
|
|
|
1019
1045
|
*/
|
|
1020
1046
|
limit?: number | null;
|
|
1021
1047
|
}
|
|
1022
|
-
|
|
1048
|
+
interface QueryProductsExportSpiResponse {
|
|
1023
1049
|
items?: ProductOrVariantV2[];
|
|
1024
1050
|
pagingMetadata?: PagingMetadataV2;
|
|
1025
1051
|
}
|
|
1026
|
-
|
|
1052
|
+
interface ProductOrVariantV2 {
|
|
1027
1053
|
kind?: string;
|
|
1028
1054
|
product?: Product;
|
|
1029
1055
|
variant?: Variant;
|
|
1030
1056
|
}
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
}
|
|
1052
|
-
interface ApplicationErrorNonNullableFields {
|
|
1053
|
-
code: string;
|
|
1054
|
-
description: string;
|
|
1055
|
-
}
|
|
1056
|
-
interface FieldViolationNonNullableFields {
|
|
1057
|
-
field: string;
|
|
1058
|
-
description: string;
|
|
1059
|
-
violatedRule: RuleType;
|
|
1060
|
-
}
|
|
1061
|
-
interface ValidationErrorNonNullableFields {
|
|
1062
|
-
fieldViolations: FieldViolationNonNullableFields[];
|
|
1063
|
-
}
|
|
1064
|
-
interface DetailsNonNullableFields {
|
|
1065
|
-
applicationError?: ApplicationErrorNonNullableFields;
|
|
1066
|
-
validationError?: ValidationErrorNonNullableFields;
|
|
1067
|
-
}
|
|
1068
|
-
interface ExportAsyncJobDataNonNullableFields {
|
|
1069
|
-
query?: ExportQueryV2NonNullableFields;
|
|
1070
|
-
fields: FieldDescriptorNonNullableFields[];
|
|
1071
|
-
arrayFieldDelimiter: ArrayFieldDelimiter;
|
|
1072
|
-
methodMetadata?: MethodMetadataNonNullableFields;
|
|
1073
|
-
methodSpec?: MethodSpecNonNullableFields;
|
|
1074
|
-
userId: string;
|
|
1075
|
-
format: string;
|
|
1076
|
-
uploadId: string;
|
|
1077
|
-
iterationsCount: number;
|
|
1078
|
-
processedItemsCount: number;
|
|
1079
|
-
resetCount: number;
|
|
1080
|
-
signedUrl: string;
|
|
1081
|
-
error?: DetailsNonNullableFields;
|
|
1082
|
-
}
|
|
1083
|
-
export interface ExportAsyncJobNonNullableFields {
|
|
1084
|
-
_id: string;
|
|
1085
|
-
data?: ExportAsyncJobDataNonNullableFields;
|
|
1086
|
-
status: Status;
|
|
1087
|
-
}
|
|
1088
|
-
export interface CreateExportAsyncJobResponseNonNullableFields {
|
|
1089
|
-
job?: ExportAsyncJobNonNullableFields;
|
|
1090
|
-
}
|
|
1091
|
-
export interface GetExportAsyncJobResponseNonNullableFields {
|
|
1092
|
-
job?: ExportAsyncJobNonNullableFields;
|
|
1093
|
-
}
|
|
1057
|
+
/** @docsIgnore */
|
|
1058
|
+
type CreateExportAsyncJobApplicationErrors = {
|
|
1059
|
+
code?: 'method_endpoint_not_found';
|
|
1060
|
+
description?: string;
|
|
1061
|
+
data?: Record<string, any>;
|
|
1062
|
+
};
|
|
1063
|
+
/** @docsIgnore */
|
|
1064
|
+
type GetExportAsyncJobApplicationErrors = {
|
|
1065
|
+
code?: 'job_not_found';
|
|
1066
|
+
description?: string;
|
|
1067
|
+
data?: Record<string, any>;
|
|
1068
|
+
} | {
|
|
1069
|
+
code?: 'get_async_job_internal';
|
|
1070
|
+
description?: string;
|
|
1071
|
+
data?: Record<string, any>;
|
|
1072
|
+
} | {
|
|
1073
|
+
code?: 'method_endpoint_permission_denied';
|
|
1074
|
+
description?: string;
|
|
1075
|
+
data?: Record<string, any>;
|
|
1076
|
+
};
|
|
1094
1077
|
/**
|
|
1095
1078
|
* Creates a new Export
|
|
1096
1079
|
* @param query - WQL expression
|
|
@@ -1099,15 +1082,16 @@ export interface GetExportAsyncJobResponseNonNullableFields {
|
|
|
1099
1082
|
* @requiredField options.fields
|
|
1100
1083
|
* @requiredField options.methodMetadata
|
|
1101
1084
|
* @requiredField query
|
|
1102
|
-
* @requiredField query.pagingMethod
|
|
1103
1085
|
* @permissionId EXPORT_ASYNC_JOB.CREATE
|
|
1104
1086
|
* @fqn wix.fedinfra.exportservice.v1.ExportService.CreateExportAsyncJob
|
|
1105
1087
|
*/
|
|
1106
|
-
|
|
1107
|
-
|
|
1088
|
+
declare function createExportAsyncJob(query: ExportQueryV2, options?: NonNullablePaths<CreateExportAsyncJobOptions, `fields` | `methodMetadata`, 2>): Promise<NonNullablePaths<CreateExportAsyncJobResponse, `job._id` | `job.data.query.sort` | `job.data.query.sort.${number}.fieldName` | `job.data.query.sort.${number}.order` | `job.data.query.fields` | `job.data.query.fieldsets` | `job.data.fields` | `job.data.fields.${number}._id` | `job.data.fields.${number}.header` | `job.data.arrayFieldDelimiter` | `job.data.methodMetadata.artifact` | `job.data.methodMetadata.service` | `job.data.methodMetadata.method` | `job.data.methodSpec.requestQueryFieldNumber` | `job.data.userId` | `job.data.format` | `job.data.uploadId` | `job.data.iterationsCount` | `job.data.processedItemsCount` | `job.data.resetCount` | `job.data.signedUrl` | `job.data.error.applicationError.code` | `job.data.error.applicationError.description` | `job.data.error.validationError.fieldViolations` | `job.data.error.validationError.fieldViolations.${number}.field` | `job.data.error.validationError.fieldViolations.${number}.description` | `job.data.error.validationError.fieldViolations.${number}.violatedRule` | `job.status`, 8> & {
|
|
1089
|
+
__applicationErrorsType?: CreateExportAsyncJobApplicationErrors;
|
|
1090
|
+
}>;
|
|
1091
|
+
interface CreateExportAsyncJobOptions {
|
|
1108
1092
|
/** translated CSV headers */
|
|
1109
1093
|
fields: FieldDescriptor[];
|
|
1110
|
-
arrayFieldDelimiter?:
|
|
1094
|
+
arrayFieldDelimiter?: ArrayFieldDelimiterWithLiterals;
|
|
1111
1095
|
/** The target method to query data from */
|
|
1112
1096
|
methodMetadata: MethodMetadata;
|
|
1113
1097
|
/** The target method to query data from */
|
|
@@ -1127,5 +1111,8 @@ export interface CreateExportAsyncJobOptions {
|
|
|
1127
1111
|
* @returns The retrieved ExportAsyncJob
|
|
1128
1112
|
* @fqn wix.fedinfra.exportservice.v1.ExportService.GetExportAsyncJob
|
|
1129
1113
|
*/
|
|
1130
|
-
|
|
1131
|
-
|
|
1114
|
+
declare function getExportAsyncJob(jobId: string): Promise<NonNullablePaths<ExportAsyncJob, `_id` | `data.query.sort` | `data.query.sort.${number}.fieldName` | `data.query.sort.${number}.order` | `data.query.fields` | `data.query.fieldsets` | `data.fields` | `data.fields.${number}._id` | `data.fields.${number}.header` | `data.arrayFieldDelimiter` | `data.methodMetadata.artifact` | `data.methodMetadata.service` | `data.methodMetadata.method` | `data.methodSpec.requestQueryFieldNumber` | `data.userId` | `data.format` | `data.uploadId` | `data.iterationsCount` | `data.processedItemsCount` | `data.resetCount` | `data.signedUrl` | `data.error.applicationError.code` | `data.error.applicationError.description` | `data.error.validationError.fieldViolations` | `data.error.validationError.fieldViolations.${number}.field` | `data.error.validationError.fieldViolations.${number}.description` | `data.error.validationError.fieldViolations.${number}.violatedRule` | `status`, 7> & {
|
|
1115
|
+
__applicationErrorsType?: GetExportAsyncJobApplicationErrors;
|
|
1116
|
+
}>;
|
|
1117
|
+
|
|
1118
|
+
export { type AdditionalInfoSection, type ApplicationError, ArrayFieldDelimiter, type ArrayFieldDelimiterWithLiterals, type CancelExportAsyncJobRequest, type CancelExportAsyncJobResponse, type Choice, type CostAndProfitData, type CreateExportAsyncJobApplicationErrors, type CreateExportAsyncJobOptions, type CreateExportAsyncJobRequest, type CreateExportAsyncJobResponse, type Cursors, type CustomTextField, type Details, type DetailsKindOneOf, type Discount, DiscountType, type DiscountTypeWithLiterals, type ExportAsyncJob, type ExportAsyncJobData, type ExportCursorPaging, type ExportQueryV2, type ExportQueryV2PagingMethodOneOf, type FieldDescriptor, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FormattedPrice, type GenerateExportAsyncJobDownloadUrlRequest, type GenerateExportAsyncJobDownloadUrlResponse, type GetExportAsyncJobApplicationErrors, type GetExportAsyncJobRequest, type GetExportAsyncJobResponse, InventoryStatus, type InventoryStatusWithLiterals, type Keyword, MeasurementUnit, type MeasurementUnitWithLiterals, type Media, type MediaItem, type MediaItemItemOneOf, MediaItemType, type MediaItemTypeWithLiterals, type MediaItemUrlAndSize, type MediaItemVideo, type MethodMetadata, type MethodSpec, type NumericPropertyRange, OptionType, type OptionTypeWithLiterals, type PageUrl, type Paging, type PagingMetadataV2, type PlatformMedia, type PlatformMediaMediaOneOf, type PreorderInfo, type PriceData, type PricePerUnitData, type Product, type ProductOption, type ProductOrVariant, type ProductOrVariantV2, ProductType, type ProductTypeWithLiterals, QueryFieldNumber, type QueryFieldNumberWithLiterals, type QueryProductsExportSpiResponse, type QueryRequestLoose, type QueryVariantsExportSpiResponse, type Ribbon, RuleType, type RuleTypeWithLiterals, type SecuredMedia, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type Stock, type StoreVariant, type SystemError, type Tag, type ValidationError, type Variant, type VariantDataWithNoStock, type VariantStock, type VideoResolution, createExportAsyncJob, getExportAsyncJob };
|