@wix/crm 1.0.164 → 1.0.166

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/crm",
-  "version": "1.0.164",
+  "version": "1.0.166",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -23,10 +23,10 @@
   "dependencies": {
     "@wix/crm_attachments": "1.0.24",
     "@wix/crm_contacts": "1.0.70",
-    "@wix/crm_extended-fields": "1.0.49",
+    "@wix/crm_extended-fields": "1.0.50",
     "@wix/crm_labels": "1.0.48",
     "@wix/crm_submitted-contact": "1.0.44",
-    "@wix/crm_tasks": "1.0.51"
+    "@wix/crm_tasks": "1.0.52"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -51,5 +51,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "eb4a24b6cd939879067c8c86c3b3b1da26799464454a52842e524b67"
+  "falconPackageHash": "836a3b910015981e98fbc15eff4261f492ccfbbcb59126d7b39a931b"
 }

package/type-bundles/context.bundle.d.ts

@@ -3239,7 +3239,7 @@ interface ExtendedField {
     /**
      * Extended field namespace.
      *
-     * Extended fields created by site collaborators or 3rd-party apps
+     * Extended fields created through by calling the Find Or Create Extended Field method
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
@@ -3248,34 +3248,24 @@ interface ExtendedField {
      * Extended field key.
      *
      * When accessing contact data,
-     * extended field data is available at `fields[key]`.
+     * extended field data is available at `extendedFields[key]`.
      * For example, if the key is "custom.notes",
-     * the value can be accessed at `fields["custom.notes"]`.
+     * the value can be accessed at `extendedFields["custom.notes"]`.
      *
      * `key` is generated when the extended field is created
-     * and cannot be modified, even if `displayName` changes.
+     * and can't be modified, even if `displayName` changes.
      * @readonly
      */
     key?: string;
-    /** Display name shown in the Contact List. */
+    /** Display name shown in the contact list. */
     displayName?: string;
     /**
      * Type of data the field holds.
-     *
-     * 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.
-     *
-     * One of:
-     * - `"SYSTEM"`: System field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `"USER_DEFINED"`: Custom field that can be modified by 3rd-party apps or site admins.
      * @readonly
      */
     fieldType?: FieldType;
@@ -3306,9 +3296,9 @@ declare enum FieldDataType {
     URL = "URL"
 }
 declare enum FieldType {
-    /** The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors. */
+    /** Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. */
     SYSTEM = "SYSTEM",
-    /** The field is a custom field and can be modified by 3rd-party apps or site contributors. */
+    /** Field is a custom field and can be modified by calling the Update Extended Field method. */
     USER_DEFINED = "USER_DEFINED"
 }
 /** Extended field filter options. */
@@ -3317,7 +3307,7 @@ interface ListExtendedFieldsRequest {
     fieldType?: FieldType;
     /**
      * Filter for fields in the specified namespace.
-     * Fields created by site contributors or 3rd-party apps
+     * Fields created by calling the Find Or Create Extended Field method
      * are automatically assigned to the `custom` namespace.
      */
     namespace?: string | null;
@@ -3381,10 +3371,10 @@ interface PagingMetadata$1 {
 /** Custom field to find or create. */
 interface FindOrCreateExtendedFieldRequest {
     /**
-     * Display name to find or create.
+     * Display name to retrieve or create.
      *
      * If an existing custom field is an exact match
-     * for the specified `displayName`,
+     * for the specified display name,
      * the existing field is returned.
      * If not, a new field is created and returned.
      */
@@ -3392,12 +3382,7 @@ interface FindOrCreateExtendedFieldRequest {
     /**
      * Type of data the field holds.
      * Ignored if an existing field is an exact match
-     * 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.
+     * for the specified display name.
      */
     dataType?: FieldDataType;
 }
@@ -3408,8 +3393,7 @@ interface FindOrCreateExtendedFieldResponse {
     /**
      * Indicates whether the extended field was just created or already existed.
      *
-     * If the field was just created, returns `true`.
-     * If the field already existed, returns `false`.
+     * Returns `true` if the field was just created.
      */
     newField?: boolean;
 }
@@ -3418,11 +3402,12 @@ interface GetExtendedFieldRequest {
      * Extended field key.
      *
      * When accessing contact data,
-     * extended field values are available at `fields[key]`.
-     * For example, if the key is "custom.notes",
-     * the value can be accessed at `fields["custom.notes"]`.
+     * 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"]`.
      *
-     * Once set, `key` cannot be modified, even if `displayName` changes.
+     * `key` is generated when the extended field is created.
+     * It can't be modified, even if `displayName` is updated.
      */
     key: string;
 }
@@ -3440,12 +3425,12 @@ interface GetExtendedFieldByLegacyIdResponse {
     field?: ExtendedField;
 }
 interface UpdateExtendedFieldRequest {
-    /** Field to update. */
+    /** Extended field to rename. */
     field?: ExtendedField;
 }
 /** Updated extended field. */
 interface UpdateExtendedFieldResponse {
-    /** Updated extended field. */
+    /** Renamed extended field. */
     field?: ExtendedField;
 }
 interface DeleteExtendedFieldRequest {
@@ -3695,30 +3680,20 @@ interface RenameExtendedField {
     /**
      * Extended field namespace.
      *
-     * Extended fields created by site collaborators or 3rd-party apps
+     * Extended fields created through by calling the Find Or Create Extended Field method
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
     namespace?: string | null;
-    /** Display name shown in the Contact List. */
+    /** Display name shown in the contact list. */
     displayName?: string;
     /**
      * Type of data the field holds.
-     *
-     * 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.
-     *
-     * One of:
-     * - `"SYSTEM"`: System field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `"USER_DEFINED"`: Custom field that can be modified by 3rd-party apps or site admins.
      * @readonly
      */
     fieldType?: FieldType;
@@ -3814,28 +3789,23 @@ interface FieldsQueryBuilder {
 declare function findOrCreateExtendedField$1(httpClient: HttpClient): FindOrCreateExtendedFieldSignature;
 interface FindOrCreateExtendedFieldSignature {
     /**
-     * Retrieves a custom field with a given name, or creates one if it doesn't exist.
+     * Retrieves a custom field with a specified name, or creates one if it doesn't exist.
+     * The number of custom fields is limited to 100.
      *
-     * The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
+     * Successful calls to this method always return a field,
+     * which can be specified in subsequent calls.
      *
-     * 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()` or `queryExtendedFields()`.
-     *
-     * @param - Display name to find or create.
+     * To find an existing custom field without potentially creating a new one, call Get Extended Field or
+     * Query Extended Fields.
+     * @param - Display name to retrieve or create.
      *
      * If an existing custom field is an exact match
-     * for the specified `displayName`,
+     * for the specified display name,
      * the existing field is returned.
      * If not, a new field is created and returned.
      * @param - Type of data the field holds.
      * Ignored if an existing field is an exact match
-     * 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.
+     * for the specified display name.
      * @returns Extended field that was found or created.
      */
     (displayName: string, dataType: FieldDataType): Promise<FindOrCreateExtendedFieldResponse & FindOrCreateExtendedFieldResponseNonNullableFields>;
@@ -3843,18 +3813,8 @@ interface FindOrCreateExtendedFieldSignature {
 declare function getExtendedField$1(httpClient: HttpClient): GetExtendedFieldSignature;
 interface GetExtendedFieldSignature {
     /**
-     * Retrieves an extended field.
-     *
-     * The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
-     *
-     * @param - Extended field key.
-     *
-     * When accessing contact data,
-     * extended field values are available at `fields[key]`.
-     * 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.
+     * Retrieves an extended field by the specified extended field key.
+     * @param - null
      * @returns The specified field.
      */
     (key: string): Promise<ExtendedField & ExtendedFieldNonNullableFields>;
@@ -3863,19 +3823,9 @@ declare function renameExtendedField$1(httpClient: HttpClient): RenameExtendedFi
 interface RenameExtendedFieldSignature {
     /**
      * Renames an extended field.
-     *
-     * The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
-     *
-     * @param - Extended field key.
-     *
-     * When accessing contact data,
-     * extended field values are available at `fields[key]`.
-     * 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.
-     * @param - Extended field to rename.
-     * @returns Updated extended field.
+     * @param - null
+     * @param - null
+     * @returns Renamed extended field.
      */
     (key: string, field: RenameExtendedField): Promise<ExtendedField & ExtendedFieldNonNullableFields>;
 }
@@ -3884,10 +3834,8 @@ interface DeleteExtendedFieldSignature {
     /**
      * Deletes an extended field.
      *
-     * 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.
-     *
+     * When an extended field is deleted,
+     * any contact data stored in the field is also permanently deleted.
      * @param - Extended field key.
      */
     (key: string): Promise<void>;
@@ -3897,18 +3845,18 @@ interface QueryExtendedFieldsSignature {
     /**
      * 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 `FieldsQueryBuilder` object.
+     * The `queryExtendedFields()` method builds a query to retrieve a list of extended fields and returns an `FieldsQueryBuilder` object.
      *
-     * The returned object contains the query definition, which is used to run the query using the `find()` function.
+     * The returned object contains the query definition, which is used to run the query using the `find()` method.
      *
-     * You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
+     * You can refine the query by chaining `FieldsQueryBuilder` methods onto the query. `FieldsQueryBuilder` methods enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
      *
      * `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
      * - `skip()`
      * - `limit(50)`
      * - `descending('_createdDate')`
      *
-     * The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.
+     * The following `FieldsQueryBuilder` methods are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.
      */
     (): FieldsQueryBuilder;
 }
@@ -5451,7 +5399,7 @@ interface TaskSource {
      */
     appId?: string | null;
     /**
-     * User ID, if the task was created by a user.
+     * User ID, if the task was created by a Wix user.
      * @readonly
      */
     userId?: string | null;
@@ -5460,7 +5408,7 @@ interface TaskSource {
 declare enum SourceType {
     /** Task was created by an app. */
     APP = "APP",
-    /** Task was created by a user. */
+    /** Task was created by a Wix user. */
     USER = "USER"
 }
 interface ContactInfo {
@@ -5477,7 +5425,7 @@ interface ContactInfo {
      */
     lastName?: string | null;
     /**
-     * Contact's image url.
+     * Contact's image URL.
      * @readonly
      */
     imageUrl?: string | null;
@@ -5652,7 +5600,7 @@ interface CountTasksRequest {
     filter?: Record<string, any> | null;
 }
 interface CountTasksResponse {
-    /** The number of tasks that match the provided filter. */
+    /** The number of tasks that match the specified filter. */
     count?: number;
 }
 interface QueryTasksInternalRequest {
@@ -5697,7 +5645,7 @@ interface Paging {
     offset?: number | null;
 }
 interface QueryTasksInternalResponse {
-    /** The retrieved Tasks */
+    /** The retrieved tasks. */
     tasks?: Task[];
     /** Details on the paged set of results returned. */
     pagingMetadata?: PagingMetadataV2;
@@ -5715,11 +5663,11 @@ interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 interface MoveTaskAfterRequest {
-    /** The task ID to move. */
+    /** ID of the task to move. */
     taskId: string;
     /**
-     * The task ID after which the moved task is positioned in the display.
-     * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
+     * The ID of the task after which the moved task is positioned in the task display.
+     * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
      */
     beforeTaskId?: string | null;
 }
@@ -6028,8 +5976,8 @@ interface CountTasksOptions {
 }
 interface MoveTaskAfterOptions {
     /**
-     * The task ID after which the moved task is positioned in the display.
-     * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
+     * The ID of the task after which the moved task is positioned in the task display.
+     * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
      */
     beforeTaskId?: string | null;
 }
@@ -6109,10 +6057,9 @@ interface CountTasksSignature {
      * Counts the number of tasks.
      *
      *
-     * This endpoint returns the count of all tasks regardless of the task `status`.
+     * This method returns the count of all tasks regardless of their `status`.
      *
-     * Optionally, you can pass a filter to count only tasks based
-     * on specified criteria.
+     * Optionally, you can specify a filter to count only tasks that meet certain criteria.
      * @param - Filtering options.
      */
     (options?: CountTasksOptions | undefined): Promise<CountTasksResponse & CountTasksResponseNonNullableFields>;
@@ -6120,10 +6067,10 @@ interface CountTasksSignature {
 declare function moveTaskAfter$1(httpClient: HttpClient): MoveTaskAfterSignature;
 interface MoveTaskAfterSignature {
     /**
-     * Moves a task specified by ID to be placed after another task in the display.
+     * Moves a task specified by ID to be placed after another task in the task display.
      *
-     * You can reposition a task to be first in the display by ommitting `beforeTaskId`.
-     * @param - The task ID to move.
+     * You can reposition a task to be first in the display by omitting `beforeTaskId`.
+     * @param - ID of the task to move.
      * @param - Options for moving the task.
      */
     (taskId: string, options?: MoveTaskAfterOptions | undefined): Promise<void>;

package/type-bundles/index.bundle.d.ts

@@ -3239,7 +3239,7 @@ interface ExtendedField {
     /**
      * Extended field namespace.
      *
-     * Extended fields created by site collaborators or 3rd-party apps
+     * Extended fields created through by calling the Find Or Create Extended Field method
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
@@ -3248,34 +3248,24 @@ interface ExtendedField {
      * Extended field key.
      *
      * When accessing contact data,
-     * extended field data is available at `fields[key]`.
+     * extended field data is available at `extendedFields[key]`.
      * For example, if the key is "custom.notes",
-     * the value can be accessed at `fields["custom.notes"]`.
+     * the value can be accessed at `extendedFields["custom.notes"]`.
      *
      * `key` is generated when the extended field is created
-     * and cannot be modified, even if `displayName` changes.
+     * and can't be modified, even if `displayName` changes.
      * @readonly
      */
     key?: string;
-    /** Display name shown in the Contact List. */
+    /** Display name shown in the contact list. */
     displayName?: string;
     /**
      * Type of data the field holds.
-     *
-     * 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.
-     *
-     * One of:
-     * - `"SYSTEM"`: System field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `"USER_DEFINED"`: Custom field that can be modified by 3rd-party apps or site admins.
      * @readonly
      */
     fieldType?: FieldType;
@@ -3306,9 +3296,9 @@ declare enum FieldDataType {
     URL = "URL"
 }
 declare enum FieldType {
-    /** The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors. */
+    /** Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. */
     SYSTEM = "SYSTEM",
-    /** The field is a custom field and can be modified by 3rd-party apps or site contributors. */
+    /** Field is a custom field and can be modified by calling the Update Extended Field method. */
     USER_DEFINED = "USER_DEFINED"
 }
 /** Extended field filter options. */
@@ -3317,7 +3307,7 @@ interface ListExtendedFieldsRequest {
     fieldType?: FieldType;
     /**
      * Filter for fields in the specified namespace.
-     * Fields created by site contributors or 3rd-party apps
+     * Fields created by calling the Find Or Create Extended Field method
      * are automatically assigned to the `custom` namespace.
      */
     namespace?: string | null;
@@ -3381,10 +3371,10 @@ interface PagingMetadata$1 {
 /** Custom field to find or create. */
 interface FindOrCreateExtendedFieldRequest {
     /**
-     * Display name to find or create.
+     * Display name to retrieve or create.
      *
      * If an existing custom field is an exact match
-     * for the specified `displayName`,
+     * for the specified display name,
      * the existing field is returned.
      * If not, a new field is created and returned.
      */
@@ -3392,12 +3382,7 @@ interface FindOrCreateExtendedFieldRequest {
     /**
      * Type of data the field holds.
      * Ignored if an existing field is an exact match
-     * 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.
+     * for the specified display name.
      */
     dataType?: FieldDataType;
 }
@@ -3408,8 +3393,7 @@ interface FindOrCreateExtendedFieldResponse {
     /**
      * Indicates whether the extended field was just created or already existed.
      *
-     * If the field was just created, returns `true`.
-     * If the field already existed, returns `false`.
+     * Returns `true` if the field was just created.
      */
     newField?: boolean;
 }
@@ -3418,11 +3402,12 @@ interface GetExtendedFieldRequest {
      * Extended field key.
      *
      * When accessing contact data,
-     * extended field values are available at `fields[key]`.
-     * For example, if the key is "custom.notes",
-     * the value can be accessed at `fields["custom.notes"]`.
+     * 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"]`.
      *
-     * Once set, `key` cannot be modified, even if `displayName` changes.
+     * `key` is generated when the extended field is created.
+     * It can't be modified, even if `displayName` is updated.
      */
     key: string;
 }
@@ -3440,12 +3425,12 @@ interface GetExtendedFieldByLegacyIdResponse {
     field?: ExtendedField;
 }
 interface UpdateExtendedFieldRequest {
-    /** Field to update. */
+    /** Extended field to rename. */
     field?: ExtendedField;
 }
 /** Updated extended field. */
 interface UpdateExtendedFieldResponse {
-    /** Updated extended field. */
+    /** Renamed extended field. */
     field?: ExtendedField;
 }
 interface DeleteExtendedFieldRequest {
@@ -3695,30 +3680,20 @@ interface RenameExtendedField {
     /**
      * Extended field namespace.
      *
-     * Extended fields created by site collaborators or 3rd-party apps
+     * Extended fields created through by calling the Find Or Create Extended Field method
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
     namespace?: string | null;
-    /** Display name shown in the Contact List. */
+    /** Display name shown in the contact list. */
     displayName?: string;
     /**
      * Type of data the field holds.
-     *
-     * 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.
-     *
-     * One of:
-     * - `"SYSTEM"`: System field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `"USER_DEFINED"`: Custom field that can be modified by 3rd-party apps or site admins.
      * @readonly
      */
     fieldType?: FieldType;
@@ -3814,28 +3789,23 @@ interface FieldsQueryBuilder {
 declare function findOrCreateExtendedField$1(httpClient: HttpClient): FindOrCreateExtendedFieldSignature;
 interface FindOrCreateExtendedFieldSignature {
     /**
-     * Retrieves a custom field with a given name, or creates one if it doesn't exist.
+     * Retrieves a custom field with a specified name, or creates one if it doesn't exist.
+     * The number of custom fields is limited to 100.
      *
-     * The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
+     * Successful calls to this method always return a field,
+     * which can be specified in subsequent calls.
      *
-     * 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()` or `queryExtendedFields()`.
-     *
-     * @param - Display name to find or create.
+     * To find an existing custom field without potentially creating a new one, call Get Extended Field or
+     * Query Extended Fields.
+     * @param - Display name to retrieve or create.
      *
      * If an existing custom field is an exact match
-     * for the specified `displayName`,
+     * for the specified display name,
      * the existing field is returned.
      * If not, a new field is created and returned.
      * @param - Type of data the field holds.
      * Ignored if an existing field is an exact match
-     * 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.
+     * for the specified display name.
      * @returns Extended field that was found or created.
      */
     (displayName: string, dataType: FieldDataType): Promise<FindOrCreateExtendedFieldResponse & FindOrCreateExtendedFieldResponseNonNullableFields>;
@@ -3843,18 +3813,8 @@ interface FindOrCreateExtendedFieldSignature {
 declare function getExtendedField$1(httpClient: HttpClient): GetExtendedFieldSignature;
 interface GetExtendedFieldSignature {
     /**
-     * Retrieves an extended field.
-     *
-     * The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
-     *
-     * @param - Extended field key.
-     *
-     * When accessing contact data,
-     * extended field values are available at `fields[key]`.
-     * 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.
+     * Retrieves an extended field by the specified extended field key.
+     * @param - null
      * @returns The specified field.
      */
     (key: string): Promise<ExtendedField & ExtendedFieldNonNullableFields>;
@@ -3863,19 +3823,9 @@ declare function renameExtendedField$1(httpClient: HttpClient): RenameExtendedFi
 interface RenameExtendedFieldSignature {
     /**
      * Renames an extended field.
-     *
-     * The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
-     *
-     * @param - Extended field key.
-     *
-     * When accessing contact data,
-     * extended field values are available at `fields[key]`.
-     * 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.
-     * @param - Extended field to rename.
-     * @returns Updated extended field.
+     * @param - null
+     * @param - null
+     * @returns Renamed extended field.
      */
     (key: string, field: RenameExtendedField): Promise<ExtendedField & ExtendedFieldNonNullableFields>;
 }
@@ -3884,10 +3834,8 @@ interface DeleteExtendedFieldSignature {
     /**
      * Deletes an extended field.
      *
-     * 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.
-     *
+     * When an extended field is deleted,
+     * any contact data stored in the field is also permanently deleted.
      * @param - Extended field key.
      */
     (key: string): Promise<void>;
@@ -3897,18 +3845,18 @@ interface QueryExtendedFieldsSignature {
     /**
      * 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 `FieldsQueryBuilder` object.
+     * The `queryExtendedFields()` method builds a query to retrieve a list of extended fields and returns an `FieldsQueryBuilder` object.
      *
-     * The returned object contains the query definition, which is used to run the query using the `find()` function.
+     * The returned object contains the query definition, which is used to run the query using the `find()` method.
      *
-     * You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
+     * You can refine the query by chaining `FieldsQueryBuilder` methods onto the query. `FieldsQueryBuilder` methods enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
      *
      * `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
      * - `skip()`
      * - `limit(50)`
      * - `descending('_createdDate')`
      *
-     * The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.
+     * The following `FieldsQueryBuilder` methods are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.
      */
     (): FieldsQueryBuilder;
 }
@@ -5451,7 +5399,7 @@ interface TaskSource {
      */
     appId?: string | null;
     /**
-     * User ID, if the task was created by a user.
+     * User ID, if the task was created by a Wix user.
      * @readonly
      */
     userId?: string | null;
@@ -5460,7 +5408,7 @@ interface TaskSource {
 declare enum SourceType {
     /** Task was created by an app. */
     APP = "APP",
-    /** Task was created by a user. */
+    /** Task was created by a Wix user. */
     USER = "USER"
 }
 interface ContactInfo {
@@ -5477,7 +5425,7 @@ interface ContactInfo {
      */
     lastName?: string | null;
     /**
-     * Contact's image url.
+     * Contact's image URL.
      * @readonly
      */
     imageUrl?: string | null;
@@ -5652,7 +5600,7 @@ interface CountTasksRequest {
     filter?: Record<string, any> | null;
 }
 interface CountTasksResponse {
-    /** The number of tasks that match the provided filter. */
+    /** The number of tasks that match the specified filter. */
     count?: number;
 }
 interface QueryTasksInternalRequest {
@@ -5697,7 +5645,7 @@ interface Paging {
     offset?: number | null;
 }
 interface QueryTasksInternalResponse {
-    /** The retrieved Tasks */
+    /** The retrieved tasks. */
     tasks?: Task[];
     /** Details on the paged set of results returned. */
     pagingMetadata?: PagingMetadataV2;
@@ -5715,11 +5663,11 @@ interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 interface MoveTaskAfterRequest {
-    /** The task ID to move. */
+    /** ID of the task to move. */
     taskId: string;
     /**
-     * The task ID after which the moved task is positioned in the display.
-     * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
+     * The ID of the task after which the moved task is positioned in the task display.
+     * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
      */
     beforeTaskId?: string | null;
 }
@@ -6028,8 +5976,8 @@ interface CountTasksOptions {
 }
 interface MoveTaskAfterOptions {
     /**
-     * The task ID after which the moved task is positioned in the display.
-     * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
+     * The ID of the task after which the moved task is positioned in the task display.
+     * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
      */
     beforeTaskId?: string | null;
 }
@@ -6109,10 +6057,9 @@ interface CountTasksSignature {
      * Counts the number of tasks.
      *
      *
-     * This endpoint returns the count of all tasks regardless of the task `status`.
+     * This method returns the count of all tasks regardless of their `status`.
      *
-     * Optionally, you can pass a filter to count only tasks based
-     * on specified criteria.
+     * Optionally, you can specify a filter to count only tasks that meet certain criteria.
      * @param - Filtering options.
      */
     (options?: CountTasksOptions | undefined): Promise<CountTasksResponse & CountTasksResponseNonNullableFields>;
@@ -6120,10 +6067,10 @@ interface CountTasksSignature {
 declare function moveTaskAfter$1(httpClient: HttpClient): MoveTaskAfterSignature;
 interface MoveTaskAfterSignature {
     /**
-     * Moves a task specified by ID to be placed after another task in the display.
+     * Moves a task specified by ID to be placed after another task in the task display.
      *
-     * You can reposition a task to be first in the display by ommitting `beforeTaskId`.
-     * @param - The task ID to move.
+     * You can reposition a task to be first in the display by omitting `beforeTaskId`.
+     * @param - ID of the task to move.
      * @param - Options for moving the task.
      */
     (taskId: string, options?: MoveTaskAfterOptions | undefined): Promise<void>;

package/type-bundles/meta.bundle.d.ts

@@ -2095,7 +2095,7 @@ interface ExtendedField$1 {
     /**
      * Extended field namespace.
      *
-     * Extended fields created by site collaborators or 3rd-party apps
+     * Extended fields created through by calling the Find Or Create Extended Field method
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
@@ -2109,11 +2109,11 @@ interface ExtendedField$1 {
      * the value can be accessed at `extendedFields["custom.notes"]`.
      *
      * `key` is generated when the extended field is created
-     * and cannot be modified, even if `displayName` changes.
+     * and can't be modified, even if `displayName` changes.
      * @readonly
      */
     key?: string;
-    /** Display name shown in the Contact List. */
+    /** Display name shown in the contact list. */
     displayName?: string;
     /**
      * Type of data the field holds.
@@ -2152,9 +2152,9 @@ declare enum FieldDataType$1 {
     URL = "URL"
 }
 declare enum FieldType$1 {
-    /** The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors. */
+    /** Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. */
     SYSTEM = "SYSTEM",
-    /** The field is a custom field and can be modified by 3rd-party apps or site contributors. */
+    /** Field is a custom field and can be modified by calling the Update Extended Field method. */
     USER_DEFINED = "USER_DEFINED"
 }
 interface Sorting$5 {
@@ -2203,10 +2203,10 @@ interface PagingMetadata$3 {
 /** Custom field to find or create. */
 interface FindOrCreateExtendedFieldRequest$1 {
     /**
-     * Display name to find or create.
+     * Display name to retrieve or create.
      *
      * If an existing custom field is an exact match
-     * for the specified `displayName`,
+     * for the specified display name,
      * the existing field is returned.
      * If not, a new field is created and returned.
      */
@@ -2215,11 +2215,6 @@ interface FindOrCreateExtendedFieldRequest$1 {
      * Type of data the field holds.
      * Ignored if an existing field is an exact match
      * for the specified display name.
-     *
-     * - `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$1;
 }
@@ -2230,8 +2225,7 @@ interface FindOrCreateExtendedFieldResponse$1 {
     /**
      * Indicates whether the extended field was just created or already existed.
      *
-     * If the field was just created, returns `true`.
-     * If the field already existed, returns `false`.
+     * Returns `true` if the field was just created.
      */
     newField?: boolean;
 }
@@ -2244,7 +2238,8 @@ interface GetExtendedFieldRequest$1 {
      * For example, if the key is "custom.patronus",
      * the value can be accessed at `info.extendedFields.items["custom.patronus"]`.
      *
-     * Once set, `key` cannot be modified, even if `displayName` changes.
+     * `key` is generated when the extended field is created.
+     * It can't be modified, even if `displayName` is updated.
      */
     key: string;
 }
@@ -2254,12 +2249,12 @@ interface GetExtendedFieldResponse$1 {
     field?: ExtendedField$1;
 }
 interface UpdateExtendedFieldRequest$1 {
-    /** Field to update. */
+    /** Extended field to rename. */
     field?: ExtendedField$1;
 }
 /** Updated extended field. */
 interface UpdateExtendedFieldResponse$1 {
-    /** Updated extended field. */
+    /** Renamed extended field. */
     field?: ExtendedField$1;
 }
 interface DeleteExtendedFieldRequest$1 {
@@ -2328,7 +2323,7 @@ interface ExtendedField {
     /**
      * Extended field namespace.
      *
-     * Extended fields created by site collaborators or 3rd-party apps
+     * Extended fields created through by calling the Find Or Create Extended Field method
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
@@ -2337,34 +2332,24 @@ interface ExtendedField {
      * Extended field key.
      *
      * When accessing contact data,
-     * extended field data is available at `fields[key]`.
+     * extended field data is available at `extendedFields[key]`.
      * For example, if the key is "custom.notes",
-     * the value can be accessed at `fields["custom.notes"]`.
+     * the value can be accessed at `extendedFields["custom.notes"]`.
      *
      * `key` is generated when the extended field is created
-     * and cannot be modified, even if `displayName` changes.
+     * and can't be modified, even if `displayName` changes.
      * @readonly
      */
     key?: string;
-    /** Display name shown in the Contact List. */
+    /** Display name shown in the contact list. */
     displayName?: string;
     /**
      * Type of data the field holds.
-     *
-     * 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.
-     *
-     * One of:
-     * - `"SYSTEM"`: System field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `"USER_DEFINED"`: Custom field that can be modified by 3rd-party apps or site admins.
      * @readonly
      */
     fieldType?: FieldType;
@@ -2395,9 +2380,9 @@ declare enum FieldDataType {
     URL = "URL"
 }
 declare enum FieldType {
-    /** The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors. */
+    /** Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. */
     SYSTEM = "SYSTEM",
-    /** The field is a custom field and can be modified by 3rd-party apps or site contributors. */
+    /** Field is a custom field and can be modified by calling the Update Extended Field method. */
     USER_DEFINED = "USER_DEFINED"
 }
 interface Sorting$4 {
@@ -2446,10 +2431,10 @@ interface PagingMetadata$2 {
 /** Custom field to find or create. */
 interface FindOrCreateExtendedFieldRequest {
     /**
-     * Display name to find or create.
+     * Display name to retrieve or create.
      *
      * If an existing custom field is an exact match
-     * for the specified `displayName`,
+     * for the specified display name,
      * the existing field is returned.
      * If not, a new field is created and returned.
      */
@@ -2457,12 +2442,7 @@ interface FindOrCreateExtendedFieldRequest {
     /**
      * Type of data the field holds.
      * Ignored if an existing field is an exact match
-     * 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.
+     * for the specified display name.
      */
     dataType?: FieldDataType;
 }
@@ -2473,8 +2453,7 @@ interface FindOrCreateExtendedFieldResponse {
     /**
      * Indicates whether the extended field was just created or already existed.
      *
-     * If the field was just created, returns `true`.
-     * If the field already existed, returns `false`.
+     * Returns `true` if the field was just created.
      */
     newField?: boolean;
 }
@@ -2483,11 +2462,12 @@ interface GetExtendedFieldRequest {
      * Extended field key.
      *
      * When accessing contact data,
-     * extended field values are available at `fields[key]`.
-     * For example, if the key is "custom.notes",
-     * the value can be accessed at `fields["custom.notes"]`.
+     * 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"]`.
      *
-     * Once set, `key` cannot be modified, even if `displayName` changes.
+     * `key` is generated when the extended field is created.
+     * It can't be modified, even if `displayName` is updated.
      */
     key: string;
 }
@@ -2497,12 +2477,12 @@ interface GetExtendedFieldResponse {
     field?: ExtendedField;
 }
 interface UpdateExtendedFieldRequest {
-    /** Field to update. */
+    /** Extended field to rename. */
     field?: ExtendedField;
 }
 /** Updated extended field. */
 interface UpdateExtendedFieldResponse {
-    /** Updated extended field. */
+    /** Renamed extended field. */
     field?: ExtendedField;
 }
 interface DeleteExtendedFieldRequest {
@@ -3676,7 +3656,7 @@ interface TaskSource$1 {
      */
     appId?: string | null;
     /**
-     * User ID, if the task was created by a user.
+     * User ID, if the task was created by a Wix user.
      * @readonly
      */
     userId?: string | null;
@@ -3685,7 +3665,7 @@ interface TaskSource$1 {
 declare enum SourceType$1 {
     /** Task was created by an app. */
     APP = "APP",
-    /** Task was created by a user. */
+    /** Task was created by a Wix user. */
     USER = "USER"
 }
 interface ContactInfo$1 {
@@ -3702,7 +3682,7 @@ interface ContactInfo$1 {
      */
     lastName?: string | null;
     /**
-     * Contact's image url.
+     * Contact's image URL.
      * @readonly
      */
     imageUrl?: string | null;
@@ -3824,27 +3804,29 @@ interface Cursors$1 {
 }
 interface CountTasksRequest$1 {
     /**
-     * Filter tasks to count. See [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort) for supported filters.
+     * Filter which tasks to count. See supported filters ([REST](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort)| [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/tasks/query-tasks)).
      *
      * Filter tasks in the following format:
+     *
      * `"filter" : {
      * "fieldName1": "value1",
      * "fieldName2":{"$operator":"value2"}
      * }`
+     *
      * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
      */
     filter?: Record<string, any> | null;
 }
 interface CountTasksResponse$1 {
-    /** The number of tasks that match the provided filter. */
+    /** The number of tasks that match the specified filter. */
     count?: number;
 }
 interface MoveTaskAfterRequest$1 {
-    /** The task ID to move. */
+    /** ID of the task to move. */
     taskId: string;
     /**
-     * The task ID after which the moved task is positioned in the display.
-     * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
+     * The ID of the task after which the moved task is positioned in the task display.
+     * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
      */
     beforeTaskId?: string | null;
 }
@@ -3930,7 +3912,7 @@ interface TaskSource {
      */
     appId?: string | null;
     /**
-     * User ID, if the task was created by a user.
+     * User ID, if the task was created by a Wix user.
      * @readonly
      */
     userId?: string | null;
@@ -3939,7 +3921,7 @@ interface TaskSource {
 declare enum SourceType {
     /** Task was created by an app. */
     APP = "APP",
-    /** Task was created by a user. */
+    /** Task was created by a Wix user. */
     USER = "USER"
 }
 interface ContactInfo {
@@ -3956,7 +3938,7 @@ interface ContactInfo {
      */
     lastName?: string | null;
     /**
-     * Contact's image url.
+     * Contact's image URL.
      * @readonly
      */
     imageUrl?: string | null;
@@ -4091,15 +4073,15 @@ interface CountTasksRequest {
     filter?: Record<string, any> | null;
 }
 interface CountTasksResponse {
-    /** The number of tasks that match the provided filter. */
+    /** The number of tasks that match the specified filter. */
     count?: number;
 }
 interface MoveTaskAfterRequest {
-    /** The task ID to move. */
+    /** ID of the task to move. */
     taskId: string;
     /**
-     * The task ID after which the moved task is positioned in the display.
-     * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
+     * The ID of the task after which the moved task is positioned in the task display.
+     * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
      */
     beforeTaskId?: string | null;
 }