@wix/auto_sdk_crm_contacts-v-5 1.0.5 → 1.0.6

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.
Files changed (37) hide show
  1. package/build/cjs/{contacts-v5-contact-contacts-v-5.universal-Bkb1VwgJ.d.ts → contacts-v5-contact-contacts-v-5.universal-CehUMnuf.d.ts} +228 -210
  2. package/build/cjs/index.d.ts +31 -30
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +3 -3
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +150 -139
  7. package/build/cjs/meta.js.map +1 -1
  8. package/build/cjs/schemas.js +349 -337
  9. package/build/cjs/schemas.js.map +1 -1
  10. package/build/es/{contacts-v5-contact-contacts-v-5.universal-Bkb1VwgJ.d.mts → contacts-v5-contact-contacts-v-5.universal-CehUMnuf.d.mts} +228 -210
  11. package/build/es/index.d.mts +31 -30
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +3 -3
  14. package/build/es/index.typings.mjs.map +1 -1
  15. package/build/es/meta.d.mts +150 -139
  16. package/build/es/meta.mjs.map +1 -1
  17. package/build/es/schemas.mjs +349 -337
  18. package/build/es/schemas.mjs.map +1 -1
  19. package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-Bkb1VwgJ.d.ts → contacts-v5-contact-contacts-v-5.universal-CehUMnuf.d.ts} +228 -210
  20. package/build/internal/cjs/index.d.ts +31 -30
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +3 -3
  23. package/build/internal/cjs/index.typings.js.map +1 -1
  24. package/build/internal/cjs/meta.d.ts +150 -139
  25. package/build/internal/cjs/meta.js.map +1 -1
  26. package/build/internal/cjs/schemas.js +349 -337
  27. package/build/internal/cjs/schemas.js.map +1 -1
  28. package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-Bkb1VwgJ.d.mts → contacts-v5-contact-contacts-v-5.universal-CehUMnuf.d.mts} +228 -210
  29. package/build/internal/es/index.d.mts +31 -30
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +3 -3
  32. package/build/internal/es/index.typings.mjs.map +1 -1
  33. package/build/internal/es/meta.d.mts +150 -139
  34. package/build/internal/es/meta.mjs.map +1 -1
  35. package/build/internal/es/schemas.mjs +349 -337
  36. package/build/internal/es/schemas.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -20,19 +20,19 @@ interface Contact {
20
20
  */
21
21
  revision?: string | null;
22
22
  /**
23
- * Date and time the Contact was created.
23
+ * Date and time the contact was created.
24
24
  * @readonly
25
25
  * @immutable
26
26
  */
27
27
  _createdDate?: Date | null;
28
28
  /**
29
- * Date and time the Contact was last updated.
29
+ * Date and time the contact was last updated.
30
30
  * @readonly
31
31
  */
32
32
  _updatedDate?: Date | null;
33
33
  /**
34
- * Contact External ID. Used to identify contacts from external systems.
35
- * This field can only be set once and cannot be updated after creation.
34
+ * Contact external ID. Used to identify contacts from external systems.
35
+ * This field can only be set once and can't be updated after creation.
36
36
  * @maxLength 100
37
37
  */
38
38
  externalId?: string | null;
@@ -122,7 +122,7 @@ interface Contact {
122
122
  */
123
123
  lastActivity?: ContactActivity;
124
124
  /**
125
- * List of Contact segment IDs that this contact belongs to.
125
+ * IDs of the segments the contact belongs to.
126
126
  * Segments are used for organizing and targeting groups of contacts.
127
127
  * @maxSize 60
128
128
  * @readonly
@@ -232,7 +232,8 @@ interface AdditionalEmail {
232
232
  interface ContactPhone {
233
233
  /**
234
234
  * Phone type classification. Helps categorize the phone number's purpose.
235
- * Default value: OTHER
235
+ *
236
+ * Default: `OTHER`
236
237
  */
237
238
  tag?: PhoneTagWithLiterals;
238
239
  /**
@@ -288,7 +289,8 @@ type PhoneDeliverabilityStatusWithLiterals = PhoneDeliverabilityStatus | 'NO_PHO
288
289
  interface AdditionalPhone {
289
290
  /**
290
291
  * Phone type classification for the additional phone number.
291
- * Default value: OTHER
292
+ *
293
+ * Default: `OTHER`
292
294
  */
293
295
  tag?: PhoneTagWithLiterals;
294
296
  /**
@@ -309,7 +311,8 @@ interface AdditionalPhone {
309
311
  interface ContactAddress {
310
312
  /**
311
313
  * Address type classification. Helps categorize the address purpose.
312
- * Default value: OTHER
314
+ *
315
+ * Default: `OTHER`
313
316
  */
314
317
  tag?: AddressTagWithLiterals;
315
318
  /**
@@ -318,18 +321,17 @@ interface ContactAddress {
318
321
  */
319
322
  address?: Address;
320
323
  /**
321
- * Indicates whether this address is the primary/default address for the contact.
324
+ * Whether this address is the contact's default address.
322
325
  * Only one address can be designated as default per contact.
323
326
  * If no address is explicitly set as default, the first address automatically becomes the default.
324
- * All other addresses will have this field set to false.
325
327
  */
326
328
  defaultAddress?: boolean | null;
327
329
  /**
328
- * Address ID
330
+ * Address ID.
329
331
  * @format GUID
330
332
  */
331
333
  addressId?: string | null;
332
- /** Address recipient information for delivery purposes */
334
+ /** Address recipient information for delivery purposes. */
333
335
  recipient?: Recipient;
334
336
  }
335
337
  declare enum AddressTag {
@@ -1064,16 +1066,16 @@ interface BulkDelete {
1064
1066
  items?: Delete[];
1065
1067
  }
1066
1068
  interface CreateContactRequest {
1067
- /** Contact to be created. */
1069
+ /** Contact to create. */
1068
1070
  contact: Contact;
1069
1071
  /**
1070
- * Allows creating a duplicate contact.
1072
+ * Whether to create the contact even if it duplicates an existing contact.
1071
1073
  * More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
1072
1074
  */
1073
1075
  allowDuplicates?: boolean;
1074
1076
  }
1075
1077
  interface CreateContactResponse {
1076
- /** The created Contact. */
1078
+ /** Created contact. */
1077
1079
  contact?: Contact;
1078
1080
  /**
1079
1081
  * The upload ID of the image upload process.
@@ -1083,11 +1085,11 @@ interface CreateContactResponse {
1083
1085
  }
1084
1086
  interface DuplicateContactExists {
1085
1087
  /**
1086
- * The ID of an existing contact that matches a duplicate in the request.
1088
+ * ID of an existing contact that matches a duplicate in the request.
1087
1089
  * @format GUID
1088
1090
  */
1089
1091
  matchingContactId?: string | null;
1090
- /** The field(s) of an existing contact that match a duplicate in the request. */
1092
+ /** Field or fields of an existing contact that match a duplicate in the request. */
1091
1093
  matchType?: MatchTypeWithLiterals;
1092
1094
  }
1093
1095
  declare enum MatchType {
@@ -1100,26 +1102,26 @@ declare enum MatchType {
1100
1102
  type MatchTypeWithLiterals = MatchType | 'EMAIL' | 'PHONE' | 'EXTERNAL_ID' | 'EMAIL_AND_PHONE';
1101
1103
  interface GetContactRequest {
1102
1104
  /**
1103
- * ID of the Contact to retrieve.
1105
+ * ID of the contact to retrieve.
1104
1106
  * @format GUID
1105
1107
  */
1106
1108
  contactId: string;
1107
1109
  }
1108
1110
  interface GetContactResponse {
1109
- /** The requested Contact. */
1111
+ /** Retrieved contact. */
1110
1112
  contact?: Contact;
1111
1113
  }
1112
1114
  interface UpdateContactRequest {
1113
- /** Contact to be updated, may be partial. */
1115
+ /** Contact to update. May be partial. */
1114
1116
  contact: Contact;
1115
1117
  /**
1116
- * Allows updating the contact even if it becomes a duplicate of another contact.
1118
+ * Whether to update the contact even if it becomes a duplicate of another contact.
1117
1119
  * More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
1118
1120
  */
1119
1121
  allowDuplicates?: boolean;
1120
1122
  }
1121
1123
  interface UpdateContactResponse {
1122
- /** Updated Contact. */
1124
+ /** Updated contact. */
1123
1125
  contact?: Contact;
1124
1126
  /**
1125
1127
  * The upload ID of the image upload process.
@@ -1128,19 +1130,19 @@ interface UpdateContactResponse {
1128
1130
  imageUploadId?: string | null;
1129
1131
  }
1130
1132
  interface UpsertContactRequest {
1131
- /** Contact to be upserted. */
1133
+ /** Contact to upsert. */
1132
1134
  contact: Contact;
1133
- /** The mode in which the upsert should work in. */
1135
+ /** Mode that determines how an existing contact is updated when a match is found. See the endpoint description for the supported modes. */
1134
1136
  upsertMode?: UpsertModeWithLiterals;
1135
- /** Indicates whether to update the contact even if it is a site member. */
1137
+ /** Whether to update the contact even if it's a site member. */
1136
1138
  updateMember?: boolean | null;
1137
1139
  }
1138
1140
  declare enum UpsertMode {
1139
- /** Fields will be overwritten (default). */
1141
+ /** Replaces existing field values. Default value. */
1140
1142
  OVERWRITE = "OVERWRITE",
1141
- /** Fields will be appended. Non-array fields will be set only if it does not have an existing value. */
1143
+ /** Sets a non-array field only if it doesn't already have a value, and appends to array fields. */
1142
1144
  APPEND = "APPEND",
1143
- /** Array fields, will be appended. Non-array fields will be overwritten. */
1145
+ /** Overwrites non-array fields and appends to array fields. */
1144
1146
  OVERWRITE_APPEND_ARRAYS = "OVERWRITE_APPEND_ARRAYS"
1145
1147
  }
1146
1148
  /** @enumType */
@@ -1171,17 +1173,17 @@ interface FailedMemberUpdate {
1171
1173
  }
1172
1174
  interface UpdateContactTagsRequest {
1173
1175
  /**
1174
- * The contact from which to add or remove tags.
1176
+ * ID of the contact whose tags to update.
1175
1177
  * @format GUID
1176
1178
  */
1177
1179
  contactId: string;
1178
- /** The tags to add. */
1180
+ /** Tags to assign. */
1179
1181
  assignTags?: PrivateTags;
1180
- /** The tags to remove. */
1182
+ /** Tags to unassign. */
1181
1183
  unassignTags?: PrivateTags;
1182
1184
  }
1183
1185
  interface UpdateContactTagsResponse {
1184
- /** Updated Contact. */
1186
+ /** Updated contact. */
1185
1187
  contact?: Contact;
1186
1188
  }
1187
1189
  interface MergeContactsRequest {
@@ -1190,9 +1192,12 @@ interface MergeContactsRequest {
1190
1192
  * @format GUID
1191
1193
  */
1192
1194
  targetContactId: string;
1193
- /** Target contact revision number, which increments by 1 each time the contact is updated to prevent conflicting changes. */
1195
+ /**
1196
+ * Revision number of the target contact, which increments by 1 each time the contact is updated.
1197
+ * The current revision must be passed to prevent conflicting changes.
1198
+ */
1194
1199
  targetContactRevision: string | null;
1195
- /** When the target contact is provided, the merged result will be overwritten. */
1200
+ /** Contact to overwrite the target with, instead of merging in the source contacts' data. See the endpoint description for details. */
1196
1201
  targetContact?: Contact;
1197
1202
  /**
1198
1203
  * IDs of up to 5 contacts to merge into the target contact.
@@ -1203,11 +1208,14 @@ interface MergeContactsRequest {
1203
1208
  * @format GUID
1204
1209
  */
1205
1210
  sourceContactIds?: string[];
1206
- /** Indicates whether to only return a preview of the merged contact or perform the actual merge. */
1211
+ /**
1212
+ * Whether to return a preview of the merged contact instead of performing the actual merge.
1213
+ *
1214
+ * Default: `false`
1215
+ */
1207
1216
  preview?: boolean | null;
1208
1217
  /**
1209
- * Allows updating the target contact even if it becomes a duplicate of another contact.
1210
- * This can happen only where the target contact is provided.
1218
+ * Whether to update the target contact even if it becomes a duplicate of another contact. Relevant only when `targetContact` is provided.
1211
1219
  * More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
1212
1220
  */
1213
1221
  allowDuplicates?: boolean;
@@ -1218,13 +1226,14 @@ interface MergeContactsResponse {
1218
1226
  }
1219
1227
  interface DeleteContactRequest {
1220
1228
  /**
1221
- * Id of the Contact to delete.
1229
+ * ID of the contact to delete.
1222
1230
  * @format GUID
1223
1231
  */
1224
1232
  contactId: string;
1225
1233
  /**
1226
- * Indicates whether to delete the contact that is a site member. If set to `true`, the contact is deleted even
1227
- * if it is a site member and the site member is also deleted. Default: `false`
1234
+ * Whether to delete the contact even if it's a site member. If `true`, the site member is also deleted.
1235
+ *
1236
+ * Default: `false`
1228
1237
  */
1229
1238
  deleteMember?: boolean | null;
1230
1239
  }
@@ -1232,7 +1241,7 @@ interface DeleteContactResponse {
1232
1241
  }
1233
1242
  interface FindMatchingContactsRequest {
1234
1243
  /**
1235
- * Contact External ID.
1244
+ * Contact external ID.
1236
1245
  * @maxLength 100
1237
1246
  */
1238
1247
  externalId?: string | null;
@@ -1250,7 +1259,7 @@ interface FindMatchingContactsRequest {
1250
1259
  phone?: string | null;
1251
1260
  }
1252
1261
  interface FindMatchingContactsResponse {
1253
- /** List of Contacts. At most 100 contacts are returned. */
1262
+ /** Matching contacts, ordered by match strength. At most 100 contacts are returned. */
1254
1263
  contacts?: Contact[];
1255
1264
  }
1256
1265
  interface QueryContactsRequest {
@@ -1318,9 +1327,9 @@ interface CursorPaging {
1318
1327
  cursor?: string | null;
1319
1328
  }
1320
1329
  interface QueryContactsResponse {
1321
- /** List of Contacts. */
1330
+ /** Retrieved contacts. */
1322
1331
  contacts?: Contact[];
1323
- /** Paging metadata */
1332
+ /** Paging metadata. */
1324
1333
  pagingMetadata?: CursorPagingMetadata;
1325
1334
  }
1326
1335
  interface CursorPagingMetadata {
@@ -1355,7 +1364,7 @@ interface Cursors {
1355
1364
  prev?: string | null;
1356
1365
  }
1357
1366
  interface SearchContactsRequest {
1358
- /** WQL search expression */
1367
+ /** WQL search expression. */
1359
1368
  search?: CursorSearch;
1360
1369
  /**
1361
1370
  * Name Format for sorting and searching.
@@ -1628,11 +1637,11 @@ declare enum NameFormat {
1628
1637
  /** @enumType */
1629
1638
  type NameFormatWithLiterals = NameFormat | 'BY_FIRST_NAME' | 'BY_LAST_NAME';
1630
1639
  interface SearchContactsResponse {
1631
- /** List of Contacts. */
1640
+ /** Retrieved contacts. */
1632
1641
  contacts?: Contact[];
1633
- /** Paging metadata */
1642
+ /** Paging metadata. */
1634
1643
  pagingMetadata?: CursorPagingMetadata;
1635
- /** Aggregation data */
1644
+ /** Aggregation data. */
1636
1645
  aggregationData?: AggregationData;
1637
1646
  }
1638
1647
  interface AggregationData {
@@ -1821,7 +1830,7 @@ interface CountContactsResponse {
1821
1830
  }
1822
1831
  interface GenerateContactImageUploadUrlRequest {
1823
1832
  /**
1824
- * ID of the contact whose picture is being updated.
1833
+ * ID of the contact to generate an image upload URL for.
1825
1834
  * @format GUID
1826
1835
  */
1827
1836
  contactId: string;
@@ -1840,59 +1849,59 @@ interface GenerateContactImageUploadUrlResponse {
1840
1849
  */
1841
1850
  uploadUrl?: string;
1842
1851
  /**
1843
- * The upload id.
1852
+ * Upload ID. Pass this ID to [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to check the status of the upload.
1844
1853
  * @format GUID
1845
1854
  */
1846
1855
  imageUploadId?: string;
1847
1856
  }
1848
1857
  interface AddContactAdditionalEmailRequest {
1849
1858
  /**
1850
- * ID of the Contact to add an email.
1859
+ * ID of the contact to add an email to.
1851
1860
  * @format GUID
1852
1861
  */
1853
1862
  contactId: string;
1854
- /** The email to add. */
1863
+ /** Email to add. */
1855
1864
  email: AdditionalEmail;
1856
- /** Contact revision number for optimistic concurrency control. */
1865
+ /** Contact revision number. */
1857
1866
  revision: string | null;
1858
1867
  }
1859
1868
  interface AddContactAdditionalEmailResponse {
1860
- /** Updated Contact. */
1869
+ /** Updated contact. */
1861
1870
  contact?: Contact;
1862
1871
  }
1863
1872
  interface AddContactAdditionalPhoneRequest {
1864
1873
  /**
1865
- * ID of the Contact to add a phone.
1874
+ * ID of the contact to add a phone to.
1866
1875
  * @format GUID
1867
1876
  */
1868
1877
  contactId: string;
1869
- /** The phone to add. */
1878
+ /** Phone to add. */
1870
1879
  phone: AdditionalPhone;
1871
- /** Contact revision number for optimistic concurrency control. */
1880
+ /** Contact revision number. */
1872
1881
  revision: string | null;
1873
1882
  }
1874
1883
  interface AddContactAdditionalPhoneResponse {
1875
- /** Updated Contact. */
1884
+ /** Updated contact. */
1876
1885
  contact?: Contact;
1877
1886
  }
1878
1887
  interface AddContactAddressRequest {
1879
1888
  /**
1880
- * ID of the Contact to add an address.
1889
+ * ID of the contact to add an address to.
1881
1890
  * @format GUID
1882
1891
  */
1883
1892
  contactId: string;
1884
- /** The address to add. */
1893
+ /** Address to add. */
1885
1894
  address: ContactAddress;
1886
- /** Contact revision number for optimistic concurrency control. */
1895
+ /** Contact revision number. */
1887
1896
  revision: string | null;
1888
1897
  }
1889
1898
  interface AddContactAddressResponse {
1890
- /** Updated Contact. */
1899
+ /** Updated contact. */
1891
1900
  contact?: Contact;
1892
1901
  }
1893
1902
  interface DeleteContactAddressRequest {
1894
1903
  /**
1895
- * ID of the Contact from which to delete an address.
1904
+ * ID of the contact to delete the address from.
1896
1905
  * @format GUID
1897
1906
  */
1898
1907
  contactId: string;
@@ -1901,48 +1910,48 @@ interface DeleteContactAddressRequest {
1901
1910
  * @format GUID
1902
1911
  */
1903
1912
  addressId: string;
1904
- /** Contact revision number for optimistic concurrency control. */
1913
+ /** Contact revision number. */
1905
1914
  revision: string | null;
1906
1915
  }
1907
1916
  interface DeleteContactAddressResponse {
1908
- /** Updated Contact after address deletion. */
1917
+ /** Updated contact. */
1909
1918
  contact?: Contact;
1910
1919
  }
1911
1920
  interface UpdateContactAddressRequest {
1912
1921
  /**
1913
- * ID of the Contact to update address on.
1922
+ * ID of the contact to update the address on.
1914
1923
  * @format GUID
1915
1924
  */
1916
1925
  contactId: string;
1917
- /** The updated address (must include address.id). */
1926
+ /** Address to update. Must include `address.id`. */
1918
1927
  address: ContactAddress;
1919
- /** Contact revision number for optimistic concurrency control. */
1928
+ /** Contact revision number. */
1920
1929
  revision: string | null;
1921
1930
  }
1922
1931
  interface UpdateContactAddressResponse {
1923
- /** Updated Contact after address update. */
1932
+ /** Updated contact. */
1924
1933
  contact?: Contact;
1925
1934
  }
1926
1935
  interface BulkCreateContactsRequest {
1927
1936
  /**
1928
- * List of Contacts to be created
1937
+ * Contacts to create.
1929
1938
  * @minSize 1
1930
1939
  * @maxSize 100
1931
1940
  */
1932
1941
  contacts: Contact[];
1933
1942
  /** Whether to include the created contacts in the response. */
1934
1943
  returnEntity?: boolean;
1935
- /** Allows creating the contact even if a duplicate already exists. */
1944
+ /** Whether to create the contact even if it duplicates an existing contact. */
1936
1945
  allowDuplicates?: boolean;
1937
1946
  }
1938
1947
  interface BulkCreateContactsResponse {
1939
1948
  /**
1940
- * List of the bulk create operation results including the Contacts and metadata.
1949
+ * Results of the bulk create operation, including the created contacts and metadata.
1941
1950
  * @minSize 1
1942
1951
  * @maxSize 100
1943
1952
  */
1944
1953
  results?: BulkContactResult[];
1945
- /** Metadata regarding the bulk create operation */
1954
+ /** Metadata regarding the bulk create operation. */
1946
1955
  bulkActionMetadata?: BulkActionMetadata;
1947
1956
  }
1948
1957
  interface ItemMetadata {
@@ -1967,9 +1976,9 @@ interface ApplicationError {
1967
1976
  data?: Record<string, any> | null;
1968
1977
  }
1969
1978
  interface BulkContactResult {
1970
- /** Metadata regarding the specific single create operation */
1979
+ /** Metadata regarding the creation of this specific contact. */
1971
1980
  itemMetadata?: ItemMetadata;
1972
- /** Only exists if `returnEntity` was set to true in the request */
1981
+ /** Returned only when `returnEntity` is `true` in the request. */
1973
1982
  item?: Contact;
1974
1983
  }
1975
1984
  interface BulkActionMetadata {
@@ -1982,39 +1991,39 @@ interface BulkActionMetadata {
1982
1991
  }
1983
1992
  interface BulkUpdateContactsRequest {
1984
1993
  /**
1985
- * List of Contacts to be updated.
1994
+ * Contacts to update.
1986
1995
  * @minSize 1
1987
1996
  * @maxSize 100
1988
1997
  */
1989
1998
  contacts: MaskedContact[];
1990
1999
  /** Whether to include the updated contacts in the response. */
1991
2000
  returnEntity?: boolean;
1992
- /** Allows updating the contact even if it becomes a duplicate of another contact. */
2001
+ /** Whether to update the contact even if it becomes a duplicate of another contact. */
1993
2002
  allowDuplicates?: boolean;
1994
2003
  }
1995
2004
  interface MaskedContact {
1996
- /** Contact to be updated, may be partial */
2005
+ /** Contact to update. May be partial. */
1997
2006
  contact?: Contact;
1998
2007
  }
1999
2008
  interface BulkUpdateContactsResponse {
2000
2009
  /**
2001
- * Results
2010
+ * Results of the update for each contact.
2002
2011
  * @minSize 1
2003
2012
  * @maxSize 100
2004
2013
  */
2005
2014
  results?: BulkUpdateContactsResponseBulkContactResult[];
2006
- /** Metadata regarding the bulk update operation */
2015
+ /** Metadata regarding the bulk update operation. */
2007
2016
  bulkActionMetadata?: BulkActionMetadata;
2008
2017
  }
2009
2018
  interface BulkUpdateContactsResponseBulkContactResult {
2010
- /** Metadata regarding the specific single update operation */
2019
+ /** Metadata regarding the update of this specific contact. */
2011
2020
  itemMetadata?: ItemMetadata;
2012
- /** Only exists if `returnEntity` was set to true in the request */
2021
+ /** Returned only when `returnEntity` is `true` in the request. */
2013
2022
  item?: Contact;
2014
2023
  }
2015
2024
  interface BulkUpdateContactTagsRequest {
2016
2025
  /**
2017
- * The contacts from which to add or remove tags.
2026
+ * IDs of the contacts to add or remove tags on.
2018
2027
  * @minSize 1
2019
2028
  * @maxSize 100
2020
2029
  * @format GUID
@@ -2022,14 +2031,14 @@ interface BulkUpdateContactTagsRequest {
2022
2031
  contactIds: string[];
2023
2032
  /** Whether to include the updated contacts in the response. */
2024
2033
  returnEntity?: boolean;
2025
- /** The tags to add. */
2034
+ /** Tags to assign. */
2026
2035
  assignTags?: PrivateTags;
2027
- /** The tags to remove. */
2036
+ /** Tags to unassign. */
2028
2037
  unassignTags?: PrivateTags;
2029
2038
  }
2030
2039
  interface BulkUpdateContactTagsResponse {
2031
2040
  /**
2032
- * The results of the update for all contacts in the request.
2041
+ * Results of the tag update for each contact.
2033
2042
  * @minSize 1
2034
2043
  * @maxSize 100
2035
2044
  */
@@ -2038,19 +2047,19 @@ interface BulkUpdateContactTagsResponse {
2038
2047
  bulkActionMetadata?: BulkActionMetadata;
2039
2048
  }
2040
2049
  interface BulkUpdateContactTagsResult {
2041
- /** Metadata regarding the specific single update operation */
2050
+ /** Metadata regarding the tag update for this specific contact. */
2042
2051
  itemMetadata?: ItemMetadata;
2043
- /** Only exists if `returnEntity` was set to true in the request */
2052
+ /** Returned only when `returnEntity` is `true` in the request. */
2044
2053
  item?: Contact;
2045
2054
  }
2046
2055
  interface BulkUpdateContactTagsByFilterRequest {
2047
- /** A filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters) */
2056
+ /** Filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters). */
2048
2057
  filter: Record<string, any> | null;
2049
2058
  /** Free text to match in searchable fields. */
2050
2059
  search?: SearchDetails;
2051
- /** Tag ids to add to the contact. */
2060
+ /** Tags to assign to the matching contacts. */
2052
2061
  assignTags?: PrivateTags;
2053
- /** Tag ids to remove from the contact. */
2062
+ /** Tags to unassign from the matching contacts. */
2054
2063
  unassignTags?: PrivateTags;
2055
2064
  }
2056
2065
  interface BulkUpdateContactTagsByFilterResponse {
@@ -2062,30 +2071,30 @@ interface BulkUpdateContactTagsByFilterResponse {
2062
2071
  }
2063
2072
  interface BulkUpsertContactsRequest {
2064
2073
  /**
2065
- * List of Contacts to be updated.
2074
+ * Contacts to create or update.
2066
2075
  * @minSize 1
2067
2076
  * @maxSize 100
2068
2077
  */
2069
2078
  contacts: BulkUpsertContactsRequestMaskedContact[];
2070
2079
  /** Whether to include the upserted contacts in the response. */
2071
2080
  returnEntity?: boolean;
2072
- /** The mode in which the upsert should work in. */
2081
+ /** Mode that determines how an existing contact is updated when a match is found. See the endpoint description for the supported modes. */
2073
2082
  upsertMode?: UpsertModeWithLiterals;
2074
- /** Indicates whether to update a contact even if it is a site member. */
2083
+ /** Whether to update a contact even if it's a site member. */
2075
2084
  updateMember?: boolean | null;
2076
2085
  }
2077
2086
  interface BulkUpsertContactsRequestMaskedContact {
2078
- /** Contact to be updated, may be partial */
2087
+ /** Contact to create or update. May be partial. */
2079
2088
  contact?: Contact;
2080
2089
  }
2081
2090
  interface BulkUpsertContactsResponse {
2082
2091
  /**
2083
- * Results
2092
+ * Results of the upsert for each contact.
2084
2093
  * @minSize 1
2085
2094
  * @maxSize 100
2086
2095
  */
2087
2096
  results?: BulkUpsertContactsResponseBulkContactResult[];
2088
- /** Metadata regarding the bulk update operation */
2097
+ /** Metadata regarding the bulk upsert operation. */
2089
2098
  bulkActionMetadata?: BulkActionMetadata;
2090
2099
  }
2091
2100
  declare enum Action {
@@ -2096,39 +2105,40 @@ declare enum Action {
2096
2105
  /** @enumType */
2097
2106
  type ActionWithLiterals = Action | 'UNKNOWN_ACTION' | 'UPDATED' | 'CREATED';
2098
2107
  interface BulkUpsertContactsResponseBulkContactResult {
2099
- /** Metadata regarding the specific single update operation */
2108
+ /** Metadata regarding the upsert of this specific contact. */
2100
2109
  itemMetadata?: ItemMetadata;
2101
- /** Only exists if `returnEntity` was set to true in the request */
2110
+ /** Returned only when `returnEntity` is `true` in the request. */
2102
2111
  item?: Contact;
2103
2112
  /** The action performed on the contact. */
2104
2113
  action?: ActionWithLiterals;
2105
2114
  }
2106
2115
  interface BulkDeleteContactsRequest {
2107
2116
  /**
2108
- * Contact ids to be deleted
2117
+ * IDs of the contacts to delete.
2109
2118
  * @minSize 1
2110
2119
  * @maxSize 100
2111
2120
  * @format GUID
2112
2121
  */
2113
2122
  contactIds: string[];
2114
2123
  /**
2115
- * Indicates whether to delete the contact that is a site member. If set to `true`, the contact is deleted even
2116
- * if it is a site member and the site member is also deleted. Default: `false`
2124
+ * Whether to delete the associated site member for any contact that's a site member. If `true`, the site member is also deleted.
2125
+ *
2126
+ * Default: `false`
2117
2127
  */
2118
2128
  deleteMembers?: boolean | null;
2119
2129
  }
2120
2130
  interface BulkDeleteContactsResponse {
2121
2131
  /**
2122
- * Results
2132
+ * Results of the delete operation for each contact.
2123
2133
  * @minSize 1
2124
2134
  * @maxSize 100
2125
2135
  */
2126
2136
  results?: BulkDeleteContactsResponseBulkContactResult[];
2127
- /** Metadata regarding the bulk delete operation */
2137
+ /** Metadata regarding the bulk delete operation. */
2128
2138
  bulkActionMetadata?: BulkActionMetadata;
2129
2139
  }
2130
2140
  interface BulkDeleteContactsResponseBulkContactResult {
2131
- /** Metadata regarding the specific single delete operation */
2141
+ /** Metadata regarding the deletion of this specific contact. */
2132
2142
  itemMetadata?: ItemMetadata;
2133
2143
  }
2134
2144
  interface BulkDeleteContactsByFilterRequest {
@@ -2139,11 +2149,12 @@ interface BulkDeleteContactsByFilterRequest {
2139
2149
  * `{ "filter": { "name.last": "Smith" } }`
2140
2150
  */
2141
2151
  filter: Record<string, any> | null;
2142
- /** Free text to match in searchable fields */
2152
+ /** Free text to match in searchable fields. */
2143
2153
  search?: SearchDetails;
2144
2154
  /**
2145
- * Indicates whether to delete the contact that is a site member. If set to `true`, the contact is deleted even
2146
- * if it is a site member and the site member is also deleted. Default: `false`
2155
+ * Whether to delete the associated site member for any contact that's a site member. If `true`, the site member is also deleted.
2156
+ *
2157
+ * Default: `false`
2147
2158
  */
2148
2159
  deleteMembers?: boolean | null;
2149
2160
  }
@@ -2156,7 +2167,7 @@ interface BulkDeleteContactsByFilterResponse {
2156
2167
  }
2157
2168
  interface RemoveContactFromTrashBinRequest {
2158
2169
  /**
2159
- * Id of the Contact to remove from trashbin.
2170
+ * ID of the contact to permanently delete from the trash bin.
2160
2171
  * @format GUID
2161
2172
  */
2162
2173
  contactId: string;
@@ -2165,18 +2176,18 @@ interface RemoveContactFromTrashBinResponse {
2165
2176
  }
2166
2177
  interface RestoreContactFromTrashBinRequest {
2167
2178
  /**
2168
- * Id of the Contact to restore from trashbin.
2179
+ * ID of the contact to restore from the trash bin.
2169
2180
  * @format GUID
2170
2181
  */
2171
2182
  contactId: string;
2172
2183
  }
2173
2184
  interface RestoreContactFromTrashBinResponse {
2174
- /** The restored Contact. */
2185
+ /** Restored contact. */
2175
2186
  contact?: Contact;
2176
2187
  }
2177
2188
  interface BulkRestoreContactsFromTrashBinRequest {
2178
2189
  /**
2179
- * List of Contacts to be restored
2190
+ * IDs of the contacts to restore from the trash bin.
2180
2191
  * @minSize 1
2181
2192
  * @maxSize 100
2182
2193
  * @format GUID
@@ -2187,34 +2198,34 @@ interface BulkRestoreContactsFromTrashBinRequest {
2187
2198
  }
2188
2199
  interface BulkRestoreContactsFromTrashBinResponse {
2189
2200
  /**
2190
- * Results
2201
+ * Results of the restore operation for each contact.
2191
2202
  * @minSize 1
2192
2203
  * @maxSize 100
2193
2204
  */
2194
2205
  results?: BulkRestoreContactsFromTrashBinResponseBulkContactResult[];
2195
- /** Metadata regarding the bulk delete operation */
2206
+ /** Metadata regarding the bulk restore operation. */
2196
2207
  bulkActionMetadata?: BulkActionMetadata;
2197
2208
  }
2198
2209
  interface BulkRestoreContactsFromTrashBinResponseBulkContactResult {
2199
- /** Metadata regarding the specific single restore operation */
2210
+ /** Metadata regarding the restoration of this specific contact. */
2200
2211
  itemMetadata?: ItemMetadata;
2201
- /** Only exists if returnEntity was set to true in the request */
2212
+ /** Returned only when `returnEntity` is `true` in the request. */
2202
2213
  item?: Contact;
2203
2214
  }
2204
2215
  interface GetDeletedContactRequest {
2205
2216
  /**
2206
- * Id of the Contact to retrieve from trashbin.
2217
+ * ID of the contact to retrieve from the trash bin.
2207
2218
  * @format GUID
2208
2219
  */
2209
2220
  contactId: string;
2210
2221
  }
2211
2222
  interface GetDeletedContactResponse {
2212
- /** The requested Contact. */
2223
+ /** Retrieved contact. */
2213
2224
  contact?: Contact;
2214
2225
  }
2215
2226
  interface ListDeletedContactsRequest {
2216
2227
  /**
2217
- * External ID
2228
+ * External ID.
2218
2229
  * @maxLength 100
2219
2230
  */
2220
2231
  externalId?: string | null;
@@ -2236,53 +2247,53 @@ interface ListDeletedContactsRequest {
2236
2247
  * @format GUID
2237
2248
  */
2238
2249
  contactIds?: string[];
2239
- /** From date and time that contact was deleted. */
2250
+ /** Filters to contacts deleted on or after this date and time. */
2240
2251
  deletedFromDate?: Date | null;
2241
- /** Until date and time that contact was deleted. */
2252
+ /** Filters to contacts deleted on or before this date and time. */
2242
2253
  deletedToDate?: Date | null;
2243
2254
  /** Cursor paging. */
2244
2255
  paging?: CursorPaging;
2245
2256
  }
2246
2257
  interface ListDeletedContactsResponse {
2247
- /** List of Contacts. */
2258
+ /** Retrieved contacts. */
2248
2259
  contacts?: Contact[];
2249
- /** Paging metadata */
2260
+ /** Paging metadata. */
2250
2261
  pagingMetadata?: CursorPagingMetadata;
2251
2262
  }
2252
2263
  interface BulkAddSegmentToContactsRequest {
2253
2264
  /**
2254
- * Segment id
2265
+ * Segment ID.
2255
2266
  * @format GUID
2256
2267
  */
2257
2268
  segmentId?: string;
2258
2269
  /**
2259
- * List of Contact ids
2270
+ * IDs of the contacts to add the segment to.
2260
2271
  * @format GUID
2261
2272
  * @minSize 1
2262
2273
  * @maxSize 100
2263
2274
  */
2264
2275
  contactIds?: string[];
2265
2276
  /**
2266
- * List of existing segment ids. It is used to remove segments that no longer exist that are still on the contact.
2277
+ * IDs of segments on the contact that no longer exist, used to remove them from the contact.
2267
2278
  * @format GUID
2268
2279
  * @maxSize 100
2269
2280
  */
2270
2281
  existingSegmentIds?: string[];
2271
2282
  }
2272
2283
  interface BulkAddSegmentToContactsResponse {
2273
- /** List of action results */
2284
+ /** Results of the action for each contact. */
2274
2285
  results?: ItemMetadata[];
2275
- /** Metadata on the bulk action */
2286
+ /** Metadata regarding the bulk action. */
2276
2287
  bulkActionMetadata?: BulkActionMetadata;
2277
2288
  }
2278
2289
  interface BulkRemoveSegmentFromContactsRequest {
2279
2290
  /**
2280
- * Segment id
2291
+ * Segment ID.
2281
2292
  * @format GUID
2282
2293
  */
2283
2294
  segmentId?: string;
2284
2295
  /**
2285
- * List of Contact ids
2296
+ * IDs of the contacts to remove the segment from.
2286
2297
  * @format GUID
2287
2298
  * @minSize 1
2288
2299
  * @maxSize 100
@@ -2290,9 +2301,9 @@ interface BulkRemoveSegmentFromContactsRequest {
2290
2301
  contactIds?: string[];
2291
2302
  }
2292
2303
  interface BulkRemoveSegmentFromContactsResponse {
2293
- /** List of action results */
2304
+ /** Results of the action for each contact. */
2294
2305
  results?: ItemMetadata[];
2295
- /** Metadata on the bulk action */
2306
+ /** Metadata regarding the bulk action. */
2296
2307
  bulkActionMetadata?: BulkActionMetadata;
2297
2308
  }
2298
2309
  interface QueryContactsByOffsetInternalRequest {
@@ -2381,9 +2392,9 @@ declare enum QueryContactsByOffsetInternalRequestNameFormat {
2381
2392
  /** @enumType */
2382
2393
  type QueryContactsByOffsetInternalRequestNameFormatWithLiterals = QueryContactsByOffsetInternalRequestNameFormat | 'BY_FIRST_NAME' | 'BY_LAST_NAME';
2383
2394
  interface QueryContactsByOffsetInternalResponse {
2384
- /** List of Contacts. */
2395
+ /** Retrieved contacts. */
2385
2396
  contacts?: Contact[];
2386
- /** Paging metadata */
2397
+ /** Paging metadata. */
2387
2398
  pagingMetadata?: PagingMetadataV2;
2388
2399
  }
2389
2400
  interface PagingMetadataV2 {
@@ -2400,13 +2411,12 @@ interface PagingMetadataV2 {
2400
2411
  }
2401
2412
  interface GetContactImageUploadStatusRequest {
2402
2413
  /**
2403
- * Id of the contact for which to retrieve the image upload status.
2414
+ * ID of the contact whose image upload status to retrieve.
2404
2415
  * @format GUID
2405
2416
  */
2406
2417
  contactId: string;
2407
2418
  /**
2408
- * The upload ID of the image upload process. Returned in case an image URL was provided when creating or
2409
- * updating a contact. It is also returned from the GenerateContactImageUploadUrl endpoint.
2419
+ * The upload ID of the image upload process. Returned when an image URL is provided while creating or updating a contact, or from [Generate Contact Image Upload Url](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/generate-contact-image-upload-url).
2410
2420
  * @maxLength 100
2411
2421
  */
2412
2422
  imageUploadId: string;
@@ -2437,7 +2447,8 @@ interface BulkUpdatePhoneCountryCodeByFilterRequest {
2437
2447
  search?: SearchDetails;
2438
2448
  /**
2439
2449
  * [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code to apply.
2440
- * The country code will be added to the contacts main phone number, when adding it the phone, makes it a valid phone number.
2450
+ *
2451
+ * Applied only to contacts whose phone number isn't already in [ITU E.164 international](https://www.itu.int/rec/T-REC-E.164/) format. If the phone number still can't be converted to E.164 format after applying the country code, that contact fails with `PHONE_CANNOT_BE_FIXED_WITH_COUNTRY_CODE`.
2441
2452
  * @format COUNTRY
2442
2453
  */
2443
2454
  countryCode: string;
@@ -2852,13 +2863,13 @@ interface BulkUpdateContactSubscriptionsOptions {
2852
2863
  * Image upload: When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
2853
2864
  *
2854
2865
  * To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v5/bulk-create-contacts).
2855
- * @param contact - Contact to be created.
2866
+ * @param contact - Contact to create.
2856
2867
  * @public
2857
2868
  * @documentationMaturity preview
2858
2869
  * @requiredField contact
2859
2870
  * @permissionId CONTACTS.CONTACT_CREATE
2860
2871
  * @applicableIdentity APP
2861
- * @returns The created Contact.
2872
+ * @returns Created contact.
2862
2873
  * @fqn wix.contacts.v5.Contacts.CreateContact
2863
2874
  */
2864
2875
  declare function createContact(contact: Contact, options?: CreateContactOptions): Promise<NonNullablePaths<Contact, `email.email` | `email.subscriptionStatus.status` | `email.deliverabilityStatus` | `additionalEmails` | `additionalEmails.${number}.email` | `phone.tag` | `phone.phone` | `phone.deliverabilityStatus` | `additionalPhones` | `additionalPhones.${number}.tag` | `additionalPhones.${number}.phone` | `addresses` | `addresses.${number}.tag` | `addresses.${number}.address.streetAddress.number` | `addresses.${number}.address.streetAddress.name` | `addresses.${number}.address.streetAddress.apt` | `locationIds` | `segmentIds` | `memberInfo.status` | `memberInfo.profileInfo.privacyStatus` | `memberInfo.userInfo.userId` | `memberInfo.userInfo.role` | `memberInfo.sessionInfo.mobileAppNames` | `memberInfo.groupInfo.groupIds` | `tags.privateTags.tagIds`, 6> & {
@@ -2866,20 +2877,20 @@ declare function createContact(contact: Contact, options?: CreateContactOptions)
2866
2877
  }>;
2867
2878
  interface CreateContactOptions {
2868
2879
  /**
2869
- * Allows creating a duplicate contact.
2880
+ * Whether to create the contact even if it duplicates an existing contact.
2870
2881
  * More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
2871
2882
  */
2872
2883
  allowDuplicates?: boolean;
2873
2884
  }
2874
2885
  /**
2875
2886
  * Retrieves a single contact by ID.
2876
- * @param contactId - ID of the Contact to retrieve.
2887
+ * @param contactId - ID of the contact to retrieve.
2877
2888
  * @public
2878
2889
  * @documentationMaturity preview
2879
2890
  * @requiredField contactId
2880
2891
  * @permissionId CONTACTS.CONTACT_READ
2881
2892
  * @applicableIdentity APP
2882
- * @returns The requested Contact.
2893
+ * @returns Retrieved contact.
2883
2894
  * @fqn wix.contacts.v5.Contacts.GetContact
2884
2895
  */
2885
2896
  declare function getContact(contactId: string): Promise<NonNullablePaths<Contact, `email.email` | `email.subscriptionStatus.status` | `email.deliverabilityStatus` | `additionalEmails` | `additionalEmails.${number}.email` | `phone.tag` | `phone.phone` | `phone.deliverabilityStatus` | `additionalPhones` | `additionalPhones.${number}.tag` | `additionalPhones.${number}.phone` | `addresses` | `addresses.${number}.tag` | `addresses.${number}.address.streetAddress.number` | `addresses.${number}.address.streetAddress.name` | `addresses.${number}.address.streetAddress.apt` | `locationIds` | `segmentIds` | `memberInfo.status` | `memberInfo.profileInfo.privacyStatus` | `memberInfo.userInfo.userId` | `memberInfo.userInfo.role` | `memberInfo.sessionInfo.mobileAppNames` | `memberInfo.groupInfo.groupIds` | `tags.privateTags.tagIds`, 6>>;
@@ -2905,7 +2916,7 @@ declare function getContact(contactId: string): Promise<NonNullablePaths<Contact
2905
2916
  * @permissionId CONTACTS.CONTACT_UPDATE
2906
2917
  * @permissionId CONTACTS.CONTACT_MEMBER_EMAIL_UPDATE
2907
2918
  * @applicableIdentity APP
2908
- * @returns Updated Contact.
2919
+ * @returns Updated contact.
2909
2920
  * @fqn wix.contacts.v5.Contacts.UpdateContact
2910
2921
  */
2911
2922
  declare function updateContact(_id: string, contact: NonNullablePaths<UpdateContact, `revision`, 2>, options?: UpdateContactOptions): Promise<NonNullablePaths<Contact, `email.email` | `email.subscriptionStatus.status` | `email.deliverabilityStatus` | `additionalEmails` | `additionalEmails.${number}.email` | `phone.tag` | `phone.phone` | `phone.deliverabilityStatus` | `additionalPhones` | `additionalPhones.${number}.tag` | `additionalPhones.${number}.phone` | `addresses` | `addresses.${number}.tag` | `addresses.${number}.address.streetAddress.number` | `addresses.${number}.address.streetAddress.name` | `addresses.${number}.address.streetAddress.apt` | `locationIds` | `segmentIds` | `memberInfo.status` | `memberInfo.profileInfo.privacyStatus` | `memberInfo.userInfo.userId` | `memberInfo.userInfo.role` | `memberInfo.sessionInfo.mobileAppNames` | `memberInfo.groupInfo.groupIds` | `tags.privateTags.tagIds`, 6> & {
@@ -2929,19 +2940,19 @@ interface UpdateContact {
2929
2940
  */
2930
2941
  revision?: string | null;
2931
2942
  /**
2932
- * Date and time the Contact was created.
2943
+ * Date and time the contact was created.
2933
2944
  * @readonly
2934
2945
  * @immutable
2935
2946
  */
2936
2947
  _createdDate?: Date | null;
2937
2948
  /**
2938
- * Date and time the Contact was last updated.
2949
+ * Date and time the contact was last updated.
2939
2950
  * @readonly
2940
2951
  */
2941
2952
  _updatedDate?: Date | null;
2942
2953
  /**
2943
- * Contact External ID. Used to identify contacts from external systems.
2944
- * This field can only be set once and cannot be updated after creation.
2954
+ * Contact external ID. Used to identify contacts from external systems.
2955
+ * This field can only be set once and can't be updated after creation.
2945
2956
  * @maxLength 100
2946
2957
  */
2947
2958
  externalId?: string | null;
@@ -3031,7 +3042,7 @@ interface UpdateContact {
3031
3042
  */
3032
3043
  lastActivity?: ContactActivity;
3033
3044
  /**
3034
- * List of Contact segment IDs that this contact belongs to.
3045
+ * IDs of the segments the contact belongs to.
3035
3046
  * Segments are used for organizing and targeting groups of contacts.
3036
3047
  * @maxSize 60
3037
3048
  * @readonly
@@ -3057,7 +3068,7 @@ interface UpdateContact {
3057
3068
  }
3058
3069
  interface UpdateContactOptions {
3059
3070
  /**
3060
- * Allows updating the contact even if it becomes a duplicate of another contact.
3071
+ * Whether to update the contact even if it becomes a duplicate of another contact.
3061
3072
  * More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
3062
3073
  */
3063
3074
  allowDuplicates?: boolean;
@@ -3079,7 +3090,7 @@ interface UpdateContactOptions {
3079
3090
  * Image upload: When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
3080
3091
  *
3081
3092
  * To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-upsert-contacts).
3082
- * @param contact - Contact to be upserted.
3093
+ * @param contact - Contact to upsert.
3083
3094
  * @public
3084
3095
  * @documentationMaturity preview
3085
3096
  * @requiredField contact
@@ -3092,9 +3103,9 @@ declare function upsertContact(contact: Contact, options?: UpsertContactOptions)
3092
3103
  __applicationErrorsType?: UpsertContactApplicationErrors;
3093
3104
  }>;
3094
3105
  interface UpsertContactOptions {
3095
- /** The mode in which the upsert should work in. */
3106
+ /** Mode that determines how an existing contact is updated when a match is found. See the endpoint description for the supported modes. */
3096
3107
  upsertMode?: UpsertModeWithLiterals;
3097
- /** Indicates whether to update the contact even if it is a site member. */
3108
+ /** Whether to update the contact even if it's a site member. */
3098
3109
  updateMember?: boolean | null;
3099
3110
  }
3100
3111
  /**
@@ -3103,7 +3114,7 @@ interface UpsertContactOptions {
3103
3114
  * Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
3104
3115
  *
3105
3116
  * To update tags on multiple contacts, call [Bulk Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contact-tags).
3106
- * @param contactId - The contact from which to add or remove tags.
3117
+ * @param contactId - ID of the contact whose tags to update.
3107
3118
  * @public
3108
3119
  * @documentationMaturity preview
3109
3120
  * @requiredField contactId
@@ -3115,9 +3126,9 @@ declare function updateContactTags(contactId: string, options?: UpdateContactTag
3115
3126
  __applicationErrorsType?: UpdateContactTagsApplicationErrors;
3116
3127
  }>;
3117
3128
  interface UpdateContactTagsOptions {
3118
- /** The tags to add. */
3129
+ /** Tags to assign. */
3119
3130
  assignTags?: PrivateTags;
3120
- /** The tags to remove. */
3131
+ /** Tags to unassign. */
3121
3132
  unassignTags?: PrivateTags;
3122
3133
  }
3123
3134
  /**
@@ -3139,7 +3150,8 @@ interface UpdateContactTagsOptions {
3139
3150
  * - `externalId` can be set only once and can't be changed if it already has a value.
3140
3151
  * - The target contact must remain valid after the merge, keeping at least one of `name`, `email`, or `phone`.
3141
3152
  * @param targetContactId - Target contact ID.
3142
- * @param targetContactRevision - Target contact revision number, which increments by 1 each time the contact is updated to prevent conflicting changes.
3153
+ * @param targetContactRevision - Revision number of the target contact, which increments by 1 each time the contact is updated.
3154
+ * The current revision must be passed to prevent conflicting changes.
3143
3155
  * @public
3144
3156
  * @documentationMaturity preview
3145
3157
  * @requiredField targetContactId
@@ -3152,7 +3164,7 @@ declare function mergeContacts(targetContactId: string, targetContactRevision: s
3152
3164
  __applicationErrorsType?: MergeContactsApplicationErrors;
3153
3165
  }>;
3154
3166
  interface MergeContactsOptions {
3155
- /** When the target contact is provided, the merged result will be overwritten. */
3167
+ /** Contact to overwrite the target with, instead of merging in the source contacts' data. See the endpoint description for details. */
3156
3168
  targetContact?: Contact;
3157
3169
  /**
3158
3170
  * IDs of up to 5 contacts to merge into the target contact.
@@ -3163,11 +3175,14 @@ interface MergeContactsOptions {
3163
3175
  * @format GUID
3164
3176
  */
3165
3177
  sourceContactIds?: string[];
3166
- /** Indicates whether to only return a preview of the merged contact or perform the actual merge. */
3178
+ /**
3179
+ * Whether to return a preview of the merged contact instead of performing the actual merge.
3180
+ *
3181
+ * Default: `false`
3182
+ */
3167
3183
  preview?: boolean | null;
3168
3184
  /**
3169
- * Allows updating the target contact even if it becomes a duplicate of another contact.
3170
- * This can happen only where the target contact is provided.
3185
+ * Whether to update the target contact even if it becomes a duplicate of another contact. Relevant only when `targetContact` is provided.
3171
3186
  * More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
3172
3187
  */
3173
3188
  allowDuplicates?: boolean;
@@ -3184,7 +3199,7 @@ interface MergeContactsOptions {
3184
3199
  * - A site owner or contributor can't be deleted.
3185
3200
  *
3186
3201
  * To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-delete-contacts).
3187
- * @param contactId - Id of the Contact to delete.
3202
+ * @param contactId - ID of the contact to delete.
3188
3203
  * @public
3189
3204
  * @documentationMaturity preview
3190
3205
  * @requiredField contactId
@@ -3198,8 +3213,9 @@ declare function deleteContact(contactId: string, options?: DeleteContactOptions
3198
3213
  }>;
3199
3214
  interface DeleteContactOptions {
3200
3215
  /**
3201
- * Indicates whether to delete the contact that is a site member. If set to `true`, the contact is deleted even
3202
- * if it is a site member and the site member is also deleted. Default: `false`
3216
+ * Whether to delete the contact even if it's a site member. If `true`, the site member is also deleted.
3217
+ *
3218
+ * Default: `false`
3203
3219
  */
3204
3220
  deleteMember?: boolean | null;
3205
3221
  }
@@ -3222,7 +3238,7 @@ declare function findMatchingContacts(options?: FindMatchingContactsOptions): Pr
3222
3238
  }>;
3223
3239
  interface FindMatchingContactsOptions {
3224
3240
  /**
3225
- * Contact External ID.
3241
+ * Contact external ID.
3226
3242
  * @maxLength 100
3227
3243
  */
3228
3244
  externalId?: string | null;
@@ -3737,7 +3753,7 @@ interface CountContactsOptions {
3737
3753
  * see the [Upload API](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/upload-api) article.
3738
3754
  *
3739
3755
  * You can call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to query the status of the image upload.
3740
- * @param contactId - ID of the contact whose picture is being updated.
3756
+ * @param contactId - ID of the contact to generate an image upload URL for.
3741
3757
  * @public
3742
3758
  * @documentationMaturity preview
3743
3759
  * @requiredField contactId
@@ -3763,8 +3779,8 @@ interface GenerateContactImageUploadUrlOptions {
3763
3779
  * The contact must have a main email (`email.email`) before an additional email can be added.
3764
3780
  *
3765
3781
  * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
3766
- * @param contactId - ID of the Contact to add an email.
3767
- * @param email - The email to add.
3782
+ * @param contactId - ID of the contact to add an email to.
3783
+ * @param email - Email to add.
3768
3784
  * @public
3769
3785
  * @documentationMaturity preview
3770
3786
  * @requiredField contactId
@@ -3779,7 +3795,7 @@ declare function addContactAdditionalEmail(contactId: string, email: AdditionalE
3779
3795
  __applicationErrorsType?: AddContactAdditionalEmailApplicationErrors;
3780
3796
  }>;
3781
3797
  interface AddContactAdditionalEmailOptions {
3782
- /** Contact revision number for optimistic concurrency control. */
3798
+ /** Contact revision number. */
3783
3799
  revision: string | null;
3784
3800
  }
3785
3801
  /**
@@ -3788,8 +3804,8 @@ interface AddContactAdditionalEmailOptions {
3788
3804
  * The contact must have a main phone (`phone.phone`) before an additional phone can be added. If the contact already has the same phone number with the same tag, the request is ignored.
3789
3805
  *
3790
3806
  * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
3791
- * @param contactId - ID of the Contact to add a phone.
3792
- * @param phone - The phone to add.
3807
+ * @param contactId - ID of the contact to add a phone to.
3808
+ * @param phone - Phone to add.
3793
3809
  * @public
3794
3810
  * @documentationMaturity preview
3795
3811
  * @requiredField contactId
@@ -3804,7 +3820,7 @@ declare function addContactAdditionalPhone(contactId: string, phone: AdditionalP
3804
3820
  __applicationErrorsType?: AddContactAdditionalPhoneApplicationErrors;
3805
3821
  }>;
3806
3822
  interface AddContactAdditionalPhoneOptions {
3807
- /** Contact revision number for optimistic concurrency control. */
3823
+ /** Contact revision number. */
3808
3824
  revision: string | null;
3809
3825
  }
3810
3826
  /**
@@ -3813,8 +3829,8 @@ interface AddContactAdditionalPhoneOptions {
3813
3829
  * The address is appended to the contact's list of addresses. If the contact already has the same address with the same tag, the request is ignored.
3814
3830
  *
3815
3831
  * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
3816
- * @param contactId - ID of the Contact to add an address.
3817
- * @param address - The address to add.
3832
+ * @param contactId - ID of the contact to add an address to.
3833
+ * @param address - Address to add.
3818
3834
  * @public
3819
3835
  * @documentationMaturity preview
3820
3836
  * @requiredField address
@@ -3829,14 +3845,14 @@ declare function addContactAddress(contactId: string, address: ContactAddress, o
3829
3845
  __applicationErrorsType?: AddContactAddressApplicationErrors;
3830
3846
  }>;
3831
3847
  interface AddContactAddressOptions {
3832
- /** Contact revision number for optimistic concurrency control. */
3848
+ /** Contact revision number. */
3833
3849
  revision: string | null;
3834
3850
  }
3835
3851
  /**
3836
3852
  * Deletes an address from a contact by address ID.
3837
3853
  *
3838
3854
  * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
3839
- * @param revision - Contact revision number for optimistic concurrency control.
3855
+ * @param revision - Contact revision number.
3840
3856
  * @public
3841
3857
  * @documentationMaturity preview
3842
3858
  * @requiredField identifiers
@@ -3852,7 +3868,7 @@ declare function deleteContactAddress(identifiers: NonNullablePaths<DeleteContac
3852
3868
  }>;
3853
3869
  interface DeleteContactAddressIdentifiers {
3854
3870
  /**
3855
- * ID of the Contact from which to delete an address.
3871
+ * ID of the contact to delete the address from.
3856
3872
  * @format GUID
3857
3873
  */
3858
3874
  contactId: string;
@@ -3866,7 +3882,7 @@ interface DeleteContactAddressIdentifiers {
3866
3882
  * Updates an address on a contact.
3867
3883
  *
3868
3884
  * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
3869
- * @param address - The updated address (must include address.id).
3885
+ * @param address - Address to update. Must include `address.id`.
3870
3886
  * @public
3871
3887
  * @documentationMaturity preview
3872
3888
  * @requiredField address
@@ -3883,13 +3899,13 @@ declare function updateContactAddress(identifiers: NonNullablePaths<UpdateContac
3883
3899
  }>;
3884
3900
  interface UpdateContactAddressIdentifiers {
3885
3901
  /**
3886
- * ID of the Contact to update address on.
3902
+ * ID of the contact to update the address on.
3887
3903
  * @format GUID
3888
3904
  */
3889
3905
  contactId: string;
3890
3906
  }
3891
3907
  interface UpdateContactAddressOptions {
3892
- /** Contact revision number for optimistic concurrency control. */
3908
+ /** Contact revision number. */
3893
3909
  revision: string | null;
3894
3910
  }
3895
3911
  /**
@@ -3898,7 +3914,7 @@ interface UpdateContactAddressOptions {
3898
3914
  * When you provide an image URL for a contact, the image is uploaded in the background and the returned contact temporarily has no image. Once the upload succeeds, the contact's image is updated.
3899
3915
  *
3900
3916
  * To create a single contact, call [Create Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/create-contact).
3901
- * @param contacts - List of Contacts to be created
3917
+ * @param contacts - Contacts to create.
3902
3918
  * @public
3903
3919
  * @documentationMaturity preview
3904
3920
  * @requiredField contacts
@@ -3910,7 +3926,7 @@ declare function bulkCreateContacts(contacts: Contact[], options?: BulkCreateCon
3910
3926
  interface BulkCreateContactsOptions {
3911
3927
  /** Whether to include the created contacts in the response. */
3912
3928
  returnEntity?: boolean;
3913
- /** Allows creating the contact even if a duplicate already exists. */
3929
+ /** Whether to create the contact even if it duplicates an existing contact. */
3914
3930
  allowDuplicates?: boolean;
3915
3931
  }
3916
3932
  /**
@@ -3921,7 +3937,7 @@ interface BulkCreateContactsOptions {
3921
3937
  * `externalId` can be set only once. If it already has a value, it can't be updated.
3922
3938
  *
3923
3939
  * To update a single contact, call [Update Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact).
3924
- * @param contacts - List of Contacts to be updated.
3940
+ * @param contacts - Contacts to update.
3925
3941
  * @public
3926
3942
  * @documentationMaturity preview
3927
3943
  * @requiredField contacts
@@ -3935,7 +3951,7 @@ declare function bulkUpdateContacts(contacts: NonNullablePaths<MaskedContact, `c
3935
3951
  interface BulkUpdateContactsOptions {
3936
3952
  /** Whether to include the updated contacts in the response. */
3937
3953
  returnEntity?: boolean;
3938
- /** Allows updating the contact even if it becomes a duplicate of another contact. */
3954
+ /** Whether to update the contact even if it becomes a duplicate of another contact. */
3939
3955
  allowDuplicates?: boolean;
3940
3956
  }
3941
3957
  /**
@@ -3944,7 +3960,7 @@ interface BulkUpdateContactsOptions {
3944
3960
  * Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
3945
3961
  *
3946
3962
  * To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
3947
- * @param contactIds - The contacts from which to add or remove tags.
3963
+ * @param contactIds - IDs of the contacts to add or remove tags on.
3948
3964
  * @public
3949
3965
  * @documentationMaturity preview
3950
3966
  * @requiredField contactIds
@@ -3958,9 +3974,9 @@ declare function bulkUpdateContactTags(contactIds: string[], options?: BulkUpdat
3958
3974
  interface BulkUpdateContactTagsOptions {
3959
3975
  /** Whether to include the updated contacts in the response. */
3960
3976
  returnEntity?: boolean;
3961
- /** The tags to add. */
3977
+ /** Tags to assign. */
3962
3978
  assignTags?: PrivateTags;
3963
- /** The tags to remove. */
3979
+ /** Tags to unassign. */
3964
3980
  unassignTags?: PrivateTags;
3965
3981
  }
3966
3982
  /**
@@ -3971,7 +3987,7 @@ interface BulkUpdateContactTagsOptions {
3971
3987
  * To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
3972
3988
  *
3973
3989
  * To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
3974
- * @param filter - A filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters)
3990
+ * @param filter - Filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
3975
3991
  * @public
3976
3992
  * @documentationMaturity preview
3977
3993
  * @requiredField filter
@@ -3985,9 +4001,9 @@ declare function bulkUpdateContactTagsByFilter(filter: Record<string, any>, opti
3985
4001
  interface BulkUpdateContactTagsByFilterOptions {
3986
4002
  /** Free text to match in searchable fields. */
3987
4003
  search?: SearchDetails;
3988
- /** Tag ids to add to the contact. */
4004
+ /** Tags to assign to the matching contacts. */
3989
4005
  assignTags?: PrivateTags;
3990
- /** Tag ids to remove from the contact. */
4006
+ /** Tags to unassign from the matching contacts. */
3991
4007
  unassignTags?: PrivateTags;
3992
4008
  }
3993
4009
  /**
@@ -4005,7 +4021,7 @@ interface BulkUpdateContactTagsByFilterOptions {
4005
4021
  * When you provide an image URL and the upsert mode allows the image to be updated, the image is uploaded in the background. The returned contact temporarily has no image if it was created, or its previous image if it was updated. Once the upload succeeds, the contact's image is updated.
4006
4022
  *
4007
4023
  * To create or update a single contact, call [Upsert Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/upsert-contact).
4008
- * @param contacts - List of Contacts to be updated.
4024
+ * @param contacts - Contacts to create or update.
4009
4025
  * @public
4010
4026
  * @documentationMaturity preview
4011
4027
  * @requiredField contacts
@@ -4018,9 +4034,9 @@ declare function bulkUpsertContacts(contacts: BulkUpsertContactsRequestMaskedCon
4018
4034
  interface BulkUpsertContactsOptions {
4019
4035
  /** Whether to include the upserted contacts in the response. */
4020
4036
  returnEntity?: boolean;
4021
- /** The mode in which the upsert should work in. */
4037
+ /** Mode that determines how an existing contact is updated when a match is found. See the endpoint description for the supported modes. */
4022
4038
  upsertMode?: UpsertModeWithLiterals;
4023
- /** Indicates whether to update a contact even if it is a site member. */
4039
+ /** Whether to update a contact even if it's a site member. */
4024
4040
  updateMember?: boolean | null;
4025
4041
  }
4026
4042
  /**
@@ -4029,7 +4045,7 @@ interface BulkUpsertContactsOptions {
4029
4045
  * Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
4030
4046
  *
4031
4047
  * To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/delete-contact).
4032
- * @param contactIds - Contact ids to be deleted
4048
+ * @param contactIds - IDs of the contacts to delete.
4033
4049
  * @public
4034
4050
  * @documentationMaturity preview
4035
4051
  * @requiredField contactIds
@@ -4043,8 +4059,9 @@ declare function bulkDeleteContacts(contactIds: string[], options?: BulkDeleteCo
4043
4059
  }>;
4044
4060
  interface BulkDeleteContactsOptions {
4045
4061
  /**
4046
- * Indicates whether to delete the contact that is a site member. If set to `true`, the contact is deleted even
4047
- * if it is a site member and the site member is also deleted. Default: `false`
4062
+ * Whether to delete the associated site member for any contact that's a site member. If `true`, the site member is also deleted.
4063
+ *
4064
+ * Default: `false`
4048
4065
  */
4049
4066
  deleteMembers?: boolean | null;
4050
4067
  }
@@ -4079,11 +4096,12 @@ declare function bulkDeleteContactsByFilter(filter: Record<string, any>, options
4079
4096
  __applicationErrorsType?: BulkDeleteContactsByFilterApplicationErrors;
4080
4097
  }>;
4081
4098
  interface BulkDeleteContactsByFilterOptions {
4082
- /** Free text to match in searchable fields */
4099
+ /** Free text to match in searchable fields. */
4083
4100
  search?: SearchDetails;
4084
4101
  /**
4085
- * Indicates whether to delete the contact that is a site member. If set to `true`, the contact is deleted even
4086
- * if it is a site member and the site member is also deleted. Default: `false`
4102
+ * Whether to delete the associated site member for any contact that's a site member. If `true`, the site member is also deleted.
4103
+ *
4104
+ * Default: `false`
4087
4105
  */
4088
4106
  deleteMembers?: boolean | null;
4089
4107
  }
@@ -4091,7 +4109,7 @@ interface BulkDeleteContactsByFilterOptions {
4091
4109
  * Permanently deletes a contact from the trash bin.
4092
4110
  *
4093
4111
  * After removal, the contact can no longer be restored.
4094
- * @param contactId - Id of the Contact to remove from trashbin.
4112
+ * @param contactId - ID of the contact to permanently delete from the trash bin.
4095
4113
  * @public
4096
4114
  * @documentationMaturity preview
4097
4115
  * @requiredField contactId
@@ -4104,7 +4122,7 @@ declare function removeContactFromTrashBin(contactId: string): Promise<void>;
4104
4122
  * Restores a soft-deleted contact from the trash bin.
4105
4123
  *
4106
4124
  * To restore multiple contacts in a single request, call [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
4107
- * @param contactId - Id of the Contact to restore from trashbin.
4125
+ * @param contactId - ID of the contact to restore from the trash bin.
4108
4126
  * @public
4109
4127
  * @documentationMaturity preview
4110
4128
  * @requiredField contactId
@@ -4126,7 +4144,7 @@ declare function restoreContactFromTrashBin(contactId: string): Promise<NonNulla
4126
4144
  declare function bulkRestoreContactsFromTrashBin(options?: BulkRestoreContactsFromTrashBinOptions): Promise<NonNullablePaths<BulkRestoreContactsFromTrashBinResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
4127
4145
  interface BulkRestoreContactsFromTrashBinOptions {
4128
4146
  /**
4129
- * List of Contacts to be restored
4147
+ * IDs of the contacts to restore from the trash bin.
4130
4148
  * @minSize 1
4131
4149
  * @maxSize 100
4132
4150
  * @format GUID
@@ -4137,7 +4155,7 @@ interface BulkRestoreContactsFromTrashBinOptions {
4137
4155
  }
4138
4156
  /**
4139
4157
  * Retrieves a soft-deleted contact from the trash bin by ID.
4140
- * @param contactId - Id of the Contact to retrieve from trashbin.
4158
+ * @param contactId - ID of the contact to retrieve from the trash bin.
4141
4159
  * @public
4142
4160
  * @documentationMaturity preview
4143
4161
  * @requiredField contactId
@@ -4157,7 +4175,7 @@ declare function getDeletedContact(contactId: string): Promise<NonNullablePaths<
4157
4175
  declare function listDeletedContacts(options?: ListDeletedContactsOptions): Promise<NonNullablePaths<ListDeletedContactsResponse, `contacts` | `contacts.${number}.email.email` | `contacts.${number}.email.subscriptionStatus.status` | `contacts.${number}.email.deliverabilityStatus` | `contacts.${number}.phone.tag` | `contacts.${number}.phone.phone` | `contacts.${number}.phone.deliverabilityStatus` | `contacts.${number}.memberInfo.status` | `contacts.${number}.memberInfo.profileInfo.privacyStatus` | `contacts.${number}.memberInfo.userInfo.userId` | `contacts.${number}.memberInfo.userInfo.role`, 6>>;
4158
4176
  interface ListDeletedContactsOptions {
4159
4177
  /**
4160
- * External ID
4178
+ * External ID.
4161
4179
  * @maxLength 100
4162
4180
  */
4163
4181
  externalId?: string | null;
@@ -4179,9 +4197,9 @@ interface ListDeletedContactsOptions {
4179
4197
  * @format GUID
4180
4198
  */
4181
4199
  contactIds?: string[];
4182
- /** From date and time that contact was deleted. */
4200
+ /** Filters to contacts deleted on or after this date and time. */
4183
4201
  deletedFromDate?: Date | null;
4184
- /** Until date and time that contact was deleted. */
4202
+ /** Filters to contacts deleted on or before this date and time. */
4185
4203
  deletedToDate?: Date | null;
4186
4204
  /** Cursor paging. */
4187
4205
  paging?: CursorPaging;
@@ -4202,13 +4220,12 @@ declare function getContactImageUploadStatus(identifiers: NonNullablePaths<GetCo
4202
4220
  }>;
4203
4221
  interface GetContactImageUploadStatusIdentifiers {
4204
4222
  /**
4205
- * Id of the contact for which to retrieve the image upload status.
4223
+ * ID of the contact whose image upload status to retrieve.
4206
4224
  * @format GUID
4207
4225
  */
4208
4226
  contactId: string;
4209
4227
  /**
4210
- * The upload ID of the image upload process. Returned in case an image URL was provided when creating or
4211
- * updating a contact. It is also returned from the GenerateContactImageUploadUrl endpoint.
4228
+ * The upload ID of the image upload process. Returned when an image URL is provided while creating or updating a contact, or from [Generate Contact Image Upload Url](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/generate-contact-image-upload-url).
4212
4229
  * @maxLength 100
4213
4230
  */
4214
4231
  imageUploadId: string;
@@ -4239,7 +4256,8 @@ interface BulkUpdatePhoneCountryCodeByFilterOptions {
4239
4256
  search?: SearchDetails;
4240
4257
  /**
4241
4258
  * [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code to apply.
4242
- * The country code will be added to the contacts main phone number, when adding it the phone, makes it a valid phone number.
4259
+ *
4260
+ * Applied only to contacts whose phone number isn't already in [ITU E.164 international](https://www.itu.int/rec/T-REC-E.164/) format. If the phone number still can't be converted to E.164 format after applying the country code, that contact fails with `PHONE_CANNOT_BE_FIXED_WITH_COUNTRY_CODE`.
4243
4261
  * @format COUNTRY
4244
4262
  */
4245
4263
  countryCode: string;