@wix/auto_sdk_benefit-programs_pool-definitions 1.0.22 → 1.0.24
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.
- package/build/cjs/index.d.ts +135 -0
- package/build/cjs/index.js.map +1 -0
- package/build/{benefit-programs-v1-pool-definition-pool-definitions.universal-CBw_o38g.d.mts → cjs/index.typings.d.ts} +225 -3
- package/build/cjs/index.typings.js +952 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/{internal → cjs}/meta.d.ts +23 -2
- package/build/es/index.d.mts +135 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{benefit-programs-v1-pool-definition-pool-definitions.universal-CBw_o38g.d.ts → es/index.typings.d.mts} +225 -3
- package/build/es/index.typings.mjs +911 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/{internal → es}/meta.d.mts +23 -2
- package/build/es/package.json +3 -0
- package/build/internal/cjs/index.d.ts +135 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/{benefit-programs-v1-pool-definition-pool-definitions.universal-CBw_o38g.d.ts → cjs/index.typings.d.ts} +225 -3
- package/build/internal/cjs/index.typings.js +952 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/{meta.d.ts → internal/cjs/meta.d.ts} +23 -2
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/es/index.d.mts +135 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/{benefit-programs-v1-pool-definition-pool-definitions.universal-CBw_o38g.d.mts → es/index.typings.d.mts} +225 -3
- package/build/internal/es/index.typings.mjs +911 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/{meta.d.mts → internal/es/meta.d.mts} +23 -2
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/index.d.mts +0 -127
- package/build/index.d.ts +0 -127
- package/build/index.js.map +0 -1
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -127
- package/build/internal/index.d.ts +0 -127
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs.map +0 -1
- package/build/meta.js.map +0 -1
- package/build/meta.mjs.map +0 -1
- /package/build/{index.js → cjs/index.js} +0 -0
- /package/build/{internal → cjs}/meta.js +0 -0
- /package/build/{internal → cjs}/meta.js.map +0 -0
- /package/build/{index.mjs → es/index.mjs} +0 -0
- /package/build/{internal → es}/meta.mjs +0 -0
- /package/build/{internal → es}/meta.mjs.map +0 -0
- /package/build/internal/{index.js → cjs/index.js} +0 -0
- /package/build/{meta.js → internal/cjs/meta.js} +0 -0
- /package/build/internal/{index.mjs → es/index.mjs} +0 -0
- /package/build/{meta.mjs → internal/es/meta.mjs} +0 -0
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface PoolDefinition {
|
|
2
4
|
/**
|
|
3
5
|
* Pool definition ID.
|
|
@@ -32,7 +34,7 @@ interface PoolDefinition {
|
|
|
32
34
|
/**
|
|
33
35
|
* List of program definition IDs that are associated with this pool definition.
|
|
34
36
|
* @format GUID
|
|
35
|
-
* @maxSize
|
|
37
|
+
* @maxSize 20
|
|
36
38
|
*/
|
|
37
39
|
programDefinitionIds?: string[];
|
|
38
40
|
/** Pool definition benefits and settings. */
|
|
@@ -51,6 +53,12 @@ interface PoolDefinition {
|
|
|
51
53
|
* [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.
|
|
52
54
|
*/
|
|
53
55
|
extendedFields?: ExtendedFields;
|
|
56
|
+
/**
|
|
57
|
+
* Program definitions that this pool definition is associated with.
|
|
58
|
+
* @readonly
|
|
59
|
+
* @maxSize 20
|
|
60
|
+
*/
|
|
61
|
+
programDefinitions?: ProgramDefinitionInfo[];
|
|
54
62
|
}
|
|
55
63
|
interface Details {
|
|
56
64
|
/**
|
|
@@ -319,6 +327,20 @@ interface ExtendedFields {
|
|
|
319
327
|
*/
|
|
320
328
|
namespaces?: Record<string, Record<string, any>>;
|
|
321
329
|
}
|
|
330
|
+
interface ProgramDefinitionInfo {
|
|
331
|
+
/**
|
|
332
|
+
* Program definition ID.
|
|
333
|
+
* @format GUID
|
|
334
|
+
* @readonly
|
|
335
|
+
*/
|
|
336
|
+
_id?: string;
|
|
337
|
+
/**
|
|
338
|
+
* Program definition external ID.
|
|
339
|
+
* @format GUID
|
|
340
|
+
* @readonly
|
|
341
|
+
*/
|
|
342
|
+
externalId?: string | null;
|
|
343
|
+
}
|
|
322
344
|
interface PoolDefinitionAddedToProgramDefinition {
|
|
323
345
|
/** PoolDefinition that was added to the program definition */
|
|
324
346
|
poolDefinition?: PoolDefinition;
|
|
@@ -807,6 +829,43 @@ declare enum WebhookIdentityType {
|
|
|
807
829
|
}
|
|
808
830
|
/** @enumType */
|
|
809
831
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
832
|
+
type UpdatePoolDefinitionValidationErrors = {
|
|
833
|
+
ruleName?: 'cascade_is_required';
|
|
834
|
+
} | {
|
|
835
|
+
ruleName?: 'cascade_value_not_supported';
|
|
836
|
+
};
|
|
837
|
+
type BulkUpdatePoolDefinitionsValidationErrors = {
|
|
838
|
+
ruleName?: 'cascade_is_required';
|
|
839
|
+
} | {
|
|
840
|
+
ruleName?: 'cascade_value_not_supported';
|
|
841
|
+
};
|
|
842
|
+
type AddPoolDefinitionToProgramDefinitionValidationErrors = {
|
|
843
|
+
ruleName?: 'cascade_is_required';
|
|
844
|
+
} | {
|
|
845
|
+
ruleName?: 'cascade_value_not_supported';
|
|
846
|
+
};
|
|
847
|
+
type RemovePoolDefinitionFromProgramDefinitionValidationErrors = {
|
|
848
|
+
ruleName?: 'cascade_is_required';
|
|
849
|
+
} | {
|
|
850
|
+
ruleName?: 'cascade_value_not_supported';
|
|
851
|
+
};
|
|
852
|
+
/**
|
|
853
|
+
* Creates a pool definition.
|
|
854
|
+
* @param poolDefinition - Pool definition to create.
|
|
855
|
+
* @public
|
|
856
|
+
* @documentationMaturity preview
|
|
857
|
+
* @requiredField poolDefinition
|
|
858
|
+
* @requiredField poolDefinition.details
|
|
859
|
+
* @requiredField poolDefinition.details.benefits
|
|
860
|
+
* @requiredField poolDefinition.details.benefits.benefitKey
|
|
861
|
+
* @requiredField poolDefinition.details.benefits.providerAppId
|
|
862
|
+
* @requiredField poolDefinition.namespace
|
|
863
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
|
|
864
|
+
* @applicableIdentity APP
|
|
865
|
+
* @returns Created pool definition.
|
|
866
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.CreatePoolDefinition
|
|
867
|
+
*/
|
|
868
|
+
declare function createPoolDefinition(poolDefinition: NonNullablePaths<PoolDefinition, `details` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.benefits.${number}.providerAppId` | `namespace`, 5>, options?: CreatePoolDefinitionOptions): Promise<NonNullablePaths<PoolDefinition, `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `programDefinitions` | `programDefinitions.${number}._id`, 5>>;
|
|
810
869
|
interface CreatePoolDefinitionOptions {
|
|
811
870
|
/**
|
|
812
871
|
* Determines when the changes to the program definitions containing this pool definition will be applied to associated programs.
|
|
@@ -815,6 +874,22 @@ interface CreatePoolDefinitionOptions {
|
|
|
815
874
|
*/
|
|
816
875
|
cascade?: CascadeWithLiterals;
|
|
817
876
|
}
|
|
877
|
+
/**
|
|
878
|
+
* Creates pool definitions.
|
|
879
|
+
* @param poolDefinitions - Pool definitions to create.
|
|
880
|
+
* @public
|
|
881
|
+
* @documentationMaturity preview
|
|
882
|
+
* @requiredField poolDefinitions
|
|
883
|
+
* @requiredField poolDefinitions.details
|
|
884
|
+
* @requiredField poolDefinitions.details.benefits
|
|
885
|
+
* @requiredField poolDefinitions.details.benefits.benefitKey
|
|
886
|
+
* @requiredField poolDefinitions.details.benefits.providerAppId
|
|
887
|
+
* @requiredField poolDefinitions.namespace
|
|
888
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
|
|
889
|
+
* @applicableIdentity APP
|
|
890
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkCreatePoolDefinitions
|
|
891
|
+
*/
|
|
892
|
+
declare function bulkCreatePoolDefinitions(poolDefinitions: NonNullablePaths<PoolDefinition, `details` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.benefits.${number}.providerAppId` | `namespace`, 5>[], options?: BulkCreatePoolDefinitionsOptions): Promise<NonNullablePaths<BulkCreatePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.poolDefinition.displayName` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
818
893
|
interface BulkCreatePoolDefinitionsOptions {
|
|
819
894
|
/**
|
|
820
895
|
* Determines when the changes to the program definitions containing these pool definitions will be applied to associated programs.
|
|
@@ -829,6 +904,28 @@ interface BulkCreatePoolDefinitionsOptions {
|
|
|
829
904
|
*/
|
|
830
905
|
returnEntity?: boolean;
|
|
831
906
|
}
|
|
907
|
+
/**
|
|
908
|
+
* Updates a pool definition.
|
|
909
|
+
*
|
|
910
|
+
* Each time the pool definition is updated,
|
|
911
|
+
* `revision` increments by 1.
|
|
912
|
+
* The current `revision` must be passed when updating the pool definition.
|
|
913
|
+
* This ensures you're working with the latest pool definition
|
|
914
|
+
* and prevents unintended overwrites.
|
|
915
|
+
* @param _id - Pool definition ID.
|
|
916
|
+
* @public
|
|
917
|
+
* @documentationMaturity preview
|
|
918
|
+
* @requiredField _id
|
|
919
|
+
* @requiredField poolDefinition
|
|
920
|
+
* @requiredField poolDefinition.revision
|
|
921
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
|
|
922
|
+
* @applicableIdentity APP
|
|
923
|
+
* @returns Updated pool definition.
|
|
924
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.UpdatePoolDefinition
|
|
925
|
+
*/
|
|
926
|
+
declare function updatePoolDefinition(_id: string, poolDefinition: NonNullablePaths<UpdatePoolDefinition, `revision`, 2>, options?: UpdatePoolDefinitionOptions): Promise<NonNullablePaths<PoolDefinition, `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `programDefinitions` | `programDefinitions.${number}._id`, 5> & {
|
|
927
|
+
__validationErrorsType?: UpdatePoolDefinitionValidationErrors;
|
|
928
|
+
}>;
|
|
832
929
|
interface UpdatePoolDefinition {
|
|
833
930
|
/**
|
|
834
931
|
* Pool definition ID.
|
|
@@ -863,7 +960,7 @@ interface UpdatePoolDefinition {
|
|
|
863
960
|
/**
|
|
864
961
|
* List of program definition IDs that are associated with this pool definition.
|
|
865
962
|
* @format GUID
|
|
866
|
-
* @maxSize
|
|
963
|
+
* @maxSize 20
|
|
867
964
|
*/
|
|
868
965
|
programDefinitionIds?: string[];
|
|
869
966
|
/** Pool definition benefits and settings. */
|
|
@@ -882,11 +979,31 @@ interface UpdatePoolDefinition {
|
|
|
882
979
|
* [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.
|
|
883
980
|
*/
|
|
884
981
|
extendedFields?: ExtendedFields;
|
|
982
|
+
/**
|
|
983
|
+
* Program definitions that this pool definition is associated with.
|
|
984
|
+
* @readonly
|
|
985
|
+
* @maxSize 20
|
|
986
|
+
*/
|
|
987
|
+
programDefinitions?: ProgramDefinitionInfo[];
|
|
885
988
|
}
|
|
886
989
|
interface UpdatePoolDefinitionOptions {
|
|
887
990
|
/** Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
|
|
888
991
|
cascade?: CascadeWithLiterals;
|
|
889
992
|
}
|
|
993
|
+
/**
|
|
994
|
+
* Updates pool definitions.
|
|
995
|
+
* @public
|
|
996
|
+
* @documentationMaturity preview
|
|
997
|
+
* @requiredField options.poolDefinitions.poolDefinition
|
|
998
|
+
* @requiredField options.poolDefinitions.poolDefinition._id
|
|
999
|
+
* @requiredField options.poolDefinitions.poolDefinition.revision
|
|
1000
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
|
|
1001
|
+
* @applicableIdentity APP
|
|
1002
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkUpdatePoolDefinitions
|
|
1003
|
+
*/
|
|
1004
|
+
declare function bulkUpdatePoolDefinitions(options?: NonNullablePaths<BulkUpdatePoolDefinitionsOptions, `poolDefinitions.${number}.poolDefinition` | `poolDefinitions.${number}.poolDefinition._id` | `poolDefinitions.${number}.poolDefinition.revision`, 5>): Promise<NonNullablePaths<BulkUpdatePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.poolDefinition.displayName` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
1005
|
+
__validationErrorsType?: BulkUpdatePoolDefinitionsValidationErrors;
|
|
1006
|
+
}>;
|
|
890
1007
|
interface BulkUpdatePoolDefinitionsOptions {
|
|
891
1008
|
/**
|
|
892
1009
|
* Pool definitions to update.
|
|
@@ -903,14 +1020,69 @@ interface BulkUpdatePoolDefinitionsOptions {
|
|
|
903
1020
|
*/
|
|
904
1021
|
returnEntity?: boolean;
|
|
905
1022
|
}
|
|
1023
|
+
/**
|
|
1024
|
+
* Deletes a pool definition.
|
|
1025
|
+
* @param poolDefinitionId - ID of the pool definition to delete.
|
|
1026
|
+
* @public
|
|
1027
|
+
* @documentationMaturity preview
|
|
1028
|
+
* @requiredField poolDefinitionId
|
|
1029
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
|
|
1030
|
+
* @applicableIdentity APP
|
|
1031
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.DeletePoolDefinition
|
|
1032
|
+
*/
|
|
1033
|
+
declare function deletePoolDefinition(poolDefinitionId: string, options?: DeletePoolDefinitionOptions): Promise<void>;
|
|
906
1034
|
interface DeletePoolDefinitionOptions {
|
|
907
1035
|
/** Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
|
|
908
1036
|
cascade?: CascadeWithLiterals;
|
|
909
1037
|
}
|
|
1038
|
+
/**
|
|
1039
|
+
* Deletes pool definitions.
|
|
1040
|
+
* @param poolDefinitionIds - List of IDs of the pool definitions to delete.
|
|
1041
|
+
* @public
|
|
1042
|
+
* @documentationMaturity preview
|
|
1043
|
+
* @requiredField poolDefinitionIds
|
|
1044
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
|
|
1045
|
+
* @applicableIdentity APP
|
|
1046
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkDeletePoolDefinitions
|
|
1047
|
+
*/
|
|
1048
|
+
declare function bulkDeletePoolDefinitions(poolDefinitionIds: string[], options?: BulkDeletePoolDefinitionsOptions): Promise<NonNullablePaths<BulkDeletePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.poolDefinition.displayName` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
910
1049
|
interface BulkDeletePoolDefinitionsOptions {
|
|
911
1050
|
/** Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
|
|
912
1051
|
cascade?: CascadeWithLiterals;
|
|
913
1052
|
}
|
|
1053
|
+
/**
|
|
1054
|
+
* Retrieves a pool definition.
|
|
1055
|
+
* @param poolDefinitionId - ID of the pool definition to retrieve.
|
|
1056
|
+
* @public
|
|
1057
|
+
* @documentationMaturity preview
|
|
1058
|
+
* @requiredField poolDefinitionId
|
|
1059
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
|
|
1060
|
+
* @applicableIdentity APP
|
|
1061
|
+
* @applicableIdentity VISITOR
|
|
1062
|
+
* @returns Retrieved pool definition.
|
|
1063
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.GetPoolDefinition
|
|
1064
|
+
*/
|
|
1065
|
+
declare function getPoolDefinition(poolDefinitionId: string): Promise<NonNullablePaths<PoolDefinition, `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `programDefinitions` | `programDefinitions.${number}._id`, 5>>;
|
|
1066
|
+
/**
|
|
1067
|
+
* Creates a query to retrieve a list of pool definitions.
|
|
1068
|
+
*
|
|
1069
|
+
* The Query Pool Definitions method builds a query to retrieve a list of pool definitions and returns a `PoolDefinitionsQueryBuilder` object.
|
|
1070
|
+
*
|
|
1071
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
1072
|
+
*
|
|
1073
|
+
* You can refine the query by chaining `PoolDefinitionsQueryBuilder` methods onto the query. `PoolDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pool Definitions returns.
|
|
1074
|
+
*
|
|
1075
|
+
* Query Pool Definitions has a default paging limit of 50, which you can override.
|
|
1076
|
+
*
|
|
1077
|
+
* For a full description of the item object, see the object returned for the `items` property in `PoolDefinitionsQueryResult`.
|
|
1078
|
+
* @public
|
|
1079
|
+
* @documentationMaturity preview
|
|
1080
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
|
|
1081
|
+
* @applicableIdentity APP
|
|
1082
|
+
* @applicableIdentity VISITOR
|
|
1083
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.QueryPoolDefinitions
|
|
1084
|
+
*/
|
|
1085
|
+
declare function queryPoolDefinitions(): PoolDefinitionsQueryBuilder;
|
|
914
1086
|
interface QueryCursorResult {
|
|
915
1087
|
cursors: Cursors;
|
|
916
1088
|
hasNext: () => boolean;
|
|
@@ -993,6 +1165,24 @@ interface PoolDefinitionsQueryBuilder {
|
|
|
993
1165
|
/** @documentationMaturity preview */
|
|
994
1166
|
find: () => Promise<PoolDefinitionsQueryResult>;
|
|
995
1167
|
}
|
|
1168
|
+
/**
|
|
1169
|
+
* Adds a pool definition to a program definition.
|
|
1170
|
+
*
|
|
1171
|
+
* Pool definitions can be contained by multiple program definitions, so this doesn't affect other program definitions that contain this pool definition.
|
|
1172
|
+
* @param poolDefinitionId - ID of the pool definition to add to the program definition.
|
|
1173
|
+
* @public
|
|
1174
|
+
* @documentationMaturity preview
|
|
1175
|
+
* @requiredField options
|
|
1176
|
+
* @requiredField options.cascade
|
|
1177
|
+
* @requiredField options.programDefinitionId
|
|
1178
|
+
* @requiredField poolDefinitionId
|
|
1179
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
|
|
1180
|
+
* @applicableIdentity APP
|
|
1181
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.AddPoolDefinitionToProgramDefinition
|
|
1182
|
+
*/
|
|
1183
|
+
declare function addPoolDefinitionToProgramDefinition(poolDefinitionId: string, options: NonNullablePaths<AddPoolDefinitionToProgramDefinitionOptions, `cascade` | `programDefinitionId`, 2>): Promise<NonNullablePaths<AddPoolDefinitionToProgramDefinitionResponse, `poolDefinition.displayName` | `poolDefinition.programDefinitionIds` | `poolDefinition.details.benefits` | `poolDefinition.details.benefits.${number}.benefitKey` | `poolDefinition.details.creditConfiguration.amount` | `poolDefinition.programDefinitions` | `poolDefinition.programDefinitions.${number}._id`, 6> & {
|
|
1184
|
+
__validationErrorsType?: AddPoolDefinitionToProgramDefinitionValidationErrors;
|
|
1185
|
+
}>;
|
|
996
1186
|
interface AddPoolDefinitionToProgramDefinitionOptions {
|
|
997
1187
|
/**
|
|
998
1188
|
* ID of the program definition to add the pool definition to.
|
|
@@ -1002,6 +1192,24 @@ interface AddPoolDefinitionToProgramDefinitionOptions {
|
|
|
1002
1192
|
/** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
|
|
1003
1193
|
cascade: CascadeWithLiterals;
|
|
1004
1194
|
}
|
|
1195
|
+
/**
|
|
1196
|
+
* Removes a pool definition from a program definition.
|
|
1197
|
+
*
|
|
1198
|
+
* Pool definitions don't need to be contained by a program definition, so this doesn't affect the usability of this pool definition.
|
|
1199
|
+
* @param poolDefinitionId - ID of the pool definition to remove from the program definition.
|
|
1200
|
+
* @public
|
|
1201
|
+
* @documentationMaturity preview
|
|
1202
|
+
* @requiredField options
|
|
1203
|
+
* @requiredField options.cascade
|
|
1204
|
+
* @requiredField options.programDefinitionId
|
|
1205
|
+
* @requiredField poolDefinitionId
|
|
1206
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
|
|
1207
|
+
* @applicableIdentity APP
|
|
1208
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.RemovePoolDefinitionFromProgramDefinition
|
|
1209
|
+
*/
|
|
1210
|
+
declare function removePoolDefinitionFromProgramDefinition(poolDefinitionId: string, options: NonNullablePaths<RemovePoolDefinitionFromProgramDefinitionOptions, `cascade` | `programDefinitionId`, 2>): Promise<NonNullablePaths<RemovePoolDefinitionFromProgramDefinitionResponse, `poolDefinition.displayName` | `poolDefinition.programDefinitionIds` | `poolDefinition.details.benefits` | `poolDefinition.details.benefits.${number}.benefitKey` | `poolDefinition.details.creditConfiguration.amount` | `poolDefinition.programDefinitions` | `poolDefinition.programDefinitions.${number}._id`, 6> & {
|
|
1211
|
+
__validationErrorsType?: RemovePoolDefinitionFromProgramDefinitionValidationErrors;
|
|
1212
|
+
}>;
|
|
1005
1213
|
interface RemovePoolDefinitionFromProgramDefinitionOptions {
|
|
1006
1214
|
/**
|
|
1007
1215
|
* ID of the program definition to remove the pool definition from.
|
|
@@ -1011,6 +1219,20 @@ interface RemovePoolDefinitionFromProgramDefinitionOptions {
|
|
|
1011
1219
|
/** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
|
|
1012
1220
|
cascade: CascadeWithLiterals;
|
|
1013
1221
|
}
|
|
1222
|
+
/**
|
|
1223
|
+
* Retrieve all a program definition's pool definitions.
|
|
1224
|
+
* @param programDefinitionId - ID of the program definition to retrieve its pool definitions.
|
|
1225
|
+
* @public
|
|
1226
|
+
* @documentationMaturity preview
|
|
1227
|
+
* @requiredField options
|
|
1228
|
+
* @requiredField options.namespace
|
|
1229
|
+
* @requiredField programDefinitionId
|
|
1230
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
|
|
1231
|
+
* @applicableIdentity APP
|
|
1232
|
+
* @applicableIdentity VISITOR
|
|
1233
|
+
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.FindPoolDefinitionsByProgramDefinition
|
|
1234
|
+
*/
|
|
1235
|
+
declare function findPoolDefinitionsByProgramDefinition(programDefinitionId: string, options: NonNullablePaths<FindPoolDefinitionsByProgramDefinitionOptions, `namespace`, 2>): Promise<NonNullablePaths<FindPoolDefinitionsByProgramDefinitionResponse, `poolDefinitions` | `poolDefinitions.${number}.displayName` | `poolDefinitions.${number}.details.creditConfiguration.amount`, 6>>;
|
|
1014
1236
|
interface FindPoolDefinitionsByProgramDefinitionOptions {
|
|
1015
1237
|
/**
|
|
1016
1238
|
* 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.
|
|
@@ -1020,4 +1242,4 @@ interface FindPoolDefinitionsByProgramDefinitionOptions {
|
|
|
1020
1242
|
namespace: string;
|
|
1021
1243
|
}
|
|
1022
1244
|
|
|
1023
|
-
export { type
|
|
1245
|
+
export { type ActionEvent, type AddPoolDefinitionToProgramDefinitionOptions, type AddPoolDefinitionToProgramDefinitionRequest, type AddPoolDefinitionToProgramDefinitionResponse, type AddPoolDefinitionToProgramDefinitionValidationErrors, type ApplicationError, type Benefit, type BulkActionMetadata, type BulkCreatePoolDefinitionsOptions, type BulkCreatePoolDefinitionsRequest, type BulkCreatePoolDefinitionsResponse, type BulkDeletePoolDefinitionsOptions, type BulkDeletePoolDefinitionsRequest, type BulkDeletePoolDefinitionsResponse, type BulkPoolDefinitionResult, type BulkUpdatePoolDefinitionsOptions, type BulkUpdatePoolDefinitionsRequest, type BulkUpdatePoolDefinitionsResponse, type BulkUpdatePoolDefinitionsValidationErrors, Cascade, type CascadeWithLiterals, type CreatePoolDefinitionOptions, type CreatePoolDefinitionRequest, type CreatePoolDefinitionResponse, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomPolicy, type DeletePoolDefinitionOptions, type DeletePoolDefinitionRequest, type DeletePoolDefinitionResponse, type Details, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type FindPoolDefinitionsByProgramDefinitionOptions, type FindPoolDefinitionsByProgramDefinitionRequest, type FindPoolDefinitionsByProgramDefinitionResponse, type FixedIntervalPolicy, type GetPoolDefinitionRequest, type GetPoolDefinitionResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MaskedPoolDefinition, type MessageEnvelope, type Policy, type PolicyExpression, type PolicyExpressionAnd, type PolicyExpressionExpressionOneOf, type PolicyExpressionNot, type PolicyExpressionOr, PolicyExpressionType, type PolicyExpressionTypeWithLiterals, type PolicyPolicyOneOf, type PoolDefinition, type PoolDefinitionAddedToProgramDefinition, type PoolDefinitionDeletedProxySupport, type PoolDefinitionRemovedFromProgramDefinition, type PoolDefinitionUpdatedProxySupport, type PoolDefinitionsQueryBuilder, type PoolDefinitionsQueryResult, type ProgramDefinitionInfo, type QueryPoolDefinitionsRequest, type QueryPoolDefinitionsResponse, type RateLimitedPolicy, type RateLimitedPolicyPeriodOneOf, RateLimitedPolicyType, type RateLimitedPolicyTypeWithLiterals, type RemovePoolDefinitionFromProgramDefinitionOptions, type RemovePoolDefinitionFromProgramDefinitionRequest, type RemovePoolDefinitionFromProgramDefinitionResponse, type RemovePoolDefinitionFromProgramDefinitionValidationErrors, type RestoreInfo, type RolloverConfiguration, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type UpdatePoolDefinition, type UpdatePoolDefinitionOptions, type UpdatePoolDefinitionRequest, type UpdatePoolDefinitionResponse, type UpdatePoolDefinitionValidationErrors, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeekDay, type WeekDayWithLiterals, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };
|