@wix/auto_sdk_stores_ribbons-v-3 1.0.0

package/build/internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.d.ts

@@ -0,0 +1,514 @@
+/** A Ribbon is a visual element that you can assign to products to highlight them on your site. */
+export interface Ribbon {
+    /**
+     * Ribbon ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the ribbon is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the ribbon.
+     *
+     * Ignored when creating a ribbon.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the ribbon was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the ribbon was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Ribbon name. */
+    name?: string;
+    /**
+     * Number of products this ribbon is assigned to.
+     * > **Note:** Returned only when you pass `"ASSIGNED_PRODUCT_COUNT"` to the `fields` array in Ribbon API requests.
+     * @readonly
+     */
+    assignedProductCount?: number | null;
+}
+export interface InvalidateCache extends InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    reason?: string | null;
+    /** Is local DS */
+    localDc?: boolean;
+    hardPurge?: boolean;
+}
+/** @oneof */
+export interface InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+}
+export interface App {
+    /** The AppDefId */
+    appDefId?: string;
+    /** The instance Id */
+    instanceId?: string;
+}
+export interface Page {
+    /** the msid the page is on */
+    metaSiteId?: string;
+    /** Invalidate by Page ID */
+    pageId?: string;
+}
+export interface URI {
+    /** the msid the URI is on */
+    metaSiteId?: string;
+    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    uriPath?: string;
+}
+export interface File {
+    /** the msid the file is related to */
+    metaSiteId?: string;
+    /** Invalidate by filename (for media files such as PDFs) */
+    fileName?: string;
+}
+export interface CreateRibbonRequest {
+    /** Ribbon to create. */
+    ribbon: Ribbon;
+}
+export interface CreateRibbonResponse {
+    /** Created ribbon. */
+    ribbon?: Ribbon;
+}
+export interface GetRibbonRequest {
+    /** Ribbon ID. */
+    ribbonId: string;
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     */
+    fields?: RequestedFields[];
+}
+export declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    ASSIGNED_PRODUCT_COUNT = "ASSIGNED_PRODUCT_COUNT"
+}
+export interface GetRibbonResponse {
+    /** Ribbon. */
+    ribbon?: Ribbon;
+}
+export interface UpdateRibbonRequest {
+    /** Ribbon to update. */
+    ribbon: Ribbon;
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     */
+    fields?: RequestedFields[];
+}
+export interface UpdateRibbonResponse {
+    /** Updated Ribbon. */
+    ribbon?: Ribbon;
+}
+export interface DeleteRibbonRequest {
+    /** Ribbon ID. */
+    ribbonId: string;
+}
+export interface DeleteRibbonResponse {
+}
+export interface QueryRibbonsRequest {
+    /** Query options. */
+    query?: CursorQuery;
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     */
+    fields?: RequestedFields[];
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    /** Ascending order. */
+    ASC = "ASC",
+    /** Descending order. */
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface QueryRibbonsResponse {
+    /** List of ribbons. */
+    ribbons?: Ribbon[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    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;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface BulkCreateRibbonsRequest {
+    /** Ribbons to create. */
+    ribbons: Ribbon[];
+    /**
+     * Whether to return the full created ribbon entities in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+export interface BulkCreateRibbonsResponse {
+    /** Ribbons created by bulk action. */
+    results?: V3BulkRibbonResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface V3BulkRibbonResult {
+    /** Bulk action metadata for ribbon. */
+    itemMetadata?: ItemMetadata;
+    /**
+     * Full ribbon entity.
+     *
+     * Returned only if `returnEntity: true` is passed in the request.
+     */
+    item?: Ribbon;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface BulkUpdateRibbonsRequest {
+    /** List of ribbons to update. */
+    ribbons: MaskedRibbon[];
+    /**
+     * Whether to return the full updated ribbon entities in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     */
+    fields?: RequestedFields[];
+}
+export interface MaskedRibbon {
+    /** Ribbon to update. */
+    ribbon?: Ribbon;
+    /** Explicit list of fields to update. */
+    fieldMask?: string[];
+}
+export interface BulkUpdateRibbonsResponse {
+    /** Ribbons updated by bulk action. */
+    results?: V3BulkRibbonResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface GetOrCreateRibbonRequest {
+    /** Ribbon name to retrieve or create. */
+    ribbonName: string;
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     */
+    fields?: RequestedFields[];
+}
+export interface GetOrCreateRibbonResponse {
+    /** Ribbon. */
+    ribbon?: Ribbon;
+}
+export interface BulkGetOrCreateRibbonsRequest {
+    /** Ribbon names to retrieve or create. */
+    ribbonNames: string[];
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     */
+    fields?: RequestedFields[];
+}
+export interface BulkGetOrCreateRibbonsResponse {
+    /** Ribbons retrieved or created by bulk action. */
+    results?: V3BulkRibbonResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkDeleteRibbonsRequest {
+    /** IDs of ribbons to delete. */
+    ribbonIds: string[];
+}
+export interface BulkDeleteRibbonsResponse {
+    /** Ribbons deleted by bulk action. */
+    results?: BulkRibbonResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkRibbonResult {
+    /** Bulk action metadata for ribbon. */
+    itemMetadata?: ItemMetadata;
+}
+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 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 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;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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 Empty {
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface RibbonNonNullableFields {
+    name: string;
+}
+export interface CreateRibbonResponseNonNullableFields {
+    ribbon?: RibbonNonNullableFields;
+}
+export interface GetRibbonResponseNonNullableFields {
+    ribbon?: RibbonNonNullableFields;
+}
+export interface UpdateRibbonResponseNonNullableFields {
+    ribbon?: RibbonNonNullableFields;
+}
+export interface QueryRibbonsResponseNonNullableFields {
+    ribbons: RibbonNonNullableFields[];
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface V3BulkRibbonResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: RibbonNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreateRibbonsResponseNonNullableFields {
+    results: V3BulkRibbonResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkUpdateRibbonsResponseNonNullableFields {
+    results: V3BulkRibbonResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface GetOrCreateRibbonResponseNonNullableFields {
+    ribbon?: RibbonNonNullableFields;
+}
+export interface BulkGetOrCreateRibbonsResponseNonNullableFields {
+    results: V3BulkRibbonResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkRibbonResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+export interface BulkDeleteRibbonsResponseNonNullableFields {
+    results: BulkRibbonResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export {};

package/build/internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.SortOrder = exports.RequestedFields = void 0;
+var RequestedFields;
+(function (RequestedFields) {
+    RequestedFields["UNKNOWN_REQUESTED_FIELD"] = "UNKNOWN_REQUESTED_FIELD";
+    RequestedFields["ASSIGNED_PRODUCT_COUNT"] = "ASSIGNED_PRODUCT_COUNT";
+})(RequestedFields || (exports.RequestedFields = RequestedFields = {}));
+var SortOrder;
+(function (SortOrder) {
+    /** Ascending order. */
+    SortOrder["ASC"] = "ASC";
+    /** Descending order. */
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (exports.SortOrder = SortOrder = {}));
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+//# sourceMappingURL=stores-catalog-v3-ribbon-ribbons-v-3.types.js.map

package/build/internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-catalog-v3-ribbon-ribbons-v-3.types.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v3-ribbon-ribbons-v-3.types.ts"],"names":[],"mappings":";;;AAyHA,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,sEAAmD,CAAA;IACnD,oEAAiD,CAAA;AACnD,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B;AAyED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,uBAAuB;IACvB,wBAAW,CAAA;IACX,wBAAwB;IACxB,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA2SD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}