@wix/auto_sdk_benefit-programs_items 1.0.0 → 1.0.2

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

@@ -1,6 +1,7 @@
 export interface Item {
     /**
      * Benefit item ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -26,9 +27,13 @@ export interface Item {
      * 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.
+     * @format GUID
      */
     externalId?: string;
-    /** Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups. */
+    /**
+     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * @maxLength 20
+     */
     category?: string | null;
     /**
      * ID that is a shared reference between a benefit pool and a specific item.
@@ -36,14 +41,21 @@ export interface 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.
+     * @format GUID
+     * @immutable
      */
     itemSetId?: string;
-    /** Display name of the item. For example, a concert ticket or an exercise session with a personal trainer. */
+    /**
+     * Display name of the item. For example, a concert ticket or an exercise session with a personal trainer.
+     * @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.
+     * @format GUID
+     * @immutable
      */
     providerAppId?: string | null;
     /**
@@ -55,6 +67,9 @@ export interface Item {
      * Module name of the item provider's application that originated the items.
      *
      * For example, `store-inventory` or `fitness-resources`.
+     * @minLength 1
+     * @maxLength 50
+     * @immutable
      */
     namespace?: string | null;
 }
@@ -70,7 +85,10 @@ export interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 export interface ItemsCloned {
-    /** ID of the pool that had its items provisioned */
+    /**
+     * ID of the pool that had its items provisioned
+     * @format GUID
+     */
     itemSetId?: string;
 }
 export interface CreateItemRequest {
@@ -82,7 +100,11 @@ export interface CreateItemResponse {
     item?: Item;
 }
 export interface BulkCreateItemsRequest {
-    /** Items to be created. */
+    /**
+     * Items to be created.
+     * @minSize 1
+     * @maxSize 100
+     */
     items: Item[];
     /**
      * Whether to return the full item entities.
@@ -96,6 +118,8 @@ export interface BulkCreateItemsResponse {
      * List of results for each item.
      *
      * Includes the item and whether the operation was successful.
+     * @minSize 1
+     * @maxSize 100
      */
     results?: BulkItemResult[];
     /** Bulk action metadata. */
@@ -108,7 +132,10 @@ export interface BulkItemResult {
     item?: Item;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * 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;
@@ -134,13 +161,21 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface DeleteItemRequest {
-    /** Item ID. */
+    /**
+     * Item ID.
+     * @format GUID
+     */
     itemId: string;
 }
 export interface DeleteItemResponse {
 }
 export interface BulkDeleteItemsRequest {
-    /** ID of the items to delete. */
+    /**
+     * ID of the items to delete.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
     itemIds: string[];
 }
 export interface BulkDeleteItemsResponse {
@@ -148,13 +183,19 @@ export interface BulkDeleteItemsResponse {
      * List of results for each item.
      *
      * Includes the item and whether the deletion was successful.
+     * @minSize 1
+     * @maxSize 100
      */
     results?: BulkItemResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface BulkDeleteItemsByFilterRequest {
-    /** Sub-module name of the item provider's application that originated the items. */
+    /**
+     * Sub-module name of the item provider's application that originated the items.
+     * @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?: Record<string, any> | null;
@@ -164,6 +205,7 @@ 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.
+     * @format GUID
      */
     jobId?: string;
 }
@@ -176,7 +218,11 @@ export interface UpdateItemResponse {
     item?: Item;
 }
 export interface BulkUpdateItemsRequest {
-    /** Items to update. */
+    /**
+     * Items to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     items?: MaskedItem[];
     /**
      * Whether to return the full item entities.
@@ -192,13 +238,20 @@ export interface MaskedItem {
     fieldMask?: string[];
 }
 export interface BulkUpdateItemsResponse {
-    /** Items that were updated. */
+    /**
+     * Items that were updated.
+     * @minSize 1
+     * @maxSize 100
+     */
     results?: BulkItemResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface GetItemRequest {
-    /** ID of the item to retrieve. */
+    /**
+     * ID of the item to retrieve.
+     * @format GUID
+     */
     itemId: string;
 }
 export interface GetItemResponse {
@@ -231,29 +284,58 @@ export declare enum Type {
     BY_REFERENCE = "BY_REFERENCE"
 }
 export interface ByItemSetIdAndReference {
-    /** Filter list. */
+    /**
+     * Filter list.
+     * @minSize 1
+     * @maxSize 100
+     */
     filters?: ByItemSetIdAndReferenceFilter[];
 }
 export interface ByItemSetIdAndReferenceFilter {
-    /** ID that is a shared reference between a benefit pool and a specific item. */
+    /**
+     * ID that is a shared reference between a benefit pool and a specific item.
+     * @format GUID
+     */
     itemSetId?: string;
-    /** External item ID assigned by the provider of the items. */
+    /**
+     * External item ID assigned by the provider of the items.
+     * @format GUID
+     */
     externalId?: string;
-    /** Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups. */
+    /**
+     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * @maxLength 20
+     */
     category?: string;
-    /** ID of the external application supplying the items. */
+    /**
+     * ID of the external application supplying the items.
+     * @format GUID
+     */
     providerAppId?: string;
 }
 export interface ByReference {
-    /** Filter list. */
+    /**
+     * Filter list.
+     * @minSize 1
+     * @maxSize 100
+     */
     filters?: ByReferenceFilter[];
 }
 export interface ByReferenceFilter {
-    /** External item ID assigned by the provider of the items. */
+    /**
+     * External item ID assigned by the provider of the items.
+     * @format GUID
+     */
     externalId?: string;
-    /** Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups. */
+    /**
+     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * @maxLength 20
+     */
     category?: string;
-    /** ID of the external application supplying the items. */
+    /**
+     * ID of the external application supplying the items.
+     * @format GUID
+     */
     providerAppId?: string;
 }
 export interface Filter extends FilterFilterOneOf {
@@ -274,7 +356,11 @@ export interface Filter extends FilterFilterOneOf {
     byReferenceOptions?: ByReference;
     /** Filter type. */
     type?: Type;
-    /** Filter items by the item's namespace. */
+    /**
+     * Filter items by the item's namespace.
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string;
 }
 /** @oneof */
@@ -296,13 +382,17 @@ export interface FilterFilterOneOf {
     byReferenceOptions?: ByReference;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 1000
+     */
     limit?: number | 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?: string | null;
 }
@@ -326,9 +416,15 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface QueryItemsRequest {
@@ -350,6 +446,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -359,7 +456,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -387,39 +487,70 @@ export interface CountItemsResponse {
     count?: number;
 }
 export interface CloneItemsRequest {
-    /** Id of the item set to be cloned */
+    /**
+     * Id of the item set to be cloned
+     * @format GUID
+     */
     itemSetId?: string;
 }
 export interface CloneItemsResponse {
-    /** Id of the item set that these items were added to */
+    /**
+     * Id of the item set that these items were added to
+     * @format GUID
+     */
     clonedItemSetId?: string;
-    /** Id of the job that is cloning the item set */
+    /**
+     * Id of the job that is cloning the item set
+     * @format GUID
+     */
     cloneJobId?: string;
 }
 export interface BulkCloneItemSetsRequest {
-    /** Id of the item sets to be cloned */
+    /**
+     * Id of the item sets to be cloned
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
     itemSetIds?: string[];
 }
 export interface BulkCloneItemSetsResponse {
-    /** Results */
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 1000
+     */
     results?: BulkCloneItemSetsResult[];
     /** Bulk action metadata */
     bulkActionMetadata?: BulkActionMetadata;
-    /** Id of the job that is cloning the item set */
+    /**
+     * Id of the job that is cloning the item set
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface BulkCloneItemSetsResult {
     /** Item metadata */
     itemMetadata?: ItemMetadata;
-    /** Id of the item set that these items were added to */
+    /**
+     * Id of the item set that these items were added to
+     * @format GUID
+     */
     clonedItemSetId?: string;
 }
 export interface AllocateItemSetsRequest {
-    /** Number of sets to allocate */
+    /**
+     * Number of sets to allocate
+     * @min 1
+     * @max 1000
+     */
     numberOfSets?: number;
 }
 export interface AllocateItemSetsResponse {
-    /** ID that is a shared reference between a benefit pool and a specific item. */
+    /**
+     * ID that is a shared reference between a benefit pool and a specific item.
+     * @format GUID
+     */
     itemSetIds?: string[];
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -495,9 +626,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -505,26 +642,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

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":"AA6OA,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;AAsJD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAqLD,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":"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"}