@wix/ditto-codegen-public 1.0.161 → 1.0.163

package/dist/docs-output/api-docs/search-wixSiteSearch-search-doc.txt

@@ -0,0 +1,162 @@
+<search_wixSiteSearch_search>
+<description>
+# Method name:
+
+search.wixSiteSearch.search(search: Search, options: SearchOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/search/wix-site-search/search
+
+# Method Description:
+
+Retrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried.
+
+The `search()` API supports the document types listed in the [Introduction](https://dev.wix.com/docs/sdk/backend-modules/search/wix-site-search/introduction), each with its own schema. These schemas define the fields available for filtering, sorting, and free-text searching.
+
+To learn more about working with the search query, see [API Query Language](https://dev.wix.com/docs/sdk/articles/working-with-the-sdk/api-query-language).
+
+# Method Permissions:
+
+- SEARCH.SITE_DOCUMENT_READ
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## search
+
+```javascript
+import { wixSiteSearch } from '@wix/search';
+
+async function search(search, options) {
+ const response = await wixSiteSearch.search(search, options);
+};
+```
+
+## search (with elevated permissions)
+
+```javascript
+import { wixSiteSearch } from '@wix/search';
+import { auth } from '@wix/essentials';
+
+async function mySearchMethod(search, options) {
+ const elevatedSearch = auth.elevate(wixSiteSearch.search);
+ const response = await elevatedSearch(search, options);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+ const result = await wixSiteSearch.search({
+   search: {
+     search: {
+       expression: "latest events"
+     }
+   }
+ }, "EVENTS");
+ return result;
+} catch (error) {
+ console.error(error);
+ throw error;
+}
+```
+</description>
+<type_definition>
+```
+Method: search.wixSiteSearch.search(search, options)
+Description: Retrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried.  The `search()` API supports the document types listed in the [Introduction](https://dev.wix.com/docs/sdk/backend-modules/search/wix-site-search/introduction), each with its own schema. These schemas define the fields available for filtering, sorting, and free-text searching.  To learn more about working with the search query, see [API Query Language](https://dev.wix.com/docs/sdk/articles/working-with-the-sdk/api-query-language).
+Method parameters:
+  param name:  search | type: Search | description:  Search query and aggregation information. | required: true
+      - name: aggregations  | type: Array<Aggregation> | description:  A search method for grouping data into various categories (facets) and providing summaries for each category. For example, use aggregations to categorize search results by specific price ranges, brand names, or ratings. 
+            - name: fieldPath  | type: string | description:  Field to aggregate by. 
+            - name: name  | type: string | description:  Aggregation name displayed in the return. 
+            - name: type  | type: AggregationType | description:  Type of aggregation to perform. 
+                enum: 
+                     NESTED: Multi-level aggregation, where each next aggregation is nested within previous one.
+                     SCALAR: A single-value metric aggregation - e.g. min, max, sum, avg.
+                   UNKNOWN_AGGREGATION_TYPE,   VALUE: An aggregation where result buckets are dynamically built - one per unique value.
+            - ONE-OF: 
+              - name: nested  | type: NestedAggregation | description:  Pass if `type` is `NESTED`. A nested aggregation is applied to the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. This allows for more complex analyses that summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on the field containing the price, and a second value aggregation on the field indicating whether a product is in stock. You can nest up to a maximum of 3 aggregations. Each aggregation can be either value-based or scalar, allowing flexibility in how the data is grouped and analyzed. 
+                  - name: nestedAggregations  | type: Array<NestedAggregationItem> | description:  List of aggregations, where each aggregation is nested within previous one. 
+                        - name: fieldPath  | type: string | description:  Field to aggregate by. 
+                        - name: name  | type: string | description:  Aggregation name displayed in the return. 
+                        - name: type  | type: NestedAggregationType | description:  Type of aggregation to perform. 
+                            enum: 
+                                 SCALAR: A single-value metric aggregation - e.g. min, max, sum, avg.
+                                 UNKNOWN_AGGREGATION_TYPE: Unknown aggregation type.
+                                 VALUE: An aggregation where result buckets are dynamically built - one per unique value.
+                        - ONE-OF: 
+                          - name: scalar  | type: ScalarAggregation | description:  Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the total, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. 
+                              - name: type  | type: ScalarType | description:  Type of scalar aggregation. 
+                                  enum: 
+                                       MAX: Maximum value.
+                                       MIN: Minimum value.
+                                       UNKNOWN_SCALAR_TYPE: Unknown scalar type.
+                          - name: value  | type: ValueAggregation | description:  Pass if `type` is `VALUE`. A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. 
+                              - name: limit  | type: number | description:  Maximum number of aggregation results to return. Min: `1` Max: `250` Default: `10` 
+              - name: scalar  | type: ScalarAggregation | description:  Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the total, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. 
+              - name: value  | type: ValueAggregation | description:  Pass if `type` is `VALUE`. A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. 
+      - name: filter  | type: Record<string, any> | description:  Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
+      - name: search  | type: SearchDetails | description:  Search information. 
+          - name: expression  | type: string | description:  Search term or expression. 
+          - name: fields  | type: Array<string> | description:  Fields to search in. If the array is empty, all fields are searched. 
+          - name: fuzzy  | type: boolean | description:  Whether to allow the search function to automatically correct typos or minor mistakes in the search expression. The search function uses an algorithm to find results that are close to the text provided. 
+      - name: sort  | type: Array<Sorting> | description:  Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
+            - name: fieldName  | type: string | description:  Name of the field to sort by. 
+            - name: order  | type: SortOrder | description:  Sort order. 
+                enum: ASC, DESC
+      - ONE-OF: 
+        - name: paging  | type: Paging | description:  Paging options to limit and skip the number of items. 
+            - name: limit  | type: number | description:  Number of items to load. 
+            - name: offset  | type: number | description:  Number of items to skip in the current sort order. 
+  param name:  options | type: SearchOptions | description:  none 
+      - name: documentType  | type: DocumentType | description:  Document type to search in. | required: true
+          enum: BLOG_POSTS, BOOKING_SERVICES, EVENTS, FORUM_CONTENT, ONLINE_PROGRAMS, PROGALLERY_ITEM, STORES_PRODUCTS, UNSPECIFIED
+      - name: language  | type: string | description:  Language to search in. 
+Return type: PROMISE<SearchResponse>
+      - name: aggregationData  | type: AggregationData | description:  Aggregated data. 
+          - name: aggregationData.results  | type: Array<AggregationResults> | description:  List of the aggregated data results. 
+                - name: aggregationData.results[].fieldPath  | type: string | description:  Field the data was aggregated by. 
+                - name: aggregationData.results[].name  | type: string | description:  Aggregation name defined in the request. 
+                - name: aggregationData.results[].type  | type: AggregationType | description:  Type of aggregation that was performed. 
+                    enum: 
+                         NESTED: Multi-level aggregation, where each next aggregation is nested within previous one.
+                         SCALAR: A single-value metric aggregation - e.g. min, max, sum, avg.
+                       UNKNOWN_AGGREGATION_TYPE,   VALUE: An aggregation where result buckets are dynamically built - one per unique value.
+                - ONE-OF: 
+                  - name: aggregationData.results[].nested  | type: NestedResults | description:  Nested aggregation results. 
+                      - name: aggregationData.results[].nested.results  | type: Array<Results> | description:  List of nested aggregation results. 
+                            - name: aggregationData.results[].nested.results[].results  | type: Record<string, NestedResultValue> | description:  Aggregation results. 
+                  - name: aggregationData.results[].scalar  | type: AggregationResultsScalarResult | description:  Scalar aggregation results. 
+                      - name: aggregationData.results[].scalar.type  | type: ScalarType | description:  Type of scalar aggregation. 
+                          enum: 
+                               MAX: Maximum value.
+                               MIN: Minimum value.
+                               UNKNOWN_SCALAR_TYPE: Unknown scalar type.
+                      - name: aggregationData.results[].scalar.value  | type: number | description:  Value of the scalar aggregation. For example, the minimum, maximum, or total value for the specified field. 
+                  - name: aggregationData.results[].values  | type: ValueResults | description:  Value aggregation results. 
+                      - name: aggregationData.results[].values.results  | type: Array<ValueAggregationResult> | description:  List of value aggregation results. 
+                            - name: aggregationData.results[].values.results[].count  | type: number | description:  Number of documents containing the specified value in the specified field. 
+                            - name: aggregationData.results[].values.results[].value  | type: string | description:  Value contained in the field specified in `fieldPath` for this aggregation in the request. 
+      - name: siteDocumentItems  | type: Array<SiteDocument> | description:  Documents matching the search query. 
+            - name: siteDocumentItems[]._id  | type: string | description:  Result GUID. 
+            - name: siteDocumentItems[].data  | type: Record<string, any> | description:  The document payload. 
+      - ONE-OF: 
+        - name: pagingOffsetMetadata  | type: PagingMetadata | description:  Paging metadata. 
+            - name: pagingOffsetMetadata.count  | type: number | description:  Number of items returned in the response. 
+            - name: pagingOffsetMetadata.offset  | type: number | description:  Offset that was requested. 
+            - name: pagingOffsetMetadata.tooManyToCount  | type: boolean | description:  Whether the server failed to calculate the `total` field. 
+            - name: pagingOffsetMetadata.total  | type: number | description:  Total number of items that match the query. 
+
+```
+</type_definition>
+</search_wixSiteSearch_search>

package/dist/docs-output/api-docs/stores-collections-addProductsToCollection-doc.txt

@@ -0,0 +1,86 @@
+<stores_collections_addProductsToCollection>
+<description>
+# Method name:
+
+stores.products.addProductsToCollection(_id: string, productIds: Array<string>)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/products/add-products-to-collection
+
+# Method Description:
+
+Adds products to a specified collection.
+
+# Method Permissions:
+
+- WIX_STORES.MODIFY_PRODUCTS
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## Add products to a product collection 
+
+```javascript
+/**************************************
+* Backend code - products.web.js/ts *
+**************************************/
+
+import { Permissions, webMethod } from '@wix/web-methods';
+import { products } from '@wix/stores';
+
+export const addProductsToCollection = webMethod(Permissions.Anyone, (_id, productIds) => {
+ return products.addProductsToCollection(_id, productIds);
+});
+
+/*************
+* Page code *
+*************/
+
+import { addProductsToCollection } from 'backend/products.web';
+
+// ...
+
+const _id =  ... // get collection ID
+const productIds = ["id1", "id2", "id3"];
+
+addProductsToCollection(_id, productIds)
+ .then(() => {
+   // products added to the collection 
+ })
+ .catch((error) => {
+   // products not added to the collection 
+ });
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await products.addProductsToCollection("42631916-bdfe-487b-81a6-cbf9210c04f6", ["7bb38a7a-70b7-9cf3-fc80-584205694465", "a668ef33-f5b8-6569-d04c-1d123be68441"]);
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.products.addProductsToCollection(_id, productIds)
+Description: Adds products to a specified collection.
+Method parameters:
+  param name:  _id | type: string | description:  Collection GUID. | required: true
+  param name:  productIds | type: Array<string> | description:  IDs of the products to add to the collection, separated by commas. | required: true
+Return type: PROMISE<void>
+
+```
+</type_definition>
+</stores_collections_addProductsToCollection>

package/dist/docs-output/api-docs/stores-collections-createCollection-doc.txt

@@ -0,0 +1,108 @@
+<stores_collections_createCollection>
+<description>
+# Method name:
+
+stores.products.createCollection(collection: Collection)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/products/create-collection
+
+# Method Description:
+
+Creates a new collection.
+
+# Method Permissions:
+
+- WIX_STORES.MODIFY_PRODUCTS
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## createCollection
+
+```javascript
+import { products } from '@wix/stores';
+
+async function createCollection(collection) {
+ const response = await products.createCollection(collection);
+};
+```
+
+## createCollection (with elevated permissions)
+
+```javascript
+import { products } from '@wix/stores';
+import { auth } from '@wix/essentials';
+
+async function myCreateCollectionMethod(collection) {
+ const elevatedCreateCollection = auth.elevate(products.createCollection);
+ const response = await elevatedCreateCollection(collection);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+     const collection = { name: "New Cool Collection" };
+     const result = await products.createCollection(collection);
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.products.createCollection(collection)
+Description: Creates a new collection.
+Method parameters:
+  param name:  collection | type: Collection | description:  Collection info. | required: true
+      - name: description  | type: string | description:  Collection description. 
+      - name: name  | type: string | description:  Collection name. | required: true
+      - name: slug  | type: string | description:  Collection slug. 
+      - name: visible  | type: boolean | description:  Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. 
+Return type: PROMISE<CreateCollectionResponse>
+      - name: collection  | type: Collection | description:  Collection. 
+          - name: collection._id  | type: string | description:  Collection GUID (generated automatically by the catalog). 
+          - name: collection.description  | type: string | description:  Collection description. 
+          - name: collection.media  | type: Media | description:  Media items (images, videos etc) associated with this collection. Read only. 
+              - name: collection.media.items  | type: Array<MediaItem> | description:  Media (images, videos etc) associated with this product. 
+                    - name: collection.media.items[]._id  | type: string | description:  Media GUID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). 
+                    - name: collection.media.items[].mediaType  | type: MediaItemType | description:  Media item type (image, video, etc.). 
+                        enum: 
+                             audio: Audio media type.
+                             document: Document media type.
+                             image: Image media type.
+                           unspecified_media_item_type,   video: Video media type.
+                             zip: Zip media type.
+                    - name: collection.media.items[].thumbnail  | type: MediaItemUrlAndSize | description:  Media item thumbnail details. 
+                        - name: collection.media.items[].thumbnail.altText  | type: string | description:  Alt text. This text will be shown in case the image is not available. 
+                        - name: collection.media.items[].thumbnail.format  | type: string | description:  Media format (mp4, png, etc.). 
+                        - name: collection.media.items[].thumbnail.height  | type: number | description:  Media item height. 
+                        - name: collection.media.items[].thumbnail.url  | type: string | description:  Media item URL. 
+                        - name: collection.media.items[].thumbnail.width  | type: number | description:  Media item width. 
+                    - name: collection.media.items[].title  | type: string | description:  Media item title. 
+                    - ONE-OF: 
+                      - name: collection.media.items[].image  | type: MediaItemUrlAndSize | description:  Image data (URL, size). 
+                      - name: collection.media.items[].video  | type: MediaItemVideo | description:  Video data (URL, size). 
+                          - name: collection.media.items[].video.files  | type: Array<MediaItemUrlAndSize> | description:  Data (URL, size) about each resolution for which this video is available. 
+                          - name: collection.media.items[].video.stillFrameMediaId  | type: string | description:  GUID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. 
+              - name: collection.media.mainMedia  | type: MediaItem | description:  Primary media (image, video etc) associated with this product. 
+          - name: collection.name  | type: string | description:  Collection name. | required: true
+          - name: collection.numberOfProducts  | type: number | description:  Number of products in the collection. Read only. 
+          - name: collection.slug  | type: string | description:  Collection slug. 
+          - name: collection.visible  | type: boolean | description:  Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. 
+
+```
+</type_definition>
+</stores_collections_createCollection>

package/dist/docs-output/api-docs/stores-collections-getCollection-doc.txt

@@ -0,0 +1,102 @@
+<stores_collections_getCollection>
+<description>
+# Method name:
+
+stores.collections.getCollection(_id: string)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/collections/get-collection
+
+# Method Description:
+
+Retrieves a collection with the provided ID.
+
+# Method Permissions:
+
+
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## getCollection
+
+```javascript
+import { collections } from '@wix/stores';
+
+async function getCollection(id) {
+ const response = await collections.getCollection(id);
+};
+```
+
+## getCollection (with elevated permissions)
+
+```javascript
+import { collections } from '@wix/stores';
+import { auth } from '@wix/essentials';
+
+async function myGetCollectionMethod(id) {
+ const elevatedGetCollection = auth.elevate(collections.getCollection);
+ const response = await elevatedGetCollection(id);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await collections.getCollection("00000000-000000-000000-000000000001");
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.collections.getCollection(_id)
+Description: Retrieves a collection with the provided GUID.
+Method parameters:
+  param name:  _id | type: string | description:  Requested collection GUID. | required: true
+Return type: PROMISE<Collection>
+      - name: _id  | type: string | description:  Collection GUID (generated automatically by the catalog). 
+      - name: description  | type: string | description:  Collection description. 
+      - name: media  | type: Media | description:  Media items (images, videos etc) associated with this collection. Read only. 
+          - name: media.items  | type: Array<MediaItem> | description:  Media (images, videos etc) associated with this product. 
+                - name: media.items[]._id  | type: string | description:  Media GUID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). 
+                - name: media.items[].mediaType  | type: MediaItemType | description:  Media item type (image, video, etc.). 
+                    enum: 
+                         audio: Audio media type.
+                         document: Document media type.
+                         image: Image media type.
+                       unspecified_media_item_type,   video: Video media type.
+                         zip: Zip media type.
+                - name: media.items[].thumbnail  | type: MediaItemUrlAndSize | description:  Media item thumbnail details. 
+                    - name: media.items[].thumbnail.altText  | type: string | description:  Alt text. This text will be shown in case the image is not available. 
+                    - name: media.items[].thumbnail.format  | type: string | description:  Media format (mp4, png, etc.). 
+                    - name: media.items[].thumbnail.height  | type: number | description:  Media item height. 
+                    - name: media.items[].thumbnail.url  | type: string | description:  Media item URL. 
+                    - name: media.items[].thumbnail.width  | type: number | description:  Media item width. 
+                - name: media.items[].title  | type: string | description:  Media item title. 
+                - ONE-OF: 
+                  - name: media.items[].image  | type: MediaItemUrlAndSize | description:  Image data (URL, size). 
+                  - name: media.items[].video  | type: MediaItemVideo | description:  Video data (URL, size). 
+                      - name: media.items[].video.files  | type: Array<MediaItemUrlAndSize> | description:  Data (URL, size) about each resolution for which this video is available. 
+                      - name: media.items[].video.stillFrameMediaId  | type: string | description:  GUID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. 
+          - name: media.mainMedia  | type: MediaItem | description:  Primary media (image, video etc) associated with this product. 
+      - name: name  | type: string | description:  Collection name. 
+      - name: numberOfProducts  | type: number | description:  Number of products in the collection. Read only. 
+      - name: slug  | type: string | description:  Collection slug. 
+      - name: visible  | type: boolean | description:  Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. 
+
+```
+</type_definition>
+</stores_collections_getCollection>