@wix/crm 1.0.165 → 1.0.167

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.
-     *
-     * The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
+     * 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.
      *
-     * Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
+     * Successful calls to this method always return a field,
+     * which can be specified in subsequent 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;
 }
@@ -3992,14 +3940,14 @@ interface ContactLabel {
     /**
      * Label namespace.
      *
-     * Labels created by site admins or 3rd-party apps
+     * Labels created by calling the Find Or Create Label method
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
     namespace?: string | null;
     /**
      * Display name for the namespace,
-     * used to organize the list of labels in the site Dashboard.
+     * used to organize the list of labels in the site dashboard.
      * @readonly
      */
     namespaceDisplayName?: string | null;
@@ -4007,18 +3955,14 @@ interface ContactLabel {
      * Label key.
      *
      * `key` is generated when the label is created.
-     * It cannot be modified, even if `displayName` is updated.
+     * It can't be modified, even if `displayName` is updated.
      * @readonly
      */
     key?: string;
-    /** Label display name shown in the Dashboard. */
+    /** Label display name shown in the dashboard. */
     displayName?: string;
     /**
-     * Label type.
-     *
-     * - `"SYSTEM"`: The label is a default system label for the Contact List.
-     * - `"USER_DEFINED"`: The label was created by a site contributor or 3rd-party app.
-     * - `"WIX_APP_DEFINED"`: The label was created by a Wix app.
+     * Label type indicating how the label was created.
      * @readonly
      */
     labelType?: LabelType;
@@ -4034,11 +3978,11 @@ interface ContactLabel {
     _updatedDate?: Date | null;
 }
 declare enum LabelType {
-    /** Default system label for the Contact List. */
+    /** Default system label for the contact list. */
     SYSTEM = "SYSTEM",
-    /** Label created by a site contributor or 3rd-party app. */
+    /** Label created by calling the Find Or Create Label method. */
     USER_DEFINED = "USER_DEFINED",
-    /** Label created by a Wix app. */
+    /** Label created by an app built by Wix. */
     WIX_APP_DEFINED = "WIX_APP_DEFINED"
 }
 /** Label filter options. */
@@ -4053,7 +3997,6 @@ interface ListLabelsRequest {
     sort?: Sorting$1;
     /** Paging options. */
     paging?: Paging$1;
-    /** Language for localization. */
     language?: string | null;
 }
 interface Sorting$1 {
@@ -4114,7 +4057,10 @@ interface FindOrCreateLabelRequest {
      * If not, a new label is created and returned.
      */
     displayName: string;
-    /** Language for localization. */
+    /**
+     * Language for localization.
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
+     */
     language?: string | null;
 }
 /** Label that was found or created. */
@@ -4124,8 +4070,7 @@ interface FindOrCreateLabelResponse {
     /**
      * Indicates whether the label was just created or already existed.
      *
-     * If the label was just created, returns `true`.
-     * If it already existed, returns `false`.
+     * Returns `true` if the label was just created.
      */
     newLabel?: boolean;
 }
@@ -4160,10 +4105,13 @@ interface GetLabelRequest {
      * Label key.
      *
      * `key` is generated when the label is created.
-     * It cannot be modified, even if `displayName` is updated.
+     * It can't be modified, even if `displayName` is updated.
      */
     key: string;
-    /** Language for localization. */
+    /**
+     * Language for localization.
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
+     */
     language?: string | null;
 }
 /** The specified label. */
@@ -4182,14 +4130,17 @@ interface GetLabelByLegacyIdResponse {
     label?: ContactLabel;
 }
 interface UpdateLabelRequest {
-    /** Label details to update. */
+    /** Label to rename. */
     label?: ContactLabel;
-    /** Language for localization. */
+    /**
+     * Language for localization.
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
+     */
     language?: string | null;
 }
 /** Updated label. */
 interface UpdateLabelResponse {
-    /** Updated label. */
+    /** Renamed label. */
     label?: ContactLabel;
 }
 interface DeleteLabelRequest {
@@ -4219,7 +4170,10 @@ interface GdprListResponse {
 interface QueryLabelsRequest {
     /** Query options. */
     query?: Query;
-    /** Language for localization. */
+    /**
+     * Language for localization.
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
+     */
     language?: string | null;
 }
 interface Query {
@@ -4441,18 +4395,14 @@ interface LabelUpdatedEnvelope {
 interface FindOrCreateLabelOptions {
     /**
      * Language for localization.
-     *
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
      */
     language?: string | null;
 }
 interface GetLabelOptions {
     /**
      * Language for localization.
-     *
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
      */
     language?: string | null;
 }
@@ -4460,25 +4410,21 @@ interface RenameLabel {
     /**
      * Label namespace.
      *
-     * Labels created by site admins or 3rd-party apps
+     * Labels created by calling the Find Or Create Label method
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
     namespace?: string | null;
     /**
      * Display name for the namespace,
-     * used to organize the list of labels in the site Dashboard.
+     * used to organize the list of labels in the site dashboard.
      * @readonly
      */
     namespaceDisplayName?: string | null;
-    /** Label display name shown in the Dashboard. */
+    /** Label display name shown in the dashboard. */
     displayName?: string;
     /**
-     * Label type.
-     *
-     * - `"SYSTEM"`: The label is a default system label for the Contact List.
-     * - `"USER_DEFINED"`: The label was created by a site contributor or 3rd-party app.
-     * - `"WIX_APP_DEFINED"`: The label was created by a Wix app.
+     * Label type indicating how the label was created.
      * @readonly
      */
     labelType?: LabelType;
@@ -4496,9 +4442,7 @@ interface RenameLabel {
 interface RenameLabelOptions {
     /**
      * Language for localization.
-     *
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
      */
     language?: string | null;
 }
@@ -4587,15 +4531,18 @@ interface LabelsQueryBuilder {
 declare function findOrCreateLabel$1(httpClient: HttpClient): FindOrCreateLabelSignature;
 interface FindOrCreateLabelSignature {
     /**
-     * Retrieves a label with a given name, or creates one if it doesn't exist.
+     * Retrieves a label with a specified name, or creates one if it doesn't exist.
      *
-     * The `findOrCreateLabel()` function returns a Promise that resolves when the specified label is found or created.
-     *
-     * Successful calls to `findOrCreateLabel()` always returns a label, which can be passed to subsequent function calls.
-     *
-     * To find an existing label without potentially creating a new one, use `getLabel()` or `queryLabels()`.
+     * Successful calls to this method always return a label,
+     * which can be specified in subsequent calls.
      *
+     * For example, in the Contacts API, Label Contact and Unlabel Contact
+     * calls will fail if you include a non-existant label.
+     * To ensure successful calls, you can call this method first,
+     * and then use the response in the Label Contact and Unlabel Contact calls.
      *
+     * To find an existing label without potentially creating a new one, call
+     * Get Label or Query Labels.
      * @param - Display name to retrieve or create.
      *
      * If an existing label is an exact match
@@ -4611,12 +4558,10 @@ declare function getLabel$1(httpClient: HttpClient): GetLabelSignature;
 interface GetLabelSignature {
     /**
      * Retrieves a label by the specified label key.
-     *
-     * The `getLabel()` function returns a Promise that resolves when the specified label is retrieved.
      * @param - Label key.
      *
      * `key` is generated when the label is created.
-     * It cannot be modified, even if `displayName` is updated.
+     * It can't be modified, even if `displayName` is updated.
      * @param - Language options.
      * @returns The specified label.
      */
@@ -4626,27 +4571,20 @@ declare function renameLabel$1(httpClient: HttpClient): RenameLabelSignature;
 interface RenameLabelSignature {
     /**
      * Renames a label.
-     *
-     * The `renameLabel()` function returns a Promise that resolves when the specified label's display name is changed.
-     *
      * @param - Label key.
      *
      * `key` is generated when the label is created.
-     * It cannot be modified, even if `displayName` is updated.
+     * It can't be modified, even if `displayName` is updated.
      * @param - Language options.
      * @param - Label to rename.
-     * @returns
+     * @returns Renamed label.
      */
     (key: string, label: RenameLabel, options?: RenameLabelOptions | undefined): Promise<ContactLabel & ContactLabelNonNullableFields>;
 }
 declare function deleteLabel$1(httpClient: HttpClient): DeleteLabelSignature;
 interface DeleteLabelSignature {
     /**
-     * Deletes a label from the site and removes it from contacts it applies to.
-     *
-     * The `deleteLabel()` function returns a Promise that resolves when the specified label is deleted.
-     *
-     *
+     * Deletes the specified label from a site and removes it from the contacts it applies to.
      * @param - Label key to delete.
      */
     (key: string): Promise<void>;
@@ -4656,18 +4594,18 @@ interface QueryLabelsSignature {
     /**
      * Creates a query to retrieve a list of labels.
      *
-     * The `queryLabels()` function builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
+     * The `queryLabels()` method builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` 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 call the query using the `find()` method.
      *
-     * You can refine the query by chaining `LabelsQueryBuilder` functions onto the query. `LabelsQueryBuilder` functions enable you to filter, sort, and control the results that `queryLabels()` returns.
+     * You can refine the query by chaining `LabelsQueryBuilder` methods onto the query. `LabelsQueryBuilder` methods enable you to filter, sort, and control the response that `queryLabels()` returns.
      *
-     * `queryLabels()` runs with the following `LabelsQueryBuilder` defaults, which you can override:
+     * `queryLabels()` is called with the following `LabelsQueryBuilder` defaults, which you can override:
      * - `skip(0)`
      * - `limit(50)`
      * - `descending('_createdDate')`
      *
-     * The following `LabelsQueryBuilder` functions are supported for `queryLabels()`. For a full description of the `Labels` object, see the object returned for the `items` property in `LabelsQueryResult`.
+     * The following `LabelsQueryBuilder` methods are supported for `queryLabels()`. For a full description of the `Labels` object, see the object returned for the `items` field in `LabelsQueryResult`.
      *
      *
      * @param - Language options.