@wix/crm 1.0.85 → 1.0.87

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

@@ -1,627 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-/** 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.
-     *
-     * - `"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.
-     * 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<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * 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;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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.
-     */
-    currentEntity?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-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;
-    }[];
-}
-export declare const onLabelCreated: EventDefinition<DomainCreatedEvent<ContactLabel>, "wix.contacts.v4.label_created">;
-export declare const onLabelUpdated: EventDefinition<DomainUpdatedEvent<ContactLabel>, "wix.contacts.v4.label_updated">;
-export declare const onLabelDeleted: EventDefinition<DomainDeletedEvent<ContactLabel>, "wix.contacts.v4.label_deleted">;
-/**
- * Retrieves a label with a given name, or creates one if it doesn't exist.
- *
- * The `findOrCreateLabel()` function returns a Promise that resolves when the specified label is found or created.
- *
- * Successful calls to `findOrCreateLabel()` always returns a label, which can be passed to subsequent function calls.
- *
- * To find an existing label without potentially creating a new one, use `getLabel()` or `queryLabels()`.
- *
- *
- * @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
- * @param options - Language options.
- * @permissionScope Manage Contact Labels
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- * @returns Label that was found or created.
- */
-export declare function findOrCreateLabel(displayName: string, options?: FindOrCreateLabelOptions): Promise<FindOrCreateLabelResponse & FindOrCreateLabelResponseNonNullableFields>;
-export interface FindOrCreateLabelOptions {
-    /**
-     * Language for localization.
-     *
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
-     */
-    language?: string | null;
-}
-/**
- * Retrieves a label by the specified label key.
- *
- * The `getLabel()` function returns a Promise that resolves when the specified label is retrieved.
- * @param key - Label key.
- *
- * `key` is generated when the label is created.
- * It cannot be modified, even if `displayName` is updated.
- * @public
- * @documentationMaturity preview
- * @requiredField key
- * @param options - Language options.
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Contact Labels
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- * @returns The specified label.
- */
-export declare function getLabel(key: string, options?: GetLabelOptions): Promise<ContactLabel & NonNullable<GetLabelResponseNonNullableFields>['label']>;
-export interface GetLabelOptions {
-    /**
-     * Language for localization.
-     *
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
-     */
-    language?: string | null;
-}
-/**
- * Renames a label.
- *
- * The `renameLabel()` function returns a Promise that resolves when the specified label's display name is changed.
- *
- * @param key - Label key.
- *
- * `key` is generated when the label is created.
- * It cannot be modified, even if `displayName` is updated.
- * @public
- * @documentationMaturity preview
- * @requiredField key
- * @requiredField label
- * @requiredField label.displayName
- * @param options - Language options.
- * @param label - Label to rename.
- * @permissionScope Manage Contact Labels
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- * @returns
- */
-export declare function renameLabel(key: string, label: RenameLabel, options?: RenameLabelOptions): Promise<ContactLabel & NonNullable<UpdateLabelResponseNonNullableFields>['label']>;
-export interface RenameLabel {
-    /**
-     * 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 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 interface RenameLabelOptions {
-    /**
-     * Language for localization.
-     *
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
-     */
-    language?: string | null;
-}
-/**
- * Deletes a label from the site and removes it from contacts it applies to.
- *
- * The `deleteLabel()` function returns a Promise that resolves when the specified label is deleted.
- *
- *
- * @param key - Label key to delete.
- * @public
- * @documentationMaturity preview
- * @requiredField key
- * @permissionScope Manage Contact Labels
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- */
-export declare function deleteLabel(key: string): Promise<void>;
-/**
- * Creates a query to retrieve a list of labels.
- *
- * The `queryLabels()` function builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
- *
- * The returned object contains the query definition, which is used to run the query using the `find()` function.
- *
- * You can refine the query by chaining `LabelsQueryBuilder` functions onto the query. `LabelsQueryBuilder` functions enable you to filter, sort, and control the results that `queryLabels()` returns.
- *
- * `queryLabels()` runs with the following `LabelsQueryBuilder` defaults, which you can override:
- * - `skip(0)`
- * - `limit(50)`
- * - `descending('_createdDate')`
- *
- * The following `LabelsQueryBuilder` functions are supported for `queryLabels()`. For a full description of the `Labels` object, see the object returned for the `items` property in `LabelsQueryResult`.
- *
- *
- * @public
- * @documentationMaturity preview
- * @param options - Language options.
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Contact Labels
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- */
-export declare function queryLabels(options?: QueryLabelsOptions): LabelsQueryBuilder;
-export interface QueryLabelsOptions {
-    /**
-     * Language for localization.
-     *
-     * 2-letter language code in
-     * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
-     */
-    language?: string | null | undefined;
-}
-interface QueryOffsetResult {
-    currentPage: number | undefined;
-    totalPages: number | undefined;
-    totalCount: number | undefined;
-    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
-     */
-    ge: (propertyName: '_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 {};