@wix/auto_sdk_benefit-programs_pool-definitions 1.0.58 → 1.0.59

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.
@@ -1,9 +1,7 @@
1
1
  "use strict";
2
- var __create = Object.create;
3
2
  var __defProp = Object.defineProperty;
4
3
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
4
  var __getOwnPropNames = Object.getOwnPropertyNames;
6
- var __getProtoOf = Object.getPrototypeOf;
7
5
  var __hasOwnProp = Object.prototype.hasOwnProperty;
8
6
  var __export = (target, all) => {
9
7
  for (var name in all)
@@ -17,14 +15,6 @@ var __copyProps = (to, from, except, desc) => {
17
15
  }
18
16
  return to;
19
17
  };
20
- var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
21
- // If the importer is in node compatibility mode or this is not an ESM
22
- // file that has been converted to a CommonJS file using a Babel-
23
- // compatible transform (i.e. "__esModule" has not been set), then set
24
- // "default" to the CommonJS "module.exports" for node compatibility.
25
- isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
26
- mod
27
- ));
28
18
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
29
19
 
30
20
  // index.typings.ts
@@ -569,1365 +559,6 @@ function findPoolDefinitionsByProgramDefinition(payload) {
569
559
 
570
560
  // src/benefit-programs-v1-pool-definition-pool-definitions.universal.ts
571
561
  var import_transform_paths2 = require("@wix/sdk-runtime/transformations/transform-paths");
572
-
573
- // src/benefit-programs-v1-pool-definition-pool-definitions.schemas.ts
574
- var z = __toESM(require("zod"));
575
- var CreatePoolDefinitionRequest = z.object({
576
- poolDefinition: z.object({
577
- _id: z.string().describe("Pool definition ID.").regex(
578
- /^[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}$/,
579
- "Must be a valid GUID"
580
- ).optional().nullable(),
581
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
582
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
583
- ).optional().nullable(),
584
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
585
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
586
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
587
- programDefinitionIds: z.array(z.string()).max(20).optional(),
588
- details: z.object({
589
- benefits: z.array(
590
- z.object({
591
- benefitKey: z.string().describe(
592
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
593
- ).max(64),
594
- itemSetId: z.string().describe(
595
- "ID that is used to associated items with this benefit."
596
- ).regex(
597
- /^[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}$/,
598
- "Must be a valid GUID"
599
- ).optional().nullable(),
600
- price: z.string().describe(
601
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
602
- ).optional().nullable(),
603
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
604
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
605
- /^[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}$/,
606
- "Must be a valid GUID"
607
- ),
608
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
609
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
610
- })
611
- ).max(10),
612
- creditConfiguration: z.object({
613
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
614
- rolloverConfiguration: z.object({
615
- enabled: z.boolean().describe(
616
- "Whether unused credits roll over to a new cycle when a program renews."
617
- ).optional().nullable(),
618
- balanceCap: z.string().describe(
619
- "Maximum number of credits that can roll over to the next cycle when a program renews."
620
- ).optional().nullable()
621
- }).describe("Rollover settings.").optional(),
622
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
623
- }).describe(
624
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
625
- ).optional(),
626
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
627
- }).describe("Pool definition benefits and settings."),
628
- namespace: z.string().describe(
629
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
630
- ).min(1).max(20),
631
- extendedFields: z.object({
632
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
633
- "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)."
634
- ).optional()
635
- }).describe(
636
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
637
- ).optional(),
638
- programDefinitions: z.array(
639
- z.object({
640
- _id: z.string().describe("Program definition ID.").regex(
641
- /^[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}$/,
642
- "Must be a valid GUID"
643
- ).optional(),
644
- externalId: z.string().describe("Program definition external ID.").regex(
645
- /^[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}$/,
646
- "Must be a valid GUID"
647
- ).optional().nullable()
648
- })
649
- ).max(20).optional()
650
- }).describe("Pool definition to create."),
651
- options: z.object({
652
- cascade: z.enum([
653
- "UNKNOWN_CASCADE",
654
- "IMMEDIATELY",
655
- "NEXT_RENEWAL",
656
- "FUTURE_PROVISIONS"
657
- ]).optional()
658
- }).optional()
659
- });
660
- var CreatePoolDefinitionResponse = z.object({
661
- _id: z.string().describe("Pool definition ID.").regex(
662
- /^[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}$/,
663
- "Must be a valid GUID"
664
- ).optional().nullable(),
665
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
666
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
667
- ).optional().nullable(),
668
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
669
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
670
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
671
- programDefinitionIds: z.array(z.string()).max(20).optional(),
672
- details: z.object({
673
- benefits: z.array(
674
- z.object({
675
- benefitKey: z.string().describe(
676
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
677
- ).max(64).optional(),
678
- itemSetId: z.string().describe(
679
- "ID that is used to associated items with this benefit."
680
- ).regex(
681
- /^[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}$/,
682
- "Must be a valid GUID"
683
- ).optional().nullable(),
684
- price: z.string().describe(
685
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
686
- ).optional().nullable(),
687
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
688
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
689
- /^[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}$/,
690
- "Must be a valid GUID"
691
- ).optional().nullable(),
692
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
693
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
694
- })
695
- ).max(10).optional(),
696
- creditConfiguration: z.object({
697
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
698
- rolloverConfiguration: z.object({
699
- enabled: z.boolean().describe(
700
- "Whether unused credits roll over to a new cycle when a program renews."
701
- ).optional().nullable(),
702
- balanceCap: z.string().describe(
703
- "Maximum number of credits that can roll over to the next cycle when a program renews."
704
- ).optional().nullable()
705
- }).describe("Rollover settings.").optional(),
706
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
707
- }).describe(
708
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
709
- ).optional(),
710
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
711
- }).describe("Pool definition benefits and settings.").optional(),
712
- namespace: z.string().describe(
713
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
714
- ).min(1).max(20).optional().nullable(),
715
- extendedFields: z.object({
716
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
717
- "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)."
718
- ).optional()
719
- }).describe(
720
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
721
- ).optional(),
722
- programDefinitions: z.array(
723
- z.object({
724
- _id: z.string().describe("Program definition ID.").regex(
725
- /^[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}$/,
726
- "Must be a valid GUID"
727
- ).optional(),
728
- externalId: z.string().describe("Program definition external ID.").regex(
729
- /^[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}$/,
730
- "Must be a valid GUID"
731
- ).optional().nullable()
732
- })
733
- ).max(20).optional()
734
- });
735
- var BulkCreatePoolDefinitionsRequest = z.object({
736
- poolDefinitions: z.array(
737
- z.object({
738
- _id: z.string().describe("Pool definition ID.").regex(
739
- /^[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}$/,
740
- "Must be a valid GUID"
741
- ).optional().nullable(),
742
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
743
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
744
- ).optional().nullable(),
745
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
746
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
747
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
748
- programDefinitionIds: z.array(z.string()).max(20).optional(),
749
- details: z.object({
750
- benefits: z.array(
751
- z.object({
752
- benefitKey: z.string().describe(
753
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
754
- ).max(64),
755
- itemSetId: z.string().describe(
756
- "ID that is used to associated items with this benefit."
757
- ).regex(
758
- /^[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}$/,
759
- "Must be a valid GUID"
760
- ).optional().nullable(),
761
- price: z.string().describe(
762
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
763
- ).optional().nullable(),
764
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
765
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
766
- /^[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}$/,
767
- "Must be a valid GUID"
768
- ),
769
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
770
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
771
- })
772
- ).max(10),
773
- creditConfiguration: z.object({
774
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
775
- rolloverConfiguration: z.object({
776
- enabled: z.boolean().describe(
777
- "Whether unused credits roll over to a new cycle when a program renews."
778
- ).optional().nullable(),
779
- balanceCap: z.string().describe(
780
- "Maximum number of credits that can roll over to the next cycle when a program renews."
781
- ).optional().nullable()
782
- }).describe("Rollover settings.").optional(),
783
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
784
- }).describe(
785
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
786
- ).optional(),
787
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
788
- }).describe("Pool definition benefits and settings."),
789
- namespace: z.string().describe(
790
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
791
- ).min(1).max(20),
792
- extendedFields: z.object({
793
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
794
- "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)."
795
- ).optional()
796
- }).describe(
797
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
798
- ).optional(),
799
- programDefinitions: z.array(
800
- z.object({
801
- _id: z.string().describe("Program definition ID.").regex(
802
- /^[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}$/,
803
- "Must be a valid GUID"
804
- ).optional(),
805
- externalId: z.string().describe("Program definition external ID.").regex(
806
- /^[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}$/,
807
- "Must be a valid GUID"
808
- ).optional().nullable()
809
- })
810
- ).max(20).optional()
811
- })
812
- ).min(1).max(100),
813
- options: z.object({
814
- cascade: z.enum([
815
- "UNKNOWN_CASCADE",
816
- "IMMEDIATELY",
817
- "NEXT_RENEWAL",
818
- "FUTURE_PROVISIONS"
819
- ]).optional(),
820
- returnEntity: z.boolean().describe(
821
- "Whether to return the created pool definitions.\n\nDefault: `false`"
822
- ).optional()
823
- }).optional()
824
- });
825
- var BulkCreatePoolDefinitionsResponse = z.object({
826
- results: z.array(
827
- z.object({
828
- itemMetadata: z.object({
829
- _id: z.string().describe(
830
- "Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
831
- ).regex(
832
- /^[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}$/,
833
- "Must be a valid GUID"
834
- ).optional().nullable(),
835
- originalIndex: z.number().int().describe(
836
- "Index of the item within the request array. Allows for correlation between request and response items."
837
- ).optional(),
838
- success: z.boolean().describe(
839
- "Whether the requested action was successful for this item. When `false`, the `error` field is populated."
840
- ).optional(),
841
- error: z.object({
842
- code: z.string().describe("Error code.").optional(),
843
- description: z.string().describe("Description of the error.").optional(),
844
- data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
845
- }).describe("Details about the error in case of failure.").optional()
846
- }).describe("Item metadata.").optional(),
847
- item: z.object({
848
- _id: z.string().describe("Pool definition ID.").regex(
849
- /^[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}$/,
850
- "Must be a valid GUID"
851
- ).optional().nullable(),
852
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
853
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
854
- ).optional().nullable(),
855
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
856
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
857
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
858
- programDefinitionIds: z.array(z.string()).max(20).optional(),
859
- details: z.object({
860
- benefits: z.array(
861
- z.object({
862
- benefitKey: z.string().describe(
863
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
864
- ).max(64).optional(),
865
- itemSetId: z.string().describe(
866
- "ID that is used to associated items with this benefit."
867
- ).regex(
868
- /^[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}$/,
869
- "Must be a valid GUID"
870
- ).optional().nullable(),
871
- price: z.string().describe(
872
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
873
- ).optional().nullable(),
874
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
875
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
876
- /^[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}$/,
877
- "Must be a valid GUID"
878
- ).optional().nullable(),
879
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
880
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
881
- })
882
- ).max(10).optional(),
883
- creditConfiguration: z.object({
884
- amount: z.string().describe(
885
- "Initial available amount for associated balances."
886
- ).optional(),
887
- rolloverConfiguration: z.object({
888
- enabled: z.boolean().describe(
889
- "Whether unused credits roll over to a new cycle when a program renews."
890
- ).optional().nullable(),
891
- balanceCap: z.string().describe(
892
- "Maximum number of credits that can roll over to the next cycle when a program renews."
893
- ).optional().nullable()
894
- }).describe("Rollover settings.").optional(),
895
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
896
- }).describe(
897
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
898
- ).optional(),
899
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
900
- }).describe("Pool definition benefits and settings.").optional(),
901
- namespace: z.string().describe(
902
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
903
- ).min(1).max(20).optional().nullable(),
904
- extendedFields: z.object({
905
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
906
- "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)."
907
- ).optional()
908
- }).describe(
909
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
910
- ).optional(),
911
- programDefinitions: z.array(
912
- z.object({
913
- _id: z.string().describe("Program definition ID.").regex(
914
- /^[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}$/,
915
- "Must be a valid GUID"
916
- ).optional(),
917
- externalId: z.string().describe("Program definition external ID.").regex(
918
- /^[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}$/,
919
- "Must be a valid GUID"
920
- ).optional().nullable()
921
- })
922
- ).max(20).optional()
923
- }).describe("Pool definition.").optional()
924
- })
925
- ).min(1).max(100).optional(),
926
- bulkActionMetadata: z.object({
927
- totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
928
- totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
929
- undetailedFailures: z.number().int().describe(
930
- "Number of failures without details because detailed failure threshold was exceeded."
931
- ).optional()
932
- }).describe("Bulk action metadata.").optional()
933
- });
934
- var UpdatePoolDefinitionRequest = z.object({
935
- _id: z.string().describe("Pool definition ID.").regex(
936
- /^[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}$/,
937
- "Must be a valid GUID"
938
- ),
939
- poolDefinition: z.object({
940
- _id: z.string().describe("Pool definition ID.").regex(
941
- /^[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}$/,
942
- "Must be a valid GUID"
943
- ).optional().nullable(),
944
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
945
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
946
- ),
947
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
948
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
949
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
950
- programDefinitionIds: z.array(z.string()).max(20).optional(),
951
- details: z.object({
952
- benefits: z.array(
953
- z.object({
954
- benefitKey: z.string().describe(
955
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
956
- ).max(64).optional(),
957
- itemSetId: z.string().describe(
958
- "ID that is used to associated items with this benefit."
959
- ).regex(
960
- /^[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}$/,
961
- "Must be a valid GUID"
962
- ).optional().nullable(),
963
- price: z.string().describe(
964
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
965
- ).optional().nullable(),
966
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
967
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
968
- /^[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}$/,
969
- "Must be a valid GUID"
970
- ).optional().nullable(),
971
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
972
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
973
- })
974
- ).max(10).optional(),
975
- creditConfiguration: z.object({
976
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
977
- rolloverConfiguration: z.object({
978
- enabled: z.boolean().describe(
979
- "Whether unused credits roll over to a new cycle when a program renews."
980
- ).optional().nullable(),
981
- balanceCap: z.string().describe(
982
- "Maximum number of credits that can roll over to the next cycle when a program renews."
983
- ).optional().nullable()
984
- }).describe("Rollover settings.").optional(),
985
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
986
- }).describe(
987
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
988
- ).optional(),
989
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
990
- }).describe("Pool definition benefits and settings.").optional(),
991
- namespace: z.string().describe(
992
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
993
- ).min(1).max(20).optional().nullable(),
994
- extendedFields: z.object({
995
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
996
- "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)."
997
- ).optional()
998
- }).describe(
999
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1000
- ).optional(),
1001
- programDefinitions: z.array(
1002
- z.object({
1003
- _id: z.string().describe("Program definition ID.").regex(
1004
- /^[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}$/,
1005
- "Must be a valid GUID"
1006
- ).optional(),
1007
- externalId: z.string().describe("Program definition external ID.").regex(
1008
- /^[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}$/,
1009
- "Must be a valid GUID"
1010
- ).optional().nullable()
1011
- })
1012
- ).max(20).optional()
1013
- }).describe("Pool definition to update."),
1014
- options: z.object({
1015
- cascade: z.enum([
1016
- "UNKNOWN_CASCADE",
1017
- "IMMEDIATELY",
1018
- "NEXT_RENEWAL",
1019
- "FUTURE_PROVISIONS"
1020
- ]).optional()
1021
- }).optional()
1022
- });
1023
- var UpdatePoolDefinitionResponse = z.object({
1024
- _id: z.string().describe("Pool definition ID.").regex(
1025
- /^[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}$/,
1026
- "Must be a valid GUID"
1027
- ).optional().nullable(),
1028
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1029
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1030
- ).optional().nullable(),
1031
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1032
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1033
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1034
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1035
- details: z.object({
1036
- benefits: z.array(
1037
- z.object({
1038
- benefitKey: z.string().describe(
1039
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1040
- ).max(64).optional(),
1041
- itemSetId: z.string().describe(
1042
- "ID that is used to associated items with this benefit."
1043
- ).regex(
1044
- /^[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}$/,
1045
- "Must be a valid GUID"
1046
- ).optional().nullable(),
1047
- price: z.string().describe(
1048
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1049
- ).optional().nullable(),
1050
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
1051
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
1052
- /^[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}$/,
1053
- "Must be a valid GUID"
1054
- ).optional().nullable(),
1055
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1056
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1057
- })
1058
- ).max(10).optional(),
1059
- creditConfiguration: z.object({
1060
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
1061
- rolloverConfiguration: z.object({
1062
- enabled: z.boolean().describe(
1063
- "Whether unused credits roll over to a new cycle when a program renews."
1064
- ).optional().nullable(),
1065
- balanceCap: z.string().describe(
1066
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1067
- ).optional().nullable()
1068
- }).describe("Rollover settings.").optional(),
1069
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1070
- }).describe(
1071
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1072
- ).optional(),
1073
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
1074
- }).describe("Pool definition benefits and settings.").optional(),
1075
- namespace: z.string().describe(
1076
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1077
- ).min(1).max(20).optional().nullable(),
1078
- extendedFields: z.object({
1079
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1080
- "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)."
1081
- ).optional()
1082
- }).describe(
1083
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1084
- ).optional(),
1085
- programDefinitions: z.array(
1086
- z.object({
1087
- _id: z.string().describe("Program definition ID.").regex(
1088
- /^[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}$/,
1089
- "Must be a valid GUID"
1090
- ).optional(),
1091
- externalId: z.string().describe("Program definition external ID.").regex(
1092
- /^[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}$/,
1093
- "Must be a valid GUID"
1094
- ).optional().nullable()
1095
- })
1096
- ).max(20).optional()
1097
- });
1098
- var BulkUpdatePoolDefinitionsRequest = z.object({
1099
- options: z.object({
1100
- poolDefinitions: z.array(
1101
- z.object({
1102
- poolDefinition: z.object({
1103
- _id: z.string().describe("Pool definition ID.").regex(
1104
- /^[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}$/,
1105
- "Must be a valid GUID"
1106
- ),
1107
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1108
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1109
- ),
1110
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1111
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1112
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1113
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1114
- details: z.object({
1115
- benefits: z.array(
1116
- z.object({
1117
- benefitKey: z.string().describe(
1118
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1119
- ).max(64).optional(),
1120
- itemSetId: z.string().describe(
1121
- "ID that is used to associated items with this benefit."
1122
- ).regex(
1123
- /^[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}$/,
1124
- "Must be a valid GUID"
1125
- ).optional().nullable(),
1126
- price: z.string().describe(
1127
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1128
- ).optional().nullable(),
1129
- additionalData: z.record(z.string(), z.any()).describe(
1130
- "Additional information for this benefit."
1131
- ).optional().nullable(),
1132
- providerAppId: z.string().describe(
1133
- "ID of the app providing the benefit items."
1134
- ).regex(
1135
- /^[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}$/,
1136
- "Must be a valid GUID"
1137
- ).optional().nullable(),
1138
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1139
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1140
- })
1141
- ).max(10).optional(),
1142
- creditConfiguration: z.object({
1143
- amount: z.string().describe(
1144
- "Initial available amount for associated balances."
1145
- ).optional(),
1146
- rolloverConfiguration: z.object({
1147
- enabled: z.boolean().describe(
1148
- "Whether unused credits roll over to a new cycle when a program renews."
1149
- ).optional().nullable(),
1150
- balanceCap: z.string().describe(
1151
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1152
- ).optional().nullable()
1153
- }).describe("Rollover settings.").optional(),
1154
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1155
- }).describe(
1156
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1157
- ).optional(),
1158
- additionalData: z.record(z.string(), z.any()).describe(
1159
- "Additional information relating to this object."
1160
- ).optional().nullable()
1161
- }).describe("Pool definition benefits and settings.").optional(),
1162
- namespace: z.string().describe(
1163
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1164
- ).min(1).max(20).optional().nullable(),
1165
- extendedFields: z.object({
1166
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1167
- "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)."
1168
- ).optional()
1169
- }).describe(
1170
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1171
- ).optional(),
1172
- programDefinitions: z.array(
1173
- z.object({
1174
- _id: z.string().describe("Program definition ID.").regex(
1175
- /^[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}$/,
1176
- "Must be a valid GUID"
1177
- ).optional(),
1178
- externalId: z.string().describe("Program definition external ID.").regex(
1179
- /^[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}$/,
1180
- "Must be a valid GUID"
1181
- ).optional().nullable()
1182
- })
1183
- ).max(20).optional()
1184
- }).describe("Pool definition to update."),
1185
- fieldMask: z.array(z.string()).optional()
1186
- })
1187
- ).min(1).max(100).optional(),
1188
- cascade: z.enum([
1189
- "UNKNOWN_CASCADE",
1190
- "IMMEDIATELY",
1191
- "NEXT_RENEWAL",
1192
- "FUTURE_PROVISIONS"
1193
- ]).optional(),
1194
- returnEntity: z.boolean().describe(
1195
- "Whether to return the updated pool definitions.\n\nDefault: `false`"
1196
- ).optional()
1197
- }).optional()
1198
- });
1199
- var BulkUpdatePoolDefinitionsResponse = z.object({
1200
- results: z.array(
1201
- z.object({
1202
- itemMetadata: z.object({
1203
- _id: z.string().describe(
1204
- "Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
1205
- ).regex(
1206
- /^[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}$/,
1207
- "Must be a valid GUID"
1208
- ).optional().nullable(),
1209
- originalIndex: z.number().int().describe(
1210
- "Index of the item within the request array. Allows for correlation between request and response items."
1211
- ).optional(),
1212
- success: z.boolean().describe(
1213
- "Whether the requested action was successful for this item. When `false`, the `error` field is populated."
1214
- ).optional(),
1215
- error: z.object({
1216
- code: z.string().describe("Error code.").optional(),
1217
- description: z.string().describe("Description of the error.").optional(),
1218
- data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
1219
- }).describe("Details about the error in case of failure.").optional()
1220
- }).describe("Item metadata.").optional(),
1221
- item: z.object({
1222
- _id: z.string().describe("Pool definition ID.").regex(
1223
- /^[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}$/,
1224
- "Must be a valid GUID"
1225
- ).optional().nullable(),
1226
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1227
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1228
- ).optional().nullable(),
1229
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1230
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1231
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1232
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1233
- details: z.object({
1234
- benefits: z.array(
1235
- z.object({
1236
- benefitKey: z.string().describe(
1237
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1238
- ).max(64).optional(),
1239
- itemSetId: z.string().describe(
1240
- "ID that is used to associated items with this benefit."
1241
- ).regex(
1242
- /^[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}$/,
1243
- "Must be a valid GUID"
1244
- ).optional().nullable(),
1245
- price: z.string().describe(
1246
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1247
- ).optional().nullable(),
1248
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
1249
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
1250
- /^[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}$/,
1251
- "Must be a valid GUID"
1252
- ).optional().nullable(),
1253
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1254
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1255
- })
1256
- ).max(10).optional(),
1257
- creditConfiguration: z.object({
1258
- amount: z.string().describe(
1259
- "Initial available amount for associated balances."
1260
- ).optional(),
1261
- rolloverConfiguration: z.object({
1262
- enabled: z.boolean().describe(
1263
- "Whether unused credits roll over to a new cycle when a program renews."
1264
- ).optional().nullable(),
1265
- balanceCap: z.string().describe(
1266
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1267
- ).optional().nullable()
1268
- }).describe("Rollover settings.").optional(),
1269
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1270
- }).describe(
1271
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1272
- ).optional(),
1273
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
1274
- }).describe("Pool definition benefits and settings.").optional(),
1275
- namespace: z.string().describe(
1276
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1277
- ).min(1).max(20).optional().nullable(),
1278
- extendedFields: z.object({
1279
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1280
- "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)."
1281
- ).optional()
1282
- }).describe(
1283
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1284
- ).optional(),
1285
- programDefinitions: z.array(
1286
- z.object({
1287
- _id: z.string().describe("Program definition ID.").regex(
1288
- /^[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}$/,
1289
- "Must be a valid GUID"
1290
- ).optional(),
1291
- externalId: z.string().describe("Program definition external ID.").regex(
1292
- /^[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}$/,
1293
- "Must be a valid GUID"
1294
- ).optional().nullable()
1295
- })
1296
- ).max(20).optional()
1297
- }).describe("Pool definition.").optional()
1298
- })
1299
- ).min(1).max(100).optional(),
1300
- bulkActionMetadata: z.object({
1301
- totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
1302
- totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
1303
- undetailedFailures: z.number().int().describe(
1304
- "Number of failures without details because detailed failure threshold was exceeded."
1305
- ).optional()
1306
- }).describe("Bulk action metadata.").optional()
1307
- });
1308
- var DeletePoolDefinitionRequest = z.object({
1309
- poolDefinitionId: z.string().describe("ID of the pool definition to delete.").regex(
1310
- /^[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}$/,
1311
- "Must be a valid GUID"
1312
- ),
1313
- cascade: z.enum([
1314
- "UNKNOWN_CASCADE",
1315
- "IMMEDIATELY",
1316
- "NEXT_RENEWAL",
1317
- "FUTURE_PROVISIONS"
1318
- ])
1319
- });
1320
- var DeletePoolDefinitionResponse = z.object({});
1321
- var BulkDeletePoolDefinitionsRequest = z.object({
1322
- poolDefinitionIds: z.array(z.string()).min(1).max(100),
1323
- options: z.object({
1324
- cascade: z.enum([
1325
- "UNKNOWN_CASCADE",
1326
- "IMMEDIATELY",
1327
- "NEXT_RENEWAL",
1328
- "FUTURE_PROVISIONS"
1329
- ]).optional()
1330
- }).optional()
1331
- });
1332
- var BulkDeletePoolDefinitionsResponse = z.object({
1333
- results: z.array(
1334
- z.object({
1335
- itemMetadata: z.object({
1336
- _id: z.string().describe(
1337
- "Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."
1338
- ).regex(
1339
- /^[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}$/,
1340
- "Must be a valid GUID"
1341
- ).optional().nullable(),
1342
- originalIndex: z.number().int().describe(
1343
- "Index of the item within the request array. Allows for correlation between request and response items."
1344
- ).optional(),
1345
- success: z.boolean().describe(
1346
- "Whether the requested action was successful for this item. When `false`, the `error` field is populated."
1347
- ).optional(),
1348
- error: z.object({
1349
- code: z.string().describe("Error code.").optional(),
1350
- description: z.string().describe("Description of the error.").optional(),
1351
- data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
1352
- }).describe("Details about the error in case of failure.").optional()
1353
- }).describe("Item metadata.").optional(),
1354
- item: z.object({
1355
- _id: z.string().describe("Pool definition ID.").regex(
1356
- /^[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}$/,
1357
- "Must be a valid GUID"
1358
- ).optional().nullable(),
1359
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1360
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1361
- ).optional().nullable(),
1362
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1363
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1364
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1365
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1366
- details: z.object({
1367
- benefits: z.array(
1368
- z.object({
1369
- benefitKey: z.string().describe(
1370
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1371
- ).max(64).optional(),
1372
- itemSetId: z.string().describe(
1373
- "ID that is used to associated items with this benefit."
1374
- ).regex(
1375
- /^[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}$/,
1376
- "Must be a valid GUID"
1377
- ).optional().nullable(),
1378
- price: z.string().describe(
1379
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1380
- ).optional().nullable(),
1381
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
1382
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
1383
- /^[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}$/,
1384
- "Must be a valid GUID"
1385
- ).optional().nullable(),
1386
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1387
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1388
- })
1389
- ).max(10).optional(),
1390
- creditConfiguration: z.object({
1391
- amount: z.string().describe(
1392
- "Initial available amount for associated balances."
1393
- ).optional(),
1394
- rolloverConfiguration: z.object({
1395
- enabled: z.boolean().describe(
1396
- "Whether unused credits roll over to a new cycle when a program renews."
1397
- ).optional().nullable(),
1398
- balanceCap: z.string().describe(
1399
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1400
- ).optional().nullable()
1401
- }).describe("Rollover settings.").optional(),
1402
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1403
- }).describe(
1404
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1405
- ).optional(),
1406
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
1407
- }).describe("Pool definition benefits and settings.").optional(),
1408
- namespace: z.string().describe(
1409
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1410
- ).min(1).max(20).optional().nullable(),
1411
- extendedFields: z.object({
1412
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1413
- "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)."
1414
- ).optional()
1415
- }).describe(
1416
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1417
- ).optional(),
1418
- programDefinitions: z.array(
1419
- z.object({
1420
- _id: z.string().describe("Program definition ID.").regex(
1421
- /^[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}$/,
1422
- "Must be a valid GUID"
1423
- ).optional(),
1424
- externalId: z.string().describe("Program definition external ID.").regex(
1425
- /^[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}$/,
1426
- "Must be a valid GUID"
1427
- ).optional().nullable()
1428
- })
1429
- ).max(20).optional()
1430
- }).describe("Pool definition.").optional()
1431
- })
1432
- ).min(1).max(100).optional(),
1433
- bulkActionMetadata: z.object({
1434
- totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").optional(),
1435
- totalFailures: z.number().int().describe("Number of items that couldn't be processed.").optional(),
1436
- undetailedFailures: z.number().int().describe(
1437
- "Number of failures without details because detailed failure threshold was exceeded."
1438
- ).optional()
1439
- }).describe("Bulk action metadata.").optional()
1440
- });
1441
- var GetPoolDefinitionRequest = z.object({
1442
- poolDefinitionId: z.string().describe("ID of the pool definition to retrieve.").regex(
1443
- /^[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}$/,
1444
- "Must be a valid GUID"
1445
- )
1446
- });
1447
- var GetPoolDefinitionResponse = z.object({
1448
- _id: z.string().describe("Pool definition ID.").regex(
1449
- /^[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}$/,
1450
- "Must be a valid GUID"
1451
- ).optional().nullable(),
1452
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1453
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1454
- ).optional().nullable(),
1455
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1456
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1457
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1458
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1459
- details: z.object({
1460
- benefits: z.array(
1461
- z.object({
1462
- benefitKey: z.string().describe(
1463
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1464
- ).max(64).optional(),
1465
- itemSetId: z.string().describe(
1466
- "ID that is used to associated items with this benefit."
1467
- ).regex(
1468
- /^[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}$/,
1469
- "Must be a valid GUID"
1470
- ).optional().nullable(),
1471
- price: z.string().describe(
1472
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1473
- ).optional().nullable(),
1474
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
1475
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
1476
- /^[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}$/,
1477
- "Must be a valid GUID"
1478
- ).optional().nullable(),
1479
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1480
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1481
- })
1482
- ).max(10).optional(),
1483
- creditConfiguration: z.object({
1484
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
1485
- rolloverConfiguration: z.object({
1486
- enabled: z.boolean().describe(
1487
- "Whether unused credits roll over to a new cycle when a program renews."
1488
- ).optional().nullable(),
1489
- balanceCap: z.string().describe(
1490
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1491
- ).optional().nullable()
1492
- }).describe("Rollover settings.").optional(),
1493
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1494
- }).describe(
1495
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1496
- ).optional(),
1497
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
1498
- }).describe("Pool definition benefits and settings.").optional(),
1499
- namespace: z.string().describe(
1500
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1501
- ).min(1).max(20).optional().nullable(),
1502
- extendedFields: z.object({
1503
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1504
- "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)."
1505
- ).optional()
1506
- }).describe(
1507
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1508
- ).optional(),
1509
- programDefinitions: z.array(
1510
- z.object({
1511
- _id: z.string().describe("Program definition ID.").regex(
1512
- /^[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}$/,
1513
- "Must be a valid GUID"
1514
- ).optional(),
1515
- externalId: z.string().describe("Program definition external ID.").regex(
1516
- /^[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}$/,
1517
- "Must be a valid GUID"
1518
- ).optional().nullable()
1519
- })
1520
- ).max(20).optional()
1521
- });
1522
- var QueryPoolDefinitionsRequest = z.object({
1523
- query: z.intersection(
1524
- z.object({
1525
- filter: z.record(z.string(), z.any()).describe(
1526
- "Filter object.\nSee [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)\nfor more information."
1527
- ).optional().nullable(),
1528
- sort: z.array(
1529
- z.object({
1530
- fieldName: z.string().describe("Field to sort by.").max(512).optional(),
1531
- order: z.enum(["ASC", "DESC"]).optional()
1532
- })
1533
- ).max(5).optional()
1534
- }),
1535
- z.xor([
1536
- z.object({ cursorPaging: z.never().optional() }),
1537
- z.object({
1538
- cursorPaging: z.object({
1539
- limit: z.number().int().describe("Maximum number of items to return.").min(0).max(100).optional().nullable(),
1540
- cursor: z.string().describe(
1541
- "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."
1542
- ).max(16e3).optional().nullable()
1543
- }).describe(
1544
- "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`."
1545
- )
1546
- })
1547
- ])
1548
- ).describe("Filter, sort, and paging to apply to the query.")
1549
- });
1550
- var QueryPoolDefinitionsResponse = z.object({
1551
- poolDefinitions: z.array(
1552
- z.object({
1553
- _id: z.string().describe("Pool definition ID.").regex(
1554
- /^[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}$/,
1555
- "Must be a valid GUID"
1556
- ).optional().nullable(),
1557
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1558
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1559
- ).optional().nullable(),
1560
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1561
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1562
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1563
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1564
- details: z.object({
1565
- benefits: z.array(
1566
- z.object({
1567
- benefitKey: z.string().describe(
1568
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1569
- ).max(64).optional(),
1570
- itemSetId: z.string().describe(
1571
- "ID that is used to associated items with this benefit."
1572
- ).regex(
1573
- /^[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}$/,
1574
- "Must be a valid GUID"
1575
- ).optional().nullable(),
1576
- price: z.string().describe(
1577
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1578
- ).optional().nullable(),
1579
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
1580
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
1581
- /^[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}$/,
1582
- "Must be a valid GUID"
1583
- ).optional().nullable(),
1584
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1585
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1586
- })
1587
- ).max(10).optional(),
1588
- creditConfiguration: z.object({
1589
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
1590
- rolloverConfiguration: z.object({
1591
- enabled: z.boolean().describe(
1592
- "Whether unused credits roll over to a new cycle when a program renews."
1593
- ).optional().nullable(),
1594
- balanceCap: z.string().describe(
1595
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1596
- ).optional().nullable()
1597
- }).describe("Rollover settings.").optional(),
1598
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1599
- }).describe(
1600
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1601
- ).optional(),
1602
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
1603
- }).describe("Pool definition benefits and settings.").optional(),
1604
- namespace: z.string().describe(
1605
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1606
- ).min(1).max(20).optional().nullable(),
1607
- extendedFields: z.object({
1608
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1609
- "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)."
1610
- ).optional()
1611
- }).describe(
1612
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1613
- ).optional(),
1614
- programDefinitions: z.array(
1615
- z.object({
1616
- _id: z.string().describe("Program definition ID.").regex(
1617
- /^[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}$/,
1618
- "Must be a valid GUID"
1619
- ).optional(),
1620
- externalId: z.string().describe("Program definition external ID.").regex(
1621
- /^[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}$/,
1622
- "Must be a valid GUID"
1623
- ).optional().nullable()
1624
- })
1625
- ).max(20).optional()
1626
- })
1627
- ).optional(),
1628
- metadata: z.object({
1629
- count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
1630
- cursors: z.object({
1631
- next: z.string().describe(
1632
- "Cursor string pointing to the next page in the list of results."
1633
- ).max(16e3).optional().nullable(),
1634
- prev: z.string().describe(
1635
- "Cursor pointing to the previous page in the list of results."
1636
- ).max(16e3).optional().nullable()
1637
- }).describe(
1638
- "Cursor strings that point to the next page, previous page, or both."
1639
- ).optional(),
1640
- hasNext: z.boolean().describe(
1641
- "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."
1642
- ).optional().nullable()
1643
- }).describe("Metadata for the paginated results.").optional()
1644
- });
1645
- var AddPoolDefinitionToProgramDefinitionRequest = z.object({
1646
- poolDefinitionId: z.string().describe("ID of the pool definition to add to the program definition.").regex(
1647
- /^[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}$/,
1648
- "Must be a valid GUID"
1649
- ),
1650
- options: z.object({
1651
- programDefinitionId: z.string().describe("ID of the program definition to add the pool definition to.").regex(
1652
- /^[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}$/,
1653
- "Must be a valid GUID"
1654
- ),
1655
- cascade: z.enum([
1656
- "UNKNOWN_CASCADE",
1657
- "IMMEDIATELY",
1658
- "NEXT_RENEWAL",
1659
- "FUTURE_PROVISIONS"
1660
- ])
1661
- })
1662
- });
1663
- var AddPoolDefinitionToProgramDefinitionResponse = z.object({
1664
- poolDefinition: z.object({
1665
- _id: z.string().describe("Pool definition ID.").regex(
1666
- /^[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}$/,
1667
- "Must be a valid GUID"
1668
- ).optional().nullable(),
1669
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1670
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1671
- ).optional().nullable(),
1672
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1673
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1674
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1675
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1676
- details: z.object({
1677
- benefits: z.array(
1678
- z.object({
1679
- benefitKey: z.string().describe(
1680
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1681
- ).max(64).optional(),
1682
- itemSetId: z.string().describe(
1683
- "ID that is used to associated items with this benefit."
1684
- ).regex(
1685
- /^[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}$/,
1686
- "Must be a valid GUID"
1687
- ).optional().nullable(),
1688
- price: z.string().describe(
1689
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1690
- ).optional().nullable(),
1691
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
1692
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
1693
- /^[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}$/,
1694
- "Must be a valid GUID"
1695
- ).optional().nullable(),
1696
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1697
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1698
- })
1699
- ).max(10).optional(),
1700
- creditConfiguration: z.object({
1701
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
1702
- rolloverConfiguration: z.object({
1703
- enabled: z.boolean().describe(
1704
- "Whether unused credits roll over to a new cycle when a program renews."
1705
- ).optional().nullable(),
1706
- balanceCap: z.string().describe(
1707
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1708
- ).optional().nullable()
1709
- }).describe("Rollover settings.").optional(),
1710
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1711
- }).describe(
1712
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1713
- ).optional(),
1714
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
1715
- }).describe("Pool definition benefits and settings.").optional(),
1716
- namespace: z.string().describe(
1717
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1718
- ).min(1).max(20).optional().nullable(),
1719
- extendedFields: z.object({
1720
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1721
- "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)."
1722
- ).optional()
1723
- }).describe(
1724
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1725
- ).optional(),
1726
- programDefinitions: z.array(
1727
- z.object({
1728
- _id: z.string().describe("Program definition ID.").regex(
1729
- /^[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}$/,
1730
- "Must be a valid GUID"
1731
- ).optional(),
1732
- externalId: z.string().describe("Program definition external ID.").regex(
1733
- /^[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}$/,
1734
- "Must be a valid GUID"
1735
- ).optional().nullable()
1736
- })
1737
- ).max(20).optional()
1738
- }).describe("Updated pool definition.").optional()
1739
- });
1740
- var RemovePoolDefinitionFromProgramDefinitionRequest = z.object({
1741
- poolDefinitionId: z.string().describe(
1742
- "ID of the pool definition to remove from the program definition."
1743
- ).regex(
1744
- /^[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}$/,
1745
- "Must be a valid GUID"
1746
- ),
1747
- options: z.object({
1748
- programDefinitionId: z.string().describe(
1749
- "ID of the program definition to remove the pool definition from."
1750
- ).regex(
1751
- /^[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}$/,
1752
- "Must be a valid GUID"
1753
- ),
1754
- cascade: z.enum([
1755
- "UNKNOWN_CASCADE",
1756
- "IMMEDIATELY",
1757
- "NEXT_RENEWAL",
1758
- "FUTURE_PROVISIONS"
1759
- ])
1760
- })
1761
- });
1762
- var RemovePoolDefinitionFromProgramDefinitionResponse = z.object({
1763
- poolDefinition: z.object({
1764
- _id: z.string().describe("Pool definition ID.").regex(
1765
- /^[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}$/,
1766
- "Must be a valid GUID"
1767
- ).optional().nullable(),
1768
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1769
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1770
- ).optional().nullable(),
1771
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1772
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1773
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1774
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1775
- details: z.object({
1776
- benefits: z.array(
1777
- z.object({
1778
- benefitKey: z.string().describe(
1779
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1780
- ).max(64).optional(),
1781
- itemSetId: z.string().describe(
1782
- "ID that is used to associated items with this benefit."
1783
- ).regex(
1784
- /^[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}$/,
1785
- "Must be a valid GUID"
1786
- ).optional().nullable(),
1787
- price: z.string().describe(
1788
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1789
- ).optional().nullable(),
1790
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
1791
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
1792
- /^[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}$/,
1793
- "Must be a valid GUID"
1794
- ).optional().nullable(),
1795
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1796
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1797
- })
1798
- ).max(10).optional(),
1799
- creditConfiguration: z.object({
1800
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
1801
- rolloverConfiguration: z.object({
1802
- enabled: z.boolean().describe(
1803
- "Whether unused credits roll over to a new cycle when a program renews."
1804
- ).optional().nullable(),
1805
- balanceCap: z.string().describe(
1806
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1807
- ).optional().nullable()
1808
- }).describe("Rollover settings.").optional(),
1809
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1810
- }).describe(
1811
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1812
- ).optional(),
1813
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
1814
- }).describe("Pool definition benefits and settings.").optional(),
1815
- namespace: z.string().describe(
1816
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1817
- ).min(1).max(20).optional().nullable(),
1818
- extendedFields: z.object({
1819
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1820
- "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)."
1821
- ).optional()
1822
- }).describe(
1823
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1824
- ).optional(),
1825
- programDefinitions: z.array(
1826
- z.object({
1827
- _id: z.string().describe("Program definition ID.").regex(
1828
- /^[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}$/,
1829
- "Must be a valid GUID"
1830
- ).optional(),
1831
- externalId: z.string().describe("Program definition external ID.").regex(
1832
- /^[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}$/,
1833
- "Must be a valid GUID"
1834
- ).optional().nullable()
1835
- })
1836
- ).max(20).optional()
1837
- }).describe("Updated pool definition.").optional()
1838
- });
1839
- var FindPoolDefinitionsByProgramDefinitionRequest = z.object({
1840
- programDefinitionId: z.string().describe("ID of the program definition to retrieve its pool definitions.").regex(
1841
- /^[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}$/,
1842
- "Must be a valid GUID"
1843
- ),
1844
- options: z.object({
1845
- namespace: z.string().describe(
1846
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1847
- ).min(1).max(20)
1848
- })
1849
- });
1850
- var FindPoolDefinitionsByProgramDefinitionResponse = z.object({
1851
- poolDefinitions: z.array(
1852
- z.object({
1853
- _id: z.string().describe("Pool definition ID.").regex(
1854
- /^[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}$/,
1855
- "Must be a valid GUID"
1856
- ).optional().nullable(),
1857
- revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
1858
- "Revision number, which increments by 1 each time the pool definition is updated.\nTo prevent conflicting changes, the current revision must be specified when updating the pool definition.\n\nIgnored when creating a pool definition."
1859
- ).optional().nullable(),
1860
- _createdDate: z.date().describe("Date and time the pool definition was created.").optional().nullable(),
1861
- _updatedDate: z.date().describe("Date and time the pool definition was updated.").optional().nullable(),
1862
- displayName: z.string().describe("Pool definition name.").max(128).optional(),
1863
- programDefinitionIds: z.array(z.string()).max(20).optional(),
1864
- details: z.object({
1865
- benefits: z.array(
1866
- z.object({
1867
- benefitKey: z.string().describe(
1868
- "Unique identifier for this benefit.\n\nThis key is consistent across the pool definition and all associated pools that contain this benefit."
1869
- ).max(64).optional(),
1870
- itemSetId: z.string().describe(
1871
- "ID that is used to associated items with this benefit."
1872
- ).regex(
1873
- /^[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}$/,
1874
- "Must be a valid GUID"
1875
- ).optional().nullable(),
1876
- price: z.string().describe(
1877
- "Price of the benefit in credits. The price is the same for all of this benefit's items."
1878
- ).optional().nullable(),
1879
- additionalData: z.record(z.string(), z.any()).describe("Additional information for this benefit.").optional().nullable(),
1880
- providerAppId: z.string().describe("ID of the app providing the benefit items.").regex(
1881
- /^[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}$/,
1882
- "Must be a valid GUID"
1883
- ).optional().nullable(),
1884
- displayName: z.string().describe("Benefit name.").max(40).optional().nullable(),
1885
- description: z.string().describe("Benefit description.").max(255).optional().nullable()
1886
- })
1887
- ).max(10).optional(),
1888
- creditConfiguration: z.object({
1889
- amount: z.string().describe("Initial available amount for associated balances.").optional(),
1890
- rolloverConfiguration: z.object({
1891
- enabled: z.boolean().describe(
1892
- "Whether unused credits roll over to a new cycle when a program renews."
1893
- ).optional().nullable(),
1894
- balanceCap: z.string().describe(
1895
- "Maximum number of credits that can roll over to the next cycle when a program renews."
1896
- ).optional().nullable()
1897
- }).describe("Rollover settings.").optional(),
1898
- unitDisplayName: z.string().describe("Credit unit display name.").max(32).optional().nullable()
1899
- }).describe(
1900
- "Credit settings.\n\nIf this object is empty, you can't set a price for the benefit."
1901
- ).optional(),
1902
- additionalData: z.record(z.string(), z.any()).describe("Additional information relating to this object.").optional().nullable()
1903
- }).describe("Pool definition benefits and settings.").optional(),
1904
- namespace: z.string().describe(
1905
- "Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created."
1906
- ).min(1).max(20).optional().nullable(),
1907
- extendedFields: z.object({
1908
- namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
1909
- "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)."
1910
- ).optional()
1911
- }).describe(
1912
- "Custom field data for the pool definition object.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
1913
- ).optional(),
1914
- programDefinitions: z.array(
1915
- z.object({
1916
- _id: z.string().describe("Program definition ID.").regex(
1917
- /^[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}$/,
1918
- "Must be a valid GUID"
1919
- ).optional(),
1920
- externalId: z.string().describe("Program definition external ID.").regex(
1921
- /^[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}$/,
1922
- "Must be a valid GUID"
1923
- ).optional().nullable()
1924
- })
1925
- ).max(20).optional()
1926
- })
1927
- ).optional()
1928
- });
1929
-
1930
- // src/benefit-programs-v1-pool-definition-pool-definitions.universal.ts
1931
562
  var import_query_builder_utils = require("@wix/sdk-runtime/query-builder-utils");
1932
563
  var PolicyExpressionType = /* @__PURE__ */ ((PolicyExpressionType2) => {
1933
564
  PolicyExpressionType2["OPERATOR_NOT"] = "OPERATOR_NOT";
@@ -1979,10 +610,7 @@ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
1979
610
  return WebhookIdentityType2;
1980
611
  })(WebhookIdentityType || {});
1981
612
  async function createPoolDefinition2(poolDefinition, options) {
1982
- const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
1983
- if (validateRequestSchema) {
1984
- CreatePoolDefinitionRequest.parse({ poolDefinition, options });
1985
- }
613
+ const { httpClient, sideEffects } = arguments[2];
1986
614
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
1987
615
  poolDefinition,
1988
616
  cascade: options?.cascade
@@ -2011,10 +639,7 @@ async function createPoolDefinition2(poolDefinition, options) {
2011
639
  }
2012
640
  }
2013
641
  async function bulkCreatePoolDefinitions2(poolDefinitions, options) {
2014
- const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
2015
- if (validateRequestSchema) {
2016
- BulkCreatePoolDefinitionsRequest.parse({ poolDefinitions, options });
2017
- }
642
+ const { httpClient, sideEffects } = arguments[2];
2018
643
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2019
644
  poolDefinitions,
2020
645
  cascade: options?.cascade,
@@ -2047,10 +672,7 @@ async function bulkCreatePoolDefinitions2(poolDefinitions, options) {
2047
672
  }
2048
673
  }
2049
674
  async function updatePoolDefinition2(_id, poolDefinition, options) {
2050
- const { httpClient, sideEffects, validateRequestSchema } = arguments[3];
2051
- if (validateRequestSchema) {
2052
- UpdatePoolDefinitionRequest.parse({ _id, poolDefinition, options });
2053
- }
675
+ const { httpClient, sideEffects } = arguments[3];
2054
676
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2055
677
  poolDefinition: { ...poolDefinition, id: _id },
2056
678
  cascade: options?.cascade
@@ -2079,10 +701,7 @@ async function updatePoolDefinition2(_id, poolDefinition, options) {
2079
701
  }
2080
702
  }
2081
703
  async function bulkUpdatePoolDefinitions2(options) {
2082
- const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
2083
- if (validateRequestSchema) {
2084
- BulkUpdatePoolDefinitionsRequest.parse({ options });
2085
- }
704
+ const { httpClient, sideEffects } = arguments[1];
2086
705
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2087
706
  poolDefinitions: options?.poolDefinitions,
2088
707
  cascade: options?.cascade,
@@ -2115,10 +734,7 @@ async function bulkUpdatePoolDefinitions2(options) {
2115
734
  }
2116
735
  }
2117
736
  async function deletePoolDefinition2(poolDefinitionId, cascade) {
2118
- const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
2119
- if (validateRequestSchema) {
2120
- DeletePoolDefinitionRequest.parse({ poolDefinitionId, cascade });
2121
- }
737
+ const { httpClient, sideEffects } = arguments[2];
2122
738
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2123
739
  poolDefinitionId,
2124
740
  cascade
@@ -2143,13 +759,7 @@ async function deletePoolDefinition2(poolDefinitionId, cascade) {
2143
759
  }
2144
760
  }
2145
761
  async function bulkDeletePoolDefinitions2(poolDefinitionIds, options) {
2146
- const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
2147
- if (validateRequestSchema) {
2148
- BulkDeletePoolDefinitionsRequest.parse({
2149
- poolDefinitionIds,
2150
- options
2151
- });
2152
- }
762
+ const { httpClient, sideEffects } = arguments[2];
2153
763
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2154
764
  poolDefinitionIds,
2155
765
  cascade: options?.cascade
@@ -2180,10 +790,7 @@ async function bulkDeletePoolDefinitions2(poolDefinitionIds, options) {
2180
790
  }
2181
791
  }
2182
792
  async function getPoolDefinition2(poolDefinitionId) {
2183
- const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
2184
- if (validateRequestSchema) {
2185
- GetPoolDefinitionRequest.parse({ poolDefinitionId });
2186
- }
793
+ const { httpClient, sideEffects } = arguments[1];
2187
794
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2188
795
  poolDefinitionId
2189
796
  });
@@ -2256,10 +863,7 @@ function queryPoolDefinitions2(options) {
2256
863
  });
2257
864
  }
2258
865
  async function typedQueryPoolDefinitions(query, options) {
2259
- const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
2260
- if (validateRequestSchema) {
2261
- QueryPoolDefinitionsRequest.parse({ query, options });
2262
- }
866
+ const { httpClient, sideEffects } = arguments[2];
2263
867
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2264
868
  query,
2265
869
  ...options
@@ -2290,13 +894,7 @@ var utils = {
2290
894
  }
2291
895
  };
2292
896
  async function addPoolDefinitionToProgramDefinition2(poolDefinitionId, options) {
2293
- const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
2294
- if (validateRequestSchema) {
2295
- AddPoolDefinitionToProgramDefinitionRequest.parse({
2296
- poolDefinitionId,
2297
- options
2298
- });
2299
- }
897
+ const { httpClient, sideEffects } = arguments[2];
2300
898
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2301
899
  poolDefinitionId,
2302
900
  programDefinitionId: options?.programDefinitionId,
@@ -2329,13 +927,7 @@ async function addPoolDefinitionToProgramDefinition2(poolDefinitionId, options)
2329
927
  }
2330
928
  }
2331
929
  async function removePoolDefinitionFromProgramDefinition2(poolDefinitionId, options) {
2332
- const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
2333
- if (validateRequestSchema) {
2334
- RemovePoolDefinitionFromProgramDefinitionRequest.parse({
2335
- poolDefinitionId,
2336
- options
2337
- });
2338
- }
930
+ const { httpClient, sideEffects } = arguments[2];
2339
931
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2340
932
  poolDefinitionId,
2341
933
  programDefinitionId: options?.programDefinitionId,
@@ -2368,13 +960,7 @@ async function removePoolDefinitionFromProgramDefinition2(poolDefinitionId, opti
2368
960
  }
2369
961
  }
2370
962
  async function findPoolDefinitionsByProgramDefinition2(programDefinitionId, options) {
2371
- const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
2372
- if (validateRequestSchema) {
2373
- FindPoolDefinitionsByProgramDefinitionRequest.parse({
2374
- programDefinitionId,
2375
- options
2376
- });
2377
- }
963
+ const { httpClient, sideEffects } = arguments[2];
2378
964
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
2379
965
  programDefinitionId,
2380
966
  namespace: options?.namespace