@wix/crm 1.0.0 → 1.0.1

package/build/cjs/index.d.ts

@@ -1 +1,4 @@
-export * as contacts from './src/contacts-v4-submit-contact.public';
+export * as contacts from './src/contacts-v4-contact.public';
+export * as extendedFields from './src/contacts-v4-extended-field.public';
+export * as labels from './src/contacts-v4-label.public';
+export * as submittedContact from './src/contacts-v4-submit-contact.public';

package/build/cjs/index.js

@@ -19,6 +19,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.contacts = void 0;
-exports.contacts = __importStar(require("./src/contacts-v4-submit-contact.public"));
+exports.submittedContact = exports.labels = exports.extendedFields = exports.contacts = void 0;
+exports.contacts = __importStar(require("./src/contacts-v4-contact.public"));
+exports.extendedFields = __importStar(require("./src/contacts-v4-extended-field.public"));
+exports.labels = __importStar(require("./src/contacts-v4-label.public"));
+exports.submittedContact = __importStar(require("./src/contacts-v4-submit-contact.public"));
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,oFAAoE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6EAA6D;AAC7D,0FAA0E;AAC1E,yEAAyD;AACzD,4FAA4E"}

package/build/cjs/src/contacts-v4-contact.http.d.ts

@@ -0,0 +1,192 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { CreateContactRequest, CreateContactResponse, DeleteContactRequest, DeleteContactResponse, GetContactRequest, GetContactResponse, LabelContactRequest, LabelContactResponse, MergeContactsRequest, MergeContactsResponse, UnlabelContactRequest, UnlabelContactResponse, UpdateContactRequest, UpdateContactResponse } from './contacts-v4-contact.types';
+/**
+ * Creates a new contact.
+ *
+ *
+ * The `createContact()` function returns a Promise
+ * that resolves to the new contact when it is created.
+ *   > **Note:**
+ *  > This function replaces the deprecated
+ *  > `wixCrmBackend.createContact()`.
+ *  > The deprecated function will continue to work, but it will not receive updates.
+ *  > To keep any existing code compatible with future changes, see the
+ *  > [migration instructions](wix-crm-backend/createcontact#migration-instructions).
+ *
+ * The `contactInfo` parameter object must include a name, phone number, or email address.
+ *  If all 3 of these parameters are missing,
+ *  the contact won't be created.
+ *
+ * <!--
+ * > **Note:**
+ * > Only visitors with
+ * > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
+ * > can create contacts.
+ * > You can override the permissions by setting the `suppressAuth` option to `true`.
+ * -->
+ *   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`.
+ */
+export declare function createContact(payload: CreateContactRequest): RequestOptionsFactory<CreateContactResponse>;
+/**
+ * Updates a contact's properties.
+ *
+ * The `updateContact()` function returns a Promise that resolves
+ * when the specified contact's information is updated.
+ *
+ *  > **Note:**
+ * > This function replaces the deprecated
+ * > `wixCrmBackend.updateContact()`.
+ * > The deprecated function will continue to work, but it will not receive updates.
+ * > To keep any existing code compatible with future changes, see the
+ * > [migration instructions](wix-crm-backend/updatecontact#migration-instructions).
+ *
+ *  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 it prevents unintended overwrites.
+ *
+ * <!--
+ *  > **Note:**
+ * > Only visitors with
+ * > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
+ * > can update contacts.
+ * > You can override the permissions by setting the `suppressAuth` option to `true`.
+ * -->
+ */
+export declare function updateContact(payload: UpdateContactRequest): RequestOptionsFactory<UpdateContactResponse>;
+/**
+ * Merges source contacts into a target contact.
+ *
+ * Merging contacts has these effects on the target contact:
+ *
+ * - No target contact data is overwritten or deleted.
+ * - Arrays (emails, phones, addresses, and labels) are merged from the source contacts.
+ * - If merging more than one source contact, the 1st source is given precedence, then the 2nd, and so on.
+ *
+ * <blockquote class="important">
+ *
+ * __Important:__
+ * Merges cannot be undone.
+ * Use [Preview Merge Contacts](#preview-merge-contacts)
+ * to test before merging.
+ *
+ * </blockquote>
+ *
+ * Source contacts are deleted when merging.
+ * However, if a source contact is a site member or contributor,
+ * the merge fails because site contributors and members can't be deleted.
+ * Site members and contributors can be target contacts only.
+ *
+ * After merging,
+ * if you call [Get Contact](#get-contact) with a deleted source contact ID,
+ * the target contact ID is returned.
+ * This is supported when calling Get Contact only.
+ * Deleted source contact IDs are not supported on any other endpoint.
+ *
+ * Merging contacts triggers these webhooks:
+ *
+ * - [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.
+ * - [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`.
+ * - [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`.
+ */
+export declare function mergeContacts(payload: MergeContactsRequest): RequestOptionsFactory<MergeContactsResponse>;
+/**
+ * Deletes a contact who is not a site member or contributor.
+ *
+ * The `deleteContact()` function returns a Promise
+ * that resolves when the specified contact is deleted.
+ *  > **Note:**
+ * > This function replaces the deprecated
+ * > `wixCrmBackend.deleteContact()`.
+ * > The deprecated function will continue to work, but it will not receive updates.
+ * > To keep any existing code compatible with future changes, see the
+ * > [migration instructions](wix-crm-backend/deletecontact#migration-instructions).
+ *
+ *  Deleting a contact permanently removes them from your Contact List.
+ *
+ *  If the contact is also a site member,
+ * the member must be deleted first,
+ * and then the contact can be deleted.
+ *
+ * <!--
+ *  > **Note:**
+ * > Only visitors with
+ * > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
+ * > can delete contacts.
+ * > You can override the permissions by setting the `suppressAuth` option to `true`.
+ * -->
+ */
+export declare function deleteContact(payload: DeleteContactRequest): RequestOptionsFactory<DeleteContactResponse>;
+/**
+ * Adds labels to a contact.
+ *
+ *
+ * The `labelContact()` function returns a Promise
+ * that resolves when the specified labels are added to the contact.
+ *  - **To create new labels:** Use [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel).
+ * - **To find labels:** Use [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel), [`getLabel()`](wix-crm-backend/contacts/getlabel), or [`queryLabels()`](wix-crm-backend/contacts/queryLabels).
+ *
+ * <!--
+ *  > **Note:**
+ * > Only visitors with
+ * > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
+ * > can label contacts.
+ * > You can override the permissions by setting the `suppressAuth` option to `true`.
+ * -->
+ */
+export declare function labelContact(payload: LabelContactRequest): RequestOptionsFactory<LabelContactResponse>;
+/**
+ * Removes labels from a contact.
+ *
+ *  The `unlabelContact()` function returns a Promise
+ *  that resolves when the specified labels are removed from the contact.
+ *
+ *   If a label is no longer needed
+ *  and you want to remove it from all contacts,
+ *  you can delete it with
+ *  [`deleteLabel()`](wix-crm-backend/contacts/deletelabel).
+ *
+ * <!--
+ *   > **Note:**
+ *  > Only visitors with
+ *  > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
+ *  > can unlabel contacts.
+ *  > You can override the permissions by setting the `suppressAuth` option to `true`.
+ * -->
+ */
+export declare function unlabelContact(payload: UnlabelContactRequest): RequestOptionsFactory<UnlabelContactResponse>;
+/**
+ * Retrieves a contact.
+ *
+ *
+ * The `getContact()` function returns a Promise
+ * that resolves when the contact is found.
+ * #### Getting Merged Contacts
+ * When a source contact is merged
+ * with a target contact, the source contact is deleted.
+ * When calling `getContact()` for a merged contact,
+ * you can use the source or target contact ID.
+ * In both cases, the target contact is returned.
+ *
+ * This is supported only when calling `getContact()`,
+ * and only for merged contacts.
+ * Deleted source contact IDs are not supported on any other function.
+ * > **Notes:**
+ * >
+ * > - This function replaces the deprecated
+ * >   `wixCrmBackend.getContactById()`.
+ * >   The deprecated function will continue to work, but it will not receive updates.
+ * >   To keep any existing code compatible with future changes, see the
+ * >   [migration instructions](wix-crm-backend/getcontactbyid#migration-instructions).
+ * <!-- > - Only visitors with
+ * >   **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
+ * >   can retrieve contacts.
+ * >   You can override the permissions by setting the `suppressAuth` option to `true`.
+ * -->
+ */
+export declare function getContact(payload: GetContactRequest): RequestOptionsFactory<GetContactResponse>;