@wix/crm 1.0.0 → 1.0.2

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

@@ -0,0 +1,442 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+/** 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;
+}
+/**
+ * Retrieves a label with a given name, or creates one if it doesn't exist.
+ *
+ * Successful calls to this endpoint always return a label,
+ * which can be passed to subsequent requests.
+ *
+ * For example, in the Contacts API,
+ * [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
+ * [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact)
+ * requests will fail if you include a nonexistant label.
+ * To ensure successful calls, you can call this endpoint first,
+ * and then use the response in the label and unlabel requests.
+ *
+ * To find an existing label without potentially creating a new one, use
+ * [Get Label](https://dev.wix.com/api/rest/contacts/labels/get-label) or
+ * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param displayName - 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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField displayName
+ * @returns Label that was found or created.
+ */
+export declare function findOrCreateLabel(displayName: string, options?: FindOrCreateLabelOptions): Promise<FindOrCreateLabelResponse>;
+export interface FindOrCreateLabelOptions {
+    /** Language for localization. */
+    language?: string | null;
+}
+/**
+ * Updates a label's specified properties.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param key - Label key.
+ *
+ * `key` is generated when the label is created
+ * and cannot be modified, even if `displayName` changes.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField key
+ * @requiredField options.label.displayName
+ * @returns Updated label.
+ */
+export declare function renameLabel(key: string, options?: RenameLabelOptions): Promise<ContactLabel>;
+export interface RenameLabelOptions {
+    label: {
+        /**
+         * 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 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;
+    };
+    /** Language for localization. */
+    language?: string | null;
+}
+/**
+ * Deletes a label from the site and removes it from contacts it applies to.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param key - Label key to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField key
+ */
+export declare function deleteLabel(key: string): Promise<void>;
+/**
+ * Retrieves a list of contact labels. Up to 1000 labels can be returned per request.
+ *
+ * For a detailed list of supported operations, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter). To learn how to query labels, see
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryLabels(options?: QueryLabelsOptions): LabelsQueryBuilder;
+export interface QueryLabelsOptions {
+    /** Language for localization. */
+    language?: string | null | undefined;
+}
+interface QueryOffsetResult {
+    currentPage: number;
+    totalPages: number;
+    totalCount: number;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface LabelsQueryResult extends QueryOffsetResult {
+    items: ContactLabel[];
+    query: LabelsQueryBuilder;
+    next: () => Promise<LabelsQueryResult>;
+    prev: () => Promise<LabelsQueryResult>;
+}
+export interface LabelsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'namespace' | 'key' | 'displayName' | 'labelType' | '_createdDate' | '_updatedDate', value: any) => LabelsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'namespace' | 'key' | 'displayName' | '_createdDate' | '_updatedDate', value: any) => LabelsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => LabelsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => LabelsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => LabelsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'displayName', value: string) => LabelsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'key' | 'displayName', value: any) => LabelsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'displayName' | '_createdDate' | '_updatedDate'>) => LabelsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'displayName' | '_createdDate' | '_updatedDate'>) => LabelsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => LabelsQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results.
+     * @documentationMaturity preview
+     */
+    skip: (skip: number) => LabelsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<LabelsQueryResult>;
+}
+export {};