@wix/crm 1.0.27 → 1.0.28

package/build/cjs/src/contacts-v4-extended-field.http.d.ts

@@ -3,29 +3,58 @@ import { DeleteExtendedFieldRequest, DeleteExtendedFieldResponse, FindOrCreateEx
 /**
  * Retrieves a custom field with a given name, or creates one if it doesn't exist.
  *
- * Successful calls to this endpoint always return a field,
- * which can be passed to subsequent requests.
+ * The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
+ *
+ * Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
+ *
+ * To find an existing extended field without potentially creating a new one, use [`getExtendedField()`](#getextendedfield) or [`queryExtendedFields()`](#queryextendedfields).
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can find or create extended fields.
  *
- * To find an existing custom field without potentially creating a new one, use
- * [Get Extended Field](https:dev.wix.com/api/rest/contacts/extended-fields/get-extended-field) or
- * [List Extended Fields](https:dev.wix.com/api/rest/contacts/extended-fields/list-extended-fields).
  */
 export declare function findOrCreateExtendedField(payload: FindOrCreateExtendedFieldRequest): RequestOptionsFactory<FindOrCreateExtendedFieldResponse>;
-/** Retrieves an extended field. */
+/**
+ * Retrieves an extended field.
+ *
+ * The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can retrieve extended fields.
+ */
 export declare function getExtendedField(payload: GetExtendedFieldRequest): RequestOptionsFactory<GetExtendedFieldResponse>;
-/** Updates an extended field's specified properties. */
+/**
+ * Renames an extended field.
+ *
+ * The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
+ *
+ * > **Note:** Only visitors with **Manage Contacts** permissions can rename extended fields.
+ */
 export declare function updateExtendedField(payload: UpdateExtendedFieldRequest): RequestOptionsFactory<UpdateExtendedFieldResponse>;
 /**
  * Deletes an extended field.
  *
- * When an extended field is deleted,
- * any contact data stored in the field is permanently deleted as well.
+ * The `deleteExtendedField()` function returns a Promise that resolves when the specified extended field is deleted.
+ *
+ * When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can delete extended fields.
  */
 export declare function deleteExtendedField(payload: DeleteExtendedFieldRequest): RequestOptionsFactory<DeleteExtendedFieldResponse>;
 /**
- * Retrieves a list of extended fields.
+ * Creates a query to retrieve a list of extended fields.
+ *
+ * The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`ExtendedFieldsQueryBuilder`](#extendedfieldsquerybuilder) object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](#extendedfieldsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `ExtendedFieldsQueryBuilder` functions onto the query. `ExtendedFieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
+ *
+ * `queryExtendedFields()` runs with these `ExtendedFieldsQueryBuilder` defaults, which you can override:
+ * - [`skip()`](#extendedfieldsquerybuilder/skip)
+ * - [`limit(50)`](#extendedfieldsquerybuilder/limit)
+ * - [`descending('_createdDate')`](#extendedfieldsquerybuilder/descending)
+ *
+ * > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
  *
- * For a detailed list of supported operations, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter). To learn more about query language, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * The following `ExtendedFieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the [`items`](#extendedfieldsqueryresult/items) property in [`ExtendedFieldsQueryResult`](#extendedfieldsqueryresult).
  */
 export declare function queryExtendedFields(payload: QueryExtendedFieldsRequest): RequestOptionsFactory<QueryExtendedFieldsResponse>;

package/build/cjs/src/contacts-v4-extended-field.http.js

@@ -68,12 +68,14 @@ function resolveComWixpressContactsFieldsV4ContactExtendedFieldsServiceV4Url(opt
 /**
  * Retrieves a custom field with a given name, or creates one if it doesn't exist.
  *
- * Successful calls to this endpoint always return a field,
- * which can be passed to subsequent requests.
+ * The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
+ *
+ * Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
+ *
+ * To find an existing extended field without potentially creating a new one, use [`getExtendedField()`](#getextendedfield) or [`queryExtendedFields()`](#queryextendedfields).
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can find or create extended fields.
  *
- * To find an existing custom field without potentially creating a new one, use
- * [Get Extended Field](https:dev.wix.com/api/rest/contacts/extended-fields/get-extended-field) or
- * [List Extended Fields](https:dev.wix.com/api/rest/contacts/extended-fields/list-extended-fields).
  */
 function findOrCreateExtendedField(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_findOrCreateExtendedFieldRequest, {});
@@ -100,7 +102,13 @@ function findOrCreateExtendedField(payload) {
     return __findOrCreateExtendedField;
 }
 exports.findOrCreateExtendedField = findOrCreateExtendedField;
-/** Retrieves an extended field. */
+/**
+ * Retrieves an extended field.
+ *
+ * The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can retrieve extended fields.
+ */
 function getExtendedField(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getExtendedFieldRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getExtendedFieldResponse, {
@@ -126,7 +134,13 @@ function getExtendedField(payload) {
     return __getExtendedField;
 }
 exports.getExtendedField = getExtendedField;
-/** Updates an extended field's specified properties. */
+/**
+ * Renames an extended field.
+ *
+ * The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
+ *
+ * > **Note:** Only visitors with **Manage Contacts** permissions can rename extended fields.
+ */
 function updateExtendedField(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updateExtendedFieldRequest, { _extendedField });
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_updateExtendedFieldResponse, {
@@ -155,8 +169,11 @@ exports.updateExtendedField = updateExtendedField;
 /**
  * Deletes an extended field.
  *
- * When an extended field is deleted,
- * any contact data stored in the field is permanently deleted as well.
+ * The `deleteExtendedField()` function returns a Promise that resolves when the specified extended field is deleted.
+ *
+ * When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can delete extended fields.
  */
 function deleteExtendedField(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteExtendedFieldRequest, {});
@@ -182,10 +199,22 @@ function deleteExtendedField(payload) {
 }
 exports.deleteExtendedField = deleteExtendedField;
 /**
- * Retrieves a list of extended fields.
+ * Creates a query to retrieve a list of extended fields.
+ *
+ * The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`ExtendedFieldsQueryBuilder`](#extendedfieldsquerybuilder) object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](#extendedfieldsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `ExtendedFieldsQueryBuilder` functions onto the query. `ExtendedFieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
+ *
+ * `queryExtendedFields()` runs with these `ExtendedFieldsQueryBuilder` defaults, which you can override:
+ * - [`skip()`](#extendedfieldsquerybuilder/skip)
+ * - [`limit(50)`](#extendedfieldsquerybuilder/limit)
+ * - [`descending('_createdDate')`](#extendedfieldsquerybuilder/descending)
+ *
+ * > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
  *
- * For a detailed list of supported operations, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter). To learn more about query language, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * The following `ExtendedFieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the [`items`](#extendedfieldsqueryresult/items) property in [`ExtendedFieldsQueryResult`](#extendedfieldsqueryresult).
  */
 function queryExtendedFields(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_queryExtendedFieldsRequest, {});

package/build/cjs/src/contacts-v4-extended-field.http.js.map

@@ -1 +1 @@
-{"version":3,"file":"contacts-v4-extended-field.http.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAgBhD,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,cAAc,GAAG;IACrB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;AACvE,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;AAC9D,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;AAClE,MAAM,2BAA2B,GAAG,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;AAChE,MAAM,4BAA4B,GAAG,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;AAEjE,SAAS,mEAAmE,CAC1E,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,yBAAyB,CACvC,OAAyC;IAEzC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,iCAAiC,EACjC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,kCAAkC,EAAE;QAC3E,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,2BAA2B,CAAC,EAAE,IAAI,EAAO;QAChD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,0FAA0F;YAC5F,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,2BAA2B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE9C,OAAO,2BAA2B,CAAC;AACrC,CAAC;AAjCD,8DAiCC;AAED,mCAAmC;AACnC,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,yBAAyB,EAAE;QAClE,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,iFAAiF;YACnF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAjCD,4CAiCC;AAED,wDAAwD;AACxD,SAAgB,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,2BAA2B,EAC3B,EAAE,cAAc,EAAE,CACnB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,4BAA4B,EAAE;QACrE,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC;IAExC,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAjCD,kDAiCC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,2BAA2B,EAC3B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IAE3E,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC;IAExC,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AA/BD,kDA+BC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,2BAA2B,EAC3B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,4BAA4B,EAAE;QACrE,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC;IAExC,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAjCD,kDAiCC"}
+{"version":3,"file":"contacts-v4-extended-field.http.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAgBhD,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,cAAc,GAAG;IACrB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;AACvE,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;AAC9D,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;AAClE,MAAM,2BAA2B,GAAG,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;AAChE,MAAM,4BAA4B,GAAG,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;AAEjE,SAAS,mEAAmE,CAC1E,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,yBAAyB,CACvC,OAAyC;IAEzC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,iCAAiC,EACjC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,kCAAkC,EAAE;QAC3E,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,2BAA2B,CAAC,EAAE,IAAI,EAAO;QAChD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,0FAA0F;YAC5F,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,2BAA2B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE9C,OAAO,2BAA2B,CAAC;AACrC,CAAC;AAjCD,8DAiCC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,yBAAyB,EAAE;QAClE,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,iFAAiF;YACnF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAjCD,4CAiCC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,2BAA2B,EAC3B,EAAE,cAAc,EAAE,CACnB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,4BAA4B,EAAE;QACrE,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC;IAExC,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAjCD,kDAiCC;AAED;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,2BAA2B,EAC3B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;IAE3E,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC;IAExC,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AA/BD,kDA+BC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,2BAA2B,EAC3B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,4BAA4B,EAAE;QACrE,cAAc;KACf,CAAC,CAAC;IAEH,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC;IAExC,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAjCD,kDAiCC"}

package/build/cjs/src/contacts-v4-extended-field.types.d.ts

@@ -165,7 +165,7 @@ export interface FindOrCreateExtendedFieldResponse {
      * Indicates whether the extended field was just created or already existed.
      *
      * If the field was just created, returns `true`.
-     * If it already existed, returns `false`.
+     * If the field already existed, returns `false`.
      */
     newField?: boolean;
 }

package/build/cjs/src/contacts-v4-extended-field.universal.d.ts

@@ -20,7 +20,7 @@ export interface ExtendedField {
      * When accessing contact data,
      * extended field data is available at `extendedFields[key]`.
      * For example, if the key is "custom.notes",
-     * the value can be accessed at `extendedFields["custom.notes"]`.
+     * the value can be accessed at `fields["custom.notes"]`.
      *
      * `key` is generated when the extended field is created
      * and cannot be modified, even if `displayName` changes.
@@ -32,18 +32,20 @@ export interface ExtendedField {
     /**
      * Type of data the field holds.
      *
-     * - `TEXT`: Accepts strings.
-     * - `NUMBER`: Accepts floats.
-     * - `DATE`: Accepts dates formatted as `YYYY-MM-DD`.
-     * - `URL`: Accepts strings. Prepends `https://` if no protocol is included.
+     * One of:
+     * - `"TEXT"`: Accepts strings.
+     * - `"NUMBER"`: Accepts floats.
+     * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
+     * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
      * @readonly
      */
     dataType?: FieldDataType;
     /**
      * Indicates whether the extended field is a system field or custom field.
      *
-     * - `SYSTEM`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `USER_DEFINED`: The field is a custom field and can be modified by 3rd-party apps or site contributors.
+     * One of:
+     * - `"SYSTEM"`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
+     * - `"USER_DEFINED"`: The field is a custom field and can be modified by 3rd-party apps or site contributors.
      * @readonly
      */
     fieldType?: FieldType;
@@ -154,12 +156,12 @@ export interface FindOrCreateExtendedFieldRequest {
     /**
      * Type of data the field holds.
      * Ignored if an existing field is an exact match
-     * for the specified display name.
+     * for the specified display name. One of:
      *
-     * - `TEXT`: Accepts strings.
-     * - `NUMBER`: Accepts floats.
-     * - `DATE`: Accepts dates formatted as `YYYY-MM-DD`.
-     * - `URL`: Accepts strings. Prepends `https://` if no protocol is included.
+     * - `"TEXT"`: Accepts strings.
+     * - `"NUMBER"`: Accepts floats.
+     * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
+     * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
      */
     dataType?: FieldDataType;
 }
@@ -171,7 +173,7 @@ export interface FindOrCreateExtendedFieldResponse {
      * Indicates whether the extended field was just created or already existed.
      *
      * If the field was just created, returns `true`.
-     * If it already existed, returns `false`.
+     * If the field already existed, returns `false`.
      */
     newField?: boolean;
 }
@@ -181,8 +183,8 @@ export interface GetExtendedFieldRequest {
      *
      * When accessing contact data,
      * extended field values are available at `info.extendedFields.items[key]`.
-     * For example, if the key is "custom.patronus",
-     * the value can be accessed at `info.extendedFields.items["custom.patronus"]`.
+     * For example, if the key is "custom.notes",
+     * the value can be accessed at `fields["custom.notes"]`.
      *
      * Once set, `key` cannot be modified, even if `displayName` changes.
      */
@@ -264,24 +266,25 @@ export interface QueryExtendedFieldsResponse {
 /**
  * Retrieves a custom field with a given name, or creates one if it doesn't exist.
  *
- * Successful calls to this endpoint always return a field,
- * which can be passed to subsequent requests.
+ * The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
+ *
+ * Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
+ *
+ * To find an existing extended field without potentially creating a new one, use [`getExtendedField()`](#getextendedfield) or [`queryExtendedFields()`](#queryextendedfields).
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can find or create extended fields.
  *
- * To find an existing custom field without potentially creating a new one, use
- * [Get Extended Field](https:dev.wix.com/api/rest/contacts/extended-fields/get-extended-field) or
- * [List Extended Fields](https:dev.wix.com/api/rest/contacts/extended-fields/list-extended-fields).
  *
  * This function is not a universal function and runs only on the backend.
  * @param dataType - Type of data the field holds.
  * Ignored if an existing field is an exact match
- * for the specified display name.
+ * for the specified display name. One of:
  *
- * - `TEXT`: Accepts strings.
- * - `NUMBER`: Accepts floats.
- * - `DATE`: Accepts dates formatted as `YYYY-MM-DD`.
- * - `URL`: Accepts strings. Prepends `https://` if no protocol is included.
+ * - `"TEXT"`: Accepts strings.
+ * - `"NUMBER"`: Accepts floats.
+ * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
+ * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
  * @public
- * @documentationMaturity preview
  * @requiredField dataType
  * @requiredField options
  * @requiredField options.displayName
@@ -304,17 +307,20 @@ export interface FindOrCreateExtendedFieldOptions {
 /**
  * Retrieves an extended field.
  *
+ * The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can retrieve extended fields.
+ *
  * This function is not a universal function and runs only on the backend.
  * @param key - Extended field key.
  *
  * When accessing contact data,
  * extended field values are available at `info.extendedFields.items[key]`.
- * For example, if the key is "custom.patronus",
- * the value can be accessed at `info.extendedFields.items["custom.patronus"]`.
+ * For example, if the key is "custom.notes",
+ * the value can be accessed at `fields["custom.notes"]`.
  *
  * Once set, `key` cannot be modified, even if `displayName` changes.
  * @public
- * @documentationMaturity preview
  * @requiredField key
  * @permissionScope Manage Contact Extended Fields
  * @applicableIdentity APP
@@ -322,7 +328,11 @@ export interface FindOrCreateExtendedFieldOptions {
  */
 export declare function getExtendedField(key: string): Promise<ExtendedField>;
 /**
- * Updates an extended field's specified properties.
+ * Renames an extended field.
+ *
+ * The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
+ *
+ * > **Note:** Only visitors with **Manage Contacts** permissions can rename extended fields.
  *
  * This function is not a universal function and runs only on the backend.
  * @param key - Extended field key.
@@ -330,12 +340,11 @@ export declare function getExtendedField(key: string): Promise<ExtendedField>;
  * When accessing contact data,
  * extended field data is available at `extendedFields[key]`.
  * For example, if the key is "custom.notes",
- * the value can be accessed at `extendedFields["custom.notes"]`.
+ * the value can be accessed at `fields["custom.notes"]`.
  *
  * `key` is generated when the extended field is created
  * and cannot be modified, even if `displayName` changes.
  * @public
- * @documentationMaturity preview
  * @requiredField field
  * @requiredField field.displayName
  * @requiredField key
@@ -358,18 +367,20 @@ export interface RenameExtendedField {
     /**
      * Type of data the field holds.
      *
-     * - `TEXT`: Accepts strings.
-     * - `NUMBER`: Accepts floats.
-     * - `DATE`: Accepts dates formatted as `YYYY-MM-DD`.
-     * - `URL`: Accepts strings. Prepends `https://` if no protocol is included.
+     * One of:
+     * - `"TEXT"`: Accepts strings.
+     * - `"NUMBER"`: Accepts floats.
+     * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
+     * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
      * @readonly
      */
     dataType?: FieldDataType;
     /**
      * Indicates whether the extended field is a system field or custom field.
      *
-     * - `SYSTEM`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `USER_DEFINED`: The field is a custom field and can be modified by 3rd-party apps or site contributors.
+     * One of:
+     * - `"SYSTEM"`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
+     * - `"USER_DEFINED"`: The field is a custom field and can be modified by 3rd-party apps or site contributors.
      * @readonly
      */
     fieldType?: FieldType;
@@ -392,27 +403,40 @@ export interface RenameExtendedField {
 /**
  * Deletes an extended field.
  *
- * When an extended field is deleted,
- * any contact data stored in the field is permanently deleted as well.
+ * The `deleteExtendedField()` function returns a Promise that resolves when the specified extended field is deleted.
+ *
+ * When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can delete extended fields.
  *
  * This function is not a universal function and runs only on the backend.
  * @param key - Extended field key.
  * @public
- * @documentationMaturity preview
  * @requiredField key
  * @permissionScope Manage Contact Extended Fields
  * @applicableIdentity APP
  */
 export declare function deleteExtendedField(key: string): Promise<void>;
 /**
- * Retrieves a list of extended fields.
+ * Creates a query to retrieve a list of extended fields.
+ *
+ * The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`ExtendedFieldsQueryBuilder`](#extendedfieldsquerybuilder) object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](#extendedfieldsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `ExtendedFieldsQueryBuilder` functions onto the query. `ExtendedFieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
+ *
+ * `queryExtendedFields()` runs with these `ExtendedFieldsQueryBuilder` defaults, which you can override:
+ * - [`skip()`](#extendedfieldsquerybuilder/skip)
+ * - [`limit(50)`](#extendedfieldsquerybuilder/limit)
+ * - [`descending('_createdDate')`](#extendedfieldsquerybuilder/descending)
  *
- * For a detailed list of supported operations, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter). To learn more about query language, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
+ *
+ * The following `ExtendedFieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the [`items`](#extendedfieldsqueryresult/items) property in [`ExtendedFieldsQueryResult`](#extendedfieldsqueryresult).
  *
  * This function is not a universal function and runs only on the backend.
  * @public
- * @documentationMaturity preview
  * @permissionScope Manage Contact Extended Fields
  * @applicableIdentity APP
  */
@@ -435,53 +459,37 @@ export interface FieldsQueryResult extends QueryOffsetResult {
 export interface FieldsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     eq: (propertyName: 'namespace' | 'key' | 'displayName' | 'dataType' | 'fieldType' | '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ne: (propertyName: 'namespace' | 'key' | 'displayName' | 'dataType' | '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     le: (propertyName: '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
      */
     startsWith: (propertyName: 'displayName', value: string) => FieldsQueryBuilder;
-    /** @documentationMaturity preview */
     in: (propertyName: 'key' | 'displayName', value: any) => FieldsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'displayName' | '_createdDate' | '_updatedDate'>) => FieldsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     descending: (...propertyNames: Array<'displayName' | '_createdDate' | '_updatedDate'>) => FieldsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => FieldsQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results.
-     * @documentationMaturity preview
-     */
+    /** @param skip - Number of items to skip in the query results before returning the results. */
     skip: (skip: number) => FieldsQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<FieldsQueryResult>;
 }
 export {};

package/build/cjs/src/contacts-v4-extended-field.universal.js

@@ -80,24 +80,25 @@ const _updateExtendedFieldResponse = {};
 /**
  * Retrieves a custom field with a given name, or creates one if it doesn't exist.
  *
- * Successful calls to this endpoint always return a field,
- * which can be passed to subsequent requests.
+ * The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
+ *
+ * Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
+ *
+ * To find an existing extended field without potentially creating a new one, use [`getExtendedField()`](#getextendedfield) or [`queryExtendedFields()`](#queryextendedfields).
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can find or create extended fields.
  *
- * To find an existing custom field without potentially creating a new one, use
- * [Get Extended Field](https:dev.wix.com/api/rest/contacts/extended-fields/get-extended-field) or
- * [List Extended Fields](https:dev.wix.com/api/rest/contacts/extended-fields/list-extended-fields).
  *
  * This function is not a universal function and runs only on the backend.
  * @param dataType - Type of data the field holds.
  * Ignored if an existing field is an exact match
- * for the specified display name.
+ * for the specified display name. One of:
  *
- * - `TEXT`: Accepts strings.
- * - `NUMBER`: Accepts floats.
- * - `DATE`: Accepts dates formatted as `YYYY-MM-DD`.
- * - `URL`: Accepts strings. Prepends `https://` if no protocol is included.
+ * - `"TEXT"`: Accepts strings.
+ * - `"NUMBER"`: Accepts floats.
+ * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
+ * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
  * @public
- * @documentationMaturity preview
  * @requiredField dataType
  * @requiredField options
  * @requiredField options.displayName
@@ -156,17 +157,20 @@ exports.findOrCreateExtendedField = findOrCreateExtendedField;
 /**
  * Retrieves an extended field.
  *
+ * The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can retrieve extended fields.
+ *
  * This function is not a universal function and runs only on the backend.
  * @param key - Extended field key.
  *
  * When accessing contact data,
  * extended field values are available at `info.extendedFields.items[key]`.
- * For example, if the key is "custom.patronus",
- * the value can be accessed at `info.extendedFields.items["custom.patronus"]`.
+ * For example, if the key is "custom.notes",
+ * the value can be accessed at `fields["custom.notes"]`.
  *
  * Once set, `key` cannot be modified, even if `displayName` changes.
  * @public
- * @documentationMaturity preview
  * @requiredField key
  * @permissionScope Manage Contact Extended Fields
  * @applicableIdentity APP
@@ -217,7 +221,11 @@ function getExtendedField(key) {
 }
 exports.getExtendedField = getExtendedField;
 /**
- * Updates an extended field's specified properties.
+ * Renames an extended field.
+ *
+ * The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
+ *
+ * > **Note:** Only visitors with **Manage Contacts** permissions can rename extended fields.
  *
  * This function is not a universal function and runs only on the backend.
  * @param key - Extended field key.
@@ -225,12 +233,11 @@ exports.getExtendedField = getExtendedField;
  * When accessing contact data,
  * extended field data is available at `extendedFields[key]`.
  * For example, if the key is "custom.notes",
- * the value can be accessed at `extendedFields["custom.notes"]`.
+ * the value can be accessed at `fields["custom.notes"]`.
  *
  * `key` is generated when the extended field is created
  * and cannot be modified, even if `displayName` changes.
  * @public
- * @documentationMaturity preview
  * @requiredField field
  * @requiredField field.displayName
  * @requiredField key
@@ -286,13 +293,15 @@ exports.renameExtendedField = renameExtendedField;
 /**
  * Deletes an extended field.
  *
- * When an extended field is deleted,
- * any contact data stored in the field is permanently deleted as well.
+ * The `deleteExtendedField()` function returns a Promise that resolves when the specified extended field is deleted.
+ *
+ * When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
+ *
+ * >**Note:** Only visitors with **Manage Contacts** permissions can delete extended fields.
  *
  * This function is not a universal function and runs only on the backend.
  * @param key - Extended field key.
  * @public
- * @documentationMaturity preview
  * @requiredField key
  * @permissionScope Manage Contact Extended Fields
  * @applicableIdentity APP
@@ -342,14 +351,25 @@ function deleteExtendedField(key) {
 }
 exports.deleteExtendedField = deleteExtendedField;
 /**
- * Retrieves a list of extended fields.
+ * Creates a query to retrieve a list of extended fields.
+ *
+ * The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`ExtendedFieldsQueryBuilder`](#extendedfieldsquerybuilder) object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](#extendedfieldsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `ExtendedFieldsQueryBuilder` functions onto the query. `ExtendedFieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
+ *
+ * `queryExtendedFields()` runs with these `ExtendedFieldsQueryBuilder` defaults, which you can override:
+ * - [`skip()`](#extendedfieldsquerybuilder/skip)
+ * - [`limit(50)`](#extendedfieldsquerybuilder/limit)
+ * - [`descending('_createdDate')`](#extendedfieldsquerybuilder/descending)
+ *
+ * > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
  *
- * For a detailed list of supported operations, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter). To learn more about query language, see
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * The following `ExtendedFieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the [`items`](#extendedfieldsqueryresult/items) property in [`ExtendedFieldsQueryResult`](#extendedfieldsqueryresult).
  *
  * This function is not a universal function and runs only on the backend.
  * @public
- * @documentationMaturity preview
  * @permissionScope Manage Contact Extended Fields
  * @applicableIdentity APP
  */