@wix/export-async-job 1.0.1 → 1.0.3

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 (57) hide show
  1. package/build/cjs/context.d.ts +1 -0
  2. package/build/cjs/{index.typings.js → context.js} +7 -3
  3. package/build/cjs/context.js.map +1 -0
  4. package/build/cjs/index.d.ts +1 -1
  5. package/build/cjs/index.js +6 -2
  6. package/build/cjs/index.js.map +1 -1
  7. package/build/cjs/meta.d.ts +1 -1
  8. package/build/cjs/meta.js +6 -2
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/context.d.ts +1 -0
  11. package/build/es/context.js +2 -0
  12. package/build/es/context.js.map +1 -0
  13. package/build/es/index.d.ts +1 -1
  14. package/build/es/index.js +1 -1
  15. package/build/es/index.js.map +1 -1
  16. package/build/es/meta.d.ts +1 -1
  17. package/build/es/meta.js +1 -1
  18. package/build/es/meta.js.map +1 -1
  19. package/context/package.json +7 -0
  20. package/meta/package.json +2 -1
  21. package/package.json +19 -11
  22. package/{build/cjs/src/fedinfra-exportservice-v1-export-async-job.universal.d.ts → type-bundles/context.bundle.d.ts} +309 -255
  23. package/{build/es/src/fedinfra-exportservice-v1-export-async-job.universal.d.ts → type-bundles/index.bundle.d.ts} +309 -255
  24. package/type-bundles/meta.bundle.d.ts +687 -0
  25. package/build/cjs/index.typings.d.ts +0 -1
  26. package/build/cjs/index.typings.js.map +0 -1
  27. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.http.d.ts +0 -7
  28. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.http.js +0 -111
  29. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.http.js.map +0 -1
  30. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.meta.d.ts +0 -19
  31. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.meta.js +0 -81
  32. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.meta.js.map +0 -1
  33. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.public.d.ts +0 -10
  34. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.public.js +0 -36
  35. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.public.js.map +0 -1
  36. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.types.d.ts +0 -1009
  37. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.types.js +0 -121
  38. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.types.js.map +0 -1
  39. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.universal.js +0 -334
  40. package/build/cjs/src/fedinfra-exportservice-v1-export-async-job.universal.js.map +0 -1
  41. package/build/es/index.typings.d.ts +0 -1
  42. package/build/es/index.typings.js +0 -2
  43. package/build/es/index.typings.js.map +0 -1
  44. package/build/es/src/fedinfra-exportservice-v1-export-async-job.http.d.ts +0 -7
  45. package/build/es/src/fedinfra-exportservice-v1-export-async-job.http.js +0 -105
  46. package/build/es/src/fedinfra-exportservice-v1-export-async-job.http.js.map +0 -1
  47. package/build/es/src/fedinfra-exportservice-v1-export-async-job.meta.d.ts +0 -19
  48. package/build/es/src/fedinfra-exportservice-v1-export-async-job.meta.js +0 -56
  49. package/build/es/src/fedinfra-exportservice-v1-export-async-job.meta.js.map +0 -1
  50. package/build/es/src/fedinfra-exportservice-v1-export-async-job.public.d.ts +0 -10
  51. package/build/es/src/fedinfra-exportservice-v1-export-async-job.public.js +0 -19
  52. package/build/es/src/fedinfra-exportservice-v1-export-async-job.public.js.map +0 -1
  53. package/build/es/src/fedinfra-exportservice-v1-export-async-job.types.d.ts +0 -1009
  54. package/build/es/src/fedinfra-exportservice-v1-export-async-job.types.js +0 -118
  55. package/build/es/src/fedinfra-exportservice-v1-export-async-job.types.js.map +0 -1
  56. package/build/es/src/fedinfra-exportservice-v1-export-async-job.universal.js +0 -309
  57. package/build/es/src/fedinfra-exportservice-v1-export-async-job.universal.js.map +0 -1
@@ -1,1009 +0,0 @@
1
- export interface ExportAsyncJob {
2
- /** @readonly */
3
- id?: string;
4
- data?: ExportAsyncJobData;
5
- status?: Status;
6
- /** @readonly */
7
- createDate?: Date;
8
- /** @readonly */
9
- updateDate?: Date;
10
- }
11
- export interface ExportAsyncJobData {
12
- /** original request data for the export */
13
- query?: ExportQueryV2;
14
- /** translated CSV headers */
15
- fields?: FieldDescriptor[];
16
- arrayFieldDelimiter?: ArrayFieldDelimiter;
17
- /** The target method to query data from */
18
- methodMetadata?: MethodMetadata;
19
- /** Custom spec for the target method's request/response */
20
- methodSpec?: MethodSpec;
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;
28
- iterationsCount?: number;
29
- processedItemsCount?: number;
30
- completionStep?: string | null;
31
- resetCount?: number;
32
- /** at final step update the signed_url to download the result from */
33
- signedUrl?: string;
34
- /** when failed during the process update the error details */
35
- error?: Details;
36
- testParams?: Record<string, any> | null;
37
- }
38
- export interface ExportQueryV2 extends ExportQueryV2PagingMethodOneOf {
39
- /** Paging options to limit and skip the number of items. */
40
- paging?: Paging;
41
- /** 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`. */
42
- cursorPaging?: ExportCursorPaging;
43
- /**
44
- * Filter object in the following format:
45
- * `"filter" : {
46
- * "fieldName1": "value1",
47
- * "fieldName2":{"$operator":"value2"}
48
- * }`
49
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
50
- */
51
- filter?: Record<string, any> | null;
52
- /**
53
- * Sort object in the following format:
54
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
55
- */
56
- sort?: Sorting[];
57
- /** 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. */
58
- fields?: string[];
59
- /** 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. */
60
- fieldsets?: string[];
61
- }
62
- /** @oneof */
63
- export interface ExportQueryV2PagingMethodOneOf {
64
- /** Paging options to limit and skip the number of items. */
65
- paging?: Paging;
66
- /** 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`. */
67
- cursorPaging?: ExportCursorPaging;
68
- }
69
- export interface Sorting {
70
- /** Name of the field to sort by. */
71
- fieldName?: string;
72
- /** Sort order. */
73
- order?: SortOrder;
74
- }
75
- export declare enum SortOrder {
76
- ASC = "ASC",
77
- DESC = "DESC"
78
- }
79
- export interface Paging {
80
- /** Number of items to load. */
81
- limit?: number | null;
82
- /** Number of items to skip in the current sort order. */
83
- offset?: number | null;
84
- }
85
- export interface ExportCursorPaging {
86
- limit?: number | null;
87
- cursor?: string | null;
88
- }
89
- export interface FieldDescriptor {
90
- /** the path to the field out of the query response items */
91
- id?: string;
92
- /** how to present the filed in the CSV headers (translated) */
93
- header?: string;
94
- }
95
- export declare enum ArrayFieldDelimiter {
96
- SEMICOLON = "SEMICOLON",
97
- SEMICOLON_AND_SPACE = "SEMICOLON_AND_SPACE"
98
- }
99
- export interface MethodMetadata {
100
- artifact?: string;
101
- service?: string;
102
- method?: string;
103
- }
104
- export interface MethodSpec {
105
- requestQueryFieldNumber?: QueryFieldNumber;
106
- responseRepeatedFieldName?: string | null;
107
- responsePagingMetadataFieldName?: string | null;
108
- }
109
- export declare enum QueryFieldNumber {
110
- /** message QuerySomethingRequest { .wix.common.QueryV2 query = 1; } */
111
- DEFAULT = "DEFAULT",
112
- FIELD_2 = "FIELD_2",
113
- FIELD_3 = "FIELD_3",
114
- FIELD_4 = "FIELD_4",
115
- FIELD_5 = "FIELD_5",
116
- FIELD_6 = "FIELD_6",
117
- FIELD_7 = "FIELD_7",
118
- /** message QuerySomethingRequest { .wix.common.QueryV2 query = 8; } */
119
- FIELD_8 = "FIELD_8",
120
- FIELD_9 = "FIELD_9"
121
- }
122
- export interface PagingMetadataV2 {
123
- /** Number of items returned in the response. */
124
- count?: number | null;
125
- /** Offset that was requested. */
126
- offset?: number | null;
127
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
128
- total?: number | null;
129
- /** Flag that indicates the server failed to calculate the `total` field. */
130
- tooManyToCount?: boolean | null;
131
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
132
- cursors?: Cursors;
133
- }
134
- export interface Cursors {
135
- /** Cursor pointing to next page in the list of results. */
136
- next?: string | null;
137
- /** Cursor pointing to previous page in the list of results. */
138
- prev?: string | null;
139
- }
140
- export interface Details extends DetailsKindOneOf {
141
- applicationError?: ApplicationError;
142
- validationError?: ValidationError;
143
- /** deprecated in API's - to enable migration from rendering arbitrary tracing to rest response */
144
- tracing?: Record<string, string>;
145
- }
146
- /** @oneof */
147
- export interface DetailsKindOneOf {
148
- applicationError?: ApplicationError;
149
- validationError?: ValidationError;
150
- }
151
- export interface ApplicationError {
152
- /** Error code. */
153
- code?: string;
154
- /** Description of the error. */
155
- description?: string;
156
- /** Data related to the error. */
157
- data?: Record<string, any> | null;
158
- }
159
- /**
160
- * example result:
161
- * {
162
- * "fieldViolations": [
163
- * {
164
- * "field": "fieldA",
165
- * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
166
- * "violatedRule": "OTHER",
167
- * "ruleName": "INVALID_NOTE",
168
- * "data": {
169
- * "value": "FI"
170
- * }
171
- * },
172
- * {
173
- * "field": "fieldB",
174
- * "description": "field value out of range. supported range: [0-20]",
175
- * "violatedRule": "MAX",
176
- * "data": {
177
- * "threshold": 20
178
- * }
179
- * },
180
- * {
181
- * "field": "fieldC",
182
- * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
183
- * "violatedRule": "FORMAT",
184
- * "data": {
185
- * "type": "PHONE"
186
- * }
187
- * }
188
- * ]
189
- * }
190
- */
191
- export interface ValidationError {
192
- fieldViolations?: FieldViolation[];
193
- }
194
- export declare enum RuleType {
195
- VALIDATION = "VALIDATION",
196
- OTHER = "OTHER",
197
- MAX = "MAX",
198
- MIN = "MIN",
199
- MAX_LENGTH = "MAX_LENGTH",
200
- MIN_LENGTH = "MIN_LENGTH",
201
- MAX_SIZE = "MAX_SIZE",
202
- MIN_SIZE = "MIN_SIZE",
203
- FORMAT = "FORMAT",
204
- DECIMAL_LTE = "DECIMAL_LTE",
205
- DECIMAL_GTE = "DECIMAL_GTE",
206
- DECIMAL_LT = "DECIMAL_LT",
207
- DECIMAL_GT = "DECIMAL_GT",
208
- DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
209
- INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
210
- REQUIRED_FIELD = "REQUIRED_FIELD",
211
- FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
212
- ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT"
213
- }
214
- export interface FieldViolation {
215
- field?: string;
216
- description?: string;
217
- violatedRule?: RuleType;
218
- /** applicable when violated_rule=OTHER */
219
- ruleName?: string | null;
220
- data?: Record<string, any> | null;
221
- }
222
- export declare enum Status {
223
- UNKNOWN = "UNKNOWN",
224
- /** Job was created, but not started yet. */
225
- INITIALIZED = "INITIALIZED",
226
- /** Job has started and is in progress. */
227
- PROCESSING = "PROCESSING",
228
- /** Job is finished. */
229
- FINISHED = "FINISHED",
230
- /** Job is failed */
231
- FAILED = "FAILED"
232
- }
233
- export interface CreateExportAsyncJobRequest {
234
- /** WQL expression */
235
- query: ExportQueryV2;
236
- /** translated CSV headers */
237
- fields: FieldDescriptor[];
238
- arrayFieldDelimiter?: ArrayFieldDelimiter;
239
- /** The target method to query data from */
240
- methodMetadata: MethodMetadata;
241
- /** The target method to query data from */
242
- methodSpec?: MethodSpec;
243
- saveAs?: string | null;
244
- /** Test params */
245
- testParams?: Record<string, any> | null;
246
- }
247
- export interface CreateExportAsyncJobResponse {
248
- /** The retrieved Exports */
249
- job?: ExportAsyncJob;
250
- }
251
- export interface GetExportAsyncJobRequest {
252
- /** Id of the Export to retrieve */
253
- jobId: string;
254
- }
255
- export interface GetExportAsyncJobResponse {
256
- /** The retrieved ExportAsyncJob */
257
- job?: ExportAsyncJob;
258
- }
259
- export interface CancelExportAsyncJobRequest {
260
- /** Id of the Export to retrieve */
261
- jobId: string;
262
- }
263
- export interface CancelExportAsyncJobResponse {
264
- /** The retrieved ExportAsyncJob */
265
- job?: ExportAsyncJob;
266
- }
267
- export interface GenerateExportAsyncJobDownloadUrlRequest {
268
- /** Id of the Export to retrieve */
269
- jobId?: string;
270
- }
271
- export interface GenerateExportAsyncJobDownloadUrlResponse {
272
- /** The retrieved ExportAsyncJob */
273
- job?: ExportAsyncJob;
274
- }
275
- export interface QueryRequestLoose {
276
- /** WQL expression */
277
- query?: ExportQueryV2;
278
- }
279
- export interface QueryVariantsExportSpiResponse {
280
- items?: ProductOrVariant[];
281
- pagingMetadata?: PagingMetadataV2;
282
- }
283
- export interface ProductOrVariant {
284
- kind?: string;
285
- product?: Product;
286
- variant?: StoreVariant;
287
- }
288
- export interface Product {
289
- /**
290
- * Product ID (generated automatically by the catalog).
291
- * @readonly
292
- */
293
- id?: string;
294
- /**
295
- * Product name.
296
- *
297
- * Min: 1 character
298
- * Max: 80 characters
299
- */
300
- name?: string | null;
301
- /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
302
- slug?: string;
303
- /** Whether the product is visible to site visitors. */
304
- visible?: boolean | null;
305
- /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
306
- productType?: ProductType;
307
- /** Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */
308
- description?: string | null;
309
- /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */
310
- sku?: string | null;
311
- /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */
312
- weight?: number | null;
313
- /**
314
- * Product weight range. The minimum and maximum weights of all the variants.
315
- * @readonly
316
- */
317
- weightRange?: NumericPropertyRange;
318
- /**
319
- * Product inventory status (in future this will be writable via Inventory API).
320
- * @readonly
321
- */
322
- stock?: Stock;
323
- /**
324
- * Deprecated (use `priceData` instead).
325
- * @readonly
326
- */
327
- price?: PriceData;
328
- /** Price data. */
329
- priceData?: PriceData;
330
- /**
331
- * Price data, converted to the currency specified in request header.
332
- * @readonly
333
- */
334
- convertedPriceData?: PriceData;
335
- /**
336
- * Product price range. The minimum and maximum prices of all the variants.
337
- * @readonly
338
- */
339
- priceRange?: NumericPropertyRange;
340
- /** Cost and profit data. */
341
- costAndProfitData?: CostAndProfitData;
342
- /**
343
- * Product cost range. The minimum and maximum costs of all the variants.
344
- * @readonly
345
- */
346
- costRange?: NumericPropertyRange;
347
- /** Price per unit data. */
348
- pricePerUnitData?: PricePerUnitData;
349
- /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */
350
- additionalInfoSections?: AdditionalInfoSection[];
351
- /**
352
- * Deprecated (use `ribbon` instead).
353
- * @readonly
354
- */
355
- ribbons?: Ribbon[];
356
- /**
357
- * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).
358
- * @readonly
359
- */
360
- media?: Media;
361
- /**
362
- * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
363
- * @readonly
364
- */
365
- customTextFields?: CustomTextField[];
366
- /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
367
- manageVariants?: boolean | null;
368
- /** Options for this product. */
369
- productOptions?: ProductOption[];
370
- /**
371
- * Product page URL for this product (generated automatically by the server).
372
- * @readonly
373
- */
374
- productPageUrl?: PageUrl;
375
- /**
376
- * Product’s unique numeric ID (assigned in ascending order).
377
- * Primarily used for sorting and filtering when crawling all products.
378
- * @readonly
379
- */
380
- numericId?: string;
381
- /**
382
- * Inventory item ID - ID referencing the inventory system.
383
- * @readonly
384
- */
385
- inventoryItemId?: string;
386
- /** Discount deducted from the product's original price. */
387
- discount?: Discount;
388
- /**
389
- * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
390
- * @readonly
391
- */
392
- collectionIds?: string[];
393
- /**
394
- * Product variants, will be provided if the the request was sent with the includeVariants flag.
395
- * @readonly
396
- */
397
- variants?: Variant[];
398
- /**
399
- * Date and time the product was last updated.
400
- * @readonly
401
- */
402
- lastUpdated?: Date;
403
- /**
404
- * Date and time the product was created.
405
- * @readonly
406
- */
407
- createdDate?: Date;
408
- /** Custom SEO data for the product. */
409
- seoData?: SeoSchema;
410
- /** Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out". */
411
- ribbon?: string | null;
412
- /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */
413
- brand?: string | null;
414
- }
415
- export declare enum ProductType {
416
- unspecified_product_type = "unspecified_product_type",
417
- physical = "physical",
418
- digital = "digital"
419
- }
420
- export interface NumericPropertyRange {
421
- /** Minimum value. */
422
- minValue?: number;
423
- /** Maximum value. */
424
- maxValue?: number;
425
- }
426
- export interface Stock {
427
- /** Whether inventory is being tracked */
428
- trackInventory?: boolean;
429
- /** Quantity currently left in inventory */
430
- quantity?: number | null;
431
- /**
432
- * Whether the product is currently in stock (relevant only when tracking manually)
433
- * Deprecated (use `inventoryStatus` instead)
434
- */
435
- inStock?: boolean;
436
- /**
437
- * The current status of the inventory
438
- * + `IN_STOCK` - In stock
439
- * + `OUT_OF_STOCK` - Not in stock
440
- * + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock
441
- */
442
- inventoryStatus?: InventoryStatus;
443
- }
444
- export declare enum InventoryStatus {
445
- IN_STOCK = "IN_STOCK",
446
- OUT_OF_STOCK = "OUT_OF_STOCK",
447
- PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
448
- }
449
- export interface PriceData {
450
- /**
451
- * Product price currency
452
- * @readonly
453
- */
454
- currency?: string;
455
- /** Product price */
456
- price?: number | null;
457
- /**
458
- * Discounted product price (if no discounted price is set, the product price is returned)
459
- * @readonly
460
- */
461
- discountedPrice?: number;
462
- /**
463
- * The product price and discounted price, formatted with the currency
464
- * @readonly
465
- */
466
- formatted?: FormattedPrice;
467
- /**
468
- * Price per unit
469
- * @readonly
470
- */
471
- pricePerUnit?: number | null;
472
- }
473
- export interface FormattedPrice {
474
- /** Product price formatted with the currency */
475
- price?: string;
476
- /** Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned) */
477
- discountedPrice?: string;
478
- /**
479
- * Price per unit
480
- * @readonly
481
- */
482
- pricePerUnit?: string | null;
483
- }
484
- export interface CostAndProfitData {
485
- /** Item cost. */
486
- itemCost?: number | null;
487
- /**
488
- * Item cost formatted with currency symbol.
489
- * @readonly
490
- */
491
- formattedItemCost?: string;
492
- /**
493
- * Profit. Calculated by reducing `cost` from `discounted_price`.
494
- * @readonly
495
- */
496
- profit?: number;
497
- /**
498
- * Profit formatted with currency symbol.
499
- * @readonly
500
- */
501
- formattedProfit?: string;
502
- /**
503
- * Profit Margin. Calculated by dividing `profit` by `discounted_price`.
504
- * The result is rounded to 4 decimal places.
505
- * @readonly
506
- */
507
- profitMargin?: number;
508
- }
509
- export interface PricePerUnitData {
510
- /** Total quantity */
511
- totalQuantity?: number;
512
- /** Total measurement unit */
513
- totalMeasurementUnit?: MeasurementUnit;
514
- /** Base quantity */
515
- baseQuantity?: number;
516
- /** Base measurement unit */
517
- baseMeasurementUnit?: MeasurementUnit;
518
- }
519
- export declare enum MeasurementUnit {
520
- UNSPECIFIED = "UNSPECIFIED",
521
- ML = "ML",
522
- CL = "CL",
523
- L = "L",
524
- CBM = "CBM",
525
- MG = "MG",
526
- G = "G",
527
- KG = "KG",
528
- MM = "MM",
529
- CM = "CM",
530
- M = "M",
531
- SQM = "SQM",
532
- OZ = "OZ",
533
- LB = "LB",
534
- FLOZ = "FLOZ",
535
- PT = "PT",
536
- QT = "QT",
537
- GAL = "GAL",
538
- IN = "IN",
539
- FT = "FT",
540
- YD = "YD",
541
- SQFT = "SQFT"
542
- }
543
- export interface AdditionalInfoSection {
544
- /** Product info section title */
545
- title?: string;
546
- /** Product info section description */
547
- description?: string;
548
- }
549
- export interface Ribbon {
550
- /** Ribbon text */
551
- text?: string;
552
- }
553
- export interface Media {
554
- /** Primary media (image, video etc) associated with this product. */
555
- mainMedia?: MediaItem;
556
- /** Media (images, videos etc) associated with this product. */
557
- items?: MediaItem[];
558
- }
559
- export interface MediaItem extends MediaItemItemOneOf {
560
- /** Image data (URL, size). */
561
- image?: MediaItemUrlAndSize;
562
- /** Video data (URL, size). */
563
- video?: MediaItemVideo;
564
- /** Media item thumbnail details. */
565
- thumbnail?: MediaItemUrlAndSize;
566
- /** Media item type (image, video, etc.). */
567
- mediaType?: MediaItemType;
568
- /** Media item title. */
569
- title?: string;
570
- /** Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). */
571
- id?: string;
572
- }
573
- /** @oneof */
574
- export interface MediaItemItemOneOf {
575
- /** Image data (URL, size). */
576
- image?: MediaItemUrlAndSize;
577
- /** Video data (URL, size). */
578
- video?: MediaItemVideo;
579
- }
580
- export interface MediaItemUrlAndSize {
581
- /** Media item URL. */
582
- url?: string;
583
- /** Media item width. */
584
- width?: number;
585
- /** Media item height. */
586
- height?: number;
587
- /** Media format (mp4, png, etc.). */
588
- format?: string | null;
589
- /** Alt text. This text will be shown in case the image is not available. */
590
- altText?: string | null;
591
- }
592
- export declare enum MediaItemType {
593
- unspecified_media_item_type = "unspecified_media_item_type",
594
- image = "image",
595
- video = "video",
596
- audio = "audio",
597
- document = "document",
598
- zip = "zip"
599
- }
600
- export interface MediaItemVideo {
601
- /** Data (URL, size) about each resolution for which this video is available. */
602
- files?: MediaItemUrlAndSize[];
603
- /** 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"`. */
604
- stillFrameMediaId?: string;
605
- }
606
- export interface CustomTextField {
607
- /** Text box title */
608
- title?: string;
609
- /** Text box input max length */
610
- maxLength?: number;
611
- /** Whether this text box is mandatory */
612
- mandatory?: boolean;
613
- }
614
- export interface ProductOption {
615
- /**
616
- * Option type - color or other(drop down)
617
- * @readonly
618
- */
619
- optionType?: OptionType;
620
- /** Option name. */
621
- name?: string;
622
- /** Choices available for this option. */
623
- choices?: Choice[];
624
- }
625
- export declare enum OptionType {
626
- unspecified_option_type = "unspecified_option_type",
627
- drop_down = "drop_down",
628
- color = "color"
629
- }
630
- export interface Choice {
631
- /** Choice value. */
632
- value?: string;
633
- /** Choice description. */
634
- description?: string;
635
- /**
636
- * Media items (images, videos) associated with this choice
637
- * @readonly
638
- */
639
- media?: Media;
640
- /**
641
- * Based on the customer’s choices, which (if any) variants that include the selected choices are in stock
642
- * @readonly
643
- */
644
- inStock?: boolean;
645
- /**
646
- * Based on the customer’s choices, which (if any) variants that include the selected choices are visible
647
- * @readonly
648
- */
649
- visible?: boolean;
650
- }
651
- export interface PageUrl {
652
- /** Base URL. For premium sites, this is the domain. For free sites, this is the site URL (e.g mysite.wixsite.com/mysite). */
653
- base?: string;
654
- /** Path to the product page - e.g /product-page/a-product. */
655
- path?: string;
656
- }
657
- export interface Discount {
658
- /**
659
- * Discount type:
660
- * + `"AMOUNT"`
661
- * + `"PERCENT"`
662
- */
663
- type?: DiscountType;
664
- /** Discount value */
665
- value?: number;
666
- }
667
- export declare enum DiscountType {
668
- UNDEFINED = "UNDEFINED",
669
- /** No discount */
670
- NONE = "NONE",
671
- AMOUNT = "AMOUNT",
672
- PERCENT = "PERCENT"
673
- }
674
- export interface Variant {
675
- /** Requested Variant ID */
676
- id?: string;
677
- /** Specific choices within a selection, as option-choice key-value pairs */
678
- choices?: Record<string, string>;
679
- variant?: VariantDataWithNoStock;
680
- /**
681
- * Variant inventory status.
682
- * @readonly
683
- */
684
- stock?: VariantStock;
685
- }
686
- export interface VariantDataWithNoStock {
687
- /** Variant price. */
688
- priceData?: PriceData;
689
- /**
690
- * Variant price data, converted to currency requested in header.
691
- * @readonly
692
- */
693
- convertedPriceData?: PriceData;
694
- /** Cost and profit data. */
695
- costAndProfitData?: CostAndProfitData;
696
- /** Variant weight. */
697
- weight?: number;
698
- /** Variant SKU (stock keeping unit). */
699
- sku?: string;
700
- /** Whether the variant is visible to customers. */
701
- visible?: boolean;
702
- }
703
- export interface VariantStock {
704
- /** Whether inventory is being tracked. */
705
- trackQuantity?: boolean;
706
- /** Quantity currently left in inventory. */
707
- quantity?: number | null;
708
- /** Whether the product is currently in stock (relevant only when tracking manually). */
709
- inStock?: boolean;
710
- }
711
- /**
712
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
713
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
714
- * 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.
715
- */
716
- export interface SeoSchema {
717
- /** SEO tag information. */
718
- tags?: Tag[];
719
- /** SEO general settings. */
720
- settings?: Settings;
721
- }
722
- export interface Keyword {
723
- /** Keyword value. */
724
- term?: string;
725
- /** Whether the keyword is the main focus keyword. */
726
- isMain?: boolean;
727
- }
728
- export interface Tag {
729
- /**
730
- * SEO tag type.
731
- *
732
- *
733
- * Supported values: `title`, `meta`, `script`, `link`.
734
- */
735
- type?: string;
736
- /**
737
- * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
738
- * For example: `{'name': 'description', 'content': 'the description itself'}`.
739
- */
740
- props?: Record<string, any> | null;
741
- /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
742
- meta?: Record<string, any> | null;
743
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
744
- children?: string;
745
- /** Whether the tag is a custom tag. */
746
- custom?: boolean;
747
- /** Whether the tag is disabled. */
748
- disabled?: boolean;
749
- }
750
- export interface Settings {
751
- /**
752
- * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
753
- *
754
- *
755
- * Default: `false` (Auto Redirect is enabled.)
756
- */
757
- preventAutoRedirect?: boolean;
758
- /** User-selected keyword terms for a specific page. */
759
- keywords?: Keyword[];
760
- }
761
- export interface StoreVariant {
762
- /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen: {productId}.{variantId}. */
763
- id?: string;
764
- /** Variant ID. */
765
- variantId?: string;
766
- /** Product ID. */
767
- productId?: string;
768
- /** Variant name. */
769
- variantName?: string;
770
- /** Product name. */
771
- productName?: string;
772
- /** Whether the variant is managed or represents a product. */
773
- managedVariant?: boolean;
774
- /** Variant SKU (stock keeping unit). */
775
- sku?: string;
776
- /** Variant inventory status. */
777
- stock?: VariantStock;
778
- /** The selected options of this variant. For example, `{"Color": "Blue", "Size": "Large"}`. */
779
- choices?: Record<string, string>;
780
- /** Collections that include this variant. */
781
- collectionIds?: string[];
782
- /**
783
- * Media items (images, videos) associated with this variant.
784
- * @readonly
785
- */
786
- media?: PlatformMedia;
787
- /** Preorder information. */
788
- preorderInfo?: PreorderInfo;
789
- }
790
- export interface PlatformMedia extends PlatformMediaMediaOneOf {
791
- image?: Image;
792
- video?: VideoV2;
793
- }
794
- /** @oneof */
795
- export interface PlatformMediaMediaOneOf {
796
- image?: Image;
797
- video?: VideoV2;
798
- }
799
- export interface Image {
800
- /** WixMedia image ID. */
801
- id?: string;
802
- /** Image URL. */
803
- url?: string;
804
- /**
805
- * Original image height.
806
- * @readonly
807
- */
808
- height?: number;
809
- /**
810
- * Original image width.
811
- * @readonly
812
- */
813
- width?: number;
814
- /** Image alt text. */
815
- altText?: string | null;
816
- /**
817
- * Image filename.
818
- * @readonly
819
- */
820
- filename?: string | null;
821
- }
822
- export interface VideoV2 {
823
- /** WixMedia ID. */
824
- id?: string;
825
- /**
826
- * Available resolutions for the video, starting with the optimal resolution.
827
- * @readonly
828
- */
829
- resolutions?: VideoResolution[];
830
- /**
831
- * Video filename.
832
- * @readonly
833
- */
834
- filename?: string | null;
835
- }
836
- export interface VideoResolution {
837
- /** Video URL. */
838
- url?: string;
839
- /** Video height. */
840
- height?: number;
841
- /** Video width. */
842
- width?: number;
843
- /** Video format for example, mp4, hls. */
844
- format?: string;
845
- }
846
- export interface PreorderInfo {
847
- /** Whether the item is available for preorder. */
848
- enabled?: boolean;
849
- /** A message the buyer will see when the item is out of stock and preorder is enabled. */
850
- message?: string | null;
851
- /** Number of products that can be preordered after stock reaches zero. */
852
- limit?: number | null;
853
- }
854
- export interface QueryProductsExportSpiResponse {
855
- items?: ProductOrVariantV2[];
856
- pagingMetadata?: PagingMetadataV2;
857
- }
858
- export interface ProductOrVariantV2 {
859
- kind?: string;
860
- product?: Product;
861
- variant?: Variant;
862
- }
863
- export interface CreateExportAsyncJobResponseNonNullableFields {
864
- job?: {
865
- id: string;
866
- data?: {
867
- query?: {
868
- sort: {
869
- fieldName: string;
870
- order: SortOrder;
871
- }[];
872
- fields: string[];
873
- fieldsets: string[];
874
- };
875
- fields: {
876
- id: string;
877
- header: string;
878
- }[];
879
- arrayFieldDelimiter: ArrayFieldDelimiter;
880
- methodMetadata?: {
881
- artifact: string;
882
- service: string;
883
- method: string;
884
- };
885
- methodSpec?: {
886
- requestQueryFieldNumber: QueryFieldNumber;
887
- };
888
- userId: string;
889
- format: string;
890
- uploadId: string;
891
- iterationsCount: number;
892
- processedItemsCount: number;
893
- resetCount: number;
894
- signedUrl: string;
895
- error?: {
896
- applicationError?: {
897
- code: string;
898
- description: string;
899
- };
900
- validationError?: {
901
- fieldViolations: {
902
- field: string;
903
- description: string;
904
- violatedRule: RuleType;
905
- }[];
906
- };
907
- };
908
- };
909
- status: Status;
910
- };
911
- }
912
- export interface GetExportAsyncJobResponseNonNullableFields {
913
- job?: {
914
- id: string;
915
- data?: {
916
- query?: {
917
- sort: {
918
- fieldName: string;
919
- order: SortOrder;
920
- }[];
921
- fields: string[];
922
- fieldsets: string[];
923
- };
924
- fields: {
925
- id: string;
926
- header: string;
927
- }[];
928
- arrayFieldDelimiter: ArrayFieldDelimiter;
929
- methodMetadata?: {
930
- artifact: string;
931
- service: string;
932
- method: string;
933
- };
934
- methodSpec?: {
935
- requestQueryFieldNumber: QueryFieldNumber;
936
- };
937
- userId: string;
938
- format: string;
939
- uploadId: string;
940
- iterationsCount: number;
941
- processedItemsCount: number;
942
- resetCount: number;
943
- signedUrl: string;
944
- error?: {
945
- applicationError?: {
946
- code: string;
947
- description: string;
948
- };
949
- validationError?: {
950
- fieldViolations: {
951
- field: string;
952
- description: string;
953
- violatedRule: RuleType;
954
- }[];
955
- };
956
- };
957
- };
958
- status: Status;
959
- };
960
- }
961
- export interface CancelExportAsyncJobResponseNonNullableFields {
962
- job?: {
963
- id: string;
964
- data?: {
965
- query?: {
966
- sort: {
967
- fieldName: string;
968
- order: SortOrder;
969
- }[];
970
- fields: string[];
971
- fieldsets: string[];
972
- };
973
- fields: {
974
- id: string;
975
- header: string;
976
- }[];
977
- arrayFieldDelimiter: ArrayFieldDelimiter;
978
- methodMetadata?: {
979
- artifact: string;
980
- service: string;
981
- method: string;
982
- };
983
- methodSpec?: {
984
- requestQueryFieldNumber: QueryFieldNumber;
985
- };
986
- userId: string;
987
- format: string;
988
- uploadId: string;
989
- iterationsCount: number;
990
- processedItemsCount: number;
991
- resetCount: number;
992
- signedUrl: string;
993
- error?: {
994
- applicationError?: {
995
- code: string;
996
- description: string;
997
- };
998
- validationError?: {
999
- fieldViolations: {
1000
- field: string;
1001
- description: string;
1002
- violatedRule: RuleType;
1003
- }[];
1004
- };
1005
- };
1006
- };
1007
- status: Status;
1008
- };
1009
- }