@wix/crm 1.0.160 → 1.0.161

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/crm",
3
- "version": "1.0.160",
3
+ "version": "1.0.161",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -21,7 +21,7 @@
21
21
  "type-bundles"
22
22
  ],
23
23
  "dependencies": {
24
- "@wix/crm_attachments": "1.0.21",
24
+ "@wix/crm_attachments": "1.0.22",
25
25
  "@wix/crm_contacts": "1.0.69",
26
26
  "@wix/crm_extended-fields": "1.0.48",
27
27
  "@wix/crm_labels": "1.0.47",
@@ -51,5 +51,5 @@
51
51
  "fqdn": ""
52
52
  }
53
53
  },
54
- "falconPackageHash": "593d6508c9ffd86f9313673f463abc379358ae1c7e6836d1c018e077"
54
+ "falconPackageHash": "d27de53a2cf0f8757cb445398137e3800f5796d9e3bf562b500319d6"
55
55
  }
@@ -477,46 +477,50 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
477
477
  } ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
478
478
 
479
479
  interface ContactAttachment extends ContactAttachmentMediaOneOf {
480
- /** The attachment's image (if the attachment is of type IMAGE) */
480
+ /** Image details when the attachment type is `IMAGE`. */
481
481
  image?: string;
482
- /** The attachment's document (if the attachment is of type OTHER) */
482
+ /** Document details when the attachment type is `OTHER`. */
483
483
  document?: string;
484
484
  /**
485
- * The id of the attachment.
485
+ * Attachment ID.
486
486
  * @readonly
487
487
  */
488
488
  _id?: string;
489
489
  /**
490
- * Image preview (reduced image size) of the attachment (if the attachment is of type IMAGE).
490
+ * Details of the preview image reduced size when the attachment is of type `IMAGE`.
491
491
  * @readonly
492
492
  */
493
493
  previewImage?: string;
494
494
  /**
495
- * The file name of the attachment.
495
+ * Name of the attachment file.
496
496
  * @readonly
497
497
  */
498
498
  fileName?: string;
499
499
  /**
500
- * The mime type of the attachment.
500
+ * Mime type of the attachment. See supported mime types
501
+ * ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
501
502
  * @readonly
502
503
  */
503
504
  mimeType?: string;
504
505
  /**
505
- * The type of the attachment
506
+ * Type of the attachment.
506
507
  * @readonly
507
508
  */
508
509
  attachmentType?: AttachmentType;
509
510
  }
510
511
  /** @oneof */
511
512
  interface ContactAttachmentMediaOneOf {
512
- /** The attachment's image (if the attachment is of type IMAGE) */
513
+ /** Image details when the attachment type is `IMAGE`. */
513
514
  image?: string;
514
- /** The attachment's document (if the attachment is of type OTHER) */
515
+ /** Document details when the attachment type is `OTHER`. */
515
516
  document?: string;
516
517
  }
517
518
  declare enum AttachmentType {
519
+ /** Unknown attachment type. */
518
520
  UNKNOWN = "UNKNOWN",
521
+ /** Attachment is an image file. */
519
522
  IMAGE = "IMAGE",
523
+ /** Attachment is a document or any non-image file type. */
520
524
  OTHER = "OTHER"
521
525
  }
522
526
  interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
@@ -542,7 +546,7 @@ interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
542
546
  slug?: string;
543
547
  /** ID of the entity associated with the event. */
544
548
  entityId?: string;
545
- /** Event timestamp. */
549
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
546
550
  eventTime?: Date | null;
547
551
  /**
548
552
  * Whether the event was triggered as a result of a privacy regulation application
@@ -571,6 +575,9 @@ interface DomainEventBodyOneOf$4 {
571
575
  interface EntityCreatedEvent$4 {
572
576
  entity?: string;
573
577
  }
578
+ interface RestoreInfo$4 {
579
+ deletedDate?: Date | null;
580
+ }
574
581
  interface EntityUpdatedEvent$4 {
575
582
  /**
576
583
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
@@ -663,11 +670,15 @@ interface CreateDemoAttachmentResponse {
663
670
  attachment?: ContactAttachment;
664
671
  }
665
672
  interface GenerateAttachmentUploadUrlRequest {
666
- /** ID of the contact whose attachment is being uploaded. */
673
+ /** ID of the contact for whom the attachment is being uploaded. */
667
674
  contactId: string;
668
- /** File name including the extension e.g: `contact-cv.pdf` */
675
+ /** File name of the attachment including the extension, for example, `contact-cv.pdf`. */
669
676
  fileName: string;
670
- /** Mime type e.g: `application/pdf` */
677
+ /**
678
+ * Mime type of the attachment file, for example, `application/pdf`.
679
+ * See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
680
+ * [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
681
+ */
671
682
  mimeType: string;
672
683
  }
673
684
  interface GenerateAttachmentUploadUrlResponse {
@@ -675,49 +686,54 @@ interface GenerateAttachmentUploadUrlResponse {
675
686
  uploadUrl?: string;
676
687
  }
677
688
  interface ListAttachmentsRequest {
678
- /** Contact ID */
689
+ /** Contact ID for the attachments to be listed. */
679
690
  contactId: string;
680
691
  /** Allow paginating, default: limit = 100 and offset = 0 */
681
692
  paging?: Paging$4;
682
693
  }
683
694
  interface Paging$4 {
684
- /** Number of items to return (default 100, max 100). */
695
+ /**
696
+ * Number of items to return.
697
+ *
698
+ * Default: `100`
699
+ * Max: `100`
700
+ */
685
701
  limit?: number | null;
686
- /** number of items to skip in the current sort order */
702
+ /** Number of items to skip in the current sort order. */
687
703
  offset?: number | null;
688
704
  }
689
705
  interface ListAttachmentsResponse {
690
- /** The requested attachments */
706
+ /** Liss of attachments for the specified contact. */
691
707
  attachments?: ContactAttachment[];
692
- /** Metadata for the page of results. */
708
+ /** Metadata for the paginated results. */
693
709
  metadata?: PagingMetadata$3;
694
710
  }
695
711
  interface PagingMetadata$3 {
696
- /** The number of items returned in this response */
712
+ /** Number of items returned in the response. */
697
713
  count?: number | null;
698
- /** The offset which was requested */
714
+ /** Offset that was requested. */
699
715
  offset?: number | null;
700
- /** The total number of items that match the query */
716
+ /** Total number of items that match the query. */
701
717
  total?: number | null;
702
- /** A flag that indicates the server failed to calculate 'total' field */
718
+ /** Whether the server failed to calculate the `total` field. */
703
719
  tooManyToCount?: boolean | null;
704
720
  }
705
721
  interface DeleteAttachmentRequest {
706
- /** Contact ID */
722
+ /** Contact ID for the attachment to delete. */
707
723
  contactId: string;
708
- /** Attachment ID. */
724
+ /** Attachment ID to delete. */
709
725
  attachmentId: string;
710
726
  }
711
727
  interface DeleteAttachmentResponse {
712
728
  }
713
729
  interface GetAttachmentRequest {
714
- /** Contact ID */
730
+ /** Contact ID for the attachment to retrieve. */
715
731
  contactId: string;
716
- /** Attachment ID. */
732
+ /** Attachment ID to retrieve. */
717
733
  attachmentId: string;
718
734
  }
719
735
  interface GetAttachmentResponse {
720
- /** The requested attachment */
736
+ /** The requested attachment. */
721
737
  attachment?: ContactAttachment;
722
738
  }
723
739
  interface MessageEnvelope$5 {
@@ -807,7 +823,7 @@ interface EventMetadata$4 extends BaseEventMetadata$4 {
807
823
  slug?: string;
808
824
  /** ID of the entity associated with the event. */
809
825
  entityId?: string;
810
- /** Event timestamp. */
826
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
811
827
  eventTime?: Date | null;
812
828
  /**
813
829
  * Whether the event was triggered as a result of a privacy regulation application
@@ -834,7 +850,11 @@ interface AttachmentDeletedEnvelope {
834
850
  metadata: EventMetadata$4;
835
851
  }
836
852
  interface GenerateAttachmentUploadUrlOptions {
837
- /** Mime type e.g: `application/pdf` */
853
+ /**
854
+ * Mime type of the attachment file, for example, `application/pdf`.
855
+ * See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
856
+ * [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
857
+ */
838
858
  mimeType: string;
839
859
  }
840
860
  interface ListAttachmentsOptions {
@@ -842,50 +862,50 @@ interface ListAttachmentsOptions {
842
862
  paging?: Paging$4;
843
863
  }
844
864
  interface DeleteAttachmentIdentifiers {
845
- /** Contact ID */
865
+ /** Contact ID for the attachment to delete. */
846
866
  contactId: string;
847
- /** Attachment ID. */
867
+ /** Attachment ID to delete. */
848
868
  attachmentId: string;
849
869
  }
850
870
  interface GetAttachmentIdentifiers {
851
- /** Contact ID */
871
+ /** Contact ID for the attachment to retrieve. */
852
872
  contactId: string;
853
- /** Attachment ID. */
873
+ /** Attachment ID to retrieve. */
854
874
  attachmentId: string;
855
875
  }
856
876
 
857
877
  declare function generateAttachmentUploadUrl$1(httpClient: HttpClient): GenerateAttachmentUploadUrlSignature;
858
878
  interface GenerateAttachmentUploadUrlSignature {
859
879
  /**
860
- * Generates an upload URL to allow external clients to upload a file as an attachment to a given contact.
880
+ * Generates an upload URL for uploading a file as an attachment to a specified contact.
861
881
  *
862
- * To learn how external clients can use the generated upload URL in the response to upload a file,
863
- * see the [Upload API](https://dev.wix.com/api/rest/media/media-manager/upload-api) article.
864
- * @param - ID of the contact whose attachment is being uploaded.
865
- * @param - File name including the extension e.g: `contact-cv.pdf`
882
+ * To learn how to use the generated upload URL in the response to upload an attachment file,
883
+ * see the Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api)).
884
+ * @param - ID of the contact for whom the attachment is being uploaded.
885
+ * @param - File name of the attachment including the extension, for example, `contact-cv.pdf`.
866
886
  */
867
887
  (contactId: string, fileName: string, options: GenerateAttachmentUploadUrlOptions): Promise<GenerateAttachmentUploadUrlResponse & GenerateAttachmentUploadUrlResponseNonNullableFields>;
868
888
  }
869
889
  declare function listAttachments$1(httpClient: HttpClient): ListAttachmentsSignature;
870
890
  interface ListAttachmentsSignature {
871
891
  /**
872
- * List Attachments.
873
- * @param - Contact ID
892
+ * Retrieves a list of attachments associated with a specified contact.
893
+ * @param - Contact ID for the attachments to be listed.
874
894
  */
875
895
  (contactId: string, options?: ListAttachmentsOptions | undefined): Promise<ListAttachmentsResponse & ListAttachmentsResponseNonNullableFields>;
876
896
  }
877
897
  declare function deleteAttachment$1(httpClient: HttpClient): DeleteAttachmentSignature;
878
898
  interface DeleteAttachmentSignature {
879
899
  /**
880
- * Deletes an attachment from contact
900
+ * Deletes the specified attachment from the specified contact.
881
901
  */
882
902
  (identifiers: DeleteAttachmentIdentifiers): Promise<void>;
883
903
  }
884
904
  declare function getAttachment$1(httpClient: HttpClient): GetAttachmentSignature;
885
905
  interface GetAttachmentSignature {
886
906
  /**
887
- * Retrieves an attachment.
888
- * @returns The requested attachment
907
+ * Retrieves the specified attachment for the specified contact.
908
+ * @returns The requested attachment.
889
909
  */
890
910
  (identifiers: GetAttachmentIdentifiers): Promise<ContactAttachment & ContactAttachmentNonNullableFields>;
891
911
  }
@@ -955,7 +975,7 @@ declare const context$5_listAttachments: typeof listAttachments;
955
975
  declare const context$5_onAttachmentCreated: typeof onAttachmentCreated;
956
976
  declare const context$5_onAttachmentDeleted: typeof onAttachmentDeleted;
957
977
  declare namespace context$5 {
958
- export { type ActionEvent$4 as ActionEvent, type context$5_AttachmentCreatedEnvelope as AttachmentCreatedEnvelope, type context$5_AttachmentDeletedEnvelope as AttachmentDeletedEnvelope, type context$5_AttachmentMedia as AttachmentMedia, type context$5_AttachmentMediaMediaOneOf as AttachmentMediaMediaOneOf, type context$5_AttachmentMetadata as AttachmentMetadata, type context$5_AttachmentSource as AttachmentSource, context$5_AttachmentType as AttachmentType, type BaseEventMetadata$4 as BaseEventMetadata, type context$5_ContactAttachment as ContactAttachment, type context$5_ContactAttachmentMediaOneOf as ContactAttachmentMediaOneOf, type context$5_ContactAttachmentNonNullableFields as ContactAttachmentNonNullableFields, type context$5_CreateDemoAttachmentRequest as CreateDemoAttachmentRequest, type context$5_CreateDemoAttachmentResponse as CreateDemoAttachmentResponse, type context$5_CrmAttachment as CrmAttachment, context$5_CrmAttachmentAttachmentType as CrmAttachmentAttachmentType, type context$5_CrmAttachmentUploadedEvent as CrmAttachmentUploadedEvent, type context$5_DeleteAttachmentIdentifiers as DeleteAttachmentIdentifiers, type context$5_DeleteAttachmentRequest as DeleteAttachmentRequest, type context$5_DeleteAttachmentResponse as DeleteAttachmentResponse, context$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 context$5_GenerateAttachmentUploadUrlOptions as GenerateAttachmentUploadUrlOptions, type context$5_GenerateAttachmentUploadUrlRequest as GenerateAttachmentUploadUrlRequest, type context$5_GenerateAttachmentUploadUrlResponse as GenerateAttachmentUploadUrlResponse, type context$5_GenerateAttachmentUploadUrlResponseNonNullableFields as GenerateAttachmentUploadUrlResponseNonNullableFields, type context$5_GetAttachmentIdentifiers as GetAttachmentIdentifiers, type context$5_GetAttachmentRequest as GetAttachmentRequest, type context$5_GetAttachmentResponse as GetAttachmentResponse, type context$5_GetAttachmentResponseNonNullableFields as GetAttachmentResponseNonNullableFields, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type context$5_ListAttachmentsOptions as ListAttachmentsOptions, type context$5_ListAttachmentsRequest as ListAttachmentsRequest, type context$5_ListAttachmentsResponse as ListAttachmentsResponse, type context$5_ListAttachmentsResponseNonNullableFields as ListAttachmentsResponseNonNullableFields, type context$5_MediaFileUploadedEvent as MediaFileUploadedEvent, type MessageEnvelope$5 as MessageEnvelope, type Paging$4 as Paging, type PagingMetadata$3 as PagingMetadata, WebhookIdentityType$5 as WebhookIdentityType, type context$5__publicOnAttachmentCreatedType as _publicOnAttachmentCreatedType, type context$5__publicOnAttachmentDeletedType as _publicOnAttachmentDeletedType, context$5_deleteAttachment as deleteAttachment, context$5_generateAttachmentUploadUrl as generateAttachmentUploadUrl, context$5_getAttachment as getAttachment, context$5_listAttachments as listAttachments, context$5_onAttachmentCreated as onAttachmentCreated, context$5_onAttachmentDeleted as onAttachmentDeleted, onAttachmentCreated$1 as publicOnAttachmentCreated, onAttachmentDeleted$1 as publicOnAttachmentDeleted };
978
+ export { type ActionEvent$4 as ActionEvent, type context$5_AttachmentCreatedEnvelope as AttachmentCreatedEnvelope, type context$5_AttachmentDeletedEnvelope as AttachmentDeletedEnvelope, type context$5_AttachmentMedia as AttachmentMedia, type context$5_AttachmentMediaMediaOneOf as AttachmentMediaMediaOneOf, type context$5_AttachmentMetadata as AttachmentMetadata, type context$5_AttachmentSource as AttachmentSource, context$5_AttachmentType as AttachmentType, type BaseEventMetadata$4 as BaseEventMetadata, type context$5_ContactAttachment as ContactAttachment, type context$5_ContactAttachmentMediaOneOf as ContactAttachmentMediaOneOf, type context$5_ContactAttachmentNonNullableFields as ContactAttachmentNonNullableFields, type context$5_CreateDemoAttachmentRequest as CreateDemoAttachmentRequest, type context$5_CreateDemoAttachmentResponse as CreateDemoAttachmentResponse, type context$5_CrmAttachment as CrmAttachment, context$5_CrmAttachmentAttachmentType as CrmAttachmentAttachmentType, type context$5_CrmAttachmentUploadedEvent as CrmAttachmentUploadedEvent, type context$5_DeleteAttachmentIdentifiers as DeleteAttachmentIdentifiers, type context$5_DeleteAttachmentRequest as DeleteAttachmentRequest, type context$5_DeleteAttachmentResponse as DeleteAttachmentResponse, context$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 context$5_GenerateAttachmentUploadUrlOptions as GenerateAttachmentUploadUrlOptions, type context$5_GenerateAttachmentUploadUrlRequest as GenerateAttachmentUploadUrlRequest, type context$5_GenerateAttachmentUploadUrlResponse as GenerateAttachmentUploadUrlResponse, type context$5_GenerateAttachmentUploadUrlResponseNonNullableFields as GenerateAttachmentUploadUrlResponseNonNullableFields, type context$5_GetAttachmentIdentifiers as GetAttachmentIdentifiers, type context$5_GetAttachmentRequest as GetAttachmentRequest, type context$5_GetAttachmentResponse as GetAttachmentResponse, type context$5_GetAttachmentResponseNonNullableFields as GetAttachmentResponseNonNullableFields, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type context$5_ListAttachmentsOptions as ListAttachmentsOptions, type context$5_ListAttachmentsRequest as ListAttachmentsRequest, type context$5_ListAttachmentsResponse as ListAttachmentsResponse, type context$5_ListAttachmentsResponseNonNullableFields as ListAttachmentsResponseNonNullableFields, type context$5_MediaFileUploadedEvent as MediaFileUploadedEvent, type MessageEnvelope$5 as MessageEnvelope, type Paging$4 as Paging, type PagingMetadata$3 as PagingMetadata, type RestoreInfo$4 as RestoreInfo, WebhookIdentityType$5 as WebhookIdentityType, type context$5__publicOnAttachmentCreatedType as _publicOnAttachmentCreatedType, type context$5__publicOnAttachmentDeletedType as _publicOnAttachmentDeletedType, context$5_deleteAttachment as deleteAttachment, context$5_generateAttachmentUploadUrl as generateAttachmentUploadUrl, context$5_getAttachment as getAttachment, context$5_listAttachments as listAttachments, context$5_onAttachmentCreated as onAttachmentCreated, context$5_onAttachmentDeleted as onAttachmentDeleted, onAttachmentCreated$1 as publicOnAttachmentCreated, onAttachmentDeleted$1 as publicOnAttachmentDeleted };
959
979
  }
960
980
 
961
981
  interface Contact {
@@ -477,46 +477,50 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
477
477
  } ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
478
478
 
479
479
  interface ContactAttachment extends ContactAttachmentMediaOneOf {
480
- /** The attachment's image (if the attachment is of type IMAGE) */
480
+ /** Image details when the attachment type is `IMAGE`. */
481
481
  image?: string;
482
- /** The attachment's document (if the attachment is of type OTHER) */
482
+ /** Document details when the attachment type is `OTHER`. */
483
483
  document?: string;
484
484
  /**
485
- * The id of the attachment.
485
+ * Attachment ID.
486
486
  * @readonly
487
487
  */
488
488
  _id?: string;
489
489
  /**
490
- * Image preview (reduced image size) of the attachment (if the attachment is of type IMAGE).
490
+ * Details of the preview image reduced size when the attachment is of type `IMAGE`.
491
491
  * @readonly
492
492
  */
493
493
  previewImage?: string;
494
494
  /**
495
- * The file name of the attachment.
495
+ * Name of the attachment file.
496
496
  * @readonly
497
497
  */
498
498
  fileName?: string;
499
499
  /**
500
- * The mime type of the attachment.
500
+ * Mime type of the attachment. See supported mime types
501
+ * ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
501
502
  * @readonly
502
503
  */
503
504
  mimeType?: string;
504
505
  /**
505
- * The type of the attachment
506
+ * Type of the attachment.
506
507
  * @readonly
507
508
  */
508
509
  attachmentType?: AttachmentType;
509
510
  }
510
511
  /** @oneof */
511
512
  interface ContactAttachmentMediaOneOf {
512
- /** The attachment's image (if the attachment is of type IMAGE) */
513
+ /** Image details when the attachment type is `IMAGE`. */
513
514
  image?: string;
514
- /** The attachment's document (if the attachment is of type OTHER) */
515
+ /** Document details when the attachment type is `OTHER`. */
515
516
  document?: string;
516
517
  }
517
518
  declare enum AttachmentType {
519
+ /** Unknown attachment type. */
518
520
  UNKNOWN = "UNKNOWN",
521
+ /** Attachment is an image file. */
519
522
  IMAGE = "IMAGE",
523
+ /** Attachment is a document or any non-image file type. */
520
524
  OTHER = "OTHER"
521
525
  }
522
526
  interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
@@ -542,7 +546,7 @@ interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
542
546
  slug?: string;
543
547
  /** ID of the entity associated with the event. */
544
548
  entityId?: string;
545
- /** Event timestamp. */
549
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
546
550
  eventTime?: Date | null;
547
551
  /**
548
552
  * Whether the event was triggered as a result of a privacy regulation application
@@ -571,6 +575,9 @@ interface DomainEventBodyOneOf$4 {
571
575
  interface EntityCreatedEvent$4 {
572
576
  entity?: string;
573
577
  }
578
+ interface RestoreInfo$4 {
579
+ deletedDate?: Date | null;
580
+ }
574
581
  interface EntityUpdatedEvent$4 {
575
582
  /**
576
583
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
@@ -663,11 +670,15 @@ interface CreateDemoAttachmentResponse {
663
670
  attachment?: ContactAttachment;
664
671
  }
665
672
  interface GenerateAttachmentUploadUrlRequest {
666
- /** ID of the contact whose attachment is being uploaded. */
673
+ /** ID of the contact for whom the attachment is being uploaded. */
667
674
  contactId: string;
668
- /** File name including the extension e.g: `contact-cv.pdf` */
675
+ /** File name of the attachment including the extension, for example, `contact-cv.pdf`. */
669
676
  fileName: string;
670
- /** Mime type e.g: `application/pdf` */
677
+ /**
678
+ * Mime type of the attachment file, for example, `application/pdf`.
679
+ * See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
680
+ * [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
681
+ */
671
682
  mimeType: string;
672
683
  }
673
684
  interface GenerateAttachmentUploadUrlResponse {
@@ -675,49 +686,54 @@ interface GenerateAttachmentUploadUrlResponse {
675
686
  uploadUrl?: string;
676
687
  }
677
688
  interface ListAttachmentsRequest {
678
- /** Contact ID */
689
+ /** Contact ID for the attachments to be listed. */
679
690
  contactId: string;
680
691
  /** Allow paginating, default: limit = 100 and offset = 0 */
681
692
  paging?: Paging$4;
682
693
  }
683
694
  interface Paging$4 {
684
- /** Number of items to return (default 100, max 100). */
695
+ /**
696
+ * Number of items to return.
697
+ *
698
+ * Default: `100`
699
+ * Max: `100`
700
+ */
685
701
  limit?: number | null;
686
- /** number of items to skip in the current sort order */
702
+ /** Number of items to skip in the current sort order. */
687
703
  offset?: number | null;
688
704
  }
689
705
  interface ListAttachmentsResponse {
690
- /** The requested attachments */
706
+ /** Liss of attachments for the specified contact. */
691
707
  attachments?: ContactAttachment[];
692
- /** Metadata for the page of results. */
708
+ /** Metadata for the paginated results. */
693
709
  metadata?: PagingMetadata$3;
694
710
  }
695
711
  interface PagingMetadata$3 {
696
- /** The number of items returned in this response */
712
+ /** Number of items returned in the response. */
697
713
  count?: number | null;
698
- /** The offset which was requested */
714
+ /** Offset that was requested. */
699
715
  offset?: number | null;
700
- /** The total number of items that match the query */
716
+ /** Total number of items that match the query. */
701
717
  total?: number | null;
702
- /** A flag that indicates the server failed to calculate 'total' field */
718
+ /** Whether the server failed to calculate the `total` field. */
703
719
  tooManyToCount?: boolean | null;
704
720
  }
705
721
  interface DeleteAttachmentRequest {
706
- /** Contact ID */
722
+ /** Contact ID for the attachment to delete. */
707
723
  contactId: string;
708
- /** Attachment ID. */
724
+ /** Attachment ID to delete. */
709
725
  attachmentId: string;
710
726
  }
711
727
  interface DeleteAttachmentResponse {
712
728
  }
713
729
  interface GetAttachmentRequest {
714
- /** Contact ID */
730
+ /** Contact ID for the attachment to retrieve. */
715
731
  contactId: string;
716
- /** Attachment ID. */
732
+ /** Attachment ID to retrieve. */
717
733
  attachmentId: string;
718
734
  }
719
735
  interface GetAttachmentResponse {
720
- /** The requested attachment */
736
+ /** The requested attachment. */
721
737
  attachment?: ContactAttachment;
722
738
  }
723
739
  interface MessageEnvelope$5 {
@@ -807,7 +823,7 @@ interface EventMetadata$4 extends BaseEventMetadata$4 {
807
823
  slug?: string;
808
824
  /** ID of the entity associated with the event. */
809
825
  entityId?: string;
810
- /** Event timestamp. */
826
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
811
827
  eventTime?: Date | null;
812
828
  /**
813
829
  * Whether the event was triggered as a result of a privacy regulation application
@@ -834,7 +850,11 @@ interface AttachmentDeletedEnvelope {
834
850
  metadata: EventMetadata$4;
835
851
  }
836
852
  interface GenerateAttachmentUploadUrlOptions {
837
- /** Mime type e.g: `application/pdf` */
853
+ /**
854
+ * Mime type of the attachment file, for example, `application/pdf`.
855
+ * See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
856
+ * [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
857
+ */
838
858
  mimeType: string;
839
859
  }
840
860
  interface ListAttachmentsOptions {
@@ -842,50 +862,50 @@ interface ListAttachmentsOptions {
842
862
  paging?: Paging$4;
843
863
  }
844
864
  interface DeleteAttachmentIdentifiers {
845
- /** Contact ID */
865
+ /** Contact ID for the attachment to delete. */
846
866
  contactId: string;
847
- /** Attachment ID. */
867
+ /** Attachment ID to delete. */
848
868
  attachmentId: string;
849
869
  }
850
870
  interface GetAttachmentIdentifiers {
851
- /** Contact ID */
871
+ /** Contact ID for the attachment to retrieve. */
852
872
  contactId: string;
853
- /** Attachment ID. */
873
+ /** Attachment ID to retrieve. */
854
874
  attachmentId: string;
855
875
  }
856
876
 
857
877
  declare function generateAttachmentUploadUrl$1(httpClient: HttpClient): GenerateAttachmentUploadUrlSignature;
858
878
  interface GenerateAttachmentUploadUrlSignature {
859
879
  /**
860
- * Generates an upload URL to allow external clients to upload a file as an attachment to a given contact.
880
+ * Generates an upload URL for uploading a file as an attachment to a specified contact.
861
881
  *
862
- * To learn how external clients can use the generated upload URL in the response to upload a file,
863
- * see the [Upload API](https://dev.wix.com/api/rest/media/media-manager/upload-api) article.
864
- * @param - ID of the contact whose attachment is being uploaded.
865
- * @param - File name including the extension e.g: `contact-cv.pdf`
882
+ * To learn how to use the generated upload URL in the response to upload an attachment file,
883
+ * see the Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api)).
884
+ * @param - ID of the contact for whom the attachment is being uploaded.
885
+ * @param - File name of the attachment including the extension, for example, `contact-cv.pdf`.
866
886
  */
867
887
  (contactId: string, fileName: string, options: GenerateAttachmentUploadUrlOptions): Promise<GenerateAttachmentUploadUrlResponse & GenerateAttachmentUploadUrlResponseNonNullableFields>;
868
888
  }
869
889
  declare function listAttachments$1(httpClient: HttpClient): ListAttachmentsSignature;
870
890
  interface ListAttachmentsSignature {
871
891
  /**
872
- * List Attachments.
873
- * @param - Contact ID
892
+ * Retrieves a list of attachments associated with a specified contact.
893
+ * @param - Contact ID for the attachments to be listed.
874
894
  */
875
895
  (contactId: string, options?: ListAttachmentsOptions | undefined): Promise<ListAttachmentsResponse & ListAttachmentsResponseNonNullableFields>;
876
896
  }
877
897
  declare function deleteAttachment$1(httpClient: HttpClient): DeleteAttachmentSignature;
878
898
  interface DeleteAttachmentSignature {
879
899
  /**
880
- * Deletes an attachment from contact
900
+ * Deletes the specified attachment from the specified contact.
881
901
  */
882
902
  (identifiers: DeleteAttachmentIdentifiers): Promise<void>;
883
903
  }
884
904
  declare function getAttachment$1(httpClient: HttpClient): GetAttachmentSignature;
885
905
  interface GetAttachmentSignature {
886
906
  /**
887
- * Retrieves an attachment.
888
- * @returns The requested attachment
907
+ * Retrieves the specified attachment for the specified contact.
908
+ * @returns The requested attachment.
889
909
  */
890
910
  (identifiers: GetAttachmentIdentifiers): Promise<ContactAttachment & ContactAttachmentNonNullableFields>;
891
911
  }
@@ -955,7 +975,7 @@ declare const index_d$5_listAttachments: typeof listAttachments;
955
975
  declare const index_d$5_onAttachmentCreated: typeof onAttachmentCreated;
956
976
  declare const index_d$5_onAttachmentDeleted: typeof onAttachmentDeleted;
957
977
  declare namespace index_d$5 {
958
- 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 };
978
+ 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, type RestoreInfo$4 as RestoreInfo, 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 };
959
979
  }
960
980
 
961
981
  interface Contact {
@@ -1,39 +1,40 @@
1
1
  interface ContactAttachment$1 extends ContactAttachmentMediaOneOf$1 {
2
- /** The attachment's image (if the attachment is of type IMAGE) */
2
+ /** Image details when the attachment type is `IMAGE`. */
3
3
  image?: Image$2;
4
- /** The attachment's document (if the attachment is of type OTHER) */
4
+ /** Document details when the attachment type is `OTHER`. */
5
5
  document?: Document;
6
6
  /**
7
- * The id of the attachment.
7
+ * Attachment ID.
8
8
  * @readonly
9
9
  */
10
10
  id?: string;
11
11
  /**
12
- * Image preview (reduced image size) of the attachment (if the attachment is of type IMAGE).
12
+ * Details of the preview image reduced size when the attachment is of type `IMAGE`.
13
13
  * @readonly
14
14
  */
15
15
  previewImage?: Image$2;
16
16
  /**
17
- * The file name of the attachment.
17
+ * Name of the attachment file.
18
18
  * @readonly
19
19
  */
20
20
  fileName?: string;
21
21
  /**
22
- * The mime type of the attachment.
22
+ * Mime type of the attachment. See supported mime types
23
+ * ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
23
24
  * @readonly
24
25
  */
25
26
  mimeType?: string;
26
27
  /**
27
- * The type of the attachment
28
+ * Type of the attachment.
28
29
  * @readonly
29
30
  */
30
31
  attachmentType?: AttachmentType$1;
31
32
  }
32
33
  /** @oneof */
33
34
  interface ContactAttachmentMediaOneOf$1 {
34
- /** The attachment's image (if the attachment is of type IMAGE) */
35
+ /** Image details when the attachment type is `IMAGE`. */
35
36
  image?: Image$2;
36
- /** The attachment's document (if the attachment is of type OTHER) */
37
+ /** Document details when the attachment type is `OTHER`. */
37
38
  document?: Document;
38
39
  }
39
40
  interface Image$2 {
@@ -54,7 +55,7 @@ interface Image$2 {
54
55
  /** Image alt text. Optional. */
55
56
  altText?: string | null;
56
57
  /**
57
- * Image URL expiration date (when relevant). Optional
58
+ * Image URL expiration date when relevant.
58
59
  * @readonly
59
60
  */
60
61
  urlExpirationDate?: Date | null;
@@ -65,22 +66,29 @@ interface Document {
65
66
  /** Document URL. */
66
67
  url?: string;
67
68
  /**
68
- * Document URL expiration date (when relevant). Optional
69
+ * Document URL expiration date when relevant.
69
70
  * @readonly
70
71
  */
71
72
  urlExpirationDate?: Date | null;
72
73
  }
73
74
  declare enum AttachmentType$1 {
75
+ /** Unknown attachment type. */
74
76
  UNKNOWN = "UNKNOWN",
77
+ /** Attachment is an image file. */
75
78
  IMAGE = "IMAGE",
79
+ /** Attachment is a document or any non-image file type. */
76
80
  OTHER = "OTHER"
77
81
  }
78
82
  interface GenerateAttachmentUploadUrlRequest$1 {
79
- /** ID of the contact whose attachment is being uploaded. */
83
+ /** ID of the contact for whom the attachment is being uploaded. */
80
84
  contactId: string;
81
- /** File name including the extension e.g: `contact-cv.pdf` */
85
+ /** File name of the attachment including the extension, for example, `contact-cv.pdf`. */
82
86
  fileName: string;
83
- /** Mime type e.g: `application/pdf` */
87
+ /**
88
+ * Mime type of the attachment file, for example, `application/pdf`.
89
+ * See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
90
+ * [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
91
+ */
84
92
  mimeType: string;
85
93
  }
86
94
  interface GenerateAttachmentUploadUrlResponse$1 {
@@ -88,49 +96,54 @@ interface GenerateAttachmentUploadUrlResponse$1 {
88
96
  uploadUrl?: string;
89
97
  }
90
98
  interface ListAttachmentsRequest$1 {
91
- /** Contact ID */
99
+ /** Contact ID for the attachments to be listed. */
92
100
  contactId: string;
93
101
  /** Allow paginating, default: limit = 100 and offset = 0 */
94
102
  paging?: Paging$7;
95
103
  }
96
104
  interface Paging$7 {
97
- /** Number of items to return (default 100, max 100). */
105
+ /**
106
+ * Number of items to return.
107
+ *
108
+ * Default: `100`
109
+ * Max: `100`
110
+ */
98
111
  limit?: number | null;
99
- /** number of items to skip in the current sort order */
112
+ /** Number of items to skip in the current sort order. */
100
113
  offset?: number | null;
101
114
  }
102
115
  interface ListAttachmentsResponse$1 {
103
- /** The requested attachments */
116
+ /** Liss of attachments for the specified contact. */
104
117
  attachments?: ContactAttachment$1[];
105
- /** Metadata for the page of results. */
118
+ /** Metadata for the paginated results. */
106
119
  metadata?: PagingMetadata$7;
107
120
  }
108
121
  interface PagingMetadata$7 {
109
- /** The number of items returned in this response */
122
+ /** Number of items returned in the response. */
110
123
  count?: number | null;
111
- /** The offset which was requested */
124
+ /** Offset that was requested. */
112
125
  offset?: number | null;
113
- /** The total number of items that match the query */
126
+ /** Total number of items that match the query. */
114
127
  total?: number | null;
115
- /** A flag that indicates the server failed to calculate 'total' field */
128
+ /** Whether the server failed to calculate the `total` field. */
116
129
  tooManyToCount?: boolean | null;
117
130
  }
118
131
  interface DeleteAttachmentRequest$1 {
119
- /** Contact ID */
132
+ /** Contact ID for the attachment to delete. */
120
133
  contactId: string;
121
- /** Attachment ID. */
134
+ /** Attachment ID to delete. */
122
135
  attachmentId: string;
123
136
  }
124
137
  interface DeleteAttachmentResponse$1 {
125
138
  }
126
139
  interface GetAttachmentRequest$1 {
127
- /** Contact ID */
140
+ /** Contact ID for the attachment to retrieve. */
128
141
  contactId: string;
129
- /** Attachment ID. */
142
+ /** Attachment ID to retrieve. */
130
143
  attachmentId: string;
131
144
  }
132
145
  interface GetAttachmentResponse$1 {
133
- /** The requested attachment */
146
+ /** The requested attachment. */
134
147
  attachment?: ContactAttachment$1;
135
148
  }
136
149
  interface GenerateAttachmentUploadUrlResponseNonNullableFields$1 {
@@ -165,54 +178,62 @@ interface GetAttachmentResponseNonNullableFields$1 {
165
178
  }
166
179
 
167
180
  interface ContactAttachment extends ContactAttachmentMediaOneOf {
168
- /** The attachment's image (if the attachment is of type IMAGE) */
181
+ /** Image details when the attachment type is `IMAGE`. */
169
182
  image?: string;
170
- /** The attachment's document (if the attachment is of type OTHER) */
183
+ /** Document details when the attachment type is `OTHER`. */
171
184
  document?: string;
172
185
  /**
173
- * The id of the attachment.
186
+ * Attachment ID.
174
187
  * @readonly
175
188
  */
176
189
  _id?: string;
177
190
  /**
178
- * Image preview (reduced image size) of the attachment (if the attachment is of type IMAGE).
191
+ * Details of the preview image reduced size when the attachment is of type `IMAGE`.
179
192
  * @readonly
180
193
  */
181
194
  previewImage?: string;
182
195
  /**
183
- * The file name of the attachment.
196
+ * Name of the attachment file.
184
197
  * @readonly
185
198
  */
186
199
  fileName?: string;
187
200
  /**
188
- * The mime type of the attachment.
201
+ * Mime type of the attachment. See supported mime types
202
+ * ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
189
203
  * @readonly
190
204
  */
191
205
  mimeType?: string;
192
206
  /**
193
- * The type of the attachment
207
+ * Type of the attachment.
194
208
  * @readonly
195
209
  */
196
210
  attachmentType?: AttachmentType;
197
211
  }
198
212
  /** @oneof */
199
213
  interface ContactAttachmentMediaOneOf {
200
- /** The attachment's image (if the attachment is of type IMAGE) */
214
+ /** Image details when the attachment type is `IMAGE`. */
201
215
  image?: string;
202
- /** The attachment's document (if the attachment is of type OTHER) */
216
+ /** Document details when the attachment type is `OTHER`. */
203
217
  document?: string;
204
218
  }
205
219
  declare enum AttachmentType {
220
+ /** Unknown attachment type. */
206
221
  UNKNOWN = "UNKNOWN",
222
+ /** Attachment is an image file. */
207
223
  IMAGE = "IMAGE",
224
+ /** Attachment is a document or any non-image file type. */
208
225
  OTHER = "OTHER"
209
226
  }
210
227
  interface GenerateAttachmentUploadUrlRequest {
211
- /** ID of the contact whose attachment is being uploaded. */
228
+ /** ID of the contact for whom the attachment is being uploaded. */
212
229
  contactId: string;
213
- /** File name including the extension e.g: `contact-cv.pdf` */
230
+ /** File name of the attachment including the extension, for example, `contact-cv.pdf`. */
214
231
  fileName: string;
215
- /** Mime type e.g: `application/pdf` */
232
+ /**
233
+ * Mime type of the attachment file, for example, `application/pdf`.
234
+ * See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
235
+ * [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
236
+ */
216
237
  mimeType: string;
217
238
  }
218
239
  interface GenerateAttachmentUploadUrlResponse {
@@ -220,49 +241,54 @@ interface GenerateAttachmentUploadUrlResponse {
220
241
  uploadUrl?: string;
221
242
  }
222
243
  interface ListAttachmentsRequest {
223
- /** Contact ID */
244
+ /** Contact ID for the attachments to be listed. */
224
245
  contactId: string;
225
246
  /** Allow paginating, default: limit = 100 and offset = 0 */
226
247
  paging?: Paging$6;
227
248
  }
228
249
  interface Paging$6 {
229
- /** Number of items to return (default 100, max 100). */
250
+ /**
251
+ * Number of items to return.
252
+ *
253
+ * Default: `100`
254
+ * Max: `100`
255
+ */
230
256
  limit?: number | null;
231
- /** number of items to skip in the current sort order */
257
+ /** Number of items to skip in the current sort order. */
232
258
  offset?: number | null;
233
259
  }
234
260
  interface ListAttachmentsResponse {
235
- /** The requested attachments */
261
+ /** Liss of attachments for the specified contact. */
236
262
  attachments?: ContactAttachment[];
237
- /** Metadata for the page of results. */
263
+ /** Metadata for the paginated results. */
238
264
  metadata?: PagingMetadata$6;
239
265
  }
240
266
  interface PagingMetadata$6 {
241
- /** The number of items returned in this response */
267
+ /** Number of items returned in the response. */
242
268
  count?: number | null;
243
- /** The offset which was requested */
269
+ /** Offset that was requested. */
244
270
  offset?: number | null;
245
- /** The total number of items that match the query */
271
+ /** Total number of items that match the query. */
246
272
  total?: number | null;
247
- /** A flag that indicates the server failed to calculate 'total' field */
273
+ /** Whether the server failed to calculate the `total` field. */
248
274
  tooManyToCount?: boolean | null;
249
275
  }
250
276
  interface DeleteAttachmentRequest {
251
- /** Contact ID */
277
+ /** Contact ID for the attachment to delete. */
252
278
  contactId: string;
253
- /** Attachment ID. */
279
+ /** Attachment ID to delete. */
254
280
  attachmentId: string;
255
281
  }
256
282
  interface DeleteAttachmentResponse {
257
283
  }
258
284
  interface GetAttachmentRequest {
259
- /** Contact ID */
285
+ /** Contact ID for the attachment to retrieve. */
260
286
  contactId: string;
261
- /** Attachment ID. */
287
+ /** Attachment ID to retrieve. */
262
288
  attachmentId: string;
263
289
  }
264
290
  interface GetAttachmentResponse {
265
- /** The requested attachment */
291
+ /** The requested attachment. */
266
292
  attachment?: ContactAttachment;
267
293
  }
268
294
  interface GenerateAttachmentUploadUrlResponseNonNullableFields {