@wix/auto_sdk_crm_contacts 1.0.399 → 1.0.401

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { ContactInfo, CreateContactOptions, CreateContactResponse, CreateContactApplicationErrors, UpdateContactOptions, UpdateContactResponse, UpdateContactApplicationErrors, MergeContactsOptions, MergeContactsResponse, MergeContactsApplicationErrors, DeleteContactApplicationErrors, LabelContactResponse, LabelContactApplicationErrors, UnlabelContactResponse, UnlabelContactApplicationErrors, QueryContactsOptions, ContactsQueryBuilder, GetContactOptions, Contact, GetContactApplicationErrors, ContactCreatedEnvelope, ContactDeletedEnvelope, ContactMergedEnvelope, ContactUpdatedEnvelope } from './index.typings.js';
 export { Action, ActionEvent, ActivityIcon, Address, AddressLocation, AddressStreetOneOf, AddressTag, ApplicationError, AssigneesWrapper, BaseEventMetadata, BulkActionMetadata, BulkAddSegmentToContactsRequest, BulkAddSegmentToContactsResponse, BulkDeleteContactsRequest, BulkDeleteContactsResponse, BulkLabelAndUnlabelContactsRequest, BulkLabelAndUnlabelContactsResponse, BulkRemoveSegmentFromContactsRequest, BulkRemoveSegmentFromContactsResponse, BulkUpdateContactsRequest, BulkUpdateContactsResponse, BulkUpsertContactsRequest, BulkUpsertContactsResponse, BulkUpsertContactsResponseMetadata, ContactActivity, ContactActivityType, ContactAddedToSegment, ContactAddress, ContactAddressesWrapper, ContactChanged, ContactEmail, ContactEmailSubscriptionUpdated, ContactEmailsWrapper, ContactFieldSet, ContactMerged, ContactName, ContactPhone, ContactPhoneSubscriptionUpdated, ContactPhonesWrapper, ContactPicture, ContactPrimaryInfoUpdated, ContactRemovedFromSegment, ContactSource, ContactSourceType, ContactSubmitted, ContactsFacet, ContactsFacetType, ContactsQueryResult, CountContactsRequest, CountContactsResponse, CreateContactRequest, CursorPaging, CursorPagingMetadata, Cursors, DeleteContactRequest, DeleteContactResponse, DomainEvent, DomainEventBodyOneOf, DuplicateContactExists, EmailDeliverabilityStatus, EmailTag, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Error, EventMetadata, ExtendedFieldsWrapper, GeneratePictureUploadUrlRequest, GeneratePictureUploadUrlResponse, GetContactRequest, GetContactResponse, GetContactResponseType, GroupInfo, IdentificationData, IdentificationDataIdOneOf, ImageProvider, Item, ItemMetadata, LabelAndUnlabelContactRequest, LabelAndUnlabelContactResponse, LabelContactRequest, LabelsWrapper, LastActivityUpdate, ListContactIdsBySegmentRequest, ListContactIdsBySegmentResponse, ListContactsRequest, ListContactsResponse, ListFacetsRequest, ListFacetsResponse, LocationsWrapper, MemberInfo, MemberStatus, MergeContactsRequest, MessageEnvelope, Metadata, Mode, Paging, PagingMetadata, PhoneDeliverabilityStatus, PhoneTag, PreviewMergeContactsRequest, PreviewMergeContactsResponse, PrimaryContactInfo, PrimaryEmail, PrimaryPhone, PrimarySubscriptionStatus, PrivacyStatus, ProfileInfo, Query, QueryContactsRequest, QueryContactsResponse, QueryFacetsRequest, QueryFacetsResponse, RestoreInfo, Role, Search, SearchContactsRequest, SearchContactsResponse, SearchDetails, SearchPagingMethodOneOf, SegmentsWrapper, SessionInfo, SortOrder, Sorting, StreetAddress, Subdivision, SubdivisionType, SubmitOperation, SubscriptionStatus, SyncSubmitContactRequest, SyncSubmitContactResponse, UnlabelContactRequest, UpdateContactRequest, UpsertContactRequest, UpsertContactResponse, UpsertContactResponseAction, UserInfo, WebhookIdentityType } from './index.typings.js';
 
+type ContactNonNullablePaths = `_id` | `revision` | `source.sourceType` | `lastActivity.activityType` | `info.emails.items` | `info.emails.items.${number}.tag` | `info.emails.items.${number}.email` | `info.phones.items` | `info.phones.items.${number}.tag` | `info.phones.items.${number}.phone` | `info.addresses.items` | `info.addresses.items.${number}.tag` | `info.addresses.items.${number}.address.streetAddress.number` | `info.addresses.items.${number}.address.streetAddress.name` | `info.labelKeys.items` | `primaryEmail.subscriptionStatus` | `primaryEmail.deliverabilityStatus` | `primaryPhone.subscriptionStatus`;
 declare function createContact$1(httpClient: HttpClient): CreateContactSignature;
 interface CreateContactSignature {
     /**
@@ -18,8 +19,10 @@ interface CreateContactSignature {
      * @param - Create contact options.
      * @returns Contact.
      */
-    (info: ContactInfo, options?: CreateContactOptions | undefined): Promise<CreateContactResponse & {
-        __applicationErrorsType?: CreateContactApplicationErrors | undefined;
+    (info: ContactInfo, options?: CreateContactOptions): Promise<NonNullablePaths<CreateContactResponse, {
+        [P in ContactNonNullablePaths]: `contact.${P}`;
+    }[ContactNonNullablePaths]> & {
+        __applicationErrorsType?: CreateContactApplicationErrors;
     }>;
 }
 declare function updateContact$1(httpClient: HttpClient): UpdateContactSignature;
@@ -45,8 +48,10 @@ interface UpdateContactSignature {
      * @param - Contact update options.
      * @returns Updated contact.
      */
-    (contactId: string, info: ContactInfo, revision: number, options?: UpdateContactOptions | undefined): Promise<UpdateContactResponse & {
-        __applicationErrorsType?: UpdateContactApplicationErrors | undefined;
+    (contactId: string, info: ContactInfo, revision: number, options?: UpdateContactOptions): Promise<NonNullablePaths<UpdateContactResponse, {
+        [P in ContactNonNullablePaths]: `contact.${P}`;
+    }[ContactNonNullablePaths]> & {
+        __applicationErrorsType?: UpdateContactApplicationErrors;
     }>;
 }
 declare function mergeContacts$1(httpClient: HttpClient): MergeContactsSignature;
@@ -88,8 +93,10 @@ interface MergeContactsSignature {
      * the target contact's current `revision` must be specified.
      * @param - Merge contacts options.
      */
-    (targetContactId: string, targetContactRevision: number, options?: MergeContactsOptions | undefined): Promise<MergeContactsResponse & {
-        __applicationErrorsType?: MergeContactsApplicationErrors | undefined;
+    (targetContactId: string, targetContactRevision: number, options?: MergeContactsOptions): Promise<NonNullablePaths<MergeContactsResponse, {
+        [P in ContactNonNullablePaths]: `contact.${P}`;
+    }[ContactNonNullablePaths]> & {
+        __applicationErrorsType?: MergeContactsApplicationErrors;
     }>;
 }
 declare function deleteContact$1(httpClient: HttpClient): DeleteContactSignature;
@@ -107,7 +114,7 @@ interface DeleteContactSignature {
      * @param - ID of the contact to delete.
      */
     (contactId: string): Promise<void & {
-        __applicationErrorsType?: DeleteContactApplicationErrors | undefined;
+        __applicationErrorsType?: DeleteContactApplicationErrors;
     }>;
 }
 declare function labelContact$1(httpClient: HttpClient): LabelContactSignature;
@@ -126,8 +133,10 @@ interface LabelContactSignature {
      * Use the Labels API to create or retrieve labels.
      * @returns Updated contact.
      */
-    (contactId: string, labelKeys: string[]): Promise<LabelContactResponse & {
-        __applicationErrorsType?: LabelContactApplicationErrors | undefined;
+    (contactId: string, labelKeys: string[]): Promise<NonNullablePaths<LabelContactResponse, {
+        [P in ContactNonNullablePaths]: `contact.${P}`;
+    }[ContactNonNullablePaths]> & {
+        __applicationErrorsType?: LabelContactApplicationErrors;
     }>;
 }
 declare function unlabelContact$1(httpClient: HttpClient): UnlabelContactSignature;
@@ -145,8 +154,10 @@ interface UnlabelContactSignature {
      * @param - List of label keys to remove from the contact.
      * @returns Updated contact.
      */
-    (contactId: string, labelKeys: string[]): Promise<UnlabelContactResponse & {
-        __applicationErrorsType?: UnlabelContactApplicationErrors | undefined;
+    (contactId: string, labelKeys: string[]): Promise<NonNullablePaths<UnlabelContactResponse, {
+        [P in ContactNonNullablePaths]: `contact.${P}`;
+    }[ContactNonNullablePaths]> & {
+        __applicationErrorsType?: UnlabelContactApplicationErrors;
     }>;
 }
 declare function queryContacts$1(httpClient: HttpClient): QueryContactsSignature;
@@ -169,7 +180,7 @@ interface QueryContactsSignature {
      * The functions that are chained to `queryContacts()` are applied in the order they are called. For example, if you apply `ascending('info.company')` and then `descending('info.name.last')`, the results are sorted first by the company name, and then, if there are multiple results with the same company, the items are sorted by last name.
      * @param - Query contact options.
      */
-    (options?: QueryContactsOptions | undefined): ContactsQueryBuilder;
+    (options?: QueryContactsOptions): ContactsQueryBuilder;
 }
 declare function getContact$1(httpClient: HttpClient): GetContactSignature;
 interface GetContactSignature {
@@ -190,8 +201,8 @@ interface GetContactSignature {
      * @param - Get contact options.
      * @returns The requested contact.
      */
-    (_id: string, options?: GetContactOptions | undefined): Promise<Contact & {
-        __applicationErrorsType?: GetContactApplicationErrors | undefined;
+    (_id: string, options?: GetContactOptions): Promise<NonNullablePaths<Contact, ContactNonNullablePaths> & {
+        __applicationErrorsType?: GetContactApplicationErrors;
     }>;
 }
 declare const onContactCreated$1: EventDefinition<ContactCreatedEnvelope, "wix.contacts.v4.contact_created">;