@wix/auto_sdk_data_indexes 1.0.8 → 1.0.9

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 (130) hide show
  1. package/build/{es/src/data-v2-index-indexes.types.d.ts → data-v2-index-indexes.universal-BbNMyDRQ.d.mts} +26 -22
  2. package/build/{cjs/src/data-v2-index-indexes.types.d.ts → data-v2-index-indexes.universal-BbNMyDRQ.d.ts} +26 -22
  3. package/build/{es/src/data-v2-index-indexes.public.d.ts → index.d.mts} +13 -9
  4. package/build/{internal/cjs/src/data-v2-index-indexes.public.d.ts → index.d.ts} +13 -18
  5. package/build/index.js +629 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +598 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/data-v2-index-indexes.types.d.ts → data-v2-index-indexes.universal-DRs6_tQv.d.mts} +26 -22
  10. package/build/internal/{es/src/data-v2-index-indexes.types.d.ts → data-v2-index-indexes.universal-DRs6_tQv.d.ts} +26 -22
  11. package/build/{cjs/src/data-v2-index-indexes.public.d.ts → internal/index.d.mts} +24 -9
  12. package/build/internal/{es/src/data-v2-index-indexes.public.d.ts → index.d.ts} +16 -10
  13. package/build/internal/index.js +629 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +598 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +215 -0
  18. package/build/internal/meta.d.ts +215 -0
  19. package/build/internal/meta.js +512 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +482 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +215 -0
  24. package/build/meta.d.ts +215 -0
  25. package/build/meta.js +512 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +482 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/data-v2-index-indexes.context.d.ts +0 -7
  40. package/build/cjs/src/data-v2-index-indexes.context.js +0 -16
  41. package/build/cjs/src/data-v2-index-indexes.context.js.map +0 -1
  42. package/build/cjs/src/data-v2-index-indexes.http.d.ts +0 -30
  43. package/build/cjs/src/data-v2-index-indexes.http.js +0 -433
  44. package/build/cjs/src/data-v2-index-indexes.http.js.map +0 -1
  45. package/build/cjs/src/data-v2-index-indexes.meta.d.ts +0 -16
  46. package/build/cjs/src/data-v2-index-indexes.meta.js +0 -104
  47. package/build/cjs/src/data-v2-index-indexes.meta.js.map +0 -1
  48. package/build/cjs/src/data-v2-index-indexes.public.js +0 -36
  49. package/build/cjs/src/data-v2-index-indexes.public.js.map +0 -1
  50. package/build/cjs/src/data-v2-index-indexes.types.js +0 -52
  51. package/build/cjs/src/data-v2-index-indexes.types.js.map +0 -1
  52. package/build/cjs/src/data-v2-index-indexes.universal.d.ts +0 -285
  53. package/build/cjs/src/data-v2-index-indexes.universal.js +0 -261
  54. package/build/cjs/src/data-v2-index-indexes.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/data-v2-index-indexes.context.d.ts +0 -7
  66. package/build/es/src/data-v2-index-indexes.context.js +0 -9
  67. package/build/es/src/data-v2-index-indexes.context.js.map +0 -1
  68. package/build/es/src/data-v2-index-indexes.http.d.ts +0 -30
  69. package/build/es/src/data-v2-index-indexes.http.js +0 -426
  70. package/build/es/src/data-v2-index-indexes.http.js.map +0 -1
  71. package/build/es/src/data-v2-index-indexes.meta.d.ts +0 -16
  72. package/build/es/src/data-v2-index-indexes.meta.js +0 -74
  73. package/build/es/src/data-v2-index-indexes.meta.js.map +0 -1
  74. package/build/es/src/data-v2-index-indexes.public.js +0 -25
  75. package/build/es/src/data-v2-index-indexes.public.js.map +0 -1
  76. package/build/es/src/data-v2-index-indexes.types.js +0 -49
  77. package/build/es/src/data-v2-index-indexes.types.js.map +0 -1
  78. package/build/es/src/data-v2-index-indexes.universal.d.ts +0 -285
  79. package/build/es/src/data-v2-index-indexes.universal.js +0 -231
  80. package/build/es/src/data-v2-index-indexes.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/data-v2-index-indexes.context.d.ts +0 -9
  91. package/build/internal/cjs/src/data-v2-index-indexes.context.js +0 -16
  92. package/build/internal/cjs/src/data-v2-index-indexes.context.js.map +0 -1
  93. package/build/internal/cjs/src/data-v2-index-indexes.http.d.ts +0 -30
  94. package/build/internal/cjs/src/data-v2-index-indexes.http.js +0 -433
  95. package/build/internal/cjs/src/data-v2-index-indexes.http.js.map +0 -1
  96. package/build/internal/cjs/src/data-v2-index-indexes.meta.d.ts +0 -16
  97. package/build/internal/cjs/src/data-v2-index-indexes.meta.js +0 -104
  98. package/build/internal/cjs/src/data-v2-index-indexes.meta.js.map +0 -1
  99. package/build/internal/cjs/src/data-v2-index-indexes.public.js +0 -36
  100. package/build/internal/cjs/src/data-v2-index-indexes.public.js.map +0 -1
  101. package/build/internal/cjs/src/data-v2-index-indexes.types.js +0 -52
  102. package/build/internal/cjs/src/data-v2-index-indexes.types.js.map +0 -1
  103. package/build/internal/cjs/src/data-v2-index-indexes.universal.d.ts +0 -300
  104. package/build/internal/cjs/src/data-v2-index-indexes.universal.js +0 -261
  105. package/build/internal/cjs/src/data-v2-index-indexes.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/data-v2-index-indexes.context.d.ts +0 -9
  116. package/build/internal/es/src/data-v2-index-indexes.context.js +0 -9
  117. package/build/internal/es/src/data-v2-index-indexes.context.js.map +0 -1
  118. package/build/internal/es/src/data-v2-index-indexes.http.d.ts +0 -30
  119. package/build/internal/es/src/data-v2-index-indexes.http.js +0 -426
  120. package/build/internal/es/src/data-v2-index-indexes.http.js.map +0 -1
  121. package/build/internal/es/src/data-v2-index-indexes.meta.d.ts +0 -16
  122. package/build/internal/es/src/data-v2-index-indexes.meta.js +0 -74
  123. package/build/internal/es/src/data-v2-index-indexes.meta.js.map +0 -1
  124. package/build/internal/es/src/data-v2-index-indexes.public.js +0 -25
  125. package/build/internal/es/src/data-v2-index-indexes.public.js.map +0 -1
  126. package/build/internal/es/src/data-v2-index-indexes.types.js +0 -49
  127. package/build/internal/es/src/data-v2-index-indexes.types.js.map +0 -1
  128. package/build/internal/es/src/data-v2-index-indexes.universal.d.ts +0 -300
  129. package/build/internal/es/src/data-v2-index-indexes.universal.js +0 -231
  130. package/build/internal/es/src/data-v2-index-indexes.universal.js.map +0 -1
@@ -1,300 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
3
- export interface Index {
4
- /**
5
- * Name of the index.
6
- * @minLength 1
7
- * @maxLength 128
8
- */
9
- name?: string;
10
- /**
11
- * Fields for which the index is defined.
12
- *
13
- * Max: 3 fields (for a unique index: 1 field)
14
- * @minSize 1
15
- * @maxSize 3
16
- */
17
- fields?: Field[];
18
- /**
19
- * Current status of the index.
20
- * @readonly
21
- */
22
- status?: StatusWithLiterals;
23
- /**
24
- * Contains details about the reasons for failure when `status` is `FAILED`.
25
- * @readonly
26
- */
27
- failure?: Failure;
28
- /**
29
- * Whether the index enforces uniqueness of values in the field for which it is defined.
30
- * If `true`, the index can have only one field.
31
- *
32
- * Default: `false`
33
- */
34
- unique?: boolean;
35
- /**
36
- * Whether the index ignores case.
37
- *
38
- * Default: `false`
39
- */
40
- caseInsensitive?: boolean;
41
- /** Specifies the origin of the index definition. */
42
- source?: IndexSourceWithLiterals;
43
- }
44
- /**
45
- * Order determines how values are ordered in the index. This is important when
46
- * ordering and/or range querying by indexed fields.
47
- */
48
- export declare enum Order {
49
- ASC = "ASC",
50
- DESC = "DESC"
51
- }
52
- /** @enumType */
53
- export type OrderWithLiterals = Order | 'ASC' | 'DESC';
54
- export interface Field {
55
- /**
56
- * Path of the field to index. For example: `title` or `options.price`.
57
- * @minLength 1
58
- * @maxLength 128
59
- */
60
- path?: string;
61
- /**
62
- * Sort order for the index. Base on how the data is regularly queried.
63
- *
64
- * Default: `ASC`
65
- */
66
- order?: OrderWithLiterals;
67
- }
68
- export declare enum Status {
69
- /** Place holder. Never returned by the service. */
70
- UNKNOWN = "UNKNOWN",
71
- /** Index creation is in progress. */
72
- BUILDING = "BUILDING",
73
- /** Index has been successfully created and can be used in queries. */
74
- ACTIVE = "ACTIVE",
75
- /** Index is in the process of being dropped. */
76
- DROPPING = "DROPPING",
77
- /** Index has been dropped successfully. */
78
- DROPPED = "DROPPED",
79
- /** Index creation has failed. */
80
- FAILED = "FAILED",
81
- /** Index contains incorrectly indexed data. */
82
- INVALID = "INVALID"
83
- }
84
- /** @enumType */
85
- export type StatusWithLiterals = Status | 'UNKNOWN' | 'BUILDING' | 'ACTIVE' | 'DROPPING' | 'DROPPED' | 'FAILED' | 'INVALID';
86
- export interface Failure {
87
- /**
88
- * Error code.
89
- * - `WDE0112`: Unknown error while building collection index.
90
- * - `WDE0113`: Duplicate key error while building collection index.
91
- * - `WDE0114`: Document too large while building collection index.
92
- * @maxLength 7
93
- */
94
- code?: string;
95
- /**
96
- * Description of the failure.
97
- * @maxLength 1024
98
- */
99
- description?: string;
100
- /**
101
- * ID of the data item that caused the failure.
102
- * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
103
- * @maxLength 16000
104
- */
105
- itemId?: string | null;
106
- }
107
- export declare enum IndexSource {
108
- /** Place holder. Never returned by the service. */
109
- UNKNOWN_INDEX_SOURCE = "UNKNOWN_INDEX_SOURCE",
110
- /** Index is created by the system, present for all collections. */
111
- SYSTEM = "SYSTEM",
112
- /** Index was created by a user via API or UI. */
113
- USER = "USER",
114
- /** Index is created automatically by the system based on user queries. */
115
- AUTO = "AUTO"
116
- }
117
- /** @enumType */
118
- export type IndexSourceWithLiterals = IndexSource | 'UNKNOWN_INDEX_SOURCE' | 'SYSTEM' | 'USER' | 'AUTO';
119
- export interface CreateIndexRequest {
120
- /** Details of the index to be created. */
121
- index: Index;
122
- /**
123
- * ID of the data collection for which to generate the index.
124
- * @maxLength 256
125
- */
126
- dataCollectionId: string;
127
- }
128
- export declare enum Environment {
129
- /** Place holder. Never returned by the service. */
130
- UNKNOWN_ENVIRONMENT = "UNKNOWN_ENVIRONMENT",
131
- /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
132
- SANDBOX = "SANDBOX",
133
- /** 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. */
134
- SANDBOX_PREFERRED = "SANDBOX_PREFERRED",
135
- /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
136
- LIVE = "LIVE"
137
- }
138
- /** @enumType */
139
- export type EnvironmentWithLiterals = Environment | 'UNKNOWN_ENVIRONMENT' | 'SANDBOX' | 'SANDBOX_PREFERRED' | 'LIVE';
140
- export interface CreateIndexResponse {
141
- /** Details of the index being generated. */
142
- index?: Index;
143
- }
144
- export interface DropIndexRequest {
145
- /**
146
- * Name of the index to drop.
147
- * @minLength 1
148
- * @maxLength 128
149
- */
150
- indexName: string;
151
- /**
152
- * ID of the data collection for which the index to be dropped is defined.
153
- * @maxLength 1024
154
- */
155
- dataCollectionId: string;
156
- }
157
- export interface DropIndexResponse {
158
- }
159
- export interface ListIndexesRequest {
160
- /**
161
- * ID of the data collection for which to list indexes.
162
- * @maxLength 1024
163
- */
164
- dataCollectionId: string;
165
- /** Paging options to limit and skip the number of items. */
166
- paging?: Paging;
167
- }
168
- export interface Paging {
169
- /** Number of items to load. */
170
- limit?: number | null;
171
- /** Number of items to skip in the current sort order. */
172
- offset?: number | null;
173
- }
174
- export interface ListIndexesResponse {
175
- /** List of all indexes for the requested data collection. */
176
- indexes?: Index[];
177
- /** Paging metadata. */
178
- pagingMetadata?: PagingMetadata;
179
- }
180
- export interface PagingMetadata {
181
- /** Number of items returned in the response. */
182
- count?: number | null;
183
- /** Offset that was requested. */
184
- offset?: number | null;
185
- /** Total number of items that match the query. */
186
- total?: number | null;
187
- /** Flag that indicates the server failed to calculate the `total` field. */
188
- tooManyToCount?: boolean | null;
189
- }
190
- export interface ListAvailableIndexesRequest {
191
- /**
192
- * Data collection to show available indexes for
193
- * @maxLength 256
194
- */
195
- dataCollectionId: string;
196
- }
197
- export interface ListAvailableIndexesResponse {
198
- /**
199
- * limit of regular single-field indexes, even if 0 1-field indices may be created using
200
- * 3-field quota (if available)
201
- */
202
- regular1Field?: number;
203
- /** limit of regular indexes up to 3-fields (in addition to 1-field indexes quota) */
204
- regular3Field?: number;
205
- /** limit of unique indexes */
206
- unique1Field?: number;
207
- /** Overall index limit, missing value means there's no overall limit */
208
- total?: number | null;
209
- }
210
- type IndexNonNullablePaths = `name` | `fields` | `fields.${number}.path` | `fields.${number}.order` | `status` | `failure.code` | `failure.description` | `unique` | `caseInsensitive` | `source`;
211
- /**
212
- * Creates an index for a data collection.
213
- *
214
- * The index can't be used immediately, as the process of generating the index takes time.
215
- * You can check whether an index is ready by calling List Indexes.
216
- *
217
- * Note that when an index fails to create, the failed index still occupies a slot.
218
- * To remove the failed index and free up the slot for a new index, call Drop Index.
219
- * @param dataCollectionId - ID of the data collection for which to generate the index.
220
- * @param index - Details of the index to be created.
221
- * @public
222
- * @requiredField dataCollectionId
223
- * @requiredField index
224
- * @requiredField index.fields
225
- * @requiredField index.fields.path
226
- * @requiredField index.name
227
- * @param options - Options for creating an index.
228
- * @permissionId WIX_DATA.CREATE_INDEX
229
- * @permissionScope Manage Data Indexes
230
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
231
- * @permissionScope Manage All Data Resources
232
- * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
233
- * @applicableIdentity APP
234
- * @returns Details of the index being generated.
235
- * @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
236
- */
237
- export declare function createIndex(dataCollectionId: string, index: NonNullablePaths<Index, `fields` | `fields.${number}.path` | `name`>): Promise<NonNullablePaths<Index, IndexNonNullablePaths>>;
238
- /**
239
- * Removes an index from a data collection.
240
- *
241
- * The process of dropping an index from a collection takes time.
242
- * You can check whether an index has been dropped by calling List Indexes.
243
- * @param dataCollectionId - ID of the data collection for which the index to be dropped is defined.
244
- * @param indexName - Name of the index to drop.
245
- * @public
246
- * @requiredField dataCollectionId
247
- * @requiredField indexName
248
- * @param options - Options for dropping an index.
249
- * @permissionId WIX_DATA.DROP_INDEX
250
- * @permissionScope Manage Data Indexes
251
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
252
- * @permissionScope Manage All Data Resources
253
- * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
254
- * @applicableIdentity APP
255
- * @fqn com.wixpress.cloud.data.api.index.IndexService.DropIndex
256
- */
257
- export declare function dropIndex(dataCollectionId: string, indexName: string): Promise<void>;
258
- /**
259
- * Lists all indexes defined for a data collection.
260
- *
261
- * When an index's status is `ACTIVE`, it is ready to use.
262
- * While it is still being created, its status is `BUILDING`.
263
- *
264
- * When an index's status is `DROPPED`, it has been dropped successfully.
265
- * While it is still in the process of being removed, its status is `DROPPING`.
266
- * @param dataCollectionId - ID of the data collection for which to list indexes.
267
- * @public
268
- * @requiredField dataCollectionId
269
- * @param options - Options for retrieving a list of indexes.
270
- * @permissionId WIX_DATA.LIST_INDEXES
271
- * @permissionScope Manage Data Indexes
272
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
273
- * @permissionScope Manage All Data Resources
274
- * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
275
- * @applicableIdentity APP
276
- * @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
277
- */
278
- export declare function listIndexes(dataCollectionId: string, options?: ListIndexesOptions): Promise<NonNullablePaths<ListIndexesResponse, {
279
- [P in IndexNonNullablePaths]: `indexes.${number}.${P}`;
280
- }[IndexNonNullablePaths]>>;
281
- export interface ListIndexesOptions {
282
- /** Paging options to limit and skip the number of items. */
283
- paging?: Paging;
284
- }
285
- /**
286
- * Lists available indexes limits
287
- * @param dataCollectionId - Data collection to show available indexes for
288
- * @internal
289
- * @documentationMaturity preview
290
- * @requiredField dataCollectionId
291
- * @permissionId WIX_DATA.LIST_INDEXES
292
- * @permissionScope Manage Data Indexes
293
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
294
- * @permissionScope Manage All Data Resources
295
- * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
296
- * @applicableIdentity APP
297
- * @fqn com.wixpress.cloud.data.api.index.IndexService.ListAvailableIndexes
298
- */
299
- export declare function listAvailableIndexes(dataCollectionId: string): Promise<NonNullablePaths<ListAvailableIndexesResponse, `regular1Field` | `regular3Field` | `unique1Field`>>;
300
- export {};
@@ -1,231 +0,0 @@
1
- import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
- import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
3
- import * as ambassadorWixDataV2Index from './data-v2-index-indexes.http.js';
4
- /**
5
- * Order determines how values are ordered in the index. This is important when
6
- * ordering and/or range querying by indexed fields.
7
- */
8
- export var Order;
9
- (function (Order) {
10
- Order["ASC"] = "ASC";
11
- Order["DESC"] = "DESC";
12
- })(Order || (Order = {}));
13
- export var Status;
14
- (function (Status) {
15
- /** Place holder. Never returned by the service. */
16
- Status["UNKNOWN"] = "UNKNOWN";
17
- /** Index creation is in progress. */
18
- Status["BUILDING"] = "BUILDING";
19
- /** Index has been successfully created and can be used in queries. */
20
- Status["ACTIVE"] = "ACTIVE";
21
- /** Index is in the process of being dropped. */
22
- Status["DROPPING"] = "DROPPING";
23
- /** Index has been dropped successfully. */
24
- Status["DROPPED"] = "DROPPED";
25
- /** Index creation has failed. */
26
- Status["FAILED"] = "FAILED";
27
- /** Index contains incorrectly indexed data. */
28
- Status["INVALID"] = "INVALID";
29
- })(Status || (Status = {}));
30
- export var IndexSource;
31
- (function (IndexSource) {
32
- /** Place holder. Never returned by the service. */
33
- IndexSource["UNKNOWN_INDEX_SOURCE"] = "UNKNOWN_INDEX_SOURCE";
34
- /** Index is created by the system, present for all collections. */
35
- IndexSource["SYSTEM"] = "SYSTEM";
36
- /** Index was created by a user via API or UI. */
37
- IndexSource["USER"] = "USER";
38
- /** Index is created automatically by the system based on user queries. */
39
- IndexSource["AUTO"] = "AUTO";
40
- })(IndexSource || (IndexSource = {}));
41
- export var Environment;
42
- (function (Environment) {
43
- /** Place holder. Never returned by the service. */
44
- Environment["UNKNOWN_ENVIRONMENT"] = "UNKNOWN_ENVIRONMENT";
45
- /** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
46
- Environment["SANDBOX"] = "SANDBOX";
47
- /** 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. */
48
- Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
49
- /** Collection [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
50
- Environment["LIVE"] = "LIVE";
51
- })(Environment || (Environment = {}));
52
- /**
53
- * Creates an index for a data collection.
54
- *
55
- * The index can't be used immediately, as the process of generating the index takes time.
56
- * You can check whether an index is ready by calling List Indexes.
57
- *
58
- * Note that when an index fails to create, the failed index still occupies a slot.
59
- * To remove the failed index and free up the slot for a new index, call Drop Index.
60
- * @param dataCollectionId - ID of the data collection for which to generate the index.
61
- * @param index - Details of the index to be created.
62
- * @public
63
- * @requiredField dataCollectionId
64
- * @requiredField index
65
- * @requiredField index.fields
66
- * @requiredField index.fields.path
67
- * @requiredField index.name
68
- * @param options - Options for creating an index.
69
- * @permissionId WIX_DATA.CREATE_INDEX
70
- * @permissionScope Manage Data Indexes
71
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
72
- * @permissionScope Manage All Data Resources
73
- * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
74
- * @applicableIdentity APP
75
- * @returns Details of the index being generated.
76
- * @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
77
- */
78
- export async function createIndex(dataCollectionId, index) {
79
- // @ts-ignore
80
- const { httpClient, sideEffects } = arguments[2];
81
- const payload = renameKeysFromSDKRequestToRESTRequest({
82
- dataCollectionId: dataCollectionId,
83
- index: index,
84
- });
85
- const reqOpts = ambassadorWixDataV2Index.createIndex(payload);
86
- sideEffects?.onSiteCall?.();
87
- try {
88
- const result = await httpClient.request(reqOpts);
89
- sideEffects?.onSuccess?.(result);
90
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.index;
91
- }
92
- catch (err) {
93
- const transformedError = sdkTransformError(err, {
94
- spreadPathsToArguments: {},
95
- explicitPathsToArguments: { dataCollectionId: '$[0]', index: '$[1]' },
96
- singleArgumentUnchanged: false,
97
- }, ['dataCollectionId', 'index']);
98
- sideEffects?.onError?.(err);
99
- throw transformedError;
100
- }
101
- }
102
- /**
103
- * Removes an index from a data collection.
104
- *
105
- * The process of dropping an index from a collection takes time.
106
- * You can check whether an index has been dropped by calling List Indexes.
107
- * @param dataCollectionId - ID of the data collection for which the index to be dropped is defined.
108
- * @param indexName - Name of the index to drop.
109
- * @public
110
- * @requiredField dataCollectionId
111
- * @requiredField indexName
112
- * @param options - Options for dropping an index.
113
- * @permissionId WIX_DATA.DROP_INDEX
114
- * @permissionScope Manage Data Indexes
115
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
116
- * @permissionScope Manage All Data Resources
117
- * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
118
- * @applicableIdentity APP
119
- * @fqn com.wixpress.cloud.data.api.index.IndexService.DropIndex
120
- */
121
- export async function dropIndex(dataCollectionId, indexName) {
122
- // @ts-ignore
123
- const { httpClient, sideEffects } = arguments[2];
124
- const payload = renameKeysFromSDKRequestToRESTRequest({
125
- dataCollectionId: dataCollectionId,
126
- indexName: indexName,
127
- });
128
- const reqOpts = ambassadorWixDataV2Index.dropIndex(payload);
129
- sideEffects?.onSiteCall?.();
130
- try {
131
- const result = await httpClient.request(reqOpts);
132
- sideEffects?.onSuccess?.(result);
133
- }
134
- catch (err) {
135
- const transformedError = sdkTransformError(err, {
136
- spreadPathsToArguments: {},
137
- explicitPathsToArguments: {
138
- dataCollectionId: '$[0]',
139
- indexName: '$[1]',
140
- },
141
- singleArgumentUnchanged: false,
142
- }, ['dataCollectionId', 'indexName']);
143
- sideEffects?.onError?.(err);
144
- throw transformedError;
145
- }
146
- }
147
- /**
148
- * Lists all indexes defined for a data collection.
149
- *
150
- * When an index's status is `ACTIVE`, it is ready to use.
151
- * While it is still being created, its status is `BUILDING`.
152
- *
153
- * When an index's status is `DROPPED`, it has been dropped successfully.
154
- * While it is still in the process of being removed, its status is `DROPPING`.
155
- * @param dataCollectionId - ID of the data collection for which to list indexes.
156
- * @public
157
- * @requiredField dataCollectionId
158
- * @param options - Options for retrieving a list of indexes.
159
- * @permissionId WIX_DATA.LIST_INDEXES
160
- * @permissionScope Manage Data Indexes
161
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
162
- * @permissionScope Manage All Data Resources
163
- * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
164
- * @applicableIdentity APP
165
- * @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
166
- */
167
- export async function listIndexes(dataCollectionId, options) {
168
- // @ts-ignore
169
- const { httpClient, sideEffects } = arguments[2];
170
- const payload = renameKeysFromSDKRequestToRESTRequest({
171
- dataCollectionId: dataCollectionId,
172
- paging: options?.paging,
173
- });
174
- const reqOpts = ambassadorWixDataV2Index.listIndexes(payload);
175
- sideEffects?.onSiteCall?.();
176
- try {
177
- const result = await httpClient.request(reqOpts);
178
- sideEffects?.onSuccess?.(result);
179
- return renameKeysFromRESTResponseToSDKResponse(result.data);
180
- }
181
- catch (err) {
182
- const transformedError = sdkTransformError(err, {
183
- spreadPathsToArguments: {},
184
- explicitPathsToArguments: {
185
- dataCollectionId: '$[0]',
186
- paging: '$[1].paging',
187
- },
188
- singleArgumentUnchanged: false,
189
- }, ['dataCollectionId', 'options']);
190
- sideEffects?.onError?.(err);
191
- throw transformedError;
192
- }
193
- }
194
- /**
195
- * Lists available indexes limits
196
- * @param dataCollectionId - Data collection to show available indexes for
197
- * @internal
198
- * @documentationMaturity preview
199
- * @requiredField dataCollectionId
200
- * @permissionId WIX_DATA.LIST_INDEXES
201
- * @permissionScope Manage Data Indexes
202
- * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
203
- * @permissionScope Manage All Data Resources
204
- * @permissionScopeId SCOPE.DC-DATA.MANAGE-ALL
205
- * @applicableIdentity APP
206
- * @fqn com.wixpress.cloud.data.api.index.IndexService.ListAvailableIndexes
207
- */
208
- export async function listAvailableIndexes(dataCollectionId) {
209
- // @ts-ignore
210
- const { httpClient, sideEffects } = arguments[1];
211
- const payload = renameKeysFromSDKRequestToRESTRequest({
212
- dataCollectionId: dataCollectionId,
213
- });
214
- const reqOpts = ambassadorWixDataV2Index.listAvailableIndexes(payload);
215
- sideEffects?.onSiteCall?.();
216
- try {
217
- const result = await httpClient.request(reqOpts);
218
- sideEffects?.onSuccess?.(result);
219
- return renameKeysFromRESTResponseToSDKResponse(result.data);
220
- }
221
- catch (err) {
222
- const transformedError = sdkTransformError(err, {
223
- spreadPathsToArguments: {},
224
- explicitPathsToArguments: { dataCollectionId: '$[0]' },
225
- singleArgumentUnchanged: false,
226
- }, ['dataCollectionId']);
227
- sideEffects?.onError?.(err);
228
- throw transformedError;
229
- }
230
- }
231
- //# sourceMappingURL=data-v2-index-indexes.universal.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"data-v2-index-indexes.universal.js","sourceRoot":"","sources":["../../../../src/data-v2-index-indexes.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,wBAAwB,MAAM,iCAAiC,CAAC;AA6C5E;;;GAGG;AACH,MAAM,CAAN,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,KAAL,KAAK,QAGhB;AAoBD,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;AAmCD,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,mDAAmD;IACnD,4DAA6C,CAAA;IAC7C,mEAAmE;IACnE,gCAAiB,CAAA;IACjB,iDAAiD;IACjD,4BAAa,CAAA;IACb,0EAA0E;IAC1E,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAoBD,MAAM,CAAN,IAAY,WASX;AATD,WAAY,WAAW;IACrB,mDAAmD;IACnD,0DAA2C,CAAA;IAC3C,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,0SAA0S;IAC1S,sDAAuC,CAAA;IACvC,6IAA6I;IAC7I,4BAAa,CAAA;AACf,CAAC,EATW,WAAW,KAAX,WAAW,QAStB;AAoGD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,gBAAwB,EACxB,KAA2E;IAE3E,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;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,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAM,CAAC;IACtE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,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;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,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,qCAAqC,CAAC;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,iBAAiB,CACxC,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;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,gBAAwB,EACxB,OAA4B;IAS5B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;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,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,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;AAOD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,gBAAwB;IAOxB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;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,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,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"}