@wix/auto_sdk_benefit-programs_items 1.0.16 → 1.0.18

package/build/{benefit-programs-v1-item-items.universal-C7Ua6Gkb.d.ts → es/src/benefit-programs-v1-item-items.universal.d.ts}

@@ -1,4 +1,5 @@
-interface Item {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface Item {
     /**
      * Benefit item ID.
      * @format GUID
@@ -73,7 +74,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.
@@ -84,22 +85,22 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-interface ItemsCloned {
+export interface ItemsCloned {
     /**
      * ID of the pool that had its items provisioned
      * @format GUID
      */
     itemSetId?: string;
 }
-interface CreateItemRequest {
+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
@@ -113,7 +114,7 @@ interface BulkCreateItemsRequest {
      */
     returnEntity?: boolean;
 }
-interface BulkCreateItemsResponse {
+export interface BulkCreateItemsResponse {
     /**
      * List of created items and associated metadata.
      * @minSize 1
@@ -123,13 +124,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
@@ -142,7 +143,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. */
@@ -150,7 +151,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. */
@@ -158,16 +159,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
@@ -176,7 +177,7 @@ interface BulkDeleteItemsRequest {
      */
     itemIds: string[];
 }
-interface BulkDeleteItemsResponse {
+export interface BulkDeleteItemsResponse {
     /**
      * List of deleted items and associated metadata.
      * @minSize 1
@@ -186,7 +187,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
@@ -196,22 +197,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
@@ -225,13 +226,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
@@ -241,24 +242,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`. */
@@ -266,7 +267,7 @@ declare enum Type {
     /** Use with `filter.byReferenceOptions`. */
     BY_REFERENCE = "BY_REFERENCE"
 }
-interface ByItemSetIdAndReference {
+export interface ByItemSetIdAndReference {
     /**
      * Filter list.
      * @minSize 1
@@ -274,7 +275,7 @@ interface ByItemSetIdAndReference {
      */
     filters?: ByItemSetIdAndReferenceFilter[];
 }
-interface ByItemSetIdAndReferenceFilter {
+export interface ByItemSetIdAndReferenceFilter {
     /**
      * ID set ID.
      * @format GUID
@@ -296,7 +297,7 @@ interface ByItemSetIdAndReferenceFilter {
      */
     providerAppId?: string;
 }
-interface ByReference {
+export interface ByReference {
     /**
      * Filter list.
      * @minSize 1
@@ -304,7 +305,7 @@ interface ByReference {
      */
     filters?: ByReferenceFilter[];
 }
-interface ByReferenceFilter {
+export interface ByReferenceFilter {
     /**
      * External item ID.
      * @format GUID
@@ -321,7 +322,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. */
@@ -336,13 +337,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
@@ -357,13 +358,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. */
@@ -376,7 +377,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
@@ -388,11 +389,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;
     /**
@@ -412,11 +413,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
@@ -425,17 +426,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.
      *
@@ -443,18 +444,18 @@ interface CountItemsRequest {
      */
     filter?: Record<string, any> | null;
 }
-interface CountItemsResponse {
+export interface CountItemsResponse {
     /** Number of items fulfilling the specified filter conditions. */
     count?: number;
 }
-interface CloneItemsRequest {
+export interface CloneItemsRequest {
     /**
      * Id of the item set to be cloned
      * @format GUID
      */
     itemSetId?: string;
 }
-interface CloneItemsResponse {
+export interface CloneItemsResponse {
     /**
      * Id of the item set that these items were added to
      * @format GUID
@@ -466,7 +467,7 @@ interface CloneItemsResponse {
      */
     cloneJobId?: string;
 }
-interface BulkCloneItemSetsRequest {
+export interface BulkCloneItemSetsRequest {
     /**
      * Id of the item sets to be cloned
      * @format GUID
@@ -475,7 +476,7 @@ interface BulkCloneItemSetsRequest {
      */
     itemSetIds?: string[];
 }
-interface BulkCloneItemSetsResponse {
+export interface BulkCloneItemSetsResponse {
     /**
      * Results
      * @minSize 1
@@ -490,7 +491,7 @@ interface BulkCloneItemSetsResponse {
      */
     jobId?: string;
 }
-interface BulkCloneItemSetsResult {
+export interface BulkCloneItemSetsResult {
     /** Item metadata */
     itemMetadata?: ItemMetadata;
     /**
@@ -499,7 +500,7 @@ interface BulkCloneItemSetsResult {
      */
     clonedItemSetId?: string;
 }
-interface AllocateItemSetsRequest {
+export interface AllocateItemSetsRequest {
     /**
      * Number of sets to allocate
      * @min 1
@@ -507,14 +508,14 @@ interface AllocateItemSetsRequest {
      */
     numberOfSets?: number;
 }
-interface AllocateItemSetsResponse {
+export interface AllocateItemSetsResponse {
     /**
      * ID that is a shared reference between a benefit pool and a specific item.
      * @format GUID
      */
     itemSetIds?: string[];
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -557,19 +558,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+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.
@@ -577,14 +578,14 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -600,7 +601,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -625,7 +626,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -647,14 +648,49 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BulkCreateItemsOptions {
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @returns Created item.
+ * @fqn wix.benefit_programs.v1.item.ItemService.CreateItem
+ */
+export declare function createItem(item: NonNullablePaths<Item, `externalId` | `itemSetId` | `namespace` | `providerAppId`>): 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.BulkCreateItems
+ */
+export declare function bulkCreateItems(items: NonNullablePaths<Item, `externalId` | `itemSetId` | `namespace` | `providerAppId`>[], 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`>>;
+export interface BulkCreateItemsOptions {
     /**
      * Whether to return the full item entities.
      *
@@ -662,11 +698,92 @@ interface BulkCreateItemsOptions {
      */
     returnEntity?: boolean;
 }
-interface BulkDeleteItemsByFilterOptions {
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.DeleteItem
+ */
+export 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItems
+ */
+export 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`>>;
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItemsByFilter
+ */
+export declare function bulkDeleteItemsByFilter(namespace: string, options?: BulkDeleteItemsByFilterOptions): Promise<NonNullablePaths<BulkDeleteItemsByFilterResponse, `jobId`>>;
+export 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;
 }
-interface UpdateItem {
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @returns Updated item.
+ * @fqn wix.benefit_programs.v1.item.ItemService.UpdateItem
+ */
+export declare function updateItem(_id: string, item: NonNullablePaths<UpdateItem, `revision`>): Promise<Item>;
+export interface UpdateItem {
     /**
      * Benefit item ID.
      * @format GUID
@@ -741,7 +858,27 @@ interface UpdateItem {
      */
     namespace?: string | null;
 }
-interface BulkUpdateItemsOptions {
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.BulkUpdateItems
+ */
+export declare function bulkUpdateItems(options?: NonNullablePaths<BulkUpdateItemsOptions, `items.${number}.item` | `items.${number}.item._id` | `items.${number}.item.revision`>): 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`>>;
+export interface BulkUpdateItemsOptions {
     /**
      * Items to update.
      * @minSize 1
@@ -755,12 +892,70 @@ interface BulkUpdateItemsOptions {
      */
     returnEntity?: boolean;
 }
-interface ListItemsOptions {
+/**
+ * Retrieves a benefit item.
+ * @param itemId - ID of the item to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemId
+ * @permissionId BENEFIT_PROGRAMS.ITEM_READ
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @returns Retrieved item.
+ * @fqn wix.benefit_programs.v1.item.ItemService.GetItem
+ */
+export declare function getItem(itemId: string): Promise<Item>;
+/**
+ * Retrieves a list of up to 1000 benefit items.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.ITEM_READ
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.ListItems
+ */
+export declare function listItems(options?: ListItemsOptions): Promise<NonNullablePaths<ListItemsResponse, `items`>>;
+export 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId BENEFIT_PROGRAMS.ITEM_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.QueryItems
+ */
+export declare function queryItems(): ItemsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -768,13 +963,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface ItemsQueryResult extends QueryCursorResult {
+export interface ItemsQueryResult extends QueryCursorResult {
     items: Item[];
     query: ItemsQueryBuilder;
     next: () => Promise<ItemsQueryResult>;
     prev: () => Promise<ItemsQueryResult>;
 }
-interface ItemsQueryBuilder {
+export interface ItemsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -838,7 +1033,24 @@ interface ItemsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ItemsQueryResult>;
 }
-interface CountItemsOptions {
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.item.ItemService.CountItems
+ */
+export declare function countItems(options?: CountItemsOptions): Promise<NonNullablePaths<CountItemsResponse, `count`>>;
+export interface CountItemsOptions {
     /**
      * Items to count.
      *
@@ -846,5 +1058,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 {};