@wix/wix-data-items-common 1.0.78 → 1.0.79
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api/WixDataAggregate.js.map +1 -1
- package/dist/cjs/api/WixDataFilter.js.map +1 -1
- package/dist/cjs/api/WixDataQuery.js.map +1 -1
- package/dist/cjs/api/WixDataResult.js.map +1 -1
- package/dist/cjs/api/types.js.map +1 -1
- package/dist/cjs/types/data-item-types.js.map +1 -1
- package/dist/esm/types/data-item-types.js.map +1 -1
- package/dist/types/api/WixDataAggregate.d.ts +10 -12
- package/dist/types/api/WixDataAggregate.d.ts.map +1 -1
- package/dist/types/api/WixDataFilter.d.ts +3 -5
- package/dist/types/api/WixDataFilter.d.ts.map +1 -1
- package/dist/types/api/WixDataQuery.d.ts +12 -17
- package/dist/types/api/WixDataQuery.d.ts.map +1 -1
- package/dist/types/api/WixDataResult.d.ts +2 -2
- package/dist/types/api/types.d.ts +13 -18
- package/dist/types/api/types.d.ts.map +1 -1
- package/dist/types/types/data-item-types.d.ts +48 -49
- package/dist/types/types/data-item-types.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["Environment","exports","ACTION","BulkActionType","Action","SortOrder"],"sources":["../../../src/types/data-item-types.ts"],"sourcesContent":["export interface DataItem {\n /** Data item ID. */\n id?: string\n /**\n * ID of the collection this item belongs to\n * @readonly\n */\n dataCollectionId?: string\n /**\n * Data item contents.\n *\n * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:\n *\n * + `_id`: Item ID.\n * + `_createdDate`: Date and time the item was added to the collection.\n * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.\n * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.\n */\n data?: Record<string, any> | null\n}\n\nexport interface InsertDataItemRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert the item. */\n dataCollectionId: string\n /** Item to insert. */\n dataItem: DataItem\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * If true, referenced items will be included.\n * @internal\n */\n includeReferencedItems?: boolean\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport enum Environment {\n LIVE = 'LIVE',\n SANDBOX = 'SANDBOX',\n SANDBOX_PREFERRED = 'SANDBOX_PREFERRED',\n}\n\nexport interface Options {\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: PublishPluginOptions\n}\n\nexport interface PublishPluginOptions {\n showDraftItems?: boolean\n}\n\nexport interface InsertDataItemResponse {\n /** Inserted data item. */\n dataItem?: DataItem\n}\n\nexport interface PatchDataItemRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the existing item. */\n dataCollectionId: string\n /** Patch set applied during item update. */\n patchSet: PatchSet\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface PatchSet {\n /** Data item ID. */\n dataItemId?: string\n /** Set of field updates to be applied */\n fieldUpdates?: FieldUpdate[]\n}\n\nexport interface FieldUpdate extends FieldUpdateActionOptionsOneOf {\n setField?: SetField\n incrementField?: IncrementField\n appendToArray?: AppendToArray\n removeFromArray?: RemoveFromArray\n /** Field key to be patched. For ex \"title\", \"address.street\" */\n fieldPath?: string\n /** Action to be applied */\n action?: ACTION\n}\n\n/** @oneof */\nexport interface FieldUpdateActionOptionsOneOf {\n setField?: SetField\n incrementField?: IncrementField\n appendToArray?: AppendToArray\n removeFromArray?: RemoveFromArray\n}\n\nexport enum ACTION {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n SET_FIELD = 'SET_FIELD',\n REMOVE_FIELD = 'REMOVE_FIELD',\n INCREMENT_FIELD = 'INCREMENT_FIELD',\n APPEND_TO_ARRAY = 'APPEND_TO_ARRAY',\n REMOVE_FROM_ARRAY = 'REMOVE_FROM_ARRAY',\n}\n\nexport interface SetField {\n value?: any\n}\n\nexport interface IncrementField {\n value?: number\n}\n\nexport interface AppendToArray {\n value?: any\n}\n\nexport interface RemoveFromArray {\n value?: any\n}\n\nexport interface DataPublishPluginOptions {\n includeDraftItems?: boolean\n}\n\nexport interface PatchDataItemResponse {\n /** Updated data item. */\n dataItem?: DataItem\n}\n\nexport interface BulkPatchDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to update items. */\n dataCollectionId: string\n /** Patch sets to apply. */\n patchSets: PatchSet[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the updated data items.\n * When `true`, the `results` objects contain a `dataItem` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface BulkPatchDataItemsResponse {\n /** Information about the updated items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkDataItemResult {\n /** The action attempted for the data item. */\n action?: BulkActionType\n /** Metadata related to the data item for which the action was attempted. */\n itemMetadata?: ItemMetadata\n /** The data item for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */\n dataItem?: DataItem\n}\n\nexport enum BulkActionType {\n UNKNOWN_ACTION_TYPE = 'UNKNOWN_ACTION_TYPE',\n INSERT = 'INSERT',\n UPDATE = 'UPDATE',\n DELETE = 'DELETE',\n PATCH = 'PATCH',\n}\n\nexport interface ItemMetadata {\n /** Item ID. This field doesn't appear if there is no item ID, for example, when item creation fails. */\n id?: string | null\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean\n /** Details about the error in case of failure. */\n error?: ApplicationError\n}\n\nexport interface ApplicationError {\n /** Error code. */\n code?: string\n /** Description of the error. */\n description?: string\n /** Data related to the error. */\n data?: Record<string, any> | null\n}\n\nexport interface BulkActionMetadata {\n /** Number of items successfully processed. */\n totalSuccesses?: number\n /** Number of items that couldn't be processed. */\n totalFailures?: number\n}\n\nexport interface UpdateDataItemRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the existing item. */\n dataCollectionId: string\n /** Updated data item content. The existing data item's content is replaced entirely. */\n dataItem: DataItem\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * If true, referenced items will be included.\n * @internal\n */\n includeReferencedItems?: boolean\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface UpdateDataItemResponse {\n /** Updated data item. */\n dataItem?: DataItem\n}\n\nexport interface SaveDataItemRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert or update the item. */\n dataCollectionId: string\n /** Data item to insert or update. */\n dataItem: DataItem\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * If true, referenced items will be included.\n * @internal\n */\n includeReferencedItems?: boolean\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface SaveDataItemResponse {\n /**\n * The action carried out for the item.\n *\n * + `INSERTED`: A new item was added to the collection.\n * + `UPDATED`: An existing item in the collection was updated.\n */\n action?: Action\n /** Inserted or updated data item. */\n dataItem?: DataItem\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n INSERTED = 'INSERTED',\n UPDATED = 'UPDATED',\n}\n\nexport interface GetDataItemRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection from which to retrieve the data item. */\n dataCollectionId: string\n /** ID of the data item to retrieve. */\n dataItemId: string\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language.\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n * If not provided, result text is not translated.\n */\n language?: string | null\n /**\n * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n * **Note:** The `_id` system field is always returned.\n */\n fields?: string[]\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface GetDataItemResponse {\n /** Retrieved item. */\n dataItem?: DataItem\n}\n\nexport interface RemoveDataItemRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection from which to remove the item. */\n dataCollectionId: string\n /** ID of the item to remove. */\n dataItemId: string\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface RemoveDataItemResponse {\n /** Removed item. */\n dataItem?: DataItem\n}\n\nexport interface TruncateDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection to truncate. */\n dataCollectionId: string\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n}\n\nexport interface TruncateDataItemsResponse {}\n\nexport interface QueryDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection to query. */\n dataCollectionId: string\n /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */\n query?: QueryV2\n /**\n * Whether to return the total count in the response for a query with offset paging.\n * When `true`, the `pagingMetadata` object in the response contains a `total` field.\n *\n * Default: `false`\n */\n returnTotalCount?: boolean\n /**\n * Properties for which to include referenced items in the query's results.\n * Up to 50 referenced items can be included for each item that matches the query.\n * @deprecated\n * @replacedBy referenced_item_options\n * @removalDate 2025-08-01\n */\n includeReferencedItems?: string[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language.\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n * If not provided, result text is not translated.\n */\n language?: string | null\n /**\n * Request information about this collection caching\n * @internal\n */\n requestCachingInfo?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n /** Options for retrieving referenced items. */\n referencedItemOptions?: ReferencedItemOptions[]\n}\n\nexport interface QueryV2 extends QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n /**\n * Filter object in the following format:\n *\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n *\n * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n *\n * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n filter?: Record<string, any> | null\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[]\n /**\n * Fields to return for each item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n * **Note:** The `_id` system field is always returned.\n */\n fields?: string[]\n}\n\n/** @oneof */\nexport interface QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n}\n\nexport interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string\n /** Sort order. */\n order?: SortOrder\n}\n\nexport enum SortOrder {\n ASC = 'ASC',\n DESC = 'DESC',\n}\n\nexport interface Paging {\n /** Number of items to load. */\n limit?: number | null\n /** Number of items to skip in the current sort order. */\n offset?: number | null\n}\n\nexport interface CursorPaging {\n /** Number of items to load. */\n limit?: number | null\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null\n}\n\nexport interface ReferencedItemOptions {\n /** Field containing references in the queried item. */\n fieldName?: string\n /** Maximum number of referenced items to include for each queried item. */\n limit?: number | null\n}\n\nexport interface QueryDataItemsResponse {\n /** Retrieved items. */\n dataItems?: DataItem[]\n /**\n * Caching info, returned if `request_caching_info` is set and caching is allowed\n * @internal\n */\n cachingInfo?: CachingInfo\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2\n}\n\nexport interface CachingInfo {\n /** Caching tags for this collection */\n tags?: string[]\n /** max caching time if set */\n maxAge?: number | null\n}\n\nexport interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null\n /** Offset that was requested. */\n offset?: number | null\n /** Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false. */\n total?: number | null\n /** Whether the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n * @internal\n */\n hasNext?: boolean | null\n}\n\nexport interface Cursors {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null\n}\n\nexport interface AggregateDataItemsRequest\n extends AggregateDataItemsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection on which to run the aggregation. */\n dataCollectionId: string\n /**\n * Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.\n *\n * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n initialFilter?: Record<string, any> | null\n /** Aggregation applied to the data. */\n aggregation?: Aggregation\n /**\n * Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.\n * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n finalFilter?: Record<string, any> | null\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[]\n /**\n * Whether to return the total count in the response for a query with offset paging.\n * When `true`, the `pagingMetadata` object in the response contains a `total` field.\n *\n * Default: `false`\n */\n returnTotalCount?: boolean\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language.\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n * If not provided, result text is not translated.\n */\n language?: string | null\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\n/** @oneof */\nexport interface AggregateDataItemsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n}\n\nexport interface Average {\n /** Name of the field for which to calculate the average value. */\n itemFieldName?: string\n}\n\nexport interface Min {\n /** Name of the field for which to calculate the minimum value. */\n itemFieldName?: string\n}\n\nexport interface Max {\n /** Name of the field for which to calculate the maximum value. */\n itemFieldName?: string\n}\n\nexport interface Sum {\n /** Name of the field for which to calculate the sum. */\n itemFieldName?: string\n}\n\nexport interface Count {}\n\nexport interface Operation extends OperationCalculateOneOf {\n /** Calculate the average value of a specified field for all items in the grouping. */\n average?: Average\n /** Calculate the minimum value of a specified field for all items in the grouping. */\n min?: Min\n /** Calculate the maximum value of a specified field for all items in the grouping. */\n max?: Max\n /** Calculate the sum of values of a specified field for all items in the grouping. */\n sum?: Sum\n /** Calculate the number of items in the grouping. */\n itemCount?: Count\n /** Name of the field containing results of the operation. */\n resultFieldName?: string\n}\n\n/** @oneof */\nexport interface OperationCalculateOneOf {\n /** Calculate the average value of a specified field for all items in the grouping. */\n average?: Average\n /** Calculate the minimum value of a specified field for all items in the grouping. */\n min?: Min\n /** Calculate the maximum value of a specified field for all items in the grouping. */\n max?: Max\n /** Calculate the sum of values of a specified field for all items in the grouping. */\n sum?: Sum\n /** Calculate the number of items in the grouping. */\n itemCount?: Count\n}\n\nexport interface Aggregation {\n /** Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection. */\n groupingFields?: string[]\n /** Operations to carry out on the data in each grouping. */\n operations?: Operation[]\n}\n\nexport interface AggregateDataItemsResponse {\n /** Aggregation results. */\n results?: Record<string, any>[] | null\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2\n}\n\nexport interface CountDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection for which to count query results. */\n dataCollectionId: string\n /**\n * Filter object in the following format:\n *\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`.\n *\n * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n *\n * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n filter?: Record<string, any> | null\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language.\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n * If not provided, result text is not translated.\n */\n language?: string | null\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface CountDataItemsResponse {\n /** Number of items matching the query. */\n totalCount?: number\n}\n\nexport interface QueryDistinctValuesRequest\n extends QueryDistinctValuesRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection to query. */\n dataCollectionId: string\n /** Item field name for which to return all distinct values. */\n fieldName?: string\n /**\n * Filter object in the following format:\n *\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`.\n *\n * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n *\n * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n filter?: Record<string, any> | null\n /** Sort order. */\n order?: SortOrder\n /**\n * Whether to return the total count in the response for a query with offset paging.\n * When `true`, the `pagingMetadata` object in the response contains a `total` field.\n *\n * Default: `false`\n */\n returnTotalCount?: boolean\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language.\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n * If not provided, result text is not translated.\n */\n language?: string | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\n/** @oneof */\nexport interface QueryDistinctValuesRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n}\n\nexport interface QueryDistinctValuesResponse {\n /** List of distinct values contained in the field specified in `fieldName`. */\n distinctValues?: any[]\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2\n}\n\nexport interface BulkInsertDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert the items. */\n dataCollectionId: string\n /** Data items to insert. */\n dataItems: DataItem[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options.\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the inserted data items.\n * When `true`, the `results` objects contain a `dataItem` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface BulkInsertDataItemsResponse {\n /** Information about the inserted items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkUpdateDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to update items. */\n dataCollectionId: string\n /** Data items to update. */\n dataItems: DataItem[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the updated data items.\n * When `true`, the `results` objects contain a `dataItem` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface BulkUpdateDataItemsResponse {\n /** Information about the updated items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkSaveDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert or update the items. */\n dataCollectionId: string\n /** Data items to insert or update. */\n dataItems: DataItem[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the saved data item.\n * When `true`, the `results` objects contain a `dataItem` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface BulkSaveDataItemsResponse {\n /** Information about the saved items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkRemoveDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection from which to remove the item. */\n dataCollectionId: string\n /** IDs of data items to remove. */\n dataItemIds: string[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface BulkRemoveDataItemsResponse {\n /** Information about the removed data items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface QueryReferencedDataItemsRequest\n extends QueryReferencedDataItemsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring item. */\n dataCollectionId: string\n /** ID of the referring item. */\n referringItemId?: string\n /** Field containing references in the referring item. */\n referringItemFieldName?: string\n /** Order of the returned referenced items. Sorted by the date each item was referenced. */\n order?: SortOrder\n /**\n * Whether to return the total count in the response.\n * When `true`, the `pagingMetadata` object in the response contains a `total` field.\n *\n * Default: `false`\n */\n returnTotalCount?: boolean\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language.\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n * If not provided, result text is not translated.\n */\n language?: string | null\n /**\n * Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n * **Note:** The `_id` system field is always returned.\n */\n fields?: string[]\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\n/** @oneof */\nexport interface QueryReferencedDataItemsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n}\n\nexport interface QueryReferencedDataItemsResponse {\n /** Referenced items and/or IDs. For successfully resolved references, the referenced data item is returned. For references that can't be resolved, the ID is returned. */\n results?: ReferencedResult[]\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2\n}\n\nexport interface UnresolvedReference {\n /** ID of the referring item. */\n referringItemId?: string\n /** Field specified to query for references. */\n referringItemFieldName?: string\n}\n\nexport interface ReferencedResult extends ReferencedResultEntityOneOf {\n /** Data item referenced. */\n dataItem?: DataItem\n /** Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state. */\n unresolvedReference?: UnresolvedReference\n}\n\n/** @oneof */\nexport interface ReferencedResultEntityOneOf {\n /** Data item referenced. */\n dataItem?: DataItem\n /** Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state. */\n unresolvedReference?: UnresolvedReference\n}\n\nexport interface IsReferencedDataItemRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring data item. */\n dataCollectionId: string\n /** Field to check for a reference to the item that may be referenced. */\n referringItemFieldName: string\n /** ID of the referring item. */\n referringItemId: string\n /** ID of the item that may be referenced. */\n referencedItemId: string\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface IsReferencedDataItemResponse {\n /** Whether the specified reference exists. */\n isReferenced?: boolean\n}\n\nexport interface InsertDataItemReferenceRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert the reference. */\n dataCollectionId: string\n /** Reference to insert */\n dataItemReference?: DataItemReference\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface DataItemReference {\n /** Referring item field containing the references to the referenced items. */\n referringItemFieldName?: string\n /** ID of the referring item. */\n referringItemId?: string\n /** ID of the referenced item. */\n referencedItemId?: string\n}\n\nexport interface InsertDataItemReferenceResponse {\n /** Inserted reference. */\n dataItemReference?: DataItemReference\n}\n\nexport interface RemoveDataItemReferenceRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring item. */\n dataCollectionId: string\n /** Reference to remove. */\n dataItemReference: DataItemReference\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface RemoveDataItemReferenceResponse {\n /** Removed reference. */\n dataItemReference?: DataItemReference\n}\n\nexport interface BulkInsertDataItemReferencesRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring items. */\n dataCollectionId: string\n /** References to insert. */\n dataItemReferences: DataItemReference[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the inserted data item references.\n * When `true`, the `results` objects contain a `dataItemReference` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface BulkInsertDataItemReferencesResponse {\n /** Information about the inserted references. */\n results?: BulkDataItemReferenceResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkDataItemReferenceResult {\n /** The action attempted for the reference. */\n action?: BulkActionType\n /** Metadata related to the reference for which the action was attempted. */\n referenceMetadata?: ItemMetadata\n /** The reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */\n dataItemReference?: DataItemReference\n}\n\nexport interface BulkRemoveDataItemReferencesRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring items. */\n dataCollectionId: string\n /** References to remove. */\n dataItemReferences: DataItemReference[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface BulkRemoveDataItemReferencesResponse {\n /** Information about the removed references. */\n results?: BulkDataItemReferenceResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface ReplaceDataItemReferencesRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring item. */\n dataCollectionId: string\n /** Field containing references in the referring item. */\n referringItemFieldName: string\n /** ID of the referring item. */\n referringItemId: string\n /** List of new referenced item IDs to replace the existing ones. */\n newReferencedItemIds?: string[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface ReplaceDataItemReferencesResponse {\n /** Updated references. */\n dataItemReferences?: DataItemReference[]\n}\n"],"mappings":";;;;IA4DYA,WAAW,GAAAC,OAAA,CAAAD,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAmFvB;AAAA,IAQYE,MAAM,GAAAD,OAAA,CAAAC,MAAA,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAAA,IA6FNC,cAAc,GAAAF,OAAA,CAAAE,cAAA,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAAA,IAsIdC,MAAM,GAAAH,OAAA,CAAAG,MAAA,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AA8OlB;AAAA,IAeYC,SAAS,GAAAJ,OAAA,CAAAI,SAAA,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAuJrB;AA6CA;AAsKA;AAgRA;AA6BA"}
|
|
1
|
+
{"version":3,"names":["Environment","exports","ACTION","BulkActionType","Action","SortOrder"],"sources":["../../../src/types/data-item-types.ts"],"sourcesContent":["export interface DataItem {\n /** Data item ID. */\n id?: string\n /**\n * ID of the collection to which this item belongs.\n * @readonly\n */\n dataCollectionId?: string\n /**\n * Data item contents.\n *\n * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:\n *\n * + `_id`: Item ID.\n * + `_createdDate`: Date and time the item was added to the collection.\n * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.\n * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.\n */\n data?: Record<string, any> | null\n}\n\nexport interface InsertDataItemRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert the item. */\n dataCollectionId: string\n /** Item to insert. */\n dataItem: DataItem\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * If true, referenced items will be included.\n * @internal\n */\n includeReferencedItems?: boolean\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport enum Environment {\n LIVE = 'LIVE',\n SANDBOX = 'SANDBOX',\n SANDBOX_PREFERRED = 'SANDBOX_PREFERRED',\n}\n\nexport interface Options {\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: PublishPluginOptions\n}\n\nexport interface PublishPluginOptions {\n showDraftItems?: boolean\n}\n\nexport interface InsertDataItemResponse {\n /** Inserted data item. */\n dataItem?: DataItem\n}\n\nexport interface PatchDataItemRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the existing item. */\n dataCollectionId: string\n /** Patch set applied during item update. */\n patchSet: PatchSet\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface PatchSet {\n /** Data item ID. */\n dataItemId?: string\n /** Set of field updates to be applied. */\n fieldUpdates?: FieldUpdate[]\n}\n\nexport interface FieldUpdate extends FieldUpdateActionOptionsOneOf {\n setField?: SetField\n incrementField?: IncrementField\n appendToArray?: AppendToArray\n removeFromArray?: RemoveFromArray\n /** Field key to be patched. For ex \"title\", \"address.street\" */\n fieldPath?: string\n /** Action to be applied */\n action?: ACTION\n}\n\n/** @oneof */\nexport interface FieldUpdateActionOptionsOneOf {\n setField?: SetField\n incrementField?: IncrementField\n appendToArray?: AppendToArray\n removeFromArray?: RemoveFromArray\n}\n\nexport enum ACTION {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n SET_FIELD = 'SET_FIELD',\n REMOVE_FIELD = 'REMOVE_FIELD',\n INCREMENT_FIELD = 'INCREMENT_FIELD',\n APPEND_TO_ARRAY = 'APPEND_TO_ARRAY',\n REMOVE_FROM_ARRAY = 'REMOVE_FROM_ARRAY',\n}\n\nexport interface SetField {\n value?: any\n}\n\nexport interface IncrementField {\n value?: number\n}\n\nexport interface AppendToArray {\n value?: any\n}\n\nexport interface RemoveFromArray {\n value?: any\n}\n\nexport interface DataPublishPluginOptions {\n includeDraftItems?: boolean\n}\n\nexport interface PatchDataItemResponse {\n /** Updated data item. */\n dataItem?: DataItem\n}\n\nexport interface BulkPatchDataItemsRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to update items. */\n dataCollectionId: string\n /** Patch sets to apply. */\n patchSets: PatchSet[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the updated data items.\n * When `true`, the `results` objects contain a `dataItem` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface BulkPatchDataItemsResponse {\n /** Information about the updated items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkDataItemResult {\n /** The action attempted for the data item. */\n action?: BulkActionType\n /** Metadata related to the data item for which the action was attempted. */\n itemMetadata?: ItemMetadata\n /** The data item for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */\n dataItem?: DataItem\n}\n\nexport enum BulkActionType {\n UNKNOWN_ACTION_TYPE = 'UNKNOWN_ACTION_TYPE',\n INSERT = 'INSERT',\n UPDATE = 'UPDATE',\n DELETE = 'DELETE',\n PATCH = 'PATCH',\n}\n\nexport interface ItemMetadata {\n /** Item ID. This field doesn't appear if there is no item ID, for example, when item creation fails. */\n id?: string | null\n /** Index of the item within the request array. Allows for correlation between request and response items. */\n originalIndex?: number\n /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */\n success?: boolean\n /** Details about the error in case of failure. */\n error?: ApplicationError\n}\n\nexport interface ApplicationError {\n /** Error code. */\n code?: string\n /** Description of the error. */\n description?: string\n /** Data related to the error. */\n data?: Record<string, any> | null\n}\n\nexport interface BulkActionMetadata {\n /** Number of items successfully processed. */\n totalSuccesses?: number\n /** Number of items that couldn't be processed. */\n totalFailures?: number\n}\n\nexport interface UpdateDataItemRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the existing item. */\n dataCollectionId: string\n /** Updated data item content. The existing data item's content is replaced entirely. */\n dataItem: DataItem\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * If true, referenced items will be included.\n * @internal\n */\n includeReferencedItems?: boolean\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface UpdateDataItemResponse {\n /** Updated data item. */\n dataItem?: DataItem\n}\n\nexport interface SaveDataItemRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert or update the item. */\n dataCollectionId: string\n /** Data item to insert or update. */\n dataItem: DataItem\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * If true, referenced items will be included.\n * @internal\n */\n includeReferencedItems?: boolean\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface SaveDataItemResponse {\n /**\n * Action carried out for the item.\n *\n * + `INSERTED`: A new item was added to the collection.\n * + `UPDATED`: An existing item in the collection was updated.\n */\n action?: Action\n /** Inserted or updated data item. */\n dataItem?: DataItem\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n INSERTED = 'INSERTED',\n UPDATED = 'UPDATED',\n}\n\nexport interface GetDataItemRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection from which to retrieve the data item. */\n dataCollectionId: string\n /** ID of the data item to retrieve. */\n dataItemId: string\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language. If not provided, the result text is not translated.\n *\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n */\n language?: string | null\n /**\n * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n *\n * **Note:** The `_id` system field is always returned.\n */\n fields?: string[]\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface GetDataItemResponse {\n /** Retrieved item. */\n dataItem?: DataItem\n}\n\nexport interface RemoveDataItemRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`\n * @internal\n */\n environment?: Environment\n /** ID of the collection from which to remove the item. */\n dataCollectionId: string\n /** ID of the item to remove. */\n dataItemId: string\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface RemoveDataItemResponse {\n /** Removed item. */\n dataItem?: DataItem\n}\n\nexport interface TruncateDataItemsRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection to truncate. */\n dataCollectionId: string\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n}\n\nexport interface TruncateDataItemsResponse {}\n\nexport interface QueryDataItemsRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection to query. */\n dataCollectionId: string\n /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */\n query?: QueryV2\n /**\n * Whether to return the total count in the response for a query with offset paging.\n * When `true`, the `pagingMetadata` object in the response contains a `total` field.\n *\n * Default: `false`\n */\n returnTotalCount?: boolean\n /**\n * Properties for which to include referenced items in the query's results.\n * Up to 50 referenced items can be included for each item that matches the query.\n * @deprecated\n * @replacedBy referenced_item_options\n * @removalDate 2025-08-01\n */\n includeReferencedItems?: string[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language. If not provided, the result text is not translated.\n *\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n */\n language?: string | null\n /**\n * Request information about this collection caching\n * @internal\n */\n requestCachingInfo?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n /** Options for retrieving referenced items. */\n referencedItemOptions?: ReferencedItemOptions[]\n}\n\nexport interface QueryV2 extends QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n /**\n * Filter object in the following format:\n *\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`\n *\n * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n *\n * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n filter?: Record<string, any> | null\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[]\n /**\n * Fields to return for each item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n * **Note:** The `_id` system field is always returned.\n */\n fields?: string[]\n}\n\n/** @oneof */\nexport interface QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n}\n\nexport interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string\n /** Sort order. */\n order?: SortOrder\n}\n\nexport enum SortOrder {\n ASC = 'ASC',\n DESC = 'DESC',\n}\n\nexport interface Paging {\n /** Number of items to load. */\n limit?: number | null\n /** Number of items to skip in the current sort order. */\n offset?: number | null\n}\n\nexport interface CursorPaging {\n /** Number of items to load. */\n limit?: number | null\n /**\n * Pointer to the next or previous page in the list of results.\n *\n * You can get the relevant cursor token\n * from the `pagingMetadata` object in the previous call's response.\n * Not relevant for the first request.\n */\n cursor?: string | null\n}\n\nexport interface ReferencedItemOptions {\n /** Field containing references in the queried item. */\n fieldName?: string\n /** Maximum number of referenced items to include for each queried item. */\n limit?: number | null\n}\n\nexport interface QueryDataItemsResponse {\n /** Retrieved items. */\n dataItems?: DataItem[]\n /**\n * Caching info. Returned if `request_caching_info` is true in the request and caching is allowed.\n * @internal\n */\n cachingInfo?: CachingInfo\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2\n}\n\nexport interface CachingInfo {\n /** Caching tags for this collection */\n tags?: string[]\n /** max caching time if set */\n maxAge?: number | null\n}\n\nexport interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: number | null\n /** Offset that was requested. */\n offset?: number | null\n /** Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false. */\n total?: number | null\n /** Whether the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | null\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n cursors?: Cursors\n /**\n * Indicates if there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, this is the last page.\n * @internal\n */\n hasNext?: boolean | null\n}\n\nexport interface Cursors {\n /** Cursor pointing to next page in the list of results. */\n next?: string | null\n /** Cursor pointing to previous page in the list of results. */\n prev?: string | null\n}\n\nexport interface AggregateDataItemsRequest\n extends AggregateDataItemsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection on which to run the aggregation. */\n dataCollectionId: string\n /**\n * Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.\n *\n * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n initialFilter?: Record<string, any> | null\n /** Aggregation applied to the data. */\n aggregation?: Aggregation\n /**\n * Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.\n * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n finalFilter?: Record<string, any> | null\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting[]\n /**\n * Whether to return the total count in the response for a query with offset paging.\n * When `true`, the `pagingMetadata` object in the response contains a `total` field.\n *\n * Default: `false`\n */\n returnTotalCount?: boolean\n /**\n * Grid app ID. Optional in `LIVE` segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language. If not provided, the result text is not translated.\n *\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n */\n language?: string | null\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\n/** @oneof */\nexport interface AggregateDataItemsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n}\n\nexport interface Average {\n /** Name of the field for which to calculate the average value. */\n itemFieldName?: string\n}\n\nexport interface Min {\n /** Name of the field for which to calculate the minimum value. */\n itemFieldName?: string\n}\n\nexport interface Max {\n /** Name of the field for which to calculate the maximum value. */\n itemFieldName?: string\n}\n\nexport interface Sum {\n /** Name of the field for which to calculate the sum. */\n itemFieldName?: string\n}\n\nexport interface Count {}\n\nexport interface Operation extends OperationCalculateOneOf {\n /** Calculate the average value of a specified field for all items in the grouping. */\n average?: Average\n /** Calculate the minimum value of a specified field for all items in the grouping. */\n min?: Min\n /** Calculate the maximum value of a specified field for all items in the grouping. */\n max?: Max\n /** Calculate the sum of values of a specified field for all items in the grouping. */\n sum?: Sum\n /** Calculate the number of items in the grouping. */\n itemCount?: Count\n /** Name of the field containing results of the operation. */\n resultFieldName?: string\n}\n\n/** @oneof */\nexport interface OperationCalculateOneOf {\n /** Calculate the average value of a specified field for all items in the grouping. */\n average?: Average\n /** Calculate the minimum value of a specified field for all items in the grouping. */\n min?: Min\n /** Calculate the maximum value of a specified field for all items in the grouping. */\n max?: Max\n /** Calculate the sum of values of a specified field for all items in the grouping. */\n sum?: Sum\n /** Calculate the number of items in the grouping. */\n itemCount?: Count\n}\n\nexport interface Aggregation {\n /** Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection. */\n groupingFields?: string[]\n /** Operations to carry out on the data in each grouping. */\n operations?: Operation[]\n}\n\nexport interface AggregateDataItemsResponse {\n /** Aggregation results. */\n results?: Record<string, any>[] | null\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2\n}\n\nexport interface CountDataItemsRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection for which to count query results. */\n dataCollectionId: string\n /**\n * Filter object in the following format:\n *\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`.\n *\n * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n *\n * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n filter?: Record<string, any> | null\n /**\n * Grid app ID. Optional in `LIVE` segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language. If not provided, the result text is not translated.\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n */\n language?: string | null\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface CountDataItemsResponse {\n /** Number of items matching the query. */\n totalCount?: number\n}\n\nexport interface QueryDistinctValuesRequest\n extends QueryDistinctValuesRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection to query. */\n dataCollectionId: string\n /** Item field name for which to return all distinct values. */\n fieldName?: string\n /**\n * Filter object in the following format:\n *\n * `\"filter\" : {\n * \"fieldName1\": \"value1\",\n * \"fieldName2\":{\"$operator\":\"value2\"}\n * }`.\n *\n * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.\n *\n * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).\n */\n filter?: Record<string, any> | null\n /** Sort order. */\n order?: SortOrder\n /**\n * Whether to return the total count in the response for a query with offset paging.\n * When `true`, the `pagingMetadata` object in the response contains a `total` field.\n *\n * Default: `false`\n */\n returnTotalCount?: boolean\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language. If not provided, the result text is not translated.\n *\n * > **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n */\n language?: string | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\n/** @oneof */\nexport interface QueryDistinctValuesRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n}\n\nexport interface QueryDistinctValuesResponse {\n /** List of distinct values contained in the field specified in `fieldName`. */\n distinctValues?: any[]\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2\n}\n\nexport interface BulkInsertDataItemsRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert the items. */\n dataCollectionId: string\n /** Data items to insert. */\n dataItems: DataItem[]\n /**\n * Grid app ID. Optional in `LIVE` segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options.\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the inserted data items.\n * When `true`, the `results` objects contain a `dataItem` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface BulkInsertDataItemsResponse {\n /** Information about the inserted items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkUpdateDataItemsRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to update items. */\n dataCollectionId: string\n /** Data items to update. */\n dataItems: DataItem[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the updated data items.\n * When `true`, the `results` objects contain a `dataItem` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface BulkUpdateDataItemsResponse {\n /** Information about the updated items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkSaveDataItemsRequest {\n /**\n * Environment: LIVE or SANDBOX\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert or update the items. */\n dataCollectionId: string\n /** Data items to insert or update. */\n dataItems: DataItem[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the saved data item.\n * When `true`, the `results` objects contain a `dataItem` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface BulkSaveDataItemsResponse {\n /** Information about the saved items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkRemoveDataItemsRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection from which to remove the item. */\n dataCollectionId: string\n /** IDs of data items to remove. */\n dataItemIds: string[]\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\nexport interface BulkRemoveDataItemsResponse {\n /** Information about the removed data items. */\n results?: BulkDataItemResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface QueryReferencedDataItemsRequest\n extends QueryReferencedDataItemsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring item. */\n dataCollectionId: string\n /** ID of the referring item. */\n referringItemId?: string\n /** Field containing references in the referring item. */\n referringItemFieldName?: string\n /** Order of the returned referenced items. Sorted by the date each item was referenced. */\n order?: SortOrder\n /**\n * Whether to return the total count in the response.\n * When `true`, the `pagingMetadata` object in the response contains a `total` field.\n *\n * Default: `false`\n */\n returnTotalCount?: boolean\n /**\n * Grid app ID. Optional in `LIVE` segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /**\n * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If provided, the result text is returned in the specified language. If not provided, the result text is not translated.\n *\n * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n *\n */\n language?: string | null\n /**\n * Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.\n * **Note:** The `_id` system field is always returned.\n */\n fields?: string[]\n /** @internal */\n appOptions?: Record<string, any> | null\n /** @internal */\n publishPluginOptions?: DataPublishPluginOptions\n}\n\n/** @oneof */\nexport interface QueryReferencedDataItemsRequestPagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging\n /** 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`. */\n cursorPaging?: CursorPaging\n}\n\nexport interface QueryReferencedDataItemsResponse {\n /** Referenced items and/or IDs. For successfully resolved references, the referenced data item is returned. For references that can't be resolved, the ID is returned. */\n results?: ReferencedResult[]\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2\n}\n\nexport interface UnresolvedReference {\n /** ID of the referring item. */\n referringItemId?: string\n /** Field specified to query for references. */\n referringItemFieldName?: string\n}\n\nexport interface ReferencedResult extends ReferencedResultEntityOneOf {\n /** Data item referenced. */\n dataItem?: DataItem\n /** Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state. */\n unresolvedReference?: UnresolvedReference\n}\n\n/** @oneof */\nexport interface ReferencedResultEntityOneOf {\n /** Data item referenced. */\n dataItem?: DataItem\n /** Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state. */\n unresolvedReference?: UnresolvedReference\n}\n\nexport interface IsReferencedDataItemRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring data item. */\n dataCollectionId: string\n /** Field to check for a reference to the item that may be referenced. */\n referringItemFieldName: string\n /** ID of the referring item. */\n referringItemId: string\n /** ID of the item that may be referenced. */\n referencedItemId: string\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to retrieve data from the primary database instance.\n * This decreases performance but ensures data retrieved is up to date even immediately after an update.\n * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n *\n * Default: `false`\n */\n consistentRead?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface IsReferencedDataItemResponse {\n /** Whether the specified reference exists. */\n isReferenced?: boolean\n}\n\nexport interface InsertDataItemReferenceRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection in which to insert the reference. */\n dataCollectionId: string\n /** Reference to insert */\n dataItemReference?: DataItemReference\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface DataItemReference {\n /** Referring item field containing the references to the referenced items. */\n referringItemFieldName?: string\n /** ID of the referring item. */\n referringItemId?: string\n /** ID of the referenced item. */\n referencedItemId?: string\n}\n\nexport interface InsertDataItemReferenceResponse {\n /** Inserted reference. */\n dataItemReference?: DataItemReference\n}\n\nexport interface RemoveDataItemReferenceRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring item. */\n dataCollectionId: string\n /** Reference to remove. */\n dataItemReference: DataItemReference\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface RemoveDataItemReferenceResponse {\n /** Removed reference. */\n dataItemReference?: DataItemReference\n}\n\nexport interface BulkInsertDataItemReferencesRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring items. */\n dataCollectionId: string\n /** References to insert. */\n dataItemReferences: DataItemReference[]\n /**\n * Grid app ID. Optional in `LIVE` segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /**\n * Whether to return the inserted data item references.\n * When `true`, the `results` objects contain a `dataItemReference` field.\n *\n * Default: `false`\n */\n returnEntity?: boolean\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface BulkInsertDataItemReferencesResponse {\n /** Information about the inserted references. */\n results?: BulkDataItemReferenceResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface BulkDataItemReferenceResult {\n /** Action attempted for the reference. */\n action?: BulkActionType\n /** Metadata related to the reference for which the action was attempted. */\n referenceMetadata?: ItemMetadata\n /** Reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */\n dataItemReference?: DataItemReference\n}\n\nexport interface BulkRemoveDataItemReferencesRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring items. */\n dataCollectionId: string\n /** References to remove. */\n dataItemReferences: DataItemReference[]\n /**\n * Grid app ID. Optional in `LIVE` segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface BulkRemoveDataItemReferencesResponse {\n /** Information about the removed references. */\n results?: BulkDataItemReferenceResult[]\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata\n}\n\nexport interface ReplaceDataItemReferencesRequest {\n /**\n * Environment: `LIVE` or `SANDBOX`.\n * @internal\n */\n environment?: Environment\n /** ID of the collection containing the referring item. */\n dataCollectionId: string\n /** Field containing references in the referring item. */\n referringItemFieldName: string\n /** ID of the referring item. */\n referringItemId: string\n /** List of new referenced item IDs to replace the existing ones. */\n newReferencedItemIds?: string[]\n /**\n * Grid app ID. Optional in `LIVE` segment.\n * @internal\n */\n appId?: string | null\n /**\n * Data access options\n * @internal\n * @deprecated\n * @replacedBy inlined\n * @removalDate 2024-07-12\n */\n options?: Options\n /** @internal */\n appOptions?: Record<string, any> | null\n}\n\nexport interface ReplaceDataItemReferencesResponse {\n /** Updated references. */\n dataItemReferences?: DataItemReference[]\n}\n"],"mappings":";;;;IA4DYA,WAAW,GAAAC,OAAA,CAAAD,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAmFvB;AAAA,IAQYE,MAAM,GAAAD,OAAA,CAAAC,MAAA,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAAA,IA6FNC,cAAc,GAAAF,OAAA,CAAAE,cAAA,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAAA,IAsIdC,MAAM,GAAAH,OAAA,CAAAG,MAAA,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AA+OlB;AAAA,IAeYC,SAAS,GAAAJ,OAAA,CAAAI,SAAA,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAuJrB;AA6CA;AAoKA;AAgRA;AA6BA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-item-types.js","sourceRoot":"","sources":["../../../src/types/data-item-types.ts"],"names":[],"mappings":"AA4DA,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;IACnB,sDAAuC,CAAA;AACzC,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAuFD,MAAM,CAAN,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,iCAAuB,CAAA;IACvB,uCAA6B,CAAA;IAC7B,6CAAmC,CAAA;IACnC,6CAAmC,CAAA;IACnC,iDAAuC,CAAA;AACzC,CAAC,EAPW,MAAM,KAAN,MAAM,QAOjB;AAsFD,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,6DAA2C,CAAA;IAC3C,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,iCAAe,CAAA;AACjB,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAgID,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,+BAAqB,CAAA;IACrB,6BAAmB,CAAA;AACrB,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;
|
|
1
|
+
{"version":3,"file":"data-item-types.js","sourceRoot":"","sources":["../../../src/types/data-item-types.ts"],"names":[],"mappings":"AA4DA,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;IACnB,sDAAuC,CAAA;AACzC,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAuFD,MAAM,CAAN,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,iCAAuB,CAAA;IACvB,uCAA6B,CAAA;IAC7B,6CAAmC,CAAA;IACnC,6CAAmC,CAAA;IACnC,iDAAuC,CAAA;AACzC,CAAC,EAPW,MAAM,KAAN,MAAM,QAOjB;AAsFD,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,6DAA2C,CAAA;IAC3C,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,iCAAe,CAAA;AACjB,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAgID,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,+BAAqB,CAAA;IACrB,6BAAmB,CAAA;AACrB,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AA0PD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}
|
|
@@ -22,7 +22,7 @@ export interface WixDataAggregate {
|
|
|
22
22
|
* Sums can only be calculated on fields of type Number.
|
|
23
23
|
*
|
|
24
24
|
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
25
|
-
* > used on [Wix app collections](https://
|
|
25
|
+
* > used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
26
26
|
* @public
|
|
27
27
|
* @documentationMaturity preview
|
|
28
28
|
* @param field - Field in which to find the sum.
|
|
@@ -48,7 +48,7 @@ export interface WixDataAggregate {
|
|
|
48
48
|
* Averages can only be calculated on fields of type Number.
|
|
49
49
|
*
|
|
50
50
|
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
51
|
-
* > used on [Wix app collections](https://
|
|
51
|
+
* > used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
52
52
|
* @public
|
|
53
53
|
* @documentationMaturity preview
|
|
54
54
|
* @param field - Field in which to find the average value.
|
|
@@ -83,7 +83,7 @@ export interface WixDataAggregate {
|
|
|
83
83
|
* - Reference: Compares by the ID of the referenced item as a String.
|
|
84
84
|
*
|
|
85
85
|
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
86
|
-
* > used on [Wix app collections](https://
|
|
86
|
+
* > used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
87
87
|
* @public
|
|
88
88
|
* @documentationMaturity preview
|
|
89
89
|
* @param field - Field in which to find the minimum value.
|
|
@@ -118,7 +118,7 @@ export interface WixDataAggregate {
|
|
|
118
118
|
* - Reference: Compares by the ID of the referenced item as a String.
|
|
119
119
|
*
|
|
120
120
|
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
121
|
-
* > used on [Wix app collections](https://
|
|
121
|
+
* > used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
122
122
|
* @public
|
|
123
123
|
* @documentationMaturity preview
|
|
124
124
|
* @param field - Field in which to find the maximum value.
|
|
@@ -138,10 +138,10 @@ export interface WixDataAggregate {
|
|
|
138
138
|
* - The value is the count of items aggregated in the group.
|
|
139
139
|
*
|
|
140
140
|
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
141
|
-
* > used on [Wix app collections](https://
|
|
141
|
+
* > used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
142
142
|
* @public
|
|
143
143
|
* @documentationMaturity preview
|
|
144
|
-
* @param projectedField - Field in the aggregation results that contains the count value.
|
|
144
|
+
* @param projectedField - Field in the aggregation results that contains the count value. Default: `count`.
|
|
145
145
|
* @returns `WixDataAggregate` object representing the refined aggregation.
|
|
146
146
|
*/
|
|
147
147
|
count(projectedField?: string): WixDataAggregate;
|
|
@@ -158,7 +158,7 @@ export interface WixDataAggregate {
|
|
|
158
158
|
* aggregation. To filter grouped results, use the `having()` method.
|
|
159
159
|
*
|
|
160
160
|
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
161
|
-
* > used on [Wix app collections](https://
|
|
161
|
+
* > used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
162
162
|
* @public
|
|
163
163
|
* @documentationMaturity preview
|
|
164
164
|
* @param filter - Filter to use to filter out items from being used in the aggregation.
|
|
@@ -203,8 +203,7 @@ export interface WixDataAggregate {
|
|
|
203
203
|
* Filtering using `having()` takes place after grouping is performed on the
|
|
204
204
|
* aggregation. To filter items before grouping, use the `filter()` method.
|
|
205
205
|
*
|
|
206
|
-
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
207
|
-
* > used on [Wix app collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
|
|
206
|
+
* > **Note:** Aggregations can only be used on collections you have created. They cannot be used in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
208
207
|
* @public
|
|
209
208
|
* @documentationMaturity preview
|
|
210
209
|
* @param filter - Filter to use to filter out groups from being returned from the aggregation.
|
|
@@ -223,8 +222,7 @@ export interface WixDataAggregate {
|
|
|
223
222
|
*
|
|
224
223
|
* The maximum value that `limit()` can accept is `1000`.
|
|
225
224
|
*
|
|
226
|
-
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
227
|
-
* > used on [Wix app collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
|
|
225
|
+
* > **Note:** Aggregations can only be used on collections you have created. They cannot be used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
228
226
|
* @public
|
|
229
227
|
* @documentationMaturity preview
|
|
230
228
|
* @param limit - Number of items or groups to return.
|
|
@@ -312,7 +310,7 @@ export interface WixDataAggregate {
|
|
|
312
310
|
* by the aggregation and some information about the results.
|
|
313
311
|
*
|
|
314
312
|
* > **Note:** Aggregations can only be used on collections you have created. They cannot be
|
|
315
|
-
* > used on [Wix app collections](https://
|
|
313
|
+
* > used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
|
|
316
314
|
* @public
|
|
317
315
|
* @documentationMaturity preview
|
|
318
316
|
* @param options - Options to use when running an aggregation.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataAggregate.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAggregate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE7D;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEhD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,CAAA;IAE/C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAE3C
|
|
1
|
+
{"version":3,"file":"WixDataAggregate.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAggregate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE7D;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEhD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,CAAA;IAE/C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,CAAA;IAE/C;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEtC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAEjD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAE9C,UAAU,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,gBAAgB,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,SAAS,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAEhD,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAE7C,SAAS,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,gBAAgB,CAAA;IAE3C;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAA;CAC/E"}
|
|
@@ -13,8 +13,7 @@ export interface WixDataFilter {
|
|
|
13
13
|
*
|
|
14
14
|
* Matching strings with `eq()` is case sensitive, so `"text"` is not equal to `"Text"`.
|
|
15
15
|
*
|
|
16
|
-
* If `field` points to a collection field of type
|
|
17
|
-
* as long as at least one Array element matches the specified `value`.
|
|
16
|
+
* If `field` points to a collection field of type array, `eq()` includes the item as long as at least one array element matches the specified `value`.
|
|
18
17
|
* @public
|
|
19
18
|
* @documentationMaturity preview
|
|
20
19
|
* @param field - Field whose value is compared with `value`.
|
|
@@ -36,7 +35,7 @@ export interface WixDataFilter {
|
|
|
36
35
|
* Matching strings with `ne()` is case sensitive, so `"text"` is not equal to `"Text"`.
|
|
37
36
|
*
|
|
38
37
|
* If the value of `field` is an array, `ne()` includes items
|
|
39
|
-
* in which none of the elements of the
|
|
38
|
+
* in which none of the elements of the array match the specified `value`.
|
|
40
39
|
* @public
|
|
41
40
|
* @documentationMaturity preview
|
|
42
41
|
* @param field - Field whose value is compared with `value`.
|
|
@@ -393,12 +392,11 @@ export interface WixDataFilter {
|
|
|
393
392
|
* - `"A"` and `"M"` are considered between `"A"` and `"Z"`, but `"a"`, `"m"`, `"z"` and `"Z"` are not.
|
|
394
393
|
* - `"A"`, `"M"`, `"Z"`, and `"a"` are considered between `"A"` and `"z"`, but `"z"` is not.
|
|
395
394
|
*
|
|
396
|
-
*
|
|
397
395
|
* > **Note**: Items that do not have a value for the specified field are considered as the lowest comparable value and are ranked last.
|
|
398
396
|
*
|
|
399
397
|
* @public
|
|
400
398
|
* @documentationMaturity preview
|
|
401
|
-
* @param field -
|
|
399
|
+
* @param field - Field to compare with `rangeStart` and `rangeEnd`.
|
|
402
400
|
* @requiredField field
|
|
403
401
|
* @param rangeStart - Starting value of the range to match.
|
|
404
402
|
* @requiredField rangeStart
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataFilter.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataFilter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B
|
|
1
|
+
{"version":3,"file":"WixDataFilter.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataFilter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,aAAa,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,aAAa,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa,CAAA;IAE/D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAExC;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAErC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAEvD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAErD;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAA;IAE9E;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAA;IAE3E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAA;IAE7E;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAA;IAE1E;;;;;;;;;;;;;;;OAeG;IACH,EAAE,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAClC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAC/B,aAAa,CAAA;CACjB"}
|
|
@@ -64,8 +64,8 @@ export interface WixDataQuery {
|
|
|
64
64
|
*
|
|
65
65
|
* Matching strings with `eq()` is case sensitive, so `"text"` is not equal to `"Text"`.
|
|
66
66
|
*
|
|
67
|
-
* If `field` points to a collection field of type
|
|
68
|
-
* as long as at least one
|
|
67
|
+
* If `field` points to a collection field of type array, `eq()` includes the item
|
|
68
|
+
* as long as at least one array element matches the specified `value`.
|
|
69
69
|
* @public
|
|
70
70
|
* @documentationMaturity preview
|
|
71
71
|
* @param field - Field whose value is compared with `value`.
|
|
@@ -86,8 +86,8 @@ export interface WixDataQuery {
|
|
|
86
86
|
*
|
|
87
87
|
* Matching strings with `ne()` is case sensitive, so `"text"` is not equal to `"Text"`.
|
|
88
88
|
*
|
|
89
|
-
* If the value of the `field` property is an
|
|
90
|
-
* in which none of the elements of the
|
|
89
|
+
* If the value of the `field` property is an array, `ne()` includes items
|
|
90
|
+
* in which none of the elements of the array match the specified `value`.
|
|
91
91
|
* @public
|
|
92
92
|
* @documentationMaturity preview
|
|
93
93
|
* @param field - Field whose value is compared with `value`.
|
|
@@ -477,7 +477,7 @@ export interface WixDataQuery {
|
|
|
477
477
|
* with incorrect permissions or if any of the methods used to refine the
|
|
478
478
|
* query is invalid.
|
|
479
479
|
*
|
|
480
|
-
* Calling the `count()` method triggers the `beforeCount()` and `afterCount()` hooks if they have been defined.
|
|
480
|
+
* Calling the `count()` method triggers the [`beforeCount()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-count) and [`afterCount()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-count) hooks if they have been defined.
|
|
481
481
|
*
|
|
482
482
|
* Use the `options` parameter to run `count()` without checking for permissions
|
|
483
483
|
* or without its registered hooks.
|
|
@@ -512,9 +512,7 @@ export interface WixDataQuery {
|
|
|
512
512
|
* The Promise is rejected if `distinct()` is called with incorrect permissions or if any of the
|
|
513
513
|
* methods used to refine the query is invalid.
|
|
514
514
|
*
|
|
515
|
-
* >**Note:** Only site visitors with [Data Read](https://support.wix.com/en/article/collection-permissions-an-overview#permissions)
|
|
516
|
-
* permissions can retrieve and view data. You can override the permissions in backend code by setting the
|
|
517
|
-
* `options.suppressAuth` option to `true`.
|
|
515
|
+
* >**Note:** Only site visitors with [Data Read](https://support.wix.com/en/article/collection-permissions-an-overview#permissions) permissions can retrieve and view data. You can override the permissions by calling this method with [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions).
|
|
518
516
|
* @public
|
|
519
517
|
* @documentationMaturity preview
|
|
520
518
|
* @param field - Field whose value is compared for distinct values.
|
|
@@ -531,17 +529,15 @@ export interface WixDataQuery {
|
|
|
531
529
|
* rejected if `find()` is called with incorrect permissions or if any of the
|
|
532
530
|
* methods used to refine the query is invalid.
|
|
533
531
|
*
|
|
534
|
-
* Calling the `find()` method triggers the `beforeQuery()` and `afterQuery()` hooks if they have been defined.
|
|
532
|
+
* Calling the `find()` method triggers the [`beforeQuery()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-query) and [`afterQuery()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-query) hooks if they have been defined.
|
|
535
533
|
*
|
|
536
534
|
* > **Note:**
|
|
537
|
-
* > Calling `find()` triggers hooks for the specified collection only. It doesn't trigger hooks for referenced
|
|
538
|
-
* > collections.
|
|
535
|
+
* > Calling `find()` triggers hooks for the specified collection only. It doesn't trigger hooks for referenced collections.
|
|
539
536
|
*
|
|
540
537
|
* Use the `options` parameter to override default preferences:
|
|
541
|
-
* - Override permission checks with `suppressAuth`.
|
|
542
538
|
* - Ensure the most up-to-date data is retrieved with `consistentRead`.
|
|
543
539
|
* - Prevent hooks from running with `suppressHooks`.
|
|
544
|
-
* -
|
|
540
|
+
* - Get a count of all the items that match the query by setting `returnTotalCount` to `true`.
|
|
545
541
|
*
|
|
546
542
|
* If you build a query and don't refine it with any `wixDataQuery` methods,
|
|
547
543
|
* `find()` returns the entire collection.
|
|
@@ -581,7 +577,7 @@ export interface WixDataQuery {
|
|
|
581
577
|
*
|
|
582
578
|
* The maximum value that `limit()` can accept is `1000`.
|
|
583
579
|
*
|
|
584
|
-
* Note that for some Wix app collections, the maximum value `limit()` can accept is
|
|
580
|
+
* Note that for some [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), the maximum value `limit()` can accept is
|
|
585
581
|
* less than `1000`. For example, the maximum limit for the Wix `Stores/Product` collection is 100.
|
|
586
582
|
* @public
|
|
587
583
|
* @documentationMaturity preview
|
|
@@ -642,9 +638,8 @@ export interface WixDataQuery {
|
|
|
642
638
|
* For a discussion of when to use the similar `queryReferenced()`
|
|
643
639
|
* method and when to use `include()`, see [Querying Items that Reference Other Items](https://support.wix.com/en/article/including-referenced-data-when-filtering).
|
|
644
640
|
*
|
|
645
|
-
* > **
|
|
646
|
-
*
|
|
647
|
-
* > - The `include()` method is not supported for Single Item Collections.
|
|
641
|
+
* > **Note:** The `include()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
|
|
642
|
+
*
|
|
648
643
|
* @public
|
|
649
644
|
* @documentationMaturity preview
|
|
650
645
|
* @param fields - Fields for which to include referenced items.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataQuery.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAE7C,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAE1C,UAAU,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,YAAY,CAAA;IAExC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAE5C,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAEzC,SAAS,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,YAAY,CAAA;IAEvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,CAAA;IAE9D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,CAAA;IAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,CAAA;IAE9D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,CAAA;IAE9D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEvC;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEpC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEtD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEpD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAE7E;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAE1E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAE5E;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAEzE;;;;;;;;;;;;;;OAcG;IACH,EAAE,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAAA;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAAA;IAExC;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAClC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAC/B,YAAY,CAAA;IAEf;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEpD
|
|
1
|
+
{"version":3,"file":"WixDataQuery.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAE7C,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAE1C,UAAU,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,YAAY,CAAA;IAExC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAE5C,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAEzC,SAAS,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,YAAY,CAAA;IAEvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,CAAA;IAE9D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,CAAA;IAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,CAAA;IAE9D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,CAAA;IAE9D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEvC;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEpC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEtD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEpD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAE7E;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAE1E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAE5E;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAEzE;;;;;;;;;;;;;;OAcG;IACH,EAAE,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAAA;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAAA;IAExC;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAClC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAC/B,YAAY,CAAA;IAEf;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEpD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CACN,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IAE3D;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAEzC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,YAAY,CAAA;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,OAAO,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAE1C;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,YAAY,CAAA;IAEpD;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,YAAY,CAAA;IAErE;;;;OAIG;IACH,OAAO,CACL,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACb,YAAY,CAAA;IAEf;;;;OAIG;IACH,OAAO,CACL,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACb,YAAY,CAAA;IAEf;;;;OAIG;IACH,OAAO,CACL,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACb,YAAY,CAAA;IAEf;;;;OAIG;IACH,OAAO,CAAC,GAAG,kBAAkB,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,MAAM,CAAC,GAAG,YAAY,CAAA;IAEnE;;;;OAIG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,YAAY,CAAA;CAC1C"}
|
|
@@ -97,7 +97,7 @@ export interface WixDataResult<Item = WixDataItem> {
|
|
|
97
97
|
*
|
|
98
98
|
* If items are added or removed between calls to `next()` the values returned may change.
|
|
99
99
|
*
|
|
100
|
-
* >**Note:** The `next()` method is not supported for
|
|
100
|
+
* >**Note:** The `next()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
|
|
101
101
|
*
|
|
102
102
|
* @public
|
|
103
103
|
* @documentationMaturity preview
|
|
@@ -117,7 +117,7 @@ export interface WixDataResult<Item = WixDataItem> {
|
|
|
117
117
|
* If items are added or removed between calls to `prev()` the values returned
|
|
118
118
|
* may change.
|
|
119
119
|
*
|
|
120
|
-
* >**Note:** The `prev()` method is not supported for
|
|
120
|
+
* >**Note:** The `prev()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
|
|
121
121
|
*
|
|
122
122
|
* @public
|
|
123
123
|
* @documentationMaturity preview
|