@wix/crm 1.0.107 → 1.0.109

package/type-bundles/meta.bundle.d.ts

@@ -1,3 +1,353 @@
+interface ContactAttachment$1 extends ContactAttachmentMediaOneOf$1 {
+    /** The attachment's image (if the attachment is of type IMAGE) */
+    image?: Image$2;
+    /** The attachment's document (if the attachment is of type OTHER) */
+    document?: Document;
+    /**
+     * The id of the attachment.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Image preview (reduced image size) of the attachment (if the attachment is of type IMAGE).
+     * @readonly
+     */
+    previewImage?: Image$2;
+    /**
+     * The file name of the attachment.
+     * @readonly
+     */
+    fileName?: string;
+    /**
+     * The mime type of the attachment.
+     * @readonly
+     */
+    mimeType?: string;
+    /**
+     * The type of the attachment
+     * @readonly
+     */
+    attachmentType?: AttachmentType$1;
+}
+/** @oneof */
+interface ContactAttachmentMediaOneOf$1 {
+    /** The attachment's image (if the attachment is of type IMAGE) */
+    image?: Image$2;
+    /** The attachment's document (if the attachment is of type OTHER) */
+    document?: Document;
+}
+interface Image$2 {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. Optional. */
+    altText?: string | null;
+    /**
+     * Image URL expiration date (when relevant). Optional
+     * @readonly
+     */
+    urlExpirationDate?: Date;
+}
+interface Document {
+    /** WixMedia ID. */
+    id?: string;
+    /** Document URL. */
+    url?: string;
+    /**
+     * Document URL expiration date (when relevant). Optional
+     * @readonly
+     */
+    urlExpirationDate?: Date;
+}
+declare enum AttachmentType$1 {
+    UNKNOWN = "UNKNOWN",
+    IMAGE = "IMAGE",
+    OTHER = "OTHER"
+}
+interface GenerateAttachmentUploadUrlRequest$1 {
+    /** ID of the contact whose attachment is being uploaded. */
+    contactId: string;
+    /** File name including the extension e.g: `contact-cv.pdf` */
+    fileName: string;
+    /** Mime type e.g: `application/pdf` */
+    mimeType: string;
+}
+interface GenerateAttachmentUploadUrlResponse$1 {
+    /** The URL for uploading a file as an attachment to the contact. */
+    uploadUrl?: string;
+}
+interface ListAttachmentsRequest$1 {
+    /** Contact ID */
+    contactId: string;
+    /** Allow paginating, default: limit = 100 and offset = 0 */
+    paging?: Paging$7;
+}
+interface Paging$7 {
+    /** Number of items to return (default 100, max 100). */
+    limit?: number | null;
+    /** number of items to skip in the current sort order */
+    offset?: number | null;
+}
+interface ListAttachmentsResponse$1 {
+    /** The requested attachments */
+    attachments?: ContactAttachment$1[];
+    /** Metadata for the page of results. */
+    metadata?: PagingMetadata$7;
+}
+interface PagingMetadata$7 {
+    /** The number of items returned in this response */
+    count?: number | null;
+    /** The offset which was requested */
+    offset?: number | null;
+    /** The total number of items that match the query */
+    total?: number | null;
+    /** A flag that indicates the server failed to calculate 'total' field */
+    tooManyToCount?: boolean | null;
+}
+interface DeleteAttachmentRequest$1 {
+    /** Contact ID */
+    contactId: string;
+    /** Attachment ID. */
+    attachmentId: string;
+}
+interface DeleteAttachmentResponse$1 {
+}
+interface GetAttachmentRequest$1 {
+    /** Contact ID */
+    contactId: string;
+    /** Attachment ID. */
+    attachmentId: string;
+}
+interface GetAttachmentResponse$1 {
+    /** The requested attachment */
+    attachment?: ContactAttachment$1;
+}
+interface GenerateAttachmentUploadUrlResponseNonNullableFields$1 {
+    uploadUrl: string;
+    uploadId: string;
+}
+interface ListAttachmentsResponseNonNullableFields$1 {
+    attachments: {
+        image?: {
+            id: string;
+            url: string;
+            height: number;
+            width: number;
+        };
+        document?: {
+            id: string;
+            url: string;
+        };
+        id: string;
+        previewImage?: {
+            id: string;
+            url: string;
+            height: number;
+            width: number;
+        };
+        fileName: string;
+        mimeType: string;
+        attachmentType: AttachmentType$1;
+        mediaPath: string;
+    }[];
+}
+interface GetAttachmentResponseNonNullableFields$1 {
+    attachment?: {
+        image?: {
+            id: string;
+            url: string;
+            height: number;
+            width: number;
+        };
+        document?: {
+            id: string;
+            url: string;
+        };
+        id: string;
+        previewImage?: {
+            id: string;
+            url: string;
+            height: number;
+            width: number;
+        };
+        fileName: string;
+        mimeType: string;
+        attachmentType: AttachmentType$1;
+        mediaPath: string;
+    };
+}
+
+interface ContactAttachment extends ContactAttachmentMediaOneOf {
+    /** The attachment's image (if the attachment is of type IMAGE) */
+    image?: string;
+    /** The attachment's document (if the attachment is of type OTHER) */
+    document?: string;
+    /**
+     * The id of the attachment.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Image preview (reduced image size) of the attachment (if the attachment is of type IMAGE).
+     * @readonly
+     */
+    previewImage?: string;
+    /**
+     * The file name of the attachment.
+     * @readonly
+     */
+    fileName?: string;
+    /**
+     * The mime type of the attachment.
+     * @readonly
+     */
+    mimeType?: string;
+    /**
+     * The type of the attachment
+     * @readonly
+     */
+    attachmentType?: AttachmentType;
+}
+/** @oneof */
+interface ContactAttachmentMediaOneOf {
+    /** The attachment's image (if the attachment is of type IMAGE) */
+    image?: string;
+    /** The attachment's document (if the attachment is of type OTHER) */
+    document?: string;
+}
+declare enum AttachmentType {
+    UNKNOWN = "UNKNOWN",
+    IMAGE = "IMAGE",
+    OTHER = "OTHER"
+}
+interface GenerateAttachmentUploadUrlRequest {
+    /** ID of the contact whose attachment is being uploaded. */
+    contactId: string;
+    /** File name including the extension e.g: `contact-cv.pdf` */
+    fileName: string;
+    /** Mime type e.g: `application/pdf` */
+    mimeType: string;
+}
+interface GenerateAttachmentUploadUrlResponse {
+    /** The URL for uploading a file as an attachment to the contact. */
+    uploadUrl?: string;
+}
+interface ListAttachmentsRequest {
+    /** Contact ID */
+    contactId: string;
+    /** Allow paginating, default: limit = 100 and offset = 0 */
+    paging?: Paging$6;
+}
+interface Paging$6 {
+    /** Number of items to return (default 100, max 100). */
+    limit?: number | null;
+    /** number of items to skip in the current sort order */
+    offset?: number | null;
+}
+interface ListAttachmentsResponse {
+    /** The requested attachments */
+    attachments?: ContactAttachment[];
+    /** Metadata for the page of results. */
+    metadata?: PagingMetadata$6;
+}
+interface PagingMetadata$6 {
+    /** The number of items returned in this response */
+    count?: number | null;
+    /** The offset which was requested */
+    offset?: number | null;
+    /** The total number of items that match the query */
+    total?: number | null;
+    /** A flag that indicates the server failed to calculate 'total' field */
+    tooManyToCount?: boolean | null;
+}
+interface DeleteAttachmentRequest {
+    /** Contact ID */
+    contactId: string;
+    /** Attachment ID. */
+    attachmentId: string;
+}
+interface DeleteAttachmentResponse {
+}
+interface GetAttachmentRequest {
+    /** Contact ID */
+    contactId: string;
+    /** Attachment ID. */
+    attachmentId: string;
+}
+interface GetAttachmentResponse {
+    /** The requested attachment */
+    attachment?: ContactAttachment;
+}
+interface GenerateAttachmentUploadUrlResponseNonNullableFields {
+    uploadUrl: string;
+}
+interface ListAttachmentsResponseNonNullableFields {
+    attachments: {
+        image: string;
+        document: string;
+        _id: string;
+        previewImage: string;
+        fileName: string;
+        mimeType: string;
+        attachmentType: AttachmentType;
+    }[];
+}
+interface GetAttachmentResponseNonNullableFields {
+    attachment?: {
+        image: string;
+        document: string;
+        _id: string;
+        previewImage: string;
+        fileName: string;
+        mimeType: string;
+        attachmentType: AttachmentType;
+    };
+}
+
+type __PublicMethodMetaInfo$5<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function generateAttachmentUploadUrl(): __PublicMethodMetaInfo$5<'POST', {
+    contactId: string;
+}, GenerateAttachmentUploadUrlRequest, GenerateAttachmentUploadUrlRequest$1, GenerateAttachmentUploadUrlResponse & GenerateAttachmentUploadUrlResponseNonNullableFields, GenerateAttachmentUploadUrlResponse$1 & GenerateAttachmentUploadUrlResponseNonNullableFields$1>;
+declare function listAttachments(): __PublicMethodMetaInfo$5<'GET', {
+    contactId: string;
+}, ListAttachmentsRequest, ListAttachmentsRequest$1, ListAttachmentsResponse & ListAttachmentsResponseNonNullableFields, ListAttachmentsResponse$1 & ListAttachmentsResponseNonNullableFields$1>;
+declare function deleteAttachment(): __PublicMethodMetaInfo$5<'DELETE', {
+    contactId: string;
+    attachmentId: string;
+}, DeleteAttachmentRequest, DeleteAttachmentRequest$1, DeleteAttachmentResponse, DeleteAttachmentResponse$1>;
+declare function getAttachment(): __PublicMethodMetaInfo$5<'GET', {
+    contactId: string;
+    attachmentId: string;
+}, GetAttachmentRequest, GetAttachmentRequest$1, GetAttachmentResponse & GetAttachmentResponseNonNullableFields, GetAttachmentResponse$1 & GetAttachmentResponseNonNullableFields$1>;
+
+declare const meta$5_deleteAttachment: typeof deleteAttachment;
+declare const meta$5_generateAttachmentUploadUrl: typeof generateAttachmentUploadUrl;
+declare const meta$5_getAttachment: typeof getAttachment;
+declare const meta$5_listAttachments: typeof listAttachments;
+declare namespace meta$5 {
+  export { type __PublicMethodMetaInfo$5 as __PublicMethodMetaInfo, meta$5_deleteAttachment as deleteAttachment, meta$5_generateAttachmentUploadUrl as generateAttachmentUploadUrl, meta$5_getAttachment as getAttachment, meta$5_listAttachments as listAttachments };
+}
+
 interface Contact$1 {
     /**
      * Contact ID.
@@ -79,7 +429,7 @@ interface ContactActivity$1 {
      * Contact's last action in the site.
      *
      * For descriptions of each value, see
-     * [Last Activity Types](https://dev.wix.com/api/rest/contacts/contacts/last-activity-types).
+     * [Last Activity Types](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/last-activity-types).
      */
     activityType?: ContactActivityType$1;
 }
@@ -4624,4 +4974,4 @@ declare namespace meta {
   export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_countTasks as countTasks, meta_createTask as createTask, meta_deleteTask as deleteTask, meta_getTask as getTask, meta_moveTaskAfter as moveTaskAfter, meta_queryTasks as queryTasks, meta_updateTask as updateTask };
 }
 
-export { meta$4 as contacts, meta$3 as extendedFields, meta$2 as labels, meta$1 as submittedContact, meta as tasks };
+export { meta$5 as attachments, meta$4 as contacts, meta$3 as extendedFields, meta$2 as labels, meta$1 as submittedContact, meta as tasks };