@wix/auto_sdk_crm_contacts-v-5 1.0.0

package/build/internal/cjs/index.typings.d.ts

@@ -0,0 +1,38 @@
+import { c3 as CursorSearch, S as SearchContactsOptions, s as SearchContactsResponse } from './contacts-v5-contact-contacts-v-5.universal-78Io5ULf.js';
+export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, z as AddContactAdditionalEmailApplicationErrors, x as AddContactAdditionalEmailOptions, cA as AddContactAdditionalEmailRequest, y as AddContactAdditionalEmailResponse, J as AddContactAdditionalPhoneApplicationErrors, H as AddContactAdditionalPhoneOptions, cB as AddContactAdditionalPhoneRequest, I as AddContactAdditionalPhoneResponse, O as AddContactAddressApplicationErrors, L as AddContactAddressOptions, cC as AddContactAddressRequest, N as AddContactAddressResponse, A as AdditionalEmail, E as AdditionalPhone, 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, Y as BulkCreateContactsOptions, cF as BulkCreateContactsRequest, Z as BulkCreateContactsResponse, bH as BulkDelete, ac as BulkDeleteContactsApplicationErrors, af as BulkDeleteContactsByFilterApplicationErrors, ad as BulkDeleteContactsByFilterOptions, cT as BulkDeleteContactsByFilterRequest, ae as BulkDeleteContactsByFilterResponse, aa as BulkDeleteContactsOptions, cR as BulkDeleteContactsRequest, ab as BulkDeleteContactsResponse, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, ah as BulkRestoreContactsFromTrashBinOptions, cX as BulkRestoreContactsFromTrashBinRequest, ai as BulkRestoreContactsFromTrashBinResponse, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, b as BulkUpdateContactSubscriptionsApplicationErrors, B as BulkUpdateContactSubscriptionsOptions, bz as BulkUpdateContactSubscriptionsRequest, a as BulkUpdateContactSubscriptionsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, cO as BulkUpdateContactTagsByFilterRequest, a5 as BulkUpdateContactTagsByFilterResponse, a1 as BulkUpdateContactTagsOptions, cM as BulkUpdateContactTagsRequest, a2 as BulkUpdateContactTagsResponse, cN as BulkUpdateContactTagsResult, $ as BulkUpdateContactsOptions, cK as BulkUpdateContactsRequest, a0 as BulkUpdateContactsResponse, cL as BulkUpdateContactsResponseBulkContactResult, ap as BulkUpdatePhoneCountryCodeByFilterOptions, da as BulkUpdatePhoneCountryCodeByFilterRequest, aq as BulkUpdatePhoneCountryCodeByFilterResponse, a8 as BulkUpsertContactsOptions, cP as BulkUpsertContactsRequest, a7 as BulkUpsertContactsRequestMaskedContact, a9 as BulkUpsertContactsResponse, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, C as Contact, b6 as ContactActivity, K as ContactAddress, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, as as ContactQuery, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, ar as ContactsQueryBuilder, dd as ContactsQueryResult, t as CountContactsOptions, cy as CountContactsRequest, u as CountContactsResponse, d as CreateContactApplicationErrors, c as CreateContactOptions, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, R as DeleteContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, cD as DeleteContactAddressRequest, Q as DeleteContactAddressResponse, o as DeleteContactApplicationErrors, D as DeleteContactOptions, 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, q as FindMatchingContactsApplicationErrors, F as FindMatchingContactsOptions, bV as FindMatchingContactsRequest, p as FindMatchingContactsResponse, w as GenerateContactImageUploadUrlApplicationErrors, G as GenerateContactImageUploadUrlOptions, cz as GenerateContactImageUploadUrlRequest, v as GenerateContactImageUploadUrlResponse, ao as GetContactImageUploadStatusApplicationErrors, am as GetContactImageUploadStatusIdentifiers, d9 as GetContactImageUploadStatusRequest, an as GetContactImageUploadStatusResponse, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, aj as GetDeletedContactResponse, 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, ak as ListDeletedContactsOptions, c_ as ListDeletedContactsRequest, al as ListDeletedContactsResponse, _ as MaskedContact, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, n as MergeContactsApplicationErrors, M as MergeContactsOptions, bS as MergeContactsRequest, m as MergeContactsResponse, 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, ag as RestoreContactFromTrashBinResponse, 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, U as UpdateContact, X as UpdateContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, cE as UpdateContactAddressRequest, W as UpdateContactAddressResponse, f as UpdateContactApplicationErrors, e as UpdateContactOptions, bN as UpdateContactRequest, bO as UpdateContactResponse, l as UpdateContactTagsApplicationErrors, j as UpdateContactTagsOptions, bR as UpdateContactTagsRequest, k as UpdateContactTagsResponse, bh as Upsert, i as UpsertContactApplicationErrors, g as UpsertContactOptions, bP as UpsertContactRequest, h as UpsertContactResponse, 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, dX as addContactAdditionalEmail, dY as addContactAdditionalPhone, dZ as addContactAddress, e0 as bulkCreateContacts, e5 as bulkDeleteContacts, e6 as bulkDeleteContactsByFilter, e9 as bulkRestoreContactsFromTrashBin, dL as bulkUpdateContactSubscriptions, e2 as bulkUpdateContactTags, e3 as bulkUpdateContactTagsByFilter, e1 as bulkUpdateContacts, ed as bulkUpdatePhoneCountryCodeByFilter, e4 as bulkUpsertContacts, dV as countContacts, dM as createContact, dS as deleteContact, d_ as deleteContactAddress, dT as findMatchingContacts, dW as generateContactImageUploadUrl, dN as getContact, ec as getContactImageUploadStatus, ea as getDeletedContact, eb as listDeletedContacts, dR as mergeContacts, dU as queryContacts, e7 as removeContactFromTrashBin, e8 as restoreContactFromTrashBin, at as typedQueryContacts, dO as updateContact, d$ as updateContactAddress, dQ as updateContactTags, dP as upsertContact, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-78Io5ULf.js';
+import '@wix/sdk-types';
+
+/** @hidden */
+type ContactSearch = {};
+/**
+ * Searches contacts using free-text search combined with filtering and sorting.
+ *
+ * *Search Capabilities:**
+ * - Free-text search across multiple contact fields
+ * - Advanced filtering using WQL (Wix Query Language)
+ * - Flexible sorting options with name format control
+ * - Cursor-based pagination for large result sets
+ *
+ * *Searchable Fields:**
+ * - Full name, first name, last name
+ * - Email (main only)
+ * - Phone (main only)
+ * - Company name and job title
+ * - Member nickname
+ *
+ * *Name Formatting:** Control how names are displayed and sorted:
+ * - BY_FIRST_NAME: "John Smith" format
+ * - BY_LAST_NAME: "Smith, John" format
+ *
+ * Learn more: [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language)
+ * @param search - WQL search expression
+ * @public
+ * @documentationMaturity preview
+ * @requiredField search
+ * @permissionId CONTACTS.CONTACT_READ
+ * @applicableIdentity APP
+ * @fqn wix.contacts.v5.Contacts.SearchContacts
+ */
+declare function searchContacts(search: CursorSearch, options: SearchContactsOptions): Promise<SearchContactsResponse>;
+
+export { type ContactSearch, CursorSearch, SearchContactsOptions, SearchContactsResponse, searchContacts };