@wix/crm 1.0.166 → 1.0.167

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/crm",
3
- "version": "1.0.166",
3
+ "version": "1.0.167",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -24,7 +24,7 @@
24
24
  "@wix/crm_attachments": "1.0.24",
25
25
  "@wix/crm_contacts": "1.0.70",
26
26
  "@wix/crm_extended-fields": "1.0.50",
27
- "@wix/crm_labels": "1.0.48",
27
+ "@wix/crm_labels": "1.0.49",
28
28
  "@wix/crm_submitted-contact": "1.0.44",
29
29
  "@wix/crm_tasks": "1.0.52"
30
30
  },
@@ -51,5 +51,5 @@
51
51
  "fqdn": ""
52
52
  }
53
53
  },
54
- "falconPackageHash": "836a3b910015981e98fbc15eff4261f492ccfbbcb59126d7b39a931b"
54
+ "falconPackageHash": "f451bc5774c21deaaa767880cec33ecec80ce9320f39ac083178cd59"
55
55
  }
@@ -3940,14 +3940,14 @@ interface ContactLabel {
3940
3940
  /**
3941
3941
  * Label namespace.
3942
3942
  *
3943
- * Labels created by site admins or 3rd-party apps
3943
+ * Labels created by calling the Find Or Create Label method
3944
3944
  * are automatically assigned to the `custom` namespace.
3945
3945
  * @readonly
3946
3946
  */
3947
3947
  namespace?: string | null;
3948
3948
  /**
3949
3949
  * Display name for the namespace,
3950
- * used to organize the list of labels in the site Dashboard.
3950
+ * used to organize the list of labels in the site dashboard.
3951
3951
  * @readonly
3952
3952
  */
3953
3953
  namespaceDisplayName?: string | null;
@@ -3955,18 +3955,14 @@ interface ContactLabel {
3955
3955
  * Label key.
3956
3956
  *
3957
3957
  * `key` is generated when the label is created.
3958
- * It cannot be modified, even if `displayName` is updated.
3958
+ * It can't be modified, even if `displayName` is updated.
3959
3959
  * @readonly
3960
3960
  */
3961
3961
  key?: string;
3962
- /** Label display name shown in the Dashboard. */
3962
+ /** Label display name shown in the dashboard. */
3963
3963
  displayName?: string;
3964
3964
  /**
3965
- * Label type.
3966
- *
3967
- * - `"SYSTEM"`: The label is a default system label for the Contact List.
3968
- * - `"USER_DEFINED"`: The label was created by a site contributor or 3rd-party app.
3969
- * - `"WIX_APP_DEFINED"`: The label was created by a Wix app.
3965
+ * Label type indicating how the label was created.
3970
3966
  * @readonly
3971
3967
  */
3972
3968
  labelType?: LabelType;
@@ -3982,11 +3978,11 @@ interface ContactLabel {
3982
3978
  _updatedDate?: Date | null;
3983
3979
  }
3984
3980
  declare enum LabelType {
3985
- /** Default system label for the Contact List. */
3981
+ /** Default system label for the contact list. */
3986
3982
  SYSTEM = "SYSTEM",
3987
- /** Label created by a site contributor or 3rd-party app. */
3983
+ /** Label created by calling the Find Or Create Label method. */
3988
3984
  USER_DEFINED = "USER_DEFINED",
3989
- /** Label created by a Wix app. */
3985
+ /** Label created by an app built by Wix. */
3990
3986
  WIX_APP_DEFINED = "WIX_APP_DEFINED"
3991
3987
  }
3992
3988
  /** Label filter options. */
@@ -4001,7 +3997,6 @@ interface ListLabelsRequest {
4001
3997
  sort?: Sorting$1;
4002
3998
  /** Paging options. */
4003
3999
  paging?: Paging$1;
4004
- /** Language for localization. */
4005
4000
  language?: string | null;
4006
4001
  }
4007
4002
  interface Sorting$1 {
@@ -4062,7 +4057,10 @@ interface FindOrCreateLabelRequest {
4062
4057
  * If not, a new label is created and returned.
4063
4058
  */
4064
4059
  displayName: string;
4065
- /** Language for localization. */
4060
+ /**
4061
+ * Language for localization.
4062
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4063
+ */
4066
4064
  language?: string | null;
4067
4065
  }
4068
4066
  /** Label that was found or created. */
@@ -4072,8 +4070,7 @@ interface FindOrCreateLabelResponse {
4072
4070
  /**
4073
4071
  * Indicates whether the label was just created or already existed.
4074
4072
  *
4075
- * If the label was just created, returns `true`.
4076
- * If it already existed, returns `false`.
4073
+ * Returns `true` if the label was just created.
4077
4074
  */
4078
4075
  newLabel?: boolean;
4079
4076
  }
@@ -4108,10 +4105,13 @@ interface GetLabelRequest {
4108
4105
  * Label key.
4109
4106
  *
4110
4107
  * `key` is generated when the label is created.
4111
- * It cannot be modified, even if `displayName` is updated.
4108
+ * It can't be modified, even if `displayName` is updated.
4112
4109
  */
4113
4110
  key: string;
4114
- /** Language for localization. */
4111
+ /**
4112
+ * Language for localization.
4113
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4114
+ */
4115
4115
  language?: string | null;
4116
4116
  }
4117
4117
  /** The specified label. */
@@ -4130,14 +4130,17 @@ interface GetLabelByLegacyIdResponse {
4130
4130
  label?: ContactLabel;
4131
4131
  }
4132
4132
  interface UpdateLabelRequest {
4133
- /** Label details to update. */
4133
+ /** Label to rename. */
4134
4134
  label?: ContactLabel;
4135
- /** Language for localization. */
4135
+ /**
4136
+ * Language for localization.
4137
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4138
+ */
4136
4139
  language?: string | null;
4137
4140
  }
4138
4141
  /** Updated label. */
4139
4142
  interface UpdateLabelResponse {
4140
- /** Updated label. */
4143
+ /** Renamed label. */
4141
4144
  label?: ContactLabel;
4142
4145
  }
4143
4146
  interface DeleteLabelRequest {
@@ -4167,7 +4170,10 @@ interface GdprListResponse {
4167
4170
  interface QueryLabelsRequest {
4168
4171
  /** Query options. */
4169
4172
  query?: Query;
4170
- /** Language for localization. */
4173
+ /**
4174
+ * Language for localization.
4175
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4176
+ */
4171
4177
  language?: string | null;
4172
4178
  }
4173
4179
  interface Query {
@@ -4389,18 +4395,14 @@ interface LabelUpdatedEnvelope {
4389
4395
  interface FindOrCreateLabelOptions {
4390
4396
  /**
4391
4397
  * Language for localization.
4392
- *
4393
- * 2-letter language code in
4394
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
4398
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4395
4399
  */
4396
4400
  language?: string | null;
4397
4401
  }
4398
4402
  interface GetLabelOptions {
4399
4403
  /**
4400
4404
  * Language for localization.
4401
- *
4402
- * 2-letter language code in
4403
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
4405
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4404
4406
  */
4405
4407
  language?: string | null;
4406
4408
  }
@@ -4408,25 +4410,21 @@ interface RenameLabel {
4408
4410
  /**
4409
4411
  * Label namespace.
4410
4412
  *
4411
- * Labels created by site admins or 3rd-party apps
4413
+ * Labels created by calling the Find Or Create Label method
4412
4414
  * are automatically assigned to the `custom` namespace.
4413
4415
  * @readonly
4414
4416
  */
4415
4417
  namespace?: string | null;
4416
4418
  /**
4417
4419
  * Display name for the namespace,
4418
- * used to organize the list of labels in the site Dashboard.
4420
+ * used to organize the list of labels in the site dashboard.
4419
4421
  * @readonly
4420
4422
  */
4421
4423
  namespaceDisplayName?: string | null;
4422
- /** Label display name shown in the Dashboard. */
4424
+ /** Label display name shown in the dashboard. */
4423
4425
  displayName?: string;
4424
4426
  /**
4425
- * Label type.
4426
- *
4427
- * - `"SYSTEM"`: The label is a default system label for the Contact List.
4428
- * - `"USER_DEFINED"`: The label was created by a site contributor or 3rd-party app.
4429
- * - `"WIX_APP_DEFINED"`: The label was created by a Wix app.
4427
+ * Label type indicating how the label was created.
4430
4428
  * @readonly
4431
4429
  */
4432
4430
  labelType?: LabelType;
@@ -4444,9 +4442,7 @@ interface RenameLabel {
4444
4442
  interface RenameLabelOptions {
4445
4443
  /**
4446
4444
  * Language for localization.
4447
- *
4448
- * 2-letter language code in
4449
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
4445
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4450
4446
  */
4451
4447
  language?: string | null;
4452
4448
  }
@@ -4535,15 +4531,18 @@ interface LabelsQueryBuilder {
4535
4531
  declare function findOrCreateLabel$1(httpClient: HttpClient): FindOrCreateLabelSignature;
4536
4532
  interface FindOrCreateLabelSignature {
4537
4533
  /**
4538
- * Retrieves a label with a given name, or creates one if it doesn't exist.
4539
- *
4540
- * The `findOrCreateLabel()` function returns a Promise that resolves when the specified label is found or created.
4534
+ * Retrieves a label with a specified name, or creates one if it doesn't exist.
4541
4535
  *
4542
- * Successful calls to `findOrCreateLabel()` always returns a label, which can be passed to subsequent function calls.
4543
- *
4544
- * To find an existing label without potentially creating a new one, use `getLabel()` or `queryLabels()`.
4536
+ * Successful calls to this method always return a label,
4537
+ * which can be specified in subsequent calls.
4545
4538
  *
4539
+ * For example, in the Contacts API, Label Contact and Unlabel Contact
4540
+ * calls will fail if you include a non-existant label.
4541
+ * To ensure successful calls, you can call this method first,
4542
+ * and then use the response in the Label Contact and Unlabel Contact calls.
4546
4543
  *
4544
+ * To find an existing label without potentially creating a new one, call
4545
+ * Get Label or Query Labels.
4547
4546
  * @param - Display name to retrieve or create.
4548
4547
  *
4549
4548
  * If an existing label is an exact match
@@ -4559,12 +4558,10 @@ declare function getLabel$1(httpClient: HttpClient): GetLabelSignature;
4559
4558
  interface GetLabelSignature {
4560
4559
  /**
4561
4560
  * Retrieves a label by the specified label key.
4562
- *
4563
- * The `getLabel()` function returns a Promise that resolves when the specified label is retrieved.
4564
4561
  * @param - Label key.
4565
4562
  *
4566
4563
  * `key` is generated when the label is created.
4567
- * It cannot be modified, even if `displayName` is updated.
4564
+ * It can't be modified, even if `displayName` is updated.
4568
4565
  * @param - Language options.
4569
4566
  * @returns The specified label.
4570
4567
  */
@@ -4574,27 +4571,20 @@ declare function renameLabel$1(httpClient: HttpClient): RenameLabelSignature;
4574
4571
  interface RenameLabelSignature {
4575
4572
  /**
4576
4573
  * Renames a label.
4577
- *
4578
- * The `renameLabel()` function returns a Promise that resolves when the specified label's display name is changed.
4579
- *
4580
4574
  * @param - Label key.
4581
4575
  *
4582
4576
  * `key` is generated when the label is created.
4583
- * It cannot be modified, even if `displayName` is updated.
4577
+ * It can't be modified, even if `displayName` is updated.
4584
4578
  * @param - Language options.
4585
4579
  * @param - Label to rename.
4586
- * @returns
4580
+ * @returns Renamed label.
4587
4581
  */
4588
4582
  (key: string, label: RenameLabel, options?: RenameLabelOptions | undefined): Promise<ContactLabel & ContactLabelNonNullableFields>;
4589
4583
  }
4590
4584
  declare function deleteLabel$1(httpClient: HttpClient): DeleteLabelSignature;
4591
4585
  interface DeleteLabelSignature {
4592
4586
  /**
4593
- * Deletes a label from the site and removes it from contacts it applies to.
4594
- *
4595
- * The `deleteLabel()` function returns a Promise that resolves when the specified label is deleted.
4596
- *
4597
- *
4587
+ * Deletes the specified label from a site and removes it from the contacts it applies to.
4598
4588
  * @param - Label key to delete.
4599
4589
  */
4600
4590
  (key: string): Promise<void>;
@@ -4604,18 +4594,18 @@ interface QueryLabelsSignature {
4604
4594
  /**
4605
4595
  * Creates a query to retrieve a list of labels.
4606
4596
  *
4607
- * The `queryLabels()` function builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
4597
+ * The `queryLabels()` method builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
4608
4598
  *
4609
- * The returned object contains the query definition, which is used to run the query using the `find()` function.
4599
+ * The returned object contains the query definition, which is used to call the query using the `find()` method.
4610
4600
  *
4611
- * 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.
4601
+ * 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.
4612
4602
  *
4613
- * `queryLabels()` runs with the following `LabelsQueryBuilder` defaults, which you can override:
4603
+ * `queryLabels()` is called with the following `LabelsQueryBuilder` defaults, which you can override:
4614
4604
  * - `skip(0)`
4615
4605
  * - `limit(50)`
4616
4606
  * - `descending('_createdDate')`
4617
4607
  *
4618
- * 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`.
4608
+ * 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`.
4619
4609
  *
4620
4610
  *
4621
4611
  * @param - Language options.
@@ -3940,14 +3940,14 @@ interface ContactLabel {
3940
3940
  /**
3941
3941
  * Label namespace.
3942
3942
  *
3943
- * Labels created by site admins or 3rd-party apps
3943
+ * Labels created by calling the Find Or Create Label method
3944
3944
  * are automatically assigned to the `custom` namespace.
3945
3945
  * @readonly
3946
3946
  */
3947
3947
  namespace?: string | null;
3948
3948
  /**
3949
3949
  * Display name for the namespace,
3950
- * used to organize the list of labels in the site Dashboard.
3950
+ * used to organize the list of labels in the site dashboard.
3951
3951
  * @readonly
3952
3952
  */
3953
3953
  namespaceDisplayName?: string | null;
@@ -3955,18 +3955,14 @@ interface ContactLabel {
3955
3955
  * Label key.
3956
3956
  *
3957
3957
  * `key` is generated when the label is created.
3958
- * It cannot be modified, even if `displayName` is updated.
3958
+ * It can't be modified, even if `displayName` is updated.
3959
3959
  * @readonly
3960
3960
  */
3961
3961
  key?: string;
3962
- /** Label display name shown in the Dashboard. */
3962
+ /** Label display name shown in the dashboard. */
3963
3963
  displayName?: string;
3964
3964
  /**
3965
- * Label type.
3966
- *
3967
- * - `"SYSTEM"`: The label is a default system label for the Contact List.
3968
- * - `"USER_DEFINED"`: The label was created by a site contributor or 3rd-party app.
3969
- * - `"WIX_APP_DEFINED"`: The label was created by a Wix app.
3965
+ * Label type indicating how the label was created.
3970
3966
  * @readonly
3971
3967
  */
3972
3968
  labelType?: LabelType;
@@ -3982,11 +3978,11 @@ interface ContactLabel {
3982
3978
  _updatedDate?: Date | null;
3983
3979
  }
3984
3980
  declare enum LabelType {
3985
- /** Default system label for the Contact List. */
3981
+ /** Default system label for the contact list. */
3986
3982
  SYSTEM = "SYSTEM",
3987
- /** Label created by a site contributor or 3rd-party app. */
3983
+ /** Label created by calling the Find Or Create Label method. */
3988
3984
  USER_DEFINED = "USER_DEFINED",
3989
- /** Label created by a Wix app. */
3985
+ /** Label created by an app built by Wix. */
3990
3986
  WIX_APP_DEFINED = "WIX_APP_DEFINED"
3991
3987
  }
3992
3988
  /** Label filter options. */
@@ -4001,7 +3997,6 @@ interface ListLabelsRequest {
4001
3997
  sort?: Sorting$1;
4002
3998
  /** Paging options. */
4003
3999
  paging?: Paging$1;
4004
- /** Language for localization. */
4005
4000
  language?: string | null;
4006
4001
  }
4007
4002
  interface Sorting$1 {
@@ -4062,7 +4057,10 @@ interface FindOrCreateLabelRequest {
4062
4057
  * If not, a new label is created and returned.
4063
4058
  */
4064
4059
  displayName: string;
4065
- /** Language for localization. */
4060
+ /**
4061
+ * Language for localization.
4062
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4063
+ */
4066
4064
  language?: string | null;
4067
4065
  }
4068
4066
  /** Label that was found or created. */
@@ -4072,8 +4070,7 @@ interface FindOrCreateLabelResponse {
4072
4070
  /**
4073
4071
  * Indicates whether the label was just created or already existed.
4074
4072
  *
4075
- * If the label was just created, returns `true`.
4076
- * If it already existed, returns `false`.
4073
+ * Returns `true` if the label was just created.
4077
4074
  */
4078
4075
  newLabel?: boolean;
4079
4076
  }
@@ -4108,10 +4105,13 @@ interface GetLabelRequest {
4108
4105
  * Label key.
4109
4106
  *
4110
4107
  * `key` is generated when the label is created.
4111
- * It cannot be modified, even if `displayName` is updated.
4108
+ * It can't be modified, even if `displayName` is updated.
4112
4109
  */
4113
4110
  key: string;
4114
- /** Language for localization. */
4111
+ /**
4112
+ * Language for localization.
4113
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4114
+ */
4115
4115
  language?: string | null;
4116
4116
  }
4117
4117
  /** The specified label. */
@@ -4130,14 +4130,17 @@ interface GetLabelByLegacyIdResponse {
4130
4130
  label?: ContactLabel;
4131
4131
  }
4132
4132
  interface UpdateLabelRequest {
4133
- /** Label details to update. */
4133
+ /** Label to rename. */
4134
4134
  label?: ContactLabel;
4135
- /** Language for localization. */
4135
+ /**
4136
+ * Language for localization.
4137
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4138
+ */
4136
4139
  language?: string | null;
4137
4140
  }
4138
4141
  /** Updated label. */
4139
4142
  interface UpdateLabelResponse {
4140
- /** Updated label. */
4143
+ /** Renamed label. */
4141
4144
  label?: ContactLabel;
4142
4145
  }
4143
4146
  interface DeleteLabelRequest {
@@ -4167,7 +4170,10 @@ interface GdprListResponse {
4167
4170
  interface QueryLabelsRequest {
4168
4171
  /** Query options. */
4169
4172
  query?: Query;
4170
- /** Language for localization. */
4173
+ /**
4174
+ * Language for localization.
4175
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4176
+ */
4171
4177
  language?: string | null;
4172
4178
  }
4173
4179
  interface Query {
@@ -4389,18 +4395,14 @@ interface LabelUpdatedEnvelope {
4389
4395
  interface FindOrCreateLabelOptions {
4390
4396
  /**
4391
4397
  * Language for localization.
4392
- *
4393
- * 2-letter language code in
4394
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
4398
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4395
4399
  */
4396
4400
  language?: string | null;
4397
4401
  }
4398
4402
  interface GetLabelOptions {
4399
4403
  /**
4400
4404
  * Language for localization.
4401
- *
4402
- * 2-letter language code in
4403
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
4405
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4404
4406
  */
4405
4407
  language?: string | null;
4406
4408
  }
@@ -4408,25 +4410,21 @@ interface RenameLabel {
4408
4410
  /**
4409
4411
  * Label namespace.
4410
4412
  *
4411
- * Labels created by site admins or 3rd-party apps
4413
+ * Labels created by calling the Find Or Create Label method
4412
4414
  * are automatically assigned to the `custom` namespace.
4413
4415
  * @readonly
4414
4416
  */
4415
4417
  namespace?: string | null;
4416
4418
  /**
4417
4419
  * Display name for the namespace,
4418
- * used to organize the list of labels in the site Dashboard.
4420
+ * used to organize the list of labels in the site dashboard.
4419
4421
  * @readonly
4420
4422
  */
4421
4423
  namespaceDisplayName?: string | null;
4422
- /** Label display name shown in the Dashboard. */
4424
+ /** Label display name shown in the dashboard. */
4423
4425
  displayName?: string;
4424
4426
  /**
4425
- * Label type.
4426
- *
4427
- * - `"SYSTEM"`: The label is a default system label for the Contact List.
4428
- * - `"USER_DEFINED"`: The label was created by a site contributor or 3rd-party app.
4429
- * - `"WIX_APP_DEFINED"`: The label was created by a Wix app.
4427
+ * Label type indicating how the label was created.
4430
4428
  * @readonly
4431
4429
  */
4432
4430
  labelType?: LabelType;
@@ -4444,9 +4442,7 @@ interface RenameLabel {
4444
4442
  interface RenameLabelOptions {
4445
4443
  /**
4446
4444
  * Language for localization.
4447
- *
4448
- * 2-letter language code in
4449
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
4445
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
4450
4446
  */
4451
4447
  language?: string | null;
4452
4448
  }
@@ -4535,15 +4531,18 @@ interface LabelsQueryBuilder {
4535
4531
  declare function findOrCreateLabel$1(httpClient: HttpClient): FindOrCreateLabelSignature;
4536
4532
  interface FindOrCreateLabelSignature {
4537
4533
  /**
4538
- * Retrieves a label with a given name, or creates one if it doesn't exist.
4539
- *
4540
- * The `findOrCreateLabel()` function returns a Promise that resolves when the specified label is found or created.
4534
+ * Retrieves a label with a specified name, or creates one if it doesn't exist.
4541
4535
  *
4542
- * Successful calls to `findOrCreateLabel()` always returns a label, which can be passed to subsequent function calls.
4543
- *
4544
- * To find an existing label without potentially creating a new one, use `getLabel()` or `queryLabels()`.
4536
+ * Successful calls to this method always return a label,
4537
+ * which can be specified in subsequent calls.
4545
4538
  *
4539
+ * For example, in the Contacts API, Label Contact and Unlabel Contact
4540
+ * calls will fail if you include a non-existant label.
4541
+ * To ensure successful calls, you can call this method first,
4542
+ * and then use the response in the Label Contact and Unlabel Contact calls.
4546
4543
  *
4544
+ * To find an existing label without potentially creating a new one, call
4545
+ * Get Label or Query Labels.
4547
4546
  * @param - Display name to retrieve or create.
4548
4547
  *
4549
4548
  * If an existing label is an exact match
@@ -4559,12 +4558,10 @@ declare function getLabel$1(httpClient: HttpClient): GetLabelSignature;
4559
4558
  interface GetLabelSignature {
4560
4559
  /**
4561
4560
  * Retrieves a label by the specified label key.
4562
- *
4563
- * The `getLabel()` function returns a Promise that resolves when the specified label is retrieved.
4564
4561
  * @param - Label key.
4565
4562
  *
4566
4563
  * `key` is generated when the label is created.
4567
- * It cannot be modified, even if `displayName` is updated.
4564
+ * It can't be modified, even if `displayName` is updated.
4568
4565
  * @param - Language options.
4569
4566
  * @returns The specified label.
4570
4567
  */
@@ -4574,27 +4571,20 @@ declare function renameLabel$1(httpClient: HttpClient): RenameLabelSignature;
4574
4571
  interface RenameLabelSignature {
4575
4572
  /**
4576
4573
  * Renames a label.
4577
- *
4578
- * The `renameLabel()` function returns a Promise that resolves when the specified label's display name is changed.
4579
- *
4580
4574
  * @param - Label key.
4581
4575
  *
4582
4576
  * `key` is generated when the label is created.
4583
- * It cannot be modified, even if `displayName` is updated.
4577
+ * It can't be modified, even if `displayName` is updated.
4584
4578
  * @param - Language options.
4585
4579
  * @param - Label to rename.
4586
- * @returns
4580
+ * @returns Renamed label.
4587
4581
  */
4588
4582
  (key: string, label: RenameLabel, options?: RenameLabelOptions | undefined): Promise<ContactLabel & ContactLabelNonNullableFields>;
4589
4583
  }
4590
4584
  declare function deleteLabel$1(httpClient: HttpClient): DeleteLabelSignature;
4591
4585
  interface DeleteLabelSignature {
4592
4586
  /**
4593
- * Deletes a label from the site and removes it from contacts it applies to.
4594
- *
4595
- * The `deleteLabel()` function returns a Promise that resolves when the specified label is deleted.
4596
- *
4597
- *
4587
+ * Deletes the specified label from a site and removes it from the contacts it applies to.
4598
4588
  * @param - Label key to delete.
4599
4589
  */
4600
4590
  (key: string): Promise<void>;
@@ -4604,18 +4594,18 @@ interface QueryLabelsSignature {
4604
4594
  /**
4605
4595
  * Creates a query to retrieve a list of labels.
4606
4596
  *
4607
- * The `queryLabels()` function builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
4597
+ * The `queryLabels()` method builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
4608
4598
  *
4609
- * The returned object contains the query definition, which is used to run the query using the `find()` function.
4599
+ * The returned object contains the query definition, which is used to call the query using the `find()` method.
4610
4600
  *
4611
- * 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.
4601
+ * 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.
4612
4602
  *
4613
- * `queryLabels()` runs with the following `LabelsQueryBuilder` defaults, which you can override:
4603
+ * `queryLabels()` is called with the following `LabelsQueryBuilder` defaults, which you can override:
4614
4604
  * - `skip(0)`
4615
4605
  * - `limit(50)`
4616
4606
  * - `descending('_createdDate')`
4617
4607
  *
4618
- * 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`.
4608
+ * 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`.
4619
4609
  *
4620
4610
  *
4621
4611
  * @param - Language options.
@@ -2582,14 +2582,14 @@ interface ContactLabel$1 {
2582
2582
  /**
2583
2583
  * Label namespace.
2584
2584
  *
2585
- * Labels created by site admins or 3rd-party apps
2585
+ * Labels created by calling the Find Or Create Label method
2586
2586
  * are automatically assigned to the `custom` namespace.
2587
2587
  * @readonly
2588
2588
  */
2589
2589
  namespace?: string | null;
2590
2590
  /**
2591
2591
  * Display name for the namespace,
2592
- * used to organize the list of labels in the site Dashboard.
2592
+ * used to organize the list of labels in the site dashboard.
2593
2593
  * @readonly
2594
2594
  */
2595
2595
  namespaceDisplayName?: string | null;
@@ -2597,11 +2597,11 @@ interface ContactLabel$1 {
2597
2597
  * Label key.
2598
2598
  *
2599
2599
  * `key` is generated when the label is created.
2600
- * It cannot be modified, even if `displayName` is updated.
2600
+ * It can't be modified, even if `displayName` is updated.
2601
2601
  * @readonly
2602
2602
  */
2603
2603
  key?: string;
2604
- /** Label display name shown in the Dashboard. */
2604
+ /** Label display name shown in the dashboard. */
2605
2605
  displayName?: string;
2606
2606
  /**
2607
2607
  * Label type indicating how the label was created.
@@ -2620,11 +2620,11 @@ interface ContactLabel$1 {
2620
2620
  updatedDate?: Date | null;
2621
2621
  }
2622
2622
  declare enum LabelType$1 {
2623
- /** Default system label for the Contact List. */
2623
+ /** Default system label for the contact list. */
2624
2624
  SYSTEM = "SYSTEM",
2625
- /** Label created by a site contributor or 3rd-party app. */
2625
+ /** Label created by calling the Find Or Create Label method. */
2626
2626
  USER_DEFINED = "USER_DEFINED",
2627
- /** Label created by a Wix app. */
2627
+ /** Label created by an app built by Wix. */
2628
2628
  WIX_APP_DEFINED = "WIX_APP_DEFINED"
2629
2629
  }
2630
2630
  interface Sorting$3 {
@@ -2678,7 +2678,10 @@ interface FindOrCreateLabelRequest$1 {
2678
2678
  * If not, a new label is created and returned.
2679
2679
  */
2680
2680
  displayName: string;
2681
- /** Language for localization. */
2681
+ /**
2682
+ * Language for localization.
2683
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
2684
+ */
2682
2685
  language?: string | null;
2683
2686
  }
2684
2687
  /** Label that was found or created. */
@@ -2688,8 +2691,7 @@ interface FindOrCreateLabelResponse$1 {
2688
2691
  /**
2689
2692
  * Indicates whether the label was just created or already existed.
2690
2693
  *
2691
- * If the label was just created, returns `true`.
2692
- * If it already existed, returns `false`.
2694
+ * Returns `true` if the label was just created.
2693
2695
  */
2694
2696
  newLabel?: boolean;
2695
2697
  }
@@ -2698,10 +2700,13 @@ interface GetLabelRequest$1 {
2698
2700
  * Label key.
2699
2701
  *
2700
2702
  * `key` is generated when the label is created.
2701
- * It cannot be modified, even if `displayName` is updated.
2703
+ * It can't be modified, even if `displayName` is updated.
2702
2704
  */
2703
2705
  key: string;
2704
- /** Language for localization. */
2706
+ /**
2707
+ * Language for localization.
2708
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
2709
+ */
2705
2710
  language?: string | null;
2706
2711
  }
2707
2712
  /** The specified label. */
@@ -2710,14 +2715,17 @@ interface GetLabelResponse$1 {
2710
2715
  label?: ContactLabel$1;
2711
2716
  }
2712
2717
  interface UpdateLabelRequest$1 {
2713
- /** Label details to update. */
2718
+ /** Label to rename. */
2714
2719
  label?: ContactLabel$1;
2715
- /** Language for localization. */
2720
+ /**
2721
+ * Language for localization.
2722
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
2723
+ */
2716
2724
  language?: string | null;
2717
2725
  }
2718
2726
  /** Updated label. */
2719
2727
  interface UpdateLabelResponse$1 {
2720
- /** Updated label. */
2728
+ /** Renamed label. */
2721
2729
  label?: ContactLabel$1;
2722
2730
  }
2723
2731
  interface DeleteLabelRequest$1 {
@@ -2729,7 +2737,10 @@ interface DeleteLabelResponse$1 {
2729
2737
  interface QueryLabelsRequest$1 {
2730
2738
  /** Query options. */
2731
2739
  query?: Query$1;
2732
- /** Language for localization. */
2740
+ /**
2741
+ * Language for localization.
2742
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
2743
+ */
2733
2744
  language?: string | null;
2734
2745
  }
2735
2746
  interface Query$1 {
@@ -2787,14 +2798,14 @@ interface ContactLabel {
2787
2798
  /**
2788
2799
  * Label namespace.
2789
2800
  *
2790
- * Labels created by site admins or 3rd-party apps
2801
+ * Labels created by calling the Find Or Create Label method
2791
2802
  * are automatically assigned to the `custom` namespace.
2792
2803
  * @readonly
2793
2804
  */
2794
2805
  namespace?: string | null;
2795
2806
  /**
2796
2807
  * Display name for the namespace,
2797
- * used to organize the list of labels in the site Dashboard.
2808
+ * used to organize the list of labels in the site dashboard.
2798
2809
  * @readonly
2799
2810
  */
2800
2811
  namespaceDisplayName?: string | null;
@@ -2802,18 +2813,14 @@ interface ContactLabel {
2802
2813
  * Label key.
2803
2814
  *
2804
2815
  * `key` is generated when the label is created.
2805
- * It cannot be modified, even if `displayName` is updated.
2816
+ * It can't be modified, even if `displayName` is updated.
2806
2817
  * @readonly
2807
2818
  */
2808
2819
  key?: string;
2809
- /** Label display name shown in the Dashboard. */
2820
+ /** Label display name shown in the dashboard. */
2810
2821
  displayName?: string;
2811
2822
  /**
2812
- * Label type.
2813
- *
2814
- * - `"SYSTEM"`: The label is a default system label for the Contact List.
2815
- * - `"USER_DEFINED"`: The label was created by a site contributor or 3rd-party app.
2816
- * - `"WIX_APP_DEFINED"`: The label was created by a Wix app.
2823
+ * Label type indicating how the label was created.
2817
2824
  * @readonly
2818
2825
  */
2819
2826
  labelType?: LabelType;
@@ -2829,11 +2836,11 @@ interface ContactLabel {
2829
2836
  _updatedDate?: Date | null;
2830
2837
  }
2831
2838
  declare enum LabelType {
2832
- /** Default system label for the Contact List. */
2839
+ /** Default system label for the contact list. */
2833
2840
  SYSTEM = "SYSTEM",
2834
- /** Label created by a site contributor or 3rd-party app. */
2841
+ /** Label created by calling the Find Or Create Label method. */
2835
2842
  USER_DEFINED = "USER_DEFINED",
2836
- /** Label created by a Wix app. */
2843
+ /** Label created by an app built by Wix. */
2837
2844
  WIX_APP_DEFINED = "WIX_APP_DEFINED"
2838
2845
  }
2839
2846
  interface Sorting$2 {
@@ -2887,7 +2894,10 @@ interface FindOrCreateLabelRequest {
2887
2894
  * If not, a new label is created and returned.
2888
2895
  */
2889
2896
  displayName: string;
2890
- /** Language for localization. */
2897
+ /**
2898
+ * Language for localization.
2899
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
2900
+ */
2891
2901
  language?: string | null;
2892
2902
  }
2893
2903
  /** Label that was found or created. */
@@ -2897,8 +2907,7 @@ interface FindOrCreateLabelResponse {
2897
2907
  /**
2898
2908
  * Indicates whether the label was just created or already existed.
2899
2909
  *
2900
- * If the label was just created, returns `true`.
2901
- * If it already existed, returns `false`.
2910
+ * Returns `true` if the label was just created.
2902
2911
  */
2903
2912
  newLabel?: boolean;
2904
2913
  }
@@ -2907,10 +2916,13 @@ interface GetLabelRequest {
2907
2916
  * Label key.
2908
2917
  *
2909
2918
  * `key` is generated when the label is created.
2910
- * It cannot be modified, even if `displayName` is updated.
2919
+ * It can't be modified, even if `displayName` is updated.
2911
2920
  */
2912
2921
  key: string;
2913
- /** Language for localization. */
2922
+ /**
2923
+ * Language for localization.
2924
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
2925
+ */
2914
2926
  language?: string | null;
2915
2927
  }
2916
2928
  /** The specified label. */
@@ -2919,14 +2931,17 @@ interface GetLabelResponse {
2919
2931
  label?: ContactLabel;
2920
2932
  }
2921
2933
  interface UpdateLabelRequest {
2922
- /** Label details to update. */
2934
+ /** Label to rename. */
2923
2935
  label?: ContactLabel;
2924
- /** Language for localization. */
2936
+ /**
2937
+ * Language for localization.
2938
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
2939
+ */
2925
2940
  language?: string | null;
2926
2941
  }
2927
2942
  /** Updated label. */
2928
2943
  interface UpdateLabelResponse {
2929
- /** Updated label. */
2944
+ /** Renamed label. */
2930
2945
  label?: ContactLabel;
2931
2946
  }
2932
2947
  interface DeleteLabelRequest {
@@ -2938,7 +2953,10 @@ interface DeleteLabelResponse {
2938
2953
  interface QueryLabelsRequest {
2939
2954
  /** Query options. */
2940
2955
  query?: Query;
2941
- /** Language for localization. */
2956
+ /**
2957
+ * Language for localization.
2958
+ * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
2959
+ */
2942
2960
  language?: string | null;
2943
2961
  }
2944
2962
  interface Query {