@wix/auto_sdk_crm_contacts-v-5 1.0.22 → 1.0.23
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-BJh2oKn7.d.ts → contacts-v5-contact-contacts-v-5.universal-_-E4ZhZP.d.ts} +27 -15
- package/build/cjs/index.d.ts +8 -11
- package/build/cjs/index.js +17 -19
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +15 -15
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +13 -5
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{contacts-v5-contact-contacts-v-5.universal-BJh2oKn7.d.mts → contacts-v5-contact-contacts-v-5.universal-_-E4ZhZP.d.mts} +27 -15
- package/build/es/index.d.mts +8 -11
- package/build/es/index.mjs +17 -19
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +15 -15
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +13 -5
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-Ckkqdx9F.d.ts → contacts-v5-contact-contacts-v-5.universal-Cz3zaNvV.d.ts} +27 -15
- package/build/internal/cjs/index.d.ts +8 -11
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +13 -5
- package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-Ckkqdx9F.d.mts → contacts-v5-contact-contacts-v-5.universal-Cz3zaNvV.d.mts} +27 -15
- package/build/internal/es/index.d.mts +8 -11
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +13 -5
- package/package.json +2 -2
|
@@ -2077,8 +2077,8 @@ interface BulkUpdateContactTagsResult {
|
|
|
2077
2077
|
item?: Contact;
|
|
2078
2078
|
}
|
|
2079
2079
|
interface BulkUpdateContactTagsByFilterRequest {
|
|
2080
|
-
/** 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). */
|
|
2081
|
-
filter
|
|
2080
|
+
/** Filter object. An empty filter (`{}`) matches all contacts. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters). */
|
|
2081
|
+
filter?: Record<string, any> | null;
|
|
2082
2082
|
/** Free text to match in searchable fields. */
|
|
2083
2083
|
search?: SearchDetails;
|
|
2084
2084
|
/** Tags to assign to the matching contacts. */
|
|
@@ -2167,12 +2167,12 @@ interface BulkDeleteContactsResponseBulkContactResult {
|
|
|
2167
2167
|
}
|
|
2168
2168
|
interface BulkDeleteContactsByFilterRequest {
|
|
2169
2169
|
/**
|
|
2170
|
-
* Filter object.
|
|
2170
|
+
* Filter object. An empty filter (`{}`) matches all contacts.
|
|
2171
2171
|
*
|
|
2172
2172
|
* Example:
|
|
2173
2173
|
* `{ "filter": { "name.last": "Smith" } }`
|
|
2174
2174
|
*/
|
|
2175
|
-
filter
|
|
2175
|
+
filter?: Record<string, any> | null;
|
|
2176
2176
|
/** Free text to match in searchable fields. */
|
|
2177
2177
|
search?: SearchDetails;
|
|
2178
2178
|
/**
|
|
@@ -2830,6 +2830,10 @@ type BulkUpdateContactTagsByFilterApplicationErrors = {
|
|
|
2830
2830
|
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
2831
2831
|
description?: string;
|
|
2832
2832
|
data?: Record<string, any>;
|
|
2833
|
+
} | {
|
|
2834
|
+
code?: 'MISSING_FILTER_AND_SEARCH';
|
|
2835
|
+
description?: string;
|
|
2836
|
+
data?: Record<string, any>;
|
|
2833
2837
|
};
|
|
2834
2838
|
/** @docsIgnore */
|
|
2835
2839
|
type BulkDeleteContactsApplicationErrors = {
|
|
@@ -2842,6 +2846,10 @@ type BulkDeleteContactsByFilterApplicationErrors = {
|
|
|
2842
2846
|
code?: 'UNAUTHORIZED_DELETE_MEMBER';
|
|
2843
2847
|
description?: string;
|
|
2844
2848
|
data?: Record<string, any>;
|
|
2849
|
+
} | {
|
|
2850
|
+
code?: 'MISSING_FILTER_AND_SEARCH';
|
|
2851
|
+
description?: string;
|
|
2852
|
+
data?: Record<string, any>;
|
|
2845
2853
|
};
|
|
2846
2854
|
/** @docsIgnore */
|
|
2847
2855
|
type GetContactImageUploadStatusApplicationErrors = {
|
|
@@ -4002,24 +4010,26 @@ interface BulkUpdateContactTagsOptions {
|
|
|
4002
4010
|
unassignTags?: PrivateTags;
|
|
4003
4011
|
}
|
|
4004
4012
|
/**
|
|
4005
|
-
* Adds or removes tags on multiple contacts that match the provided filter. Works asynchronously.
|
|
4013
|
+
* Adds or removes tags on multiple contacts that match the provided filter. Works asynchronously.
|
|
4014
|
+
*
|
|
4015
|
+
* All contacts that meet the specified `filter` and `search` criteria are updated. The request must contain a `filter` value, a `search` value, or both. An empty `filter` (`{}`) without a `search` value matches all contacts.
|
|
4006
4016
|
*
|
|
4007
4017
|
* 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.
|
|
4008
4018
|
*
|
|
4009
4019
|
* 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).
|
|
4010
4020
|
*
|
|
4011
4021
|
* 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).
|
|
4012
|
-
* @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).
|
|
4013
4022
|
* @public
|
|
4014
|
-
* @requiredField filter
|
|
4015
4023
|
* @permissionId CONTACTS.CONTACT_UPDATE
|
|
4016
4024
|
* @applicableIdentity APP
|
|
4017
4025
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContactTagsByFilter
|
|
4018
4026
|
*/
|
|
4019
|
-
declare function bulkUpdateContactTagsByFilter(
|
|
4027
|
+
declare function bulkUpdateContactTagsByFilter(options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`, 0> & {
|
|
4020
4028
|
__applicationErrorsType?: BulkUpdateContactTagsByFilterApplicationErrors;
|
|
4021
4029
|
}>;
|
|
4022
4030
|
interface BulkUpdateContactTagsByFilterOptions {
|
|
4031
|
+
/** Filter object. An empty filter (`{}`) matches all contacts. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters). */
|
|
4032
|
+
filter?: Record<string, any> | null;
|
|
4023
4033
|
/** Free text to match in searchable fields. */
|
|
4024
4034
|
search?: SearchDetails;
|
|
4025
4035
|
/** Tags to assign to the matching contacts. */
|
|
@@ -4087,7 +4097,7 @@ interface BulkDeleteContactsOptions {
|
|
|
4087
4097
|
/**
|
|
4088
4098
|
* Deletes multiple contacts that match the provided filter. Works asynchronously.
|
|
4089
4099
|
*
|
|
4090
|
-
* All contacts that meet the specified `filter` and `search` criteria are deleted. The request must contain a `filter` value, a `search` value, or both. To preview which contacts match before deleting, call [Search Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/search-contacts) with the same criteria.
|
|
4100
|
+
* All contacts that meet the specified `filter` and `search` criteria are deleted. The request must contain a `filter` value, a `search` value, or both. An empty `filter` (`{}`) without a `search` value matches all contacts, so all of the site's contacts are deleted. To preview which contacts match before deleting, call [Search Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/search-contacts) with the same criteria.
|
|
4091
4101
|
*
|
|
4092
4102
|
* To check the status of the bulk deletion, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
4093
4103
|
*
|
|
@@ -4099,21 +4109,23 @@ interface BulkDeleteContactsOptions {
|
|
|
4099
4109
|
* - `CANNOT_DELETE_WIX_USERS_MEMBER`: Site member can't be deleted because it's the owner or a contributor.
|
|
4100
4110
|
* - `FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION`: Site member was deleted, but the contact was not.
|
|
4101
4111
|
* - `FAILED_DELETE_CONTACT`: Contact couldn't be deleted.
|
|
4102
|
-
* @param filter - Filter object.
|
|
4103
|
-
*
|
|
4104
|
-
* Example:
|
|
4105
|
-
* `{ "filter": { "name.last": "Smith" } }`
|
|
4106
4112
|
* @public
|
|
4107
|
-
* @requiredField filter
|
|
4108
4113
|
* @permissionId CONTACTS.CONTACT_DELETE
|
|
4109
4114
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
4110
4115
|
* @applicableIdentity APP
|
|
4111
4116
|
* @fqn wix.contacts.v5.Contacts.BulkDeleteContactsByFilter
|
|
4112
4117
|
*/
|
|
4113
|
-
declare function bulkDeleteContactsByFilter(
|
|
4118
|
+
declare function bulkDeleteContactsByFilter(options?: BulkDeleteContactsByFilterOptions): Promise<NonNullablePaths<BulkDeleteContactsByFilterResponse, `jobId`, 0> & {
|
|
4114
4119
|
__applicationErrorsType?: BulkDeleteContactsByFilterApplicationErrors;
|
|
4115
4120
|
}>;
|
|
4116
4121
|
interface BulkDeleteContactsByFilterOptions {
|
|
4122
|
+
/**
|
|
4123
|
+
* Filter object. An empty filter (`{}`) matches all contacts.
|
|
4124
|
+
*
|
|
4125
|
+
* Example:
|
|
4126
|
+
* `{ "filter": { "name.last": "Smith" } }`
|
|
4127
|
+
*/
|
|
4128
|
+
filter?: Record<string, any> | null;
|
|
4117
4129
|
/** Free text to match in searchable fields. */
|
|
4118
4130
|
search?: SearchDetails;
|
|
4119
4131
|
/**
|
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 UpdateContactAddress, W as UpdateContactAddressOptions, X as UpdateContactAddressResponse, Y as UpdateContactAddressApplicationErrors, Z as BulkCreateContactsOptions, _ as BulkCreateContactsResponse, $ as MaskedContact, a0 as BulkUpdateContactsOptions, a1 as BulkUpdateContactsResponse, a2 as BulkUpdateContactTagsOptions, a3 as BulkUpdateContactTagsResponse, a4 as BulkUpdateContactTagsApplicationErrors, a5 as BulkUpdateContactTagsByFilterOptions, a6 as BulkUpdateContactTagsByFilterResponse, a7 as BulkUpdateContactTagsByFilterApplicationErrors, a8 as BulkUpsertContactsRequestMaskedContact, a9 as BulkUpsertContactsOptions, aa as BulkUpsertContactsResponse, ab as BulkDeleteContactsOptions, ac as BulkDeleteContactsResponse, ad as BulkDeleteContactsApplicationErrors, ae as BulkDeleteContactsByFilterOptions, af as BulkDeleteContactsByFilterResponse, ag as BulkDeleteContactsByFilterApplicationErrors, ah as RestoreContactFromTrashBinResponse, ai as BulkRestoreContactsFromTrashBinOptions, aj as BulkRestoreContactsFromTrashBinResponse, ak as GetDeletedContactResponse, al as ListDeletedContactsOptions, am as ListDeletedContactsResponse, an as GetContactImageUploadStatusIdentifiers, ao as GetContactImageUploadStatusResponse, ap as GetContactImageUploadStatusApplicationErrors, aq as BulkUpdatePhoneCountryCodeByFilterOptions, ar as BulkUpdatePhoneCountryCodeByFilterResponse, as as ContactsQueryBuilder, at as ContactQuery, au as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-
|
|
3
|
-
export { bz as AccountInfo, aT as Action, bv as ActionEvent, dH as ActionWithLiterals, cB as AddContactAdditionalEmailRequest, cC as AddContactAdditionalPhoneRequest, cD as AddContactAddressRequest, a_ as Address, b1 as AddressLocation, a$ as AddressStreetOneOf, az as AddressTag, dm as AddressTagWithLiterals, c6 as Aggregation, ci as AggregationData, c7 as AggregationKindOneOf, cx as AggregationResults, cy as AggregationResultsResultOneOf, cn as AggregationResultsScalarResult, aR as AggregationType, dF as AggregationTypeWithLiterals, cI as ApplicationError, cK as BulkActionMetadata, d0 as BulkAddSegmentToContactsRequest, d1 as BulkAddSegmentToContactsResponse, cJ as BulkContactResult, cG as BulkCreateContactsRequest, bI as BulkDelete, cU as BulkDeleteContactsByFilterRequest, cS as BulkDeleteContactsRequest, cT as BulkDeleteContactsResponseBulkContactResult, bH as BulkIndex, d2 as BulkRemoveSegmentFromContactsRequest, d3 as BulkRemoveSegmentFromContactsResponse, cY as BulkRestoreContactsFromTrashBinRequest, cZ as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bA as BulkUpdateContactSubscriptionsRequest, cP as BulkUpdateContactTagsByFilterRequest, cN as BulkUpdateContactTagsRequest, cO as BulkUpdateContactTagsResult, cL as BulkUpdateContactsRequest, cM as BulkUpdateContactsResponseBulkContactResult, db as BulkUpdatePhoneCountryCodeByFilterRequest, cQ as BulkUpsertContactsRequest, cR as BulkUpsertContactsResponseBulkContactResult, dK as CommonQueryWithEntityContext, dL as CommonSearchWithEntityContext, b7 as ContactActivity, b5 as ContactCompany, aX as ContactEmail, bm as ContactEmailSubscriptionUpdated, bo as ContactImageUploaded, bl as ContactMerged, aW as ContactName, aZ as ContactPhone, bn as ContactPhoneSubscriptionUpdated, df as ContactQuerySpec, dg as ContactSearchSpec, b6 as ContactSource, aY as ContactSubscription, de as ContactsQueryResult, cz as CountContactsRequest, bJ as CreateContactRequest, bK as CreateContactResponse, b$ as CursorPaging, c1 as CursorPagingMetadata, bY as CursorQuery, bZ as CursorQueryPagingMethodOneOf, c4 as CursorSearch, c5 as CursorSearchPagingMethodOneOf, c2 as Cursors, ce as DateHistogramAggregation, cu as DateHistogramResult, cv as DateHistogramResults, bF as Delete, cE as DeleteContactAddressRequest, bU as DeleteContactRequest, bV as DeleteContactResponse, bp as DomainEvent, bq as DomainEventBodyOneOf, bL as DuplicateContactExists, aw as EmailDeliverabilityStatus, dj as EmailDeliverabilityStatusWithLiterals, dc as Empty, br as EntityCreatedEvent, bu as EntityDeletedEvent, bt as EntityUpdatedEvent, bf as ExtendedFields, bR as FailedMemberUpdate, bW as FindMatchingContactsRequest, cA as GenerateContactImageUploadUrlRequest, da as GetContactImageUploadStatusRequest, bM as GetContactRequest, bN as GetContactResponse, c_ as GetDeletedContactRequest, bc as GroupInfo, bx as IdentificationData, by as IdentificationDataIdOneOf, aV as ImageUploadStatus, dJ as ImageUploadStatusWithLiterals, c9 as IncludeMissingValuesOptions, bE as Index, aQ as Interval, dE as IntervalWithLiterals, cH as ItemMetadata, c$ as ListDeletedContactsRequest, aH as MatchType, dv as MatchTypeWithLiterals, dd as MediaFileUploadedEvent, b8 as MemberInfo, aB as MemberStatus, dp as MemberStatusWithLiterals, bT as MergeContactsRequest, bw as MessageEnvelope, aN as MissingValues, dB as MissingValuesWithLiterals, aF as Mode, dt as ModeWithLiterals, aS as NameFormat, dG as NameFormatWithLiterals, ch as NestedAggregation, cf as NestedAggregationItem, cg as NestedAggregationItemKindOneOf, aP as NestedAggregationType, dD as NestedAggregationTypeWithLiterals, cr as NestedResultValue, cs as NestedResultValueResultOneOf, cw as NestedResults, d7 as Paging, d9 as PagingMetadataV2, ay as PhoneDeliverabilityStatus, dl as PhoneDeliverabilityStatusWithLiterals, ax as PhoneTag, dk as PhoneTagWithLiterals, aC as PrivacyStatus, dq as PrivacyStatusWithLiterals, bd as PrivateTags, b9 as ProfileInfo, d4 as QueryContactsByOffsetInternalRequest, aU as QueryContactsByOffsetInternalRequestNameFormat, dI as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d8 as QueryContactsByOffsetInternalResponse, bX as QueryContactsRequest, c0 as QueryContactsResponse, d5 as QueryV2, d6 as QueryV2PagingMethodOneOf, cc as RangeAggregation, ck as RangeAggregationResult, c8 as RangeBucket, cp as RangeResult, cm as RangeResults, b4 as Recipient, bC as ReindexEntityForFQDN, bD as ReindexEntityForFQDNActionOneOf, bg as ReindexMessage, bh as ReindexMessageActionOneOf, bj as ReindexMessageDelete, cV as RemoveContactFromTrashBinRequest, cW as RemoveContactFromTrashBinResponse, bG as ReportBatchCompleted, cX as RestoreContactFromTrashBinRequest, bs as RestoreInfo, ct as Results, aD as Role, dr as RoleWithLiterals, cd as ScalarAggregation, cq as ScalarResult, aO as ScalarType, dC as ScalarTypeWithLiterals, bk as Schema, c3 as SearchContactsRequest, bB as SearchDetails, bb as SessionInfo, aM as SortDirection, dA as SortDirectionWithLiterals, aK as SortOrder, dy as SortOrderWithLiterals, aL as SortType, dz as SortTypeWithLiterals, b_ as Sorting, b3 as StandardDetails, b0 as StreetAddress, b2 as Subdivision, aA as SubdivisionType, dn as SubdivisionTypeWithLiterals, av as SubscriptionStatus, di as SubscriptionStatusWithLiterals, be as TagList, cF as UpdateContactAddressRequest, bO as UpdateContactRequest, bP as UpdateContactResponse, bS as UpdateContactTagsRequest, bi as Upsert, bQ as UpsertContactRequest, aJ as UpsertContactResponseAction, dx as UpsertContactResponseActionWithLiterals, aI as UpsertMode, dw as UpsertModeWithLiterals, ba as UserInfo, aG as V5SubscriptionStatus, du as V5SubscriptionStatusWithLiterals, ca as ValueAggregation, cb as ValueAggregationOptionsOneOf, cj as ValueAggregationResult, co as ValueResult, cl as ValueResults, aE as WebhookIdentityType, ds as WebhookIdentityTypeWithLiterals, dh 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 UpdateContactAddress, W as UpdateContactAddressOptions, X as UpdateContactAddressResponse, Y as UpdateContactAddressApplicationErrors, Z as BulkCreateContactsOptions, _ as BulkCreateContactsResponse, $ as MaskedContact, a0 as BulkUpdateContactsOptions, a1 as BulkUpdateContactsResponse, a2 as BulkUpdateContactTagsOptions, a3 as BulkUpdateContactTagsResponse, a4 as BulkUpdateContactTagsApplicationErrors, a5 as BulkUpdateContactTagsByFilterOptions, a6 as BulkUpdateContactTagsByFilterResponse, a7 as BulkUpdateContactTagsByFilterApplicationErrors, a8 as BulkUpsertContactsRequestMaskedContact, a9 as BulkUpsertContactsOptions, aa as BulkUpsertContactsResponse, ab as BulkDeleteContactsOptions, ac as BulkDeleteContactsResponse, ad as BulkDeleteContactsApplicationErrors, ae as BulkDeleteContactsByFilterOptions, af as BulkDeleteContactsByFilterResponse, ag as BulkDeleteContactsByFilterApplicationErrors, ah as RestoreContactFromTrashBinResponse, ai as BulkRestoreContactsFromTrashBinOptions, aj as BulkRestoreContactsFromTrashBinResponse, ak as GetDeletedContactResponse, al as ListDeletedContactsOptions, am as ListDeletedContactsResponse, an as GetContactImageUploadStatusIdentifiers, ao as GetContactImageUploadStatusResponse, ap as GetContactImageUploadStatusApplicationErrors, aq as BulkUpdatePhoneCountryCodeByFilterOptions, ar as BulkUpdatePhoneCountryCodeByFilterResponse, as as ContactsQueryBuilder, at as ContactQuery, au as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-_-E4ZhZP.js';
|
|
3
|
+
export { bz as AccountInfo, aT as Action, bv as ActionEvent, dH as ActionWithLiterals, cB as AddContactAdditionalEmailRequest, cC as AddContactAdditionalPhoneRequest, cD as AddContactAddressRequest, a_ as Address, b1 as AddressLocation, a$ as AddressStreetOneOf, az as AddressTag, dm as AddressTagWithLiterals, c6 as Aggregation, ci as AggregationData, c7 as AggregationKindOneOf, cx as AggregationResults, cy as AggregationResultsResultOneOf, cn as AggregationResultsScalarResult, aR as AggregationType, dF as AggregationTypeWithLiterals, cI as ApplicationError, cK as BulkActionMetadata, d0 as BulkAddSegmentToContactsRequest, d1 as BulkAddSegmentToContactsResponse, cJ as BulkContactResult, cG as BulkCreateContactsRequest, bI as BulkDelete, cU as BulkDeleteContactsByFilterRequest, cS as BulkDeleteContactsRequest, cT as BulkDeleteContactsResponseBulkContactResult, bH as BulkIndex, d2 as BulkRemoveSegmentFromContactsRequest, d3 as BulkRemoveSegmentFromContactsResponse, cY as BulkRestoreContactsFromTrashBinRequest, cZ as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bA as BulkUpdateContactSubscriptionsRequest, cP as BulkUpdateContactTagsByFilterRequest, cN as BulkUpdateContactTagsRequest, cO as BulkUpdateContactTagsResult, cL as BulkUpdateContactsRequest, cM as BulkUpdateContactsResponseBulkContactResult, db as BulkUpdatePhoneCountryCodeByFilterRequest, cQ as BulkUpsertContactsRequest, cR as BulkUpsertContactsResponseBulkContactResult, dK as CommonQueryWithEntityContext, dL as CommonSearchWithEntityContext, b7 as ContactActivity, b5 as ContactCompany, aX as ContactEmail, bm as ContactEmailSubscriptionUpdated, bo as ContactImageUploaded, bl as ContactMerged, aW as ContactName, aZ as ContactPhone, bn as ContactPhoneSubscriptionUpdated, df as ContactQuerySpec, dg as ContactSearchSpec, b6 as ContactSource, aY as ContactSubscription, de as ContactsQueryResult, cz as CountContactsRequest, bJ as CreateContactRequest, bK as CreateContactResponse, b$ as CursorPaging, c1 as CursorPagingMetadata, bY as CursorQuery, bZ as CursorQueryPagingMethodOneOf, c4 as CursorSearch, c5 as CursorSearchPagingMethodOneOf, c2 as Cursors, ce as DateHistogramAggregation, cu as DateHistogramResult, cv as DateHistogramResults, bF as Delete, cE as DeleteContactAddressRequest, bU as DeleteContactRequest, bV as DeleteContactResponse, bp as DomainEvent, bq as DomainEventBodyOneOf, bL as DuplicateContactExists, aw as EmailDeliverabilityStatus, dj as EmailDeliverabilityStatusWithLiterals, dc as Empty, br as EntityCreatedEvent, bu as EntityDeletedEvent, bt as EntityUpdatedEvent, bf as ExtendedFields, bR as FailedMemberUpdate, bW as FindMatchingContactsRequest, cA as GenerateContactImageUploadUrlRequest, da as GetContactImageUploadStatusRequest, bM as GetContactRequest, bN as GetContactResponse, c_ as GetDeletedContactRequest, bc as GroupInfo, bx as IdentificationData, by as IdentificationDataIdOneOf, aV as ImageUploadStatus, dJ as ImageUploadStatusWithLiterals, c9 as IncludeMissingValuesOptions, bE as Index, aQ as Interval, dE as IntervalWithLiterals, cH as ItemMetadata, c$ as ListDeletedContactsRequest, aH as MatchType, dv as MatchTypeWithLiterals, dd as MediaFileUploadedEvent, b8 as MemberInfo, aB as MemberStatus, dp as MemberStatusWithLiterals, bT as MergeContactsRequest, bw as MessageEnvelope, aN as MissingValues, dB as MissingValuesWithLiterals, aF as Mode, dt as ModeWithLiterals, aS as NameFormat, dG as NameFormatWithLiterals, ch as NestedAggregation, cf as NestedAggregationItem, cg as NestedAggregationItemKindOneOf, aP as NestedAggregationType, dD as NestedAggregationTypeWithLiterals, cr as NestedResultValue, cs as NestedResultValueResultOneOf, cw as NestedResults, d7 as Paging, d9 as PagingMetadataV2, ay as PhoneDeliverabilityStatus, dl as PhoneDeliverabilityStatusWithLiterals, ax as PhoneTag, dk as PhoneTagWithLiterals, aC as PrivacyStatus, dq as PrivacyStatusWithLiterals, bd as PrivateTags, b9 as ProfileInfo, d4 as QueryContactsByOffsetInternalRequest, aU as QueryContactsByOffsetInternalRequestNameFormat, dI as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d8 as QueryContactsByOffsetInternalResponse, bX as QueryContactsRequest, c0 as QueryContactsResponse, d5 as QueryV2, d6 as QueryV2PagingMethodOneOf, cc as RangeAggregation, ck as RangeAggregationResult, c8 as RangeBucket, cp as RangeResult, cm as RangeResults, b4 as Recipient, bC as ReindexEntityForFQDN, bD as ReindexEntityForFQDNActionOneOf, bg as ReindexMessage, bh as ReindexMessageActionOneOf, bj as ReindexMessageDelete, cV as RemoveContactFromTrashBinRequest, cW as RemoveContactFromTrashBinResponse, bG as ReportBatchCompleted, cX as RestoreContactFromTrashBinRequest, bs as RestoreInfo, ct as Results, aD as Role, dr as RoleWithLiterals, cd as ScalarAggregation, cq as ScalarResult, aO as ScalarType, dC as ScalarTypeWithLiterals, bk as Schema, c3 as SearchContactsRequest, bB as SearchDetails, bb as SessionInfo, aM as SortDirection, dA as SortDirectionWithLiterals, aK as SortOrder, dy as SortOrderWithLiterals, aL as SortType, dz as SortTypeWithLiterals, b_ as Sorting, b3 as StandardDetails, b0 as StreetAddress, b2 as Subdivision, aA as SubdivisionType, dn as SubdivisionTypeWithLiterals, av as SubscriptionStatus, di as SubscriptionStatusWithLiterals, be as TagList, cF as UpdateContactAddressRequest, bO as UpdateContactRequest, bP as UpdateContactResponse, bS as UpdateContactTagsRequest, bi as Upsert, bQ as UpsertContactRequest, aJ as UpsertContactResponseAction, dx as UpsertContactResponseActionWithLiterals, aI as UpsertMode, dw as UpsertModeWithLiterals, ba as UserInfo, aG as V5SubscriptionStatus, du as V5SubscriptionStatusWithLiterals, ca as ValueAggregation, cb as ValueAggregationOptionsOneOf, cj as ValueAggregationResult, co as ValueResult, cl as ValueResults, aE as WebhookIdentityType, ds as WebhookIdentityTypeWithLiterals, dh as utils } from './contacts-v5-contact-contacts-v-5.universal-_-E4ZhZP.js';
|
|
4
4
|
|
|
5
5
|
declare function bulkUpdateContactSubscriptions$1(httpClient: HttpClient): BulkUpdateContactSubscriptionsSignature;
|
|
6
6
|
interface BulkUpdateContactSubscriptionsSignature {
|
|
@@ -319,16 +319,17 @@ interface BulkUpdateContactTagsSignature {
|
|
|
319
319
|
declare function bulkUpdateContactTagsByFilter$1(httpClient: HttpClient): BulkUpdateContactTagsByFilterSignature;
|
|
320
320
|
interface BulkUpdateContactTagsByFilterSignature {
|
|
321
321
|
/**
|
|
322
|
-
* Adds or removes tags on multiple contacts that match the provided filter. Works asynchronously.
|
|
322
|
+
* Adds or removes tags on multiple contacts that match the provided filter. Works asynchronously.
|
|
323
|
+
*
|
|
324
|
+
* All contacts that meet the specified `filter` and `search` criteria are updated. The request must contain a `filter` value, a `search` value, or both. An empty `filter` (`{}`) without a `search` value matches all contacts.
|
|
323
325
|
*
|
|
324
326
|
* 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.
|
|
325
327
|
*
|
|
326
328
|
* 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).
|
|
327
329
|
*
|
|
328
330
|
* 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).
|
|
329
|
-
* @param - 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).
|
|
330
331
|
*/
|
|
331
|
-
(
|
|
332
|
+
(options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`, 0> & {
|
|
332
333
|
__applicationErrorsType?: BulkUpdateContactTagsByFilterApplicationErrors;
|
|
333
334
|
}>;
|
|
334
335
|
}
|
|
@@ -372,7 +373,7 @@ interface BulkDeleteContactsByFilterSignature {
|
|
|
372
373
|
/**
|
|
373
374
|
* Deletes multiple contacts that match the provided filter. Works asynchronously.
|
|
374
375
|
*
|
|
375
|
-
* All contacts that meet the specified `filter` and `search` criteria are deleted. The request must contain a `filter` value, a `search` value, or both. To preview which contacts match before deleting, call [Search Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/search-contacts) with the same criteria.
|
|
376
|
+
* All contacts that meet the specified `filter` and `search` criteria are deleted. The request must contain a `filter` value, a `search` value, or both. An empty `filter` (`{}`) without a `search` value matches all contacts, so all of the site's contacts are deleted. To preview which contacts match before deleting, call [Search Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/search-contacts) with the same criteria.
|
|
376
377
|
*
|
|
377
378
|
* To check the status of the bulk deletion, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
378
379
|
*
|
|
@@ -384,12 +385,8 @@ interface BulkDeleteContactsByFilterSignature {
|
|
|
384
385
|
* - `CANNOT_DELETE_WIX_USERS_MEMBER`: Site member can't be deleted because it's the owner or a contributor.
|
|
385
386
|
* - `FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION`: Site member was deleted, but the contact was not.
|
|
386
387
|
* - `FAILED_DELETE_CONTACT`: Contact couldn't be deleted.
|
|
387
|
-
* @param - Filter object.
|
|
388
|
-
*
|
|
389
|
-
* Example:
|
|
390
|
-
* `{ "filter": { "name.last": "Smith" } }`
|
|
391
388
|
*/
|
|
392
|
-
(
|
|
389
|
+
(options?: BulkDeleteContactsByFilterOptions): Promise<NonNullablePaths<BulkDeleteContactsByFilterResponse, `jobId`, 0> & {
|
|
393
390
|
__applicationErrorsType?: BulkDeleteContactsByFilterApplicationErrors;
|
|
394
391
|
}>;
|
|
395
392
|
}
|
package/build/cjs/index.js
CHANGED
|
@@ -2541,10 +2541,10 @@ async function bulkUpdateContactTags2(contactIds, options) {
|
|
|
2541
2541
|
throw transformedError;
|
|
2542
2542
|
}
|
|
2543
2543
|
}
|
|
2544
|
-
async function bulkUpdateContactTagsByFilter2(
|
|
2545
|
-
const { httpClient, sideEffects } = arguments[
|
|
2544
|
+
async function bulkUpdateContactTagsByFilter2(options) {
|
|
2545
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
2546
2546
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
|
|
2547
|
-
filter,
|
|
2547
|
+
filter: options?.filter,
|
|
2548
2548
|
search: options?.search,
|
|
2549
2549
|
assignTags: options?.assignTags,
|
|
2550
2550
|
unassignTags: options?.unassignTags
|
|
@@ -2561,14 +2561,14 @@ async function bulkUpdateContactTagsByFilter2(filter, options) {
|
|
|
2561
2561
|
{
|
|
2562
2562
|
spreadPathsToArguments: {},
|
|
2563
2563
|
explicitPathsToArguments: {
|
|
2564
|
-
filter: "$[0]",
|
|
2565
|
-
search: "$[
|
|
2566
|
-
assignTags: "$[
|
|
2567
|
-
unassignTags: "$[
|
|
2564
|
+
filter: "$[0].filter",
|
|
2565
|
+
search: "$[0].search",
|
|
2566
|
+
assignTags: "$[0].assignTags",
|
|
2567
|
+
unassignTags: "$[0].unassignTags"
|
|
2568
2568
|
},
|
|
2569
2569
|
singleArgumentUnchanged: false
|
|
2570
2570
|
},
|
|
2571
|
-
["
|
|
2571
|
+
["options"]
|
|
2572
2572
|
);
|
|
2573
2573
|
sideEffects?.onError?.(err);
|
|
2574
2574
|
throw transformedError;
|
|
@@ -2659,10 +2659,10 @@ async function bulkDeleteContacts2(contactIds, options) {
|
|
|
2659
2659
|
throw transformedError;
|
|
2660
2660
|
}
|
|
2661
2661
|
}
|
|
2662
|
-
async function bulkDeleteContactsByFilter2(
|
|
2663
|
-
const { httpClient, sideEffects } = arguments[
|
|
2662
|
+
async function bulkDeleteContactsByFilter2(options) {
|
|
2663
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
2664
2664
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
|
|
2665
|
-
filter,
|
|
2665
|
+
filter: options?.filter,
|
|
2666
2666
|
search: options?.search,
|
|
2667
2667
|
deleteMembers: options?.deleteMembers
|
|
2668
2668
|
});
|
|
@@ -2678,13 +2678,13 @@ async function bulkDeleteContactsByFilter2(filter, options) {
|
|
|
2678
2678
|
{
|
|
2679
2679
|
spreadPathsToArguments: {},
|
|
2680
2680
|
explicitPathsToArguments: {
|
|
2681
|
-
filter: "$[0]",
|
|
2682
|
-
search: "$[
|
|
2683
|
-
deleteMembers: "$[
|
|
2681
|
+
filter: "$[0].filter",
|
|
2682
|
+
search: "$[0].search",
|
|
2683
|
+
deleteMembers: "$[0].deleteMembers"
|
|
2684
2684
|
},
|
|
2685
2685
|
singleArgumentUnchanged: false
|
|
2686
2686
|
},
|
|
2687
|
-
["
|
|
2687
|
+
["options"]
|
|
2688
2688
|
);
|
|
2689
2689
|
sideEffects?.onError?.(err);
|
|
2690
2690
|
throw transformedError;
|
|
@@ -3115,8 +3115,7 @@ function bulkUpdateContactTags3(httpClient) {
|
|
|
3115
3115
|
);
|
|
3116
3116
|
}
|
|
3117
3117
|
function bulkUpdateContactTagsByFilter3(httpClient) {
|
|
3118
|
-
return (
|
|
3119
|
-
filter,
|
|
3118
|
+
return (options) => bulkUpdateContactTagsByFilter2(
|
|
3120
3119
|
options,
|
|
3121
3120
|
// @ts-ignore
|
|
3122
3121
|
{ httpClient }
|
|
@@ -3139,8 +3138,7 @@ function bulkDeleteContacts3(httpClient) {
|
|
|
3139
3138
|
);
|
|
3140
3139
|
}
|
|
3141
3140
|
function bulkDeleteContactsByFilter3(httpClient) {
|
|
3142
|
-
return (
|
|
3143
|
-
filter,
|
|
3141
|
+
return (options) => bulkDeleteContactsByFilter2(
|
|
3144
3142
|
options,
|
|
3145
3143
|
// @ts-ignore
|
|
3146
3144
|
{ httpClient }
|