@wix/crm 1.0.0 → 1.0.2

package/build/cjs/src/contacts-v4-label.public.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = exports.LabelType = exports.queryLabels = exports.deleteLabel = exports.renameLabel = exports.findOrCreateLabel = exports.__metadata = void 0;
+const contacts_v4_label_universal_1 = require("./contacts-v4-label.universal");
+exports.__metadata = { PACKAGE_NAME: '@wix/crm' };
+function findOrCreateLabel(httpClient) {
+    return (displayName, options) => (0, contacts_v4_label_universal_1.findOrCreateLabel)(displayName, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.findOrCreateLabel = findOrCreateLabel;
+function renameLabel(httpClient) {
+    return (key, options) => (0, contacts_v4_label_universal_1.renameLabel)(key, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.renameLabel = renameLabel;
+function deleteLabel(httpClient) {
+    return (key) => (0, contacts_v4_label_universal_1.deleteLabel)(key, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.deleteLabel = deleteLabel;
+function queryLabels(httpClient) {
+    return (options) => (0, contacts_v4_label_universal_1.queryLabels)(options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.queryLabels = queryLabels;
+var contacts_v4_label_universal_2 = require("./contacts-v4-label.universal");
+Object.defineProperty(exports, "LabelType", { enumerable: true, get: function () { return contacts_v4_label_universal_2.LabelType; } });
+Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return contacts_v4_label_universal_2.SortOrder; } });
+//# sourceMappingURL=contacts-v4-label.public.js.map

package/build/cjs/src/contacts-v4-label.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts-v4-label.public.js","sourceRoot":"","sources":["../../../src/contacts-v4-label.public.ts"],"names":[],"mappings":";;;AACA,+EAQuC;AAE1B,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;AAEvD,SAAgB,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CAAC,WAAmB,EAAE,OAAkC,EAAE,EAAE,CACjE,IAAA,+CAA0B,EACxB,WAAW,EACX,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,8CAQC;AAED,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,OAA4B,EAAE,EAAE,CACnD,IAAA,yCAAoB,EAClB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAED,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,yCAAoB,EAClB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kCAOC;AAED,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,OAA4B,EAAE,EAAE,CACtC,IAAA,yCAAoB,EAClB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kCAOC;AAED,6EAAqE;AAA5D,wHAAA,SAAS,OAAA;AAAE,wHAAA,SAAS,OAAA"}

package/build/cjs/src/contacts-v4-label.types.d.ts

@@ -0,0 +1,253 @@
+/** Label that was found or created. */
+export interface ContactLabel {
+    /**
+     * Label namespace.
+     *
+     * Labels created by site contributors or 3rd-party apps
+     * are automatically assigned to the `custom` namespace.
+     * @readonly
+     */
+    namespace?: string | null;
+    /**
+     * Display name for the namespace,
+     * used to organize the list of labels in the site Dashboard.
+     * @readonly
+     */
+    namespaceDisplayName?: string | null;
+    /**
+     * Label key.
+     *
+     * `key` is generated when the label is created
+     * and cannot be modified, even if `displayName` changes.
+     * @readonly
+     */
+    key?: string;
+    /** Label display name shown in the Dashboard. */
+    displayName?: string;
+    /**
+     * Label type.
+     *
+     * - `SYSTEM`: The label is a default system label for the Contact List.
+     * - `USER_DEFINED`: The label was created by a site contributor or 3rd-party app.
+     * - `WIX_APP_DEFINED`: The label was created by a Wix app.
+     * @readonly
+     */
+    labelType?: LabelType;
+    /**
+     * Date and time the label was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the label was last updated.
+     * @readonly
+     */
+    updatedDate?: Date;
+}
+export declare enum LabelType {
+    /** Need UNKNOWN to be able to fetch all labels */
+    UNKNOWN = "UNKNOWN",
+    SYSTEM = "SYSTEM",
+    USER_DEFINED = "USER_DEFINED",
+    WIX_APP_DEFINED = "WIX_APP_DEFINED"
+}
+/** Label filter options. */
+export interface ListLabelsRequest {
+    /** Filter for labels of the specified type. */
+    labelType?: LabelType;
+    /** Filter for labels in the specified namespace. */
+    namespace?: string | null;
+    /** Filter for labels where `displayName` starts with the specified case-sensitive string. */
+    startsWith?: string | null;
+    /** Sorting options. */
+    sort?: Sorting;
+    /** Paging options. */
+    paging?: Paging;
+    /** Language for localization. */
+    language?: string | null;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Defaults to `ASC`.
+     */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /**
+     * Number of items to return.
+     *
+     * Defaults to `1000`. <br>
+     * Maximum: `2000`.
+     */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+/** List of labels. */
+export interface ListLabelsResponse {
+    /** List of labels. */
+    labels?: ContactLabel[];
+    /** Metadata for the page of results. */
+    metadata?: PagingMetadata;
+}
+export interface PagingMetadata {
+    /** Number of items returned. */
+    count?: number | null;
+    /** Requested offset. */
+    offset?: number | null;
+    /** Number of items that matched the query. */
+    total?: number | null;
+    /**
+     * Indicates if `total` calculation timed out before the response was sent.
+     * Typically this happens if there is a large set of results.
+     */
+    tooManyToCount?: boolean | null;
+}
+/** Label to find or create. */
+export interface FindOrCreateLabelRequest {
+    /**
+     * Display name to retrieve or create.
+     *
+     * If an existing label is an exact match
+     * for the specified display name,
+     * the existing label is returned.
+     * If not, a new label is created and returned.
+     */
+    displayName: string;
+    /** Language for localization. */
+    language?: string | null;
+}
+/** Label that was found or created. */
+export interface FindOrCreateLabelResponse {
+    /** Label that was found or created. */
+    label?: ContactLabel;
+    /**
+     * Indicates whether the label was just created or already existed.
+     *
+     * If the label was just created, returns `true`.
+     * If it already existed, returns `false`.
+     */
+    newLabel?: boolean;
+}
+export interface LabelsQuotaReached {
+    labelsQuota?: string | null;
+    labelsCurrentTotal?: string | null;
+}
+export interface ListLabelNamespacesRequest {
+    /** Language for localization */
+    language?: string | null;
+}
+export interface ListLabelNamespacesResponse {
+    namespaces?: ContactLabelNamespace[];
+}
+export interface ContactLabelNamespace {
+    /**
+     * Namespace key
+     * @readonly
+     */
+    key?: string;
+    /**
+     * Namespace display name
+     * @readonly
+     */
+    displayName?: string | null;
+}
+export interface GetLabelRequest {
+    /**
+     * Label key.
+     *
+     * `key` is generated when the label is created
+     * and cannot be modified, even if `displayName` changes.
+     */
+    key?: string;
+    /** Language for localization. */
+    language?: string | null;
+}
+/** The specified label. */
+export interface GetLabelResponse {
+    /** The specified label. */
+    label?: ContactLabel;
+}
+export interface GetLabelByLegacyIdRequest {
+    legacyId?: string;
+    /** Language for localization */
+    language?: string | null;
+}
+export interface GetLabelByLegacyIdResponse {
+    label?: ContactLabel;
+}
+export interface UpdateLabelRequest {
+    /** Label details to update. */
+    label?: ContactLabel;
+    /** Language for localization. */
+    language?: string | null;
+}
+/** Updated label. */
+export interface UpdateLabelResponse {
+    /** Updated label. */
+    label?: ContactLabel;
+}
+export interface DeleteLabelRequest {
+    /** Label key to delete. */
+    key: string;
+}
+export interface DeleteLabelResponse {
+}
+export interface PurgeRequest {
+    instanceId?: string;
+    exludingLabelKeys?: string[];
+}
+export interface PurgeResponse {
+    deletedItems?: number;
+}
+export interface GdprListRequest {
+    instanceId?: string;
+}
+export interface GdprListResponse {
+    labels?: ContactLabel[];
+}
+export interface QueryLabelsRequest {
+    /** Query options. */
+    query?: Query;
+    /** Language for localization. */
+    language?: string | null;
+}
+export interface Query {
+    /**
+     * ilter object.
+     *
+     * Possible filters: `$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
+     *
+     * For a detailed list of supported filters, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter).
+     *
+     * Example: `{ "filter": {
+     * "displayName": {
+     * "$startsWith": "Referral"
+     * }
+     * }
+     * }`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sorting options. For a list of fields that can be sorted, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter).
+     *
+     * Example: `{ "sort": [{"fieldName": "displayName", "order": "DESC"}] }`
+     */
+    sort?: Sorting[];
+    /** Pagination options. */
+    paging?: Paging;
+}
+export interface QueryLabelsResponse {
+    /** List of labels */
+    labels?: ContactLabel[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadata;
+}

package/build/cjs/src/contacts-v4-label.types.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = exports.LabelType = void 0;
+var LabelType;
+(function (LabelType) {
+    /** Need UNKNOWN to be able to fetch all labels */
+    LabelType["UNKNOWN"] = "UNKNOWN";
+    LabelType["SYSTEM"] = "SYSTEM";
+    LabelType["USER_DEFINED"] = "USER_DEFINED";
+    LabelType["WIX_APP_DEFINED"] = "WIX_APP_DEFINED";
+})(LabelType = exports.LabelType || (exports.LabelType = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+//# sourceMappingURL=contacts-v4-label.types.js.map

package/build/cjs/src/contacts-v4-label.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts-v4-label.types.js","sourceRoot":"","sources":["../../../src/contacts-v4-label.types.ts"],"names":[],"mappings":";;;AA+CA,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,kDAAkD;IAClD,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,0CAA6B,CAAA;IAC7B,gDAAmC,CAAA;AACrC,CAAC,EANW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAMpB;AA6BD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}