@wix/auto_sdk_data_indexes 1.0.0 → 1.0.1

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 (25) hide show
  1. package/build/cjs/src/data-v2-index-indexes.types.d.ts +42 -8
  2. package/build/cjs/src/data-v2-index-indexes.types.js +3 -0
  3. package/build/cjs/src/data-v2-index-indexes.types.js.map +1 -1
  4. package/build/cjs/src/data-v2-index-indexes.universal.d.ts +48 -8
  5. package/build/cjs/src/data-v2-index-indexes.universal.js +11 -0
  6. package/build/cjs/src/data-v2-index-indexes.universal.js.map +1 -1
  7. package/build/es/src/data-v2-index-indexes.types.d.ts +42 -8
  8. package/build/es/src/data-v2-index-indexes.types.js +3 -0
  9. package/build/es/src/data-v2-index-indexes.types.js.map +1 -1
  10. package/build/es/src/data-v2-index-indexes.universal.d.ts +48 -8
  11. package/build/es/src/data-v2-index-indexes.universal.js +11 -0
  12. package/build/es/src/data-v2-index-indexes.universal.js.map +1 -1
  13. package/build/internal/cjs/src/data-v2-index-indexes.types.d.ts +42 -8
  14. package/build/internal/cjs/src/data-v2-index-indexes.types.js +3 -0
  15. package/build/internal/cjs/src/data-v2-index-indexes.types.js.map +1 -1
  16. package/build/internal/cjs/src/data-v2-index-indexes.universal.d.ts +50 -8
  17. package/build/internal/cjs/src/data-v2-index-indexes.universal.js +11 -0
  18. package/build/internal/cjs/src/data-v2-index-indexes.universal.js.map +1 -1
  19. package/build/internal/es/src/data-v2-index-indexes.types.d.ts +42 -8
  20. package/build/internal/es/src/data-v2-index-indexes.types.js +3 -0
  21. package/build/internal/es/src/data-v2-index-indexes.types.js.map +1 -1
  22. package/build/internal/es/src/data-v2-index-indexes.universal.d.ts +50 -8
  23. package/build/internal/es/src/data-v2-index-indexes.universal.js +11 -0
  24. package/build/internal/es/src/data-v2-index-indexes.universal.js.map +1 -1
  25. package/package.json +2 -2
package/build/cjs/src/data-v2-index-indexes.types.d.ts CHANGED
@@ -1,11 +1,17 @@
1
1
  /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
2
2
  export interface Index {
3
- /** Name of the index. */
3
+ /**
4
+ * Name of the index.
5
+ * @minLength 1
6
+ * @maxLength 128
7
+ */
4
8
  name?: string;
5
9
  /**
6
10
  * Fields for which the index is defined.
7
11
  *
8
12
  * Max: 3 fields (for a unique index: 1 field)
13
+ * @minSize 1
14
+ * @maxSize 3
9
15
  */
10
16
  fields?: Field[];
11
17
  /**
@@ -41,7 +47,11 @@ export declare enum Order {
41
47
  DESC = "DESC"
42
48
  }
43
49
  export interface Field {
44
- /** Path of the field to index. For example: `title` or `options.price`. */
50
+ /**
51
+ * Path of the field to index. For example: `title` or `options.price`.
52
+ * @minLength 1
53
+ * @maxLength 128
54
+ */
45
55
  path?: string;
46
56
  /**
47
57
  * Sort order for the index. Base on how the data is regularly queried.
@@ -72,25 +82,36 @@ export interface Failure {
72
82
  * - `WDE0112`: Unknown error while building collection index.
73
83
  * - `WDE0113`: Duplicate key error while building collection index.
74
84
  * - `WDE0114`: Document too large while building collection index.
85
+ * @maxLength 7
75
86
  */
76
87
  code?: string;
77
- /** Description of the failure. */
88
+ /**
89
+ * Description of the failure.
90
+ * @maxLength 1024
91
+ */
78
92
  description?: string;
79
93
  /**
80
94
  * ID of the data item that caused the failure.
81
95
  * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
96
+ * @maxLength 16000
82
97
  */
83
98
  itemId?: string | null;
84
99
  }
85
100
  export interface CreateIndexRequest {
86
101
  /** Details of the index to be created. */
87
102
  index: Index;
88
- /** ID of the data collection for which to generate the index. */
103
+ /**
104
+ * ID of the data collection for which to generate the index.
105
+ * @maxLength 256
106
+ */
89
107
  dataCollectionId: string;
90
108
  }
91
109
  export declare enum Environment {
110
+ /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
92
111
  LIVE = "LIVE",
112
+ /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
93
113
  SANDBOX = "SANDBOX",
114
+ /** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
94
115
  SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
95
116
  }
96
117
  export interface CreateIndexResponse {
@@ -98,15 +119,25 @@ export interface CreateIndexResponse {
98
119
  index?: Index;
99
120
  }
100
121
  export interface DropIndexRequest {
101
- /** Name of the index to drop. */
122
+ /**
123
+ * Name of the index to drop.
124
+ * @minLength 1
125
+ * @maxLength 128
126
+ */
102
127
  indexName: string;
103
- /** ID of the data collection for which the index to be dropped is defined. */
128
+ /**
129
+ * ID of the data collection for which the index to be dropped is defined.
130
+ * @maxLength 1024
131
+ */
104
132
  dataCollectionId: string;
105
133
  }
106
134
  export interface DropIndexResponse {
107
135
  }
108
136
  export interface ListIndexesRequest {
109
- /** ID of the data collection for which to list indexes. */
137
+ /**
138
+ * ID of the data collection for which to list indexes.
139
+ * @maxLength 1024
140
+ */
110
141
  dataCollectionId: string;
111
142
  /** Paging options to limit and skip the number of items. */
112
143
  paging?: Paging;
@@ -134,7 +165,10 @@ export interface PagingMetadata {
134
165
  tooManyToCount?: boolean | null;
135
166
  }
136
167
  export interface ListAvailableIndexesRequest {
137
- /** Data collection to show available indexes for */
168
+ /**
169
+ * Data collection to show available indexes for
170
+ * @maxLength 256
171
+ */
138
172
  dataCollectionId: string;
139
173
  }
140
174
  export interface ListAvailableIndexesResponse {
package/build/cjs/src/data-v2-index-indexes.types.js CHANGED
@@ -29,8 +29,11 @@ var Status;
29
29
  })(Status || (exports.Status = Status = {}));
30
30
  var Environment;
31
31
  (function (Environment) {
32
+ /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
32
33
  Environment["LIVE"] = "LIVE";
34
+ /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
33
35
  Environment["SANDBOX"] = "SANDBOX";
36
+ /** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
34
37
  Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
35
38
  })(Environment || (exports.Environment = Environment = {}));
36
39
  //# sourceMappingURL=data-v2-index-indexes.types.js.map
package/build/cjs/src/data-v2-index-indexes.types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":";;;AAmCA;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAaD,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,sBAAN,MAAM,QAejB;AA0BD,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;IACnB,sDAAuC,CAAA;AACzC,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB"}
1
+ {"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":";;;AAyCA;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAiBD,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,sBAAN,MAAM,QAejB;AAkCD,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,6IAA6I;IAC7I,4BAAa,CAAA;IACb,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,0SAA0S;IAC1S,sDAAuC,CAAA;AACzC,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB"}
package/build/cjs/src/data-v2-index-indexes.universal.d.ts CHANGED
@@ -1,11 +1,17 @@
1
1
  /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
2
2
  export interface Index {
3
- /** Name of the index. */
3
+ /**
4
+ * Name of the index.
5
+ * @minLength 1
6
+ * @maxLength 128
7
+ */
4
8
  name?: string;
5
9
  /**
6
10
  * Fields for which the index is defined.
7
11
  *
8
12
  * Max: 3 fields (for a unique index: 1 field)
13
+ * @minSize 1
14
+ * @maxSize 3
9
15
  */
10
16
  fields?: Field[];
11
17
  /**
@@ -41,7 +47,11 @@ export declare enum Order {
41
47
  DESC = "DESC"
42
48
  }
43
49
  export interface Field {
44
- /** Path of the field to index. For example: `title` or `options.price`. */
50
+ /**
51
+ * Path of the field to index. For example: `title` or `options.price`.
52
+ * @minLength 1
53
+ * @maxLength 128
54
+ */
45
55
  path?: string;
46
56
  /**
47
57
  * Sort order for the index. Base on how the data is regularly queried.
@@ -72,25 +82,36 @@ export interface Failure {
72
82
  * - `WDE0112`: Unknown error while building collection index.
73
83
  * - `WDE0113`: Duplicate key error while building collection index.
74
84
  * - `WDE0114`: Document too large while building collection index.
85
+ * @maxLength 7
75
86
  */
76
87
  code?: string;
77
- /** Description of the failure. */
88
+ /**
89
+ * Description of the failure.
90
+ * @maxLength 1024
91
+ */
78
92
  description?: string;
79
93
  /**
80
94
  * ID of the data item that caused the failure.
81
95
  * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
96
+ * @maxLength 16000
82
97
  */
83
98
  itemId?: string | null;
84
99
  }
85
100
  export interface CreateIndexRequest {
86
101
  /** Details of the index to be created. */
87
102
  index: Index;
88
- /** ID of the data collection for which to generate the index. */
103
+ /**
104
+ * ID of the data collection for which to generate the index.
105
+ * @maxLength 256
106
+ */
89
107
  dataCollectionId: string;
90
108
  }
91
109
  export declare enum Environment {
110
+ /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
92
111
  LIVE = "LIVE",
112
+ /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
93
113
  SANDBOX = "SANDBOX",
114
+ /** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
94
115
  SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
95
116
  }
96
117
  export interface CreateIndexResponse {
@@ -98,15 +119,25 @@ export interface CreateIndexResponse {
98
119
  index?: Index;
99
120
  }
100
121
  export interface DropIndexRequest {
101
- /** Name of the index to drop. */
122
+ /**
123
+ * Name of the index to drop.
124
+ * @minLength 1
125
+ * @maxLength 128
126
+ */
102
127
  indexName: string;
103
- /** ID of the data collection for which the index to be dropped is defined. */
128
+ /**
129
+ * ID of the data collection for which the index to be dropped is defined.
130
+ * @maxLength 1024
131
+ */
104
132
  dataCollectionId: string;
105
133
  }
106
134
  export interface DropIndexResponse {
107
135
  }
108
136
  export interface ListIndexesRequest {
109
- /** ID of the data collection for which to list indexes. */
137
+ /**
138
+ * ID of the data collection for which to list indexes.
139
+ * @maxLength 1024
140
+ */
110
141
  dataCollectionId: string;
111
142
  /** Paging options to limit and skip the number of items. */
112
143
  paging?: Paging;
@@ -134,7 +165,10 @@ export interface PagingMetadata {
134
165
  tooManyToCount?: boolean | null;
135
166
  }
136
167
  export interface ListAvailableIndexesRequest {
137
- /** Data collection to show available indexes for */
168
+ /**
169
+ * Data collection to show available indexes for
170
+ * @maxLength 256
171
+ */
138
172
  dataCollectionId: string;
139
173
  }
140
174
  export interface ListAvailableIndexesResponse {
@@ -198,6 +232,8 @@ export interface ListAvailableIndexesResponseNonNullableFields {
198
232
  * @permissionId WIX_DATA.CREATE_INDEX
199
233
  * @permissionScope Manage Data Indexes
200
234
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
235
+ * @permissionScope Manage All Data Resources
236
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
201
237
  * @applicableIdentity APP
202
238
  * @returns Details of the index being generated.
203
239
  * @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
@@ -217,6 +253,8 @@ export declare function createIndex(dataCollectionId: string, index: Index): Pro
217
253
  * @permissionId WIX_DATA.DROP_INDEX
218
254
  * @permissionScope Manage Data Indexes
219
255
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
256
+ * @permissionScope Manage All Data Resources
257
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
220
258
  * @applicableIdentity APP
221
259
  * @fqn com.wixpress.cloud.data.api.index.IndexService.DropIndex
222
260
  */
@@ -236,6 +274,8 @@ export declare function dropIndex(dataCollectionId: string, indexName: string):
236
274
  * @permissionId WIX_DATA.LIST_INDEXES
237
275
  * @permissionScope Manage Data Indexes
238
276
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
277
+ * @permissionScope Manage All Data Resources
278
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
239
279
  * @applicableIdentity APP
240
280
  * @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
241
281
  */
package/build/cjs/src/data-v2-index-indexes.universal.js CHANGED
@@ -55,8 +55,11 @@ var Status;
55
55
  })(Status || (exports.Status = Status = {}));
56
56
  var Environment;
57
57
  (function (Environment) {
58
+ /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
58
59
  Environment["LIVE"] = "LIVE";
60
+ /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
59
61
  Environment["SANDBOX"] = "SANDBOX";
62
+ /** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
60
63
  Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
61
64
  })(Environment || (exports.Environment = Environment = {}));
62
65
  /**
@@ -79,6 +82,8 @@ var Environment;
79
82
  * @permissionId WIX_DATA.CREATE_INDEX
80
83
  * @permissionScope Manage Data Indexes
81
84
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
85
+ * @permissionScope Manage All Data Resources
86
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
82
87
  * @applicableIdentity APP
83
88
  * @returns Details of the index being generated.
84
89
  * @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
@@ -122,6 +127,8 @@ exports.createIndex = createIndex;
122
127
  * @permissionId WIX_DATA.DROP_INDEX
123
128
  * @permissionScope Manage Data Indexes
124
129
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
130
+ * @permissionScope Manage All Data Resources
131
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
125
132
  * @applicableIdentity APP
126
133
  * @fqn com.wixpress.cloud.data.api.index.IndexService.DropIndex
127
134
  */
@@ -167,6 +174,8 @@ exports.dropIndex = dropIndex;
167
174
  * @permissionId WIX_DATA.LIST_INDEXES
168
175
  * @permissionScope Manage Data Indexes
169
176
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
177
+ * @permissionScope Manage All Data Resources
178
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
170
179
  * @applicableIdentity APP
171
180
  * @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
172
181
  */
@@ -207,6 +216,8 @@ exports.listIndexes = listIndexes;
207
216
  * @permissionId WIX_DATA.LIST_INDEXES
208
217
  * @permissionScope Manage Data Indexes
209
218
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
219
+ * @permissionScope Manage All Data Resources
220
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
210
221
  * @applicableIdentity APP
211
222
  * @fqn com.wixpress.cloud.data.api.index.IndexService.ListAvailableIndexes
212
223
  */
package/build/cjs/src/data-v2-index-indexes.universal.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"data-v2-index-indexes.universal.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,0FAA4E;AAqC5E;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAaD,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,sBAAN,MAAM,QAejB;AA0BD,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;IACnB,sDAAuC,CAAA;AACzC,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAqGD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,WAAW,CAC/B,gBAAwB,EACxB,KAAY;IAEZ,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,KAAK,EAAE,KAAK;KACb,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAM,CAAC;IACtE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;YACrE,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAC9B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,kCAqCC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,SAAS,CAC7B,gBAAwB,EACxB,SAAiB;IAEjB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE5D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,gBAAgB,EAAE,MAAM;gBACxB,SAAS,EAAE,MAAM;aAClB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAClC,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAtCD,8BAsCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,WAAW,CAC/B,gBAAwB,EACxB,OAA4B;IAE5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,gBAAgB,EAAE,MAAM;gBACxB,MAAM,EAAE,aAAa;aACtB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAChC,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,kCAwCC;AAOD;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,oBAAoB,CACxC,gBAAwB;IAIxB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,oDAqCC"}
1
+ {"version":3,"file":"data-v2-index-indexes.universal.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,0FAA4E;AA2C5E;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAiBD,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,sBAAN,MAAM,QAejB;AAkCD,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,6IAA6I;IAC7I,4BAAa,CAAA;IACb,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,0SAA0S;IAC1S,sDAAuC,CAAA;AACzC,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB;AAkHD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,UAAU,WAAW,CAC/B,gBAAwB,EACxB,KAAY;IAEZ,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,KAAK,EAAE,KAAK;KACb,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAM,CAAC;IACtE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;YACrE,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAC9B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,kCAqCC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,SAAS,CAC7B,gBAAwB,EACxB,SAAiB;IAEjB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE5D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,gBAAgB,EAAE,MAAM;gBACxB,SAAS,EAAE,MAAM;aAClB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAClC,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAtCD,8BAsCC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,WAAW,CAC/B,gBAAwB,EACxB,OAA4B;IAE5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;QAClC,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9D,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,gBAAgB,EAAE,MAAM;gBACxB,MAAM,EAAE,aAAa;aACtB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAChC,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,kCAwCC;AAOD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,oBAAoB,CACxC,gBAAwB;IAIxB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;QACpD,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AArCD,oDAqCC"}
package/build/es/src/data-v2-index-indexes.types.d.ts CHANGED
@@ -1,11 +1,17 @@
1
1
  /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
2
2
  export interface Index {
3
- /** Name of the index. */
3
+ /**
4
+ * Name of the index.
5
+ * @minLength 1
6
+ * @maxLength 128
7
+ */
4
8
  name?: string;
5
9
  /**
6
10
  * Fields for which the index is defined.
7
11
  *
8
12
  * Max: 3 fields (for a unique index: 1 field)
13
+ * @minSize 1
14
+ * @maxSize 3
9
15
  */
10
16
  fields?: Field[];
11
17
  /**
@@ -41,7 +47,11 @@ export declare enum Order {
41
47
  DESC = "DESC"
42
48
  }
43
49
  export interface Field {
44
- /** Path of the field to index. For example: `title` or `options.price`. */
50
+ /**
51
+ * Path of the field to index. For example: `title` or `options.price`.
52
+ * @minLength 1
53
+ * @maxLength 128
54
+ */
45
55
  path?: string;
46
56
  /**
47
57
  * Sort order for the index. Base on how the data is regularly queried.
@@ -72,25 +82,36 @@ export interface Failure {
72
82
  * - `WDE0112`: Unknown error while building collection index.
73
83
  * - `WDE0113`: Duplicate key error while building collection index.
74
84
  * - `WDE0114`: Document too large while building collection index.
85
+ * @maxLength 7
75
86
  */
76
87
  code?: string;
77
- /** Description of the failure. */
88
+ /**
89
+ * Description of the failure.
90
+ * @maxLength 1024
91
+ */
78
92
  description?: string;
79
93
  /**
80
94
  * ID of the data item that caused the failure.
81
95
  * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
96
+ * @maxLength 16000
82
97
  */
83
98
  itemId?: string | null;
84
99
  }
85
100
  export interface CreateIndexRequest {
86
101
  /** Details of the index to be created. */
87
102
  index: Index;
88
- /** ID of the data collection for which to generate the index. */
103
+ /**
104
+ * ID of the data collection for which to generate the index.
105
+ * @maxLength 256
106
+ */
89
107
  dataCollectionId: string;
90
108
  }
91
109
  export declare enum Environment {
110
+ /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
92
111
  LIVE = "LIVE",
112
+ /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
93
113
  SANDBOX = "SANDBOX",
114
+ /** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
94
115
  SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
95
116
  }
96
117
  export interface CreateIndexResponse {
@@ -98,15 +119,25 @@ export interface CreateIndexResponse {
98
119
  index?: Index;
99
120
  }
100
121
  export interface DropIndexRequest {
101
- /** Name of the index to drop. */
122
+ /**
123
+ * Name of the index to drop.
124
+ * @minLength 1
125
+ * @maxLength 128
126
+ */
102
127
  indexName: string;
103
- /** ID of the data collection for which the index to be dropped is defined. */
128
+ /**
129
+ * ID of the data collection for which the index to be dropped is defined.
130
+ * @maxLength 1024
131
+ */
104
132
  dataCollectionId: string;
105
133
  }
106
134
  export interface DropIndexResponse {
107
135
  }
108
136
  export interface ListIndexesRequest {
109
- /** ID of the data collection for which to list indexes. */
137
+ /**
138
+ * ID of the data collection for which to list indexes.
139
+ * @maxLength 1024
140
+ */
110
141
  dataCollectionId: string;
111
142
  /** Paging options to limit and skip the number of items. */
112
143
  paging?: Paging;
@@ -134,7 +165,10 @@ export interface PagingMetadata {
134
165
  tooManyToCount?: boolean | null;
135
166
  }
136
167
  export interface ListAvailableIndexesRequest {
137
- /** Data collection to show available indexes for */
168
+ /**
169
+ * Data collection to show available indexes for
170
+ * @maxLength 256
171
+ */
138
172
  dataCollectionId: string;
139
173
  }
140
174
  export interface ListAvailableIndexesResponse {
package/build/es/src/data-v2-index-indexes.types.js CHANGED
@@ -26,8 +26,11 @@ export var Status;
26
26
  })(Status || (Status = {}));
27
27
  export var Environment;
28
28
  (function (Environment) {
29
+ /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
29
30
  Environment["LIVE"] = "LIVE";
31
+ /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
30
32
  Environment["SANDBOX"] = "SANDBOX";
33
+ /** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
31
34
  Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
32
35
  })(Environment || (Environment = {}));
33
36
  //# sourceMappingURL=data-v2-index-indexes.types.js.map
package/build/es/src/data-v2-index-indexes.types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":"AAmCA;;;GAGG;AACH,MAAM,CAAN,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,KAAL,KAAK,QAGhB;AAaD,MAAM,CAAN,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,KAAN,MAAM,QAejB;AA0BD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;IACnB,sDAAuC,CAAA;AACzC,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB"}
1
+ {"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":"AAyCA;;;GAGG;AACH,MAAM,CAAN,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,KAAL,KAAK,QAGhB;AAiBD,MAAM,CAAN,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,KAAN,MAAM,QAejB;AAkCD,MAAM,CAAN,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,6IAA6I;IAC7I,4BAAa,CAAA;IACb,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,0SAA0S;IAC1S,sDAAuC,CAAA;AACzC,CAAC,EAPW,WAAW,KAAX,WAAW,QAOtB"}
package/build/es/src/data-v2-index-indexes.universal.d.ts CHANGED
@@ -1,11 +1,17 @@
1
1
  /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
2
2
  export interface Index {
3
- /** Name of the index. */
3
+ /**
4
+ * Name of the index.
5
+ * @minLength 1
6
+ * @maxLength 128
7
+ */
4
8
  name?: string;
5
9
  /**
6
10
  * Fields for which the index is defined.
7
11
  *
8
12
  * Max: 3 fields (for a unique index: 1 field)
13
+ * @minSize 1
14
+ * @maxSize 3
9
15
  */
10
16
  fields?: Field[];
11
17
  /**
@@ -41,7 +47,11 @@ export declare enum Order {
41
47
  DESC = "DESC"
42
48
  }
43
49
  export interface Field {
44
- /** Path of the field to index. For example: `title` or `options.price`. */
50
+ /**
51
+ * Path of the field to index. For example: `title` or `options.price`.
52
+ * @minLength 1
53
+ * @maxLength 128
54
+ */
45
55
  path?: string;
46
56
  /**
47
57
  * Sort order for the index. Base on how the data is regularly queried.
@@ -72,25 +82,36 @@ export interface Failure {
72
82
  * - `WDE0112`: Unknown error while building collection index.
73
83
  * - `WDE0113`: Duplicate key error while building collection index.
74
84
  * - `WDE0114`: Document too large while building collection index.
85
+ * @maxLength 7
75
86
  */
76
87
  code?: string;
77
- /** Description of the failure. */
88
+ /**
89
+ * Description of the failure.
90
+ * @maxLength 1024
91
+ */
78
92
  description?: string;
79
93
  /**
80
94
  * ID of the data item that caused the failure.
81
95
  * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
96
+ * @maxLength 16000
82
97
  */
83
98
  itemId?: string | null;
84
99
  }
85
100
  export interface CreateIndexRequest {
86
101
  /** Details of the index to be created. */
87
102
  index: Index;
88
- /** ID of the data collection for which to generate the index. */
103
+ /**
104
+ * ID of the data collection for which to generate the index.
105
+ * @maxLength 256
106
+ */
89
107
  dataCollectionId: string;
90
108
  }
91
109
  export declare enum Environment {
110
+ /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
92
111
  LIVE = "LIVE",
112
+ /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
93
113
  SANDBOX = "SANDBOX",
114
+ /** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
94
115
  SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
95
116
  }
96
117
  export interface CreateIndexResponse {
@@ -98,15 +119,25 @@ export interface CreateIndexResponse {
98
119
  index?: Index;
99
120
  }
100
121
  export interface DropIndexRequest {
101
- /** Name of the index to drop. */
122
+ /**
123
+ * Name of the index to drop.
124
+ * @minLength 1
125
+ * @maxLength 128
126
+ */
102
127
  indexName: string;
103
- /** ID of the data collection for which the index to be dropped is defined. */
128
+ /**
129
+ * ID of the data collection for which the index to be dropped is defined.
130
+ * @maxLength 1024
131
+ */
104
132
  dataCollectionId: string;
105
133
  }
106
134
  export interface DropIndexResponse {
107
135
  }
108
136
  export interface ListIndexesRequest {
109
- /** ID of the data collection for which to list indexes. */
137
+ /**
138
+ * ID of the data collection for which to list indexes.
139
+ * @maxLength 1024
140
+ */
110
141
  dataCollectionId: string;
111
142
  /** Paging options to limit and skip the number of items. */
112
143
  paging?: Paging;
@@ -134,7 +165,10 @@ export interface PagingMetadata {
134
165
  tooManyToCount?: boolean | null;
135
166
  }
136
167
  export interface ListAvailableIndexesRequest {
137
- /** Data collection to show available indexes for */
168
+ /**
169
+ * Data collection to show available indexes for
170
+ * @maxLength 256
171
+ */
138
172
  dataCollectionId: string;
139
173
  }
140
174
  export interface ListAvailableIndexesResponse {
@@ -198,6 +232,8 @@ export interface ListAvailableIndexesResponseNonNullableFields {
198
232
  * @permissionId WIX_DATA.CREATE_INDEX
199
233
  * @permissionScope Manage Data Indexes
200
234
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
235
+ * @permissionScope Manage All Data Resources
236
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
201
237
  * @applicableIdentity APP
202
238
  * @returns Details of the index being generated.
203
239
  * @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
@@ -217,6 +253,8 @@ export declare function createIndex(dataCollectionId: string, index: Index): Pro
217
253
  * @permissionId WIX_DATA.DROP_INDEX
218
254
  * @permissionScope Manage Data Indexes
219
255
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
256
+ * @permissionScope Manage All Data Resources
257
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
220
258
  * @applicableIdentity APP
221
259
  * @fqn com.wixpress.cloud.data.api.index.IndexService.DropIndex
222
260
  */
@@ -236,6 +274,8 @@ export declare function dropIndex(dataCollectionId: string, indexName: string):
236
274
  * @permissionId WIX_DATA.LIST_INDEXES
237
275
  * @permissionScope Manage Data Indexes
238
276
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
277
+ * @permissionScope Manage All Data Resources
278
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
239
279
  * @applicableIdentity APP
240
280
  * @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
241
281
  */
package/build/es/src/data-v2-index-indexes.universal.js CHANGED
@@ -29,8 +29,11 @@ export var Status;
29
29
  })(Status || (Status = {}));
30
30
  export var Environment;
31
31
  (function (Environment) {
32
+ /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
32
33
  Environment["LIVE"] = "LIVE";
34
+ /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
33
35
  Environment["SANDBOX"] = "SANDBOX";
36
+ /** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), run the task in the collection's sandbox environment. If not, run the task in the collection's live environment. */
34
37
  Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
35
38
  })(Environment || (Environment = {}));
36
39
  /**
@@ -53,6 +56,8 @@ export var Environment;
53
56
  * @permissionId WIX_DATA.CREATE_INDEX
54
57
  * @permissionScope Manage Data Indexes
55
58
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
59
+ * @permissionScope Manage All Data Resources
60
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
56
61
  * @applicableIdentity APP
57
62
  * @returns Details of the index being generated.
58
63
  * @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
@@ -95,6 +100,8 @@ export async function createIndex(dataCollectionId, index) {
95
100
  * @permissionId WIX_DATA.DROP_INDEX
96
101
  * @permissionScope Manage Data Indexes
97
102
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
103
+ * @permissionScope Manage All Data Resources
104
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
98
105
  * @applicableIdentity APP
99
106
  * @fqn com.wixpress.cloud.data.api.index.IndexService.DropIndex
100
107
  */
@@ -139,6 +146,8 @@ export async function dropIndex(dataCollectionId, indexName) {
139
146
  * @permissionId WIX_DATA.LIST_INDEXES
140
147
  * @permissionScope Manage Data Indexes
141
148
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
149
+ * @permissionScope Manage All Data Resources
150
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
142
151
  * @applicableIdentity APP
143
152
  * @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
144
153
  */
@@ -178,6 +187,8 @@ export async function listIndexes(dataCollectionId, options) {
178
187
  * @permissionId WIX_DATA.LIST_INDEXES
179
188
  * @permissionScope Manage Data Indexes
180
189
  * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
190
+ * @permissionScope Manage All Data Resources
191
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
181
192
  * @applicableIdentity APP
182
193
  * @fqn com.wixpress.cloud.data.api.index.IndexService.ListAvailableIndexes
183
194
  */