@wix/auto_sdk_benefit-programs_items 1.0.2 → 1.0.4

package/build/es/src/benefit-programs-v1-item-items.types.d.ts

@@ -1,12 +1,12 @@
 export interface Item {
     /**
-     * Benefit item ID.
+     * Item ID.
      * @format GUID
      * @readonly
      */
     id?: string | null;
     /**
-     * Revision number, which increments by 1 each time the benefit item is updated.
+     * Revision number, which increments by 1 each time the item is updated.
      * To prevent conflicting changes, the current revision must be passed when updating the item.
      *
      * Ignored when creating an item.
@@ -24,36 +24,30 @@ export interface Item {
      */
     updatedDate?: Date | null;
     /**
-     * External item ID assigned by the provider of the items.
+     * ID of the item in the app providing it.
      *
-     * 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 item is a product provided by Wix Stores, this would be the product ID.
      * @format GUID
      */
     externalId?: string;
     /**
-     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * Item category.
      * @maxLength 20
      */
     category?: string | null;
     /**
-     * ID that is a shared reference between a benefit pool and a specific item.
-     *
-     * This ID is returned when calling the Create Pool Definition method in the Pool Definitions API.
-     *
-     * It is used to link the specific benefit item to its corresponding location within the benefit pool.
+     * Item set ID of the benefit that this item is a part of.
      * @format GUID
      * @immutable
      */
     itemSetId?: string;
     /**
-     * Display name of the item. For example, a concert ticket or an exercise session with a personal trainer.
+     * Item name.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * 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 app that defines and provides the item. For example, if the item is a Wix Stores product, this field's value is `215238eb-22a5-4c36-9e7b-e7c08025e04e`.
      * @format GUID
      * @immutable
      */
@@ -64,9 +58,7 @@ export interface Item {
      */
     extendedFields?: ExtendedFields;
     /**
-     * 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.
      * @minLength 1
      * @maxLength 50
      * @immutable
@@ -101,7 +93,7 @@ export interface CreateItemResponse {
 }
 export interface BulkCreateItemsRequest {
     /**
-     * Items to be created.
+     * Items to create.
      * @minSize 1
      * @maxSize 100
      */
@@ -115,9 +107,7 @@ export interface BulkCreateItemsRequest {
 }
 export interface BulkCreateItemsResponse {
     /**
-     * List of results for each item.
-     *
-     * Includes the item and whether the operation was successful.
+     * List of created items and associated metadata.
      * @minSize 1
      * @maxSize 100
      */
@@ -171,7 +161,7 @@ export interface DeleteItemResponse {
 }
 export interface BulkDeleteItemsRequest {
     /**
-     * ID of the items to delete.
+     * List of IDs of the items to delete.
      * @minSize 1
      * @maxSize 100
      * @format GUID
@@ -180,9 +170,7 @@ export interface BulkDeleteItemsRequest {
 }
 export interface BulkDeleteItemsResponse {
     /**
-     * List of results for each item.
-     *
-     * Includes the item and whether the deletion was successful.
+     * List of deleted items and associated metadata.
      * @minSize 1
      * @maxSize 100
      */
@@ -192,25 +180,23 @@ export interface BulkDeleteItemsResponse {
 }
 export interface BulkDeleteItemsByFilterRequest {
     /**
-     * Sub-module name of the item provider's application that originated the items.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
-    /** Filter options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
+    /** 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;
 }
 export interface BulkDeleteItemsByFilterResponse {
     /**
-     * Job ID. Use the Async Job API to retrieve bulk delete results.
-     *
-     * Specify this job ID in the Get Async Job method to retrieve job details and metadata.
+     * Job ID for item deletion.
      * @format GUID
      */
     jobId?: string;
 }
 export interface UpdateItemRequest {
-    /** Item to be updated. */
+    /** Item to update. */
     item: Item;
 }
 export interface UpdateItemResponse {
@@ -239,7 +225,7 @@ export interface MaskedItem {
 }
 export interface BulkUpdateItemsResponse {
     /**
-     * Items that were updated.
+     * List of updated items and associated metadata.
      * @minSize 1
      * @maxSize 100
      */
@@ -267,20 +253,9 @@ export interface ListItemsRequest {
 export declare enum Type {
     /** Unknown filter type. */
     UNKNOWN_FILTER = "UNKNOWN_FILTER",
-    /**
-     * Filter the list by `itemSetId` and a reference to the item.
-     *
-     * Retrieve a list of a benefit item in a specific benefit pool.
-     *
-     * The items must be referenced by their `providerAppId`.
-     * The `externalId` can be included for additional specificity of an item, but can only be used with its corresponding `providerAppId`.
-     */
+    /** Use with `filter.byItemSetIdAndReferenceOptions`. */
     BY_ITEM_SET_ID_AND_REFERENCE = "BY_ITEM_SET_ID_AND_REFERENCE",
-    /**
-     * Filter the list by reference to the item.
-     *
-     * Retrieve a list of a benefit item in all benefit pools.
-     */
+    /** Use with `filter.byReferenceOptions`. */
     BY_REFERENCE = "BY_REFERENCE"
 }
 export interface ByItemSetIdAndReference {
@@ -293,22 +268,22 @@ export interface ByItemSetIdAndReference {
 }
 export interface ByItemSetIdAndReferenceFilter {
     /**
-     * ID that is a shared reference between a benefit pool and a specific item.
+     * ID set ID.
      * @format GUID
      */
     itemSetId?: string;
     /**
-     * External item ID assigned by the provider of the items.
+     * External item ID.
      * @format GUID
      */
     externalId?: string;
     /**
-     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * Item category.
      * @maxLength 20
      */
     category?: string;
     /**
-     * ID of the external application supplying the items.
+     * *Required**. ID of the app providing the item.
      * @format GUID
      */
     providerAppId?: string;
@@ -323,41 +298,30 @@ export interface ByReference {
 }
 export interface ByReferenceFilter {
     /**
-     * External item ID assigned by the provider of the items.
+     * External item ID.
      * @format GUID
      */
     externalId?: string;
     /**
-     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * Item category.
      * @maxLength 20
      */
     category?: string;
     /**
-     * ID of the external application supplying the items.
+     * *Required**. ID of the app providing the item.
      * @format GUID
      */
     providerAppId?: string;
 }
 export interface Filter extends FilterFilterOneOf {
-    /**
-     * Filter the list by `itemSetId` and a reference to the item.
-     *
-     * Retrieve a list of benefit items in a specific benefit pool.
-     *
-     * The items must be referenced by their `providerAppId`.
-     * The `externalId` can be included for additional specificity of an item, but can only be used with its corresponding `providerAppId`.
-     */
+    /** Filter the request by `itemSetId` and item reference. */
     byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
-    /**
-     * Filter the list by reference to the item.
-     *
-     * Retrieve a list of a benefit item in all benefit pools.
-     */
+    /** Filter the request item reference. */
     byReferenceOptions?: ByReference;
     /** Filter type. */
     type?: Type;
     /**
-     * Filter items by the item's namespace.
+     * Filter by namespace.
      * @minLength 1
      * @maxLength 50
      */
@@ -365,25 +329,14 @@ export interface Filter extends FilterFilterOneOf {
 }
 /** @oneof */
 export interface FilterFilterOneOf {
-    /**
-     * Filter the list by `itemSetId` and a reference to the item.
-     *
-     * Retrieve a list of benefit items in a specific benefit pool.
-     *
-     * The items must be referenced by their `providerAppId`.
-     * The `externalId` can be included for additional specificity of an item, but can only be used with its corresponding `providerAppId`.
-     */
+    /** Filter the request by `itemSetId` and item reference. */
     byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
-    /**
-     * Filter the list by reference to the item.
-     *
-     * Retrieve a list of a benefit item in all benefit pools.
-     */
+    /** Filter the request item reference. */
     byReferenceOptions?: ByReference;
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 1000
      */
     limit?: number | null;
@@ -428,7 +381,7 @@ export interface Cursors {
     prev?: string | null;
 }
 export interface QueryItemsRequest {
-    /** Query to select benefit items. */
+    /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -457,7 +410,7 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
@@ -469,7 +422,7 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface QueryItemsResponse {
-    /** List of items. */
+    /** List of retrieved items. */
     items?: Item[];
     /** Metadata for paginated results. */
     metadata?: CursorPagingMetadata;
@@ -483,7 +436,7 @@ export interface CountItemsRequest {
     filter?: Record<string, any> | null;
 }
 export interface CountItemsResponse {
-    /** Number of items. */
+    /** Number of items fulfilling the specified filter conditions. */
     count?: number;
 }
 export interface CloneItemsRequest {

package/build/es/src/benefit-programs-v1-item-items.types.js

@@ -2,20 +2,9 @@ export var Type;
 (function (Type) {
     /** Unknown filter type. */
     Type["UNKNOWN_FILTER"] = "UNKNOWN_FILTER";
-    /**
-     * Filter the list by `itemSetId` and a reference to the item.
-     *
-     * Retrieve a list of a benefit item in a specific benefit pool.
-     *
-     * The items must be referenced by their `providerAppId`.
-     * The `externalId` can be included for additional specificity of an item, but can only be used with its corresponding `providerAppId`.
-     */
+    /** Use with `filter.byItemSetIdAndReferenceOptions`. */
     Type["BY_ITEM_SET_ID_AND_REFERENCE"] = "BY_ITEM_SET_ID_AND_REFERENCE";
-    /**
-     * Filter the list by reference to the item.
-     *
-     * Retrieve a list of a benefit item in all benefit pools.
-     */
+    /** Use with `filter.byReferenceOptions`. */
     Type["BY_REFERENCE"] = "BY_REFERENCE";
 })(Type || (Type = {}));
 export var SortOrder;

package/build/es/src/benefit-programs-v1-item-items.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-item-items.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-item-items.types.ts"],"names":[],"mappings":"AAkSA,MAAM,CAAN,IAAY,IAkBX;AAlBD,WAAY,IAAI;IACd,2BAA2B;IAC3B,yCAAiC,CAAA;IACjC;;;;;;;OAOG;IACH,qEAA6D,CAAA;IAC7D;;;;OAIG;IACH,qCAA6B,CAAA;AAC/B,CAAC,EAlBW,IAAI,KAAJ,IAAI,QAkBf;AAqMD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAkPD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"benefit-programs-v1-item-items.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-item-items.types.ts"],"names":[],"mappings":"AAoRA,MAAM,CAAN,IAAY,IAOX;AAPD,WAAY,IAAI;IACd,2BAA2B;IAC3B,yCAAiC,CAAA;IACjC,wDAAwD;IACxD,qEAA6D,CAAA;IAC7D,4CAA4C;IAC5C,qCAA6B,CAAA;AAC/B,CAAC,EAPW,IAAI,KAAJ,IAAI,QAOf;AA+KD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAkPD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}