@wix/auto_sdk_benefit-programs_items 1.0.11 → 1.0.12

package/build/internal/index.d.mts

@@ -0,0 +1,149 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { I as Item, B as BulkCreateItemsOptions, a as BulkCreateItemsResponse, b as BulkDeleteItemsResponse, c as BulkDeleteItemsByFilterOptions, d as BulkDeleteItemsByFilterResponse, U as UpdateItem, e as BulkUpdateItemsOptions, f as BulkUpdateItemsResponse, L as ListItemsOptions, g as ListItemsResponse, h as ItemsQueryBuilder, C as CountItemsOptions, i as CountItemsResponse } from './benefit-programs-v1-item-items.universal-C7Ua6Gkb.mjs';
+export { ab as ActionEvent, a3 as AllocateItemSetsRequest, a4 as AllocateItemSetsResponse, A as ApplicationError, p as BulkActionMetadata, a0 as BulkCloneItemSetsRequest, a1 as BulkCloneItemSetsResponse, a2 as BulkCloneItemSetsResult, m as BulkCreateItemsRequest, s as BulkDeleteItemsByFilterRequest, r as BulkDeleteItemsRequest, n as BulkItemResult, v as BulkUpdateItemsRequest, y as ByItemSetIdAndReference, z as ByItemSetIdAndReferenceFilter, F as ByReference, H as ByReferenceFilter, _ as CloneItemsRequest, $ as CloneItemsResponse, Z as CountItemsRequest, k as CreateItemRequest, l as CreateItemResponse, N as CursorPaging, O as CursorPagingMetadata, R as CursorQuery, V as CursorQueryPagingMethodOneOf, P as Cursors, D as DeleteItemRequest, q as DeleteItemResponse, a5 as DomainEvent, a6 as DomainEventBodyOneOf, a7 as EntityCreatedEvent, aa as EntityDeletedEvent, a9 as EntityUpdatedEvent, E as ExtendedFields, J as Filter, K as FilterFilterOneOf, G as GetItemRequest, w as GetItemResponse, ad as IdentificationData, ae as IdentificationDataIdOneOf, o as ItemMetadata, j as ItemsCloned, af as ItemsQueryResult, x as ListItemsRequest, M as MaskedItem, ac as MessageEnvelope, Q as QueryItemsRequest, Y as QueryItemsResponse, a8 as RestoreInfo, S as SortOrder, X as Sorting, T as Type, t as UpdateItemRequest, u as UpdateItemResponse, W as WebhookIdentityType } from './benefit-programs-v1-item-items.universal-C7Ua6Gkb.mjs';
+
+declare function createItem$1(httpClient: HttpClient): CreateItemSignature;
+interface CreateItemSignature {
+    /**
+     * Creates a benefit item.
+     * @param - Item to create.
+     * @returns Created item.
+     */
+    (item: Item): Promise<Item>;
+}
+declare function bulkCreateItems$1(httpClient: HttpClient): BulkCreateItemsSignature;
+interface BulkCreateItemsSignature {
+    /**
+     * Creates benefit items.
+     * @param - Items to create.
+     */
+    (items: Item[], options?: BulkCreateItemsOptions | undefined): Promise<BulkCreateItemsResponse>;
+}
+declare function deleteItem$1(httpClient: HttpClient): DeleteItemSignature;
+interface DeleteItemSignature {
+    /**
+     * 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 - Item ID.
+     */
+    (itemId: string): Promise<void>;
+}
+declare function bulkDeleteItems$1(httpClient: HttpClient): BulkDeleteItemsSignature;
+interface BulkDeleteItemsSignature {
+    /**
+     * 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 - List of IDs of the items to delete.
+     */
+    (itemIds: string[]): Promise<BulkDeleteItemsResponse>;
+}
+declare function bulkDeleteItemsByFilter$1(httpClient: HttpClient): BulkDeleteItemsByFilterSignature;
+interface BulkDeleteItemsByFilterSignature {
+    /**
+     * 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 for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
+     */
+    (namespace: string, options?: BulkDeleteItemsByFilterOptions | undefined): Promise<BulkDeleteItemsByFilterResponse>;
+}
+declare function updateItem$1(httpClient: HttpClient): UpdateItemSignature;
+interface UpdateItemSignature {
+    /**
+     * 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 - Benefit item ID.
+     * @returns Updated item.
+     */
+    (_id: string, item: UpdateItem): Promise<Item>;
+}
+declare function bulkUpdateItems$1(httpClient: HttpClient): BulkUpdateItemsSignature;
+interface BulkUpdateItemsSignature {
+    /**
+     * 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.
+     */
+    (options?: BulkUpdateItemsOptions | undefined): Promise<BulkUpdateItemsResponse>;
+}
+declare function getItem$1(httpClient: HttpClient): GetItemSignature;
+interface GetItemSignature {
+    /**
+     * Retrieves a benefit item.
+     * @param - ID of the item to retrieve.
+     * @returns Retrieved item.
+     */
+    (itemId: string): Promise<Item>;
+}
+declare function listItems$1(httpClient: HttpClient): ListItemsSignature;
+interface ListItemsSignature {
+    /**
+     * Retrieves a list of up to 1000 benefit items.
+     */
+    (options?: ListItemsOptions | undefined): Promise<ListItemsResponse>;
+}
+declare function queryItems$1(httpClient: HttpClient): QueryItemsSignature;
+interface QueryItemsSignature {
+    /**
+     * 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`.
+     */
+    (): ItemsQueryBuilder;
+}
+declare function countItems$1(httpClient: HttpClient): CountItemsSignature;
+interface CountItemsSignature {
+    /**
+     * 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).
+     */
+    (options?: CountItemsOptions | undefined): Promise<CountItemsResponse>;
+}
+
+declare const createItem: MaybeContext<BuildRESTFunction<typeof createItem$1> & typeof createItem$1>;
+declare const bulkCreateItems: MaybeContext<BuildRESTFunction<typeof bulkCreateItems$1> & typeof bulkCreateItems$1>;
+declare const deleteItem: MaybeContext<BuildRESTFunction<typeof deleteItem$1> & typeof deleteItem$1>;
+declare const bulkDeleteItems: MaybeContext<BuildRESTFunction<typeof bulkDeleteItems$1> & typeof bulkDeleteItems$1>;
+declare const bulkDeleteItemsByFilter: MaybeContext<BuildRESTFunction<typeof bulkDeleteItemsByFilter$1> & typeof bulkDeleteItemsByFilter$1>;
+declare const updateItem: MaybeContext<BuildRESTFunction<typeof updateItem$1> & typeof updateItem$1>;
+declare const bulkUpdateItems: MaybeContext<BuildRESTFunction<typeof bulkUpdateItems$1> & typeof bulkUpdateItems$1>;
+declare const getItem: MaybeContext<BuildRESTFunction<typeof getItem$1> & typeof getItem$1>;
+declare const listItems: MaybeContext<BuildRESTFunction<typeof listItems$1> & typeof listItems$1>;
+declare const queryItems: MaybeContext<BuildRESTFunction<typeof queryItems$1> & typeof queryItems$1>;
+declare const countItems: MaybeContext<BuildRESTFunction<typeof countItems$1> & typeof countItems$1>;
+
+export { BulkCreateItemsOptions, BulkCreateItemsResponse, BulkDeleteItemsByFilterOptions, BulkDeleteItemsByFilterResponse, BulkDeleteItemsResponse, BulkUpdateItemsOptions, BulkUpdateItemsResponse, CountItemsOptions, CountItemsResponse, Item, ItemsQueryBuilder, ListItemsOptions, ListItemsResponse, UpdateItem, bulkCreateItems, bulkDeleteItems, bulkDeleteItemsByFilter, bulkUpdateItems, countItems, createItem, deleteItem, getItem, listItems, queryItems, updateItem };

package/build/internal/index.d.ts

@@ -0,0 +1,149 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { I as Item, B as BulkCreateItemsOptions, a as BulkCreateItemsResponse, b as BulkDeleteItemsResponse, c as BulkDeleteItemsByFilterOptions, d as BulkDeleteItemsByFilterResponse, U as UpdateItem, e as BulkUpdateItemsOptions, f as BulkUpdateItemsResponse, L as ListItemsOptions, g as ListItemsResponse, h as ItemsQueryBuilder, C as CountItemsOptions, i as CountItemsResponse } from './benefit-programs-v1-item-items.universal-C7Ua6Gkb.js';
+export { ab as ActionEvent, a3 as AllocateItemSetsRequest, a4 as AllocateItemSetsResponse, A as ApplicationError, p as BulkActionMetadata, a0 as BulkCloneItemSetsRequest, a1 as BulkCloneItemSetsResponse, a2 as BulkCloneItemSetsResult, m as BulkCreateItemsRequest, s as BulkDeleteItemsByFilterRequest, r as BulkDeleteItemsRequest, n as BulkItemResult, v as BulkUpdateItemsRequest, y as ByItemSetIdAndReference, z as ByItemSetIdAndReferenceFilter, F as ByReference, H as ByReferenceFilter, _ as CloneItemsRequest, $ as CloneItemsResponse, Z as CountItemsRequest, k as CreateItemRequest, l as CreateItemResponse, N as CursorPaging, O as CursorPagingMetadata, R as CursorQuery, V as CursorQueryPagingMethodOneOf, P as Cursors, D as DeleteItemRequest, q as DeleteItemResponse, a5 as DomainEvent, a6 as DomainEventBodyOneOf, a7 as EntityCreatedEvent, aa as EntityDeletedEvent, a9 as EntityUpdatedEvent, E as ExtendedFields, J as Filter, K as FilterFilterOneOf, G as GetItemRequest, w as GetItemResponse, ad as IdentificationData, ae as IdentificationDataIdOneOf, o as ItemMetadata, j as ItemsCloned, af as ItemsQueryResult, x as ListItemsRequest, M as MaskedItem, ac as MessageEnvelope, Q as QueryItemsRequest, Y as QueryItemsResponse, a8 as RestoreInfo, S as SortOrder, X as Sorting, T as Type, t as UpdateItemRequest, u as UpdateItemResponse, W as WebhookIdentityType } from './benefit-programs-v1-item-items.universal-C7Ua6Gkb.js';
+
+declare function createItem$1(httpClient: HttpClient): CreateItemSignature;
+interface CreateItemSignature {
+    /**
+     * Creates a benefit item.
+     * @param - Item to create.
+     * @returns Created item.
+     */
+    (item: Item): Promise<Item>;
+}
+declare function bulkCreateItems$1(httpClient: HttpClient): BulkCreateItemsSignature;
+interface BulkCreateItemsSignature {
+    /**
+     * Creates benefit items.
+     * @param - Items to create.
+     */
+    (items: Item[], options?: BulkCreateItemsOptions | undefined): Promise<BulkCreateItemsResponse>;
+}
+declare function deleteItem$1(httpClient: HttpClient): DeleteItemSignature;
+interface DeleteItemSignature {
+    /**
+     * 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 - Item ID.
+     */
+    (itemId: string): Promise<void>;
+}
+declare function bulkDeleteItems$1(httpClient: HttpClient): BulkDeleteItemsSignature;
+interface BulkDeleteItemsSignature {
+    /**
+     * 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 - List of IDs of the items to delete.
+     */
+    (itemIds: string[]): Promise<BulkDeleteItemsResponse>;
+}
+declare function bulkDeleteItemsByFilter$1(httpClient: HttpClient): BulkDeleteItemsByFilterSignature;
+interface BulkDeleteItemsByFilterSignature {
+    /**
+     * 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 for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
+     */
+    (namespace: string, options?: BulkDeleteItemsByFilterOptions | undefined): Promise<BulkDeleteItemsByFilterResponse>;
+}
+declare function updateItem$1(httpClient: HttpClient): UpdateItemSignature;
+interface UpdateItemSignature {
+    /**
+     * 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 - Benefit item ID.
+     * @returns Updated item.
+     */
+    (_id: string, item: UpdateItem): Promise<Item>;
+}
+declare function bulkUpdateItems$1(httpClient: HttpClient): BulkUpdateItemsSignature;
+interface BulkUpdateItemsSignature {
+    /**
+     * 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.
+     */
+    (options?: BulkUpdateItemsOptions | undefined): Promise<BulkUpdateItemsResponse>;
+}
+declare function getItem$1(httpClient: HttpClient): GetItemSignature;
+interface GetItemSignature {
+    /**
+     * Retrieves a benefit item.
+     * @param - ID of the item to retrieve.
+     * @returns Retrieved item.
+     */
+    (itemId: string): Promise<Item>;
+}
+declare function listItems$1(httpClient: HttpClient): ListItemsSignature;
+interface ListItemsSignature {
+    /**
+     * Retrieves a list of up to 1000 benefit items.
+     */
+    (options?: ListItemsOptions | undefined): Promise<ListItemsResponse>;
+}
+declare function queryItems$1(httpClient: HttpClient): QueryItemsSignature;
+interface QueryItemsSignature {
+    /**
+     * 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`.
+     */
+    (): ItemsQueryBuilder;
+}
+declare function countItems$1(httpClient: HttpClient): CountItemsSignature;
+interface CountItemsSignature {
+    /**
+     * 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).
+     */
+    (options?: CountItemsOptions | undefined): Promise<CountItemsResponse>;
+}
+
+declare const createItem: MaybeContext<BuildRESTFunction<typeof createItem$1> & typeof createItem$1>;
+declare const bulkCreateItems: MaybeContext<BuildRESTFunction<typeof bulkCreateItems$1> & typeof bulkCreateItems$1>;
+declare const deleteItem: MaybeContext<BuildRESTFunction<typeof deleteItem$1> & typeof deleteItem$1>;
+declare const bulkDeleteItems: MaybeContext<BuildRESTFunction<typeof bulkDeleteItems$1> & typeof bulkDeleteItems$1>;
+declare const bulkDeleteItemsByFilter: MaybeContext<BuildRESTFunction<typeof bulkDeleteItemsByFilter$1> & typeof bulkDeleteItemsByFilter$1>;
+declare const updateItem: MaybeContext<BuildRESTFunction<typeof updateItem$1> & typeof updateItem$1>;
+declare const bulkUpdateItems: MaybeContext<BuildRESTFunction<typeof bulkUpdateItems$1> & typeof bulkUpdateItems$1>;
+declare const getItem: MaybeContext<BuildRESTFunction<typeof getItem$1> & typeof getItem$1>;
+declare const listItems: MaybeContext<BuildRESTFunction<typeof listItems$1> & typeof listItems$1>;
+declare const queryItems: MaybeContext<BuildRESTFunction<typeof queryItems$1> & typeof queryItems$1>;
+declare const countItems: MaybeContext<BuildRESTFunction<typeof countItems$1> & typeof countItems$1>;
+
+export { BulkCreateItemsOptions, BulkCreateItemsResponse, BulkDeleteItemsByFilterOptions, BulkDeleteItemsByFilterResponse, BulkDeleteItemsResponse, BulkUpdateItemsOptions, BulkUpdateItemsResponse, CountItemsOptions, CountItemsResponse, Item, ItemsQueryBuilder, ListItemsOptions, ListItemsResponse, UpdateItem, bulkCreateItems, bulkDeleteItems, bulkDeleteItemsByFilter, bulkUpdateItems, countItems, createItem, deleteItem, getItem, listItems, queryItems, updateItem };