diff --git a/wix-bookings-backend/wix-bookings-backend/Bookings/BookingsQueryBuilder.service.json b/wix-bookings-backend/wix-bookings-backend/Bookings/BookingsQueryBuilder.service.json index 32c7d59dbd..e3b319f5e3 100644 --- a/wix-bookings-backend/wix-bookings-backend/Bookings/BookingsQueryBuilder.service.json +++ b/wix-bookings-backend/wix-bookings-backend/Bookings/BookingsQueryBuilder.service.json @@ -1,7 +1,8 @@ { "name": "BookingsQueryBuilder", "memberOf": "wix-bookings-backend.Bookings", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "WixBookingsQueryBuilder.js" }, @@ -872,7 +873,7 @@ "description": [ "The `options` parameter is an optional parameter that can be used when", " calling the query [`find()`](#find) functions. To use `options`, pass it a `QueryOptions`", - " object with the following key:value pair:", + " object with the following `key:value` pair:", "", " + `\"suppressAuth\"`: `true`/`false`" ], "links": [], @@ -886,6 +887,7 @@ "optional": true } ], "extra": { }, - "labels": [] } ], + "labels": + [ "changed" ] } ], "extra": { } } \ No newline at end of file diff --git a/wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryBuilder.service.json b/wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryBuilder.service.json index 9fa51af783..86972bda70 100644 --- a/wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryBuilder.service.json +++ b/wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryBuilder.service.json @@ -1,7 +1,8 @@ { "name": "ResourceCatalogQueryBuilder", "memberOf": "wix-bookings-backend.Resources", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "ResourceCatalogQueryBuilder.js" }, @@ -13,7 +14,7 @@ "", " Typically, you build a query using the resource catalog query function,", " refine the query by chaining `ResourceCatalogQueryBuilder` functions, and then execute the", - " query by chaining the [`find()`](wix-bookings-backend.Resources/resourcescatalogquerybuilder/find) function.", + " query by chaining the [`find()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/find) function.", "", "For example, the following code queries extended resource information where the slug name is \"john-doe\", and logs the first 5 results to the console:", "", @@ -262,12 +263,13 @@ "extra": { } }, { "name": "limit", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "limit", "type": "number", - "doc": "The number of items to return, which is also the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) of the results object." } ], + "doc": "The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) of the results object." } ], "ret": { "type": "wix-bookings-backend.Resources.ResourceCatalogQueryBuilder", "doc": "A `ResourceCatalogQueryBuilder` object representing the refined query." }, @@ -278,8 +280,8 @@ { "summary": "Limits the number of items the query returns.", "description": [ "The `limit()` function defines the number of results a query returns in each", - " page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next)", - " and [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) functions are used to", + " page. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next)", + " and [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) functions are used to", " navigate the pages of a query result.", "", " By default, `limit` is set to `50`.", @@ -402,7 +404,7 @@ "description": [ "The `options` parameter is an optional parameter that can be used when", " calling the query [`find()`](wix-bookings-backend.Resources/resourcescatalogquerybuilder/find) functions. To use `options`, pass it a `QueryOptions`", - " object with the following key:value pair:", + " object with the following `key:value` pair:", "", " + `\"includeDeleted\"`: `true`/`false`" ], "links": [], @@ -416,6 +418,7 @@ "optional": true } ], "extra": { }, - "labels": [] } ], + "labels": + [ "changed" ] } ], "extra": { } } \ No newline at end of file diff --git a/wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryResult.service.json b/wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryResult.service.json index 225252ab5a..571154020a 100644 --- a/wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryResult.service.json +++ b/wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryResult.service.json @@ -1,14 +1,15 @@ { "name": "ResourceCatalogQueryResult", "memberOf": "wix-bookings-backend.Resources", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 2, "filename": "ResourceCatalogQueryResult.js" }, "docs": { "summary": "The results of a resource catalog query, containing the retrieved items.", "description": - [ "When you execute a query with the [`find()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/find)", + [ "When you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/find)", " function, it returns a Promise that resolves to a `ResourceCatalogQueryResult` object.", " This object contains the items that match the query, information about the", " query itself, and functions for paging through the query results." ], @@ -18,7 +19,8 @@ { } }, "properties": [ { "name": "currentPage", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": "number", @@ -30,10 +32,10 @@ "description": [ "The `currentPage` is a zero-based index of the current page of results.", "", - " The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)", - " function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and", - " navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and", - " [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.", + " The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)", + " function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and", + " navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and", + " [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions.", "", " The `currentPage` property returns `undefined` if the query returned no results." ], "links": [], @@ -64,7 +66,8 @@ "extra": { } }, { "name": "items", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": @@ -79,10 +82,10 @@ "description": [ "The current page of resources, slugs, and schedules retrieved by the query.", "", - " The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)", - " function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and", - " navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and", - " [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.", + " The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)", + " function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and", + " navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and", + " [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions.", "", " When no items match the query, the array is empty." ], "links": [], @@ -256,7 +259,8 @@ "extra": { } }, { "name": "length", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": "number", @@ -266,10 +270,10 @@ "docs": { "summary": "Returns the number of items in the current results page.", "description": - [ "The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)", - " function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and", - " navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and", - " [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions." ], + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)", + " function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and", + " navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and", + " [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions." ], "links": [], "examples": [ { "title": "Get the length of a query result", @@ -298,7 +302,8 @@ "extra": { } }, { "name": "pageSize", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": "number", @@ -308,9 +313,9 @@ "docs": { "summary": "Returns the query page size.", "description": - [ "The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit) function, can be retrieved using ", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit) function, can be retrieved using ", "the `pageSize` property, and navigating through pages is done with ", - "the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions." ], + "the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions." ], "links": [], "examples": [ { "title": "Get the page size of a query result", @@ -424,7 +429,8 @@ "extra": { } }, { "name": "totalPages", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": "number", @@ -434,10 +440,10 @@ "docs": { "summary": "Returns the total number of pages the query produced.", "description": - [ "The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)", - " function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and", - " navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and", - " [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions." ], + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)", + " function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and", + " navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and", + " [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions." ], "links": [], "examples": [ { "title": "Get the total number of pages in a query result", @@ -534,7 +540,8 @@ "extra": { } }, { "name": "next", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [], "ret": @@ -551,10 +558,10 @@ "description": [ "The `next()` function retrieves the next page of query results.", "", - " The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)", - " function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and", - " navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and", - " [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.", + " The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)", + " function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and", + " navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and", + " [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions.", "", " If items are added or removed between calls to `next()` the values returned", " by `ResourceCatalogQueryResult` may change." ], @@ -607,7 +614,8 @@ "extra": { } }, { "name": "prev", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [], "ret": @@ -624,10 +632,10 @@ "description": [ "The `prev()` function retrieves the previous page of query results.", "", - " The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)", - " function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and", - " navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and", - " [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.", + " The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)", + " function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and", + " navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and", + " [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions.", "", " If items are added or removed between calls to `prev()` the values returned", " may change." ], diff --git a/wix-bookings-backend/wix-bookings-backend/Sessions/SessionQueryBuilder.service.json b/wix-bookings-backend/wix-bookings-backend/Sessions/SessionQueryBuilder.service.json index 280f870877..990e36a0fa 100644 --- a/wix-bookings-backend/wix-bookings-backend/Sessions/SessionQueryBuilder.service.json +++ b/wix-bookings-backend/wix-bookings-backend/Sessions/SessionQueryBuilder.service.json @@ -1,7 +1,8 @@ { "name": "SessionQueryBuilder", "memberOf": "wix-bookings-backend.Sessions", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "SessionQueryBuilder.js" }, @@ -613,7 +614,7 @@ "description": [ "The `options` parameter is an optional parameter that can be used when", " calling the query [`find()`](wix-bookings-backend/sessions/session-query-builder/find) functions. To use `options`, pass it a `QueryOptions`", - " object with the following key:value pair:", + " object with the following `key:value` pair:", "", " + `\"suppressAuth\"`: `true`/`false`" ], "links": [], @@ -627,6 +628,7 @@ "optional": true } ], "extra": { }, - "labels": [] } ], + "labels": + [ "changed" ] } ], "extra": { } } \ No newline at end of file diff --git a/wix-crm-backend/wix-crm-backend.service.json b/wix-crm-backend/wix-crm-backend.service.json index 07f51bd067..7dccfb3ea4 100644 --- a/wix-crm-backend/wix-crm-backend.service.json +++ b/wix-crm-backend/wix-crm-backend.service.json @@ -1,6 +1,7 @@ { "name": "wix-crm-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "contacts.js" }, @@ -634,11 +635,12 @@ [ "string", "number", "Date" ], - "doc": "Any\n number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n are used to store additional information about your site's contacts. When\n setting a custom field, use key:value pairs, where the key matches the display names\n in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n You can only set values for custom fields that already exist in the Contacts\n application.", + "doc": "Any\n number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n are used to store additional information about your site's contacts. When\n setting a custom field, use `key:value` pairs, where the key matches the display names\n in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n You can only set values for custom fields that already exist in the Contacts\n application.", "optional": true } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "DeleteOptions", "locations": [ { "lineno": 213, diff --git a/wix-crm-backend/wix-crm-backend/Contacts.service.json b/wix-crm-backend/wix-crm-backend/Contacts.service.json index bf6c1356fc..1561b64e97 100644 --- a/wix-crm-backend/wix-crm-backend/Contacts.service.json +++ b/wix-crm-backend/wix-crm-backend/Contacts.service.json @@ -2806,7 +2806,8 @@ "extra": { } }, { "name": "queryLabels", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [], "ret": @@ -2824,7 +2825,7 @@ "", "The returned object contains the query definition,", "which is used to run the query using the", - "[`find()`](wix-crm-backend/contacts/labels-query-builder/find)", + "[`find()`](https://dev.wix.com/docs/velo/apis/wix-crm-backend/contacts/labels-query-builder/find)", "function.", "", "You can refine the query", @@ -2844,7 +2845,7 @@ "> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)", "> can query labels.", "> You can override the permissions by setting the `suppressAuth` option to `true`", - "> in the [`find()`](wix-crm-backend/contacts/labels-query-builder/find) function.", + "> in the [`find()`](https://dev.wix.com/docs/velo/apis/wix-crm-backend/contacts/labels-query-builder/find) function.", "", "For property support for filters and sorting, see", "[Query labels: Supported filters and sorting](wix-crm-backend/contacts/sort,-filter,-and-search)." ], @@ -3786,8 +3787,7 @@ "optional": true } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "ContactPicture", "locations": [ { "lineno": 335, @@ -4074,8 +4074,7 @@ "optional": true } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "Label", "locations": [ { "lineno": 534, @@ -4150,8 +4149,7 @@ "doc": "Contact's last action in the site.\n\n\n\n\nSome possible values:\n`\"GENERAL\"`, `\"CONTACT_CREATED\"`, `\"MEMBER_LOGIN\"`, `\"MEMBER_REGISTER\"`,\n`\"MEMBER_STATUS_CHANGED\"`, `\"FORM_SUBMITTED\"`, `\"INBOX_FORM_SUBMITTED\"`,\n`\"INBOX_PAYMENT_REQUEST_PAID\"`, `\"INBOX_MESSAGE_TO_CUSTOMER\"`,\n`\"INBOX_MESSAGE_FROM_CUSTOMER\"`, `\"NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED\"`,\n`\"NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE\"`, `\"ECOM_PURCHASE\"`,\n`\"ECOM_CART_ABANDON\"`, `\"ECOM_CHECKOUT_BUYER\"`, `\"BOOKINGS_APPOINTMENT\"`,\n`\"HOTELS_RESERVATION\"`, `\"HOTELS_PURCHASE\"`, `\"HOTELS_CONFIRMATION\"`,\n`\"HOTELS_CANCEL\"`, `\"VIDEO_PURCHASE\"`, `\"VIDEO_RENT\"`,\n`\"CASHIER_BUTTON_PURCHASE\"`, `\"ARENA_NEW_LEAD\"`, `\"EVENTS_RSVP\"`,\n`\"INVOICE_PAY\"`, `\"INVOICE_OVERDUE\"`, `\"PRICE_QUOTE_ACCEPT\"`,\n`\"PRICE_QUOTE_EXPIRE\"`, `\"RESTAURANTS_ORDER\"`, `\"RESTAURANTS_RESERVATION\"`,\n`\"SHOUTOUT_OPEN\"`, `\"SHOUTOUT_CLICK\"`, `\"CONTACT_MERGED\"`.\n" } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "ListOptions", "locations": [ { "lineno": 9, diff --git a/wix-crm-backend/wix-crm-backend/Contacts/LabelsQueryBuilder.service.json b/wix-crm-backend/wix-crm-backend/Contacts/LabelsQueryBuilder.service.json index bd762b7a6c..259d300808 100644 --- a/wix-crm-backend/wix-crm-backend/Contacts/LabelsQueryBuilder.service.json +++ b/wix-crm-backend/wix-crm-backend/Contacts/LabelsQueryBuilder.service.json @@ -1,7 +1,8 @@ { "name": "LabelsQueryBuilder", "memberOf": "wix-crm-backend.Contacts", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "queryLabels.js" }, @@ -13,7 +14,7 @@ "", "Typically, you build a query using the `queryLabels()` function,", "refine the query by chaining `LabelsQueryBuilder` functions, and then execute the", - "query by chaining the [`find()`](wix-crm-backend/contacts/query-labels/find) function.", + "query by chaining the [`find()`](https://dev.wix.com/docs/velo/apis/wix-crm-backend/contacts/labels-query-builder/find) function.", "", "For example, the following code returns the first 5 labels that were created", "by sorting them in ascending order:", @@ -35,7 +36,7 @@ "> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)", "> can query labels.", "> You can override the permissions by setting the `suppressAuth` option to `true`", - "> in the [`find()`](wix-crm-backend/contacts/query-labels/find) function." ], + "> in the [`find()`](https://dev.wix.com/docs/velo/apis/wix-crm-backend/contacts/labels-query-builder/find) function." ], "links": [], "examples": [], "extra": @@ -189,7 +190,8 @@ "extra": { } }, { "name": "find", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "options", @@ -201,7 +203,7 @@ { "name": "Promise", "typeParams": [ "wix-crm-backend.Contacts.LabelsQueryResult" ] }, - "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-crm-backend/contacts/labels-query-builder/find)\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 137, "filename": "queryLabels.js" } ], diff --git a/wix-crm-backend/wix-crm-backend/Contacts/LabelsQueryResult.service.json b/wix-crm-backend/wix-crm-backend/Contacts/LabelsQueryResult.service.json index 921b3cb9e7..339f92714c 100644 --- a/wix-crm-backend/wix-crm-backend/Contacts/LabelsQueryResult.service.json +++ b/wix-crm-backend/wix-crm-backend/Contacts/LabelsQueryResult.service.json @@ -1,14 +1,15 @@ { "name": "LabelsQueryResult", "memberOf": "wix-crm-backend.Contacts", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 162, "filename": "queryLabels.js" }, "docs": { "summary": "The results of a contacts query, containing the retrieved items.", "description": - [ "When you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)", + [ "When you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-crm-backend/contacts/labels-query-builder/find)", "function, it returns a Promise that resolves to a `LabelsQueryResult` object.", "This object contains the items that match the query, information about the", "query itself, and functions for paging through the query results." ], @@ -303,7 +304,8 @@ "extra": { } }, { "name": "next", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [], "ret": @@ -311,7 +313,7 @@ { "name": "Promise", "typeParams": [ "wix-crm-backend.Contacts.LabelsQueryResult" ] }, - "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-crm-backend/contacts/labels-query-builder/find)\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 273, "filename": "queryLabels.js" } ], @@ -369,7 +371,8 @@ "extra": { } }, { "name": "prev", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [], "ret": @@ -377,7 +380,7 @@ { "name": "Promise", "typeParams": [ "wix-crm-backend.Contacts.LabelsQueryResult" ] }, - "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-crm-backend/contacts/labels-query-builder/find)\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 296, "filename": "queryLabels.js" } ], diff --git a/wix-crm-backend/wix-crm-backend/Events.service.json b/wix-crm-backend/wix-crm-backend/Events.service.json index 598793a43b..df0c5f951b 100644 --- a/wix-crm-backend/wix-crm-backend/Events.service.json +++ b/wix-crm-backend/wix-crm-backend/Events.service.json @@ -1,7 +1,8 @@ { "name": "Events", "memberOf": "wix-crm-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "events.js" }, @@ -1416,7 +1417,7 @@ { "name": "Array", "typeParams": [ "wix-crm-backend.Events.FormField" ] }, - "doc": "Data submitted in the Wix Form. The object contains key:value pairs where the key is the field name and the value is the contents of the field." }, + "doc": "Data submitted in the Wix Form. The object contains `key:value` pairs where the key is the field name and the value is the contents of the field." }, { "name": "attachments", "type": { "name": "Array", @@ -1425,7 +1426,8 @@ "doc": "The Wix Form's attachments." } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "UpdateAndDeleteMetadata", "locations": [ { "lineno": 105, diff --git a/wix-crm-backend/wix-crm-backend/Tasks.service.json b/wix-crm-backend/wix-crm-backend/Tasks.service.json index 8389fcca9f..52e3ba0428 100644 --- a/wix-crm-backend/wix-crm-backend/Tasks.service.json +++ b/wix-crm-backend/wix-crm-backend/Tasks.service.json @@ -1,7 +1,8 @@ { "name": "Tasks", "memberOf": "wix-crm-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "tasks.js" }, @@ -16,7 +17,7 @@ "", " The Tasks API is used to manage a site's tasks.", "", - " Use [tasks](https://support.wix.com/en/article/about-tasks-reminders) to", + " Use [tasks](https://support.wix.com/en/article/wix-contacts-creating-and-managing-tasks-reminders) to", " organize and prioritize your work with [Ascend by Wix](https://support.wix.com/en/article/about-ascend-by-wix).", "", " To use the Tasks API, import `tasks` from the `wix-crm-backend` module:", diff --git a/wix-dashboard/wix-dashboard.service.json b/wix-dashboard/wix-dashboard.service.json index 9cfd10b62e..411e123350 100644 --- a/wix-dashboard/wix-dashboard.service.json +++ b/wix-dashboard/wix-dashboard.service.json @@ -41,7 +41,7 @@ "", "### Pages created with Wix Blocks", "", - "Dashboard pages created with Wix Blocks are always part of an [app](https://dev.wix.com/docs/build-an-app/develop-your-app/frameworks/wix-blocks/getting-started-with-blocks/welcome-to-wix-blocks). The code on these pages can access APIs with the permissions of the currently logged-in user, but only if the app has also been granted those permissions.", + "Dashboard pages created with Wix Blocks are always part of an [app](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-blocks/about-wix-blocks). The code on these pages can access APIs with the permissions of the currently logged-in user, but only if the app has also been granted those permissions.", "", "![Dashboard Permissions](../assets/images/dashboard-permissions.png)", "", @@ -53,7 +53,8 @@ "properties": [], "operations": [ { "name": "addSitePlugin", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "pluginId", @@ -72,9 +73,9 @@ [ { "lineno": 1, "filename": "sitePlugins.js" } ], "docs": - { "summary": "
\n\n__Important:__\n\nThis API is in [Developer Preview](https://www.wix.com/velo/reference/api-overview/developer-preview) and is subject to change. \n\n
\n\nAdds a site plugin to one of the slots supported in an app created by Wix. You can specify a single slot in which you want to add the plugin, or add the plugin to one of the available slots based on a list of prioritized slots that you configure in the plugin's installation settings in your [app's dashboard](https://manage.wix.com/studio/custom-apps).", + { "summary": "
\n\n__Important:__\n\nThis API is in [Developer Preview](https://www.wix.com/velo/reference/api-overview/developer-preview) and is subject to change. \n\n
\n\nAdds a site plugin to one of the slots supported in an [app created by Wix](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/apps-created-by-wix). You can optionally specify a single slot in which you want to add the plugin. If you don't specify a slot, your plugin is placed in the first available slot according to the order you defined in the plugin's installation settings in your [app's dashboard](https://manage.wix.com/account/custom-apps). If that slot is occupied, it's added in the next available slot, and so on. If there are no available slots, it isn't added.", "description": - [ "> This function can only be used in page code files for dashboard pages created in the [Wix editor](https://support.wix.com/en/article/velo-working-with-dashboard-pages) or with [Wix Blocks](https://support.wix.com/en/article/wix-blocks-creating-and-managing-blocks-dashboard-pages).", + [ "> This function can only be used in dashboard pages created with [Wix Blocks](https://support.wix.com/en/article/wix-blocks-creating-and-managing-blocks-dashboard-pages).", "", "The `addSitePlugin()` function returns a Promise that resolves when the plugin is added to the site.", "", @@ -88,13 +89,9 @@ "// ...", "", "const pluginId = '975bffb7-3c04-42cc-9840-3d48c24e73d5';", - "const pluginPlacement = {", - " appDefinitionId: '13d21c63-b5ec-5912-8397-c3a5ddb27a97',", - " widgetId: 'a91a0543-d4bd-4e6b-b315-9410aa27bcde',", - " slotId: 'slot1',", - "};", + "const slotId = 'a91a0543-d4bd-4e6b-b315-9410aa27bcde';", "", - "addSitePlugin(pluginId, { placement: pluginPlacement })", + "addSitePlugin(pluginId, { slotId })", " .then(() => {", " console.log('Plugin added successfully');", " })", @@ -268,8 +265,7 @@ "extra": { } }, { "name": "onBeforeUnload", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "callback", @@ -687,7 +683,7 @@ [ { "lineno": 31, "filename": "sitePlugins.js" } ], "docs": - { "summary": "An object representing the options to use when adding a site plugin.", + { "summary": "An object representing the options to use when adding a site plugin.\n> **Note**: The `placement` property is deprecated. Use the `slotId` property instead.", "links": [], "examples": [], "extra": @@ -695,11 +691,15 @@ "members": [ { "name": "placement", "type": "wix-dashboard.PluginPlacement", - "doc": "Optional. Details of the slot in which you want to add the plugin. You can find this information in the articles about the [slots that are available on Wix app pages](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/supported-wix-app-pages/about-slots). If you do not include this property, your plugin is placed in the first available slot according to the order you defined in the plugin's installation settings in your app's dashboard. If that slot is occupied, it is added in the next available slot, and so on. If there are no available slots, it is not added.", - "optional": true } ], + "doc": "**(Deprecated)** Optional. Details of the slot in which you want to add the plugin using the legacy slot notation method. Use the `slotId` property instead.", + "optional": true }, + { "name": "slotId", + "type": "string", + "doc": "Optional. The ID of the slot in which you want to add the plugin. Learn more about the [slots available on Wix app pages](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/supported-wix-app-pages/about-slots)." } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "Archive", "locations": [ { "lineno": 90, @@ -1135,7 +1135,7 @@ "labels": [] }, { "name": "PluginPlacement", "locations": - [ { "lineno": 38, + [ { "lineno": 40, "filename": "sitePlugins.js" } ], "docs": { "summary": "An object representing a slot in which to add a plugin.", @@ -1152,10 +1152,11 @@ "doc": "ID of the host widget in which the slot is located." }, { "name": "slotId", "type": "string", - "doc": "ID of the slot." } ], + "doc": "ID of the slot in the host widget using the legacy slot notation method." } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "Serializable", "locations": [ { "lineno": 39, @@ -1340,4 +1341,4 @@ "labels": [] } ], "extra": { "scopes": - [ "frontend" ] } } + [ "frontend" ] } } \ No newline at end of file diff --git a/wix-data/DataHooks.service.json b/wix-data/DataHooks.service.json index 66417a6874..696308b951 100644 --- a/wix-data/DataHooks.service.json +++ b/wix-data/DataHooks.service.json @@ -1,6 +1,7 @@ { "name": "DataHooks", "mixes": [], - "labels": [], + "labels": + [ "removed" ], "location": { "lineno": 20, "filename": "hooks-standalone.js" }, diff --git a/wix-data/wix-data.service.json b/wix-data/wix-data.service.json index ba7caed3a8..3a187e1c1f 100644 --- a/wix-data/wix-data.service.json +++ b/wix-data/wix-data.service.json @@ -1,6 +1,7 @@ { "name": "wix-data", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 72, "filename": "data-api.js" }, @@ -1100,7 +1101,8 @@ "extra": { } }, { "name": "filter", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [], "ret": @@ -1113,7 +1115,7 @@ { "summary": "Creates a filter to be used with datasets and aggregations.", "description": [ "The `filter()` function builds a filter to be applied to a dataset or an aggregation, and returns a [`WixDataFilter`](wix-data.WixDataFilter.html) object.", - "The returned object contains the filter definition and is used with the [`setFilter()`](wix-dataset.Dataset.html#setFilter) function.", + "The returned object contains the filter definition and is used with the [`setFilter()`](https://dev.wix.com/docs/velo/velo-only-apis/$w/dataset/set-filter) function.", "", "When working with [Wix app collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code), check [which fields](https://support.wix.com/en/search?term=velo%20collection%20fields) can be used in a filter." ], "links": [], @@ -3128,7 +3130,7 @@ "description": [ "The `options` parameter is an optional parameter that can be used when", " calling some wix-data functions. To use `options`, pass it a `WixDataOptions`", - " object with one or more of the following key:value pairs:", + " object with one or more of the following `key:value` pairs:", "", " + `suppressAuth`: `true`/`false`", " + `suppressHooks`: `true`/`false`", @@ -3188,7 +3190,8 @@ "optional": true } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "WixDataQueryOptions", "locations": [ { "lineno": 29, @@ -3198,7 +3201,7 @@ "description": [ "The `options` parameter is an optional parameter that can be used when", " calling some wix-data functions. To use `options`, pass it a `WixDataOptions`", - " object with one or more of the following key:value pairs:", + " object with one or more of the following `key:value` pairs:", "", " + `suppressAuth`: `true`/`false`", " + `suppressHooks`: `true`/`false`", @@ -3267,7 +3270,8 @@ "optional": true } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "WixDataQueryReferencedOptions", "locations": [ { "lineno": 659, diff --git a/wix-data/wix-data/WixDataAggregate.service.json b/wix-data/wix-data/WixDataAggregate.service.json index 1d6413a11a..33e69e9fc5 100644 --- a/wix-data/wix-data/WixDataAggregate.service.json +++ b/wix-data/wix-data/WixDataAggregate.service.json @@ -1,7 +1,8 @@ { "name": "WixDataAggregate", "memberOf": "wix-data", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "aggregate.js" }, @@ -147,7 +148,8 @@ "extra": { } }, { "name": "avg", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "propertyName", @@ -171,7 +173,7 @@ " whole collection if no group is defined.", "", " When the aggregation is [run](#run), the returned `WixDataAggregateResult`", - " object contains an item for each group with the following key:value pairs:", + " object contains an item for each group with the following `key:value` pairs:", "", " + If a value was passed for the optional `projectedName`, the key is named", " using that value. Otherwise, the key is named using the following format:", @@ -321,7 +323,8 @@ "extra": { } }, { "name": "count", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [], "ret": @@ -337,7 +340,7 @@ " count in each of the aggregate's groups.", "", " When the aggregation is [run](#run), the returned `WixDataAggregateResult`", - " object contains items with the following additional key:value pair:", + " object contains items with the following additional `key:value` pair:", "", " + The key is named `\"count\"`.", " + The value is the count of items aggregated in the group.", @@ -1050,7 +1053,8 @@ "extra": { } }, { "name": "max", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "propertyName", @@ -1074,7 +1078,7 @@ " whole collection if no group is defined.", "", " When the aggregation is [run()](wix-data.WixDataAggregate.html#run), the returned `WixDataAggregateResult`", - " object contains an item for each group with the following key:value pairs:", + " object contains an item for each group with the following `key:value` pairs:", "", " + If a value was passed for the optional `projectedName`, the key is named", " using that value. Otherwise, the key is named using the following format:", @@ -1244,7 +1248,8 @@ "extra": { } }, { "name": "min", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "propertyName", @@ -1268,7 +1273,7 @@ " whole collection if no group is defined.", "", " When the aggregation is [run](#run), the returned `WixDataAggregateResult`", - " object contains an item for each group with the following key:value pairs:", + " object contains an item for each group with the following `key:value` pairs:", "", " + If a value was passed for the optional `projectedName`, the key is named", " using that value. Otherwise, the key is named using the following format:", @@ -1636,7 +1641,8 @@ "extra": { } }, { "name": "sum", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "propertyName", @@ -1660,7 +1666,7 @@ " whole collection if no group is defined.", "", " When the aggregation is [run](#run), the returned `WixDataAggregateResult`", - " object contains an item for each group with the following key:value pairs:", + " object contains an item for each group with the following `key:value` pairs:", "", " + If a value was passed for the optional `projectedName`, the key is named", " using that value. Otherwise, the key is named using the following format:", @@ -1830,7 +1836,7 @@ "description": [ "The `options` parameter is an optional parameter that can be used when", " calling the aggregate [`run()`](wix-data.wixdataaggregate/run) function. To use `options`, pass it a `RunOptions`", - " object with the following key:value pair:", + " object with the following `key:value` pair:", "", " + `suppressAuth`: `true`/`false`", " + `consistentRead`: `true`/`false`" ], @@ -1853,6 +1859,7 @@ "optional": true } ], "extra": { }, - "labels": [] } ], + "labels": + [ "changed" ] } ], "extra": { } } \ No newline at end of file diff --git a/wix-data/wix-data/WixDataDistinct.service.json b/wix-data/wix-data/WixDataDistinct.service.json index 04685d64df..60f5e1d077 100644 --- a/wix-data/wix-data/WixDataDistinct.service.json +++ b/wix-data/wix-data/WixDataDistinct.service.json @@ -2,8 +2,7 @@ "memberOf": "wix-data", "mixes": [ "wix-data.WixDataFilter" ], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "distinct.js" }, @@ -196,8 +195,7 @@ "extra": { } }, { "name": "getFilter", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret": @@ -373,8 +371,7 @@ "extra": { } }, { "name": "limit", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "limit", diff --git a/wix-events-backend/wix-events-backend/Events.service.json b/wix-events-backend/wix-events-backend/Events.service.json index bfe83bb965..0c4c057984 100644 --- a/wix-events-backend/wix-events-backend/Events.service.json +++ b/wix-events-backend/wix-events-backend/Events.service.json @@ -1,7 +1,8 @@ { "name": "Events", "memberOf": "wix-events-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 62, "filename": "events.js" }, @@ -922,7 +923,8 @@ "extra": { } }, { "name": "onOrderUpdated", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "event", @@ -1006,7 +1008,7 @@ " * \"ticketNumber\": \"FMXC-BZG3-OT021\",", " * \"ticketDefinitionId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\",", " * \"checkIn\": {", - " * \"created\": \"2020-04-28T12:24:20.102Z\"", + " * \"created\": \"2020-04-28T12:24:20.92Z\"", " * },", " * \"price\": {", " * \"amount\": \"123.00\",", @@ -4661,7 +4663,7 @@ " * \"ticketNumber\": \"FMXC-BZG3-OT021\",", " * \"ticketDefinitionId\": \"d72874cb-012a-4ad2-afbb-57fe8cf1e308\",", " * \"checkIn\": {", - " * \"created\": \"2020-04-28T12:24:20.102Z\"", + " * \"created\": \"2020-04-28T12:24:20.92Z\"", " * },", " * \"price\": {", " * \"amount\": \"123.00\",", @@ -4850,7 +4852,8 @@ "doc": "Tickets generated after payment." } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "PaidPlanDiscount", "locations": [ { "lineno": 61, diff --git a/wix-events-backend/wix-events-backend/WixEvents.service.json b/wix-events-backend/wix-events-backend/WixEvents.service.json index 8e4f47dfdb..bda8a72bfd 100644 --- a/wix-events-backend/wix-events-backend/WixEvents.service.json +++ b/wix-events-backend/wix-events-backend/WixEvents.service.json @@ -1482,7 +1482,7 @@ { "summary": "Creates a query to retrieve a list of Wix events.", "description": [ "The `queryEvents()` function builds a query to retrieve a list of Wix events and returns", - " a [EventsQueryBuilder](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/introduction) object.", + " an [EventsQueryBuilder](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/introduction) object.", "", " The returned object contains the query definition which is typically used to run the query", " using the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.", @@ -1523,7 +1523,7 @@ "", ">**Notes:**", "> + A guest can only see their own Wix events unless `suppressAuth` is set to `true` in the queryOptions for the [`find()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-builder/find) function.", - "> + When using the `queryEvents()` function immediately following a change to your Wix events, the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information. To solve this problem, you can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay querying for a number of seconds, following any changes to your Wix events data.", + "> + When using the `queryEvents()` function immediately following a change to your Wix events, the data retrieved may not contain your most recent changes. See [Wix Data and Eventual Consistency](https://dev.wix.com/docs/velo/apis/wix-data/introduction#apis_wix-data_wix-data-and-eventual-consistency) for more information. To solve this problem, you can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay querying for a number of seconds, following any changes to your Wix events data.", "", "", "", @@ -2512,7 +2512,7 @@ "description": [ "The `options` parameter is an optional parameter that can be used when", " calling the query `find()` function. To use `options`, pass it a `QueryOptions`", - " object with the following key:value pair:", + " object with the following `key:value` pair:", "", " + `\"suppressAuth\"`: `true`/`false`" ], "links": [], @@ -2526,7 +2526,8 @@ "optional": true } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "Registration", "locations": [ { "lineno": 216, diff --git a/wix-events-backend/wix-events-backend/WixEvents/EventsQueryBuilder.service.json b/wix-events-backend/wix-events-backend/WixEvents/EventsQueryBuilder.service.json index 470c4cecb0..0659b5848e 100644 --- a/wix-events-backend/wix-events-backend/WixEvents/EventsQueryBuilder.service.json +++ b/wix-events-backend/wix-events-backend/WixEvents/EventsQueryBuilder.service.json @@ -1,7 +1,8 @@ { "name": "EventsQueryBuilder", "memberOf": "wix-events-backend.WixEvents", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "event-query.js" }, @@ -1561,12 +1562,13 @@ "extra": { } }, { "name": "limit", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "limit", "type": "string", - "doc": "limit The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) of the results object." } ], + "doc": "The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/page-size) of the results object." } ], "ret": { "type": "wix-events-backend.WixEvents.EventsQueryBuilder", "doc": "Contains functionality for refining a Wix events query." }, @@ -1578,7 +1580,7 @@ "description": [ "The `limit()` function defines the number of results a query returns in each", "page. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/next)", - "and [`prev()`](wix-events-backend.eventsqueryresult.htmlhttps://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) functions are used to", + "and [`prev()`](https://dev.wix.com/docs/velo/api-reference/wix-events-backend/wix-events/events-query-result/prev) functions are used to", "navigate the pages of a query result.", "", "By default, `limit` is set to `50`.", diff --git a/wix-groups-backend/wix-groups-backend.service.json b/wix-groups-backend/wix-groups-backend.service.json index 65bf267eaa..0d1c056eb5 100644 --- a/wix-groups-backend/wix-groups-backend.service.json +++ b/wix-groups-backend/wix-groups-backend.service.json @@ -40,7 +40,7 @@ " + [Remove](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/remove-group-members) members of a group. ", "+ [Roles](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/roles/introduction)", " + [Assign](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/roles/assign-role) roles to members of a group. ", - " + [Unasssign](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/roles/unassign-role) roles to members of a group. ", + " + [Unassign](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/roles/unassign-role) roles to members of a group. ", "", "### Group Roles ", "", @@ -78,7 +78,7 @@ "+ If a group's privacy level is set to `SECRET`, group admins or group members can add additional members to their group.", "+ If a group's privacy level is set to `PUBLIC` or `PRIVATE`, group admins determine whether group members can add additional members to their group. ", "+ This setting can be found in your site's Dashboard under **Groups Application > Your Group > Admin Tools > Member Permissions**. ", - "+ If set to all members, group members can add additional members to the group using the [`addGroupMembers()`](https://dev.wix.com/docs/velo/api-reference/wix-groups-backend/members/add-group-member) function (no approval required). ", + "+ If set to all members, group members can add additional members to the group using the [`addGroupMembers()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/add-group-members) function (no approval required). ", "+ If set to admins only, only admins can add additional members to the group using the `addGroupMembers()` function.", "+ The default is set to admins only. ", "+ **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can add additional members to a group. ", diff --git a/wix-groups-backend/wix-groups-backend/CreateRequests.service.json b/wix-groups-backend/wix-groups-backend/CreateRequests.service.json index 32a42056e5..0ece89d57a 100644 --- a/wix-groups-backend/wix-groups-backend/CreateRequests.service.json +++ b/wix-groups-backend/wix-groups-backend/CreateRequests.service.json @@ -16,7 +16,7 @@ "### Settings for Typical Use Case", "+ Site admins determine who can create groups. They can choose to require that site members request approval when creating a group. ", "+ This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**. ", - "+ If set to admin approval required, a site member uses the [`createGroup()`](wix-groups-backend.Groups/creategroup) function to create a group, and the group becomes a `createRequest` with a status of `PENDING`. ", + "+ If set to admin approval required, a site member uses the [`createGroup()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/create-group) function to create a group, and the group becomes a `createRequest` with a status of `PENDING`. ", "+ Only a site admin can approve or reject requests to create a group. ", "+ **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members can approve or reject requests to create a group. ", "+ When a site member's request to create a group is approved, the `createRequest` status changes to `APPROVED`, and the newly created group is added to the Groups List page of your site.", @@ -482,25 +482,25 @@ [ "
", "", "> **Notes:** ", - "+ This function is only relevant if admin approval is required for creating a group, or if the function's `suppressAuth` option is set to `true`.", - "+ For `SECRET` groups, only site admins can query requests to create a group. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members can query requests to create secret groups.", + "> + This function is only relevant if admin approval is required for creating a group, or if the function's `suppressAuth` option is set to `true`.", + "> + For `SECRET` groups, only site admins can query requests to create a group. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members can query requests to create secret groups.", "", - "The `queryCreateRequests()` function builds a query to retrieve a list of all requests to create a group, and returns a [CreateRequestsQueryBuilder](wix-groups-backend/createrequests/createrequestsquerybuilder) object.", + "The `queryCreateRequests()` function builds a query to retrieve a list of all requests to create a group, and returns a [CreateRequestsQueryBuilder](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/introduction) object.", "", - "The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/createrequests/createrequestsquerybuilder/find) function. ", + "The returned object contains the query definition which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/find) function. ", "", "You can refine the query by chaining `CreateRequestsQueryBuilder` functions onto the query. `CreateRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryCreateRequests()` returns.", "", "`queryCreateRequests()` runs with these `CreateRequestsQueryBuilder` defaults, which you can override:", - " + [`limit(1000)`](wix-groups-backend/createrequests/createrequestsquerybuilder/limit)", - " + [`descending(\"_createdDate\")`](wix-groups-backend/createrequests/createrequestsquerybuilder/descending)", + " + [`limit(1000)`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/limit)", + " + [`descending(\"_createdDate\")`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/descending)", "", - "The following `CreateRequestsQueryBuilder` functions are supported for `queryCreateRequests()`. For a full description of the CreateRequests object, see the object returned for the [`items`](wix-groups-backend/createrequests/createrequestsqueryresult/items) property in [`CreateRequestsQueryResult`](wix-groups-backend/createrequests/createrequestsqueryresult).", + "The following `CreateRequestsQueryBuilder` functions are supported for `queryCreateRequests()`. For a full description of the CreateRequests object, see the object returned for the [`items`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-result/items) property in [`CreateRequestsQueryResult`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-result/introduction).", "", "| Property | Supported Filters & Sorting |", "| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |", - "| `status` | [`eq()`](wix-groups-backend/createrequests/createrequestsquerybuilder/eq), [`ne()`](wix-groups-backend/createrequests/createrequestsquerybuilder/ne), [`hasSome()`](wix-groups-backend/createrequests/createrequestsquerybuilder/hasSome), [`or()`](wix-groups-backend/createrequests/createrequestsquerybuilder/or) |", - "| `_createdDate` | [`ascending()`](wix-groups-backend/createrequests/createrequestsquerybuilder/ascending), [`descending()`](wix-groups-backend/createrequests/createrequestsquerybuilder/descending) |" ], + "| `status` | [`eq()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/ne), [`hasSome()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/has-some), [`or()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/or) |", + "| `_createdDate` | [`ascending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/descending) |" ], "links": [], "examples": [ { "title": "Query requests to create a group", diff --git a/wix-groups-backend/wix-groups-backend/CreateRequests/CreateRequestsQueryBuilder.service.json b/wix-groups-backend/wix-groups-backend/CreateRequests/CreateRequestsQueryBuilder.service.json index b07002aa70..8cbdb9822c 100644 --- a/wix-groups-backend/wix-groups-backend/CreateRequests/CreateRequestsQueryBuilder.service.json +++ b/wix-groups-backend/wix-groups-backend/CreateRequests/CreateRequestsQueryBuilder.service.json @@ -12,7 +12,7 @@ [ "The `CreateRequestsQueryBuilder` functions enable you to run, sort, filter, and control", "which results a query returns.", "", - "Typically, you build a query using the [`queryCreateRequests()`](wix-groups-backend/createrequests/querycreaterequests) function,", + "Typically, you build a query using the [`queryCreateRequests()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/query-create-requests) function,", "refine the query by chaining `CreateRequestsQueryBuilder` functions, and then execute the", "query by chaining the [`find()`](#find) function.", "", @@ -264,7 +264,8 @@ "extra": { } }, { "name": "find", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "options", @@ -276,7 +277,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.CreateRequests.CreateRequestsQueryResult" ] }, - "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.CreateRequestsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `CreateRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/find)\nfunction, it returns a Promise that resolves to a `CreateRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 462, "filename": "createRequests.js" } ], @@ -412,7 +413,7 @@ "params": [ { "name": "limit", "type": "string", - "doc": "limit The number of items to return, which is also the [`pageSize`](wix-groups-backend.CreateRequestsQueryResult.html#pageSize) of the results object." } ], + "doc": "The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-result/page-size) of the results object." } ], "ret": { "type": "wix-groups-backend.CreateRequests.CreateRequestsQueryBuilder", "doc": "A `CreateRequestsQueryBuilder` object representing the refined query." }, @@ -423,8 +424,8 @@ { "summary": "Limits the number of items the query returns.", "description": [ "The `limit()` function defines the number of results a query returns in each", - "page. Only one page of results is retrieved at a time. The [`next()`](wix-groups-backend.CreateRequestsQueryResult.html#next)", - "and [`prev()`](wix-groups-backend.CreateRequestsQueryResult.html#prev) functions are used to", + "page. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-result/next)", + "and [`prev()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-result/prev) functions are used to", "navigate the pages of a query result.", "", "By default, `limit` is set to `50`.", diff --git a/wix-groups-backend/wix-groups-backend/CreateRequests/CreateRequestsQueryResult.service.json b/wix-groups-backend/wix-groups-backend/CreateRequests/CreateRequestsQueryResult.service.json index aee7df9911..ba43cf3920 100644 --- a/wix-groups-backend/wix-groups-backend/CreateRequests/CreateRequestsQueryResult.service.json +++ b/wix-groups-backend/wix-groups-backend/CreateRequests/CreateRequestsQueryResult.service.json @@ -9,7 +9,7 @@ "docs": { "summary": "The results of a create request query, containing the retrieved items.", "description": - [ "When you execute a query with the [`find()`](wix-groups-backend.CreateRequestsQueryBuilder.html#find)", + [ "When you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/find)", "function, it returns a Promise that resolves to a `CreateRequestsQueryResult` object.", "This object contains the items that match the query, information about the", "query itself, and functions for paging through the query results." ], @@ -32,7 +32,7 @@ "description": [ "The `currentPage` is a zero-based index of the current page of results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.CreateRequestsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -229,7 +229,7 @@ "docs": { "summary": "Returns the number of items in the current results page.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.CreateRequestsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -272,7 +272,7 @@ "docs": { "summary": "Returns the query page size.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.CreateRequestsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -394,7 +394,7 @@ "docs": { "summary": "Returns the total number of pages the query produced.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.CreateRequestsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -436,7 +436,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.CreateRequests.CreateRequestsQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.CreateRequestsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `CreateRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/find)\nfunction, it returns a Promise that resolves to a `CreateRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 590, "filename": "createRequests.js" } ], @@ -445,7 +445,7 @@ "description": [ "The `next()` function retrieves the next page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.CreateRequestsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -500,7 +500,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.CreateRequests.CreateRequestsQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.CreateRequestsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `CreateRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/find)\nfunction, it returns a Promise that resolves to a `CreateRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 613, "filename": "createRequests.js" } ], @@ -509,7 +509,7 @@ "description": [ "The `prev()` function retrieves the previous page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.CreateRequestsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/create-requests/create-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", diff --git a/wix-groups-backend/wix-groups-backend/Groups.service.json b/wix-groups-backend/wix-groups-backend/Groups.service.json index 2af9b7e4dd..4e82387538 100644 --- a/wix-groups-backend/wix-groups-backend/Groups.service.json +++ b/wix-groups-backend/wix-groups-backend/Groups.service.json @@ -18,7 +18,7 @@ "", "### Settings for Typical Use Case", "+ Site admins determine who can create a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**.", - "+ If set to site members with admin approval, site members can create a group using the [`createGroup()`](wix-groups-backend.Groups/creategroup) function, and the group becomes a `createRequest` with a name of `PENDING`. The site admin either approves or rejects the request to create a group. ", + "+ If set to site members with admin approval, site members can create a group using the [`createGroup()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/create-group) function, and the group becomes a `createRequest` with a name of `PENDING`. The site admin either approves or rejects the request to create a group. ", "+ If set to all site members, site members can create a group using the `createGroup()` function (no approval required). ", "+ If set to only admins, only site admins can create a group using the `createGroup()` function.", "+ The default is set to site members with admin approval.", @@ -26,13 +26,13 @@ "+ When a group is created, the newly created group is added to the Groups List page of your site.", "", "The Groups API provides functionality allowing you to:", - " + [Create](wix-groups-backend.Groups/creategroup) a new group. ", - " + [Delete](wix-groups-backend.Groups/deletegroup) an existing group. ", - " + [Get](wix-groups-backend.Groups/getgroup) group information by ID. ", - " + [Get](wix-groups-backend.Groups/getgroupbyslug) group information by slug. ", - " + [List](wix-groups-backend.Groups/listgroups) all groups.", - " + [Query](wix-groups-backend.Groups/querygroups) groups. ", - " + [Update](wix-groups-backend.Groups/updategroup) group information.", + " + [Create](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/create-group) a new group. ", + " + [Delete](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/delete-group) an existing group. ", + " + [Get](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/get-group) group information by ID. ", + " + [Get](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/get-group-by-slug) group information by slug. ", + " + [List](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/list-groups) all groups.", + " + [Query](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/query-groups) groups. ", + " + [Update](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/update-group) group information.", "", "### Permissions Information", ">**Note:** You can override the permissions below by setting the `suppressAuth` option to `true`. ", @@ -699,24 +699,24 @@ "", "> **Note:** For `SECRET` groups, only site admins, group admins, and group members can query groups and their content. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query groups and their content. ", " ", - "The `queryGroups()` function builds a query to retrieve a list of all groups, and returns a [GroupsQueryBuilder](wix-groups-backend/groups/groupsquerybuilder) object.", + "The `queryGroups()` function builds a query to retrieve a list of all groups, and returns a [GroupsQueryBuilder](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/introduction) object.", "", - "The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/groups/groupsquerybuilder/find) function. ", + "The returned object contains the query definition which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/find) function. ", "", "You can refine the query by chaining `GroupsQueryBuilder` functions onto the query. `GroupsQueryBuilder` functions enable you to sort, filter, and control the results that `queryGroups()` returns.", "", " `queryGroups()` runs with these `GroupsQueryBuilder` defaults, which you can override:", - " + [`limit(1000)`](wix-groups-backend/groups/groupsquerybuilder/limit)", - " + [`descending(\"_createdDate\")`](wix-groups-backend/groups/groupsquerybuilder/descending)", + " + [`limit(1000)`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/limit)", + " + [`descending(\"_createdDate\")`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/descending)", "", - "The following `GroupsQueryBuilder` functions are supported for `queryGroups()`. For a full description of the Groups object, see the object returned for the [`items`](wix-groups-backend/groups/groupsqueryresult/items) property in [`GroupsQueryResult`](wix-groups-backend/groups/groupsqueryresult).", + "The following `GroupsQueryBuilder` functions are supported for `queryGroups()`. For a full description of the Groups object, see the object returned for the [`items`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-result/items) property in [`GroupsQueryResult`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-result/introduction).", "", "| Property | Supported Filters & Sorting |", "| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |", - "| `name` | [`eq()`](wix-groups-backend/groups/groupsquerybuilder/eq), [`ne()`](wix-groups-backend/groups/groupsquerybuilder/ne), [`startsWith()`](wix-groups-backend/groups/groupsquerybuilder/startsWith), [`endsWith()`](wix-groups-backend/groups/groupsquerybuilder/endsWith), [`contains()`](wix-groups-backend/groups/groupsquerybuilder/contains),[`hasSome()`](wix-groups-backend/groups/groupsquerybuilder/hasSome), [`ascending()`](wix-groups-backend/groups/groupsquerybuilder/ascending), [`descending()`](wix-groups-backend/groups/groupsquerybuilder/descending), [`or()`](wix-groups-backend/groups/groupsquerybuilder/or) |", - "| `_createdDate` | [`ascending()`](wix-groups-backend/groups/groupsquerybuilder/ascending), [`descending()`](wix-groups-backend/groups/groupsquerybuilder/descending) |", - "| `memberCount` | [`ascending()`](wix-groups-backend/groups/groupsquerybuilder/ascending), [`descending()`](wix-groups-backend/groups/groupsquerybuilder/descending) |", - "| `lastActivityDate` | [`ascending()`](wix-groups-backend/groups/groupsquerybuilder/ascending), [`descending()`](wix-groups-backend/groups/groupsquerybuilder/descending) |" ], + "| `name` | [`eq()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/ne), [`startsWith()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/starts-with), [`endsWith()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/ends-with), [`contains()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/contains),[`hasSome()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/has-some), [`ascending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/descending), [`or()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/or) |", + "| `_createdDate` | [`ascending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/descending) |", + "| `memberCount` | [`ascending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/descending) |", + "| `lastActivityDate` | [`ascending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/descending) |" ], "links": [], "examples": [ { "title": "Query groups", @@ -811,7 +811,8 @@ "extra": { } }, { "name": "updateGroup", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "groupId", @@ -841,10 +842,10 @@ "Only the fields in the `groupInfo` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same. ", "", "> **Notes:** ", - "+ If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can update a group. ", - "+ When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.", - "+ When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected.", - "+ When a public or private group's name is updated, the slug is updated to reflect the new group name." ], + "> + If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can update a group. ", + "> + When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.", + "> + When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected.", + "> + When a public or private group's name is updated, the slug is updated to reflect the new group name." ], "links": [], "examples": [ { "title": "Update a group", diff --git a/wix-groups-backend/wix-groups-backend/Groups/GroupsQueryBuilder.service.json b/wix-groups-backend/wix-groups-backend/Groups/GroupsQueryBuilder.service.json index 1bd50dc52c..eb4bbde136 100644 --- a/wix-groups-backend/wix-groups-backend/Groups/GroupsQueryBuilder.service.json +++ b/wix-groups-backend/wix-groups-backend/Groups/GroupsQueryBuilder.service.json @@ -12,7 +12,7 @@ [ "The `GroupsQueryBuilder` functions enable you to run, sort, filter, and control", "which results a query returns.", "", - "Typically, you build a query using the [`queryGroups()`](wix-groups-backend/groups/querygroups) function,", + "Typically, you build a query using the [`queryGroups()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/query-groups) function,", "refine the query by chaining `GroupsQueryBuilder` functions, and then execute the", "query by chaining the [`find()`](#find) function.", "", @@ -403,7 +403,8 @@ "extra": { } }, { "name": "find", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "options", @@ -415,7 +416,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Groups.GroupsQueryResult" ] }, - "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.GroupsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `GroupsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/find)\nfunction, it returns a Promise that resolves to a `GroupsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 594, "filename": "groups.js" } ], @@ -554,7 +555,7 @@ "params": [ { "name": "limit", "type": "string", - "doc": "The number of items to return, which is also the [`pageSize`](wix-groups-backend.GroupsQueryResult.html#pageSize) of the results object." } ], + "doc": "The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-result/page-size) of the results object." } ], "ret": { "type": "wix-groups-backend.Groups.GroupsQueryBuilder", "doc": "A `GroupsQueryBuilder` object representing the refined query." }, @@ -565,8 +566,8 @@ { "summary": "Limits the number of items the query returns.", "description": [ "The `limit()` function defines the number of results a query returns in each", - "page. Only one page of results is retrieved at a time. The [`next()`](wix-groups-backend.GroupsQueryResult.html#next)", - "and [`prev()`](wix-groups-backend.GroupsQueryResult.html#prev) functions are used to", + "page. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-result/next)", + "and [`prev()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-result/prev) functions are used to", "navigate the pages of a query result.", "", "By default, `limit` is set to `50`.", diff --git a/wix-groups-backend/wix-groups-backend/Groups/GroupsQueryResult.service.json b/wix-groups-backend/wix-groups-backend/Groups/GroupsQueryResult.service.json index 9700b6bfbe..4e72e4f20a 100644 --- a/wix-groups-backend/wix-groups-backend/Groups/GroupsQueryResult.service.json +++ b/wix-groups-backend/wix-groups-backend/Groups/GroupsQueryResult.service.json @@ -9,7 +9,7 @@ "docs": { "summary": "The results of a create request query, containing the retrieved items.", "description": - [ "When you execute a query with the [`find()`](wix-groups-backend.GroupsQueryBuilder.html#find)", + [ "When you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/find)", "function, it returns a Promise that resolves to a `GroupsQueryResult` object.", "This object contains the items that match the query, information about the", "query itself, and functions for paging through the query results." ], @@ -32,7 +32,7 @@ "description": [ "The `currentPage` is a zero-based index of the current page of results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.GroupsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -222,7 +222,7 @@ "docs": { "summary": "Returns the number of items in the current results page.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.GroupsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -265,7 +265,7 @@ "docs": { "summary": "Returns the query page size.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.GroupsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -387,7 +387,7 @@ "docs": { "summary": "Returns the total number of pages the query produced.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.GroupsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -429,7 +429,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Groups.GroupsQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.GroupsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `GroupsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/find)\nfunction, it returns a Promise that resolves to a `GroupsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 723, "filename": "groups.js" } ], @@ -438,7 +438,7 @@ "description": [ "The `next()` function retrieves the next page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.GroupsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -493,7 +493,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Groups.GroupsQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.GroupsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `GroupsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/find)\nfunction, it returns a Promise that resolves to a `GroupsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 746, "filename": "groups.js" } ], @@ -502,7 +502,7 @@ "description": [ "The `prev()` function retrieves the previous page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.GroupsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/groups/groups-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", diff --git a/wix-groups-backend/wix-groups-backend/JoinRequests.service.json b/wix-groups-backend/wix-groups-backend/JoinRequests.service.json index 18582b3696..39bd8c1aef 100644 --- a/wix-groups-backend/wix-groups-backend/JoinRequests.service.json +++ b/wix-groups-backend/wix-groups-backend/JoinRequests.service.json @@ -12,10 +12,10 @@ [ "The JoinRequests API provides functionality for managing requests to join a group.", "", "> **Notes:** ", - "+ This module is only relevant for private groups. ", - "+ When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.", - "+ When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected. ", - "+ A site member can only join a group if they have a [public profile](https://support.wix.com/en/article/wix-groups-member-privacy-settings-for-groups).", + "> + This module is only relevant for private groups. ", + "> + When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.", + "> + When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected. ", + "> + A site member can only join a group if they have a [public profile](https://support.wix.com/en/article/wix-groups-member-privacy-settings-for-groups).", " ", "### Settings for Typical Use Case", "+ Group members with group admin permissions determine who can join their group by setting their group [privacy level](https://support.wix.com/en/article/wix-groups-about-groups#your-groups-privacy-permissions).", @@ -27,10 +27,10 @@ "+ If a group's privacy level is set to `SECRET`, only site members added by an existing group member can join the group (no request necessary). ", " ", "The JoinRequests API provides functionality allowing you to: ", - " + [Approve](wix-groups-backend.joinRequests/approvejoinrequests) requests to join a group. ", - " + [List](wix-groups-backend.joinRequests/listjoinrequests) requests to join a group. ", - " + [Query](wix-groups-backend.joinRequests/queryjoinrequests) requests to join a group.", - " + [Reject](wix-groups-backend.joinRequests/rejectjoinrequests) requests to join a group. ", + " + [Approve](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/approve-join-requests) requests to join a group. ", + " + [List](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/list-join-requests) requests to join a group. ", + " + [Query](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/query-join-requests) requests to join a group.", + " + [Reject](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/reject-join-requests) requests to join a group. ", "", "### Permissions Information", ">**Note:** You can override the permissions below by setting the `suppressAuth` option to `true`. ", @@ -291,25 +291,25 @@ [ "
", "", "> **Notes:** ", - "+ This function is only relevant for private groups.", - "+ For `SECRET` groups, only site admins and group admins can query requests to join their group. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. ", + "> + This function is only relevant for private groups.", + "> + For `SECRET` groups, only site admins and group admins can query requests to join their group. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. ", "", - "The `queryJoinRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [JoinRequestsQueryBuilder](wix-groups-backend/joinrequests/joinrequestsquerybuilder) object.", + "The `queryJoinRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [JoinRequestsQueryBuilder](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/introduction) object.", "", - "The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/joinrequests/joinrequestsquerybuilder/find) function. ", + "The returned object contains the query definition which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/find) function. ", "", "You can refine the query by chaining `JoinRequestsQueryBuilder` functions onto the query. `JoinRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryJoinRequests()` returns.", "", "The results of the `queryJoinRequests()` function are sorted by `_createdDate` in descending order. ", "", "`queryJoinRequests()` runs with this `JoinRequestsQueryBuilder` default, which you can override:", - "+ [`limit(100)`](wix-groups-backend/joinrequests/joinrequestsquerybuilder/limit)", + "+ [`limit(100)`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/limit)", "", - "The following `JoinRequestsQueryBuilder` functions are supported for `queryJoinRequests()`. For a full description of the JoinRequests object, see the object returned for the [`items`](wix-groups-backend/joinrequests/joinrequestsqueryresult/items) property in [`JoinRequestsQueryResult`](wix-groups-backend/joinrequests/joinrequestsqueryresult).", + "The following `JoinRequestsQueryBuilder` functions are supported for `queryJoinRequests()`. For a full description of the JoinRequests object, see the object returned for the [`items`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-result/items) property in [`JoinRequestsQueryResult`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-result/introduction).", "", "| Property | Supported Filters & Sorting |", "| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |", - "| `status` | [`eq()`](wix-groups-backend/joinrequests/joinrequestsquerybuilder/eq), [`ne()`](wix-groups-backend/joinrequests/joinrequestsquerybuilder/ne), [`hasSome()`](wix-groups-backend/joinrequests/joinrequestsquerybuilder/hasSome), [`or()`](wix-groups-backend/joinrequests/joinrequestsquerybuilder/or) |" ], + "| `status` | [`eq()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/ne), [`hasSome()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/has-some), [`or()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/or) |" ], "links": [], "examples": [ { "title": "Query requests to join a group", diff --git a/wix-groups-backend/wix-groups-backend/JoinRequests/JoinRequestsQueryBuilder.service.json b/wix-groups-backend/wix-groups-backend/JoinRequests/JoinRequestsQueryBuilder.service.json index b1a82cd262..2b487b0b8d 100644 --- a/wix-groups-backend/wix-groups-backend/JoinRequests/JoinRequestsQueryBuilder.service.json +++ b/wix-groups-backend/wix-groups-backend/JoinRequests/JoinRequestsQueryBuilder.service.json @@ -12,7 +12,7 @@ [ "The `JoinRequestQueryBuilder` functions enable you to run, sort, filter, and control", "which results a query returns.", "", - "Typically, you build a query using the [`queryJoinRequests()`](wix-groups-backend/joinrequests/queryjoinrequests) function,", + "Typically, you build a query using the [`queryJoinRequests()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/query-join-requests) function,", "refine the query by chaining `JoinRequestsQueryBuilder` functions, and then execute the", "query by chaining the [`find()`](#find) function.", "", @@ -108,7 +108,8 @@ "extra": { } }, { "name": "find", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "options", @@ -120,7 +121,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.JoinRequests.JoinRequestsQueryResult" ] }, - "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.JoinRequestsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `JoinRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/find)\nfunction, it returns a Promise that resolves to a `JoinRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 407, "filename": "joinRequests.js" } ], @@ -256,7 +257,7 @@ "params": [ { "name": "limit", "type": "string", - "doc": "limit The number of items to return, which is also the [`pageSize`](wix-groups-backend.JoinRequestsQueryResult.html#pageSize) of the results object." } ], + "doc": "The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-result/page-size) of the results object." } ], "ret": { "type": "wix-groups-backend.JoinRequests.JoinRequestsQueryBuilder", "doc": "A `JoinRequestsQueryBuilder` object representing the refined query." }, @@ -267,8 +268,8 @@ { "summary": "Limits the number of items the query returns.", "description": [ "The `limit()` function defines the number of results a query returns in each", - "page. Only one page of results is retrieved at a time. The [`next()`](wix-groups-backend.JoinRequestsQueryResult.html#next)", - "and [`prev()`](wix-groups-backend.JoinRequestsQueryResult.html#prev) functions are used to", + "page. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-result/next)", + "and [`prev()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-result/prev) functions are used to", "navigate the pages of a query result.", "", "By default, `limit` is set to `50`.", diff --git a/wix-groups-backend/wix-groups-backend/JoinRequests/JoinRequestsQueryResult.service.json b/wix-groups-backend/wix-groups-backend/JoinRequests/JoinRequestsQueryResult.service.json index d20be5eb65..263e60e819 100644 --- a/wix-groups-backend/wix-groups-backend/JoinRequests/JoinRequestsQueryResult.service.json +++ b/wix-groups-backend/wix-groups-backend/JoinRequests/JoinRequestsQueryResult.service.json @@ -9,7 +9,7 @@ "docs": { "summary": "The results of a create request query, containing the retrieved items.", "description": - [ "When you execute a query with the [`find()`](wix-groups-backend.JoinRequestsQueryBuilder.html#find)", + [ "When you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/find)", "function, it returns a Promise that resolves to a `JoinRequestsQueryResult` object.", "This object contains the items that match the query, information about the", "query itself, and functions for paging through the query results." ], @@ -32,7 +32,7 @@ "description": [ "The `currentPage` is a zero-based index of the current page of results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.JoinRequestsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -153,7 +153,7 @@ "docs": { "summary": "Returns the number of items in the current results page.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.JoinRequestsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -196,7 +196,7 @@ "docs": { "summary": "Returns the query page size.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.JoinRequestsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -321,7 +321,7 @@ "docs": { "summary": "Returns the total number of pages the query produced.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.JoinRequestsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -363,7 +363,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.JoinRequests.JoinRequestsQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.JoinRequestsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `JoinRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/find)\nfunction, it returns a Promise that resolves to a `JoinRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 536, "filename": "joinRequests.js" } ], @@ -372,7 +372,7 @@ "description": [ "The `next()` function retrieves the next page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.JoinRequestsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -427,7 +427,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.JoinRequests.JoinRequestsQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.JoinRequestsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `JoinRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/find)\nfunction, it returns a Promise that resolves to a `JoinRequestsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 559, "filename": "joinRequests.js" } ], @@ -436,7 +436,7 @@ "description": [ "The `prev()` function retrieves the previous page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.JoinRequestsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/join-requests/join-requests-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", diff --git a/wix-groups-backend/wix-groups-backend/Members.service.json b/wix-groups-backend/wix-groups-backend/Members.service.json index 1f9ab666bc..d196489679 100644 --- a/wix-groups-backend/wix-groups-backend/Members.service.json +++ b/wix-groups-backend/wix-groups-backend/Members.service.json @@ -15,18 +15,18 @@ "+ If a group's privacy level is set to `SECRET`, group admins or group members can add additional members to their group.", "+ If a group's privacy level is set to `PUBLIC` or `PRIVATE`, group admins determine whether group members can add additional members to their group. ", "+ This setting can be found in your site's Dashboard under **Groups Application > Your Group > Admin Tools > Member Permissions**. ", - "+ If set to all members, group members can add additional members to the group using the [`addGroupMembers()`](wix-groups-backend.Members/addGroupMembers) function (no approval required). ", + "+ If set to all members, group members can add additional members to the group using the [`addGroupMembers()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/add-group-members) function (no approval required). ", "+ If set to admins only, only admins can add additional members to the group using the `addGroupMembers()` function.", "+ The default is set to admins only. ", "+ **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can add additional members to a group. ", "", "The Members API provides functionality allowing you to:", - " + [Add](wix-groups-backend.Members/addgroupmembers) members to a group. ", - " + [List](wix-groups-backend.Members/listgroupmembers) all members of a group. ", - " + [List](wix-groups-backend.Members/listmemberships) a site member's group memberships. ", - " + [Query](wix-groups-backend.Members/querygroupmembers) members of a group. ", - " + [Query](wix-groups-backend.Members/querymemberships) a site member's group memberships. ", - " + [Remove](wix-groups-backend.Members/removegroupmembers) members of a group. ", + " + [Add](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/add-group-members) members to a group. ", + " + [List](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/list-group-members) all members of a group. ", + " + [List](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/list-memberships) a site member's group memberships. ", + " + [Query](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/query-group-members) members of a group. ", + " + [Query](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/query-memberships) a site member's group memberships. ", + " + [Remove](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/remove-group-members) members of a group. ", "", "### Permissions Information", ">**Note:** You can override the permissions below by setting the `suppressAuth` option to `true`. ", @@ -409,22 +409,22 @@ "", "> **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members. ", "", - "The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](wix-groups-backend/members/membersquerybuilder) object.", + "The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/introduction) object.", "", - "The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/members/membersquerybuilder/find) function. ", + "The returned object contains the query definition which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/find) function. ", "", "You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns.", "", " `queryGroupMembers()` runs with these `GroupMembersQueryBuilder` defaults, which you can override:", - " + [`limit(100)`](wix-groups-backend/members/membersquerybuilder/limit)", - " + [`descending(\"joinedDate\")`](wix-groups-backend/members/membersquerybuilder/descending)", + " + [`limit(100)`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/limit)", + " + [`descending(\"joinedDate\")`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/descending)", "", - "The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](wix-groups-backend/members/membersqueryresult/items) property in [`GroupMembersQueryResult`](wix-groups-backend/members/membersqueryresult).", + "The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-result/items) property in [`GroupMembersQueryResult`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-result/introduction).", "", "| Property | Supported Filters & Sorting |", "| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |", - "| `role` | [`eq()`](wix-groups-backend/members/membersquerybuilder/eq), [`ne()`](wix-groups-backend/members/membersquerybuilder/ne) | ", - "| `joinedDate` | [`ascending()`](wix-groups-backend/members/membersquerybuilder/ascending), [`descending()`](wix-groups-backend/members/membersquerybuilder/descending) |" ], + "| `role` | [`eq()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/ne) | ", + "| `joinedDate` | [`ascending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/ascending), [`descending()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/descending) |" ], "links": [], "examples": [ { "title": "Query members of a group", @@ -493,23 +493,23 @@ "", "> **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships. ", "", - "The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](wix-groups-backend/members/membershipsquerybuilder) object.", + "The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/introduction) object.", "", - "The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/members/membershipsquerybuilder/find) function. ", + "The returned object contains the query definition which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/find) function. ", "", "You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMemberships()` returns.", "", "The results of the `queryMemberships()` function are sorted by `groupId` in descending order. ", "", "`queryMemberships()` runs with this `GroupMembersQueryBuilder` default, which you can override:", - "+ [`limit(100)`](wix-groups-backend/members/membershipsquerybuilder/limit)", + "+ [`limit(100)`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/limit)", "", - "The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](wix-groups-backend/members/membershipsqueryresult/items) property in [`MembershipsQueryResult`](wix-groups-backend/members/membershipsqueryresult).", + "The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-result/items) property in [`MembershipsQueryResult`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-result/introduction).", "", "| Property | Supported Filters & Sorting |", "| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |", - "| `status` | [`eq()`](wix-groups-backend/members/membershipsquerybuilder/eq), [`ne()`](wix-groups-backend/members/membershipsquerybuilder/ne) | ", - "| `role` | [`eq()`](wix-groups-backend/members/membershipsquerybuilder/eq), [`ne()`](wix-groups-backend/members/membershipsquerybuilder/ne) |" ], + "| `status` | [`eq()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/ne) | ", + "| `role` | [`eq()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/eq), [`ne()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/ne) |" ], "links": [], "examples": [ { "title": "Query a site member's memberships", diff --git a/wix-groups-backend/wix-groups-backend/Members/GroupMembersQueryBuilder.service.json b/wix-groups-backend/wix-groups-backend/Members/GroupMembersQueryBuilder.service.json index 5e0d1398fd..0807c93dda 100644 --- a/wix-groups-backend/wix-groups-backend/Members/GroupMembersQueryBuilder.service.json +++ b/wix-groups-backend/wix-groups-backend/Members/GroupMembersQueryBuilder.service.json @@ -12,7 +12,7 @@ [ "The `GroupMembersQueryBuilder` functions enable you to run, sort, filter, and control", "which results a query returns.", "", - "Typically, you build a query using the [`queryGroupMembers()`](wix-groups-backend/members/querygroupmembers)function,", + "Typically, you build a query using the [`queryGroupMembers()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/query-group-members) function,", "refine the query by chaining `GroupMembersQueryBuilder` functions, and then execute the", "query by chaining the [`find()`](#find) function.", "", @@ -276,7 +276,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Members.GroupMembersQueryResult" ] }, - "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.GroupMembersQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `GroupMembersQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/find)\nfunction, it returns a Promise that resolves to a `GroupMembersQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 526, "filename": "members.js" } ], @@ -340,7 +340,7 @@ "params": [ { "name": "limit", "type": "string", - "doc": "limit The number of items to return, which is also the [`pageSize`](wix-groups-backend.GroupMembersQueryResult.html#pageSize) of the results object." } ], + "doc": "The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-result/page-size) of the results object." } ], "ret": { "type": "wix-groups-backend.Members.GroupMembersQueryBuilder", "doc": "A `GroupMembersQueryBuilder` object representing the refined query." }, @@ -351,8 +351,8 @@ { "summary": "Limits the number of items the query returns.", "description": [ "The `limit()` function defines the number of results a query returns in each", - "page. Only one page of results is retrieved at a time. The [`next()`](wix-groups-backend.GroupMembersQueryResult.html#next)", - "and [`prev()`](wix-groups-backend.GroupMembersQueryResult.html#prev) functions are used to", + "page. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-result/next)", + "and [`prev()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-result/prev) functions are used to", "navigate the pages of a query result.", "", "By default, `limit` is set to `50`.", diff --git a/wix-groups-backend/wix-groups-backend/Members/GroupMembersQueryResult.service.json b/wix-groups-backend/wix-groups-backend/Members/GroupMembersQueryResult.service.json index 6442b175e8..0d065b6c49 100644 --- a/wix-groups-backend/wix-groups-backend/Members/GroupMembersQueryResult.service.json +++ b/wix-groups-backend/wix-groups-backend/Members/GroupMembersQueryResult.service.json @@ -9,7 +9,7 @@ "docs": { "summary": "The results of a create request query, containing the retrieved items.", "description": - [ "When you execute a query with the [`find()`](wix-groups-backend.GroupMembersQueryBuilder.html#find)", + [ "When you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/find)", "function, it returns a Promise that resolves to a `GroupMembersQueryResult` object.", "This object contains the items that match the query, information about the", "query itself, and functions for paging through the query results." ], @@ -32,7 +32,7 @@ "description": [ "The `currentPage` is a zero-based index of the current page of results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.GroupMembersQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -146,7 +146,7 @@ "docs": { "summary": "Returns the number of items in the current results page.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.GroupMembersQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -189,7 +189,7 @@ "docs": { "summary": "Returns the query page size.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.GroupMembersQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -318,7 +318,7 @@ "docs": { "summary": "Returns the total number of pages the query produced.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.GroupMembersQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -360,7 +360,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Members.GroupMembersQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.GroupMembersQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `GroupMembersQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/find)\nfunction, it returns a Promise that resolves to a `GroupMembersQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 654, "filename": "members.js" } ], @@ -369,7 +369,7 @@ "description": [ "The `next()` function retrieves the next page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.GroupMembersQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -424,7 +424,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Members.GroupMembersQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.GroupMembersQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `GroupMembersQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/find)\nfunction, it returns a Promise that resolves to a `GroupMembersQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 677, "filename": "members.js" } ], @@ -433,7 +433,7 @@ "description": [ "The `prev()` function retrieves the previous page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.GroupMembersQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/group-members-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", diff --git a/wix-groups-backend/wix-groups-backend/Members/MembershipsQueryBuilder.service.json b/wix-groups-backend/wix-groups-backend/Members/MembershipsQueryBuilder.service.json index 8eb83e392a..727c182138 100644 --- a/wix-groups-backend/wix-groups-backend/Members/MembershipsQueryBuilder.service.json +++ b/wix-groups-backend/wix-groups-backend/Members/MembershipsQueryBuilder.service.json @@ -12,7 +12,7 @@ [ "The `MembershipsQueryBuilder` functions enable you to run, sort, filter, and control", "which results a query returns.", "", - "Typically, you build a query using the [`queryMemberships()`](wix-groups-backend/members/querymemberships) function,", + "Typically, you build a query using the [`queryMemberships()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/query-memberships) function,", "refine the query by chaining `MembershipsQueryBuilder` functions, and then execute the", "query by chaining the [`find()`](#find) function.", "", @@ -121,7 +121,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Members.MembershipsQueryResult" ] }, - "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.MembershipsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `MembershipsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a contacts query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/find)\nfunction, it returns a Promise that resolves to a `MembershipsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 991, "filename": "members.js" } ], @@ -185,7 +185,7 @@ "params": [ { "name": "limit", "type": "string", - "doc": "limit The number of items to return, which is also the [`pageSize`](wix-groups-backend.MembershipsQueryResult.html#pageSize) of the results object." } ], + "doc": "The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-result/page-size) of the results object." } ], "ret": { "type": "wix-groups-backend.Members.MembershipsQueryBuilder", "doc": "A `MembershipsQueryBuilder` object representing the refined query." }, @@ -196,8 +196,8 @@ { "summary": "Limits the number of items the query returns.", "description": [ "The `limit()` function defines the number of results a query returns in each", - "page. Only one page of results is retrieved at a time. The [`next()`](wix-groups-backend.MembershipsQueryResult.html#next)", - "and [`prev()`](wix-groups-backend.MembershipsQueryResult.html#prev) functions are used to", + "page. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-result/next)", + "and [`prev()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-result/prev) functions are used to", "navigate the pages of a query result.", "", "By default, `limit` is set to `50`.", diff --git a/wix-groups-backend/wix-groups-backend/Members/MembershipsQueryResult.service.json b/wix-groups-backend/wix-groups-backend/Members/MembershipsQueryResult.service.json index d3bc2eef12..c445ae3841 100644 --- a/wix-groups-backend/wix-groups-backend/Members/MembershipsQueryResult.service.json +++ b/wix-groups-backend/wix-groups-backend/Members/MembershipsQueryResult.service.json @@ -9,7 +9,7 @@ "docs": { "summary": "The results of a create request query, containing the retrieved items.", "description": - [ "When you execute a query with the [`find()`](wix-groups-backend.MembershipsQueryBuilder.html#find)", + [ "When you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/find)", "function, it returns a Promise that resolves to a `MembershipsQueryResult` object.", "This object contains the items that match the query, information about the", "query itself, and functions for paging through the query results." ], @@ -32,7 +32,7 @@ "description": [ "The `currentPage` is a zero-based index of the current page of results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.MembershipsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -146,7 +146,7 @@ "docs": { "summary": "Returns the number of items in the current results page.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.MembershipsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -189,7 +189,7 @@ "docs": { "summary": "Returns the query page size.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.MembershipsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -318,7 +318,7 @@ "docs": { "summary": "Returns the total number of pages the query produced.", "description": - [ "The page size is defined by the [`limit()`](wix-groups-backend.MembershipsQueryBuilder.html#limit)", + [ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions." ], @@ -360,7 +360,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Members.MembershipsQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.MembershipsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `MembershipsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/find)\nfunction, it returns a Promise that resolves to a `MembershipsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 1119, "filename": "members.js" } ], @@ -369,7 +369,7 @@ "description": [ "The `next()` function retrieves the next page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.MembershipsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", @@ -424,7 +424,7 @@ { "name": "Promise", "typeParams": [ "wix-groups-backend.Members.MembershipsQueryResult" ] }, - "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](wix-groups-backend.MembershipsQueryBuilder.html#find)\nfunction, it returns a Promise that resolves to a `MembershipsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, + "doc": "Fulfilled - The results of a create requests query, containing the retrieved items.\nWhen you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/find)\nfunction, it returns a Promise that resolves to a `MembershipsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results." }, "locations": [ { "lineno": 1142, "filename": "members.js" } ], @@ -433,7 +433,7 @@ "description": [ "The `prev()` function retrieves the previous page of query results.", "", - "The page size is defined by the [`limit()`](wix-groups-backend.MembershipsQueryBuilder.html#limit)", + "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-groups-backend/members/memberships-query-builder/limit)", "function, can be retrieved using the [`pageSize`](#pageSize) property, and", "navigating through pages is done with the [`prev()`](#prev) and", "[`next()`](#next) functions.", diff --git a/wix-groups-backend/wix-groups-backend/Roles.service.json b/wix-groups-backend/wix-groups-backend/Roles.service.json index 5a912e9642..830b12291c 100644 --- a/wix-groups-backend/wix-groups-backend/Roles.service.json +++ b/wix-groups-backend/wix-groups-backend/Roles.service.json @@ -16,8 +16,8 @@ "To enable groups backend API functionality for your site, add the [Wix Groups](https://support.wix.com/en/article/wix-groups-adding-and-setting-up-wix-groups) application to your site.", "", "The Groups API provides functionality allowing you to:", - " + [Assign](wix-groups-backend.Roles/assignrole) roles to members of a group. ", - " + [Unasssign](wix-groups-backend.Roles/assignrole) roles to members of a group. ", + " + [Assign](https://dev.wix.com/docs/velo/apis/wix-groups-backend/roles/assign-role) roles to members of a group. ", + " + [Unassign](https://dev.wix.com/docs/velo/apis/wix-groups-backend/roles/unassign-role) roles from members of a group. ", "", "### Permissions Information", ">**Note:** You can override the permissions below by setting the `suppressAuth` option to `true`. ", diff --git a/wix-members-backend/wix-members-backend/Badges.service.json b/wix-members-backend/wix-members-backend/Badges.service.json index 464ebf49e4..ef7ae53645 100644 --- a/wix-members-backend/wix-members-backend/Badges.service.json +++ b/wix-members-backend/wix-members-backend/Badges.service.json @@ -1,7 +1,8 @@ { "name": "Badges", "memberOf": "wix-members-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 110, "filename": "index.js" }, @@ -151,7 +152,8 @@ "extra": { } }, { "name": "createBadge", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "badgeInfo", @@ -174,7 +176,7 @@ "", "New badges do not have any badge permissions by default.", "You can", - "[set badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)", + "[set badge permissions](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges)", "from the", "[Badges page](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fbadge-definitions)", "in the Dashboard.", diff --git a/wix-members-backend/wix-members-backend/CurrentMember.service.json b/wix-members-backend/wix-members-backend/CurrentMember.service.json index 0ecbfa1e6d..d9e6ac2a2c 100644 --- a/wix-members-backend/wix-members-backend/CurrentMember.service.json +++ b/wix-members-backend/wix-members-backend/CurrentMember.service.json @@ -1,8 +1,7 @@ { "name": "CurrentMember", "memberOf": "wix-members-backend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 20, "filename": "index.js" }, diff --git a/wix-members-backend/wix-members-backend/Members.service.json b/wix-members-backend/wix-members-backend/Members.service.json index e0ca6372f7..b05e590360 100644 --- a/wix-members-backend/wix-members-backend/Members.service.json +++ b/wix-members-backend/wix-members-backend/Members.service.json @@ -1,8 +1,7 @@ { "name": "Members", "memberOf": "wix-members-backend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 53, "filename": "index.js" }, @@ -842,8 +841,7 @@ "doc": "Custom fields,\n[structured as key:object pairs](wix-members-backend/introduction#data-structure).\nCustom field IDs are defined in the\n[Contacts Extended Fields API](wix-crm-backend/contacts).\nThe paired object contains the `name` and `value` properties,\nwhere `name` is the display name and `value` is the value stored for the member.\n\nOnly custom fields\n[added to the member profile in the Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmembers-account)\nare available through the Members API.\nEmpty fields are not returned.\n\nWhen updating a member, `name` is ignored." } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "ContactInfo", "locations": [ { "lineno": 17, @@ -902,8 +900,7 @@ "optional": true } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "CustomField", "locations": [ { "lineno": 48,