@wix/auto_sdk_benefit-programs_pool-definition-items 1.0.9 → 1.0.11

package/build/cjs/index.typings.d.ts

@@ -1,17 +1,15 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 interface PoolDefinitionItem {
     /**
-     * Benefit item ID.
+     * Benefit item ID. Deterministically generated from pool_definition_id and item_id — if you know both, you can compute the ID without querying.
      * @format GUID
      * @readonly
      */
     _id?: string;
     /**
      * Revision number, which increments by 1 each time the benefit item is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the item.
-     *
-     * Ignored when creating an item.
      * @readonly
      */
     revision?: string | null;
@@ -28,7 +26,7 @@ interface PoolDefinitionItem {
     /**
      * External item ID assigned by the provider of the items.
      *
-     * For example, if the benefit items are products, this ID corresponds to the specific product ID in the supplier's system.
+     * For example, if the benefit items are products, this ID corresponds to the specific product ID in the provider's system.
      * @format GUID
      * @immutable
      * @readonly
@@ -42,18 +40,15 @@ interface PoolDefinitionItem {
      */
     category?: string;
     /**
-     * ID of the application providing the benefit item.
-     *
-     * ID of the external application supplying the items. Each item's external ID is unique to its respective provider's application.
+     * ID of the application providing the benefit items. Each item's external_id is unique within its provider application.
      * @format GUID
      * @immutable
      * @readonly
      */
     providerAppId?: string;
     /**
-     * Module name of the item provider's application that originated the items.
-     *
-     * For example, `store-inventory` or `fitness-resources`.
+     * 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
      * @maxLength 20
      * @immutable
@@ -61,26 +56,51 @@ interface PoolDefinitionItem {
      */
     namespace?: string;
     /**
-     * Pool definition id
+     * ID of the pool definition - the configuration that defines a set of benefits and which items are accessible within each benefit.
      * @format GUID
      * @immutable
      * @readonly
      */
     poolDefinitionId?: string;
     /**
-     * Item set ID.
+     * Internal grouping identifier for this benefit's item set. Use pool_definition_id together with benefit_key
+     * to identify a benefit — item_set_id is an implementation detail.
      * @format GUID
      * @immutable
      * @readonly
      */
     itemSetId?: string;
     /**
-     * Item set ID.
+     * Pool definition details including display name, description, and credit settings. Only populated when
+     * POOL_DEFINITION is included in the fields request parameter.
+     * @readonly
+     */
+    poolDefinition?: PoolDefinitionInfo;
+    /**
+     * Program definitions that include this item as an accessible benefit. Only id and external_id are
+     * returned by default; request PROGRAM_DEFINITION to include display_name and description.
+     * @maxSize 20
+     * @readonly
+     */
+    programDefinitions?: ProgramDefinitionInfo[];
+    /**
+     * Item ID.
      * @format GUID
      * @immutable
      * @readonly
      */
     itemId?: string;
+    /**
+     * Pricing and display information for the associated benefit, including credit price, name, and description.
+     * Only populated when BENEFIT is included in the fields request parameter.
+     * @readonly
+     */
+    benefitInfo?: BenefitInfo;
+    /**
+     * Display name for the catalog item. Only populated when ITEM is included in the fields request parameter.
+     * @readonly
+     */
+    itemInfo?: ItemInfo;
     /**
      * Unique identifier for the benefit associated with this item.
      * @maxLength 64
@@ -88,6 +108,14 @@ interface PoolDefinitionItem {
      * @readonly
      */
     benefitKey?: string;
+    /**
+     * Pre-computed search key for the item reference, built by concatenating provider_app_id, category, and external_id
+     * separated by /. Use this field for efficient single-field filtering instead of composing three separate conditions.
+     * @maxLength 94
+     * @immutable
+     * @readonly
+     */
+    itemReferenceSearchKey?: string;
 }
 interface PoolDefinitionInfo {
     /**
@@ -100,16 +128,12 @@ interface PoolDefinitionInfo {
      * @maxLength 450
      */
     description?: string | null;
-    /**
-     * Credit settings.
-     *
-     * If this object is empty, you can't set a price for the benefit.
-     */
+    /** Credit configuration for this pool definition. When absent, benefits in this pool do not support credit-based pricing. */
     creditConfiguration?: CreditConfiguration;
 }
 interface CreditConfiguration {
     /**
-     * Initial available amount for associated balances.
+     * Number of credits initially granted to a subscriber when this pool definition's benefits are activated.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -118,6 +142,11 @@ interface CreditConfiguration {
      * @maxLength 32
      */
     unitDisplayName?: string | null;
+    /**
+     * Credit unit type.
+     * @maxLength 16
+     */
+    unitType?: string | null;
 }
 interface ProgramDefinitionInfo {
     /**
@@ -165,10 +194,15 @@ interface ItemInfo {
      */
     displayName?: string | null;
 }
+/** Deprecated: use PoolDefinitionItemRemoved instead. Will be removed after clients are migrated. */
 interface PoolDefinitionItemDeactivated {
     /** The pool definition item that was deactivated. */
     poolDefinitionItem?: PoolDefinitionItem;
 }
+interface PoolDefinitionItemRemoved {
+    /** The pool definition item that was removed from the benefit. */
+    poolDefinitionItem?: PoolDefinitionItem;
+}
 interface QueryPoolDefinitionItemsRequest {
     /** Query to select benefit items. */
     query?: CursorQuery;
@@ -233,9 +267,13 @@ interface CursorPaging {
     cursor?: string | null;
 }
 declare enum RequestedFields {
+    /** Populates the pool_definition field with display name, description, and credit configuration. */
     POOL_DEFINITION = "POOL_DEFINITION",
+    /** Populates the program_definitions field with display_name and description. */
     PROGRAM_DEFINITION = "PROGRAM_DEFINITION",
+    /** Populates the benefit_info field with credit price, name, and description. */
     BENEFIT = "BENEFIT",
+    /** Populates the item_info field with the catalog item's display name. */
     ITEM = "ITEM"
 }
 /** @enumType */
@@ -317,6 +355,47 @@ interface ItemReference {
     category?: string;
 }
 interface RemoveItemsFromBenefitResponse {
+    /**
+     * Per-item results aligned 1:1 with `item_references` from the request — `item_metadata.original_index` always
+     * refers to the position in the request. Item references that did not match any registered item appear here as
+     * failures with `item_metadata.error.code` set to `NOT_FOUND`.
+     */
+    results?: BulkRemoveItemResult[];
+    /** Aggregate counts (successes, failures) for the bulk operation. Unresolved item references are counted as failures. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkRemoveItemResult {
+    /** Outcome metadata for a single item — includes the underlying item ID, success flag, and error details on failure. */
+    itemMetadata?: ItemMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    _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;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+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;
 }
 interface AddItemsToBenefitRequest {
     /**
@@ -337,6 +416,17 @@ interface AddItemsToBenefitRequest {
     benefitKey: string;
 }
 interface AddItemsToBenefitResponse {
+    /** Per-item results — `item_metadata.original_index` corresponds to the order of `item_references` in the request. */
+    results?: BulkAddItemResult[];
+    /** Aggregate counts (successes, failures) for the bulk operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkAddItemResult {
+    /**
+     * Outcome metadata for the catalog item created in the underlying item service. The item ID here is the Item entity
+     * ID — PoolDefinitionItem records are created asynchronously and their IDs are not returned in this response.
+     */
+    itemMetadata?: ItemMetadata;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -491,8 +581,208 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
+/** @docsIgnore */
+type RemoveItemsFromBenefitApplicationErrors = {
+    code?: 'POOL_DEFINITION_BENEFIT_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type AddItemsToBenefitApplicationErrors = {
+    code?: 'POOL_DEFINITION_BENEFIT_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Creates a query to retrieve a list of poolDefinitionItems.
+ *
+ * The `queryPoolDefinitionItems()` method builds a query to retrieve a list of poolDefinitionItems and returns a `PoolDefinitionItemsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/poolDefinitionItems/poolDefinitionItems-query-builder/find) function.
+ *
+ * You can refine the query by chaining `PoolDefinitionItemsQueryBuilder` methods onto the query. `PoolDefinitionItemsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPoolDefinitionItems()` returns.
+ *
+ * The following `PoolDefinitionItemsQueryBuilder` functions are supported for `queryPoolDefinitionItems()`. For a full description of the item object, see the object returned for the [`poolDefinitionItems`](/poolDefinitionItems/poolDefinitionItems-query-result/poolDefinitionItems) property in `PoolDefinitionItemsQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId benefit_programs:v1:pool_definition_item:query_pool_definition_items
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.QueryPoolDefinitionItems
+ */
+declare function queryPoolDefinitionItems(options?: QueryPoolDefinitionItemsOptions): PoolDefinitionItemsQueryBuilder;
+interface QueryPoolDefinitionItemsOptions {
+    /**
+     * Fields to be included in the response.
+     * @maxSize 4
+     */
+    fields?: RequestedFieldsWithLiterals[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface PoolDefinitionItemsQueryResult extends QueryCursorResult {
+    items: PoolDefinitionItem[];
+    query: PoolDefinitionItemsQueryBuilder;
+    next: () => Promise<PoolDefinitionItemsQueryResult>;
+    prev: () => Promise<PoolDefinitionItemsQueryResult>;
+}
+interface PoolDefinitionItemsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: string) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: any[]) => PoolDefinitionItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: any) => PoolDefinitionItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey', value: boolean) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey'>) => PoolDefinitionItemsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemReferenceSearchKey'>) => PoolDefinitionItemsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => PoolDefinitionItemsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => PoolDefinitionItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<PoolDefinitionItemsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.QueryPoolDefinitionItems
+ * @requiredField query
+ */
+declare function typedQueryPoolDefinitionItems(query: PoolDefinitionItemQuery, options?: QueryPoolDefinitionItemsOptions): Promise<NonNullablePaths<QueryPoolDefinitionItemsResponse, `poolDefinitionItems` | `poolDefinitionItems.${number}._id` | `poolDefinitionItems.${number}.externalId` | `poolDefinitionItems.${number}.category` | `poolDefinitionItems.${number}.providerAppId` | `poolDefinitionItems.${number}.namespace` | `poolDefinitionItems.${number}.poolDefinitionId` | `poolDefinitionItems.${number}.itemSetId` | `poolDefinitionItems.${number}.poolDefinition.displayName` | `poolDefinitionItems.${number}.poolDefinition.creditConfiguration.amount` | `poolDefinitionItems.${number}.itemId` | `poolDefinitionItems.${number}.benefitKey` | `poolDefinitionItems.${number}.itemReferenceSearchKey`, 6>>;
+interface PoolDefinitionItemQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['programDefinitions._id', 'programDefinitions.externalId'];
+            operators: ['$hasAll', '$hasSome'];
+            sort: 'BOTH';
+        },
+        {
+            fields: [
+                '_createdDate',
+                '_id',
+                'benefitKey',
+                'category',
+                'externalId',
+                'itemReferenceSearchKey',
+                'itemSetId',
+                'namespace',
+                'poolDefinitionId',
+                'providerAppId'
+            ];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<PoolDefinitionItem, PoolDefinitionItemQuerySpec>;
+type PoolDefinitionItemQuery = {
+    /**
+    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?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 1000
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | 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?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    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?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object in the following format:
+    `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<PoolDefinitionItem, PoolDefinitionItemQuerySpec, PoolDefinitionItemQuery>;
+        Filter: _wix_sdk_types.FilterFactory<PoolDefinitionItem, PoolDefinitionItemQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<PoolDefinitionItemQuerySpec>;
+    };
+};
 /**
- * Removes items from a benefit's item set, resolved by pool definition ID and benefit key.
+ * Removes items from a benefit. Items are removed asynchronously — they may briefly still appear in
+ * QueryPoolDefinitionItems results after the call returns.
+ * Item references not matching any registered item appear in results as per-item failures with `item_metadata.error.code` set to `NOT_FOUND`.
  * @param itemReferences - Items to remove from the benefit's item set.
  * @public
  * @documentationMaturity preview
@@ -505,7 +795,9 @@ interface AccountInfo {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.RemoveItemsFromBenefit
  */
-declare function removeItemsFromBenefit(itemReferences: NonNullablePaths<ItemReference, `externalId`, 2>[], options: NonNullablePaths<RemoveItemsFromBenefitOptions, `benefitKey` | `poolDefinitionId`, 2>): Promise<void>;
+declare function removeItemsFromBenefit(itemReferences: NonNullablePaths<ItemReference, `externalId`, 2>[], options: NonNullablePaths<RemoveItemsFromBenefitOptions, `benefitKey` | `poolDefinitionId`, 2>): Promise<NonNullablePaths<RemoveItemsFromBenefitResponse, `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> & {
+    __applicationErrorsType?: RemoveItemsFromBenefitApplicationErrors;
+}>;
 interface RemoveItemsFromBenefitOptions {
     /**
      * ID of the pool definition associated with the benefit.
@@ -519,7 +811,10 @@ interface RemoveItemsFromBenefitOptions {
     benefitKey: string;
 }
 /**
- * Adds items to a benefit's item set, resolved by pool definition ID and benefit key.
+ * Registers items with a benefit. This is an eventually consistent operation — items may take a short time to appear
+ * in QueryPoolDefinitionItems results after the call returns. Uses a partial success model — items already registered
+ * with the benefit return a per-item error in results.item_metadata while successfully added items are unaffected.
+ * Check bulk_action_metadata for overall counts and results for per-item outcomes.
  * @param itemReferences - Items to add to the benefit's item set.
  * @public
  * @documentationMaturity preview
@@ -532,7 +827,9 @@ interface RemoveItemsFromBenefitOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.AddItemsToBenefit
  */
-declare function addItemsToBenefit(itemReferences: NonNullablePaths<ItemReference, `externalId`, 2>[], options: NonNullablePaths<AddItemsToBenefitOptions, `benefitKey` | `poolDefinitionId`, 2>): Promise<void>;
+declare function addItemsToBenefit(itemReferences: NonNullablePaths<ItemReference, `externalId`, 2>[], options: NonNullablePaths<AddItemsToBenefitOptions, `benefitKey` | `poolDefinitionId`, 2>): Promise<NonNullablePaths<AddItemsToBenefitResponse, `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> & {
+    __applicationErrorsType?: AddItemsToBenefitApplicationErrors;
+}>;
 interface AddItemsToBenefitOptions {
     /**
      * ID of the pool definition associated with the benefit.
@@ -546,4 +843,4 @@ interface AddItemsToBenefitOptions {
     benefitKey: string;
 }
 
-export { type AccountInfo, type ActionEvent, type AddItemsToBenefitOptions, type AddItemsToBenefitRequest, type AddItemsToBenefitResponse, type BenefitInfo, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type IdentificationData, type IdentificationDataIdOneOf, type InvalidatePoolDefinitionItemsRequest, type InvalidatePoolDefinitionItemsResponse, type ItemInfo, type ItemReference, type MessageEnvelope, type PoolDefinitionInfo, type PoolDefinitionItem, type PoolDefinitionItemDeactivated, type ProgramDefinitionInfo, type QueryPoolDefinitionItemsRequest, type QueryPoolDefinitionItemsResponse, type RemoveItemsFromBenefitOptions, type RemoveItemsFromBenefitRequest, type RemoveItemsFromBenefitResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addItemsToBenefit, removeItemsFromBenefit };
+export { type AccountInfo, type ActionEvent, type AddItemsToBenefitApplicationErrors, type AddItemsToBenefitOptions, type AddItemsToBenefitRequest, type AddItemsToBenefitResponse, type ApplicationError, type BenefitInfo, type BulkActionMetadata, type BulkAddItemResult, type BulkRemoveItemResult, type CommonQueryWithEntityContext, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type IdentificationData, type IdentificationDataIdOneOf, type InvalidatePoolDefinitionItemsRequest, type InvalidatePoolDefinitionItemsResponse, type ItemInfo, type ItemMetadata, type ItemReference, type MessageEnvelope, type PoolDefinitionInfo, type PoolDefinitionItem, type PoolDefinitionItemDeactivated, type PoolDefinitionItemQuery, type PoolDefinitionItemQuerySpec, type PoolDefinitionItemRemoved, type PoolDefinitionItemsQueryBuilder, type PoolDefinitionItemsQueryResult, type ProgramDefinitionInfo, type QueryPoolDefinitionItemsOptions, type QueryPoolDefinitionItemsRequest, type QueryPoolDefinitionItemsResponse, type RemoveItemsFromBenefitApplicationErrors, type RemoveItemsFromBenefitOptions, type RemoveItemsFromBenefitRequest, type RemoveItemsFromBenefitResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addItemsToBenefit, queryPoolDefinitionItems, removeItemsFromBenefit, typedQueryPoolDefinitionItems, utils };