{ "typeDocModel": { "id": 60433, "name": "@wix/benefit-programs_item", "variant": "project", "kind": 1, "flags": {}, "children": [ { "id": 60601, "name": "SortOrder", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { "id": 60602, "name": "ASC", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "ASC" } }, { "id": 60603, "name": "DESC", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "DESC" } } ], "groups": [ { "title": "Enumeration Members", "children": [ 60602, 60603 ] } ] }, { "id": 60552, "name": "Type", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { "id": 60554, "name": "BY_ITEM_SET_ID_AND_REFERENCE", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "BY_ITEM_SET_ID_AND_REFERENCE" } }, { "id": 60555, "name": "BY_REFERENCE", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "BY_REFERENCE" } }, { "id": 60553, "name": "UNKNOWN_FILTER", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "UNKNOWN_FILTER" } } ], "groups": [ { "title": "Enumeration Members", "children": [ 60554, 60555, 60553 ] } ] }, { "id": 60673, "name": "WebhookIdentityType", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { "id": 60675, "name": "ANONYMOUS_VISITOR", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "ANONYMOUS_VISITOR" } }, { "id": 60678, "name": "APP", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "APP" } }, { "id": 60676, "name": "MEMBER", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "MEMBER" } }, { "id": 60674, "name": "UNKNOWN", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "UNKNOWN" } }, { "id": 60677, "name": "WIX_USER", "variant": "declaration", "kind": 16, "flags": {}, "type": { "type": "literal", "value": "WIX_USER" } } ], "groups": [ { "title": "Enumeration Members", "children": [ 60675, 60678, 60676, 60674, 60677 ] } ] }, { "id": 60655, "name": "ActionEvent", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60656, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60656 ] } ] }, { "id": 60826, "name": "AllocateItemSetsOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60827, "name": "numberOfSets", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of sets to allocate" } ] }, "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [ 60827 ] } ] }, { "id": 60625, "name": "AllocateItemSetsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60626, "name": "numberOfSets", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of sets to allocate" } ] }, "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [ 60626 ] } ] }, { "id": 60627, "name": "AllocateItemSetsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60628, "name": "itemSetIds", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Key of the item set that was created" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Properties", "children": [ 60628 ] } ] }, { "id": 60712, "name": "AllocateItemSetsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60713, "name": "itemSetIds", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Properties", "children": [ 60713 ] } ] }, { "id": 60512, "name": "ApplicationError", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60513, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60515, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Data related to the error." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } ] } }, { "id": 60514, "name": "description", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Description of the error." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60513, 60515, 60514 ] } ] }, { "id": 60516, "name": "BulkActionMetadata", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60518, "name": "totalFailures", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of items that couldn't be processed." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 60517, "name": "totalSuccesses", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of items that were successfully processed." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 60519, "name": "undetailedFailures", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of failures without details because detailed failure threshold was exceeded." } ] }, "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [ 60518, 60517, 60519 ] } ] }, { "id": 60616, "name": "BulkCloneItemSetsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60617, "name": "itemSetIds", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Id of the item sets to be cloned" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Properties", "children": [ 60617 ] } ] }, { "id": 60618, "name": "BulkCloneItemSetsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60620, "name": "bulkActionMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Bulk action metadata" } ] }, "type": { "type": "reference", "target": 60516, "name": "BulkActionMetadata", "package": "@wix/benefit-programs_item" } }, { "id": 60621, "name": "jobId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Id of the job that is cloning the item set" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60619, "name": "results", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Results" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60622, "name": "BulkCloneItemSetsResult", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60620, 60621, 60619 ] } ] }, { "id": 60708, "name": "BulkCloneItemSetsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60710, "name": "bulkActionMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "BulkActionMetadataNonNullableFields" }, "name": "BulkActionMetadataNonNullableFields", "package": "@wix/benefit-programs_item" } }, { "id": 60711, "name": "jobId", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60709, "name": "results", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "BulkCloneItemSetsResultNonNullableFields" }, "name": "BulkCloneItemSetsResultNonNullableFields", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60710, 60711, 60709 ] } ] }, { "id": 60622, "name": "BulkCloneItemSetsResult", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60624, "name": "clonedItemSetId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Id of the item set that these items were added to" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60623, "name": "itemMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item metadata" } ] }, "type": { "type": "reference", "target": 60507, "name": "ItemMetadata", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60624, 60623 ] } ] }, { "id": 60714, "name": "BulkCreateItemsOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60715, "name": "returnEntity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": " if you wish to receive back the created items in the response" } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [ 60715 ] } ] }, { "id": 60498, "name": "BulkCreateItemsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60499, "name": "items", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Items to be added" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } }, { "id": 60500, "name": "returnEntity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": " if you wish to receive back the created items in the response" } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [ 60499, 60500 ] } ] }, { "id": 60501, "name": "BulkCreateItemsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60503, "name": "bulkActionMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Bulk action metadata" } ] }, "type": { "type": "reference", "target": 60516, "name": "BulkActionMetadata", "package": "@wix/benefit-programs_item" } }, { "id": 60502, "name": "results", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item that were added" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60504, "name": "BulkItemResult", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60503, 60502 ] } ] }, { "id": 60684, "name": "BulkCreateItemsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60686, "name": "bulkActionMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "BulkActionMetadataNonNullableFields" }, "name": "BulkActionMetadataNonNullableFields", "package": "@wix/benefit-programs_item" } }, { "id": 60685, "name": "results", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "BulkItemResultNonNullableFields" }, "name": "BulkItemResultNonNullableFields", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60686, 60685 ] } ] }, { "id": 60716, "name": "BulkDeleteItemsByFilterOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60717, "name": "filter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Filter to delete items by" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60717 ] } ] }, { "id": 60528, "name": "BulkDeleteItemsByFilterRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60530, "name": "filter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Filter to delete items by" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } ] } }, { "id": 60529, "name": "namespace", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Namespace" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60530, 60529 ] } ] }, { "id": 60531, "name": "BulkDeleteItemsByFilterResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60532, "name": "jobId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Bulk delete job ID" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60532 ] } ] }, { "id": 60690, "name": "BulkDeleteItemsByFilterResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60691, "name": "jobId", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60691 ] } ] }, { "id": 60523, "name": "BulkDeleteItemsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60524, "name": "itemIds", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Items to be deleted" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Properties", "children": [ 60524 ] } ] }, { "id": 60525, "name": "BulkDeleteItemsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60527, "name": "bulkActionMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Bulk action metadata" } ] }, "type": { "type": "reference", "target": 60516, "name": "BulkActionMetadata", "package": "@wix/benefit-programs_item" } }, { "id": 60526, "name": "results", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Items that were removed" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60504, "name": "BulkItemResult", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60527, 60526 ] } ] }, { "id": 60687, "name": "BulkDeleteItemsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60689, "name": "bulkActionMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "BulkActionMetadataNonNullableFields" }, "name": "BulkActionMetadataNonNullableFields", "package": "@wix/benefit-programs_item" } }, { "id": 60688, "name": "results", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "BulkItemResultNonNullableFields" }, "name": "BulkItemResultNonNullableFields", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60689, 60688 ] } ] }, { "id": 60504, "name": "BulkItemResult", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60506, "name": "item", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Only exists if " }, { "kind": "code", "text": "`returnEntity`" }, { "kind": "text", "text": " was set to true in the request" } ] }, "type": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } }, { "id": 60505, "name": "itemMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item metadata" } ] }, "type": { "type": "reference", "target": 60507, "name": "ItemMetadata", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60506, 60505 ] } ] }, { "id": 60730, "name": "BulkUpdateItemsOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60731, "name": "items", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Items to be added" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60540, "name": "MaskedItem", "package": "@wix/benefit-programs_item" } } }, { "id": 60732, "name": "returnEntity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": " if you wish to receive back the delete items in the response" } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [ 60731, 60732 ] } ] }, { "id": 60537, "name": "BulkUpdateItemsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60538, "name": "items", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Items to be added" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60540, "name": "MaskedItem", "package": "@wix/benefit-programs_item" } } }, { "id": 60539, "name": "returnEntity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": " if you wish to receive back the delete items in the response" } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [ 60538, 60539 ] } ] }, { "id": 60542, "name": "BulkUpdateItemsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60544, "name": "bulkActionMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Bulk action metadata" } ] }, "type": { "type": "reference", "target": 60516, "name": "BulkActionMetadata", "package": "@wix/benefit-programs_item" } }, { "id": 60543, "name": "results", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item that were updated" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60504, "name": "BulkItemResult", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60544, 60543 ] } ] }, { "id": 60694, "name": "BulkUpdateItemsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60696, "name": "bulkActionMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "BulkActionMetadataNonNullableFields" }, "name": "BulkActionMetadataNonNullableFields", "package": "@wix/benefit-programs_item" } }, { "id": 60695, "name": "results", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "BulkItemResultNonNullableFields" }, "name": "BulkItemResultNonNullableFields", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60696, 60695 ] } ] }, { "id": 60556, "name": "ByItemSetIdAndReference", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60557, "name": "filters", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of filters" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60558, "name": "ByItemSetIdAndReferenceFilter", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60557 ] } ] }, { "id": 60558, "name": "ByItemSetIdAndReferenceFilter", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60561, "name": "category", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item category. Discriminates between different types of items. E.g. posts, groups etc." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60560, "name": "externalId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "External item identifier" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60559, "name": "itemSetId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Key of the set that this item is part of" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60562, "name": "providerAppId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item provider app id" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60561, 60560, 60559, 60562 ] } ] }, { "id": 60563, "name": "ByReference", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60564, "name": "filters", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of filters" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60565, "name": "ByReferenceFilter", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60564 ] } ] }, { "id": 60565, "name": "ByReferenceFilter", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60567, "name": "category", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item category. Discriminates between different types of items. E.g. posts, groups etc." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60566, "name": "externalId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "External item identifier" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60568, "name": "providerAppId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item provider app id" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60567, 60566, 60568 ] } ] }, { "id": 60611, "name": "CloneItemsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60612, "name": "itemSetId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Id of the item set to be cloned" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60612 ] } ] }, { "id": 60613, "name": "CloneItemsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60615, "name": "cloneJobId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Id of the job that is cloning the item set" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60614, "name": "clonedItemSetId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Id of the item set that these items were added to" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60615, 60614 ] } ] }, { "id": 60705, "name": "CloneItemsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60707, "name": "cloneJobId", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60706, "name": "clonedItemSetId", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60707, 60706 ] } ] }, { "id": 60824, "name": "CountItemsOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60825, "name": "filter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Items filter to count" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60825 ] } ] }, { "id": 60607, "name": "CountItemsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60608, "name": "filter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Items filter to count" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60608 ] } ] }, { "id": 60609, "name": "CountItemsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60610, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of counted items" } ] }, "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [ 60610 ] } ] }, { "id": 60703, "name": "CountItemsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60704, "name": "count", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [ 60704 ] } ] }, { "id": 60494, "name": "CreateItemRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60495, "name": "item", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Item to be created" } ] }, "type": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60495 ] } ] }, { "id": 60496, "name": "CreateItemResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60497, "name": "item", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item that was created" } ] }, "type": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60497 ] } ] }, { "id": 60682, "name": "CreateItemResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60683, "name": "item", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60679, "name": "ItemNonNullableFields", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60683 ] } ] }, { "id": 60577, "name": "CursorPaging", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60579, "name": "cursor", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the " }, { "kind": "code", "text": "`pagingMetadata`" }, { "kind": "text", "text": " object in the previous call's response.\nNot relevant for the first request." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60578, "name": "limit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of items to return in the results." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "number" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60579, 60578 ] } ] }, { "id": 60583, "name": "CursorPagingMetadata", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60584, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of items returned in the response." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 60585, "name": "cursors", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Cursor strings that point to the next page, previous page, or both." } ] }, "type": { "type": "reference", "target": 60587, "name": "Cursors", "package": "@wix/benefit-programs_item" } }, { "id": 60586, "name": "hasNext", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether there are more pages to retrieve following the current page.\n\n+ " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Another page of results can be retrieved.\n+ " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": This is the last page." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "boolean" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60584, 60585, 60586 ] } ] }, { "id": 60592, "name": "CursorQuery", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 60593, "name": "cursorPaging", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not " }, { "kind": "code", "text": "`filter`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`sort`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "reference", "target": 60577, "name": "CursorPaging", "package": "@wix/benefit-programs_item" }, "overwrites": { "type": "reference", "target": 60597, "name": "CursorQueryPagingMethodOneOf.cursorPaging" } }, { "id": 60594, "name": "filter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Filter object in the following format:\n" }, { "kind": "code", "text": "`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`" }, { "kind": "text", "text": "\nExample of operators: " }, { "kind": "code", "text": "`$eq`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$ne`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$lt`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$lte`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$gt`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$gte`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$in`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$hasSome`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$hasAll`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$startsWith`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`$contains`" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } ] } }, { "id": 60595, "name": "sort", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Sort object in the following format:\n" }, { "kind": "code", "text": "`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60598, "name": "Sorting", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60593, 60594, 60595 ] } ], "extendedTypes": [ { "type": "reference", "target": 60596, "name": "CursorQueryPagingMethodOneOf", "package": "@wix/benefit-programs_item" } ] }, { "id": 60596, "name": "CursorQueryPagingMethodOneOf", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 60597, "name": "cursorPaging", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not " }, { "kind": "code", "text": "`filter`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`sort`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "reference", "target": 60577, "name": "CursorPaging", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60597 ] } ], "extendedBy": [ { "type": "reference", "target": 60592, "name": "CursorQuery" } ] }, { "id": 60587, "name": "Cursors", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60588, "name": "next", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Cursor string pointing to the next page in the list of results." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60589, "name": "prev", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Cursor pointing to the previous page in the list of results." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60588, 60589 ] } ] }, { "id": 60520, "name": "DeleteItemRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60521, "name": "itemId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Item id" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60521 ] } ] }, { "id": 60522, "name": "DeleteItemResponse", "variant": "declaration", "kind": 256, "flags": {} }, { "id": 60629, "name": "DomainEvent", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 60634, "name": "_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Unique event ID.\nAllows clients to ignore duplicate webhooks." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60633, "name": "actionEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60655, "name": "ActionEvent", "package": "@wix/benefit-programs_item" }, "overwrites": { "type": "reference", "target": 60646, "name": "DomainEventBodyOneOf.actionEvent" } }, { "id": 60630, "name": "createdEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60647, "name": "EntityCreatedEvent", "package": "@wix/benefit-programs_item" }, "overwrites": { "type": "reference", "target": 60643, "name": "DomainEventBodyOneOf.createdEvent" } }, { "id": 60632, "name": "deletedEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60653, "name": "EntityDeletedEvent", "package": "@wix/benefit-programs_item" }, "overwrites": { "type": "reference", "target": 60645, "name": "DomainEventBodyOneOf.deletedEvent" } }, { "id": 60641, "name": "entityEventSequence", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60635, "name": "entityFqdn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60637, "name": "entityId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of the entity associated with the event." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60638, "name": "eventTime", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 60640, "name": "originatedFrom", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If present, indicates the action that triggered the event." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60636, "name": "slug", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60639, "name": "triggeredByAnonymizeRequest", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR)." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "boolean" } ] } }, { "id": 60631, "name": "updatedEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60651, "name": "EntityUpdatedEvent", "package": "@wix/benefit-programs_item" }, "overwrites": { "type": "reference", "target": 60644, "name": "DomainEventBodyOneOf.updatedEvent" } } ], "groups": [ { "title": "Properties", "children": [ 60634, 60633, 60630, 60632, 60641, 60635, 60637, 60638, 60640, 60636, 60639, 60631 ] } ], "extendedTypes": [ { "type": "reference", "target": 60642, "name": "DomainEventBodyOneOf", "package": "@wix/benefit-programs_item" } ] }, { "id": 60642, "name": "DomainEventBodyOneOf", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 60646, "name": "actionEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60655, "name": "ActionEvent", "package": "@wix/benefit-programs_item" } }, { "id": 60643, "name": "createdEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60647, "name": "EntityCreatedEvent", "package": "@wix/benefit-programs_item" } }, { "id": 60645, "name": "deletedEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60653, "name": "EntityDeletedEvent", "package": "@wix/benefit-programs_item" } }, { "id": 60644, "name": "updatedEvent", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60651, "name": "EntityUpdatedEvent", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60646, 60643, 60645, 60644 ] } ], "extendedBy": [ { "type": "reference", "target": 60629, "name": "DomainEvent" } ] }, { "id": 60647, "name": "EntityCreatedEvent", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60648, "name": "entity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60648 ] } ] }, { "id": 60653, "name": "EntityDeletedEvent", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60654, "name": "deletedEntity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Entity that was deleted" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60654 ] } ] }, { "id": 60651, "name": "EntityUpdatedEvent", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60652, "name": "currentEntity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60652 ] } ] }, { "id": 60490, "name": "ExtendedFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60491, "name": "namespaces", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)." } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } ], "name": "Record", "package": "typescript" } } ], "groups": [ { "title": "Properties", "children": [ 60491 ] } ] }, { "id": 60569, "name": "Filter", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 60570, "name": "byItemSetIdAndReferenceOptions", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of filters by itemSetId and reference" } ] }, "type": { "type": "reference", "target": 60556, "name": "ByItemSetIdAndReference", "package": "@wix/benefit-programs_item" }, "overwrites": { "type": "reference", "target": 60575, "name": "FilterFilterOneOf.byItemSetIdAndReferenceOptions" } }, { "id": 60571, "name": "byReferenceOptions", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of filters by reference" } ] }, "type": { "type": "reference", "target": 60563, "name": "ByReference", "package": "@wix/benefit-programs_item" }, "overwrites": { "type": "reference", "target": 60576, "name": "FilterFilterOneOf.byReferenceOptions" } }, { "id": 60573, "name": "namespace", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item namespace" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60572, "name": "type", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Type of the filter" } ] }, "type": { "type": "reference", "target": 60552, "name": "Type", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60570, 60571, 60573, 60572 ] } ], "extendedTypes": [ { "type": "reference", "target": 60574, "name": "FilterFilterOneOf", "package": "@wix/benefit-programs_item" } ] }, { "id": 60574, "name": "FilterFilterOneOf", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 60575, "name": "byItemSetIdAndReferenceOptions", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of filters by itemSetId and reference" } ] }, "type": { "type": "reference", "target": 60556, "name": "ByItemSetIdAndReference", "package": "@wix/benefit-programs_item" } }, { "id": 60576, "name": "byReferenceOptions", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of filters by reference" } ] }, "type": { "type": "reference", "target": 60563, "name": "ByReference", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60575, 60576 ] } ], "extendedBy": [ { "type": "reference", "target": 60569, "name": "Filter" } ] }, { "id": 60545, "name": "GetItemRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60546, "name": "itemId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Id of the Item to retrieve" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60546 ] } ] }, { "id": 60547, "name": "GetItemResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60548, "name": "item", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The retrieved Item" } ] }, "type": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60548 ] } ] }, { "id": 60697, "name": "GetItemResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60698, "name": "item", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60679, "name": "ItemNonNullableFields", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60698 ] } ] }, { "id": 60662, "name": "IdentificationData", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 60663, "name": "anonymousVisitorId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a site visitor that has not logged in to the site." } ] }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 60669, "name": "IdentificationDataIdOneOf.anonymousVisitorId" } }, { "id": 60666, "name": "appId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of an app." } ] }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 60672, "name": "IdentificationDataIdOneOf.appId" } }, { "id": 60667, "name": "identityType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "reference", "target": 60673, "name": "WebhookIdentityType", "package": "@wix/benefit-programs_item" } }, { "id": 60664, "name": "memberId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a site visitor that has logged in to the site." } ] }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 60670, "name": "IdentificationDataIdOneOf.memberId" } }, { "id": 60665, "name": "wixUserId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a Wix user (site owner, contributor, etc.)." } ] }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 60671, "name": "IdentificationDataIdOneOf.wixUserId" } } ], "groups": [ { "title": "Properties", "children": [ 60663, 60666, 60667, 60664, 60665 ] } ], "extendedTypes": [ { "type": "reference", "target": 60668, "name": "IdentificationDataIdOneOf", "package": "@wix/benefit-programs_item" } ] }, { "id": 60668, "name": "IdentificationDataIdOneOf", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@oneof", "content": [] } ] }, "children": [ { "id": 60669, "name": "anonymousVisitorId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a site visitor that has not logged in to the site." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60672, "name": "appId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of an app." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60670, "name": "memberId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a site visitor that has logged in to the site." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60671, "name": "wixUserId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of a Wix user (site owner, contributor, etc.)." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60669, 60672, 60670, 60671 ] } ], "extendedBy": [ { "type": "reference", "target": 60662, "name": "IdentificationData" } ] }, { "id": 60478, "name": "Item", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Represents anything that an external system exposes as a benefit. It could be a specific event, a booking session, or even a physical good.\n" }, { "kind": "code", "text": "`category`" }, { "kind": "text", "text": " is used to identify the type of the item and id is used to uniquely identify it within the category.\nFor example, if the item is a blog post, then the category could be \"post\" and the id could be the post id." } ] }, "children": [ { "id": 60481, "name": "_createdDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Represents the time this Item was created" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 60479, "name": "_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Item identifier" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60482, "name": "_updatedDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Represents the time this Item was last updated" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 60484, "name": "category", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item category. Discriminates between different types of items. E.g. posts, groups etc." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60486, "name": "displayName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Display name of the item" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60488, "name": "extendedFields", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Data extensions" } ] }, "type": { "type": "reference", "target": 60490, "name": "ExtendedFields", "package": "@wix/benefit-programs_item" } }, { "id": 60483, "name": "externalId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "External item identifier" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60485, "name": "itemSetId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Key of the set that this item is part of" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60489, "name": "namespace", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item namespace" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60487, "name": "providerAppId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of the app that provides this item, eg. bookings, blog or events" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60480, "name": "revision", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Represents the current state of an item. Each time the item is modified, its " }, { "kind": "code", "text": "`revision`" }, { "kind": "text", "text": " changes. for an update operation to succeed, you MUST pass the latest revision" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60481, 60479, 60482, 60484, 60486, 60488, 60483, 60485, 60489, 60487, 60480 ] } ] }, { "id": 60507, "name": "ItemMetadata", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60508, "name": "_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60511, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Details about the error in case of failure." } ] }, "type": { "type": "reference", "target": 60512, "name": "ApplicationError", "package": "@wix/benefit-programs_item" } }, { "id": 60509, "name": "originalIndex", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Index of the item within the request array. Allows for correlation between request and response items." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 60510, "name": "success", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the requested action was successful for this item. When " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ", the " }, { "kind": "code", "text": "`error`" }, { "kind": "text", "text": " field is populated." } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [ 60508, 60511, 60509, 60510 ] } ] }, { "id": 60679, "name": "ItemNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60680, "name": "externalId", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60681, "name": "itemSetId", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60680, 60681 ] } ] }, { "id": 60492, "name": "ItemsCloned", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60493, "name": "itemSetId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of the pool that had its items provisioned" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 60493 ] } ] }, { "id": 60754, "name": "ItemsQueryBuilder", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60805, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60806, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60807, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60808, "name": "propertyNames", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "comment": { "summary": [ { "kind": "text", "text": "Properties used in the sort. To sort by multiple properties, pass properties as additional arguments." } ] }, "type": { "type": "array", "elementType": { "type": "union", "types": [ { "type": "literal", "value": "_id" }, { "type": "literal", "value": "_createdDate" }, { "type": "literal", "value": "externalId" }, { "type": "literal", "value": "category" }, { "type": "literal", "value": "itemSetId" }, { "type": "literal", "value": "providerAppId" }, { "type": "literal", "value": "namespace" } ] } } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60809, "name": "descending", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60810, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60811, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60812, "name": "propertyNames", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "comment": { "summary": [ { "kind": "text", "text": "Properties used in the sort. To sort by multiple properties, pass properties as additional arguments." } ] }, "type": { "type": "array", "elementType": { "type": "union", "types": [ { "type": "literal", "value": "_id" }, { "type": "literal", "value": "_createdDate" }, { "type": "literal", "value": "externalId" }, { "type": "literal", "value": "category" }, { "type": "literal", "value": "itemSetId" }, { "type": "literal", "value": "providerAppId" }, { "type": "literal", "value": "namespace" } ] } } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60755, "name": "eq", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60756, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60757, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60758, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Property whose value is compared with " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "_id" }, { "type": "literal", "value": "_createdDate" }, { "type": "literal", "value": "externalId" }, { "type": "literal", "value": "category" }, { "type": "literal", "value": "itemSetId" }, { "type": "literal", "value": "providerAppId" }, { "type": "literal", "value": "namespace" } ] } }, { "id": 60759, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Value to compare against." } ] }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60800, "name": "exists", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60801, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60802, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60803, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": "_id" }, { "type": "literal", "value": "_createdDate" }, { "type": "literal", "value": "externalId" }, { "type": "literal", "value": "category" }, { "type": "literal", "value": "itemSetId" }, { "type": "literal", "value": "providerAppId" }, { "type": "literal", "value": "namespace" } ] } }, { "id": 60804, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60821, "name": "find", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60822, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60823, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 60736, "name": "ItemsQueryResult", "package": "@wix/benefit-programs_item" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 60765, "name": "ge", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60766, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60767, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60768, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Property whose value is compared with " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "_createdDate" } }, { "id": 60769, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Value to compare against." } ] }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60770, "name": "gt", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60771, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60772, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60773, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Property whose value is compared with " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "_createdDate" } }, { "id": 60774, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Value to compare against." } ] }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60790, "name": "hasSome", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60791, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60792, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60793, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Property whose value is compared with " }, { "kind": "code", "text": "`values`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "_id" }, { "type": "literal", "value": "_createdDate" }, { "type": "literal", "value": "externalId" }, { "type": "literal", "value": "category" }, { "type": "literal", "value": "itemSetId" }, { "type": "literal", "value": "providerAppId" }, { "type": "literal", "value": "namespace" } ] } }, { "id": 60794, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60795, "name": "in", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60796, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60797, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60798, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": "_id" }, { "type": "literal", "value": "_createdDate" }, { "type": "literal", "value": "externalId" }, { "type": "literal", "value": "category" }, { "type": "literal", "value": "itemSetId" }, { "type": "literal", "value": "providerAppId" }, { "type": "literal", "value": "namespace" } ] } }, { "id": 60799, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60775, "name": "le", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60776, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60777, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60778, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Property whose value is compared with " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "_createdDate" } }, { "id": 60779, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Value to compare against." } ] }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60813, "name": "limit", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60814, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60815, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60816, "name": "limit", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Number of items to return, which is also the " }, { "kind": "code", "text": "`pageSize`" }, { "kind": "text", "text": " of the results object." } ] }, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60780, "name": "lt", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60781, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60782, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60783, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Property whose value is compared with " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "_createdDate" } }, { "id": 60784, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Value to compare against." } ] }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60760, "name": "ne", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60761, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60762, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60763, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Property whose value is compared with " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "_id" }, { "type": "literal", "value": "_createdDate" }, { "type": "literal", "value": "externalId" }, { "type": "literal", "value": "category" }, { "type": "literal", "value": "itemSetId" }, { "type": "literal", "value": "providerAppId" }, { "type": "literal", "value": "namespace" } ] } }, { "id": 60764, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Value to compare against." } ] }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60817, "name": "skipTo", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60818, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60819, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60820, "name": "cursor", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A pointer to specific record" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } }, { "id": 60785, "name": "startsWith", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60786, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60787, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] } ] }, "parameters": [ { "id": 60788, "name": "propertyName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Property whose value is compared with " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "_id" }, { "type": "literal", "value": "externalId" }, { "type": "literal", "value": "category" }, { "type": "literal", "value": "itemSetId" }, { "type": "literal", "value": "providerAppId" }, { "type": "literal", "value": "namespace" } ] } }, { "id": 60789, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] } } } ], "groups": [ { "title": "Properties", "children": [ 60805, 60809, 60755, 60800, 60821, 60765, 60770, 60790, 60795, 60775, 60813, 60780, 60760, 60817, 60785 ] } ] }, { "id": 60736, "name": "ItemsQueryResult", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60745, "name": "cursors", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 60587, "name": "Cursors", "package": "@wix/benefit-programs_item" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "QueryCursorResult.cursors" } }, { "id": 60746, "name": "hasNext", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60747, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60748, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } } ] } }, "inheritedFrom": { "type": "reference", "target": -1, "name": "QueryCursorResult.hasNext" } }, { "id": 60749, "name": "hasPrev", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60750, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60751, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } } ] } }, "inheritedFrom": { "type": "reference", "target": -1, "name": "QueryCursorResult.hasPrev" } }, { "id": 60737, "name": "items", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } }, { "id": 60752, "name": "length", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "QueryCursorResult.length" } }, { "id": 60739, "name": "next", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60740, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60741, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 60736, "name": "ItemsQueryResult", "package": "@wix/benefit-programs_item" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 60753, "name": "pageSize", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "QueryCursorResult.pageSize" } }, { "id": 60742, "name": "prev", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 60743, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 60744, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 60736, "name": "ItemsQueryResult", "package": "@wix/benefit-programs_item" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 60738, "name": "query", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60745, 60746, 60749, 60737, 60752, 60739, 60753, 60742, 60738 ] } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "src/benefit-programs-v1-item-item.universal.ts", "qualifiedName": "QueryCursorResult" }, "name": "QueryCursorResult", "package": "@wix/benefit-programs_item" } ] }, { "id": 60733, "name": "ListItemsOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60735, "name": "cursorPaging", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Cursor paging" } ] }, "type": { "type": "reference", "target": 60577, "name": "CursorPaging", "package": "@wix/benefit-programs_item" } }, { "id": 60734, "name": "filter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The filter" } ] }, "type": { "type": "reference", "target": 60569, "name": "Filter", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60735, 60734 ] } ] }, { "id": 60549, "name": "ListItemsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60551, "name": "cursorPaging", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Cursor paging" } ] }, "type": { "type": "reference", "target": 60577, "name": "CursorPaging", "package": "@wix/benefit-programs_item" } }, { "id": 60550, "name": "filter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The filter" } ] }, "type": { "type": "reference", "target": 60569, "name": "Filter", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60551, 60550 ] } ] }, { "id": 60580, "name": "ListItemsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60581, "name": "items", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The retrieved items" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } }, { "id": 60582, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Paging information" } ] }, "type": { "type": "reference", "target": 60583, "name": "CursorPagingMetadata", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60581, 60582 ] } ] }, { "id": 60699, "name": "ListItemsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60700, "name": "items", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": 60679, "name": "ItemNonNullableFields", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60700 ] } ] }, { "id": 60540, "name": "MaskedItem", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60541, "name": "item", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item to be updated, may be partial" } ] }, "type": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60541 ] } ] }, { "id": 60657, "name": "MessageEnvelope", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60661, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Stringify payload." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60659, "name": "eventType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Event type." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60660, "name": "identity", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The identification type and identity data." } ] }, "type": { "type": "reference", "target": 60662, "name": "IdentificationData", "package": "@wix/benefit-programs_item" } }, { "id": 60658, "name": "instanceId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "App instance ID." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60661, 60659, 60660, 60658 ] } ] }, { "id": 60590, "name": "QueryItemsRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60591, "name": "query", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "WQL expression" } ] }, "type": { "type": "reference", "target": 60592, "name": "CursorQuery", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60591 ] } ] }, { "id": 60604, "name": "QueryItemsResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60605, "name": "items", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The retrieved Items" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } }, { "id": 60606, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Paging information" } ] }, "type": { "type": "reference", "target": 60583, "name": "CursorPagingMetadata", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60605, 60606 ] } ] }, { "id": 60701, "name": "QueryItemsResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60702, "name": "items", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": 60679, "name": "ItemNonNullableFields", "package": "@wix/benefit-programs_item" } } } ], "groups": [ { "title": "Properties", "children": [ 60702 ] } ] }, { "id": 60649, "name": "RestoreInfo", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60650, "name": "deletedDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60650 ] } ] }, { "id": 60598, "name": "Sorting", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60599, "name": "fieldName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Name of the field to sort by." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60600, "name": "order", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Sort order." } ] }, "type": { "type": "reference", "target": 60601, "name": "SortOrder", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60599, 60600 ] } ] }, { "id": 60718, "name": "UpdateItem", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60721, "name": "_createdDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Represents the time this Item was created" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 60719, "name": "_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Item identifier" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60722, "name": "_updatedDate", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Represents the time this Item was last updated" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } }, { "id": 60724, "name": "category", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item category. Discriminates between different types of items. E.g. posts, groups etc." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60726, "name": "displayName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Display name of the item" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60728, "name": "extendedFields", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Data extensions" } ] }, "type": { "type": "reference", "target": 60490, "name": "ExtendedFields", "package": "@wix/benefit-programs_item" } }, { "id": 60723, "name": "externalId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "External item identifier" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60725, "name": "itemSetId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Key of the set that this item is part of" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60729, "name": "namespace", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item namespace" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60727, "name": "providerAppId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ID of the app that provides this item, eg. bookings, blog or events" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60720, "name": "revision", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Represents the current state of an item. Each time the item is modified, its " }, { "kind": "code", "text": "`revision`" }, { "kind": "text", "text": " changes. for an update operation to succeed, you MUST pass the latest revision" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [ 60721, 60719, 60722, 60724, 60726, 60728, 60723, 60725, 60729, 60727, 60720 ] } ] }, { "id": 60533, "name": "UpdateItemRequest", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60534, "name": "item", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Item to be updated, may be partial" } ] }, "type": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60534 ] } ] }, { "id": 60535, "name": "UpdateItemResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60536, "name": "item", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Item that was updated" } ] }, "type": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60536 ] } ] }, { "id": 60692, "name": "UpdateItemResponseNonNullableFields", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 60693, "name": "item", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60679, "name": "ItemNonNullableFields", "package": "@wix/benefit-programs_item" } } ], "groups": [ { "title": "Properties", "children": [ 60693 ] } ] }, { "id": 60475, "name": "allocateItemSets", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60476, "name": "allocateItemSets", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Allocates the provided number of sets" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_SET_ALLOCATE" } ] } ] }, "parameters": [ { "id": 60477, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60826, "name": "AllocateItemSetsOptions", "package": "@wix/benefit-programs_item" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60627, "name": "AllocateItemSetsResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60712, "name": "AllocateItemSetsResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60472, "name": "bulkCloneItemSets", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60473, "name": "bulkCloneItemSets", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Clone the item set" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "itemSetIds" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_CLONE" } ] } ] }, "parameters": [ { "id": 60474, "name": "itemSetIds", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Id of the item sets to be cloned" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60618, "name": "BulkCloneItemSetsResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60708, "name": "BulkCloneItemSetsResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60437, "name": "bulkCreateItems", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60438, "name": "bulkCreateItems", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Adds items to the benefit" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "items" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "items.externalId" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "items.itemSetId" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "items.namespace" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_CREATE" } ] } ] }, "parameters": [ { "id": 60439, "name": "items", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Items to be added" } ] }, "type": { "type": "array", "elementType": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } }, { "id": 60440, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60714, "name": "BulkCreateItemsOptions", "package": "@wix/benefit-programs_item" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60501, "name": "BulkCreateItemsResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60684, "name": "BulkCreateItemsResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60444, "name": "bulkDeleteItems", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60445, "name": "bulkDeleteItems", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Deletes the items" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "itemIds" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_DELETE" } ] } ] }, "parameters": [ { "id": 60446, "name": "itemIds", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Items to be deleted" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60525, "name": "BulkDeleteItemsResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60687, "name": "BulkDeleteItemsResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60447, "name": "bulkDeleteItemsByFilter", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60448, "name": "bulkDeleteItemsByFilter", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Deletes the items by filter" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "namespace" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_DELETE" } ] } ] }, "parameters": [ { "id": 60449, "name": "namespace", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Namespace" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60450, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60716, "name": "BulkDeleteItemsByFilterOptions", "package": "@wix/benefit-programs_item" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60531, "name": "BulkDeleteItemsByFilterResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60690, "name": "BulkDeleteItemsByFilterResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60455, "name": "bulkUpdateItems", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60456, "name": "bulkUpdateItems", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Update the Item, supports partial update\nPass the latest " }, { "kind": "code", "text": "`revision`" }, { "kind": "text", "text": " for a successful update" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "options.items.item" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "options.items.item._id" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "options.items.item.revision" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_UPDATE" } ] } ] }, "parameters": [ { "id": 60457, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60730, "name": "BulkUpdateItemsOptions", "package": "@wix/benefit-programs_item" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60542, "name": "BulkUpdateItemsResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60694, "name": "BulkUpdateItemsResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60469, "name": "cloneItems", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60470, "name": "cloneItems", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Clone the item set" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "itemSetId" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_CLONE" } ] } ] }, "parameters": [ { "id": 60471, "name": "itemSetId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Id of the item set to be cloned" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60613, "name": "CloneItemsResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60705, "name": "CloneItemsResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60466, "name": "countItems", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60467, "name": "countItems", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Used for counting items" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_READ" } ] } ] }, "parameters": [ { "id": 60468, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60824, "name": "CountItemsOptions", "package": "@wix/benefit-programs_item" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60609, "name": "CountItemsResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60703, "name": "CountItemsResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60434, "name": "createItem", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60435, "name": "createItem", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Create an item" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "item" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "item.externalId" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "item.itemSetId" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "item.namespace" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "item.providerAppId" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_CREATE" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Item that was created" } ] } ] }, "parameters": [ { "id": 60436, "name": "item", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Item to be created" } ] }, "type": { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60679, "name": "ItemNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60441, "name": "deleteItem", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60442, "name": "deleteItem", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Removes the item from the benefit" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "itemId" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_DELETE" } ] } ] }, "parameters": [ { "id": 60443, "name": "itemId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Item id" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60458, "name": "getItem", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60459, "name": "getItem", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Get a Benefit Item by id" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "itemId" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_READ" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "The retrieved Item" } ] } ] }, "parameters": [ { "id": 60460, "name": "itemId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Id of the Item to retrieve" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60679, "name": "ItemNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60461, "name": "listItems", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60462, "name": "listItems", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Get all items matching the filter" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_READ" } ] } ] }, "parameters": [ { "id": 60463, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 60733, "name": "ListItemsOptions", "package": "@wix/benefit-programs_item" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60580, "name": "ListItemsResponse", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60699, "name": "ListItemsResponseNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 60464, "name": "queryItems", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60465, "name": "queryItems", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Query Items using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_READ" } ] } ] }, "type": { "type": "reference", "target": 60754, "name": "ItemsQueryBuilder", "package": "@wix/benefit-programs_item" } } ] }, { "id": 60451, "name": "updateItem", "variant": "declaration", "kind": 64, "flags": { "isPublic": true }, "signatures": [ { "id": 60452, "name": "updateItem", "variant": "signature", "kind": 4096, "flags": { "isPublic": true }, "comment": { "summary": [ { "kind": "text", "text": "Update the Item, supports partial update\nPass the latest " }, { "kind": "code", "text": "`revision`" }, { "kind": "text", "text": " for a successful update" } ], "blockTags": [ { "tag": "@documentationMaturity", "content": [ { "kind": "text", "text": "preview" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "_id" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "item" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "item.revision" } ] }, { "tag": "@permissionId", "content": [ { "kind": "text", "text": "BENEFIT_PROGRAMS.ITEM_UPDATE" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Item that was updated" } ] } ] }, "parameters": [ { "id": 60453, "name": "_id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Item identifier" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 60454, "name": "item", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 60718, "name": "UpdateItem", "package": "@wix/benefit-programs_item" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": 60478, "name": "Item", "package": "@wix/benefit-programs_item" }, { "type": "reference", "target": 60679, "name": "ItemNonNullableFields", "package": "@wix/benefit-programs_item" } ] } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Enumerations", "children": [ 60601, 60552, 60673 ] }, { "title": "Interfaces", "children": [ 60655, 60826, 60625, 60627, 60712, 60512, 60516, 60616, 60618, 60708, 60622, 60714, 60498, 60501, 60684, 60716, 60528, 60531, 60690, 60523, 60525, 60687, 60504, 60730, 60537, 60542, 60694, 60556, 60558, 60563, 60565, 60611, 60613, 60705, 60824, 60607, 60609, 60703, 60494, 60496, 60682, 60577, 60583, 60592, 60596, 60587, 60520, 60522, 60629, 60642, 60647, 60653, 60651, 60490, 60569, 60574, 60545, 60547, 60697, 60662, 60668, 60478, 60507, 60679, 60492, 60754, 60736, 60733, 60549, 60580, 60699, 60540, 60657, 60590, 60604, 60701, 60649, 60598, 60718, 60533, 60535, 60692 ] }, { "title": "Functions", "children": [ 60475, 60472, 60437, 60444, 60447, 60455, 60469, 60466, 60434, 60441, 60458, 60461, 60464, 60451 ] } ], "packageName": "@wix/benefit-programs_item", "symbolIdMap": {} }, "appendices": { "/": [ { "type": "GUIDE", "title": "Setup", "src": "To use the Item API, install the `@wix/benefit-programs` package using npm or Yarn:\n ```console\nnpm install @wix/benefit-programs\n```\n\nor\n\n```console\nyarn add @wix/benefit-programs\n```\n\nThen import `{ item }` from `@wix/benefit-programs`:\n\n```js\nimport { item } from '@wix/benefit-programs'\n```\n " } ], "/allocateItemSets": [ { "type": "EXAMPLE", "title": "allocateItemSets: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function allocateItemSets(options) {\n const response = await item.allocateItemSets(options);\n};" }, { "type": "EXAMPLE", "title": "allocateItemSets: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function allocateItemSets(options) {\n const response = await myWixClient.item.allocateItemSets(options);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/bulkCloneItemSets": [ { "type": "EXAMPLE", "title": "bulkCloneItemSets: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function bulkCloneItemSets(itemSetIds) {\n const response = await item.bulkCloneItemSets(itemSetIds);\n};" }, { "type": "EXAMPLE", "title": "bulkCloneItemSets: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkCloneItemSets(itemSetIds) {\n const response = await myWixClient.item.bulkCloneItemSets(itemSetIds);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/bulkCreateItems": [ { "type": "EXAMPLE", "title": "bulkCreateItems: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function bulkCreateItems(items, options) {\n const response = await item.bulkCreateItems(items, options);\n};" }, { "type": "EXAMPLE", "title": "bulkCreateItems: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkCreateItems(items, options) {\n const response = await myWixClient.item.bulkCreateItems(items, options);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/bulkDeleteItems": [ { "type": "EXAMPLE", "title": "bulkDeleteItems: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function bulkDeleteItems(itemIds) {\n const response = await item.bulkDeleteItems(itemIds);\n};" }, { "type": "EXAMPLE", "title": "bulkDeleteItems: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkDeleteItems(itemIds) {\n const response = await myWixClient.item.bulkDeleteItems(itemIds);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/bulkDeleteItemsByFilter": [ { "type": "EXAMPLE", "title": "bulkDeleteItemsByFilter: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function bulkDeleteItemsByFilter(namespace, options) {\n const response = await item.bulkDeleteItemsByFilter(namespace, options);\n};" }, { "type": "EXAMPLE", "title": "bulkDeleteItemsByFilter: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkDeleteItemsByFilter(namespace, options) {\n const response = await myWixClient.item.bulkDeleteItemsByFilter(namespace, options);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/bulkUpdateItems": [ { "type": "EXAMPLE", "title": "bulkUpdateItems: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function bulkUpdateItems(options) {\n const response = await item.bulkUpdateItems(options);\n};" }, { "type": "EXAMPLE", "title": "bulkUpdateItems: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkUpdateItems(options) {\n const response = await myWixClient.item.bulkUpdateItems(options);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/cloneItems": [ { "type": "EXAMPLE", "title": "cloneItems: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function cloneItems(itemSetId) {\n const response = await item.cloneItems(itemSetId);\n};" }, { "type": "EXAMPLE", "title": "cloneItems: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function cloneItems(itemSetId) {\n const response = await myWixClient.item.cloneItems(itemSetId);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/countItems": [ { "type": "EXAMPLE", "title": "countItems: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function countItems(options) {\n const response = await item.countItems(options);\n};" }, { "type": "EXAMPLE", "title": "countItems: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function countItems(options) {\n const response = await myWixClient.item.countItems(options);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." }, { "type": "ERROR", "title": "/countItems Errors", "src": "", "errors": [ { "httpCode": 428, "statusCode": "FAILED_PRECONDITION", "applicationCode": "TOO_MANY_TO_COUNT", "description": "Thrown when the server is unable to calculate due to too many items", "errorType": "APPLICATION", "applicationCodeData": { "applicationCode": "TOO_MANY_TO_COUNT" } } ] } ], "/createItem": [ { "type": "EXAMPLE", "title": "createItem: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function createItem(item) {\n const response = await item.createItem(item);\n};" }, { "type": "EXAMPLE", "title": "createItem: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function createItem(item) {\n const response = await myWixClient.item.createItem(item);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/deleteItem": [ { "type": "EXAMPLE", "title": "deleteItem: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function deleteItem(itemId) {\n const response = await item.deleteItem(itemId);\n};" }, { "type": "EXAMPLE", "title": "deleteItem: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteItem(itemId) {\n const response = await myWixClient.item.deleteItem(itemId);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/getItem": [ { "type": "EXAMPLE", "title": "getItem: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function getItem(itemId) {\n const response = await item.getItem(itemId);\n};" }, { "type": "EXAMPLE", "title": "getItem: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getItem(itemId) {\n const response = await myWixClient.item.getItem(itemId);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/listItems": [ { "type": "EXAMPLE", "title": "listItems: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function listItems(options) {\n const response = await item.listItems(options);\n};" }, { "type": "EXAMPLE", "title": "listItems: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listItems(options) {\n const response = await myWixClient.item.listItems(options);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/queryItems": [ { "type": "DESCRIPTION", "title": "description", "src": "Query Items using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/items-query-builder/eq),[`ne()`](/items-query-builder/ne),[`exists()`](/items-query-builder/exists),[`in()`](/items-query-builder/in),[`hasSome()`](/items-query-builder/has-some),[`startsWith()`](/items-query-builder/starts-with),[`ascending()`](/items-query-builder/ascending),[`descending()`](/items-query-builder/descending)|\n|`_createdDate`|[`eq()`](/items-query-builder/eq),[`ne()`](/items-query-builder/ne),[`exists()`](/items-query-builder/exists),[`in()`](/items-query-builder/in),[`hasSome()`](/items-query-builder/has-some),[`lt()`](/items-query-builder/lt),[`le()`](/items-query-builder/le),[`gt()`](/items-query-builder/gt),[`ge()`](/items-query-builder/ge),[`ascending()`](/items-query-builder/ascending),[`descending()`](/items-query-builder/descending)|\n|`externalId`|[`eq()`](/items-query-builder/eq),[`ne()`](/items-query-builder/ne),[`exists()`](/items-query-builder/exists),[`in()`](/items-query-builder/in),[`hasSome()`](/items-query-builder/has-some),[`startsWith()`](/items-query-builder/starts-with),[`ascending()`](/items-query-builder/ascending),[`descending()`](/items-query-builder/descending)|\n|`category`|[`eq()`](/items-query-builder/eq),[`ne()`](/items-query-builder/ne),[`exists()`](/items-query-builder/exists),[`in()`](/items-query-builder/in),[`hasSome()`](/items-query-builder/has-some),[`startsWith()`](/items-query-builder/starts-with),[`ascending()`](/items-query-builder/ascending),[`descending()`](/items-query-builder/descending)|\n|`itemSetId`|[`eq()`](/items-query-builder/eq),[`ne()`](/items-query-builder/ne),[`exists()`](/items-query-builder/exists),[`in()`](/items-query-builder/in),[`hasSome()`](/items-query-builder/has-some),[`startsWith()`](/items-query-builder/starts-with),[`ascending()`](/items-query-builder/ascending),[`descending()`](/items-query-builder/descending)|\n|`providerAppId`|[`eq()`](/items-query-builder/eq),[`ne()`](/items-query-builder/ne),[`exists()`](/items-query-builder/exists),[`in()`](/items-query-builder/in),[`hasSome()`](/items-query-builder/has-some),[`startsWith()`](/items-query-builder/starts-with),[`ascending()`](/items-query-builder/ascending),[`descending()`](/items-query-builder/descending)|\n|`namespace`|[`eq()`](/items-query-builder/eq),[`ne()`](/items-query-builder/ne),[`exists()`](/items-query-builder/exists),[`in()`](/items-query-builder/in),[`hasSome()`](/items-query-builder/has-some),[`startsWith()`](/items-query-builder/starts-with),[`ascending()`](/items-query-builder/ascending),[`descending()`](/items-query-builder/descending)|" }, { "type": "EXAMPLE", "title": "queryItems: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function queryItems() {\n const { items } = await item.queryItems().find();\n};" }, { "type": "EXAMPLE", "title": "queryItems: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function queryItems() {\n const { items } = await myWixClient.item.queryItems().find();\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ], "/queryProperties/ascending": [ { "type": "SUMMARY", "title": "summary", "src": "Adds a sort to a query, sorting by the specified properties in ascending order." }, { "type": "DESCRIPTION", "title": "description", "src": "The `ascending()` function refines a `ItemsQueryBuilder` to sort by the value of `propertyName` in ascending order.\nYou can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest." }, { "type": "EXAMPLE", "title": "Add an `ascending` sort to a query", "src": "const query = item.queryItems().ascending('_id');\n" }, { "type": "EXAMPLE", "title": "Create a query, add an `ascending` sort, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().ascending('_id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/cursors": [ { "type": "SUMMARY", "title": "summary", "src": "Returns the query cursors." }, { "type": "DESCRIPTION", "title": "description", "src": "`cursors` returns the query's `next` and `prev` cursors." }, { "type": "EXAMPLE", "title": "Get the query's cursors", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n const cursors = results.cursors;\n}\n" } ], "/queryProperties/descending": [ { "type": "SUMMARY", "title": "summary", "src": "Adds a sort to a query, sorting by the specified properties in descending order." }, { "type": "DESCRIPTION", "title": "description", "src": "The `descending()` function refines a `ItemsQueryBuilder` to sort by the value of `propertyName` in descending order.\nYou can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest." }, { "type": "EXAMPLE", "title": "Add a `descending` sort to a query", "src": "const query = item.queryItems().descending('_id');\n" }, { "type": "EXAMPLE", "title": "Create a query, add a `descending` sort, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().descending('_id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/eq": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items where the specified property equals the specified value." }, { "type": "DESCRIPTION", "title": "description", "src": "The `eq()` function refines a `ItemsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`." }, { "type": "EXAMPLE", "title": "Add an `eq` filter to a query", "src": "const query = item.queryItems().eq('_id', 'some-id');\n" }, { "type": "EXAMPLE", "title": "Create a query, add an `eq` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item\n .queryItems()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/exists": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items where the specified property contains a value." }, { "type": "DESCRIPTION", "title": "description", "src": "The `exists()` function refines a `ItemsQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolean parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned." }, { "type": "EXAMPLE", "title": "Add an `exists` filter to a query", "src": "const query = item.queryItems().exists('description', true);\n" }, { "type": "EXAMPLE", "title": "Create a query, add an `exists` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().exists('description', true).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/find": [ { "type": "SUMMARY", "title": "summary", "src": "Returns the query results." }, { "type": "DESCRIPTION", "title": "description", "src": "The `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid." }, { "type": "EXAMPLE", "title": "Run a query with no filters", "src": "const query = item.queryItems().find();\n" }, { "type": "EXAMPLE", "title": "Perform a `find` on a query", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/ge": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items where the specified property is greater than or equal to the specified value." }, { "type": "DESCRIPTION", "title": "description", "src": "The `ge()` function refines a `ItemsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`.\n`ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`." }, { "type": "EXAMPLE", "title": "Add a `ge` filter to a query", "src": "const query = item.queryItems().ge('_createdDate', '2021-03-01');\n" }, { "type": "EXAMPLE", "title": "Create a query, add a `ge` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item\n .queryItems()\n .ge('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/gt": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items where the specified property is greater than the specified value." }, { "type": "DESCRIPTION", "title": "description", "src": "The `gt()` function refines a `ItemsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`.\n`gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`." }, { "type": "EXAMPLE", "title": "Add a `gt` filter to a query", "src": "const query = item.queryItems().gt('_createdDate', '2021-03-01');\n" }, { "type": "EXAMPLE", "title": "Create a query, add a `gt` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item\n .queryItems()\n .gt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/hasNext": [ { "type": "SUMMARY", "title": "summary", "src": "Indicates whether the query has more results." }, { "type": "DESCRIPTION", "title": "description", "src": "You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `item` to navigate the pages of a query result." }, { "type": "EXAMPLE", "title": "Get whether the query has more results", "src": "const hasNext = results.hasNext();\n" }, { "type": "EXAMPLE", "title": "Perform a query and get `hasNext` from the result", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n return results.hasNext();\n}\n" } ], "/queryProperties/hasPrev": [ { "type": "SUMMARY", "title": "summary", "src": "Indicates whether the query has previous results." }, { "type": "DESCRIPTION", "title": "description", "src": "You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `item` to navigate the pages of a query result." }, { "type": "EXAMPLE", "title": "Get whether the query has previous results", "src": "const hasPrev = results.hasPrev();\n" }, { "type": "EXAMPLE", "title": "Perform a query and get `hasPrev` from the result", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n return results.hasPrev();\n}\n" } ], "/queryProperties/hasSome": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items whose specified property contains any of the specified values." }, { "type": "DESCRIPTION", "title": "description", "src": "The `hasSome()` function refines a `ItemsQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.\nMatching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values." }, { "type": "EXAMPLE", "title": "Add a `hasSome` filter to a query", "src": "const query = item.queryItems().hasSome('labelIds', ['red', 'blue', 'purple']);\n" }, { "type": "EXAMPLE", "title": "Create a query, add a `hasSome` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item\n .queryItems()\n .hasSome('labelIds', ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/in": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to only match items where the specified property contains any of the values in the provided array of values." }, { "type": "DESCRIPTION", "title": "description", "src": "The `in()` function refines a `ItemsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`." }, { "type": "EXAMPLE", "title": "Add an `in` filter to a query", "src": "const query = item\n .queryItems()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple']);\n" }, { "type": "EXAMPLE", "title": "Create a query, add an `in` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item\n .queryItems()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/items": [ { "type": "SUMMARY", "title": "summary", "src": "Returns an array of `item` items that match the query." }, { "type": "DESCRIPTION", "title": "description", "src": "`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](/items-query-builder/limit) function and can be retrieved using the [`pageSize`](}/items-query-result/page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `item` to navigate the pages of a query result." }, { "type": "EXAMPLE", "title": "Get `items` from a query result", "src": "const returnedItems = results.items;\n" }, { "type": "EXAMPLE", "title": "Perform a query and get `items` from the result", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/le": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items where the specified property is less than or equal to the specified value." }, { "type": "DESCRIPTION", "title": "description", "src": "The `le()` function refines a `ItemsQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`." }, { "type": "EXAMPLE", "title": "Add an `le` filter to a query", "src": "const query = item.queryItems().le('_createdDate', '2021-03-01');\n" }, { "type": "EXAMPLE", "title": "Create a query, add an `le` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item\n .queryItems()\n .le('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/length": [ { "type": "SUMMARY", "title": "summary", "src": "Returns the number of items in the current page of results." }, { "type": "DESCRIPTION", "title": "description", "src": "`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](}/items-query-result/total-count).\nThe page size is defined by the [`limit()`](/items-query-builder/limit) function and can be retrieved using the [`pageSize`](}/items-query-result/page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `item` to navigate the pages of a query result." }, { "type": "EXAMPLE", "title": "Get `length` from a query result", "src": "const resultLength = results.length;\n" }, { "type": "EXAMPLE", "title": "Perform a query and get `length` from the result", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n return results.length;\n}\n" } ], "/queryProperties/limit": [ { "type": "SUMMARY", "title": "summary", "src": "Limits the number of items the query returns." }, { "type": "DESCRIPTION", "title": "description", "src": "The `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result." }, { "type": "EXAMPLE", "title": "Add a `limit` to a query", "src": "const query = item.queryItems().limit(10);\n" }, { "type": "EXAMPLE", "title": "Create a query, add a `limit`, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/lt": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items where the specified property is less than the specified value." }, { "type": "DESCRIPTION", "title": "description", "src": "The `le()` function refines a `ItemsQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`." }, { "type": "EXAMPLE", "title": "Add an `lt` filter to a query", "src": "const query = item.queryItems().lt('_createdDate', '2021-03-01');\n" }, { "type": "EXAMPLE", "title": "Create a query, add an `lt` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item\n .queryItems()\n .lt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/ne": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items where the specified property doesn't equal the specified value." }, { "type": "DESCRIPTION", "title": "description", "src": "The `ne()` function refines a `ItemsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`." }, { "type": "EXAMPLE", "title": "Add an `ne` filter to a query", "src": "const query = item\n .queryItems()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da');\n" }, { "type": "EXAMPLE", "title": "Create a query, add an `ne` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item\n .queryItems()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/queryProperties/next": [ { "type": "SUMMARY", "title": "summary", "src": "Retrieves the next page of query results." }, { "type": "DESCRIPTION", "title": "description", "src": "The `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](/items-query-builder/limit) function and can be retrieved using the [`pageSize`](}/items-query-result/page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `item` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `ItemsQueryBuilder` may change." }, { "type": "EXAMPLE", "title": "Get `next` from a query result", "src": "const nextPage = results.next();\n" }, { "type": "EXAMPLE", "title": "Perform a query and get `next` from the result", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n return results.next();\n}\n" }, { "type": "EXAMPLE", "title": "Iterate through all pages of query results", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await item.queryItems().limit(1000).find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n" } ], "/queryProperties/pageSize": [ { "type": "SUMMARY", "title": "summary", "src": "Returns the requested page size." }, { "type": "DESCRIPTION", "title": "description", "src": "`pageSize` returns the page size set in [`limit()`](/items-query-builder/limit) in `ItemsQueryBuilder`." }, { "type": "EXAMPLE", "title": "Get the query's page size", "src": "const requestedPageSize = results.pageSize;\n" }, { "type": "EXAMPLE", "title": "Perform a query and get `pageSize` from the result", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n return results.pageSize;\n}\n" } ], "/queryProperties/prev": [ { "type": "SUMMARY", "title": "summary", "src": "Retrieves the previous page of query results." }, { "type": "DESCRIPTION", "title": "description", "src": "The `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](/items-query-builder/limit) function and can be retrieved using the [`pageSize`](}/items-query-result/page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `item` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change." }, { "type": "EXAMPLE", "title": "Get `prev` from a query result", "src": "const previousPage = results.prev();\n" }, { "type": "EXAMPLE", "title": "Perform a query and get `prev` from the result", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n return results.prev();\n}\n" } ], "/queryProperties/query": [ { "type": "SUMMARY", "title": "summary", "src": "Returns the `ItemsQueryBuilder` object used to get the current results." }, { "type": "DESCRIPTION", "title": "description", "src": "Use `query` to create and run a new query by chaining additional `ItemsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `ItemsQueryBuilder`." }, { "type": "EXAMPLE", "title": "Get `query` that produced the current result", "src": "const originalQuery = results.query;\n" }, { "type": "EXAMPLE", "title": "Perform a query and get `query` from the result", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n return results.query;\n}\n" } ], "/queryProperties/skipTo": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query that skips to a specific record." }, { "type": "DESCRIPTION", "title": "description", "src": "The `skipTo()` function refines a `ItemsQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.\n \nWhen using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed." }, { "type": "EXAMPLE", "title": "Perform a query and skip to the next cursor", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n const nextCursor = results.cursors.next;\n return item.queryItems().skipTo(nextCursor).find();\n}\n" }, { "type": "EXAMPLE", "title": "Perform a query and skip to the previous cursor", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems().find();\n\n const prevCursor = results.cursors.prev;\n return item.queryItems().skipTo(prevCursor).find();\n}\n" } ], "/queryProperties/startsWith": [ { "type": "SUMMARY", "title": "summary", "src": "Refines a query to match items where the specified property starts with the specified value." }, { "type": "DESCRIPTION", "title": "description", "src": "The `startsWith()` function refines a `ItemsQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.\nMatching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.\nYou can only use `startsWith()` with a property whose value is a string." }, { "type": "EXAMPLE", "title": "Add a `startsWith` filter to a query", "src": "const query = item.queryItems().startsWith('_id', 'L');\n" }, { "type": "EXAMPLE", "title": "Create a query, add a `startsWith` filter, and run it", "src": "import { item } from '@wix/benefit-programs';\n\nexport async function myQueryFunction() {\n const results = await item.queryItems();\n startsWith('_id', 'L').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n" } ], "/updateItem": [ { "type": "EXAMPLE", "title": "updateItem: Wix-hosted", "src": "import { item } from '@wix/benefit-programs';\n\nasync function updateItem(id, item) {\n const response = await item.updateItem(id, item);\n};" }, { "type": "EXAMPLE", "title": "updateItem: Self-hosted", "src": "import { createClient } from '@wix/sdk';\nimport { item } from '@wix/benefit-programs';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { item },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updateItem(id, item) {\n const response = await myWixClient.item.updateItem(id, item);\n};", "description": "Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client)." } ] }, "standaloneTypes": {}, "metadata": { "fqdn": "wix.benefit_programs.v1.item" } }