@wix/auto_sdk_crm_contacts-v-5 1.0.10 → 1.0.12
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/build/cjs/{contacts-v5-contact-contacts-v-5.universal-rkyEtvlE.d.ts → contacts-v5-contact-contacts-v-5.universal-BsgIzfZI.d.ts} +3 -52
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -3
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -1
- package/build/es/{contacts-v5-contact-contacts-v-5.universal-rkyEtvlE.d.mts → contacts-v5-contact-contacts-v-5.universal-BsgIzfZI.d.mts} +3 -52
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -3
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1 -1
- package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-rkyEtvlE.d.ts → contacts-v5-contact-contacts-v-5.universal-BsgIzfZI.d.ts} +3 -52
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -3
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1 -1
- package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-rkyEtvlE.d.mts → contacts-v5-contact-contacts-v-5.universal-BsgIzfZI.d.mts} +3 -52
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -3
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1 -1
- package/package.json +2 -2
|
@@ -2849,7 +2849,6 @@ type GetContactImageUploadStatusApplicationErrors = {
|
|
|
2849
2849
|
* Example:
|
|
2850
2850
|
* `{ "filter": { "name.last": "Smith" } }`
|
|
2851
2851
|
* @public
|
|
2852
|
-
* @documentationMaturity preview
|
|
2853
2852
|
* @requiredField filter
|
|
2854
2853
|
* @permissionId CONTACTS.CONTACT_SUBSCRIPTION_UPDATE
|
|
2855
2854
|
* @applicableIdentity APP
|
|
@@ -2878,7 +2877,6 @@ interface BulkUpdateContactSubscriptionsOptions {
|
|
|
2878
2877
|
* To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-create-contacts).
|
|
2879
2878
|
* @param contact - Contact to create.
|
|
2880
2879
|
* @public
|
|
2881
|
-
* @documentationMaturity preview
|
|
2882
2880
|
* @requiredField contact
|
|
2883
2881
|
* @permissionId CONTACTS.CONTACT_CREATE
|
|
2884
2882
|
* @applicableIdentity APP
|
|
@@ -2899,7 +2897,6 @@ interface CreateContactOptions {
|
|
|
2899
2897
|
* Retrieves a single contact by ID.
|
|
2900
2898
|
* @param contactId - ID of the contact to retrieve.
|
|
2901
2899
|
* @public
|
|
2902
|
-
* @documentationMaturity preview
|
|
2903
2900
|
* @requiredField contactId
|
|
2904
2901
|
* @permissionId CONTACTS.CONTACT_READ
|
|
2905
2902
|
* @applicableIdentity APP
|
|
@@ -2922,7 +2919,6 @@ declare function getContact(contactId: string): Promise<NonNullablePaths<Contact
|
|
|
2922
2919
|
* To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contacts).
|
|
2923
2920
|
* @param _id - Contact ID.
|
|
2924
2921
|
* @public
|
|
2925
|
-
* @documentationMaturity preview
|
|
2926
2922
|
* @requiredField _id
|
|
2927
2923
|
* @requiredField contact
|
|
2928
2924
|
* @requiredField contact.revision
|
|
@@ -3109,7 +3105,6 @@ interface UpdateContactOptions {
|
|
|
3109
3105
|
* 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).
|
|
3110
3106
|
* @param contact - Contact to upsert.
|
|
3111
3107
|
* @public
|
|
3112
|
-
* @documentationMaturity preview
|
|
3113
3108
|
* @requiredField contact
|
|
3114
3109
|
* @permissionId CONTACTS.CONTACT_UPSERT
|
|
3115
3110
|
* @permissionId CONTACTS.CONTACT_MEMBER_UPDATE
|
|
@@ -3133,7 +3128,6 @@ interface UpsertContactOptions {
|
|
|
3133
3128
|
* 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).
|
|
3134
3129
|
* @param contactId - ID of the contact whose tags to update.
|
|
3135
3130
|
* @public
|
|
3136
|
-
* @documentationMaturity preview
|
|
3137
3131
|
* @requiredField contactId
|
|
3138
3132
|
* @permissionId CONTACTS.CONTACT_UPDATE
|
|
3139
3133
|
* @applicableIdentity APP
|
|
@@ -3170,7 +3164,6 @@ interface UpdateContactTagsOptions {
|
|
|
3170
3164
|
* @param targetContactRevision - Revision number of the target contact, which increments by 1 each time the contact is updated.
|
|
3171
3165
|
* The current revision must be passed to prevent conflicting changes.
|
|
3172
3166
|
* @public
|
|
3173
|
-
* @documentationMaturity preview
|
|
3174
3167
|
* @requiredField targetContactId
|
|
3175
3168
|
* @requiredField targetContactRevision
|
|
3176
3169
|
* @permissionId CONTACTS.CONTACT_MERGE
|
|
@@ -3218,7 +3211,6 @@ interface MergeContactsOptions {
|
|
|
3218
3211
|
* 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).
|
|
3219
3212
|
* @param contactId - ID of the contact to delete.
|
|
3220
3213
|
* @public
|
|
3221
|
-
* @documentationMaturity preview
|
|
3222
3214
|
* @requiredField contactId
|
|
3223
3215
|
* @permissionId CONTACTS.CONTACT_DELETE
|
|
3224
3216
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
@@ -3245,7 +3237,6 @@ interface DeleteContactOptions {
|
|
|
3245
3237
|
*
|
|
3246
3238
|
* Learn more about [contact matching](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
3247
3239
|
* @public
|
|
3248
|
-
* @documentationMaturity preview
|
|
3249
3240
|
* @permissionId CONTACTS.CONTACT_READ
|
|
3250
3241
|
* @applicableIdentity APP
|
|
3251
3242
|
* @fqn wix.contacts.v5.Contacts.FindMatchingContacts
|
|
@@ -3283,7 +3274,6 @@ interface FindMatchingContactsOptions {
|
|
|
3283
3274
|
*
|
|
3284
3275
|
* To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
|
|
3285
3276
|
* @public
|
|
3286
|
-
* @documentationMaturity preview
|
|
3287
3277
|
* @permissionId CONTACTS.CONTACT_READ
|
|
3288
3278
|
* @applicableIdentity APP
|
|
3289
3279
|
* @fqn wix.contacts.v5.Contacts.QueryContacts
|
|
@@ -3305,46 +3295,32 @@ interface ContactsQueryResult extends QueryCursorResult {
|
|
|
3305
3295
|
interface ContactsQueryBuilder {
|
|
3306
3296
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3307
3297
|
* @param value - Value to compare against.
|
|
3308
|
-
* @documentationMaturity preview
|
|
3309
3298
|
*/
|
|
3310
3299
|
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'externalId' | 'email.email' | 'phone.phone', value: any) => ContactsQueryBuilder;
|
|
3311
3300
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3312
3301
|
* @param value - Value to compare against.
|
|
3313
|
-
* @documentationMaturity preview
|
|
3314
3302
|
*/
|
|
3315
3303
|
ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => ContactsQueryBuilder;
|
|
3316
3304
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3317
3305
|
* @param value - Value to compare against.
|
|
3318
|
-
* @documentationMaturity preview
|
|
3319
3306
|
*/
|
|
3320
3307
|
gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ContactsQueryBuilder;
|
|
3321
3308
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3322
3309
|
* @param value - Value to compare against.
|
|
3323
|
-
* @documentationMaturity preview
|
|
3324
3310
|
*/
|
|
3325
3311
|
le: (propertyName: '_createdDate' | '_updatedDate', value: any) => ContactsQueryBuilder;
|
|
3326
3312
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3327
3313
|
* @param value - Value to compare against.
|
|
3328
|
-
* @documentationMaturity preview
|
|
3329
3314
|
*/
|
|
3330
3315
|
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ContactsQueryBuilder;
|
|
3331
|
-
/** @documentationMaturity preview */
|
|
3332
3316
|
in: (propertyName: '_id' | 'externalId' | 'email.email' | 'phone.phone', value: any) => ContactsQueryBuilder;
|
|
3333
|
-
/** @documentationMaturity preview */
|
|
3334
3317
|
exists: (propertyName: 'externalId' | 'email.email' | 'phone.phone', value: boolean) => ContactsQueryBuilder;
|
|
3335
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3336
|
-
* @documentationMaturity preview
|
|
3337
|
-
*/
|
|
3318
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
3338
3319
|
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => ContactsQueryBuilder;
|
|
3339
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
3340
|
-
* @documentationMaturity preview
|
|
3341
|
-
*/
|
|
3320
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
3342
3321
|
limit: (limit: number) => ContactsQueryBuilder;
|
|
3343
|
-
/** @param cursor - A pointer to specific record
|
|
3344
|
-
* @documentationMaturity preview
|
|
3345
|
-
*/
|
|
3322
|
+
/** @param cursor - A pointer to specific record */
|
|
3346
3323
|
skipTo: (cursor: string) => ContactsQueryBuilder;
|
|
3347
|
-
/** @documentationMaturity preview */
|
|
3348
3324
|
find: () => Promise<ContactsQueryResult>;
|
|
3349
3325
|
}
|
|
3350
3326
|
/**
|
|
@@ -3429,10 +3405,6 @@ declare const utils: {
|
|
|
3429
3405
|
SearchBuilder: () => _wix_sdk_types.SearchBuilder<Contact, ContactSearchSpec, ContactSearch>;
|
|
3430
3406
|
Filter: _wix_sdk_types.FilterFactory<Contact, ContactSearchSpec>;
|
|
3431
3407
|
Sort: _wix_sdk_types.SortFactory<ContactSearchSpec>;
|
|
3432
|
-
/**
|
|
3433
|
-
* Maximum number of items to return in the results.
|
|
3434
|
-
* @max 100
|
|
3435
|
-
*/
|
|
3436
3408
|
SearchParams: _wix_sdk_types.SearchParamsFactory<ContactSearchSpec>;
|
|
3437
3409
|
Aggregation: _wix_sdk_types.AggregationFactory<ContactSearchSpec>;
|
|
3438
3410
|
};
|
|
@@ -3736,7 +3708,6 @@ type ContactSearch = {
|
|
|
3736
3708
|
/**
|
|
3737
3709
|
* Retrieves the number of contacts that match the provided filter and search criteria.
|
|
3738
3710
|
* @public
|
|
3739
|
-
* @documentationMaturity preview
|
|
3740
3711
|
* @permissionId CONTACTS.CONTACT_READ
|
|
3741
3712
|
* @applicableIdentity APP
|
|
3742
3713
|
* @fqn wix.contacts.v5.Contacts.CountContacts
|
|
@@ -3776,7 +3747,6 @@ interface CountContactsOptions {
|
|
|
3776
3747
|
* 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.
|
|
3777
3748
|
* @param contactId - ID of the contact to generate an image upload URL for.
|
|
3778
3749
|
* @public
|
|
3779
|
-
* @documentationMaturity preview
|
|
3780
3750
|
* @requiredField contactId
|
|
3781
3751
|
* @permissionId CONTACTS.GENERATE_IMAGE_UPLOAD_URL
|
|
3782
3752
|
* @applicableIdentity APP
|
|
@@ -3803,7 +3773,6 @@ interface GenerateContactImageUploadUrlOptions {
|
|
|
3803
3773
|
* @param contactId - ID of the contact to add an email to.
|
|
3804
3774
|
* @param email - Email to add.
|
|
3805
3775
|
* @public
|
|
3806
|
-
* @documentationMaturity preview
|
|
3807
3776
|
* @requiredField contactId
|
|
3808
3777
|
* @requiredField email
|
|
3809
3778
|
* @requiredField options
|
|
@@ -3828,7 +3797,6 @@ interface AddContactAdditionalEmailOptions {
|
|
|
3828
3797
|
* @param contactId - ID of the contact to add a phone to.
|
|
3829
3798
|
* @param phone - Phone to add.
|
|
3830
3799
|
* @public
|
|
3831
|
-
* @documentationMaturity preview
|
|
3832
3800
|
* @requiredField contactId
|
|
3833
3801
|
* @requiredField options
|
|
3834
3802
|
* @requiredField options.revision
|
|
@@ -3853,7 +3821,6 @@ interface AddContactAdditionalPhoneOptions {
|
|
|
3853
3821
|
* @param contactId - ID of the contact to add an address to.
|
|
3854
3822
|
* @param address - Address to add.
|
|
3855
3823
|
* @public
|
|
3856
|
-
* @documentationMaturity preview
|
|
3857
3824
|
* @requiredField address
|
|
3858
3825
|
* @requiredField contactId
|
|
3859
3826
|
* @requiredField options
|
|
@@ -3875,7 +3842,6 @@ interface AddContactAddressOptions {
|
|
|
3875
3842
|
* 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.
|
|
3876
3843
|
* @param revision - Contact revision number.
|
|
3877
3844
|
* @public
|
|
3878
|
-
* @documentationMaturity preview
|
|
3879
3845
|
* @requiredField identifiers
|
|
3880
3846
|
* @requiredField identifiers.addressId
|
|
3881
3847
|
* @requiredField identifiers.contactId
|
|
@@ -3905,7 +3871,6 @@ interface DeleteContactAddressIdentifiers {
|
|
|
3905
3871
|
* 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.
|
|
3906
3872
|
* @param address - Address to update. Must include `address.id`.
|
|
3907
3873
|
* @public
|
|
3908
|
-
* @documentationMaturity preview
|
|
3909
3874
|
* @requiredField address
|
|
3910
3875
|
* @requiredField identifiers
|
|
3911
3876
|
* @requiredField identifiers.contactId
|
|
@@ -3937,7 +3902,6 @@ interface UpdateContactAddressOptions {
|
|
|
3937
3902
|
* To create a single contact, call [Create Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/create-contact).
|
|
3938
3903
|
* @param contacts - Contacts to create.
|
|
3939
3904
|
* @public
|
|
3940
|
-
* @documentationMaturity preview
|
|
3941
3905
|
* @requiredField contacts
|
|
3942
3906
|
* @permissionId CONTACTS.CONTACT_CREATE
|
|
3943
3907
|
* @applicableIdentity APP
|
|
@@ -3960,7 +3924,6 @@ interface BulkCreateContactsOptions {
|
|
|
3960
3924
|
* To update a single contact, call [Update Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact).
|
|
3961
3925
|
* @param contacts - Contacts to update.
|
|
3962
3926
|
* @public
|
|
3963
|
-
* @documentationMaturity preview
|
|
3964
3927
|
* @requiredField contacts
|
|
3965
3928
|
* @requiredField contacts.contact._id
|
|
3966
3929
|
* @requiredField contacts.contact.revision
|
|
@@ -3983,7 +3946,6 @@ interface BulkUpdateContactsOptions {
|
|
|
3983
3946
|
* 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).
|
|
3984
3947
|
* @param contactIds - IDs of the contacts to add or remove tags on.
|
|
3985
3948
|
* @public
|
|
3986
|
-
* @documentationMaturity preview
|
|
3987
3949
|
* @requiredField contactIds
|
|
3988
3950
|
* @permissionId CONTACTS.CONTACT_UPDATE
|
|
3989
3951
|
* @applicableIdentity APP
|
|
@@ -4010,7 +3972,6 @@ interface BulkUpdateContactTagsOptions {
|
|
|
4010
3972
|
* 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).
|
|
4011
3973
|
* @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).
|
|
4012
3974
|
* @public
|
|
4013
|
-
* @documentationMaturity preview
|
|
4014
3975
|
* @requiredField filter
|
|
4015
3976
|
* @permissionId CONTACTS.CONTACT_UPDATE
|
|
4016
3977
|
* @applicableIdentity APP
|
|
@@ -4044,7 +4005,6 @@ interface BulkUpdateContactTagsByFilterOptions {
|
|
|
4044
4005
|
* 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).
|
|
4045
4006
|
* @param contacts - Contacts to create or update.
|
|
4046
4007
|
* @public
|
|
4047
|
-
* @documentationMaturity preview
|
|
4048
4008
|
* @requiredField contacts
|
|
4049
4009
|
* @permissionId CONTACTS.CONTACT_UPSERT
|
|
4050
4010
|
* @permissionId CONTACTS.CONTACT_MEMBER_UPDATE
|
|
@@ -4068,7 +4028,6 @@ interface BulkUpsertContactsOptions {
|
|
|
4068
4028
|
* To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/delete-contact).
|
|
4069
4029
|
* @param contactIds - IDs of the contacts to delete.
|
|
4070
4030
|
* @public
|
|
4071
|
-
* @documentationMaturity preview
|
|
4072
4031
|
* @requiredField contactIds
|
|
4073
4032
|
* @permissionId CONTACTS.CONTACT_DELETE
|
|
4074
4033
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
@@ -4106,7 +4065,6 @@ interface BulkDeleteContactsOptions {
|
|
|
4106
4065
|
* Example:
|
|
4107
4066
|
* `{ "filter": { "name.last": "Smith" } }`
|
|
4108
4067
|
* @public
|
|
4109
|
-
* @documentationMaturity preview
|
|
4110
4068
|
* @requiredField filter
|
|
4111
4069
|
* @permissionId CONTACTS.CONTACT_DELETE
|
|
4112
4070
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
@@ -4132,7 +4090,6 @@ interface BulkDeleteContactsByFilterOptions {
|
|
|
4132
4090
|
* After removal, the contact can no longer be restored.
|
|
4133
4091
|
* @param contactId - ID of the contact to permanently delete from the trash bin.
|
|
4134
4092
|
* @public
|
|
4135
|
-
* @documentationMaturity preview
|
|
4136
4093
|
* @requiredField contactId
|
|
4137
4094
|
* @permissionId CONTACTS.CONTACT_REMOVE_FROM_TRASHBIN
|
|
4138
4095
|
* @applicableIdentity APP
|
|
@@ -4145,7 +4102,6 @@ declare function removeContactFromTrashBin(contactId: string): Promise<void>;
|
|
|
4145
4102
|
* 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).
|
|
4146
4103
|
* @param contactId - ID of the contact to restore from the trash bin.
|
|
4147
4104
|
* @public
|
|
4148
|
-
* @documentationMaturity preview
|
|
4149
4105
|
* @requiredField contactId
|
|
4150
4106
|
* @permissionId CONTACTS.CONTACT_RESTORE_FROM_TRASHBIN
|
|
4151
4107
|
* @applicableIdentity APP
|
|
@@ -4157,7 +4113,6 @@ declare function restoreContactFromTrashBin(contactId: string): Promise<NonNulla
|
|
|
4157
4113
|
*
|
|
4158
4114
|
* To restore a single contact, call [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin).
|
|
4159
4115
|
* @public
|
|
4160
|
-
* @documentationMaturity preview
|
|
4161
4116
|
* @permissionId CONTACTS.CONTACT_RESTORE_FROM_TRASHBIN
|
|
4162
4117
|
* @applicableIdentity APP
|
|
4163
4118
|
* @fqn wix.contacts.v5.Contacts.BulkRestoreContactsFromTrashBin
|
|
@@ -4178,7 +4133,6 @@ interface BulkRestoreContactsFromTrashBinOptions {
|
|
|
4178
4133
|
* Retrieves a soft-deleted contact from the trash bin by ID.
|
|
4179
4134
|
* @param contactId - ID of the contact to retrieve from the trash bin.
|
|
4180
4135
|
* @public
|
|
4181
|
-
* @documentationMaturity preview
|
|
4182
4136
|
* @requiredField contactId
|
|
4183
4137
|
* @permissionId CONTACTS.CONTACT_READ_FROM_TRASHBIN
|
|
4184
4138
|
* @applicableIdentity APP
|
|
@@ -4188,7 +4142,6 @@ declare function getDeletedContact(contactId: string): Promise<NonNullablePaths<
|
|
|
4188
4142
|
/**
|
|
4189
4143
|
* Retrieves a list of soft-deleted contacts from the trash bin, filtered by the provided identifiers and deletion date range.
|
|
4190
4144
|
* @public
|
|
4191
|
-
* @documentationMaturity preview
|
|
4192
4145
|
* @permissionId CONTACTS.CONTACT_READ_FROM_TRASHBIN
|
|
4193
4146
|
* @applicableIdentity APP
|
|
4194
4147
|
* @fqn wix.contacts.v5.Contacts.ListDeletedContacts
|
|
@@ -4228,7 +4181,6 @@ interface ListDeletedContactsOptions {
|
|
|
4228
4181
|
/**
|
|
4229
4182
|
* Retrieves the status of the contact image upload process.
|
|
4230
4183
|
* @public
|
|
4231
|
-
* @documentationMaturity preview
|
|
4232
4184
|
* @requiredField identifiers
|
|
4233
4185
|
* @requiredField identifiers.contactId
|
|
4234
4186
|
* @requiredField identifiers.imageUploadId
|
|
@@ -4258,7 +4210,6 @@ interface GetContactImageUploadStatusIdentifiers {
|
|
|
4258
4210
|
*
|
|
4259
4211
|
* 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).
|
|
4260
4212
|
* @public
|
|
4261
|
-
* @documentationMaturity preview
|
|
4262
4213
|
* @requiredField options.countryCode
|
|
4263
4214
|
* @permissionId CONTACTS.CONTACT_UPDATE
|
|
4264
4215
|
* @applicableIdentity APP
|
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { B as BulkUpdateContactSubscriptionsOptions, a as BulkUpdateContactSubscriptionsResponse, b as BulkUpdateContactSubscriptionsApplicationErrors, C as Contact, c as CreateContactOptions, d as CreateContactApplicationErrors, U as UpdateContact, e as UpdateContactOptions, f as UpdateContactApplicationErrors, g as UpsertContactOptions, h as UpsertContactResponse, i as UpsertContactApplicationErrors, j as UpdateContactTagsOptions, k as UpdateContactTagsResponse, l as UpdateContactTagsApplicationErrors, M as MergeContactsOptions, m as MergeContactsResponse, n as MergeContactsApplicationErrors, D as DeleteContactOptions, o as DeleteContactApplicationErrors, F as FindMatchingContactsOptions, p as FindMatchingContactsResponse, q as FindMatchingContactsApplicationErrors, r as ContactSearch, S as SearchContactsOptions, s as SearchContactsResponse, t as CountContactsOptions, u as CountContactsResponse, G as GenerateContactImageUploadUrlOptions, v as GenerateContactImageUploadUrlResponse, w as GenerateContactImageUploadUrlApplicationErrors, A as AdditionalEmail, x as AddContactAdditionalEmailOptions, y as AddContactAdditionalEmailResponse, z as AddContactAdditionalEmailApplicationErrors, E as AdditionalPhone, H as AddContactAdditionalPhoneOptions, I as AddContactAdditionalPhoneResponse, J as AddContactAdditionalPhoneApplicationErrors, K as ContactAddress, L as AddContactAddressOptions, N as AddContactAddressResponse, O as AddContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, Q as DeleteContactAddressResponse, R as DeleteContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, W as UpdateContactAddressResponse, X as UpdateContactAddressApplicationErrors, Y as BulkCreateContactsOptions, Z as BulkCreateContactsResponse, _ as MaskedContact, $ as BulkUpdateContactsOptions, a0 as BulkUpdateContactsResponse, a1 as BulkUpdateContactTagsOptions, a2 as BulkUpdateContactTagsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, a5 as BulkUpdateContactTagsByFilterResponse, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a7 as BulkUpsertContactsRequestMaskedContact, a8 as BulkUpsertContactsOptions, a9 as BulkUpsertContactsResponse, aa as BulkDeleteContactsOptions, ab as BulkDeleteContactsResponse, ac as BulkDeleteContactsApplicationErrors, ad as BulkDeleteContactsByFilterOptions, ae as BulkDeleteContactsByFilterResponse, af as BulkDeleteContactsByFilterApplicationErrors, ag as RestoreContactFromTrashBinResponse, ah as BulkRestoreContactsFromTrashBinOptions, ai as BulkRestoreContactsFromTrashBinResponse, aj as GetDeletedContactResponse, ak as ListDeletedContactsOptions, al as ListDeletedContactsResponse, am as GetContactImageUploadStatusIdentifiers, an as GetContactImageUploadStatusResponse, ao as GetContactImageUploadStatusApplicationErrors, ap as BulkUpdatePhoneCountryCodeByFilterOptions, aq as BulkUpdatePhoneCountryCodeByFilterResponse, ar as ContactsQueryBuilder, as as ContactQuery, at as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-
|
|
3
|
-
export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, cA as AddContactAdditionalEmailRequest, cB as AddContactAdditionalPhoneRequest, cC as AddContactAddressRequest, aZ as Address, b0 as AddressLocation, a_ as AddressStreetOneOf, ay as AddressTag, dl as AddressTagWithLiterals, c5 as Aggregation, ch as AggregationData, c6 as AggregationKindOneOf, cw as AggregationResults, cx as AggregationResultsResultOneOf, cm as AggregationResultsScalarResult, aQ as AggregationType, dE as AggregationTypeWithLiterals, cH as ApplicationError, cJ as BulkActionMetadata, c$ as BulkAddSegmentToContactsRequest, d0 as BulkAddSegmentToContactsResponse, cI as BulkContactResult, cF as BulkCreateContactsRequest, bH as BulkDelete, cT as BulkDeleteContactsByFilterRequest, cR as BulkDeleteContactsRequest, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, cX as BulkRestoreContactsFromTrashBinRequest, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bz as BulkUpdateContactSubscriptionsRequest, cO as BulkUpdateContactTagsByFilterRequest, cM as BulkUpdateContactTagsRequest, cN as BulkUpdateContactTagsResult, cK as BulkUpdateContactsRequest, cL as BulkUpdateContactsResponseBulkContactResult, da as BulkUpdatePhoneCountryCodeByFilterRequest, cP as BulkUpsertContactsRequest, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, b6 as ContactActivity, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, dd as ContactsQueryResult, cy as CountContactsRequest, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c3 as CursorSearch, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, cD as DeleteContactAddressRequest, bT as DeleteContactRequest, bU as DeleteContactResponse, bo as DomainEvent, bp as DomainEventBodyOneOf, bK as DuplicateContactExists, av as EmailDeliverabilityStatus, di as EmailDeliverabilityStatusWithLiterals, db as Empty, bq as EntityCreatedEvent, bt as EntityDeletedEvent, bs as EntityUpdatedEvent, be as ExtendedFields, bQ as FailedMemberUpdate, bV as FindMatchingContactsRequest, cz as GenerateContactImageUploadUrlRequest, d9 as GetContactImageUploadStatusRequest, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, bb as GroupInfo, bw as IdentificationData, bx as IdentificationDataIdOneOf, aU as ImageUploadStatus, dI as ImageUploadStatusWithLiterals, c8 as IncludeMissingValuesOptions, bD as Index, aP as Interval, dD as IntervalWithLiterals, cG as ItemMetadata, c_ as ListDeletedContactsRequest, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, bS as MergeContactsRequest, bv as MessageEnvelope, aM as MissingValues, dA as MissingValuesWithLiterals, aE as Mode, ds as ModeWithLiterals, aR as NameFormat, dF as NameFormatWithLiterals, cg as NestedAggregation, ce as NestedAggregationItem, cf as NestedAggregationItemKindOneOf, aO as NestedAggregationType, dC as NestedAggregationTypeWithLiterals, cq as NestedResultValue, cr as NestedResultValueResultOneOf, cv as NestedResults, d6 as Paging, d8 as PagingMetadataV2, ax as PhoneDeliverabilityStatus, dk as PhoneDeliverabilityStatusWithLiterals, aw as PhoneTag, dj as PhoneTagWithLiterals, aB as PrivacyStatus, dp as PrivacyStatusWithLiterals, bc as PrivateTags, b8 as ProfileInfo, d3 as QueryContactsByOffsetInternalRequest, aT as QueryContactsByOffsetInternalRequestNameFormat, dH as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d7 as QueryContactsByOffsetInternalResponse, bW as QueryContactsRequest, b$ as QueryContactsResponse, d4 as QueryV2, d5 as QueryV2PagingMethodOneOf, cb as RangeAggregation, cj as RangeAggregationResult, c7 as RangeBucket, co as RangeResult, cl as RangeResults, b3 as Recipient, bB as ReindexEntityForFQDN, bC as ReindexEntityForFQDNActionOneOf, bf as ReindexMessage, bg as ReindexMessageActionOneOf, bi as ReindexMessageDelete, cU as RemoveContactFromTrashBinRequest, cV as RemoveContactFromTrashBinResponse, bF as ReportBatchCompleted, cW as RestoreContactFromTrashBinRequest, br as RestoreInfo, cs as Results, aC as Role, dq as RoleWithLiterals, cc as ScalarAggregation, cp as ScalarResult, aN as ScalarType, dB as ScalarTypeWithLiterals, bj as Schema, c2 as SearchContactsRequest, bA as SearchDetails, ba as SessionInfo, aL as SortDirection, dz as SortDirectionWithLiterals, aJ as SortOrder, dx as SortOrderWithLiterals, aK as SortType, dy as SortTypeWithLiterals, bZ as Sorting, b2 as StandardDetails, a$ as StreetAddress, b1 as Subdivision, az as SubdivisionType, dm as SubdivisionTypeWithLiterals, au as SubscriptionStatus, dh as SubscriptionStatusWithLiterals, bd as TagList, cE as UpdateContactAddressRequest, bN as UpdateContactRequest, bO as UpdateContactResponse, bR as UpdateContactTagsRequest, bh as Upsert, bP as UpsertContactRequest, aI as UpsertContactResponseAction, dw as UpsertContactResponseActionWithLiterals, aH as UpsertMode, dv as UpsertModeWithLiterals, b9 as UserInfo, aF as V5SubscriptionStatus, dt as V5SubscriptionStatusWithLiterals, c9 as ValueAggregation, ca as ValueAggregationOptionsOneOf, ci as ValueAggregationResult, cn as ValueResult, ck as ValueResults, aD as WebhookIdentityType, dr as WebhookIdentityTypeWithLiterals, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-
|
|
2
|
+
import { B as BulkUpdateContactSubscriptionsOptions, a as BulkUpdateContactSubscriptionsResponse, b as BulkUpdateContactSubscriptionsApplicationErrors, C as Contact, c as CreateContactOptions, d as CreateContactApplicationErrors, U as UpdateContact, e as UpdateContactOptions, f as UpdateContactApplicationErrors, g as UpsertContactOptions, h as UpsertContactResponse, i as UpsertContactApplicationErrors, j as UpdateContactTagsOptions, k as UpdateContactTagsResponse, l as UpdateContactTagsApplicationErrors, M as MergeContactsOptions, m as MergeContactsResponse, n as MergeContactsApplicationErrors, D as DeleteContactOptions, o as DeleteContactApplicationErrors, F as FindMatchingContactsOptions, p as FindMatchingContactsResponse, q as FindMatchingContactsApplicationErrors, r as ContactSearch, S as SearchContactsOptions, s as SearchContactsResponse, t as CountContactsOptions, u as CountContactsResponse, G as GenerateContactImageUploadUrlOptions, v as GenerateContactImageUploadUrlResponse, w as GenerateContactImageUploadUrlApplicationErrors, A as AdditionalEmail, x as AddContactAdditionalEmailOptions, y as AddContactAdditionalEmailResponse, z as AddContactAdditionalEmailApplicationErrors, E as AdditionalPhone, H as AddContactAdditionalPhoneOptions, I as AddContactAdditionalPhoneResponse, J as AddContactAdditionalPhoneApplicationErrors, K as ContactAddress, L as AddContactAddressOptions, N as AddContactAddressResponse, O as AddContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, Q as DeleteContactAddressResponse, R as DeleteContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, W as UpdateContactAddressResponse, X as UpdateContactAddressApplicationErrors, Y as BulkCreateContactsOptions, Z as BulkCreateContactsResponse, _ as MaskedContact, $ as BulkUpdateContactsOptions, a0 as BulkUpdateContactsResponse, a1 as BulkUpdateContactTagsOptions, a2 as BulkUpdateContactTagsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, a5 as BulkUpdateContactTagsByFilterResponse, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a7 as BulkUpsertContactsRequestMaskedContact, a8 as BulkUpsertContactsOptions, a9 as BulkUpsertContactsResponse, aa as BulkDeleteContactsOptions, ab as BulkDeleteContactsResponse, ac as BulkDeleteContactsApplicationErrors, ad as BulkDeleteContactsByFilterOptions, ae as BulkDeleteContactsByFilterResponse, af as BulkDeleteContactsByFilterApplicationErrors, ag as RestoreContactFromTrashBinResponse, ah as BulkRestoreContactsFromTrashBinOptions, ai as BulkRestoreContactsFromTrashBinResponse, aj as GetDeletedContactResponse, ak as ListDeletedContactsOptions, al as ListDeletedContactsResponse, am as GetContactImageUploadStatusIdentifiers, an as GetContactImageUploadStatusResponse, ao as GetContactImageUploadStatusApplicationErrors, ap as BulkUpdatePhoneCountryCodeByFilterOptions, aq as BulkUpdatePhoneCountryCodeByFilterResponse, ar as ContactsQueryBuilder, as as ContactQuery, at as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-BsgIzfZI.js';
|
|
3
|
+
export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, cA as AddContactAdditionalEmailRequest, cB as AddContactAdditionalPhoneRequest, cC as AddContactAddressRequest, aZ as Address, b0 as AddressLocation, a_ as AddressStreetOneOf, ay as AddressTag, dl as AddressTagWithLiterals, c5 as Aggregation, ch as AggregationData, c6 as AggregationKindOneOf, cw as AggregationResults, cx as AggregationResultsResultOneOf, cm as AggregationResultsScalarResult, aQ as AggregationType, dE as AggregationTypeWithLiterals, cH as ApplicationError, cJ as BulkActionMetadata, c$ as BulkAddSegmentToContactsRequest, d0 as BulkAddSegmentToContactsResponse, cI as BulkContactResult, cF as BulkCreateContactsRequest, bH as BulkDelete, cT as BulkDeleteContactsByFilterRequest, cR as BulkDeleteContactsRequest, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, cX as BulkRestoreContactsFromTrashBinRequest, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bz as BulkUpdateContactSubscriptionsRequest, cO as BulkUpdateContactTagsByFilterRequest, cM as BulkUpdateContactTagsRequest, cN as BulkUpdateContactTagsResult, cK as BulkUpdateContactsRequest, cL as BulkUpdateContactsResponseBulkContactResult, da as BulkUpdatePhoneCountryCodeByFilterRequest, cP as BulkUpsertContactsRequest, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, b6 as ContactActivity, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, dd as ContactsQueryResult, cy as CountContactsRequest, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c3 as CursorSearch, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, cD as DeleteContactAddressRequest, bT as DeleteContactRequest, bU as DeleteContactResponse, bo as DomainEvent, bp as DomainEventBodyOneOf, bK as DuplicateContactExists, av as EmailDeliverabilityStatus, di as EmailDeliverabilityStatusWithLiterals, db as Empty, bq as EntityCreatedEvent, bt as EntityDeletedEvent, bs as EntityUpdatedEvent, be as ExtendedFields, bQ as FailedMemberUpdate, bV as FindMatchingContactsRequest, cz as GenerateContactImageUploadUrlRequest, d9 as GetContactImageUploadStatusRequest, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, bb as GroupInfo, bw as IdentificationData, bx as IdentificationDataIdOneOf, aU as ImageUploadStatus, dI as ImageUploadStatusWithLiterals, c8 as IncludeMissingValuesOptions, bD as Index, aP as Interval, dD as IntervalWithLiterals, cG as ItemMetadata, c_ as ListDeletedContactsRequest, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, bS as MergeContactsRequest, bv as MessageEnvelope, aM as MissingValues, dA as MissingValuesWithLiterals, aE as Mode, ds as ModeWithLiterals, aR as NameFormat, dF as NameFormatWithLiterals, cg as NestedAggregation, ce as NestedAggregationItem, cf as NestedAggregationItemKindOneOf, aO as NestedAggregationType, dC as NestedAggregationTypeWithLiterals, cq as NestedResultValue, cr as NestedResultValueResultOneOf, cv as NestedResults, d6 as Paging, d8 as PagingMetadataV2, ax as PhoneDeliverabilityStatus, dk as PhoneDeliverabilityStatusWithLiterals, aw as PhoneTag, dj as PhoneTagWithLiterals, aB as PrivacyStatus, dp as PrivacyStatusWithLiterals, bc as PrivateTags, b8 as ProfileInfo, d3 as QueryContactsByOffsetInternalRequest, aT as QueryContactsByOffsetInternalRequestNameFormat, dH as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d7 as QueryContactsByOffsetInternalResponse, bW as QueryContactsRequest, b$ as QueryContactsResponse, d4 as QueryV2, d5 as QueryV2PagingMethodOneOf, cb as RangeAggregation, cj as RangeAggregationResult, c7 as RangeBucket, co as RangeResult, cl as RangeResults, b3 as Recipient, bB as ReindexEntityForFQDN, bC as ReindexEntityForFQDNActionOneOf, bf as ReindexMessage, bg as ReindexMessageActionOneOf, bi as ReindexMessageDelete, cU as RemoveContactFromTrashBinRequest, cV as RemoveContactFromTrashBinResponse, bF as ReportBatchCompleted, cW as RestoreContactFromTrashBinRequest, br as RestoreInfo, cs as Results, aC as Role, dq as RoleWithLiterals, cc as ScalarAggregation, cp as ScalarResult, aN as ScalarType, dB as ScalarTypeWithLiterals, bj as Schema, c2 as SearchContactsRequest, bA as SearchDetails, ba as SessionInfo, aL as SortDirection, dz as SortDirectionWithLiterals, aJ as SortOrder, dx as SortOrderWithLiterals, aK as SortType, dy as SortTypeWithLiterals, bZ as Sorting, b2 as StandardDetails, a$ as StreetAddress, b1 as Subdivision, az as SubdivisionType, dm as SubdivisionTypeWithLiterals, au as SubscriptionStatus, dh as SubscriptionStatusWithLiterals, bd as TagList, cE as UpdateContactAddressRequest, bN as UpdateContactRequest, bO as UpdateContactResponse, bR as UpdateContactTagsRequest, bh as Upsert, bP as UpsertContactRequest, aI as UpsertContactResponseAction, dw as UpsertContactResponseActionWithLiterals, aH as UpsertMode, dv as UpsertModeWithLiterals, b9 as UserInfo, aF as V5SubscriptionStatus, dt as V5SubscriptionStatusWithLiterals, c9 as ValueAggregation, ca as ValueAggregationOptionsOneOf, ci as ValueAggregationResult, cn as ValueResult, ck as ValueResults, aD as WebhookIdentityType, dr as WebhookIdentityTypeWithLiterals, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-BsgIzfZI.js';
|
|
4
4
|
|
|
5
5
|
declare function bulkUpdateContactSubscriptions$1(httpClient: HttpClient): BulkUpdateContactSubscriptionsSignature;
|
|
6
6
|
interface BulkUpdateContactSubscriptionsSignature {
|