@wix/crm 1.0.165 → 1.0.167

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 {
@@ -2602,14 +2582,14 @@ interface ContactLabel$1 {
     /**
      * 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;
@@ -2617,11 +2597,11 @@ interface ContactLabel$1 {
      * 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 indicating how the label was created.
@@ -2640,11 +2620,11 @@ interface ContactLabel$1 {
     updatedDate?: Date | null;
 }
 declare enum LabelType$1 {
-    /** 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"
 }
 interface Sorting$3 {
@@ -2698,7 +2678,10 @@ interface FindOrCreateLabelRequest$1 {
      * 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. */
@@ -2708,8 +2691,7 @@ interface FindOrCreateLabelResponse$1 {
     /**
      * 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;
 }
@@ -2718,10 +2700,13 @@ interface GetLabelRequest$1 {
      * 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. */
@@ -2730,14 +2715,17 @@ interface GetLabelResponse$1 {
     label?: ContactLabel$1;
 }
 interface UpdateLabelRequest$1 {
-    /** Label details to update. */
+    /** Label to rename. */
     label?: ContactLabel$1;
-    /** 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$1 {
-    /** Updated label. */
+    /** Renamed label. */
     label?: ContactLabel$1;
 }
 interface DeleteLabelRequest$1 {
@@ -2749,7 +2737,10 @@ interface DeleteLabelResponse$1 {
 interface QueryLabelsRequest$1 {
     /** Query options. */
     query?: Query$1;
-    /** 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$1 {
@@ -2807,14 +2798,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;
@@ -2822,18 +2813,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;
@@ -2849,11 +2836,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"
 }
 interface Sorting$2 {
@@ -2907,7 +2894,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. */
@@ -2917,8 +2907,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;
 }
@@ -2927,10 +2916,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. */
@@ -2939,14 +2931,17 @@ interface GetLabelResponse {
     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 {
@@ -2958,7 +2953,10 @@ interface DeleteLabelResponse {
 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 {