@wix/crm 1.0.84 → 1.0.86

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

@@ -1,349 +0,0 @@
-/** Label that was found or created. */
-export interface ContactLabel {
-    /**
-     * Label namespace.
-     *
-     * Labels created by site admins 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.
-     * It cannot be modified, even if `displayName` is updated.
-     * @readonly
-     */
-    key?: string;
-    /** Label display name shown in the Dashboard. */
-    displayName?: string;
-    /**
-     * Label type indicating how the label was created.
-     *
-     * - `SYSTEM`: Default system label for the Contact List.
-     * - `USER_DEFINED`: Label created by a site contributor or 3rd-party app.
-     * - `WIX_APP_DEFINED`: Label 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.
-     * It cannot be modified, even if `displayName` is updated.
-     */
-    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;
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp. */
-    eventTime?: Date;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface FindOrCreateLabelResponseNonNullableFields {
-    label?: {
-        key: string;
-        displayName: string;
-        labelType: LabelType;
-    };
-    newLabel: boolean;
-}
-export interface GetLabelResponseNonNullableFields {
-    label?: {
-        key: string;
-        displayName: string;
-        labelType: LabelType;
-    };
-}
-export interface UpdateLabelResponseNonNullableFields {
-    label?: {
-        key: string;
-        displayName: string;
-        labelType: LabelType;
-    };
-}
-export interface QueryLabelsResponseNonNullableFields {
-    labels: {
-        key: string;
-        displayName: string;
-        labelType: LabelType;
-    }[];
-}

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

@@ -1,17 +0,0 @@
-"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 = LabelType = {}));
-var SortOrder;
-(function (SortOrder) {
-    SortOrder["ASC"] = "ASC";
-    SortOrder["DESC"] = "DESC";
-})(SortOrder || (exports.SortOrder = SortOrder = {}));
-//# sourceMappingURL=contacts-v4-label.types.js.map

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

@@ -1 +0,0 @@
-{"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,yBAAT,SAAS,QAMpB;AA6BD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}