@wix/auto_sdk_crm_contacts 1.0.1356 → 1.0.1358
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/index.d.ts +13 -13
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +14 -14
- package/build/cjs/index.typings.js.map +1 -1
- package/build/es/index.d.mts +13 -13
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +14 -14
- package/build/es/index.typings.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +13 -13
- package/build/internal/cjs/index.typings.d.ts +14 -14
- package/build/internal/es/index.d.mts +13 -13
- package/build/internal/es/index.typings.d.mts +14 -14
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -18,7 +18,7 @@ interface CreateContactSignature {
|
|
|
18
18
|
* @param - Create contact options.
|
|
19
19
|
* @returns Contact.
|
|
20
20
|
*/
|
|
21
|
-
(info: ContactInfo, options?: CreateContactOptions): Promise<NonNullablePaths<CreateContactResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`,
|
|
21
|
+
(info: ContactInfo, options?: CreateContactOptions): Promise<NonNullablePaths<CreateContactResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`, 7> & {
|
|
22
22
|
__applicationErrorsType?: CreateContactApplicationErrors;
|
|
23
23
|
}>;
|
|
24
24
|
}
|
|
@@ -45,7 +45,7 @@ interface UpdateContactSignature {
|
|
|
45
45
|
* @param - Contact update options.
|
|
46
46
|
* @returns Updated contact.
|
|
47
47
|
*/
|
|
48
|
-
(contactId: string, info: ContactInfo, revision: number, options?: UpdateContactOptions): Promise<NonNullablePaths<UpdateContactResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`,
|
|
48
|
+
(contactId: string, info: ContactInfo, revision: number, options?: UpdateContactOptions): Promise<NonNullablePaths<UpdateContactResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`, 7> & {
|
|
49
49
|
__applicationErrorsType?: UpdateContactApplicationErrors;
|
|
50
50
|
}>;
|
|
51
51
|
}
|
|
@@ -88,7 +88,7 @@ interface MergeContactsSignature {
|
|
|
88
88
|
* the target contact's current `revision` must be specified.
|
|
89
89
|
* @param - Merge contacts options.
|
|
90
90
|
*/
|
|
91
|
-
(targetContactId: string, targetContactRevision: number, options?: MergeContactsOptions): Promise<NonNullablePaths<MergeContactsResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`,
|
|
91
|
+
(targetContactId: string, targetContactRevision: number, options?: MergeContactsOptions): Promise<NonNullablePaths<MergeContactsResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`, 7> & {
|
|
92
92
|
__applicationErrorsType?: MergeContactsApplicationErrors;
|
|
93
93
|
}>;
|
|
94
94
|
}
|
|
@@ -105,7 +105,7 @@ interface PreviewMergeContactsSignature {
|
|
|
105
105
|
* @param - Target contact ID.
|
|
106
106
|
* @param - Preview merge contacts options.
|
|
107
107
|
*/
|
|
108
|
-
(targetContactId: string, options?: PreviewMergeContactsOptions): Promise<NonNullablePaths<PreviewMergeContactsResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`,
|
|
108
|
+
(targetContactId: string, options?: PreviewMergeContactsOptions): Promise<NonNullablePaths<PreviewMergeContactsResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`, 7> & {
|
|
109
109
|
__applicationErrorsType?: PreviewMergeContactsApplicationErrors;
|
|
110
110
|
}>;
|
|
111
111
|
}
|
|
@@ -143,7 +143,7 @@ interface LabelContactSignature {
|
|
|
143
143
|
* Use the Labels API to create or retrieve labels.
|
|
144
144
|
* @returns Updated contact.
|
|
145
145
|
*/
|
|
146
|
-
(contactId: string, labelKeys: string[]): Promise<NonNullablePaths<LabelContactResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`,
|
|
146
|
+
(contactId: string, labelKeys: string[]): Promise<NonNullablePaths<LabelContactResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`, 7> & {
|
|
147
147
|
__applicationErrorsType?: LabelContactApplicationErrors;
|
|
148
148
|
}>;
|
|
149
149
|
}
|
|
@@ -162,7 +162,7 @@ interface UnlabelContactSignature {
|
|
|
162
162
|
* @param - List of label keys to remove from the contact.
|
|
163
163
|
* @returns Updated contact.
|
|
164
164
|
*/
|
|
165
|
-
(contactId: string, labelKeys: string[]): Promise<NonNullablePaths<UnlabelContactResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`,
|
|
165
|
+
(contactId: string, labelKeys: string[]): Promise<NonNullablePaths<UnlabelContactResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`, 7> & {
|
|
166
166
|
__applicationErrorsType?: UnlabelContactApplicationErrors;
|
|
167
167
|
}>;
|
|
168
168
|
}
|
|
@@ -173,7 +173,7 @@ interface ListContactsSignature {
|
|
|
173
173
|
* @param - Object containing list of options for retrieving contacts.
|
|
174
174
|
* @returns List of contacts.
|
|
175
175
|
*/
|
|
176
|
-
(options?: ListContactsOptions): Promise<NonNullablePaths<ListContactsResponse, `contacts` | `contacts.${number}._id` | `contacts.${number}.revision` | `contacts.${number}.source.sourceType` | `contacts.${number}.lastActivity.activityType` | `contacts.${number}.primaryEmail.subscriptionStatus` | `contacts.${number}.primaryEmail.deliverabilityStatus` | `contacts.${number}.primaryPhone.subscriptionStatus`,
|
|
176
|
+
(options?: ListContactsOptions): Promise<NonNullablePaths<ListContactsResponse, `contacts` | `contacts.${number}._id` | `contacts.${number}.revision` | `contacts.${number}.source.sourceType` | `contacts.${number}.lastActivity.activityType` | `contacts.${number}.primaryEmail.subscriptionStatus` | `contacts.${number}.primaryEmail.deliverabilityStatus` | `contacts.${number}.primaryPhone.subscriptionStatus`, 3> & {
|
|
177
177
|
__applicationErrorsType?: ListContactsApplicationErrors;
|
|
178
178
|
}>;
|
|
179
179
|
}
|
|
@@ -184,7 +184,7 @@ interface ListFacetsSignature {
|
|
|
184
184
|
* Facets include labels and subscription statuses.
|
|
185
185
|
* @param - List facets options.
|
|
186
186
|
*/
|
|
187
|
-
(options?: ListFacetsOptions): Promise<NonNullablePaths<ListFacetsResponse, `facets` | `facets.${number}.facetType`,
|
|
187
|
+
(options?: ListFacetsOptions): Promise<NonNullablePaths<ListFacetsResponse, `facets` | `facets.${number}.facetType`, 2>>;
|
|
188
188
|
}
|
|
189
189
|
declare function queryFacets$1(httpClient: HttpClient): QueryFacetsSignature;
|
|
190
190
|
interface QueryFacetsSignature {
|
|
@@ -193,7 +193,7 @@ interface QueryFacetsSignature {
|
|
|
193
193
|
* Facets include labels and subscription statuses.
|
|
194
194
|
* @param - Query facets options.
|
|
195
195
|
*/
|
|
196
|
-
(options?: QueryFacetsOptions): Promise<NonNullablePaths<QueryFacetsResponse, `facets` | `facets.${number}.facetType`,
|
|
196
|
+
(options?: QueryFacetsOptions): Promise<NonNullablePaths<QueryFacetsResponse, `facets` | `facets.${number}.facetType`, 2>>;
|
|
197
197
|
}
|
|
198
198
|
declare function bulkDeleteContacts$1(httpClient: HttpClient): BulkDeleteContactsSignature;
|
|
199
199
|
interface BulkDeleteContactsSignature {
|
|
@@ -216,7 +216,7 @@ interface BulkDeleteContactsSignature {
|
|
|
216
216
|
* - `FAILED_DELETE_CONTACT` - Contact could not be deleted.
|
|
217
217
|
* @param - Bulk delete contacts options.
|
|
218
218
|
*/
|
|
219
|
-
(options?: BulkDeleteContactsOptions): Promise<NonNullablePaths<BulkDeleteContactsResponse, `jobId`,
|
|
219
|
+
(options?: BulkDeleteContactsOptions): Promise<NonNullablePaths<BulkDeleteContactsResponse, `jobId`, 0> & {
|
|
220
220
|
__applicationErrorsType?: BulkDeleteContactsApplicationErrors;
|
|
221
221
|
}>;
|
|
222
222
|
}
|
|
@@ -235,7 +235,7 @@ interface BulkUpdateContactsSignature {
|
|
|
235
235
|
* The job's status can be retrieved with Get Bulk Job.
|
|
236
236
|
* @param - Bulk update contacts options.
|
|
237
237
|
*/
|
|
238
|
-
(options?: BulkUpdateContactsOptions): Promise<NonNullablePaths<BulkUpdateContactsResponse, `jobId`,
|
|
238
|
+
(options?: BulkUpdateContactsOptions): Promise<NonNullablePaths<BulkUpdateContactsResponse, `jobId`, 0>>;
|
|
239
239
|
}
|
|
240
240
|
declare function bulkLabelAndUnlabelContacts$1(httpClient: HttpClient): BulkLabelAndUnlabelContactsSignature;
|
|
241
241
|
interface BulkLabelAndUnlabelContactsSignature {
|
|
@@ -252,7 +252,7 @@ interface BulkLabelAndUnlabelContactsSignature {
|
|
|
252
252
|
* The job's status can be retrieved with Get Bulk Job.
|
|
253
253
|
* @param - Bulk label and unlabel contacts options.
|
|
254
254
|
*/
|
|
255
|
-
(options?: BulkLabelAndUnlabelContactsOptions): Promise<NonNullablePaths<BulkLabelAndUnlabelContactsResponse, `jobId`,
|
|
255
|
+
(options?: BulkLabelAndUnlabelContactsOptions): Promise<NonNullablePaths<BulkLabelAndUnlabelContactsResponse, `jobId`, 0> & {
|
|
256
256
|
__applicationErrorsType?: BulkLabelAndUnlabelContactsApplicationErrors;
|
|
257
257
|
}>;
|
|
258
258
|
}
|
|
@@ -275,7 +275,7 @@ interface GetContactSignature {
|
|
|
275
275
|
* @param - Get contact options.
|
|
276
276
|
* @returns The requested contact.
|
|
277
277
|
*/
|
|
278
|
-
(_id: string, options?: GetContactOptions): Promise<NonNullablePaths<Contact, `_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`,
|
|
278
|
+
(_id: string, options?: GetContactOptions): Promise<NonNullablePaths<Contact, `_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`, 6> & {
|
|
279
279
|
__applicationErrorsType?: GetContactApplicationErrors;
|
|
280
280
|
}>;
|
|
281
281
|
}
|