@wix/auto_sdk_benefit-programs_items 1.0.16 → 1.0.18

package/build/{meta.d.ts → internal/es/src/benefit-programs-v1-item-items.types.d.ts}

@@ -1,6 +1,4 @@
-import { k as CreateItemRequest$1, l as CreateItemResponse$1, m as BulkCreateItemsRequest$1, a as BulkCreateItemsResponse$1, D as DeleteItemRequest$1, q as DeleteItemResponse$1, r as BulkDeleteItemsRequest$1, b as BulkDeleteItemsResponse$1, s as BulkDeleteItemsByFilterRequest$1, d as BulkDeleteItemsByFilterResponse$1, t as UpdateItemRequest$1, u as UpdateItemResponse$1, v as BulkUpdateItemsRequest$1, f as BulkUpdateItemsResponse$1, G as GetItemRequest$1, w as GetItemResponse$1, x as ListItemsRequest$1, g as ListItemsResponse$1, Q as QueryItemsRequest$1, Y as QueryItemsResponse$1, Z as CountItemsRequest$1, i as CountItemsResponse$1 } from './benefit-programs-v1-item-items.universal-C7Ua6Gkb.js';
-
-interface Item {
+export interface Item {
     /**
      * Benefit item ID.
      * @format GUID
@@ -75,7 +73,7 @@ interface Item {
      */
     namespace?: string | null;
 }
-interface ExtendedFields {
+export interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -86,15 +84,22 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-interface CreateItemRequest {
+export interface ItemsCloned {
+    /**
+     * ID of the pool that had its items provisioned
+     * @format GUID
+     */
+    itemSetId?: string;
+}
+export interface CreateItemRequest {
     /** Item to create. */
     item: Item;
 }
-interface CreateItemResponse {
+export interface CreateItemResponse {
     /** Created item. */
     item?: Item;
 }
-interface BulkCreateItemsRequest {
+export interface BulkCreateItemsRequest {
     /**
      * Items to create.
      * @minSize 1
@@ -108,7 +113,7 @@ interface BulkCreateItemsRequest {
      */
     returnEntity?: boolean;
 }
-interface BulkCreateItemsResponse {
+export interface BulkCreateItemsResponse {
     /**
      * List of created items and associated metadata.
      * @minSize 1
@@ -118,13 +123,13 @@ interface BulkCreateItemsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface BulkItemResult {
+export interface BulkItemResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
     /** Item. */
     item?: Item;
 }
-interface ItemMetadata {
+export interface ItemMetadata {
     /**
      * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
      * @format GUID
@@ -137,7 +142,7 @@ interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-interface ApplicationError {
+export interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -145,7 +150,7 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface BulkActionMetadata {
+export interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -153,16 +158,16 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-interface DeleteItemRequest {
+export interface DeleteItemRequest {
     /**
      * Item ID.
      * @format GUID
      */
     itemId: string;
 }
-interface DeleteItemResponse {
+export interface DeleteItemResponse {
 }
-interface BulkDeleteItemsRequest {
+export interface BulkDeleteItemsRequest {
     /**
      * List of IDs of the items to delete.
      * @minSize 1
@@ -171,7 +176,7 @@ interface BulkDeleteItemsRequest {
      */
     itemIds: string[];
 }
-interface BulkDeleteItemsResponse {
+export interface BulkDeleteItemsResponse {
     /**
      * List of deleted items and associated metadata.
      * @minSize 1
@@ -181,7 +186,7 @@ interface BulkDeleteItemsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface BulkDeleteItemsByFilterRequest {
+export interface BulkDeleteItemsByFilterRequest {
     /**
      * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
      * @minLength 1
@@ -191,22 +196,22 @@ interface BulkDeleteItemsByFilterRequest {
     /** Filter options. To learn more, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
     filter?: Record<string, any> | null;
 }
-interface BulkDeleteItemsByFilterResponse {
+export interface BulkDeleteItemsByFilterResponse {
     /**
      * Job ID for item deletion. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
 }
-interface UpdateItemRequest {
+export interface UpdateItemRequest {
     /** Item to update. */
     item: Item;
 }
-interface UpdateItemResponse {
+export interface UpdateItemResponse {
     /** Updated item. */
     item?: Item;
 }
-interface BulkUpdateItemsRequest {
+export interface BulkUpdateItemsRequest {
     /**
      * Items to update.
      * @minSize 1
@@ -220,13 +225,13 @@ interface BulkUpdateItemsRequest {
      */
     returnEntity?: boolean;
 }
-interface MaskedItem {
+export interface MaskedItem {
     /** Item to update. */
     item?: Item;
     /** Explicit list of fields to update. */
     fieldMask?: string[];
 }
-interface BulkUpdateItemsResponse {
+export interface BulkUpdateItemsResponse {
     /**
      * List of updated items and associated metadata.
      * @minSize 1
@@ -236,24 +241,24 @@ interface BulkUpdateItemsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface GetItemRequest {
+export interface GetItemRequest {
     /**
      * ID of the item to retrieve.
      * @format GUID
      */
     itemId: string;
 }
-interface GetItemResponse {
+export interface GetItemResponse {
     /** Retrieved item. */
     item?: Item;
 }
-interface ListItemsRequest {
+export interface ListItemsRequest {
     /** Filter. */
     filter?: Filter;
     /** Cursor paging */
     cursorPaging?: CursorPaging;
 }
-declare enum Type {
+export declare enum Type {
     /** Unknown filter type. */
     UNKNOWN_FILTER = "UNKNOWN_FILTER",
     /** Use with `filter.byItemSetIdAndReferenceOptions`. */
@@ -261,7 +266,7 @@ declare enum Type {
     /** Use with `filter.byReferenceOptions`. */
     BY_REFERENCE = "BY_REFERENCE"
 }
-interface ByItemSetIdAndReference {
+export interface ByItemSetIdAndReference {
     /**
      * Filter list.
      * @minSize 1
@@ -269,7 +274,7 @@ interface ByItemSetIdAndReference {
      */
     filters?: ByItemSetIdAndReferenceFilter[];
 }
-interface ByItemSetIdAndReferenceFilter {
+export interface ByItemSetIdAndReferenceFilter {
     /**
      * ID set ID.
      * @format GUID
@@ -291,7 +296,7 @@ interface ByItemSetIdAndReferenceFilter {
      */
     providerAppId?: string;
 }
-interface ByReference {
+export interface ByReference {
     /**
      * Filter list.
      * @minSize 1
@@ -299,7 +304,7 @@ interface ByReference {
      */
     filters?: ByReferenceFilter[];
 }
-interface ByReferenceFilter {
+export interface ByReferenceFilter {
     /**
      * External item ID.
      * @format GUID
@@ -316,7 +321,7 @@ interface ByReferenceFilter {
      */
     providerAppId?: string;
 }
-interface Filter extends FilterFilterOneOf {
+export interface Filter extends FilterFilterOneOf {
     /** Filter the request by `itemSetId` and item reference. */
     byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
     /** Filter the request item reference. */
@@ -331,13 +336,13 @@ interface Filter extends FilterFilterOneOf {
     namespace?: string;
 }
 /** @oneof */
-interface FilterFilterOneOf {
+export interface FilterFilterOneOf {
     /** Filter the request by `itemSetId` and item reference. */
     byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
     /** Filter the request item reference. */
     byReferenceOptions?: ByReference;
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return.
      * @max 1000
@@ -352,13 +357,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface ListItemsResponse {
+export interface ListItemsResponse {
     /** Items. */
     items?: Item[];
     /** Metadata for paginated results. */
     metadata?: CursorPagingMetadata;
 }
-interface 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. */
@@ -371,7 +376,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -383,11 +388,11 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface QueryItemsRequest {
+export interface QueryItemsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -407,11 +412,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface CursorQueryPagingMethodOneOf {
+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;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Field to sort by.
      * @maxLength 512
@@ -420,17 +425,17 @@ interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-interface QueryItemsResponse {
+export interface QueryItemsResponse {
     /** List of retrieved items. */
     items?: Item[];
     /** Metadata for paginated results. */
     metadata?: CursorPagingMetadata;
 }
-interface CountItemsRequest {
+export interface CountItemsRequest {
     /**
      * Items to count.
      *
@@ -438,37 +443,216 @@ interface CountItemsRequest {
      */
     filter?: Record<string, any> | null;
 }
-interface CountItemsResponse {
+export interface CountItemsResponse {
     /** Number of items fulfilling the specified filter conditions. */
     count?: number;
 }
-
-type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-declare function createItem(): __PublicMethodMetaInfo<'POST', {}, CreateItemRequest$1, CreateItemRequest, CreateItemResponse$1, CreateItemResponse>;
-declare function bulkCreateItems(): __PublicMethodMetaInfo<'POST', {}, BulkCreateItemsRequest$1, BulkCreateItemsRequest, BulkCreateItemsResponse$1, BulkCreateItemsResponse>;
-declare function deleteItem(): __PublicMethodMetaInfo<'POST', {
-    itemId: string;
-}, DeleteItemRequest$1, DeleteItemRequest, DeleteItemResponse$1, DeleteItemResponse>;
-declare function bulkDeleteItems(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteItemsRequest$1, BulkDeleteItemsRequest, BulkDeleteItemsResponse$1, BulkDeleteItemsResponse>;
-declare function bulkDeleteItemsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteItemsByFilterRequest$1, BulkDeleteItemsByFilterRequest, BulkDeleteItemsByFilterResponse$1, BulkDeleteItemsByFilterResponse>;
-declare function updateItem(): __PublicMethodMetaInfo<'PATCH', {
-    itemId: string;
-}, UpdateItemRequest$1, UpdateItemRequest, UpdateItemResponse$1, UpdateItemResponse>;
-declare function bulkUpdateItems(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateItemsRequest$1, BulkUpdateItemsRequest, BulkUpdateItemsResponse$1, BulkUpdateItemsResponse>;
-declare function getItem(): __PublicMethodMetaInfo<'GET', {
-    itemId: string;
-}, GetItemRequest$1, GetItemRequest, GetItemResponse$1, GetItemResponse>;
-declare function listItems(): __PublicMethodMetaInfo<'GET', {}, ListItemsRequest$1, ListItemsRequest, ListItemsResponse$1, ListItemsResponse>;
-declare function queryItems(): __PublicMethodMetaInfo<'POST', {}, QueryItemsRequest$1, QueryItemsRequest, QueryItemsResponse$1, QueryItemsResponse>;
-declare function countItems(): __PublicMethodMetaInfo<'POST', {}, CountItemsRequest$1, CountItemsRequest, CountItemsResponse$1, CountItemsResponse>;
-
-export { type __PublicMethodMetaInfo, bulkCreateItems, bulkDeleteItems, bulkDeleteItemsByFilter, bulkUpdateItems, countItems, createItem, deleteItem, getItem, listItems, queryItems, updateItem };
+export interface CloneItemsRequest {
+    /**
+     * Id of the item set to be cloned
+     * @format GUID
+     */
+    itemSetId?: string;
+}
+export interface CloneItemsResponse {
+    /**
+     * Id of the item set that these items were added to
+     * @format GUID
+     */
+    clonedItemSetId?: string;
+    /**
+     * Id of the job that is cloning the item set
+     * @format GUID
+     */
+    cloneJobId?: string;
+}
+export interface BulkCloneItemSetsRequest {
+    /**
+     * Id of the item sets to be cloned
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
+    itemSetIds?: string[];
+}
+export interface BulkCloneItemSetsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 1000
+     */
+    results?: BulkCloneItemSetsResult[];
+    /** Bulk action metadata */
+    bulkActionMetadata?: BulkActionMetadata;
+    /**
+     * Id of the job that is cloning the item set
+     * @format GUID
+     */
+    jobId?: string;
+}
+export interface BulkCloneItemSetsResult {
+    /** Item metadata */
+    itemMetadata?: ItemMetadata;
+    /**
+     * Id of the item set that these items were added to
+     * @format GUID
+     */
+    clonedItemSetId?: string;
+}
+export interface AllocateItemSetsRequest {
+    /**
+     * Number of sets to allocate
+     * @min 1
+     * @max 1000
+     */
+    numberOfSets?: number;
+}
+export interface AllocateItemSetsResponse {
+    /**
+     * ID that is a shared reference between a benefit pool and a specific item.
+     * @format GUID
+     */
+    itemSetIds?: string[];
+}
+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 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;
+}
+export 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?: WebhookIdentityType;
+}
+/** @oneof */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}

package/build/internal/es/src/benefit-programs-v1-item-items.types.js

@@ -0,0 +1,23 @@
+export var Type;
+(function (Type) {
+    /** Unknown filter type. */
+    Type["UNKNOWN_FILTER"] = "UNKNOWN_FILTER";
+    /** Use with `filter.byItemSetIdAndReferenceOptions`. */
+    Type["BY_ITEM_SET_ID_AND_REFERENCE"] = "BY_ITEM_SET_ID_AND_REFERENCE";
+    /** Use with `filter.byReferenceOptions`. */
+    Type["BY_REFERENCE"] = "BY_REFERENCE";
+})(Type || (Type = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+//# sourceMappingURL=benefit-programs-v1-item-items.types.js.map

package/build/internal/es/src/benefit-programs-v1-item-items.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"benefit-programs-v1-item-items.types.js","sourceRoot":"","sources":["../../../../src/benefit-programs-v1-item-items.types.ts"],"names":[],"mappings":"AA4RA,MAAM,CAAN,IAAY,IAOX;AAPD,WAAY,IAAI;IACd,2BAA2B;IAC3B,yCAAiC,CAAA;IACjC,wDAAwD;IACxD,qEAA6D,CAAA;IAC7D,4CAA4C;IAC5C,qCAA6B,CAAA;AAC/B,CAAC,EAPW,IAAI,KAAJ,IAAI,QAOf;AA+KD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAkPD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}