@wix/auto_sdk_embeds_custom-embeds 1.0.0

package/build/cjs/embeds-v1-custom-embed-custom-embeds.universal-mfBLr_Yo.d.ts

@@ -0,0 +1,402 @@
+/** A custom embed is an entity that manages custom HTML and JavaScript code embedded in a site, along with its placement and properties. */
+interface CustomEmbed {
+    /**
+     * Custom embed ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the custom embed is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating a custom embed.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Custom embed name, as displayed to Wix users.
+     * @minLength 1
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * Whether the custom embed is enabled on the site.
+     * Default: `true`.
+     */
+    enabled?: boolean | null;
+    /**
+     * Whether to load the custom embed once during initial site rendering, rather than on each page navigation.
+     * This setting affects performance and should be chosen based on the embed's functionality.
+     * Default: `true`.
+     */
+    loadOnce?: boolean | null;
+    /**
+     * Site domain that's connected to the site, if relevant.
+     * @format HOSTNAME
+     */
+    domain?: string | null;
+    /** Position where the custom embed code is placed on the page. */
+    position?: PositionOnPageWithLiterals;
+    /** Custom embed data. */
+    embedData?: V1CustomEmbed;
+}
+declare enum PositionOnPage {
+    /** Illegal value, exception will be thrown if used */
+    UNKNOWN_POSITION = "UNKNOWN_POSITION",
+    /** HEAD position */
+    HEAD = "HEAD",
+    /** BODY_START position */
+    BODY_START = "BODY_START",
+    /** BODY_END position */
+    BODY_END = "BODY_END"
+}
+/** @enumType */
+type PositionOnPageWithLiterals = PositionOnPage | 'UNKNOWN_POSITION' | 'HEAD' | 'BODY_START' | 'BODY_END';
+interface V1CustomEmbed {
+    /** CustomEmbed's category */
+    category?: CategoryWithLiterals;
+    /**
+     * CustomEmbed's html
+     * @maxLength 15000
+     */
+    html?: string;
+}
+declare enum Category {
+    /** Illegal type, exception will be thrown if used */
+    UNKNOWN_CATEGORY = "UNKNOWN_CATEGORY",
+    /** Essential category */
+    ESSENTIAL = "ESSENTIAL",
+    /** Functional category */
+    FUNCTIONAL = "FUNCTIONAL",
+    /** Analytics category */
+    ANALYTICS = "ANALYTICS",
+    /** Advertising category */
+    ADVERTISING = "ADVERTISING",
+    /** Data to third party category */
+    DATA_TO_THIRD_PARTY = "DATA_TO_THIRD_PARTY"
+}
+/** @enumType */
+type CategoryWithLiterals = Category | 'UNKNOWN_CATEGORY' | 'ESSENTIAL' | 'FUNCTIONAL' | 'ANALYTICS' | 'ADVERTISING' | 'DATA_TO_THIRD_PARTY';
+interface CreateCustomEmbedRequest {
+    /** Custom embed to create. */
+    customEmbed: CustomEmbed;
+}
+interface CreateCustomEmbedResponse {
+    /** Created custom embed. */
+    customEmbed?: CustomEmbed;
+}
+interface GetCustomEmbedRequest {
+    /**
+     * Custom embed ID.
+     * @format GUID
+     */
+    customEmbedId: string;
+}
+interface GetCustomEmbedResponse {
+    /** Requested custom embed. */
+    customEmbed?: CustomEmbed;
+}
+interface UpdateCustomEmbedRequest {
+    /** Custom embed to update. */
+    customEmbed: CustomEmbed;
+}
+interface UpdateCustomEmbedResponse {
+    /** Updated custom embed. */
+    customEmbed?: CustomEmbed;
+}
+interface DeleteCustomEmbedRequest {
+    /**
+     * Custom embed ID to delete.
+     * @format GUID
+     */
+    customEmbedId: string;
+}
+interface DeleteCustomEmbedResponse {
+}
+interface ListCustomEmbedsRequest {
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface ListCustomEmbedsResponse {
+    /** List of custom embeds. */
+    customEmbeds?: CustomEmbed[];
+    /** Pagination metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface CustomEmbedCreatedEnvelope {
+    entity: CustomEmbed;
+    metadata: EventMetadata;
+}
+interface CustomEmbedDeletedEnvelope {
+    entity: CustomEmbed;
+    metadata: EventMetadata;
+}
+interface CustomEmbedUpdatedEnvelope {
+    entity: CustomEmbed;
+    metadata: EventMetadata;
+}
+interface UpdateCustomEmbed {
+    /**
+     * Custom embed ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the custom embed is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating a custom embed.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Custom embed name, as displayed to Wix users.
+     * @minLength 1
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * Whether the custom embed is enabled on the site.
+     * Default: `true`.
+     */
+    enabled?: boolean | null;
+    /**
+     * Whether to load the custom embed once during initial site rendering, rather than on each page navigation.
+     * This setting affects performance and should be chosen based on the embed's functionality.
+     * Default: `true`.
+     */
+    loadOnce?: boolean | null;
+    /**
+     * Site domain that's connected to the site, if relevant.
+     * @format HOSTNAME
+     */
+    domain?: string | null;
+    /** Position where the custom embed code is placed on the page. */
+    position?: PositionOnPageWithLiterals;
+    /** Custom embed data. */
+    embedData?: V1CustomEmbed;
+}
+interface ListCustomEmbedsOptions {
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+
+export { type ActionEvent as A, type BaseEventMetadata as B, type CustomEmbed as C, type DeleteCustomEmbedRequest as D, type EntityCreatedEvent as E, type GetCustomEmbedRequest as G, type IdentificationData as I, type ListCustomEmbedsOptions as L, type MessageEnvelope as M, PositionOnPage as P, type RestoreInfo as R, type UpdateCustomEmbed as U, type V1CustomEmbed as V, WebhookIdentityType as W, type ListCustomEmbedsResponse as a, type CustomEmbedCreatedEnvelope as b, type CustomEmbedDeletedEnvelope as c, type CustomEmbedUpdatedEnvelope as d, Category as e, type CreateCustomEmbedRequest as f, type CreateCustomEmbedResponse as g, type GetCustomEmbedResponse as h, type UpdateCustomEmbedRequest as i, type UpdateCustomEmbedResponse as j, type DeleteCustomEmbedResponse as k, type ListCustomEmbedsRequest as l, type CursorPaging as m, type CursorPagingMetadata as n, type Cursors as o, type DomainEvent as p, type DomainEventBodyOneOf as q, type EntityUpdatedEvent as r, type EntityDeletedEvent as s, type Empty as t, type IdentificationDataIdOneOf as u, type EventMetadata as v };

package/build/cjs/index.d.ts

@@ -0,0 +1,72 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { C as CustomEmbed, U as UpdateCustomEmbed, L as ListCustomEmbedsOptions, a as ListCustomEmbedsResponse, b as CustomEmbedCreatedEnvelope, c as CustomEmbedDeletedEnvelope, d as CustomEmbedUpdatedEnvelope } from './embeds-v1-custom-embed-custom-embeds.universal-mfBLr_Yo.js';
+export { A as ActionEvent, B as BaseEventMetadata, e as Category, f as CreateCustomEmbedRequest, g as CreateCustomEmbedResponse, m as CursorPaging, n as CursorPagingMetadata, o as Cursors, D as DeleteCustomEmbedRequest, k as DeleteCustomEmbedResponse, p as DomainEvent, q as DomainEventBodyOneOf, t as Empty, E as EntityCreatedEvent, s as EntityDeletedEvent, r as EntityUpdatedEvent, v as EventMetadata, G as GetCustomEmbedRequest, h as GetCustomEmbedResponse, I as IdentificationData, u as IdentificationDataIdOneOf, l as ListCustomEmbedsRequest, M as MessageEnvelope, P as PositionOnPage, R as RestoreInfo, i as UpdateCustomEmbedRequest, j as UpdateCustomEmbedResponse, V as V1CustomEmbed, W as WebhookIdentityType } from './embeds-v1-custom-embed-custom-embeds.universal-mfBLr_Yo.js';
+
+declare function createCustomEmbed$1(httpClient: HttpClient): CreateCustomEmbedSignature;
+interface CreateCustomEmbedSignature {
+    /**
+     * Creates a custom embed within the specified position (`HEAD`, `BODY_START` or `BODY_END`).
+     *
+     * Required fields: `name`, `position`, `embedData` (including `category` and `html`).
+     * @param - Custom embed to create.
+     * @returns Created custom embed.
+     */
+    (customEmbed: CustomEmbed): Promise<CustomEmbed>;
+}
+declare function getCustomEmbed$1(httpClient: HttpClient): GetCustomEmbedSignature;
+interface GetCustomEmbedSignature {
+    /**
+     * Retrieves a custom embed.
+     * @param - Custom embed ID.
+     * @returns Requested custom embed.
+     */
+    (customEmbedId: string): Promise<CustomEmbed>;
+}
+declare function updateCustomEmbed$1(httpClient: HttpClient): UpdateCustomEmbedSignature;
+interface UpdateCustomEmbedSignature {
+    /**
+     * Updates a custom embed.
+     * To prevent conflicting changes, you must pass the current revision number.
+     * @param - Custom embed ID.
+     * @returns Updated custom embed.
+     */
+    (_id: string, customEmbed: UpdateCustomEmbed): Promise<CustomEmbed>;
+}
+declare function deleteCustomEmbed$1(httpClient: HttpClient): DeleteCustomEmbedSignature;
+interface DeleteCustomEmbedSignature {
+    /**
+     * Permanently deletes a custom embed.
+     * @param - Custom embed ID to delete.
+     */
+    (customEmbedId: string): Promise<void>;
+}
+declare function listCustomEmbeds$1(httpClient: HttpClient): ListCustomEmbedsSignature;
+interface ListCustomEmbedsSignature {
+    /**
+     * Retrieves a list of up to 100 custom embeds, sorted by position  (`HEAD`, `BODY_START` or `BODY_END`).
+     */
+    (options?: ListCustomEmbedsOptions | undefined): Promise<ListCustomEmbedsResponse>;
+}
+declare const onCustomEmbedCreated$1: EventDefinition<CustomEmbedCreatedEnvelope, "wix.embeds.v1.custom_embed_created">;
+declare const onCustomEmbedDeleted$1: EventDefinition<CustomEmbedDeletedEnvelope, "wix.embeds.v1.custom_embed_deleted">;
+declare const onCustomEmbedUpdated$1: EventDefinition<CustomEmbedUpdatedEnvelope, "wix.embeds.v1.custom_embed_updated">;
+
+declare const createCustomEmbed: MaybeContext<BuildRESTFunction<typeof createCustomEmbed$1> & typeof createCustomEmbed$1>;
+declare const getCustomEmbed: MaybeContext<BuildRESTFunction<typeof getCustomEmbed$1> & typeof getCustomEmbed$1>;
+declare const updateCustomEmbed: MaybeContext<BuildRESTFunction<typeof updateCustomEmbed$1> & typeof updateCustomEmbed$1>;
+declare const deleteCustomEmbed: MaybeContext<BuildRESTFunction<typeof deleteCustomEmbed$1> & typeof deleteCustomEmbed$1>;
+declare const listCustomEmbeds: MaybeContext<BuildRESTFunction<typeof listCustomEmbeds$1> & typeof listCustomEmbeds$1>;
+/**
+ * Triggered when a custom embed is created.
+ */
+declare const onCustomEmbedCreated: BuildEventDefinition<typeof onCustomEmbedCreated$1>;
+/**
+ * Triggered when a custom embed is deleted.
+ */
+declare const onCustomEmbedDeleted: BuildEventDefinition<typeof onCustomEmbedDeleted$1>;
+/**
+ * Triggered when a custom embed is updated.
+ */
+declare const onCustomEmbedUpdated: BuildEventDefinition<typeof onCustomEmbedUpdated$1>;
+
+export { CustomEmbed, CustomEmbedCreatedEnvelope, CustomEmbedDeletedEnvelope, CustomEmbedUpdatedEnvelope, ListCustomEmbedsOptions, ListCustomEmbedsResponse, UpdateCustomEmbed, createCustomEmbed, deleteCustomEmbed, getCustomEmbed, listCustomEmbeds, onCustomEmbedCreated, onCustomEmbedDeleted, onCustomEmbedUpdated, updateCustomEmbed };