@wix/auto_sdk_benefit-programs_pool-definition-items 1.0.7 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/build/cjs/index.d.ts +8 -3
  2. package/build/cjs/index.js +249 -2
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +188 -2
  5. package/build/cjs/index.typings.js +223 -2
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +3 -2
  8. package/build/cjs/meta.js +52 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +52 -1
  11. package/build/cjs/schemas.js +101 -0
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +8 -3
  14. package/build/es/index.mjs +250 -2
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +188 -2
  17. package/build/es/index.typings.mjs +223 -2
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +3 -2
  20. package/build/es/meta.mjs +51 -0
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +52 -1
  23. package/build/es/schemas.mjs +99 -0
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +8 -3
  26. package/build/internal/cjs/index.js +249 -2
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +188 -2
  29. package/build/internal/cjs/index.typings.js +223 -2
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +3 -2
  32. package/build/internal/cjs/meta.js +52 -0
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/schemas.d.ts +52 -1
  35. package/build/internal/cjs/schemas.js +101 -0
  36. package/build/internal/cjs/schemas.js.map +1 -1
  37. package/build/internal/es/index.d.mts +8 -3
  38. package/build/internal/es/index.mjs +250 -2
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +188 -2
  41. package/build/internal/es/index.typings.mjs +223 -2
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +3 -2
  44. package/build/internal/es/meta.mjs +51 -0
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/schemas.d.mts +52 -1
  47. package/build/internal/es/schemas.mjs +99 -0
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +2 -2
@@ -1,4 +1,5 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
1
+ import * as _wix_sdk_types from '@wix/sdk-types';
2
+ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
2
3
 
3
4
  interface PoolDefinitionItem {
4
5
  /**
@@ -522,6 +523,191 @@ interface AccountInfo {
522
523
  */
523
524
  siteId?: string | null;
524
525
  }
526
+ /**
527
+ * Creates a query to retrieve a list of poolDefinitionItems.
528
+ *
529
+ * The `queryPoolDefinitionItems()` method builds a query to retrieve a list of poolDefinitionItems and returns a `PoolDefinitionItemsQueryBuilder` object.
530
+ *
531
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/poolDefinitionItems/poolDefinitionItems-query-builder/find) function.
532
+ *
533
+ * You can refine the query by chaining `PoolDefinitionItemsQueryBuilder` methods onto the query. `PoolDefinitionItemsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPoolDefinitionItems()` returns.
534
+ *
535
+ * The following `PoolDefinitionItemsQueryBuilder` functions are supported for `queryPoolDefinitionItems()`. For a full description of the item object, see the object returned for the [`poolDefinitionItems`](/poolDefinitionItems/poolDefinitionItems-query-result/poolDefinitionItems) property in `PoolDefinitionItemsQueryResult`.
536
+ * @public
537
+ * @documentationMaturity preview
538
+ * @permissionId benefit_programs:v1:pool_definition_item:query_pool_definition_items
539
+ * @applicableIdentity APP
540
+ * @fqn wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.QueryPoolDefinitionItems
541
+ */
542
+ declare function queryPoolDefinitionItems(options?: QueryPoolDefinitionItemsOptions): PoolDefinitionItemsQueryBuilder;
543
+ interface QueryPoolDefinitionItemsOptions {
544
+ /**
545
+ * Fields to be included in the response.
546
+ * @maxSize 4
547
+ */
548
+ fields?: RequestedFieldsWithLiterals[] | undefined;
549
+ }
550
+ interface QueryCursorResult {
551
+ cursors: Cursors;
552
+ hasNext: () => boolean;
553
+ hasPrev: () => boolean;
554
+ length: number;
555
+ pageSize: number;
556
+ }
557
+ interface PoolDefinitionItemsQueryResult extends QueryCursorResult {
558
+ items: PoolDefinitionItem[];
559
+ query: PoolDefinitionItemsQueryBuilder;
560
+ next: () => Promise<PoolDefinitionItemsQueryResult>;
561
+ prev: () => Promise<PoolDefinitionItemsQueryResult>;
562
+ }
563
+ interface PoolDefinitionItemsQueryBuilder {
564
+ /** @param propertyName - Property whose value is compared with `value`.
565
+ * @param value - Value to compare against.
566
+ * @documentationMaturity preview
567
+ */
568
+ eq: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: any) => PoolDefinitionItemsQueryBuilder;
569
+ /** @param propertyName - Property whose value is compared with `value`.
570
+ * @param value - Value to compare against.
571
+ * @documentationMaturity preview
572
+ */
573
+ ne: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: any) => PoolDefinitionItemsQueryBuilder;
574
+ /** @param propertyName - Property whose value is compared with `value`.
575
+ * @param value - Value to compare against.
576
+ * @documentationMaturity preview
577
+ */
578
+ ge: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: any) => PoolDefinitionItemsQueryBuilder;
579
+ /** @param propertyName - Property whose value is compared with `value`.
580
+ * @param value - Value to compare against.
581
+ * @documentationMaturity preview
582
+ */
583
+ gt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: any) => PoolDefinitionItemsQueryBuilder;
584
+ /** @param propertyName - Property whose value is compared with `value`.
585
+ * @param value - Value to compare against.
586
+ * @documentationMaturity preview
587
+ */
588
+ le: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: any) => PoolDefinitionItemsQueryBuilder;
589
+ /** @param propertyName - Property whose value is compared with `value`.
590
+ * @param value - Value to compare against.
591
+ * @documentationMaturity preview
592
+ */
593
+ lt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: any) => PoolDefinitionItemsQueryBuilder;
594
+ /** @param propertyName - Property whose value is compared with `string`.
595
+ * @param string - String to compare against. Case-insensitive.
596
+ * @documentationMaturity preview
597
+ */
598
+ startsWith: (propertyName: '_id' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: string) => PoolDefinitionItemsQueryBuilder;
599
+ /** @param propertyName - Property whose value is compared with `values`.
600
+ * @param values - List of values to compare against.
601
+ * @documentationMaturity preview
602
+ */
603
+ hasSome: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: any[]) => PoolDefinitionItemsQueryBuilder;
604
+ /** @documentationMaturity preview */
605
+ in: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: any) => PoolDefinitionItemsQueryBuilder;
606
+ /** @documentationMaturity preview */
607
+ exists: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey', value: boolean) => PoolDefinitionItemsQueryBuilder;
608
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
609
+ * @documentationMaturity preview
610
+ */
611
+ ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey'>) => PoolDefinitionItemsQueryBuilder;
612
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
613
+ * @documentationMaturity preview
614
+ */
615
+ descending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey'>) => PoolDefinitionItemsQueryBuilder;
616
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
617
+ * @documentationMaturity preview
618
+ */
619
+ limit: (limit: number) => PoolDefinitionItemsQueryBuilder;
620
+ /** @param cursor - A pointer to specific record
621
+ * @documentationMaturity preview
622
+ */
623
+ skipTo: (cursor: string) => PoolDefinitionItemsQueryBuilder;
624
+ /** @documentationMaturity preview */
625
+ find: () => Promise<PoolDefinitionItemsQueryResult>;
626
+ }
627
+ /**
628
+ * @hidden
629
+ * @fqn wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.QueryPoolDefinitionItems
630
+ * @requiredField query
631
+ */
632
+ declare function typedQueryPoolDefinitionItems(query: PoolDefinitionItemQuery, options?: QueryPoolDefinitionItemsOptions): Promise<NonNullablePaths<QueryPoolDefinitionItemsResponse, `poolDefinitionItems` | `poolDefinitionItems.${number}._id` | `poolDefinitionItems.${number}.externalId` | `poolDefinitionItems.${number}.category` | `poolDefinitionItems.${number}.providerAppId` | `poolDefinitionItems.${number}.namespace` | `poolDefinitionItems.${number}.poolDefinitionId` | `poolDefinitionItems.${number}.itemSetId` | `poolDefinitionItems.${number}.itemId` | `poolDefinitionItems.${number}.benefitKey`, 4>>;
633
+ interface PoolDefinitionItemQuerySpec extends QuerySpec {
634
+ paging: 'cursor';
635
+ wql: [
636
+ {
637
+ fields: ['programDefinitions._id', 'programDefinitions.externalId'];
638
+ operators: ['$hasAll', '$hasSome'];
639
+ sort: 'BOTH';
640
+ },
641
+ {
642
+ fields: [
643
+ '_createdDate',
644
+ '_id',
645
+ 'benefitKey',
646
+ 'category',
647
+ 'externalId',
648
+ 'itemSetId',
649
+ 'namespace',
650
+ 'poolDefinitionId',
651
+ 'providerAppId'
652
+ ];
653
+ operators: '*';
654
+ sort: 'BOTH';
655
+ }
656
+ ];
657
+ }
658
+ type CommonQueryWithEntityContext = Query<PoolDefinitionItem, PoolDefinitionItemQuerySpec>;
659
+ type PoolDefinitionItemQuery = {
660
+ /**
661
+ Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
662
+ */
663
+ cursorPaging?: {
664
+ /**
665
+ Maximum number of items to return in the results.
666
+ @max: 1000
667
+ */
668
+ limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
669
+ /**
670
+ Pointer to the next or previous page in the list of results.
671
+
672
+ Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
673
+ Not relevant for the first request.
674
+ @maxLength: 16000
675
+ */
676
+ cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
677
+ };
678
+ /**
679
+ Filter object in the following format:
680
+ `"filter" : {
681
+ "fieldName1": "value1",
682
+ "fieldName2":{"$operator":"value2"}
683
+ }`
684
+ Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
685
+ */
686
+ filter?: CommonQueryWithEntityContext['filter'] | null;
687
+ /**
688
+ Sort object in the following format:
689
+ `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
690
+ @maxSize: 5
691
+ */
692
+ sort?: {
693
+ /**
694
+ Name of the field to sort by.
695
+ @maxLength: 512
696
+ */
697
+ fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
698
+ /**
699
+ Sort order.
700
+ */
701
+ order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
702
+ }[];
703
+ };
704
+ declare const utils: {
705
+ query: {
706
+ QueryBuilder: () => _wix_sdk_types.QueryBuilder<PoolDefinitionItem, PoolDefinitionItemQuerySpec, PoolDefinitionItemQuery>;
707
+ Filter: _wix_sdk_types.FilterFactory<PoolDefinitionItem, PoolDefinitionItemQuerySpec>;
708
+ Sort: _wix_sdk_types.SortFactory<PoolDefinitionItemQuerySpec>;
709
+ };
710
+ };
525
711
  /**
526
712
  * Removes items from a benefit's item set, resolved by pool definition ID and benefit key.
527
713
  * @param itemReferences - Items to remove from the benefit's item set.
@@ -577,4 +763,4 @@ interface AddItemsToBenefitOptions {
577
763
  benefitKey: string;
578
764
  }
579
765
 
580
- export { type AccountInfo, type ActionEvent, type AddItemsToBenefitOptions, type AddItemsToBenefitRequest, type AddItemsToBenefitResponse, type BenefitInfo, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type IdentificationData, type IdentificationDataIdOneOf, type InvalidatePoolDefinitionItemsRequest, type InvalidatePoolDefinitionItemsResponse, type ItemInfo, type ItemReference, type MessageEnvelope, type PoolDefinitionInfo, type PoolDefinitionItem, type PoolDefinitionItemDeactivated, type ProgramDefinitionInfo, type QueryPoolDefinitionItemsRequest, type QueryPoolDefinitionItemsResponse, type RemoveItemsFromBenefitOptions, type RemoveItemsFromBenefitRequest, type RemoveItemsFromBenefitResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addItemsToBenefit, removeItemsFromBenefit };
766
+ export { type AccountInfo, type ActionEvent, type AddItemsToBenefitOptions, type AddItemsToBenefitRequest, type AddItemsToBenefitResponse, type BenefitInfo, type CommonQueryWithEntityContext, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type IdentificationData, type IdentificationDataIdOneOf, type InvalidatePoolDefinitionItemsRequest, type InvalidatePoolDefinitionItemsResponse, type ItemInfo, type ItemReference, type MessageEnvelope, type PoolDefinitionInfo, type PoolDefinitionItem, type PoolDefinitionItemDeactivated, type PoolDefinitionItemQuery, type PoolDefinitionItemQuerySpec, type PoolDefinitionItemsQueryBuilder, type PoolDefinitionItemsQueryResult, type ProgramDefinitionInfo, type QueryPoolDefinitionItemsOptions, type QueryPoolDefinitionItemsRequest, type QueryPoolDefinitionItemsResponse, type RemoveItemsFromBenefitOptions, type RemoveItemsFromBenefitRequest, type RemoveItemsFromBenefitResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addItemsToBenefit, queryPoolDefinitionItems, removeItemsFromBenefit, typedQueryPoolDefinitionItems, utils };
@@ -34,15 +34,21 @@ __export(index_typings_exports, {
34
34
  SortOrder: () => SortOrder,
35
35
  WebhookIdentityType: () => WebhookIdentityType,
36
36
  addItemsToBenefit: () => addItemsToBenefit2,
37
- removeItemsFromBenefit: () => removeItemsFromBenefit2
37
+ queryPoolDefinitionItems: () => queryPoolDefinitionItems2,
38
+ removeItemsFromBenefit: () => removeItemsFromBenefit2,
39
+ typedQueryPoolDefinitionItems: () => typedQueryPoolDefinitionItems,
40
+ utils: () => utils
38
41
  });
39
42
  module.exports = __toCommonJS(index_typings_exports);
40
43
 
41
44
  // src/benefit-programs-v1-pool-definition-item-pool-definition-items.universal.ts
42
45
  var import_transform_error = require("@wix/sdk-runtime/transform-error");
46
+ var import_query_builder = require("@wix/sdk-runtime/query-builder");
43
47
  var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
44
48
 
45
49
  // src/benefit-programs-v1-pool-definition-item-pool-definition-items.http.ts
50
+ var import_timestamp = require("@wix/sdk-runtime/transformations/timestamp");
51
+ var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
46
52
  var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
47
53
  function resolveWixBenefitProgramsV1PoolDefinitionItemPoolDefinitionItemServiceUrl(opts) {
48
54
  const domainToMappings = {
@@ -68,6 +74,34 @@ function resolveWixBenefitProgramsV1PoolDefinitionItemPoolDefinitionItemServiceU
68
74
  return (0, import_rest_modules.resolveUrl)(Object.assign(opts, { domainToMappings }));
69
75
  }
70
76
  var PACKAGE_NAME = "@wix/auto_sdk_benefit-programs_pool-definition-items";
77
+ function queryPoolDefinitionItems(payload) {
78
+ function __queryPoolDefinitionItems({ host }) {
79
+ const metadata = {
80
+ entityFqdn: "wix.benefit_programs.v1.pool_definition_item",
81
+ method: "POST",
82
+ methodFqn: "wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.QueryPoolDefinitionItems",
83
+ packageName: PACKAGE_NAME,
84
+ migrationOptions: {
85
+ optInTransformResponse: true
86
+ },
87
+ url: resolveWixBenefitProgramsV1PoolDefinitionItemPoolDefinitionItemServiceUrl(
88
+ { protoPath: "/v1/pool-definition-items/query", data: payload, host }
89
+ ),
90
+ data: payload,
91
+ transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
92
+ {
93
+ transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
94
+ paths: [
95
+ { path: "poolDefinitionItems.createdDate" },
96
+ { path: "poolDefinitionItems.updatedDate" }
97
+ ]
98
+ }
99
+ ])
100
+ };
101
+ return metadata;
102
+ }
103
+ return __queryPoolDefinitionItems;
104
+ }
71
105
  function removeItemsFromBenefit(payload) {
72
106
  function __removeItemsFromBenefit({ host }) {
73
107
  const metadata = {
@@ -115,8 +149,108 @@ function addItemsToBenefit(payload) {
115
149
  return __addItemsToBenefit;
116
150
  }
117
151
 
152
+ // src/benefit-programs-v1-pool-definition-item-pool-definition-items.universal.ts
153
+ var import_transform_paths2 = require("@wix/sdk-runtime/transformations/transform-paths");
154
+
118
155
  // src/benefit-programs-v1-pool-definition-item-pool-definition-items.schemas.ts
119
156
  var z = __toESM(require("zod"));
157
+ var QueryPoolDefinitionItemsRequest = z.object({
158
+ query: z.intersection(
159
+ z.object({
160
+ filter: z.record(z.string(), z.any()).describe(
161
+ 'Filter object in the following format:\n`"filter" : {\n"fieldName1": "value1",\n"fieldName2":{"$operator":"value2"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`'
162
+ ).optional().nullable(),
163
+ sort: z.array(
164
+ z.object({
165
+ fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
166
+ order: z.enum(["ASC", "DESC"]).optional()
167
+ })
168
+ ).max(5).optional()
169
+ }),
170
+ z.xor([
171
+ z.object({ cursorPaging: z.never().optional() }),
172
+ z.object({
173
+ cursorPaging: z.object({
174
+ limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(1e3).optional().nullable(),
175
+ cursor: z.string().describe(
176
+ "Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
177
+ ).max(16e3).optional().nullable()
178
+ }).describe(
179
+ "Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`."
180
+ )
181
+ })
182
+ ])
183
+ ).describe("Query to select benefit items."),
184
+ options: z.object({
185
+ fields: z.array(
186
+ z.enum(["POOL_DEFINITION", "PROGRAM_DEFINITION", "BENEFIT", "ITEM"])
187
+ ).max(4).optional()
188
+ }).optional()
189
+ });
190
+ var QueryPoolDefinitionItemsResponse = z.object({
191
+ poolDefinitionItems: z.array(
192
+ z.object({
193
+ _id: z.string().describe("Benefit item ID.").regex(
194
+ /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
195
+ "Must be a valid GUID"
196
+ ).optional(),
197
+ revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
198
+ "Revision number, which increments by 1 each time the benefit item is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the item.\n\nIgnored when creating an item."
199
+ ).optional().nullable(),
200
+ _createdDate: z.date().describe("Date and time the item was created.").optional().nullable(),
201
+ _updatedDate: z.date().describe("Date and time the item was updated.").optional().nullable(),
202
+ externalId: z.string().describe(
203
+ "External item ID assigned by the provider of the items.\n\nFor example, if the benefit items are products, this ID corresponds to the specific product ID in the supplier's system."
204
+ ).regex(
205
+ /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
206
+ "Must be a valid GUID"
207
+ ).optional(),
208
+ category: z.string().describe(
209
+ "Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups."
210
+ ).max(20).optional(),
211
+ providerAppId: z.string().describe(
212
+ "ID of the application providing the benefit item.\n\nID of the external application supplying the items. Each item's external ID is unique to its respective provider's application."
213
+ ).regex(
214
+ /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
215
+ "Must be a valid GUID"
216
+ ).optional(),
217
+ namespace: z.string().describe(
218
+ "Module name of the item provider's application that originated the items.\n\nFor example, `store-inventory` or `fitness-resources`."
219
+ ).min(1).max(20).optional(),
220
+ poolDefinitionId: z.string().describe("Pool definition id").regex(
221
+ /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
222
+ "Must be a valid GUID"
223
+ ).optional(),
224
+ itemSetId: z.string().describe("Item set ID.").regex(
225
+ /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
226
+ "Must be a valid GUID"
227
+ ).optional(),
228
+ itemId: z.string().describe("Item set ID.").regex(
229
+ /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
230
+ "Must be a valid GUID"
231
+ ).optional(),
232
+ benefitKey: z.string().describe(
233
+ "Unique identifier for the benefit associated with this item."
234
+ ).max(64).optional()
235
+ })
236
+ ).optional(),
237
+ metadata: z.object({
238
+ count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
239
+ cursors: z.object({
240
+ next: z.string().describe(
241
+ "Cursor string pointing to the next page in the list of results."
242
+ ).max(16e3).optional().nullable(),
243
+ prev: z.string().describe(
244
+ "Cursor pointing to the previous page in the list of results."
245
+ ).max(16e3).optional().nullable()
246
+ }).describe(
247
+ "Cursor strings that point to the next page, previous page, or both."
248
+ ).optional(),
249
+ hasNext: z.boolean().describe(
250
+ "Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page."
251
+ ).optional().nullable()
252
+ }).describe("Metadata for paginated results.").optional()
253
+ });
120
254
  var RemoveItemsFromBenefitRequest = z.object({
121
255
  itemReferences: z.array(
122
256
  z.object({
@@ -157,6 +291,7 @@ var AddItemsToBenefitRequest = z.object({
157
291
  var AddItemsToBenefitResponse = z.object({});
158
292
 
159
293
  // src/benefit-programs-v1-pool-definition-item-pool-definition-items.universal.ts
294
+ var import_query_builder_utils = require("@wix/sdk-runtime/query-builder-utils");
160
295
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
161
296
  SortOrder2["ASC"] = "ASC";
162
297
  SortOrder2["DESC"] = "DESC";
@@ -177,6 +312,89 @@ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
177
312
  WebhookIdentityType2["APP"] = "APP";
178
313
  return WebhookIdentityType2;
179
314
  })(WebhookIdentityType || {});
315
+ function queryPoolDefinitionItems2(options) {
316
+ const { httpClient, sideEffects } = arguments[1];
317
+ return (0, import_query_builder.queryBuilder)({
318
+ func: async (payload) => {
319
+ const reqOpts = queryPoolDefinitionItems(
320
+ { ...payload, ...options ?? {} }
321
+ );
322
+ sideEffects?.onSiteCall?.();
323
+ try {
324
+ const result = await httpClient.request(reqOpts);
325
+ sideEffects?.onSuccess?.(result);
326
+ return result;
327
+ } catch (err) {
328
+ sideEffects?.onError?.(err);
329
+ throw err;
330
+ }
331
+ },
332
+ requestTransformer: (query) => {
333
+ const args = [query, options];
334
+ return (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
335
+ ...args?.[1],
336
+ query: args?.[0]
337
+ });
338
+ },
339
+ responseTransformer: ({
340
+ data
341
+ }) => {
342
+ const transformedData = (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(
343
+ (0, import_transform_paths2.transformPaths)(data, [])
344
+ );
345
+ return {
346
+ items: transformedData?.poolDefinitionItems,
347
+ pagingMetadata: transformedData?.metadata
348
+ };
349
+ },
350
+ errorTransformer: (err) => {
351
+ const transformedError = (0, import_transform_error.transformError)(err, {
352
+ spreadPathsToArguments: {},
353
+ explicitPathsToArguments: { query: "$[0]" },
354
+ singleArgumentUnchanged: false
355
+ });
356
+ throw transformedError;
357
+ },
358
+ pagingMethod: "CURSOR",
359
+ transformationPaths: {}
360
+ });
361
+ }
362
+ async function typedQueryPoolDefinitionItems(query, options) {
363
+ const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
364
+ if (validateRequestSchema) {
365
+ QueryPoolDefinitionItemsRequest.parse({ query, options });
366
+ }
367
+ const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
368
+ query,
369
+ ...options
370
+ });
371
+ const reqOpts = queryPoolDefinitionItems(
372
+ payload
373
+ );
374
+ sideEffects?.onSiteCall?.();
375
+ try {
376
+ const result = await httpClient.request(reqOpts);
377
+ sideEffects?.onSuccess?.(result);
378
+ return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
379
+ } catch (err) {
380
+ const transformedError = (0, import_transform_error.transformError)(
381
+ err,
382
+ {
383
+ spreadPathsToArguments: {},
384
+ explicitPathsToArguments: { query: "$[0]" },
385
+ singleArgumentUnchanged: false
386
+ },
387
+ ["query", "options"]
388
+ );
389
+ sideEffects?.onError?.(err);
390
+ throw transformedError;
391
+ }
392
+ }
393
+ var utils = {
394
+ query: {
395
+ ...(0, import_query_builder_utils.createQueryUtils)()
396
+ }
397
+ };
180
398
  async function removeItemsFromBenefit2(itemReferences, options) {
181
399
  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
182
400
  if (validateRequestSchema) {
@@ -251,6 +469,9 @@ async function addItemsToBenefit2(itemReferences, options) {
251
469
  SortOrder,
252
470
  WebhookIdentityType,
253
471
  addItemsToBenefit,
254
- removeItemsFromBenefit
472
+ queryPoolDefinitionItems,
473
+ removeItemsFromBenefit,
474
+ typedQueryPoolDefinitionItems,
475
+ utils
255
476
  });
256
477
  //# sourceMappingURL=index.typings.js.map