@wix/crm 1.0.125 → 1.0.126
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/package.json +8 -8
- package/type-bundles/context.bundle.d.ts +637 -180
- package/type-bundles/index.bundle.d.ts +637 -180
|
@@ -1,3 +1,47 @@
|
|
|
1
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
|
+
interface HttpClient {
|
|
3
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
|
+
fetchWithAuth: typeof fetch;
|
|
5
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
6
|
+
}
|
|
7
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
|
+
type HttpResponse<T = any> = {
|
|
9
|
+
data: T;
|
|
10
|
+
status: number;
|
|
11
|
+
statusText: string;
|
|
12
|
+
headers: any;
|
|
13
|
+
request?: any;
|
|
14
|
+
};
|
|
15
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
16
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
17
|
+
url: string;
|
|
18
|
+
data?: Data;
|
|
19
|
+
params?: URLSearchParams;
|
|
20
|
+
} & APIMetadata;
|
|
21
|
+
type APIMetadata = {
|
|
22
|
+
methodFqn?: string;
|
|
23
|
+
entityFqdn?: string;
|
|
24
|
+
packageName?: string;
|
|
25
|
+
};
|
|
26
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
+
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
28
|
+
__type: 'event-definition';
|
|
29
|
+
type: Type;
|
|
30
|
+
isDomainEvent?: boolean;
|
|
31
|
+
transformations?: (envelope: unknown) => Payload;
|
|
32
|
+
__payload: Payload;
|
|
33
|
+
};
|
|
34
|
+
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
35
|
+
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
36
|
+
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
37
|
+
|
|
38
|
+
declare global {
|
|
39
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
40
|
+
interface SymbolConstructor {
|
|
41
|
+
readonly observable: symbol;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
|
|
1
45
|
interface ContactAttachment extends ContactAttachmentMediaOneOf {
|
|
2
46
|
/** The attachment's image (if the attachment is of type IMAGE) */
|
|
3
47
|
image?: string;
|
|
@@ -376,74 +420,61 @@ interface GetAttachmentIdentifiers {
|
|
|
376
420
|
attachmentId: string;
|
|
377
421
|
}
|
|
378
422
|
|
|
379
|
-
|
|
380
|
-
interface
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
423
|
+
declare function generateAttachmentUploadUrl$1(httpClient: HttpClient): GenerateAttachmentUploadUrlSignature;
|
|
424
|
+
interface GenerateAttachmentUploadUrlSignature {
|
|
425
|
+
/**
|
|
426
|
+
* Generates an upload URL to allow external clients to upload a file as an attachment to a given contact.
|
|
427
|
+
*
|
|
428
|
+
* To learn how external clients can use the generated upload URL in the response to upload a file,
|
|
429
|
+
* see the [Upload API](https://dev.wix.com/api/rest/media/media-manager/upload-api) article.
|
|
430
|
+
* @param - ID of the contact whose attachment is being uploaded.
|
|
431
|
+
* @param - File name including the extension e.g: `contact-cv.pdf`
|
|
432
|
+
*/
|
|
433
|
+
(contactId: string, fileName: string, options: GenerateAttachmentUploadUrlOptions): Promise<GenerateAttachmentUploadUrlResponse & GenerateAttachmentUploadUrlResponseNonNullableFields>;
|
|
384
434
|
}
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
}
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
type: Type;
|
|
408
|
-
isDomainEvent?: boolean;
|
|
409
|
-
transformations?: (envelope: unknown) => Payload;
|
|
410
|
-
__payload: Payload;
|
|
411
|
-
};
|
|
412
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
413
|
-
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
414
|
-
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
415
|
-
|
|
416
|
-
declare global {
|
|
417
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
418
|
-
interface SymbolConstructor {
|
|
419
|
-
readonly observable: symbol;
|
|
420
|
-
}
|
|
435
|
+
declare function listAttachments$1(httpClient: HttpClient): ListAttachmentsSignature;
|
|
436
|
+
interface ListAttachmentsSignature {
|
|
437
|
+
/**
|
|
438
|
+
* List Attachments.
|
|
439
|
+
* @param - Contact ID
|
|
440
|
+
*/
|
|
441
|
+
(contactId: string, options?: ListAttachmentsOptions | undefined): Promise<ListAttachmentsResponse & ListAttachmentsResponseNonNullableFields>;
|
|
442
|
+
}
|
|
443
|
+
declare function deleteAttachment$1(httpClient: HttpClient): DeleteAttachmentSignature;
|
|
444
|
+
interface DeleteAttachmentSignature {
|
|
445
|
+
/**
|
|
446
|
+
* Deletes an attachment from contact
|
|
447
|
+
*/
|
|
448
|
+
(identifiers: DeleteAttachmentIdentifiers): Promise<void>;
|
|
449
|
+
}
|
|
450
|
+
declare function getAttachment$1(httpClient: HttpClient): GetAttachmentSignature;
|
|
451
|
+
interface GetAttachmentSignature {
|
|
452
|
+
/**
|
|
453
|
+
* Retrieves an attachment.
|
|
454
|
+
* @returns The requested attachment
|
|
455
|
+
*/
|
|
456
|
+
(identifiers: GetAttachmentIdentifiers): Promise<ContactAttachment & ContactAttachmentNonNullableFields>;
|
|
421
457
|
}
|
|
422
|
-
|
|
423
|
-
declare function generateAttachmentUploadUrl$1(httpClient: HttpClient): (contactId: string, fileName: string, options: GenerateAttachmentUploadUrlOptions) => Promise<GenerateAttachmentUploadUrlResponse & GenerateAttachmentUploadUrlResponseNonNullableFields>;
|
|
424
|
-
declare function listAttachments$1(httpClient: HttpClient): (contactId: string, options?: ListAttachmentsOptions) => Promise<ListAttachmentsResponse & ListAttachmentsResponseNonNullableFields>;
|
|
425
|
-
declare function deleteAttachment$1(httpClient: HttpClient): (identifiers: DeleteAttachmentIdentifiers) => Promise<void>;
|
|
426
|
-
declare function getAttachment$1(httpClient: HttpClient): (identifiers: GetAttachmentIdentifiers) => Promise<ContactAttachment & ContactAttachmentNonNullableFields>;
|
|
427
458
|
declare const onAttachmentCreated$1: EventDefinition<AttachmentCreatedEnvelope, "wix.contacts.v4.attachment_created">;
|
|
428
459
|
declare const onAttachmentDeleted$1: EventDefinition<AttachmentDeletedEnvelope, "wix.contacts.v4.attachment_deleted">;
|
|
429
460
|
|
|
430
|
-
declare function createRESTModule$5<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
431
|
-
|
|
432
461
|
declare function createEventModule$4<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
433
462
|
|
|
434
|
-
|
|
435
|
-
declare const
|
|
436
|
-
|
|
437
|
-
declare const
|
|
438
|
-
type _publicDeleteAttachmentType = typeof deleteAttachment$1;
|
|
439
|
-
declare const deleteAttachment: ReturnType<typeof createRESTModule$5<_publicDeleteAttachmentType>>;
|
|
440
|
-
type _publicGetAttachmentType = typeof getAttachment$1;
|
|
441
|
-
declare const getAttachment: ReturnType<typeof createRESTModule$5<_publicGetAttachmentType>>;
|
|
463
|
+
declare const generateAttachmentUploadUrl: BuildRESTFunction<typeof generateAttachmentUploadUrl$1> & typeof generateAttachmentUploadUrl$1;
|
|
464
|
+
declare const listAttachments: BuildRESTFunction<typeof listAttachments$1> & typeof listAttachments$1;
|
|
465
|
+
declare const deleteAttachment: BuildRESTFunction<typeof deleteAttachment$1> & typeof deleteAttachment$1;
|
|
466
|
+
declare const getAttachment: BuildRESTFunction<typeof getAttachment$1> & typeof getAttachment$1;
|
|
442
467
|
|
|
443
468
|
type _publicOnAttachmentCreatedType = typeof onAttachmentCreated$1;
|
|
469
|
+
/**
|
|
470
|
+
* Triggered when an attachment is created.
|
|
471
|
+
*/
|
|
444
472
|
declare const onAttachmentCreated: ReturnType<typeof createEventModule$4<_publicOnAttachmentCreatedType>>;
|
|
445
473
|
|
|
446
474
|
type _publicOnAttachmentDeletedType = typeof onAttachmentDeleted$1;
|
|
475
|
+
/**
|
|
476
|
+
* Triggered when a contact is deleted.
|
|
477
|
+
*/
|
|
447
478
|
declare const onAttachmentDeleted: ReturnType<typeof createEventModule$4<_publicOnAttachmentDeletedType>>;
|
|
448
479
|
|
|
449
480
|
type index_d$5_AttachmentCreatedEnvelope = AttachmentCreatedEnvelope;
|
|
@@ -481,10 +512,6 @@ type index_d$5_ListAttachmentsRequest = ListAttachmentsRequest;
|
|
|
481
512
|
type index_d$5_ListAttachmentsResponse = ListAttachmentsResponse;
|
|
482
513
|
type index_d$5_ListAttachmentsResponseNonNullableFields = ListAttachmentsResponseNonNullableFields;
|
|
483
514
|
type index_d$5_MediaFileUploadedEvent = MediaFileUploadedEvent;
|
|
484
|
-
type index_d$5__publicDeleteAttachmentType = _publicDeleteAttachmentType;
|
|
485
|
-
type index_d$5__publicGenerateAttachmentUploadUrlType = _publicGenerateAttachmentUploadUrlType;
|
|
486
|
-
type index_d$5__publicGetAttachmentType = _publicGetAttachmentType;
|
|
487
|
-
type index_d$5__publicListAttachmentsType = _publicListAttachmentsType;
|
|
488
515
|
type index_d$5__publicOnAttachmentCreatedType = _publicOnAttachmentCreatedType;
|
|
489
516
|
type index_d$5__publicOnAttachmentDeletedType = _publicOnAttachmentDeletedType;
|
|
490
517
|
declare const index_d$5_deleteAttachment: typeof deleteAttachment;
|
|
@@ -494,7 +521,7 @@ declare const index_d$5_listAttachments: typeof listAttachments;
|
|
|
494
521
|
declare const index_d$5_onAttachmentCreated: typeof onAttachmentCreated;
|
|
495
522
|
declare const index_d$5_onAttachmentDeleted: typeof onAttachmentDeleted;
|
|
496
523
|
declare namespace index_d$5 {
|
|
497
|
-
export { type ActionEvent$4 as ActionEvent, type index_d$5_AttachmentCreatedEnvelope as AttachmentCreatedEnvelope, type index_d$5_AttachmentDeletedEnvelope as AttachmentDeletedEnvelope, type index_d$5_AttachmentMedia as AttachmentMedia, type index_d$5_AttachmentMediaMediaOneOf as AttachmentMediaMediaOneOf, type index_d$5_AttachmentMetadata as AttachmentMetadata, type index_d$5_AttachmentSource as AttachmentSource, index_d$5_AttachmentType as AttachmentType, type BaseEventMetadata$4 as BaseEventMetadata, type index_d$5_ContactAttachment as ContactAttachment, type index_d$5_ContactAttachmentMediaOneOf as ContactAttachmentMediaOneOf, type index_d$5_ContactAttachmentNonNullableFields as ContactAttachmentNonNullableFields, type index_d$5_CreateDemoAttachmentRequest as CreateDemoAttachmentRequest, type index_d$5_CreateDemoAttachmentResponse as CreateDemoAttachmentResponse, type index_d$5_CrmAttachment as CrmAttachment, index_d$5_CrmAttachmentAttachmentType as CrmAttachmentAttachmentType, type index_d$5_CrmAttachmentUploadedEvent as CrmAttachmentUploadedEvent, type index_d$5_DeleteAttachmentIdentifiers as DeleteAttachmentIdentifiers, type index_d$5_DeleteAttachmentRequest as DeleteAttachmentRequest, type index_d$5_DeleteAttachmentResponse as DeleteAttachmentResponse, index_d$5_DemoContactType as DemoContactType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type EventMetadata$4 as EventMetadata, type index_d$5_GenerateAttachmentUploadUrlOptions as GenerateAttachmentUploadUrlOptions, type index_d$5_GenerateAttachmentUploadUrlRequest as GenerateAttachmentUploadUrlRequest, type index_d$5_GenerateAttachmentUploadUrlResponse as GenerateAttachmentUploadUrlResponse, type index_d$5_GenerateAttachmentUploadUrlResponseNonNullableFields as GenerateAttachmentUploadUrlResponseNonNullableFields, type index_d$5_GetAttachmentIdentifiers as GetAttachmentIdentifiers, type index_d$5_GetAttachmentRequest as GetAttachmentRequest, type index_d$5_GetAttachmentResponse as GetAttachmentResponse, type index_d$5_GetAttachmentResponseNonNullableFields as GetAttachmentResponseNonNullableFields, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type index_d$5_ListAttachmentsOptions as ListAttachmentsOptions, type index_d$5_ListAttachmentsRequest as ListAttachmentsRequest, type index_d$5_ListAttachmentsResponse as ListAttachmentsResponse, type index_d$5_ListAttachmentsResponseNonNullableFields as ListAttachmentsResponseNonNullableFields, type index_d$5_MediaFileUploadedEvent as MediaFileUploadedEvent, type MessageEnvelope$5 as MessageEnvelope, type Paging$4 as Paging, type PagingMetadata$3 as PagingMetadata, WebhookIdentityType$5 as WebhookIdentityType, type index_d$
|
|
524
|
+
export { type ActionEvent$4 as ActionEvent, type index_d$5_AttachmentCreatedEnvelope as AttachmentCreatedEnvelope, type index_d$5_AttachmentDeletedEnvelope as AttachmentDeletedEnvelope, type index_d$5_AttachmentMedia as AttachmentMedia, type index_d$5_AttachmentMediaMediaOneOf as AttachmentMediaMediaOneOf, type index_d$5_AttachmentMetadata as AttachmentMetadata, type index_d$5_AttachmentSource as AttachmentSource, index_d$5_AttachmentType as AttachmentType, type BaseEventMetadata$4 as BaseEventMetadata, type index_d$5_ContactAttachment as ContactAttachment, type index_d$5_ContactAttachmentMediaOneOf as ContactAttachmentMediaOneOf, type index_d$5_ContactAttachmentNonNullableFields as ContactAttachmentNonNullableFields, type index_d$5_CreateDemoAttachmentRequest as CreateDemoAttachmentRequest, type index_d$5_CreateDemoAttachmentResponse as CreateDemoAttachmentResponse, type index_d$5_CrmAttachment as CrmAttachment, index_d$5_CrmAttachmentAttachmentType as CrmAttachmentAttachmentType, type index_d$5_CrmAttachmentUploadedEvent as CrmAttachmentUploadedEvent, type index_d$5_DeleteAttachmentIdentifiers as DeleteAttachmentIdentifiers, type index_d$5_DeleteAttachmentRequest as DeleteAttachmentRequest, type index_d$5_DeleteAttachmentResponse as DeleteAttachmentResponse, index_d$5_DemoContactType as DemoContactType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type EventMetadata$4 as EventMetadata, type index_d$5_GenerateAttachmentUploadUrlOptions as GenerateAttachmentUploadUrlOptions, type index_d$5_GenerateAttachmentUploadUrlRequest as GenerateAttachmentUploadUrlRequest, type index_d$5_GenerateAttachmentUploadUrlResponse as GenerateAttachmentUploadUrlResponse, type index_d$5_GenerateAttachmentUploadUrlResponseNonNullableFields as GenerateAttachmentUploadUrlResponseNonNullableFields, type index_d$5_GetAttachmentIdentifiers as GetAttachmentIdentifiers, type index_d$5_GetAttachmentRequest as GetAttachmentRequest, type index_d$5_GetAttachmentResponse as GetAttachmentResponse, type index_d$5_GetAttachmentResponseNonNullableFields as GetAttachmentResponseNonNullableFields, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type index_d$5_ListAttachmentsOptions as ListAttachmentsOptions, type index_d$5_ListAttachmentsRequest as ListAttachmentsRequest, type index_d$5_ListAttachmentsResponse as ListAttachmentsResponse, type index_d$5_ListAttachmentsResponseNonNullableFields as ListAttachmentsResponseNonNullableFields, type index_d$5_MediaFileUploadedEvent as MediaFileUploadedEvent, type MessageEnvelope$5 as MessageEnvelope, type Paging$4 as Paging, type PagingMetadata$3 as PagingMetadata, WebhookIdentityType$5 as WebhookIdentityType, type index_d$5__publicOnAttachmentCreatedType as _publicOnAttachmentCreatedType, type index_d$5__publicOnAttachmentDeletedType as _publicOnAttachmentDeletedType, index_d$5_deleteAttachment as deleteAttachment, index_d$5_generateAttachmentUploadUrl as generateAttachmentUploadUrl, index_d$5_getAttachment as getAttachment, index_d$5_listAttachments as listAttachments, index_d$5_onAttachmentCreated as onAttachmentCreated, index_d$5_onAttachmentDeleted as onAttachmentDeleted, onAttachmentCreated$1 as publicOnAttachmentCreated, onAttachmentDeleted$1 as publicOnAttachmentDeleted };
|
|
498
525
|
}
|
|
499
526
|
|
|
500
527
|
interface Contact {
|
|
@@ -2412,50 +2439,225 @@ interface GetContactOptions {
|
|
|
2412
2439
|
fieldsets?: ContactFieldSet[];
|
|
2413
2440
|
}
|
|
2414
2441
|
|
|
2415
|
-
declare function createContact$1(httpClient: HttpClient):
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
|
|
2442
|
+
declare function createContact$1(httpClient: HttpClient): CreateContactSignature;
|
|
2443
|
+
interface CreateContactSignature {
|
|
2444
|
+
/**
|
|
2445
|
+
* Creates a new contact.
|
|
2446
|
+
*
|
|
2447
|
+
*
|
|
2448
|
+
* The `createContact()` function returns a Promise
|
|
2449
|
+
* that resolves to the new contact when it is created.
|
|
2450
|
+
*
|
|
2451
|
+
* The `info` parameter object must include a name, phone number, or email address.
|
|
2452
|
+
* If all 3 of these parameters are missing,
|
|
2453
|
+
* the contact won't be created.
|
|
2454
|
+
*
|
|
2455
|
+
* By default, if the call contains an email already in use by another contact, the new contact won't be created. To override this behavior, set `allowDuplicates` in the `options` object to `true`.
|
|
2456
|
+
*
|
|
2457
|
+
* @param - Contact info.
|
|
2458
|
+
* @param - Create contact options.
|
|
2459
|
+
* @returns Contact.
|
|
2460
|
+
*/
|
|
2461
|
+
(info: ContactInfo$2, options?: CreateContactOptions | undefined): Promise<CreateContactResponse & CreateContactResponseNonNullableFields>;
|
|
2462
|
+
}
|
|
2463
|
+
declare function updateContact$1(httpClient: HttpClient): UpdateContactSignature;
|
|
2464
|
+
interface UpdateContactSignature {
|
|
2465
|
+
/**
|
|
2466
|
+
* Updates a contact's properties.
|
|
2467
|
+
*
|
|
2468
|
+
* The `updateContact()` function returns a Promise that resolves
|
|
2469
|
+
* when the specified contact's information is updated.
|
|
2470
|
+
*
|
|
2471
|
+
* Each time the contact is updated, `revision` increments by 1. The existing `revision` must be included when updating the contact. This ensures you're working with the latest contact information, and prevents unintended overwrites.
|
|
2472
|
+
*
|
|
2473
|
+
* @param - ID of the contact to update.
|
|
2474
|
+
* @param - Contact info.
|
|
2475
|
+
* @param - Revision number.
|
|
2476
|
+
* When updating, include the existing `revision`
|
|
2477
|
+
* to prevent conflicting updates.
|
|
2478
|
+
* @param - Contact update options.
|
|
2479
|
+
* @returns Updated contact.
|
|
2480
|
+
*/
|
|
2481
|
+
(contactId: string, info: ContactInfo$2, revision: number | null, options?: UpdateContactOptions | undefined): Promise<UpdateContactResponse & UpdateContactResponseNonNullableFields>;
|
|
2482
|
+
}
|
|
2483
|
+
declare function mergeContacts$1(httpClient: HttpClient): MergeContactsSignature;
|
|
2484
|
+
interface MergeContactsSignature {
|
|
2485
|
+
/**
|
|
2486
|
+
* Merges source contacts into a target contact.
|
|
2487
|
+
*
|
|
2488
|
+
* Merging contacts has these effects on the target contact:
|
|
2489
|
+
*
|
|
2490
|
+
* - No target contact data is overwritten or deleted.
|
|
2491
|
+
* - Arrays (emails, phones, addresses, and labels) are merged from the source contacts into the target contact.
|
|
2492
|
+
* - If merging more than one source contact, the 1st source is given precedence, then the 2nd, and so on.
|
|
2493
|
+
*
|
|
2494
|
+
* Source contacts are deleted when merging.
|
|
2495
|
+
* However, if a source contact is a site member or collaborator,
|
|
2496
|
+
* the `mergeContacts()` function fails because site collaborators and members can't be deleted.
|
|
2497
|
+
* Site members and collaborators can only be target contacts.
|
|
2498
|
+
*
|
|
2499
|
+
* After merging, if you call the `getContact()` function with a deleted source contact ID, the target contact ID is returned. This is only supported when calling `getContact()`. Previously deleted source contact IDs can't be passed in any other function.
|
|
2500
|
+
*
|
|
2501
|
+
* @param - Target contact ID.
|
|
2502
|
+
* @param - Target contact revision number, which increments by 1 each time the contact is updated.
|
|
2503
|
+
* To prevent conflicting changes,
|
|
2504
|
+
* the target contact's current revision must be passed.
|
|
2505
|
+
* @param - Merge contacts options.
|
|
2506
|
+
*/
|
|
2507
|
+
(targetContactId: string, targetContactRevision: number | null, options?: MergeContactsOptions | undefined): Promise<MergeContactsResponse & MergeContactsResponseNonNullableFields>;
|
|
2508
|
+
}
|
|
2509
|
+
declare function deleteContact$1(httpClient: HttpClient): DeleteContactSignature;
|
|
2510
|
+
interface DeleteContactSignature {
|
|
2511
|
+
/**
|
|
2512
|
+
* Deletes a contact who is not a site member or contributor.
|
|
2513
|
+
*
|
|
2514
|
+
* The `deleteContact()` function returns a Promise
|
|
2515
|
+
* that resolves when the specified contact is deleted.
|
|
2516
|
+
*
|
|
2517
|
+
* Deleting a contact permanently removes them from your Contact List.
|
|
2518
|
+
*
|
|
2519
|
+
* If the contact is also a site member,
|
|
2520
|
+
* the member must be deleted first,
|
|
2521
|
+
* and then the contact can be deleted.
|
|
2522
|
+
*
|
|
2523
|
+
* @param - ID of the contact to delete.
|
|
2524
|
+
*/
|
|
2525
|
+
(contactId: string): Promise<void>;
|
|
2526
|
+
}
|
|
2527
|
+
declare function labelContact$1(httpClient: HttpClient): LabelContactSignature;
|
|
2528
|
+
interface LabelContactSignature {
|
|
2529
|
+
/**
|
|
2530
|
+
* Adds labels to a contact.
|
|
2531
|
+
*
|
|
2532
|
+
*
|
|
2533
|
+
* The `labelContact()` function returns a Promise
|
|
2534
|
+
* that resolves when the specified labels are added to the contact.
|
|
2535
|
+
* - **To create new labels:** Use `findOrCreateLabel()`.
|
|
2536
|
+
* - **To find labels:** Use `findOrCreateLabel()`, `getLabel()`, or `queryLabels()`.
|
|
2537
|
+
*
|
|
2538
|
+
* @param - ID of the contact to add labels to.
|
|
2539
|
+
* @param - List of label keys to add to the contact.
|
|
2540
|
+
*
|
|
2541
|
+
* Label keys must exist to be added to the contact.
|
|
2542
|
+
* Contact labels can be created with the
|
|
2543
|
+
* `findOrCreateLabel()` function. You can use the
|
|
2544
|
+
* `queryLabels()` function to view the currently existing labels.
|
|
2545
|
+
* @returns Updated contact.
|
|
2546
|
+
*/
|
|
2547
|
+
(contactId: string, labelKeys: string[]): Promise<LabelContactResponse & LabelContactResponseNonNullableFields>;
|
|
2548
|
+
}
|
|
2549
|
+
declare function unlabelContact$1(httpClient: HttpClient): UnlabelContactSignature;
|
|
2550
|
+
interface UnlabelContactSignature {
|
|
2551
|
+
/**
|
|
2552
|
+
* Removes labels from a contact.
|
|
2553
|
+
*
|
|
2554
|
+
* The `unlabelContact()` function returns a Promise
|
|
2555
|
+
* that resolves when the specified labels are removed from the contact.
|
|
2556
|
+
*
|
|
2557
|
+
* If a label is no longer needed and you want to remove it from all contacts, you can remove it with the Labels `deleteLabel()` function.
|
|
2558
|
+
*
|
|
2559
|
+
* @param - ID of the contact to remove labels from.
|
|
2560
|
+
* @param - List of label keys to remove from the contact.
|
|
2561
|
+
* @returns Updated contact.
|
|
2562
|
+
*/
|
|
2563
|
+
(contactId: string, labelKeys: string[]): Promise<UnlabelContactResponse & UnlabelContactResponseNonNullableFields>;
|
|
2564
|
+
}
|
|
2565
|
+
declare function queryContacts$1(httpClient: HttpClient): QueryContactsSignature;
|
|
2566
|
+
interface QueryContactsSignature {
|
|
2567
|
+
/**
|
|
2568
|
+
* Creates a query to retrieve a list of contacts.
|
|
2569
|
+
*
|
|
2570
|
+
* The `queryContacts()` function builds a query to retrieve a list of contacts and returns a `ContactsQueryBuilder` object.
|
|
2571
|
+
*
|
|
2572
|
+
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
2573
|
+
*
|
|
2574
|
+
* You can refine the query by chaining `ContactsQueryBuilder` functions onto the query. `ContactsQueryBuilder` functions enable you to sort, filter, and control the results `queryContacts()` returns.
|
|
2575
|
+
*
|
|
2576
|
+
* `queryContacts()` runs with these `ContactsQueryBuilder` defaults, which you can override:
|
|
2577
|
+
*
|
|
2578
|
+
* - `skip(0)`
|
|
2579
|
+
* - `limit(50)`
|
|
2580
|
+
* - `descending(\"_createdDate\")`
|
|
2581
|
+
*
|
|
2582
|
+
* 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.
|
|
2583
|
+
* @param - Query contact options.
|
|
2584
|
+
*/
|
|
2585
|
+
(options?: QueryContactsOptions | undefined): ContactsQueryBuilder;
|
|
2586
|
+
}
|
|
2587
|
+
declare function getContact$1(httpClient: HttpClient): GetContactSignature;
|
|
2588
|
+
interface GetContactSignature {
|
|
2589
|
+
/**
|
|
2590
|
+
* Retrieves a contact.
|
|
2591
|
+
*
|
|
2592
|
+
*
|
|
2593
|
+
* The `getContact()` function returns a Promise
|
|
2594
|
+
* that resolves when the contact is found.
|
|
2595
|
+
*
|
|
2596
|
+
* #### Getting Merged Contacts
|
|
2597
|
+
* When a source contact is merged into a target contact, the source contact is deleted. When calling `getContact()` for a merged contact,
|
|
2598
|
+
* you can use the source or target contact ID. In both cases, the target contact is returned.
|
|
2599
|
+
*
|
|
2600
|
+
* This is supported only when calling `getContact()`on merged contacts. Previously deleted source contact IDs can't be passed to any other function.
|
|
2601
|
+
*
|
|
2602
|
+
* @param - ID of the contact to retrieve.
|
|
2603
|
+
* @param - Get contact options.
|
|
2604
|
+
* @returns The requested contact.
|
|
2605
|
+
*/
|
|
2606
|
+
(_id: string, options?: GetContactOptions | undefined): Promise<Contact & ContactNonNullableFields>;
|
|
2607
|
+
}
|
|
2423
2608
|
declare const onContactCreated$1: EventDefinition<ContactCreatedEnvelope, "wix.contacts.v4.contact_created">;
|
|
2424
2609
|
declare const onContactUpdated$1: EventDefinition<ContactUpdatedEnvelope, "wix.contacts.v4.contact_updated">;
|
|
2425
2610
|
declare const onContactMerged$1: EventDefinition<ContactMergedEnvelope, "wix.contacts.v4.contact_merged">;
|
|
2426
2611
|
declare const onContactDeleted$1: EventDefinition<ContactDeletedEnvelope, "wix.contacts.v4.contact_deleted">;
|
|
2427
2612
|
|
|
2428
|
-
declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
2429
|
-
|
|
2430
2613
|
declare function createEventModule$3<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
2431
2614
|
|
|
2432
|
-
|
|
2433
|
-
declare const
|
|
2434
|
-
|
|
2435
|
-
declare const
|
|
2436
|
-
|
|
2437
|
-
declare const
|
|
2438
|
-
|
|
2439
|
-
declare const
|
|
2440
|
-
type _publicLabelContactType = typeof labelContact$1;
|
|
2441
|
-
declare const labelContact: ReturnType<typeof createRESTModule$4<_publicLabelContactType>>;
|
|
2442
|
-
type _publicUnlabelContactType = typeof unlabelContact$1;
|
|
2443
|
-
declare const unlabelContact: ReturnType<typeof createRESTModule$4<_publicUnlabelContactType>>;
|
|
2444
|
-
type _publicQueryContactsType = typeof queryContacts$1;
|
|
2445
|
-
declare const queryContacts: ReturnType<typeof createRESTModule$4<_publicQueryContactsType>>;
|
|
2446
|
-
type _publicGetContactType = typeof getContact$1;
|
|
2447
|
-
declare const getContact: ReturnType<typeof createRESTModule$4<_publicGetContactType>>;
|
|
2615
|
+
declare const createContact: BuildRESTFunction<typeof createContact$1> & typeof createContact$1;
|
|
2616
|
+
declare const updateContact: BuildRESTFunction<typeof updateContact$1> & typeof updateContact$1;
|
|
2617
|
+
declare const mergeContacts: BuildRESTFunction<typeof mergeContacts$1> & typeof mergeContacts$1;
|
|
2618
|
+
declare const deleteContact: BuildRESTFunction<typeof deleteContact$1> & typeof deleteContact$1;
|
|
2619
|
+
declare const labelContact: BuildRESTFunction<typeof labelContact$1> & typeof labelContact$1;
|
|
2620
|
+
declare const unlabelContact: BuildRESTFunction<typeof unlabelContact$1> & typeof unlabelContact$1;
|
|
2621
|
+
declare const queryContacts: BuildRESTFunction<typeof queryContacts$1> & typeof queryContacts$1;
|
|
2622
|
+
declare const getContact: BuildRESTFunction<typeof getContact$1> & typeof getContact$1;
|
|
2448
2623
|
|
|
2449
2624
|
type _publicOnContactCreatedType = typeof onContactCreated$1;
|
|
2625
|
+
/**
|
|
2626
|
+
* Triggered when a contact is created.
|
|
2627
|
+
*/
|
|
2450
2628
|
declare const onContactCreated: ReturnType<typeof createEventModule$3<_publicOnContactCreatedType>>;
|
|
2451
2629
|
|
|
2452
2630
|
type _publicOnContactUpdatedType = typeof onContactUpdated$1;
|
|
2631
|
+
/**
|
|
2632
|
+
* Triggered when a contact is updated.
|
|
2633
|
+
*/
|
|
2453
2634
|
declare const onContactUpdated: ReturnType<typeof createEventModule$3<_publicOnContactUpdatedType>>;
|
|
2454
2635
|
|
|
2455
2636
|
type _publicOnContactMergedType = typeof onContactMerged$1;
|
|
2637
|
+
/**
|
|
2638
|
+
* Triggered when one or more source contacts are merged into a target contact.
|
|
2639
|
+
*
|
|
2640
|
+
* Merging contacts triggers these webhooks:
|
|
2641
|
+
*
|
|
2642
|
+
* - [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.
|
|
2643
|
+
* - [Contact Updated](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-updated-webhook) is triggered for the target contact. `originatedFrom` is set to `merge`.
|
|
2644
|
+
* - [Contact Deleted](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-deleted-webhook) is triggered for each source contact. `originatedFrom` is set to `merge`.
|
|
2645
|
+
*
|
|
2646
|
+
* If your app handles the originating merge event,
|
|
2647
|
+
* it can ignore update and delete events where `originatedFrom` is set to `merge`.
|
|
2648
|
+
* When Contact Updated and Contact Deleted are not triggered from a merge,
|
|
2649
|
+
* `originatedFrom` is omitted from their payloads.
|
|
2650
|
+
*/
|
|
2456
2651
|
declare const onContactMerged: ReturnType<typeof createEventModule$3<_publicOnContactMergedType>>;
|
|
2457
2652
|
|
|
2458
2653
|
type _publicOnContactDeletedType = typeof onContactDeleted$1;
|
|
2654
|
+
/**
|
|
2655
|
+
* Triggered when a contact is deleted.
|
|
2656
|
+
*
|
|
2657
|
+
* If a contact is deleted as part of a merge,
|
|
2658
|
+
* the `originatedFrom` property is sent as `merge`.
|
|
2659
|
+
* Otherwise, `originatedFrom` is omitted.
|
|
2660
|
+
*/
|
|
2459
2661
|
declare const onContactDeleted: ReturnType<typeof createEventModule$3<_publicOnContactDeletedType>>;
|
|
2460
2662
|
|
|
2461
2663
|
type index_d$4_Action = Action;
|
|
@@ -2584,18 +2786,10 @@ type index_d$4_UpsertContactResponse = UpsertContactResponse;
|
|
|
2584
2786
|
type index_d$4_UpsertContactResponseAction = UpsertContactResponseAction;
|
|
2585
2787
|
declare const index_d$4_UpsertContactResponseAction: typeof UpsertContactResponseAction;
|
|
2586
2788
|
type index_d$4_UserInfo = UserInfo;
|
|
2587
|
-
type index_d$4__publicCreateContactType = _publicCreateContactType;
|
|
2588
|
-
type index_d$4__publicDeleteContactType = _publicDeleteContactType;
|
|
2589
|
-
type index_d$4__publicGetContactType = _publicGetContactType;
|
|
2590
|
-
type index_d$4__publicLabelContactType = _publicLabelContactType;
|
|
2591
|
-
type index_d$4__publicMergeContactsType = _publicMergeContactsType;
|
|
2592
2789
|
type index_d$4__publicOnContactCreatedType = _publicOnContactCreatedType;
|
|
2593
2790
|
type index_d$4__publicOnContactDeletedType = _publicOnContactDeletedType;
|
|
2594
2791
|
type index_d$4__publicOnContactMergedType = _publicOnContactMergedType;
|
|
2595
2792
|
type index_d$4__publicOnContactUpdatedType = _publicOnContactUpdatedType;
|
|
2596
|
-
type index_d$4__publicQueryContactsType = _publicQueryContactsType;
|
|
2597
|
-
type index_d$4__publicUnlabelContactType = _publicUnlabelContactType;
|
|
2598
|
-
type index_d$4__publicUpdateContactType = _publicUpdateContactType;
|
|
2599
2793
|
declare const index_d$4_createContact: typeof createContact;
|
|
2600
2794
|
declare const index_d$4_deleteContact: typeof deleteContact;
|
|
2601
2795
|
declare const index_d$4_getContact: typeof getContact;
|
|
@@ -2609,7 +2803,7 @@ declare const index_d$4_queryContacts: typeof queryContacts;
|
|
|
2609
2803
|
declare const index_d$4_unlabelContact: typeof unlabelContact;
|
|
2610
2804
|
declare const index_d$4_updateContact: typeof updateContact;
|
|
2611
2805
|
declare namespace index_d$4 {
|
|
2612
|
-
export { index_d$4_Action as Action, type ActionEvent$3 as ActionEvent, type ActivityIcon$1 as ActivityIcon, type Address$1 as Address, type AddressLocation$1 as AddressLocation, type AddressStreetOneOf$1 as AddressStreetOneOf, AddressTag$1 as AddressTag, type index_d$4_ApplicationError as ApplicationError, type AssigneesWrapper$1 as AssigneesWrapper, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$4_BulkActionMetadata as BulkActionMetadata, type index_d$4_BulkAddSegmentToContactsRequest as BulkAddSegmentToContactsRequest, type index_d$4_BulkAddSegmentToContactsResponse as BulkAddSegmentToContactsResponse, type index_d$4_BulkDeleteContactsRequest as BulkDeleteContactsRequest, type index_d$4_BulkDeleteContactsResponse as BulkDeleteContactsResponse, type index_d$4_BulkLabelAndUnlabelContactsRequest as BulkLabelAndUnlabelContactsRequest, type index_d$4_BulkLabelAndUnlabelContactsResponse as BulkLabelAndUnlabelContactsResponse, type index_d$4_BulkRemoveSegmentFromContactsRequest as BulkRemoveSegmentFromContactsRequest, type index_d$4_BulkRemoveSegmentFromContactsResponse as BulkRemoveSegmentFromContactsResponse, type index_d$4_BulkUpdateContactsRequest as BulkUpdateContactsRequest, type index_d$4_BulkUpdateContactsResponse as BulkUpdateContactsResponse, type index_d$4_BulkUpsertContactsRequest as BulkUpsertContactsRequest, type index_d$4_BulkUpsertContactsResponse as BulkUpsertContactsResponse, type index_d$4_BulkUpsertContactsResponseMetadata as BulkUpsertContactsResponseMetadata, type index_d$4_Contact as Contact, type ContactActivity$1 as ContactActivity, ContactActivityType$1 as ContactActivityType, type index_d$4_ContactAddedToSegment as ContactAddedToSegment, type ContactAddress$1 as ContactAddress, type ContactAddressesWrapper$1 as ContactAddressesWrapper, type index_d$4_ContactChanged as ContactChanged, type index_d$4_ContactCreatedEnvelope as ContactCreatedEnvelope, type index_d$4_ContactDeletedEnvelope as ContactDeletedEnvelope, type ContactEmail$1 as ContactEmail, type index_d$4_ContactEmailSubscriptionUpdated as ContactEmailSubscriptionUpdated, type ContactEmailsWrapper$1 as ContactEmailsWrapper, index_d$4_ContactFieldSet as ContactFieldSet, type ContactInfo$2 as ContactInfo, type index_d$4_ContactMerged as ContactMerged, type index_d$4_ContactMergedEnvelope as ContactMergedEnvelope, type ContactName$1 as ContactName, type index_d$4_ContactNonNullableFields as ContactNonNullableFields, type ContactPhone$1 as ContactPhone, type index_d$4_ContactPhoneSubscriptionUpdated as ContactPhoneSubscriptionUpdated, type ContactPhonesWrapper$1 as ContactPhonesWrapper, type ContactPicture$1 as ContactPicture, type index_d$4_ContactPrimaryInfoUpdated as ContactPrimaryInfoUpdated, type index_d$4_ContactRemovedFromSegment as ContactRemovedFromSegment, type index_d$4_ContactSource as ContactSource, ContactSourceType$1 as ContactSourceType, type index_d$4_ContactSubmitted as ContactSubmitted, type index_d$4_ContactUpdatedEnvelope as ContactUpdatedEnvelope, type index_d$4_ContactsFacet as ContactsFacet, index_d$4_ContactsFacetType as ContactsFacetType, type index_d$4_ContactsQueryBuilder as ContactsQueryBuilder, type index_d$4_ContactsQueryResult as ContactsQueryResult, type index_d$4_CountContactsRequest as CountContactsRequest, type index_d$4_CountContactsResponse as CountContactsResponse, type index_d$4_CreateContactOptions as CreateContactOptions, type index_d$4_CreateContactRequest as CreateContactRequest, type index_d$4_CreateContactResponse as CreateContactResponse, type index_d$4_CreateContactResponseNonNullableFields as CreateContactResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type Cursors$1 as Cursors, type index_d$4_DeleteContactRequest as DeleteContactRequest, type index_d$4_DeleteContactResponse as DeleteContactResponse, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type index_d$4_DuplicateContactExists as DuplicateContactExists, index_d$4_EmailDeliverabilityStatus as EmailDeliverabilityStatus, EmailTag$1 as EmailTag, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type index_d$4_Error as Error, type EventMetadata$3 as EventMetadata, type ExtendedFieldsWrapper$1 as ExtendedFieldsWrapper, type index_d$4_GeneratePictureUploadUrlRequest as GeneratePictureUploadUrlRequest, type index_d$4_GeneratePictureUploadUrlResponse as GeneratePictureUploadUrlResponse, type index_d$4_GetContactOptions as GetContactOptions, type index_d$4_GetContactRequest as GetContactRequest, type index_d$4_GetContactResponse as GetContactResponse, type index_d$4_GetContactResponseNonNullableFields as GetContactResponseNonNullableFields, index_d$4_GetContactResponseType as GetContactResponseType, type index_d$4_GroupInfo as GroupInfo, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, ImageProvider$1 as ImageProvider, type index_d$4_Item as Item, type index_d$4_ItemMetadata as ItemMetadata, type index_d$4_LabelAndUnlabelContactRequest as LabelAndUnlabelContactRequest, type index_d$4_LabelAndUnlabelContactResponse as LabelAndUnlabelContactResponse, type index_d$4_LabelContactRequest as LabelContactRequest, type index_d$4_LabelContactResponse as LabelContactResponse, type index_d$4_LabelContactResponseNonNullableFields as LabelContactResponseNonNullableFields, type LabelsWrapper$1 as LabelsWrapper, type index_d$4_LastActivityUpdate as LastActivityUpdate, type index_d$4_ListContactIdsBySegmentRequest as ListContactIdsBySegmentRequest, type index_d$4_ListContactIdsBySegmentResponse as ListContactIdsBySegmentResponse, type index_d$4_ListContactsRequest as ListContactsRequest, type index_d$4_ListContactsResponse as ListContactsResponse, type index_d$4_ListFacetsRequest as ListFacetsRequest, type index_d$4_ListFacetsResponse as ListFacetsResponse, type LocationsWrapper$1 as LocationsWrapper, type index_d$4_MemberInfo as MemberInfo, index_d$4_MemberStatus as MemberStatus, type index_d$4_MergeContactsOptions as MergeContactsOptions, type index_d$4_MergeContactsRequest as MergeContactsRequest, type index_d$4_MergeContactsResponse as MergeContactsResponse, type index_d$4_MergeContactsResponseNonNullableFields as MergeContactsResponseNonNullableFields, type MessageEnvelope$4 as MessageEnvelope, type index_d$4_Metadata as Metadata, index_d$4_Mode as Mode, type Paging$3 as Paging, type PagingMetadata$2 as PagingMetadata, index_d$4_PhoneDeliverabilityStatus as PhoneDeliverabilityStatus, PhoneTag$1 as PhoneTag, type index_d$4_PreviewMergeContactsRequest as PreviewMergeContactsRequest, type index_d$4_PreviewMergeContactsResponse as PreviewMergeContactsResponse, type index_d$4_PrimaryContactInfo as PrimaryContactInfo, type index_d$4_PrimaryEmail as PrimaryEmail, type index_d$4_PrimaryPhone as PrimaryPhone, type index_d$4_PrimarySubscriptionStatus as PrimarySubscriptionStatus, index_d$4_PrivacyStatus as PrivacyStatus, type index_d$4_ProfileInfo as ProfileInfo, type Query$2 as Query, type index_d$4_QueryContactsOptions as QueryContactsOptions, type index_d$4_QueryContactsRequest as QueryContactsRequest, type index_d$4_QueryContactsResponse as QueryContactsResponse, type index_d$4_QueryContactsResponseNonNullableFields as QueryContactsResponseNonNullableFields, type index_d$4_QueryFacetsRequest as QueryFacetsRequest, type index_d$4_QueryFacetsResponse as QueryFacetsResponse, type RestoreInfo$1 as RestoreInfo, index_d$4_Role as Role, type index_d$4_Search as Search, type index_d$4_SearchContactsRequest as SearchContactsRequest, type index_d$4_SearchContactsResponse as SearchContactsResponse, type index_d$4_SearchDetails as SearchDetails, type index_d$4_SearchPagingMethodOneOf as SearchPagingMethodOneOf, type index_d$4_SegmentsWrapper as SegmentsWrapper, type index_d$4_SessionInfo as SessionInfo, SortOrder$3 as SortOrder, type Sorting$3 as Sorting, type StreetAddress$1 as StreetAddress, type Subdivision$1 as Subdivision, SubdivisionType$1 as SubdivisionType, SubmitOperation$1 as SubmitOperation, index_d$4_SubscriptionStatus as SubscriptionStatus, type index_d$4_SyncSubmitContactRequest as SyncSubmitContactRequest, type index_d$4_SyncSubmitContactResponse as SyncSubmitContactResponse, type index_d$4_UnlabelContactRequest as UnlabelContactRequest, type index_d$4_UnlabelContactResponse as UnlabelContactResponse, type index_d$4_UnlabelContactResponseNonNullableFields as UnlabelContactResponseNonNullableFields, type index_d$4_UpdateContactOptions as UpdateContactOptions, type index_d$4_UpdateContactRequest as UpdateContactRequest, type index_d$4_UpdateContactResponse as UpdateContactResponse, type index_d$4_UpdateContactResponseNonNullableFields as UpdateContactResponseNonNullableFields, type index_d$4_UpsertContactRequest as UpsertContactRequest, type index_d$4_UpsertContactResponse as UpsertContactResponse, index_d$4_UpsertContactResponseAction as UpsertContactResponseAction, type index_d$4_UserInfo as UserInfo, WebhookIdentityType$4 as WebhookIdentityType, type index_d$4__publicCreateContactType as _publicCreateContactType, type index_d$4__publicDeleteContactType as _publicDeleteContactType, type index_d$4__publicGetContactType as _publicGetContactType, type index_d$4__publicLabelContactType as _publicLabelContactType, type index_d$4__publicMergeContactsType as _publicMergeContactsType, type index_d$4__publicOnContactCreatedType as _publicOnContactCreatedType, type index_d$4__publicOnContactDeletedType as _publicOnContactDeletedType, type index_d$4__publicOnContactMergedType as _publicOnContactMergedType, type index_d$4__publicOnContactUpdatedType as _publicOnContactUpdatedType, type index_d$4__publicQueryContactsType as _publicQueryContactsType, type index_d$4__publicUnlabelContactType as _publicUnlabelContactType, type index_d$4__publicUpdateContactType as _publicUpdateContactType, index_d$4_createContact as createContact, index_d$4_deleteContact as deleteContact, index_d$4_getContact as getContact, index_d$4_labelContact as labelContact, index_d$4_mergeContacts as mergeContacts, index_d$4_onContactCreated as onContactCreated, index_d$4_onContactDeleted as onContactDeleted, index_d$4_onContactMerged as onContactMerged, index_d$4_onContactUpdated as onContactUpdated, onContactCreated$1 as publicOnContactCreated, onContactDeleted$1 as publicOnContactDeleted, onContactMerged$1 as publicOnContactMerged, onContactUpdated$1 as publicOnContactUpdated, index_d$4_queryContacts as queryContacts, index_d$4_unlabelContact as unlabelContact, index_d$4_updateContact as updateContact };
|
|
2806
|
+
export { index_d$4_Action as Action, type ActionEvent$3 as ActionEvent, type ActivityIcon$1 as ActivityIcon, type Address$1 as Address, type AddressLocation$1 as AddressLocation, type AddressStreetOneOf$1 as AddressStreetOneOf, AddressTag$1 as AddressTag, type index_d$4_ApplicationError as ApplicationError, type AssigneesWrapper$1 as AssigneesWrapper, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$4_BulkActionMetadata as BulkActionMetadata, type index_d$4_BulkAddSegmentToContactsRequest as BulkAddSegmentToContactsRequest, type index_d$4_BulkAddSegmentToContactsResponse as BulkAddSegmentToContactsResponse, type index_d$4_BulkDeleteContactsRequest as BulkDeleteContactsRequest, type index_d$4_BulkDeleteContactsResponse as BulkDeleteContactsResponse, type index_d$4_BulkLabelAndUnlabelContactsRequest as BulkLabelAndUnlabelContactsRequest, type index_d$4_BulkLabelAndUnlabelContactsResponse as BulkLabelAndUnlabelContactsResponse, type index_d$4_BulkRemoveSegmentFromContactsRequest as BulkRemoveSegmentFromContactsRequest, type index_d$4_BulkRemoveSegmentFromContactsResponse as BulkRemoveSegmentFromContactsResponse, type index_d$4_BulkUpdateContactsRequest as BulkUpdateContactsRequest, type index_d$4_BulkUpdateContactsResponse as BulkUpdateContactsResponse, type index_d$4_BulkUpsertContactsRequest as BulkUpsertContactsRequest, type index_d$4_BulkUpsertContactsResponse as BulkUpsertContactsResponse, type index_d$4_BulkUpsertContactsResponseMetadata as BulkUpsertContactsResponseMetadata, type index_d$4_Contact as Contact, type ContactActivity$1 as ContactActivity, ContactActivityType$1 as ContactActivityType, type index_d$4_ContactAddedToSegment as ContactAddedToSegment, type ContactAddress$1 as ContactAddress, type ContactAddressesWrapper$1 as ContactAddressesWrapper, type index_d$4_ContactChanged as ContactChanged, type index_d$4_ContactCreatedEnvelope as ContactCreatedEnvelope, type index_d$4_ContactDeletedEnvelope as ContactDeletedEnvelope, type ContactEmail$1 as ContactEmail, type index_d$4_ContactEmailSubscriptionUpdated as ContactEmailSubscriptionUpdated, type ContactEmailsWrapper$1 as ContactEmailsWrapper, index_d$4_ContactFieldSet as ContactFieldSet, type ContactInfo$2 as ContactInfo, type index_d$4_ContactMerged as ContactMerged, type index_d$4_ContactMergedEnvelope as ContactMergedEnvelope, type ContactName$1 as ContactName, type index_d$4_ContactNonNullableFields as ContactNonNullableFields, type ContactPhone$1 as ContactPhone, type index_d$4_ContactPhoneSubscriptionUpdated as ContactPhoneSubscriptionUpdated, type ContactPhonesWrapper$1 as ContactPhonesWrapper, type ContactPicture$1 as ContactPicture, type index_d$4_ContactPrimaryInfoUpdated as ContactPrimaryInfoUpdated, type index_d$4_ContactRemovedFromSegment as ContactRemovedFromSegment, type index_d$4_ContactSource as ContactSource, ContactSourceType$1 as ContactSourceType, type index_d$4_ContactSubmitted as ContactSubmitted, type index_d$4_ContactUpdatedEnvelope as ContactUpdatedEnvelope, type index_d$4_ContactsFacet as ContactsFacet, index_d$4_ContactsFacetType as ContactsFacetType, type index_d$4_ContactsQueryBuilder as ContactsQueryBuilder, type index_d$4_ContactsQueryResult as ContactsQueryResult, type index_d$4_CountContactsRequest as CountContactsRequest, type index_d$4_CountContactsResponse as CountContactsResponse, type index_d$4_CreateContactOptions as CreateContactOptions, type index_d$4_CreateContactRequest as CreateContactRequest, type index_d$4_CreateContactResponse as CreateContactResponse, type index_d$4_CreateContactResponseNonNullableFields as CreateContactResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type Cursors$1 as Cursors, type index_d$4_DeleteContactRequest as DeleteContactRequest, type index_d$4_DeleteContactResponse as DeleteContactResponse, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type index_d$4_DuplicateContactExists as DuplicateContactExists, index_d$4_EmailDeliverabilityStatus as EmailDeliverabilityStatus, EmailTag$1 as EmailTag, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type index_d$4_Error as Error, type EventMetadata$3 as EventMetadata, type ExtendedFieldsWrapper$1 as ExtendedFieldsWrapper, type index_d$4_GeneratePictureUploadUrlRequest as GeneratePictureUploadUrlRequest, type index_d$4_GeneratePictureUploadUrlResponse as GeneratePictureUploadUrlResponse, type index_d$4_GetContactOptions as GetContactOptions, type index_d$4_GetContactRequest as GetContactRequest, type index_d$4_GetContactResponse as GetContactResponse, type index_d$4_GetContactResponseNonNullableFields as GetContactResponseNonNullableFields, index_d$4_GetContactResponseType as GetContactResponseType, type index_d$4_GroupInfo as GroupInfo, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, ImageProvider$1 as ImageProvider, type index_d$4_Item as Item, type index_d$4_ItemMetadata as ItemMetadata, type index_d$4_LabelAndUnlabelContactRequest as LabelAndUnlabelContactRequest, type index_d$4_LabelAndUnlabelContactResponse as LabelAndUnlabelContactResponse, type index_d$4_LabelContactRequest as LabelContactRequest, type index_d$4_LabelContactResponse as LabelContactResponse, type index_d$4_LabelContactResponseNonNullableFields as LabelContactResponseNonNullableFields, type LabelsWrapper$1 as LabelsWrapper, type index_d$4_LastActivityUpdate as LastActivityUpdate, type index_d$4_ListContactIdsBySegmentRequest as ListContactIdsBySegmentRequest, type index_d$4_ListContactIdsBySegmentResponse as ListContactIdsBySegmentResponse, type index_d$4_ListContactsRequest as ListContactsRequest, type index_d$4_ListContactsResponse as ListContactsResponse, type index_d$4_ListFacetsRequest as ListFacetsRequest, type index_d$4_ListFacetsResponse as ListFacetsResponse, type LocationsWrapper$1 as LocationsWrapper, type index_d$4_MemberInfo as MemberInfo, index_d$4_MemberStatus as MemberStatus, type index_d$4_MergeContactsOptions as MergeContactsOptions, type index_d$4_MergeContactsRequest as MergeContactsRequest, type index_d$4_MergeContactsResponse as MergeContactsResponse, type index_d$4_MergeContactsResponseNonNullableFields as MergeContactsResponseNonNullableFields, type MessageEnvelope$4 as MessageEnvelope, type index_d$4_Metadata as Metadata, index_d$4_Mode as Mode, type Paging$3 as Paging, type PagingMetadata$2 as PagingMetadata, index_d$4_PhoneDeliverabilityStatus as PhoneDeliverabilityStatus, PhoneTag$1 as PhoneTag, type index_d$4_PreviewMergeContactsRequest as PreviewMergeContactsRequest, type index_d$4_PreviewMergeContactsResponse as PreviewMergeContactsResponse, type index_d$4_PrimaryContactInfo as PrimaryContactInfo, type index_d$4_PrimaryEmail as PrimaryEmail, type index_d$4_PrimaryPhone as PrimaryPhone, type index_d$4_PrimarySubscriptionStatus as PrimarySubscriptionStatus, index_d$4_PrivacyStatus as PrivacyStatus, type index_d$4_ProfileInfo as ProfileInfo, type Query$2 as Query, type index_d$4_QueryContactsOptions as QueryContactsOptions, type index_d$4_QueryContactsRequest as QueryContactsRequest, type index_d$4_QueryContactsResponse as QueryContactsResponse, type index_d$4_QueryContactsResponseNonNullableFields as QueryContactsResponseNonNullableFields, type index_d$4_QueryFacetsRequest as QueryFacetsRequest, type index_d$4_QueryFacetsResponse as QueryFacetsResponse, type RestoreInfo$1 as RestoreInfo, index_d$4_Role as Role, type index_d$4_Search as Search, type index_d$4_SearchContactsRequest as SearchContactsRequest, type index_d$4_SearchContactsResponse as SearchContactsResponse, type index_d$4_SearchDetails as SearchDetails, type index_d$4_SearchPagingMethodOneOf as SearchPagingMethodOneOf, type index_d$4_SegmentsWrapper as SegmentsWrapper, type index_d$4_SessionInfo as SessionInfo, SortOrder$3 as SortOrder, type Sorting$3 as Sorting, type StreetAddress$1 as StreetAddress, type Subdivision$1 as Subdivision, SubdivisionType$1 as SubdivisionType, SubmitOperation$1 as SubmitOperation, index_d$4_SubscriptionStatus as SubscriptionStatus, type index_d$4_SyncSubmitContactRequest as SyncSubmitContactRequest, type index_d$4_SyncSubmitContactResponse as SyncSubmitContactResponse, type index_d$4_UnlabelContactRequest as UnlabelContactRequest, type index_d$4_UnlabelContactResponse as UnlabelContactResponse, type index_d$4_UnlabelContactResponseNonNullableFields as UnlabelContactResponseNonNullableFields, type index_d$4_UpdateContactOptions as UpdateContactOptions, type index_d$4_UpdateContactRequest as UpdateContactRequest, type index_d$4_UpdateContactResponse as UpdateContactResponse, type index_d$4_UpdateContactResponseNonNullableFields as UpdateContactResponseNonNullableFields, type index_d$4_UpsertContactRequest as UpsertContactRequest, type index_d$4_UpsertContactResponse as UpsertContactResponse, index_d$4_UpsertContactResponseAction as UpsertContactResponseAction, type index_d$4_UserInfo as UserInfo, WebhookIdentityType$4 as WebhookIdentityType, type index_d$4__publicOnContactCreatedType as _publicOnContactCreatedType, type index_d$4__publicOnContactDeletedType as _publicOnContactDeletedType, type index_d$4__publicOnContactMergedType as _publicOnContactMergedType, type index_d$4__publicOnContactUpdatedType as _publicOnContactUpdatedType, index_d$4_createContact as createContact, index_d$4_deleteContact as deleteContact, index_d$4_getContact as getContact, index_d$4_labelContact as labelContact, index_d$4_mergeContacts as mergeContacts, index_d$4_onContactCreated as onContactCreated, index_d$4_onContactDeleted as onContactDeleted, index_d$4_onContactMerged as onContactMerged, index_d$4_onContactUpdated as onContactUpdated, onContactCreated$1 as publicOnContactCreated, onContactDeleted$1 as publicOnContactDeleted, onContactMerged$1 as publicOnContactMerged, onContactUpdated$1 as publicOnContactUpdated, index_d$4_queryContacts as queryContacts, index_d$4_unlabelContact as unlabelContact, index_d$4_updateContact as updateContact };
|
|
2613
2807
|
}
|
|
2614
2808
|
|
|
2615
2809
|
/** Extended field that was found or created. */
|
|
@@ -3183,37 +3377,135 @@ interface FieldsQueryBuilder {
|
|
|
3183
3377
|
find: () => Promise<FieldsQueryResult>;
|
|
3184
3378
|
}
|
|
3185
3379
|
|
|
3186
|
-
declare function findOrCreateExtendedField$1(httpClient: HttpClient):
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3380
|
+
declare function findOrCreateExtendedField$1(httpClient: HttpClient): FindOrCreateExtendedFieldSignature;
|
|
3381
|
+
interface FindOrCreateExtendedFieldSignature {
|
|
3382
|
+
/**
|
|
3383
|
+
* Retrieves a custom field with a given name, or creates one if it doesn't exist.
|
|
3384
|
+
*
|
|
3385
|
+
* The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
|
|
3386
|
+
*
|
|
3387
|
+
* Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
|
|
3388
|
+
*
|
|
3389
|
+
* To find an existing extended field without potentially creating a new one, use `getExtendedField()` or `queryExtendedFields()`.
|
|
3390
|
+
*
|
|
3391
|
+
* @param - Display name to find or create.
|
|
3392
|
+
*
|
|
3393
|
+
* If an existing custom field is an exact match
|
|
3394
|
+
* for the specified `displayName`,
|
|
3395
|
+
* the existing field is returned.
|
|
3396
|
+
* If not, a new field is created and returned.
|
|
3397
|
+
* @param - Type of data the field holds.
|
|
3398
|
+
* Ignored if an existing field is an exact match
|
|
3399
|
+
* for the specified display name. One of:
|
|
3400
|
+
*
|
|
3401
|
+
* - `"TEXT"`: Accepts strings.
|
|
3402
|
+
* - `"NUMBER"`: Accepts floats.
|
|
3403
|
+
* - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
|
|
3404
|
+
* - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
|
|
3405
|
+
* @returns Extended field that was found or created.
|
|
3406
|
+
*/
|
|
3407
|
+
(displayName: string, dataType: FieldDataType): Promise<FindOrCreateExtendedFieldResponse & FindOrCreateExtendedFieldResponseNonNullableFields>;
|
|
3408
|
+
}
|
|
3409
|
+
declare function getExtendedField$1(httpClient: HttpClient): GetExtendedFieldSignature;
|
|
3410
|
+
interface GetExtendedFieldSignature {
|
|
3411
|
+
/**
|
|
3412
|
+
* Retrieves an extended field.
|
|
3413
|
+
*
|
|
3414
|
+
* The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
|
|
3415
|
+
*
|
|
3416
|
+
* @param - Extended field key.
|
|
3417
|
+
*
|
|
3418
|
+
* When accessing contact data,
|
|
3419
|
+
* extended field values are available at `fields[key]`.
|
|
3420
|
+
* For example, if the key is "custom.notes",
|
|
3421
|
+
* the value can be accessed at `fields["custom.notes"]`.
|
|
3422
|
+
*
|
|
3423
|
+
* Once set, `key` cannot be modified, even if `displayName` changes.
|
|
3424
|
+
* @returns The specified field.
|
|
3425
|
+
*/
|
|
3426
|
+
(key: string): Promise<ExtendedField & ExtendedFieldNonNullableFields>;
|
|
3427
|
+
}
|
|
3428
|
+
declare function renameExtendedField$1(httpClient: HttpClient): RenameExtendedFieldSignature;
|
|
3429
|
+
interface RenameExtendedFieldSignature {
|
|
3430
|
+
/**
|
|
3431
|
+
* Renames an extended field.
|
|
3432
|
+
*
|
|
3433
|
+
* The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
|
|
3434
|
+
*
|
|
3435
|
+
* @param - Extended field key.
|
|
3436
|
+
*
|
|
3437
|
+
* When accessing contact data,
|
|
3438
|
+
* extended field values are available at `fields[key]`.
|
|
3439
|
+
* For example, if the key is "custom.notes",
|
|
3440
|
+
* the value can be accessed at `fields["custom.notes"]`.
|
|
3441
|
+
*
|
|
3442
|
+
* Once set, `key` cannot be modified, even if `displayName` changes.
|
|
3443
|
+
* @param - Extended field to rename.
|
|
3444
|
+
* @returns Updated extended field.
|
|
3445
|
+
*/
|
|
3446
|
+
(key: string, field: RenameExtendedField): Promise<ExtendedField & ExtendedFieldNonNullableFields>;
|
|
3447
|
+
}
|
|
3448
|
+
declare function deleteExtendedField$1(httpClient: HttpClient): DeleteExtendedFieldSignature;
|
|
3449
|
+
interface DeleteExtendedFieldSignature {
|
|
3450
|
+
/**
|
|
3451
|
+
* Deletes an extended field.
|
|
3452
|
+
*
|
|
3453
|
+
* The `deleteExtendedField()` function returns a Promise that resolves when the specified extended field is deleted.
|
|
3454
|
+
*
|
|
3455
|
+
* When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
|
|
3456
|
+
*
|
|
3457
|
+
* @param - Extended field key.
|
|
3458
|
+
*/
|
|
3459
|
+
(key: string): Promise<void>;
|
|
3460
|
+
}
|
|
3461
|
+
declare function queryExtendedFields$1(httpClient: HttpClient): QueryExtendedFieldsSignature;
|
|
3462
|
+
interface QueryExtendedFieldsSignature {
|
|
3463
|
+
/**
|
|
3464
|
+
* Creates a query to retrieve a list of extended fields.
|
|
3465
|
+
*
|
|
3466
|
+
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an `FieldsQueryBuilder` object.
|
|
3467
|
+
*
|
|
3468
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` function.
|
|
3469
|
+
*
|
|
3470
|
+
* You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
|
|
3471
|
+
*
|
|
3472
|
+
* `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
|
|
3473
|
+
* - `skip()`
|
|
3474
|
+
* - `limit(50)`
|
|
3475
|
+
* - `descending('_createdDate')`
|
|
3476
|
+
*
|
|
3477
|
+
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.
|
|
3478
|
+
*/
|
|
3479
|
+
(): FieldsQueryBuilder;
|
|
3480
|
+
}
|
|
3191
3481
|
declare const onExtendedFieldCreated$1: EventDefinition<ExtendedFieldCreatedEnvelope, "wix.contacts.v4.extended-field_created">;
|
|
3192
3482
|
declare const onExtendedFieldUpdated$1: EventDefinition<ExtendedFieldUpdatedEnvelope, "wix.contacts.v4.extended-field_updated">;
|
|
3193
3483
|
declare const onExtendedFieldDeleted$1: EventDefinition<ExtendedFieldDeletedEnvelope, "wix.contacts.v4.extended-field_deleted">;
|
|
3194
3484
|
|
|
3195
|
-
declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
3196
|
-
|
|
3197
3485
|
declare function createEventModule$2<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
3198
3486
|
|
|
3199
|
-
|
|
3200
|
-
declare const
|
|
3201
|
-
|
|
3202
|
-
declare const
|
|
3203
|
-
|
|
3204
|
-
declare const renameExtendedField: ReturnType<typeof createRESTModule$3<_publicRenameExtendedFieldType>>;
|
|
3205
|
-
type _publicDeleteExtendedFieldType = typeof deleteExtendedField$1;
|
|
3206
|
-
declare const deleteExtendedField: ReturnType<typeof createRESTModule$3<_publicDeleteExtendedFieldType>>;
|
|
3207
|
-
type _publicQueryExtendedFieldsType = typeof queryExtendedFields$1;
|
|
3208
|
-
declare const queryExtendedFields: ReturnType<typeof createRESTModule$3<_publicQueryExtendedFieldsType>>;
|
|
3487
|
+
declare const findOrCreateExtendedField: BuildRESTFunction<typeof findOrCreateExtendedField$1> & typeof findOrCreateExtendedField$1;
|
|
3488
|
+
declare const getExtendedField: BuildRESTFunction<typeof getExtendedField$1> & typeof getExtendedField$1;
|
|
3489
|
+
declare const renameExtendedField: BuildRESTFunction<typeof renameExtendedField$1> & typeof renameExtendedField$1;
|
|
3490
|
+
declare const deleteExtendedField: BuildRESTFunction<typeof deleteExtendedField$1> & typeof deleteExtendedField$1;
|
|
3491
|
+
declare const queryExtendedFields: BuildRESTFunction<typeof queryExtendedFields$1> & typeof queryExtendedFields$1;
|
|
3209
3492
|
|
|
3210
3493
|
type _publicOnExtendedFieldCreatedType = typeof onExtendedFieldCreated$1;
|
|
3494
|
+
/**
|
|
3495
|
+
* Triggered when an extended field is created.
|
|
3496
|
+
*/
|
|
3211
3497
|
declare const onExtendedFieldCreated: ReturnType<typeof createEventModule$2<_publicOnExtendedFieldCreatedType>>;
|
|
3212
3498
|
|
|
3213
3499
|
type _publicOnExtendedFieldUpdatedType = typeof onExtendedFieldUpdated$1;
|
|
3500
|
+
/**
|
|
3501
|
+
* Triggered when an extended field is updated.
|
|
3502
|
+
*/
|
|
3214
3503
|
declare const onExtendedFieldUpdated: ReturnType<typeof createEventModule$2<_publicOnExtendedFieldUpdatedType>>;
|
|
3215
3504
|
|
|
3216
3505
|
type _publicOnExtendedFieldDeletedType = typeof onExtendedFieldDeleted$1;
|
|
3506
|
+
/**
|
|
3507
|
+
* Triggered when an extended field is deleted.
|
|
3508
|
+
*/
|
|
3217
3509
|
declare const onExtendedFieldDeleted: ReturnType<typeof createEventModule$2<_publicOnExtendedFieldDeletedType>>;
|
|
3218
3510
|
|
|
3219
3511
|
type index_d$3_DeleteExtendedFieldRequest = DeleteExtendedFieldRequest;
|
|
@@ -3247,14 +3539,9 @@ type index_d$3_RestoreInfo = RestoreInfo;
|
|
|
3247
3539
|
type index_d$3_UpdateExtendedFieldRequest = UpdateExtendedFieldRequest;
|
|
3248
3540
|
type index_d$3_UpdateExtendedFieldResponse = UpdateExtendedFieldResponse;
|
|
3249
3541
|
type index_d$3_UpdateExtendedFieldResponseNonNullableFields = UpdateExtendedFieldResponseNonNullableFields;
|
|
3250
|
-
type index_d$3__publicDeleteExtendedFieldType = _publicDeleteExtendedFieldType;
|
|
3251
|
-
type index_d$3__publicFindOrCreateExtendedFieldType = _publicFindOrCreateExtendedFieldType;
|
|
3252
|
-
type index_d$3__publicGetExtendedFieldType = _publicGetExtendedFieldType;
|
|
3253
3542
|
type index_d$3__publicOnExtendedFieldCreatedType = _publicOnExtendedFieldCreatedType;
|
|
3254
3543
|
type index_d$3__publicOnExtendedFieldDeletedType = _publicOnExtendedFieldDeletedType;
|
|
3255
3544
|
type index_d$3__publicOnExtendedFieldUpdatedType = _publicOnExtendedFieldUpdatedType;
|
|
3256
|
-
type index_d$3__publicQueryExtendedFieldsType = _publicQueryExtendedFieldsType;
|
|
3257
|
-
type index_d$3__publicRenameExtendedFieldType = _publicRenameExtendedFieldType;
|
|
3258
3545
|
declare const index_d$3_deleteExtendedField: typeof deleteExtendedField;
|
|
3259
3546
|
declare const index_d$3_findOrCreateExtendedField: typeof findOrCreateExtendedField;
|
|
3260
3547
|
declare const index_d$3_getExtendedField: typeof getExtendedField;
|
|
@@ -3264,7 +3551,7 @@ declare const index_d$3_onExtendedFieldUpdated: typeof onExtendedFieldUpdated;
|
|
|
3264
3551
|
declare const index_d$3_queryExtendedFields: typeof queryExtendedFields;
|
|
3265
3552
|
declare const index_d$3_renameExtendedField: typeof renameExtendedField;
|
|
3266
3553
|
declare namespace index_d$3 {
|
|
3267
|
-
export { type ActionEvent$2 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type index_d$3_DeleteExtendedFieldRequest as DeleteExtendedFieldRequest, type index_d$3_DeleteExtendedFieldResponse as DeleteExtendedFieldResponse, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type index_d$3_ExtendedField as ExtendedField, type index_d$3_ExtendedFieldCreatedEnvelope as ExtendedFieldCreatedEnvelope, type index_d$3_ExtendedFieldDeletedEnvelope as ExtendedFieldDeletedEnvelope, type index_d$3_ExtendedFieldNonNullableFields as ExtendedFieldNonNullableFields, type index_d$3_ExtendedFieldUpdatedEnvelope as ExtendedFieldUpdatedEnvelope, index_d$3_FieldDataType as FieldDataType, index_d$3_FieldType as FieldType, type index_d$3_FieldsQueryBuilder as FieldsQueryBuilder, type index_d$3_FieldsQueryResult as FieldsQueryResult, type index_d$3_FindOrCreateExtendedFieldRequest as FindOrCreateExtendedFieldRequest, type index_d$3_FindOrCreateExtendedFieldResponse as FindOrCreateExtendedFieldResponse, type index_d$3_FindOrCreateExtendedFieldResponseNonNullableFields as FindOrCreateExtendedFieldResponseNonNullableFields, type GdprListRequest$1 as GdprListRequest, type GdprListResponse$1 as GdprListResponse, type index_d$3_GetExtendedFieldByLegacyIdRequest as GetExtendedFieldByLegacyIdRequest, type index_d$3_GetExtendedFieldByLegacyIdResponse as GetExtendedFieldByLegacyIdResponse, type index_d$3_GetExtendedFieldRequest as GetExtendedFieldRequest, type index_d$3_GetExtendedFieldResponse as GetExtendedFieldResponse, type index_d$3_GetExtendedFieldResponseNonNullableFields as GetExtendedFieldResponseNonNullableFields, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type index_d$3_ListExtendedFieldsRequest as ListExtendedFieldsRequest, type index_d$3_ListExtendedFieldsResponse as ListExtendedFieldsResponse, type MessageEnvelope$3 as MessageEnvelope, type Paging$2 as Paging, type PagingMetadata$1 as PagingMetadata, type PurgeRequest$1 as PurgeRequest, type PurgeResponse$1 as PurgeResponse, type Query$1 as Query, type index_d$3_QueryExtendedFieldsRequest as QueryExtendedFieldsRequest, type index_d$3_QueryExtendedFieldsResponse as QueryExtendedFieldsResponse, type index_d$3_QueryExtendedFieldsResponseNonNullableFields as QueryExtendedFieldsResponseNonNullableFields, type index_d$3_RenameExtendedField as RenameExtendedField, type index_d$3_RestoreInfo as RestoreInfo, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type index_d$3_UpdateExtendedFieldRequest as UpdateExtendedFieldRequest, type index_d$3_UpdateExtendedFieldResponse as UpdateExtendedFieldResponse, type index_d$3_UpdateExtendedFieldResponseNonNullableFields as UpdateExtendedFieldResponseNonNullableFields, WebhookIdentityType$3 as WebhookIdentityType, type index_d$
|
|
3554
|
+
export { type ActionEvent$2 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type index_d$3_DeleteExtendedFieldRequest as DeleteExtendedFieldRequest, type index_d$3_DeleteExtendedFieldResponse as DeleteExtendedFieldResponse, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type index_d$3_ExtendedField as ExtendedField, type index_d$3_ExtendedFieldCreatedEnvelope as ExtendedFieldCreatedEnvelope, type index_d$3_ExtendedFieldDeletedEnvelope as ExtendedFieldDeletedEnvelope, type index_d$3_ExtendedFieldNonNullableFields as ExtendedFieldNonNullableFields, type index_d$3_ExtendedFieldUpdatedEnvelope as ExtendedFieldUpdatedEnvelope, index_d$3_FieldDataType as FieldDataType, index_d$3_FieldType as FieldType, type index_d$3_FieldsQueryBuilder as FieldsQueryBuilder, type index_d$3_FieldsQueryResult as FieldsQueryResult, type index_d$3_FindOrCreateExtendedFieldRequest as FindOrCreateExtendedFieldRequest, type index_d$3_FindOrCreateExtendedFieldResponse as FindOrCreateExtendedFieldResponse, type index_d$3_FindOrCreateExtendedFieldResponseNonNullableFields as FindOrCreateExtendedFieldResponseNonNullableFields, type GdprListRequest$1 as GdprListRequest, type GdprListResponse$1 as GdprListResponse, type index_d$3_GetExtendedFieldByLegacyIdRequest as GetExtendedFieldByLegacyIdRequest, type index_d$3_GetExtendedFieldByLegacyIdResponse as GetExtendedFieldByLegacyIdResponse, type index_d$3_GetExtendedFieldRequest as GetExtendedFieldRequest, type index_d$3_GetExtendedFieldResponse as GetExtendedFieldResponse, type index_d$3_GetExtendedFieldResponseNonNullableFields as GetExtendedFieldResponseNonNullableFields, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type index_d$3_ListExtendedFieldsRequest as ListExtendedFieldsRequest, type index_d$3_ListExtendedFieldsResponse as ListExtendedFieldsResponse, type MessageEnvelope$3 as MessageEnvelope, type Paging$2 as Paging, type PagingMetadata$1 as PagingMetadata, type PurgeRequest$1 as PurgeRequest, type PurgeResponse$1 as PurgeResponse, type Query$1 as Query, type index_d$3_QueryExtendedFieldsRequest as QueryExtendedFieldsRequest, type index_d$3_QueryExtendedFieldsResponse as QueryExtendedFieldsResponse, type index_d$3_QueryExtendedFieldsResponseNonNullableFields as QueryExtendedFieldsResponseNonNullableFields, type index_d$3_RenameExtendedField as RenameExtendedField, type index_d$3_RestoreInfo as RestoreInfo, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type index_d$3_UpdateExtendedFieldRequest as UpdateExtendedFieldRequest, type index_d$3_UpdateExtendedFieldResponse as UpdateExtendedFieldResponse, type index_d$3_UpdateExtendedFieldResponseNonNullableFields as UpdateExtendedFieldResponseNonNullableFields, WebhookIdentityType$3 as WebhookIdentityType, type index_d$3__publicOnExtendedFieldCreatedType as _publicOnExtendedFieldCreatedType, type index_d$3__publicOnExtendedFieldDeletedType as _publicOnExtendedFieldDeletedType, type index_d$3__publicOnExtendedFieldUpdatedType as _publicOnExtendedFieldUpdatedType, index_d$3_deleteExtendedField as deleteExtendedField, index_d$3_findOrCreateExtendedField as findOrCreateExtendedField, index_d$3_getExtendedField as getExtendedField, index_d$3_onExtendedFieldCreated as onExtendedFieldCreated, index_d$3_onExtendedFieldDeleted as onExtendedFieldDeleted, index_d$3_onExtendedFieldUpdated as onExtendedFieldUpdated, onExtendedFieldCreated$1 as publicOnExtendedFieldCreated, onExtendedFieldDeleted$1 as publicOnExtendedFieldDeleted, onExtendedFieldUpdated$1 as publicOnExtendedFieldUpdated, index_d$3_queryExtendedFields as queryExtendedFields, index_d$3_renameExtendedField as renameExtendedField };
|
|
3268
3555
|
}
|
|
3269
3556
|
|
|
3270
3557
|
/** Label that was found or created. */
|
|
@@ -3861,37 +4148,124 @@ interface LabelsQueryBuilder {
|
|
|
3861
4148
|
find: () => Promise<LabelsQueryResult>;
|
|
3862
4149
|
}
|
|
3863
4150
|
|
|
3864
|
-
declare function findOrCreateLabel$1(httpClient: HttpClient):
|
|
3865
|
-
|
|
3866
|
-
|
|
3867
|
-
|
|
3868
|
-
|
|
4151
|
+
declare function findOrCreateLabel$1(httpClient: HttpClient): FindOrCreateLabelSignature;
|
|
4152
|
+
interface FindOrCreateLabelSignature {
|
|
4153
|
+
/**
|
|
4154
|
+
* Retrieves a label with a given name, or creates one if it doesn't exist.
|
|
4155
|
+
*
|
|
4156
|
+
* The `findOrCreateLabel()` function returns a Promise that resolves when the specified label is found or created.
|
|
4157
|
+
*
|
|
4158
|
+
* Successful calls to `findOrCreateLabel()` always returns a label, which can be passed to subsequent function calls.
|
|
4159
|
+
*
|
|
4160
|
+
* To find an existing label without potentially creating a new one, use `getLabel()` or `queryLabels()`.
|
|
4161
|
+
*
|
|
4162
|
+
*
|
|
4163
|
+
* @param - Display name to retrieve or create.
|
|
4164
|
+
*
|
|
4165
|
+
* If an existing label is an exact match
|
|
4166
|
+
* for the specified display name,
|
|
4167
|
+
* the existing label is returned.
|
|
4168
|
+
* If not, a new label is created and returned.
|
|
4169
|
+
* @param - Language options.
|
|
4170
|
+
* @returns Label that was found or created.
|
|
4171
|
+
*/
|
|
4172
|
+
(displayName: string, options?: FindOrCreateLabelOptions | undefined): Promise<FindOrCreateLabelResponse & FindOrCreateLabelResponseNonNullableFields>;
|
|
4173
|
+
}
|
|
4174
|
+
declare function getLabel$1(httpClient: HttpClient): GetLabelSignature;
|
|
4175
|
+
interface GetLabelSignature {
|
|
4176
|
+
/**
|
|
4177
|
+
* Retrieves a label by the specified label key.
|
|
4178
|
+
*
|
|
4179
|
+
* The `getLabel()` function returns a Promise that resolves when the specified label is retrieved.
|
|
4180
|
+
* @param - Label key.
|
|
4181
|
+
*
|
|
4182
|
+
* `key` is generated when the label is created.
|
|
4183
|
+
* It cannot be modified, even if `displayName` is updated.
|
|
4184
|
+
* @param - Language options.
|
|
4185
|
+
* @returns The specified label.
|
|
4186
|
+
*/
|
|
4187
|
+
(key: string, options?: GetLabelOptions | undefined): Promise<ContactLabel & ContactLabelNonNullableFields>;
|
|
4188
|
+
}
|
|
4189
|
+
declare function renameLabel$1(httpClient: HttpClient): RenameLabelSignature;
|
|
4190
|
+
interface RenameLabelSignature {
|
|
4191
|
+
/**
|
|
4192
|
+
* Renames a label.
|
|
4193
|
+
*
|
|
4194
|
+
* The `renameLabel()` function returns a Promise that resolves when the specified label's display name is changed.
|
|
4195
|
+
*
|
|
4196
|
+
* @param - Label key.
|
|
4197
|
+
*
|
|
4198
|
+
* `key` is generated when the label is created.
|
|
4199
|
+
* It cannot be modified, even if `displayName` is updated.
|
|
4200
|
+
* @param - Language options.
|
|
4201
|
+
* @param - Label to rename.
|
|
4202
|
+
* @returns
|
|
4203
|
+
*/
|
|
4204
|
+
(key: string, label: RenameLabel, options?: RenameLabelOptions | undefined): Promise<ContactLabel & ContactLabelNonNullableFields>;
|
|
4205
|
+
}
|
|
4206
|
+
declare function deleteLabel$1(httpClient: HttpClient): DeleteLabelSignature;
|
|
4207
|
+
interface DeleteLabelSignature {
|
|
4208
|
+
/**
|
|
4209
|
+
* Deletes a label from the site and removes it from contacts it applies to.
|
|
4210
|
+
*
|
|
4211
|
+
* The `deleteLabel()` function returns a Promise that resolves when the specified label is deleted.
|
|
4212
|
+
*
|
|
4213
|
+
*
|
|
4214
|
+
* @param - Label key to delete.
|
|
4215
|
+
*/
|
|
4216
|
+
(key: string): Promise<void>;
|
|
4217
|
+
}
|
|
4218
|
+
declare function queryLabels$1(httpClient: HttpClient): QueryLabelsSignature;
|
|
4219
|
+
interface QueryLabelsSignature {
|
|
4220
|
+
/**
|
|
4221
|
+
* Creates a query to retrieve a list of labels.
|
|
4222
|
+
*
|
|
4223
|
+
* The `queryLabels()` function builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
|
|
4224
|
+
*
|
|
4225
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` function.
|
|
4226
|
+
*
|
|
4227
|
+
* You can refine the query by chaining `LabelsQueryBuilder` functions onto the query. `LabelsQueryBuilder` functions enable you to filter, sort, and control the results that `queryLabels()` returns.
|
|
4228
|
+
*
|
|
4229
|
+
* `queryLabels()` runs with the following `LabelsQueryBuilder` defaults, which you can override:
|
|
4230
|
+
* - `skip(0)`
|
|
4231
|
+
* - `limit(50)`
|
|
4232
|
+
* - `descending('_createdDate')`
|
|
4233
|
+
*
|
|
4234
|
+
* The following `LabelsQueryBuilder` functions are supported for `queryLabels()`. For a full description of the `Labels` object, see the object returned for the `items` property in `LabelsQueryResult`.
|
|
4235
|
+
*
|
|
4236
|
+
*
|
|
4237
|
+
* @param - Language options.
|
|
4238
|
+
*/
|
|
4239
|
+
(options?: QueryLabelsOptions | undefined): LabelsQueryBuilder;
|
|
4240
|
+
}
|
|
3869
4241
|
declare const onLabelCreated$1: EventDefinition<LabelCreatedEnvelope, "wix.contacts.v4.label_created">;
|
|
3870
4242
|
declare const onLabelUpdated$1: EventDefinition<LabelUpdatedEnvelope, "wix.contacts.v4.label_updated">;
|
|
3871
4243
|
declare const onLabelDeleted$1: EventDefinition<LabelDeletedEnvelope, "wix.contacts.v4.label_deleted">;
|
|
3872
4244
|
|
|
3873
|
-
declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
3874
|
-
|
|
3875
4245
|
declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
3876
4246
|
|
|
3877
|
-
|
|
3878
|
-
declare const
|
|
3879
|
-
|
|
3880
|
-
declare const
|
|
3881
|
-
|
|
3882
|
-
declare const renameLabel: ReturnType<typeof createRESTModule$2<_publicRenameLabelType>>;
|
|
3883
|
-
type _publicDeleteLabelType = typeof deleteLabel$1;
|
|
3884
|
-
declare const deleteLabel: ReturnType<typeof createRESTModule$2<_publicDeleteLabelType>>;
|
|
3885
|
-
type _publicQueryLabelsType = typeof queryLabels$1;
|
|
3886
|
-
declare const queryLabels: ReturnType<typeof createRESTModule$2<_publicQueryLabelsType>>;
|
|
4247
|
+
declare const findOrCreateLabel: BuildRESTFunction<typeof findOrCreateLabel$1> & typeof findOrCreateLabel$1;
|
|
4248
|
+
declare const getLabel: BuildRESTFunction<typeof getLabel$1> & typeof getLabel$1;
|
|
4249
|
+
declare const renameLabel: BuildRESTFunction<typeof renameLabel$1> & typeof renameLabel$1;
|
|
4250
|
+
declare const deleteLabel: BuildRESTFunction<typeof deleteLabel$1> & typeof deleteLabel$1;
|
|
4251
|
+
declare const queryLabels: BuildRESTFunction<typeof queryLabels$1> & typeof queryLabels$1;
|
|
3887
4252
|
|
|
3888
4253
|
type _publicOnLabelCreatedType = typeof onLabelCreated$1;
|
|
4254
|
+
/**
|
|
4255
|
+
* Triggered when a label is created.
|
|
4256
|
+
*/
|
|
3889
4257
|
declare const onLabelCreated: ReturnType<typeof createEventModule$1<_publicOnLabelCreatedType>>;
|
|
3890
4258
|
|
|
3891
4259
|
type _publicOnLabelUpdatedType = typeof onLabelUpdated$1;
|
|
4260
|
+
/**
|
|
4261
|
+
* Triggered when a label is updated.
|
|
4262
|
+
*/
|
|
3892
4263
|
declare const onLabelUpdated: ReturnType<typeof createEventModule$1<_publicOnLabelUpdatedType>>;
|
|
3893
4264
|
|
|
3894
4265
|
type _publicOnLabelDeletedType = typeof onLabelDeleted$1;
|
|
4266
|
+
/**
|
|
4267
|
+
* Triggered when a label is deleted.
|
|
4268
|
+
*/
|
|
3895
4269
|
declare const onLabelDeleted: ReturnType<typeof createEventModule$1<_publicOnLabelDeletedType>>;
|
|
3896
4270
|
|
|
3897
4271
|
type index_d$2_ContactLabel = ContactLabel;
|
|
@@ -3937,14 +4311,9 @@ type index_d$2_UndeleteInfo = UndeleteInfo;
|
|
|
3937
4311
|
type index_d$2_UpdateLabelRequest = UpdateLabelRequest;
|
|
3938
4312
|
type index_d$2_UpdateLabelResponse = UpdateLabelResponse;
|
|
3939
4313
|
type index_d$2_UpdateLabelResponseNonNullableFields = UpdateLabelResponseNonNullableFields;
|
|
3940
|
-
type index_d$2__publicDeleteLabelType = _publicDeleteLabelType;
|
|
3941
|
-
type index_d$2__publicFindOrCreateLabelType = _publicFindOrCreateLabelType;
|
|
3942
|
-
type index_d$2__publicGetLabelType = _publicGetLabelType;
|
|
3943
4314
|
type index_d$2__publicOnLabelCreatedType = _publicOnLabelCreatedType;
|
|
3944
4315
|
type index_d$2__publicOnLabelDeletedType = _publicOnLabelDeletedType;
|
|
3945
4316
|
type index_d$2__publicOnLabelUpdatedType = _publicOnLabelUpdatedType;
|
|
3946
|
-
type index_d$2__publicQueryLabelsType = _publicQueryLabelsType;
|
|
3947
|
-
type index_d$2__publicRenameLabelType = _publicRenameLabelType;
|
|
3948
4317
|
declare const index_d$2_deleteLabel: typeof deleteLabel;
|
|
3949
4318
|
declare const index_d$2_findOrCreateLabel: typeof findOrCreateLabel;
|
|
3950
4319
|
declare const index_d$2_getLabel: typeof getLabel;
|
|
@@ -3954,7 +4323,7 @@ declare const index_d$2_onLabelUpdated: typeof onLabelUpdated;
|
|
|
3954
4323
|
declare const index_d$2_queryLabels: typeof queryLabels;
|
|
3955
4324
|
declare const index_d$2_renameLabel: typeof renameLabel;
|
|
3956
4325
|
declare namespace index_d$2 {
|
|
3957
|
-
export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type index_d$2_ContactLabel as ContactLabel, type index_d$2_ContactLabelNamespace as ContactLabelNamespace, type index_d$2_ContactLabelNonNullableFields as ContactLabelNonNullableFields, type index_d$2_DeleteLabelRequest as DeleteLabelRequest, type index_d$2_DeleteLabelResponse as DeleteLabelResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type index_d$2_FindOrCreateLabelOptions as FindOrCreateLabelOptions, type index_d$2_FindOrCreateLabelRequest as FindOrCreateLabelRequest, type index_d$2_FindOrCreateLabelResponse as FindOrCreateLabelResponse, type index_d$2_FindOrCreateLabelResponseNonNullableFields as FindOrCreateLabelResponseNonNullableFields, type index_d$2_GdprListRequest as GdprListRequest, type index_d$2_GdprListResponse as GdprListResponse, type index_d$2_GetLabelByLegacyIdRequest as GetLabelByLegacyIdRequest, type index_d$2_GetLabelByLegacyIdResponse as GetLabelByLegacyIdResponse, type index_d$2_GetLabelOptions as GetLabelOptions, type index_d$2_GetLabelRequest as GetLabelRequest, type index_d$2_GetLabelResponse as GetLabelResponse, type index_d$2_GetLabelResponseNonNullableFields as GetLabelResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$2_LabelCreatedEnvelope as LabelCreatedEnvelope, type index_d$2_LabelDeletedEnvelope as LabelDeletedEnvelope, index_d$2_LabelType as LabelType, type index_d$2_LabelUpdatedEnvelope as LabelUpdatedEnvelope, type index_d$2_LabelsQueryBuilder as LabelsQueryBuilder, type index_d$2_LabelsQueryResult as LabelsQueryResult, type index_d$2_LabelsQuotaReached as LabelsQuotaReached, type index_d$2_ListLabelNamespacesRequest as ListLabelNamespacesRequest, type index_d$2_ListLabelNamespacesResponse as ListLabelNamespacesResponse, type index_d$2_ListLabelsRequest as ListLabelsRequest, type index_d$2_ListLabelsResponse as ListLabelsResponse, type MessageEnvelope$2 as MessageEnvelope, type Paging$1 as Paging, type index_d$2_PagingMetadata as PagingMetadata, type index_d$2_PurgeRequest as PurgeRequest, type index_d$2_PurgeResponse as PurgeResponse, type index_d$2_Query as Query, type index_d$2_QueryLabelsOptions as QueryLabelsOptions, type index_d$2_QueryLabelsRequest as QueryLabelsRequest, type index_d$2_QueryLabelsResponse as QueryLabelsResponse, type index_d$2_QueryLabelsResponseNonNullableFields as QueryLabelsResponseNonNullableFields, type index_d$2_RenameLabel as RenameLabel, type index_d$2_RenameLabelOptions as RenameLabelOptions, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, type index_d$2_UndeleteInfo as UndeleteInfo, type index_d$2_UpdateLabelRequest as UpdateLabelRequest, type index_d$2_UpdateLabelResponse as UpdateLabelResponse, type index_d$2_UpdateLabelResponseNonNullableFields as UpdateLabelResponseNonNullableFields, WebhookIdentityType$2 as WebhookIdentityType, type index_d$
|
|
4326
|
+
export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type index_d$2_ContactLabel as ContactLabel, type index_d$2_ContactLabelNamespace as ContactLabelNamespace, type index_d$2_ContactLabelNonNullableFields as ContactLabelNonNullableFields, type index_d$2_DeleteLabelRequest as DeleteLabelRequest, type index_d$2_DeleteLabelResponse as DeleteLabelResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type index_d$2_FindOrCreateLabelOptions as FindOrCreateLabelOptions, type index_d$2_FindOrCreateLabelRequest as FindOrCreateLabelRequest, type index_d$2_FindOrCreateLabelResponse as FindOrCreateLabelResponse, type index_d$2_FindOrCreateLabelResponseNonNullableFields as FindOrCreateLabelResponseNonNullableFields, type index_d$2_GdprListRequest as GdprListRequest, type index_d$2_GdprListResponse as GdprListResponse, type index_d$2_GetLabelByLegacyIdRequest as GetLabelByLegacyIdRequest, type index_d$2_GetLabelByLegacyIdResponse as GetLabelByLegacyIdResponse, type index_d$2_GetLabelOptions as GetLabelOptions, type index_d$2_GetLabelRequest as GetLabelRequest, type index_d$2_GetLabelResponse as GetLabelResponse, type index_d$2_GetLabelResponseNonNullableFields as GetLabelResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$2_LabelCreatedEnvelope as LabelCreatedEnvelope, type index_d$2_LabelDeletedEnvelope as LabelDeletedEnvelope, index_d$2_LabelType as LabelType, type index_d$2_LabelUpdatedEnvelope as LabelUpdatedEnvelope, type index_d$2_LabelsQueryBuilder as LabelsQueryBuilder, type index_d$2_LabelsQueryResult as LabelsQueryResult, type index_d$2_LabelsQuotaReached as LabelsQuotaReached, type index_d$2_ListLabelNamespacesRequest as ListLabelNamespacesRequest, type index_d$2_ListLabelNamespacesResponse as ListLabelNamespacesResponse, type index_d$2_ListLabelsRequest as ListLabelsRequest, type index_d$2_ListLabelsResponse as ListLabelsResponse, type MessageEnvelope$2 as MessageEnvelope, type Paging$1 as Paging, type index_d$2_PagingMetadata as PagingMetadata, type index_d$2_PurgeRequest as PurgeRequest, type index_d$2_PurgeResponse as PurgeResponse, type index_d$2_Query as Query, type index_d$2_QueryLabelsOptions as QueryLabelsOptions, type index_d$2_QueryLabelsRequest as QueryLabelsRequest, type index_d$2_QueryLabelsResponse as QueryLabelsResponse, type index_d$2_QueryLabelsResponseNonNullableFields as QueryLabelsResponseNonNullableFields, type index_d$2_RenameLabel as RenameLabel, type index_d$2_RenameLabelOptions as RenameLabelOptions, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, type index_d$2_UndeleteInfo as UndeleteInfo, type index_d$2_UpdateLabelRequest as UpdateLabelRequest, type index_d$2_UpdateLabelResponse as UpdateLabelResponse, type index_d$2_UpdateLabelResponseNonNullableFields as UpdateLabelResponseNonNullableFields, WebhookIdentityType$2 as WebhookIdentityType, type index_d$2__publicOnLabelCreatedType as _publicOnLabelCreatedType, type index_d$2__publicOnLabelDeletedType as _publicOnLabelDeletedType, type index_d$2__publicOnLabelUpdatedType as _publicOnLabelUpdatedType, index_d$2_deleteLabel as deleteLabel, index_d$2_findOrCreateLabel as findOrCreateLabel, index_d$2_getLabel as getLabel, index_d$2_onLabelCreated as onLabelCreated, index_d$2_onLabelDeleted as onLabelDeleted, index_d$2_onLabelUpdated as onLabelUpdated, onLabelCreated$1 as publicOnLabelCreated, onLabelDeleted$1 as publicOnLabelDeleted, onLabelUpdated$1 as publicOnLabelUpdated, index_d$2_queryLabels as queryLabels, index_d$2_renameLabel as renameLabel };
|
|
3958
4327
|
}
|
|
3959
4328
|
|
|
3960
4329
|
/** Dummy message for fqdn validation */
|
|
@@ -4545,12 +4914,18 @@ interface AppendOrCreateContactOptions {
|
|
|
4545
4914
|
contactId?: string | null;
|
|
4546
4915
|
}
|
|
4547
4916
|
|
|
4548
|
-
declare function appendOrCreateContact$1(httpClient: HttpClient):
|
|
4549
|
-
|
|
4550
|
-
|
|
4917
|
+
declare function appendOrCreateContact$1(httpClient: HttpClient): AppendOrCreateContactSignature;
|
|
4918
|
+
interface AppendOrCreateContactSignature {
|
|
4919
|
+
/**
|
|
4920
|
+
* Appends an existing contact or creates a contact if it doesn't exist.
|
|
4921
|
+
*
|
|
4922
|
+
* For internal docs, see
|
|
4923
|
+
* [Submit Contacts](crm.contact-submit-service.introduction).
|
|
4924
|
+
*/
|
|
4925
|
+
(options?: AppendOrCreateContactOptions | undefined): Promise<SubmitContactResponse & SubmitContactResponseNonNullableFields>;
|
|
4926
|
+
}
|
|
4551
4927
|
|
|
4552
|
-
|
|
4553
|
-
declare const appendOrCreateContact: ReturnType<typeof createRESTModule$1<_publicAppendOrCreateContactType>>;
|
|
4928
|
+
declare const appendOrCreateContact: BuildRESTFunction<typeof appendOrCreateContact$1> & typeof appendOrCreateContact$1;
|
|
4554
4929
|
|
|
4555
4930
|
type index_d$1_ActivityIcon = ActivityIcon;
|
|
4556
4931
|
type index_d$1_Address = Address;
|
|
@@ -4598,10 +4973,9 @@ type index_d$1_SubmitOperation = SubmitOperation;
|
|
|
4598
4973
|
declare const index_d$1_SubmitOperation: typeof SubmitOperation;
|
|
4599
4974
|
type index_d$1_SubmitVisitorIdRequest = SubmitVisitorIdRequest;
|
|
4600
4975
|
type index_d$1_SubmitVisitorIdResponse = SubmitVisitorIdResponse;
|
|
4601
|
-
type index_d$1__publicAppendOrCreateContactType = _publicAppendOrCreateContactType;
|
|
4602
4976
|
declare const index_d$1_appendOrCreateContact: typeof appendOrCreateContact;
|
|
4603
4977
|
declare namespace index_d$1 {
|
|
4604
|
-
export { type index_d$1_ActivityIcon as ActivityIcon, type index_d$1_Address as Address, type index_d$1_AddressLocation as AddressLocation, type index_d$1_AddressStreetOneOf as AddressStreetOneOf, index_d$1_AddressTag as AddressTag, type index_d$1_AppendOrCreateContactOptions as AppendOrCreateContactOptions, type index_d$1_AssigneesWrapper as AssigneesWrapper, type index_d$1_ContactActivity as ContactActivity, index_d$1_ContactActivityType as ContactActivityType, type index_d$1_ContactAddress as ContactAddress, type index_d$1_ContactAddressesWrapper as ContactAddressesWrapper, type index_d$1_ContactEmail as ContactEmail, type index_d$1_ContactEmailsWrapper as ContactEmailsWrapper, type ContactInfo$1 as ContactInfo, type index_d$1_ContactName as ContactName, type index_d$1_ContactPhone as ContactPhone, type index_d$1_ContactPhonesWrapper as ContactPhonesWrapper, type index_d$1_ContactPicture as ContactPicture, index_d$1_ContactSourceType as ContactSourceType, type index_d$1_ContactToSubmit as ContactToSubmit, index_d$1_EmailTag as EmailTag, type index_d$1_ExtendedFieldsWrapper as ExtendedFieldsWrapper, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, index_d$1_IdentityType as IdentityType, index_d$1_ImageProvider as ImageProvider, type index_d$1_LabelsWrapper as LabelsWrapper, type index_d$1_LocationsWrapper as LocationsWrapper, type MessageEnvelope$1 as MessageEnvelope, index_d$1_PhoneTag as PhoneTag, type index_d$1_StreetAddress as StreetAddress, type index_d$1_Subdivision as Subdivision, index_d$1_SubdivisionType as SubdivisionType, type index_d$1_SubmitContact as SubmitContact, type index_d$1_SubmitContactOptions as SubmitContactOptions, type index_d$1_SubmitContactRequest as SubmitContactRequest, type index_d$1_SubmitContactResponse as SubmitContactResponse, type index_d$1_SubmitContactResponseNonNullableFields as SubmitContactResponseNonNullableFields, index_d$1_SubmitOperation as SubmitOperation, type index_d$1_SubmitVisitorIdRequest as SubmitVisitorIdRequest, type index_d$1_SubmitVisitorIdResponse as SubmitVisitorIdResponse, WebhookIdentityType$1 as WebhookIdentityType,
|
|
4978
|
+
export { type index_d$1_ActivityIcon as ActivityIcon, type index_d$1_Address as Address, type index_d$1_AddressLocation as AddressLocation, type index_d$1_AddressStreetOneOf as AddressStreetOneOf, index_d$1_AddressTag as AddressTag, type index_d$1_AppendOrCreateContactOptions as AppendOrCreateContactOptions, type index_d$1_AssigneesWrapper as AssigneesWrapper, type index_d$1_ContactActivity as ContactActivity, index_d$1_ContactActivityType as ContactActivityType, type index_d$1_ContactAddress as ContactAddress, type index_d$1_ContactAddressesWrapper as ContactAddressesWrapper, type index_d$1_ContactEmail as ContactEmail, type index_d$1_ContactEmailsWrapper as ContactEmailsWrapper, type ContactInfo$1 as ContactInfo, type index_d$1_ContactName as ContactName, type index_d$1_ContactPhone as ContactPhone, type index_d$1_ContactPhonesWrapper as ContactPhonesWrapper, type index_d$1_ContactPicture as ContactPicture, index_d$1_ContactSourceType as ContactSourceType, type index_d$1_ContactToSubmit as ContactToSubmit, index_d$1_EmailTag as EmailTag, type index_d$1_ExtendedFieldsWrapper as ExtendedFieldsWrapper, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, index_d$1_IdentityType as IdentityType, index_d$1_ImageProvider as ImageProvider, type index_d$1_LabelsWrapper as LabelsWrapper, type index_d$1_LocationsWrapper as LocationsWrapper, type MessageEnvelope$1 as MessageEnvelope, index_d$1_PhoneTag as PhoneTag, type index_d$1_StreetAddress as StreetAddress, type index_d$1_Subdivision as Subdivision, index_d$1_SubdivisionType as SubdivisionType, type index_d$1_SubmitContact as SubmitContact, type index_d$1_SubmitContactOptions as SubmitContactOptions, type index_d$1_SubmitContactRequest as SubmitContactRequest, type index_d$1_SubmitContactResponse as SubmitContactResponse, type index_d$1_SubmitContactResponseNonNullableFields as SubmitContactResponseNonNullableFields, index_d$1_SubmitOperation as SubmitOperation, type index_d$1_SubmitVisitorIdRequest as SubmitVisitorIdRequest, type index_d$1_SubmitVisitorIdResponse as SubmitVisitorIdResponse, WebhookIdentityType$1 as WebhookIdentityType, index_d$1_appendOrCreateContact as appendOrCreateContact };
|
|
4605
4979
|
}
|
|
4606
4980
|
|
|
4607
4981
|
interface Task {
|
|
@@ -5237,47 +5611,137 @@ interface MoveTaskAfterOptions {
|
|
|
5237
5611
|
beforeTaskId?: string | null;
|
|
5238
5612
|
}
|
|
5239
5613
|
|
|
5240
|
-
declare function createTask$1(httpClient: HttpClient):
|
|
5241
|
-
|
|
5242
|
-
|
|
5243
|
-
|
|
5244
|
-
|
|
5245
|
-
|
|
5246
|
-
|
|
5614
|
+
declare function createTask$1(httpClient: HttpClient): CreateTaskSignature;
|
|
5615
|
+
interface CreateTaskSignature {
|
|
5616
|
+
/**
|
|
5617
|
+
* Creates a new task.
|
|
5618
|
+
*
|
|
5619
|
+
* All fields in the `task` object are optional. If you don't pass any fields in the `task` object, the function returns a task with the following core properties:
|
|
5620
|
+
* - `_id`
|
|
5621
|
+
* - `_createdDate`
|
|
5622
|
+
* - `_updatedDate`
|
|
5623
|
+
* - `status`
|
|
5624
|
+
* - `source`
|
|
5625
|
+
* - `revision`
|
|
5626
|
+
*
|
|
5627
|
+
* @param - Task to create.
|
|
5628
|
+
* @returns The created task.
|
|
5629
|
+
*/
|
|
5630
|
+
(task: Task): Promise<Task & TaskNonNullableFields>;
|
|
5631
|
+
}
|
|
5632
|
+
declare function getTask$1(httpClient: HttpClient): GetTaskSignature;
|
|
5633
|
+
interface GetTaskSignature {
|
|
5634
|
+
/**
|
|
5635
|
+
* Retrieves a task by ID.
|
|
5636
|
+
* @param - ID of the task to retrieve.
|
|
5637
|
+
* @returns The retrieved task.
|
|
5638
|
+
*/
|
|
5639
|
+
(taskId: string): Promise<Task & TaskNonNullableFields>;
|
|
5640
|
+
}
|
|
5641
|
+
declare function updateTask$1(httpClient: HttpClient): UpdateTaskSignature;
|
|
5642
|
+
interface UpdateTaskSignature {
|
|
5643
|
+
/**
|
|
5644
|
+
* Updates a task.
|
|
5645
|
+
*
|
|
5646
|
+
* Each time the task is updated, `revision` increments by 1.
|
|
5647
|
+
* The existing `revision` must be included when updating the task.
|
|
5648
|
+
* This ensures you're working with the latest task
|
|
5649
|
+
* and prevents unintended overwrites.
|
|
5650
|
+
* @param - Task ID.
|
|
5651
|
+
* @param - Task to update.
|
|
5652
|
+
* @returns The updated task.
|
|
5653
|
+
*/
|
|
5654
|
+
(_id: string | null, task: UpdateTask): Promise<Task & TaskNonNullableFields>;
|
|
5655
|
+
}
|
|
5656
|
+
declare function deleteTask$1(httpClient: HttpClient): DeleteTaskSignature;
|
|
5657
|
+
interface DeleteTaskSignature {
|
|
5658
|
+
/**
|
|
5659
|
+
* Deletes a task by ID.
|
|
5660
|
+
* @param - ID of the task to delete.
|
|
5661
|
+
*/
|
|
5662
|
+
(taskId: string): Promise<void>;
|
|
5663
|
+
}
|
|
5664
|
+
declare function queryTasks$1(httpClient: HttpClient): QueryTasksSignature;
|
|
5665
|
+
interface QueryTasksSignature {
|
|
5666
|
+
/**
|
|
5667
|
+
* Creates a query to retrieve a list of tasks.
|
|
5668
|
+
*
|
|
5669
|
+
* The `queryTasks()` function builds a query to retrieve a list of tasks and returns a `TasksQueryBuilder` object.
|
|
5670
|
+
*
|
|
5671
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` function. You can refine the query by chaining `TasksQueryBuilder` functions onto the query. `TasksQueryBuilder` functions enable you to sort, filter, and control the results that `queryTasks()` returns.
|
|
5672
|
+
*
|
|
5673
|
+
* `queryTasks()` runs with these `TasksQueryBuilder` defaults, which you can override:
|
|
5674
|
+
* - `limit(50)`
|
|
5675
|
+
* - `descending('_createdDate')`
|
|
5676
|
+
*
|
|
5677
|
+
* The functions that are chained to `queryTasks()` are applied in the order they are called. For example, if you apply `ascending('_createdDate')` and then `descending('_updatedDate')`, the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.
|
|
5678
|
+
*
|
|
5679
|
+
* The following `TasksQueryBuilder` functions are supported for `queryTasks()`. For a full description of the `task` object, see the object returned for the `items` property in `TasksQueryResult`.
|
|
5680
|
+
*/
|
|
5681
|
+
(): TasksQueryBuilder;
|
|
5682
|
+
}
|
|
5683
|
+
declare function countTasks$1(httpClient: HttpClient): CountTasksSignature;
|
|
5684
|
+
interface CountTasksSignature {
|
|
5685
|
+
/**
|
|
5686
|
+
* Counts the number of tasks.
|
|
5687
|
+
*
|
|
5688
|
+
*
|
|
5689
|
+
* This endpoint returns the count of all tasks regardless of the task `status`.
|
|
5690
|
+
*
|
|
5691
|
+
* Optionally, you can pass a filter to count only tasks based
|
|
5692
|
+
* on specified criteria.
|
|
5693
|
+
* @param - Filtering options.
|
|
5694
|
+
*/
|
|
5695
|
+
(options?: CountTasksOptions | undefined): Promise<CountTasksResponse & CountTasksResponseNonNullableFields>;
|
|
5696
|
+
}
|
|
5697
|
+
declare function moveTaskAfter$1(httpClient: HttpClient): MoveTaskAfterSignature;
|
|
5698
|
+
interface MoveTaskAfterSignature {
|
|
5699
|
+
/**
|
|
5700
|
+
* Moves a task specified by ID to be placed after another task in the display.
|
|
5701
|
+
*
|
|
5702
|
+
* You can reposition a task to be first in the display by ommitting `beforeTaskId`.
|
|
5703
|
+
* @param - The task ID to move.
|
|
5704
|
+
* @param - Options for moving the task.
|
|
5705
|
+
*/
|
|
5706
|
+
(taskId: string, options?: MoveTaskAfterOptions | undefined): Promise<void>;
|
|
5707
|
+
}
|
|
5247
5708
|
declare const onTaskOverdue$1: EventDefinition<TaskOverdueEnvelope, "wix.crm.tasks.v2.task_task_overdue">;
|
|
5248
5709
|
declare const onTaskCreated$1: EventDefinition<TaskCreatedEnvelope, "wix.crm.tasks.v2.task_created">;
|
|
5249
5710
|
declare const onTaskUpdated$1: EventDefinition<TaskUpdatedEnvelope, "wix.crm.tasks.v2.task_updated">;
|
|
5250
5711
|
declare const onTaskDeleted$1: EventDefinition<TaskDeletedEnvelope, "wix.crm.tasks.v2.task_deleted">;
|
|
5251
5712
|
|
|
5252
|
-
declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
5253
|
-
|
|
5254
5713
|
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
5255
5714
|
|
|
5256
|
-
|
|
5257
|
-
declare const
|
|
5258
|
-
|
|
5259
|
-
declare const
|
|
5260
|
-
|
|
5261
|
-
declare const
|
|
5262
|
-
|
|
5263
|
-
declare const deleteTask: ReturnType<typeof createRESTModule<_publicDeleteTaskType>>;
|
|
5264
|
-
type _publicQueryTasksType = typeof queryTasks$1;
|
|
5265
|
-
declare const queryTasks: ReturnType<typeof createRESTModule<_publicQueryTasksType>>;
|
|
5266
|
-
type _publicCountTasksType = typeof countTasks$1;
|
|
5267
|
-
declare const countTasks: ReturnType<typeof createRESTModule<_publicCountTasksType>>;
|
|
5268
|
-
type _publicMoveTaskAfterType = typeof moveTaskAfter$1;
|
|
5269
|
-
declare const moveTaskAfter: ReturnType<typeof createRESTModule<_publicMoveTaskAfterType>>;
|
|
5715
|
+
declare const createTask: BuildRESTFunction<typeof createTask$1> & typeof createTask$1;
|
|
5716
|
+
declare const getTask: BuildRESTFunction<typeof getTask$1> & typeof getTask$1;
|
|
5717
|
+
declare const updateTask: BuildRESTFunction<typeof updateTask$1> & typeof updateTask$1;
|
|
5718
|
+
declare const deleteTask: BuildRESTFunction<typeof deleteTask$1> & typeof deleteTask$1;
|
|
5719
|
+
declare const queryTasks: BuildRESTFunction<typeof queryTasks$1> & typeof queryTasks$1;
|
|
5720
|
+
declare const countTasks: BuildRESTFunction<typeof countTasks$1> & typeof countTasks$1;
|
|
5721
|
+
declare const moveTaskAfter: BuildRESTFunction<typeof moveTaskAfter$1> & typeof moveTaskAfter$1;
|
|
5270
5722
|
|
|
5271
5723
|
type _publicOnTaskOverdueType = typeof onTaskOverdue$1;
|
|
5724
|
+
/**
|
|
5725
|
+
* Triggered when a task reaches its due date.
|
|
5726
|
+
*/
|
|
5272
5727
|
declare const onTaskOverdue: ReturnType<typeof createEventModule<_publicOnTaskOverdueType>>;
|
|
5273
5728
|
|
|
5274
5729
|
type _publicOnTaskCreatedType = typeof onTaskCreated$1;
|
|
5730
|
+
/**
|
|
5731
|
+
* Triggered when a task is created.
|
|
5732
|
+
*/
|
|
5275
5733
|
declare const onTaskCreated: ReturnType<typeof createEventModule<_publicOnTaskCreatedType>>;
|
|
5276
5734
|
|
|
5277
5735
|
type _publicOnTaskUpdatedType = typeof onTaskUpdated$1;
|
|
5736
|
+
/**
|
|
5737
|
+
* Triggered when a task is updated.
|
|
5738
|
+
*/
|
|
5278
5739
|
declare const onTaskUpdated: ReturnType<typeof createEventModule<_publicOnTaskUpdatedType>>;
|
|
5279
5740
|
|
|
5280
5741
|
type _publicOnTaskDeletedType = typeof onTaskDeleted$1;
|
|
5742
|
+
/**
|
|
5743
|
+
* Triggered when a task is deleted.
|
|
5744
|
+
*/
|
|
5281
5745
|
declare const onTaskDeleted: ReturnType<typeof createEventModule<_publicOnTaskDeletedType>>;
|
|
5282
5746
|
|
|
5283
5747
|
type index_d_ActionEvent = ActionEvent;
|
|
@@ -5355,17 +5819,10 @@ type index_d_UpdateTaskResponse = UpdateTaskResponse;
|
|
|
5355
5819
|
type index_d_UpdateTaskResponseNonNullableFields = UpdateTaskResponseNonNullableFields;
|
|
5356
5820
|
type index_d_WebhookIdentityType = WebhookIdentityType;
|
|
5357
5821
|
declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
|
|
5358
|
-
type index_d__publicCountTasksType = _publicCountTasksType;
|
|
5359
|
-
type index_d__publicCreateTaskType = _publicCreateTaskType;
|
|
5360
|
-
type index_d__publicDeleteTaskType = _publicDeleteTaskType;
|
|
5361
|
-
type index_d__publicGetTaskType = _publicGetTaskType;
|
|
5362
|
-
type index_d__publicMoveTaskAfterType = _publicMoveTaskAfterType;
|
|
5363
5822
|
type index_d__publicOnTaskCreatedType = _publicOnTaskCreatedType;
|
|
5364
5823
|
type index_d__publicOnTaskDeletedType = _publicOnTaskDeletedType;
|
|
5365
5824
|
type index_d__publicOnTaskOverdueType = _publicOnTaskOverdueType;
|
|
5366
5825
|
type index_d__publicOnTaskUpdatedType = _publicOnTaskUpdatedType;
|
|
5367
|
-
type index_d__publicQueryTasksType = _publicQueryTasksType;
|
|
5368
|
-
type index_d__publicUpdateTaskType = _publicUpdateTaskType;
|
|
5369
5826
|
declare const index_d_countTasks: typeof countTasks;
|
|
5370
5827
|
declare const index_d_createTask: typeof createTask;
|
|
5371
5828
|
declare const index_d_deleteTask: typeof deleteTask;
|
|
@@ -5378,7 +5835,7 @@ declare const index_d_onTaskUpdated: typeof onTaskUpdated;
|
|
|
5378
5835
|
declare const index_d_queryTasks: typeof queryTasks;
|
|
5379
5836
|
declare const index_d_updateTask: typeof updateTask;
|
|
5380
5837
|
declare namespace index_d {
|
|
5381
|
-
export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_ContactInfo as ContactInfo, type index_d_ContactNotFoundError as ContactNotFoundError, type index_d_CountTasksOptions as CountTasksOptions, type index_d_CountTasksRequest as CountTasksRequest, type index_d_CountTasksResponse as CountTasksResponse, type index_d_CountTasksResponseNonNullableFields as CountTasksResponseNonNullableFields, type index_d_CreateTaskRequest as CreateTaskRequest, type index_d_CreateTaskResponse as CreateTaskResponse, type index_d_CreateTaskResponseNonNullableFields as CreateTaskResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DeleteCompletedTasksRequest as DeleteCompletedTasksRequest, type index_d_DeleteCompletedTasksResponse as DeleteCompletedTasksResponse, type index_d_DeleteTaskRequest as DeleteTaskRequest, type index_d_DeleteTaskResponse as DeleteTaskResponse, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_GetTaskRequest as GetTaskRequest, type index_d_GetTaskResponse as GetTaskResponse, type index_d_GetTaskResponseNonNullableFields as GetTaskResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MoveTaskAfterOptions as MoveTaskAfterOptions, type index_d_MoveTaskAfterRequest as MoveTaskAfterRequest, type index_d_MoveTaskAfterResponse as MoveTaskAfterResponse, type index_d_Paging as Paging, type index_d_PagingMetadataV2 as PagingMetadataV2, type index_d_QueryTasksInternalRequest as QueryTasksInternalRequest, type index_d_QueryTasksInternalResponse as QueryTasksInternalResponse, type index_d_QueryTasksRequest as QueryTasksRequest, type index_d_QueryTasksResponse as QueryTasksResponse, type index_d_QueryTasksResponseNonNullableFields as QueryTasksResponseNonNullableFields, type index_d_QueryV2 as QueryV2, type index_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, index_d_ReminderType as ReminderType, type index_d_RepositionTask as RepositionTask, type index_d_SendTasksReminderRequest as SendTasksReminderRequest, type index_d_SendTasksReminderResponse as SendTasksReminderResponse, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_SourceType as SourceType, type index_d_Task as Task, type index_d_TaskAssigned as TaskAssigned, type index_d_TaskCreatedEnvelope as TaskCreatedEnvelope, type index_d_TaskDeletedEnvelope as TaskDeletedEnvelope, type index_d_TaskNonNullableFields as TaskNonNullableFields, type index_d_TaskNotFoundError as TaskNotFoundError, type index_d_TaskOverdue as TaskOverdue, type index_d_TaskOverdueEnvelope as TaskOverdueEnvelope, type index_d_TaskSource as TaskSource, index_d_TaskStatus as TaskStatus, type index_d_TaskUpdatedEnvelope as TaskUpdatedEnvelope, type index_d_TasksQueryBuilder as TasksQueryBuilder, type index_d_TasksQueryResult as TasksQueryResult, type index_d_UpdateTask as UpdateTask, type index_d_UpdateTaskRequest as UpdateTaskRequest, type index_d_UpdateTaskResponse as UpdateTaskResponse, type index_d_UpdateTaskResponseNonNullableFields as UpdateTaskResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, type
|
|
5838
|
+
export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_ContactInfo as ContactInfo, type index_d_ContactNotFoundError as ContactNotFoundError, type index_d_CountTasksOptions as CountTasksOptions, type index_d_CountTasksRequest as CountTasksRequest, type index_d_CountTasksResponse as CountTasksResponse, type index_d_CountTasksResponseNonNullableFields as CountTasksResponseNonNullableFields, type index_d_CreateTaskRequest as CreateTaskRequest, type index_d_CreateTaskResponse as CreateTaskResponse, type index_d_CreateTaskResponseNonNullableFields as CreateTaskResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DeleteCompletedTasksRequest as DeleteCompletedTasksRequest, type index_d_DeleteCompletedTasksResponse as DeleteCompletedTasksResponse, type index_d_DeleteTaskRequest as DeleteTaskRequest, type index_d_DeleteTaskResponse as DeleteTaskResponse, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_GetTaskRequest as GetTaskRequest, type index_d_GetTaskResponse as GetTaskResponse, type index_d_GetTaskResponseNonNullableFields as GetTaskResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MoveTaskAfterOptions as MoveTaskAfterOptions, type index_d_MoveTaskAfterRequest as MoveTaskAfterRequest, type index_d_MoveTaskAfterResponse as MoveTaskAfterResponse, type index_d_Paging as Paging, type index_d_PagingMetadataV2 as PagingMetadataV2, type index_d_QueryTasksInternalRequest as QueryTasksInternalRequest, type index_d_QueryTasksInternalResponse as QueryTasksInternalResponse, type index_d_QueryTasksRequest as QueryTasksRequest, type index_d_QueryTasksResponse as QueryTasksResponse, type index_d_QueryTasksResponseNonNullableFields as QueryTasksResponseNonNullableFields, type index_d_QueryV2 as QueryV2, type index_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, index_d_ReminderType as ReminderType, type index_d_RepositionTask as RepositionTask, type index_d_SendTasksReminderRequest as SendTasksReminderRequest, type index_d_SendTasksReminderResponse as SendTasksReminderResponse, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_SourceType as SourceType, type index_d_Task as Task, type index_d_TaskAssigned as TaskAssigned, type index_d_TaskCreatedEnvelope as TaskCreatedEnvelope, type index_d_TaskDeletedEnvelope as TaskDeletedEnvelope, type index_d_TaskNonNullableFields as TaskNonNullableFields, type index_d_TaskNotFoundError as TaskNotFoundError, type index_d_TaskOverdue as TaskOverdue, type index_d_TaskOverdueEnvelope as TaskOverdueEnvelope, type index_d_TaskSource as TaskSource, index_d_TaskStatus as TaskStatus, type index_d_TaskUpdatedEnvelope as TaskUpdatedEnvelope, type index_d_TasksQueryBuilder as TasksQueryBuilder, type index_d_TasksQueryResult as TasksQueryResult, type index_d_UpdateTask as UpdateTask, type index_d_UpdateTaskRequest as UpdateTaskRequest, type index_d_UpdateTaskResponse as UpdateTaskResponse, type index_d_UpdateTaskResponseNonNullableFields as UpdateTaskResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnTaskCreatedType as _publicOnTaskCreatedType, type index_d__publicOnTaskDeletedType as _publicOnTaskDeletedType, type index_d__publicOnTaskOverdueType as _publicOnTaskOverdueType, type index_d__publicOnTaskUpdatedType as _publicOnTaskUpdatedType, index_d_countTasks as countTasks, index_d_createTask as createTask, index_d_deleteTask as deleteTask, index_d_getTask as getTask, index_d_moveTaskAfter as moveTaskAfter, index_d_onTaskCreated as onTaskCreated, index_d_onTaskDeleted as onTaskDeleted, index_d_onTaskOverdue as onTaskOverdue, index_d_onTaskUpdated as onTaskUpdated, onTaskCreated$1 as publicOnTaskCreated, onTaskDeleted$1 as publicOnTaskDeleted, onTaskOverdue$1 as publicOnTaskOverdue, onTaskUpdated$1 as publicOnTaskUpdated, index_d_queryTasks as queryTasks, index_d_updateTask as updateTask };
|
|
5382
5839
|
}
|
|
5383
5840
|
|
|
5384
5841
|
export { index_d$5 as attachments, index_d$4 as contacts, index_d$3 as extendedFields, index_d$2 as labels, index_d$1 as submittedContact, index_d as tasks };
|