@wix/auto_sdk_benefit-programs_items 1.0.27 → 1.0.29

package/build/cjs/{benefit-programs-v1-item-items.universal-CkMjOEfX.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Item {
     /**
      * Benefit item ID.
@@ -652,6 +654,43 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** @docsIgnore */
+type CountItemsApplicationErrors = {
+    code?: 'TOO_MANY_TO_COUNT';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Creates a benefit item.
+ * @param item - Item to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField item
+ * @requiredField item.externalId
+ * @requiredField item.itemSetId
+ * @requiredField item.namespace
+ * @requiredField item.providerAppId
+ * @permissionId BENEFIT_PROGRAMS.ITEM_CREATE
+ * @applicableIdentity APP
+ * @returns Created item.
+ * @fqn wix.benefit_programs.v1.item.ItemService.CreateItem
+ */
+declare function createItem(item: NonNullablePaths<Item, `externalId` | `itemSetId` | `namespace` | `providerAppId`, 2>): Promise<Item>;
+/**
+ * Creates benefit items.
+ * @param items - Items to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField items
+ * @requiredField items.externalId
+ * @requiredField items.itemSetId
+ * @requiredField items.namespace
+ * @requiredField items.providerAppId
+ * @permissionId BENEFIT_PROGRAMS.ITEM_CREATE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.BulkCreateItems
+ */
+declare function bulkCreateItems(items: NonNullablePaths<Item, `externalId` | `itemSetId` | `namespace` | `providerAppId`, 2>[], options?: BulkCreateItemsOptions): Promise<NonNullablePaths<BulkCreateItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 interface BulkCreateItemsOptions {
     /**
      * Whether to return the full item entities.
@@ -660,10 +699,83 @@ interface BulkCreateItemsOptions {
      */
     returnEntity?: boolean;
 }
+/**
+ * Deletes a benefit item.
+ *
+ * <blockquote class="caution">
+ * <strong>Caution:</strong>
+ *
+ * Deleting a benefit item removes the association between a benefit and the item with immediate effect. This may affect currently active pools.
+ * </blockquote>
+ * @param itemId - Item ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemId
+ * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.DeleteItem
+ */
+declare function deleteItem(itemId: string): Promise<void>;
+/**
+ * Deletes benefit items.
+ *
+ * <blockquote class="caution">
+ * <strong>Caution:</strong>
+ *
+ * Deleting a benefit item removes the association between a benefit and the item with immediate effect. This may affect currently active pools.
+ * </blockquote>
+ * @param itemIds - List of IDs of the items to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemIds
+ * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItems
+ */
+declare function bulkDeleteItems(itemIds: string[]): Promise<NonNullablePaths<BulkDeleteItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+/**
+ * Deletes benefit items that fulfill the specified filter conditions.
+ *
+ * For a list of supported filters, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/items/filtering-and-sorting).
+ *
+ * <blockquote class="caution">
+ * <strong>Caution:</strong>
+ *
+ * Deleting a benefit item removes the association between a benefit and the item with immediate effect. This may affect currently active pools.
+ * </blockquote>
+ * @param namespace - 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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField namespace
+ * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItemsByFilter
+ */
+declare function bulkDeleteItemsByFilter(namespace: string, options?: BulkDeleteItemsByFilterOptions): Promise<NonNullablePaths<BulkDeleteItemsByFilterResponse, `jobId`, 2>>;
 interface BulkDeleteItemsByFilterOptions {
     /** 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;
 }
+/**
+ * Updates a benefit item.
+ *
+ * Each time the benefit item is updated,
+ * `revision` increments by 1.
+ * The current `revision` must be passed when updating the benefit item.
+ * This ensures you're working with the latest benefit item
+ * and prevents unintended overwrites.
+ * @param _id - Benefit item ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField item
+ * @requiredField item.revision
+ * @permissionId BENEFIT_PROGRAMS.ITEM_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated item.
+ * @fqn wix.benefit_programs.v1.item.ItemService.UpdateItem
+ */
+declare function updateItem(_id: string, item: NonNullablePaths<UpdateItem, `revision`, 2>): Promise<Item>;
 interface UpdateItem {
     /**
      * Benefit item ID.
@@ -739,6 +851,24 @@ interface UpdateItem {
      */
     namespace?: string | null;
 }
+/**
+ * Updates benefit items.
+ *
+ * Each time the benefit item is updated,
+ * `revision` increments by 1.
+ * The current `revision` must be passed when updating the benefit item.
+ * This ensures you're working with the latest benefit item
+ * and prevents unintended overwrites.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.items.item
+ * @requiredField options.items.item._id
+ * @requiredField options.items.item.revision
+ * @permissionId BENEFIT_PROGRAMS.ITEM_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.BulkUpdateItems
+ */
+declare function bulkUpdateItems(options?: NonNullablePaths<BulkUpdateItemsOptions, `items.${number}.item` | `items.${number}.item._id` | `items.${number}.item.revision`, 5>): Promise<NonNullablePaths<BulkUpdateItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 interface BulkUpdateItemsOptions {
     /**
      * Items to update.
@@ -753,12 +883,52 @@ interface BulkUpdateItemsOptions {
      */
     returnEntity?: boolean;
 }
+/**
+ * Retrieves a benefit item.
+ * @param itemId - ID of the item to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemId
+ * @permissionId BENEFIT_PROGRAMS.ITEM_READ
+ * @applicableIdentity APP
+ * @returns Retrieved item.
+ * @fqn wix.benefit_programs.v1.item.ItemService.GetItem
+ */
+declare function getItem(itemId: string): Promise<Item>;
+/**
+ * Retrieves a list of up to 1000 benefit items.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.ITEM_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.ListItems
+ */
+declare function listItems(options?: ListItemsOptions): Promise<NonNullablePaths<ListItemsResponse, `items`, 2>>;
 interface ListItemsOptions {
     /** Filter. */
     filter?: Filter;
     /** Cursor paging */
     cursorPaging?: CursorPaging;
 }
+/**
+ * Creates a query to retrieve a list of items.
+ *
+ * The Query Items method builds a query to retrieve a list of items and returns a `ItemsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
+ *
+ * You can refine the query by chaining `ItemsQueryBuilder` methods onto the query. `ItemsQueryBuilder` methods enable you to filter, sort, and control the results that Query Items returns.
+ *
+ * Query Items has a default paging limit of 50, which you can override.
+ *
+ *  For a full description of the item object, see the object returned for the `items` property in `ItemsQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.ITEM_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.QueryItems
+ */
+declare function queryItems(): ItemsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -836,6 +1006,19 @@ interface ItemsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ItemsQueryResult>;
 }
+/**
+ * Counts how many benefit items exist that fulfill the specified filtering conditions.
+ *
+ * For a list of supported filters, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/items/filtering-and-sorting).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.ITEM_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.CountItems
+ */
+declare function countItems(options?: CountItemsOptions): Promise<NonNullablePaths<CountItemsResponse, `count`, 2> & {
+    __applicationErrorsType?: CountItemsApplicationErrors;
+}>;
 interface CountItemsOptions {
     /**
      * Items to count.
@@ -845,4 +1028,4 @@ interface CountItemsOptions {
     filter?: Record<string, any> | null;
 }
 
-export { type CloneItemsResponse as $, type ApplicationError as A, type BulkCreateItemsOptions as B, type CountItemsOptions as C, type DeleteItemRequest as D, type ExtendedFields as E, type ByReference as F, type GetItemRequest as G, type ByReferenceFilter as H, type Item as I, type Filter as J, type FilterFilterOneOf as K, type ListItemsOptions as L, type MaskedItem as M, type CursorPaging as N, type CursorPagingMetadata as O, type Cursors as P, type QueryItemsRequest as Q, type CursorQuery as R, SortOrder as S, Type as T, type UpdateItem as U, type CursorQueryPagingMethodOneOf as V, WebhookIdentityType as W, type Sorting as X, type QueryItemsResponse as Y, type CountItemsRequest as Z, type CloneItemsRequest as _, type BulkCreateItemsResponse as a, type BulkCloneItemSetsRequest as a0, type BulkCloneItemSetsResponse as a1, type BulkCloneItemSetsResult as a2, type AllocateItemSetsRequest as a3, type AllocateItemSetsResponse as a4, type DomainEvent as a5, type DomainEventBodyOneOf as a6, type EntityCreatedEvent as a7, type RestoreInfo as a8, type EntityUpdatedEvent as a9, type EntityDeletedEvent as aa, type ActionEvent as ab, type MessageEnvelope as ac, type IdentificationData as ad, type IdentificationDataIdOneOf as ae, type ItemsQueryResult as af, type BulkDeleteItemsResponse as b, type BulkDeleteItemsByFilterOptions as c, type BulkDeleteItemsByFilterResponse as d, type BulkUpdateItemsOptions as e, type BulkUpdateItemsResponse as f, type ListItemsResponse as g, type ItemsQueryBuilder as h, type CountItemsResponse as i, type ItemsCloned as j, type CreateItemRequest as k, type CreateItemResponse as l, type BulkCreateItemsRequest as m, type BulkItemResult as n, type ItemMetadata as o, type BulkActionMetadata as p, type DeleteItemResponse as q, type BulkDeleteItemsRequest as r, type BulkDeleteItemsByFilterRequest as s, type UpdateItemRequest as t, type UpdateItemResponse as u, type BulkUpdateItemsRequest as v, type GetItemResponse as w, type ListItemsRequest as x, type ByItemSetIdAndReference as y, type ByItemSetIdAndReferenceFilter as z };
+export { type ActionEvent, type AllocateItemSetsRequest, type AllocateItemSetsResponse, type ApplicationError, type BulkActionMetadata, type BulkCloneItemSetsRequest, type BulkCloneItemSetsResponse, type BulkCloneItemSetsResult, type BulkCreateItemsOptions, type BulkCreateItemsRequest, type BulkCreateItemsResponse, type BulkDeleteItemsByFilterOptions, type BulkDeleteItemsByFilterRequest, type BulkDeleteItemsByFilterResponse, type BulkDeleteItemsRequest, type BulkDeleteItemsResponse, type BulkItemResult, type BulkUpdateItemsOptions, type BulkUpdateItemsRequest, type BulkUpdateItemsResponse, type ByItemSetIdAndReference, type ByItemSetIdAndReferenceFilter, type ByReference, type ByReferenceFilter, type CloneItemsRequest, type CloneItemsResponse, type CountItemsApplicationErrors, type CountItemsOptions, type CountItemsRequest, type CountItemsResponse, type CreateItemRequest, type CreateItemResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteItemRequest, type DeleteItemResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type Filter, type FilterFilterOneOf, type GetItemRequest, type GetItemResponse, type IdentificationData, type IdentificationDataIdOneOf, type Item, type ItemMetadata, type ItemsCloned, type ItemsQueryBuilder, type ItemsQueryResult, type ListItemsOptions, type ListItemsRequest, type ListItemsResponse, type MaskedItem, type MessageEnvelope, type QueryItemsRequest, type QueryItemsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type UpdateItem, type UpdateItemRequest, type UpdateItemResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateItems, bulkDeleteItems, bulkDeleteItemsByFilter, bulkUpdateItems, countItems, createItem, deleteItem, getItem, listItems, queryItems, updateItem };