@wix/auto_sdk_benefit-programs_items 1.0.33 → 1.0.35

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

@@ -664,7 +664,6 @@ type CountItemsApplicationErrors = {
  * Creates a benefit item.
  * @param item - Item to create.
  * @public
- * @documentationMaturity preview
  * @requiredField item
  * @requiredField item.externalId
  * @requiredField item.itemSetId
@@ -680,7 +679,6 @@ declare function createItem(item: NonNullablePaths<Item, `externalId` | `itemSet
  * Creates benefit items.
  * @param items - Items to create.
  * @public
- * @documentationMaturity preview
  * @requiredField items
  * @requiredField items.externalId
  * @requiredField items.itemSetId
@@ -709,7 +707,6 @@ interface BulkCreateItemsOptions {
  * </blockquote>
  * @param itemId - Item ID.
  * @public
- * @documentationMaturity preview
  * @requiredField itemId
  * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
  * @applicableIdentity APP
@@ -726,7 +723,6 @@ declare function deleteItem(itemId: string): Promise<void>;
  * </blockquote>
  * @param itemIds - List of IDs of the items to delete.
  * @public
- * @documentationMaturity preview
  * @requiredField itemIds
  * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
  * @applicableIdentity APP
@@ -745,7 +741,6 @@ declare function bulkDeleteItems(itemIds: string[]): Promise<NonNullablePaths<Bu
  * </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
@@ -766,7 +761,6 @@ interface BulkDeleteItemsByFilterOptions {
  * and prevents unintended overwrites.
  * @param _id - Benefit item ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField item
  * @requiredField item.revision
@@ -860,7 +854,6 @@ interface UpdateItem {
  * 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
@@ -887,7 +880,6 @@ interface BulkUpdateItemsOptions {
  * Retrieves a benefit item.
  * @param itemId - ID of the item to retrieve.
  * @public
- * @documentationMaturity preview
  * @requiredField itemId
  * @permissionId BENEFIT_PROGRAMS.ITEM_READ
  * @applicableIdentity APP
@@ -898,7 +890,6 @@ 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
@@ -923,7 +914,6 @@ interface ListItemsOptions {
  *
  *  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
@@ -945,73 +935,59 @@ interface ItemsQueryResult extends QueryCursorResult {
 interface ItemsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     eq: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ne: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ge: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     gt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     le: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     lt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
      */
     startsWith: (propertyName: '_id' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: string) => ItemsQueryBuilder;
     /** @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' | 'itemSetId' | 'providerAppId' | 'namespace', value: any[]) => ItemsQueryBuilder;
-    /** @documentationMaturity preview */
     in: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
-    /** @documentationMaturity preview */
     exists: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: boolean) => ItemsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace'>) => ItemsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     descending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace'>) => ItemsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => ItemsQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
+    /** @param cursor - A pointer to specific record */
     skipTo: (cursor: string) => ItemsQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<ItemsQueryResult>;
 }
+/**
+ * @hidden
+ * @fqn wix.benefit_programs.v1.item.ItemService.QueryItems
+ * @requiredField query
+ */
+declare function typedQueryItems(query: CursorQuery): Promise<NonNullablePaths<QueryItemsResponse, `items`, 2>>;
 /**
  * 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
@@ -1028,4 +1004,4 @@ interface CountItemsOptions {
     filter?: Record<string, any> | null;
 }
 
-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 };
+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, typedQueryItems, updateItem };

package/build/internal/cjs/index.typings.js

@@ -33,6 +33,7 @@ __export(index_typings_exports, {
   getItem: () => getItem2,
   listItems: () => listItems2,
   queryItems: () => queryItems2,
+  typedQueryItems: () => typedQueryItems,
   updateItem: () => updateItem2
 });
 module.exports = __toCommonJS(index_typings_exports);
@@ -802,6 +803,29 @@ function queryItems2() {
     transformationPaths: {}
   });
 }
+async function typedQueryItems(query) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ query });
+  const reqOpts = queryItems(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { query: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["query"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function countItems2(options) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -842,6 +866,7 @@ async function countItems2(options) {
   getItem,
   listItems,
   queryItems,
+  typedQueryItems,
   updateItem
 });
 //# sourceMappingURL=index.typings.js.map