@wix/auto_sdk_benefit-programs_pool-definitions 1.0.23 → 1.0.25

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,6 +1,6 @@
1
- import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
- import { P as PoolDefinition, C as CreatePoolDefinitionOptions, B as BulkCreatePoolDefinitionsOptions, a as BulkCreatePoolDefinitionsResponse, U as UpdatePoolDefinition, b as UpdatePoolDefinitionOptions, c as BulkUpdatePoolDefinitionsOptions, d as BulkUpdatePoolDefinitionsResponse, D as DeletePoolDefinitionOptions, e as BulkDeletePoolDefinitionsOptions, f as BulkDeletePoolDefinitionsResponse, g as PoolDefinitionsQueryBuilder, A as AddPoolDefinitionToProgramDefinitionOptions, h as AddPoolDefinitionToProgramDefinitionResponse, R as RemovePoolDefinitionFromProgramDefinitionOptions, i as RemovePoolDefinitionFromProgramDefinitionResponse, F as FindPoolDefinitionsByProgramDefinitionOptions, j as FindPoolDefinitionsByProgramDefinitionResponse } from './benefit-programs-v1-pool-definition-pool-definitions.universal-DxzRfpcA.js';
3
- export { ap as ActionEvent, ag as AddPoolDefinitionToProgramDefinitionRequest, Z as ApplicationError, p as Benefit, _ as BulkActionMetadata, V as BulkCreatePoolDefinitionsRequest, a5 as BulkDeletePoolDefinitionsRequest, X as BulkPoolDefinitionResult, a1 as BulkUpdatePoolDefinitionsRequest, m as Cascade, O as CreatePoolDefinitionRequest, Q as CreatePoolDefinitionResponse, G as CreditConfiguration, ac as CursorPaging, ae as CursorPagingMetadata, a9 as CursorQuery, aa as CursorQueryPagingMethodOneOf, af as Cursors, E as CustomPolicy, a3 as DeletePoolDefinitionRequest, a4 as DeletePoolDefinitionResponse, o as Details, aj as DomainEvent, ak as DomainEventBodyOneOf, al as EntityCreatedEvent, ao as EntityDeletedEvent, an as EntityUpdatedEvent, I as ExtendedFields, ai as FindPoolDefinitionsByProgramDefinitionRequest, x as FixedIntervalPolicy, a6 as GetPoolDefinitionRequest, a7 as GetPoolDefinitionResponse, ar as IdentificationData, as as IdentificationDataIdOneOf, Y as ItemMetadata, a2 as MaskedPoolDefinition, aq as MessageEnvelope, v as Policy, q as PolicyExpression, t as PolicyExpressionAnd, r as PolicyExpressionExpressionOneOf, s as PolicyExpressionNot, u as PolicyExpressionOr, k as PolicyExpressionType, w as PolicyPolicyOneOf, K as PoolDefinitionAddedToProgramDefinition, N as PoolDefinitionDeletedProxySupport, L as PoolDefinitionRemovedFromProgramDefinition, M as PoolDefinitionUpdatedProxySupport, at as PoolDefinitionsQueryResult, J as ProgramDefinitionInfo, a8 as QueryPoolDefinitionsRequest, ad as QueryPoolDefinitionsResponse, y as RateLimitedPolicy, z as RateLimitedPolicyPeriodOneOf, l as RateLimitedPolicyType, ah as RemovePoolDefinitionFromProgramDefinitionRequest, am as RestoreInfo, H as RolloverConfiguration, S as SortOrder, ab as Sorting, T as Type, $ as UpdatePoolDefinitionRequest, a0 as UpdatePoolDefinitionResponse, n as WebhookIdentityType, W as WeekDay } from './benefit-programs-v1-pool-definition-pool-definitions.universal-DxzRfpcA.js';
1
+ import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
+ import { PoolDefinition, CreatePoolDefinitionOptions, BulkCreatePoolDefinitionsOptions, BulkCreatePoolDefinitionsResponse, UpdatePoolDefinition, UpdatePoolDefinitionOptions, UpdatePoolDefinitionValidationErrors, BulkUpdatePoolDefinitionsOptions, BulkUpdatePoolDefinitionsResponse, BulkUpdatePoolDefinitionsValidationErrors, DeletePoolDefinitionOptions, BulkDeletePoolDefinitionsOptions, BulkDeletePoolDefinitionsResponse, PoolDefinitionsQueryBuilder, AddPoolDefinitionToProgramDefinitionOptions, AddPoolDefinitionToProgramDefinitionResponse, AddPoolDefinitionToProgramDefinitionValidationErrors, RemovePoolDefinitionFromProgramDefinitionOptions, RemovePoolDefinitionFromProgramDefinitionResponse, RemovePoolDefinitionFromProgramDefinitionValidationErrors, FindPoolDefinitionsByProgramDefinitionOptions, FindPoolDefinitionsByProgramDefinitionResponse } from './index.typings.js';
3
+ export { ActionEvent, AddPoolDefinitionToProgramDefinitionRequest, ApplicationError, Benefit, BulkActionMetadata, BulkCreatePoolDefinitionsRequest, BulkDeletePoolDefinitionsRequest, BulkPoolDefinitionResult, BulkUpdatePoolDefinitionsRequest, Cascade, CascadeWithLiterals, CreatePoolDefinitionRequest, CreatePoolDefinitionResponse, CreditConfiguration, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomPolicy, DeletePoolDefinitionRequest, DeletePoolDefinitionResponse, Details, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, FindPoolDefinitionsByProgramDefinitionRequest, FixedIntervalPolicy, GetPoolDefinitionRequest, GetPoolDefinitionResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MaskedPoolDefinition, MessageEnvelope, Policy, PolicyExpression, PolicyExpressionAnd, PolicyExpressionExpressionOneOf, PolicyExpressionNot, PolicyExpressionOr, PolicyExpressionType, PolicyExpressionTypeWithLiterals, PolicyPolicyOneOf, PoolDefinitionAddedToProgramDefinition, PoolDefinitionDeletedProxySupport, PoolDefinitionRemovedFromProgramDefinition, PoolDefinitionUpdatedProxySupport, PoolDefinitionsQueryResult, ProgramDefinitionInfo, QueryPoolDefinitionsRequest, QueryPoolDefinitionsResponse, RateLimitedPolicy, RateLimitedPolicyPeriodOneOf, RateLimitedPolicyType, RateLimitedPolicyTypeWithLiterals, RemovePoolDefinitionFromProgramDefinitionRequest, RestoreInfo, RolloverConfiguration, SortOrder, SortOrderWithLiterals, Sorting, Type, TypeWithLiterals, UpdatePoolDefinitionRequest, UpdatePoolDefinitionResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeekDay, WeekDayWithLiterals } from './index.typings.js';
4
4
 
5
5
  declare function createPoolDefinition$1(httpClient: HttpClient): CreatePoolDefinitionSignature;
6
6
  interface CreatePoolDefinitionSignature {
@@ -9,7 +9,7 @@ interface CreatePoolDefinitionSignature {
9
9
  * @param - Pool definition to create.
10
10
  * @returns Created pool definition.
11
11
  */
12
- (poolDefinition: PoolDefinition, options?: CreatePoolDefinitionOptions | undefined): Promise<PoolDefinition>;
12
+ (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>>;
13
13
  }
14
14
  declare function bulkCreatePoolDefinitions$1(httpClient: HttpClient): BulkCreatePoolDefinitionsSignature;
15
15
  interface BulkCreatePoolDefinitionsSignature {
@@ -17,7 +17,7 @@ interface BulkCreatePoolDefinitionsSignature {
17
17
  * Creates pool definitions.
18
18
  * @param - Pool definitions to create.
19
19
  */
20
- (poolDefinitions: PoolDefinition[], options?: BulkCreatePoolDefinitionsOptions | undefined): Promise<BulkCreatePoolDefinitionsResponse>;
20
+ (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>>;
21
21
  }
22
22
  declare function updatePoolDefinition$1(httpClient: HttpClient): UpdatePoolDefinitionSignature;
23
23
  interface UpdatePoolDefinitionSignature {
@@ -32,14 +32,18 @@ interface UpdatePoolDefinitionSignature {
32
32
  * @param - Pool definition ID.
33
33
  * @returns Updated pool definition.
34
34
  */
35
- (_id: string, poolDefinition: UpdatePoolDefinition, options?: UpdatePoolDefinitionOptions | undefined): Promise<PoolDefinition>;
35
+ (_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> & {
36
+ __validationErrorsType?: UpdatePoolDefinitionValidationErrors;
37
+ }>;
36
38
  }
37
39
  declare function bulkUpdatePoolDefinitions$1(httpClient: HttpClient): BulkUpdatePoolDefinitionsSignature;
38
40
  interface BulkUpdatePoolDefinitionsSignature {
39
41
  /**
40
42
  * Updates pool definitions.
41
43
  */
42
- (options?: BulkUpdatePoolDefinitionsOptions | undefined): Promise<BulkUpdatePoolDefinitionsResponse>;
44
+ (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> & {
45
+ __validationErrorsType?: BulkUpdatePoolDefinitionsValidationErrors;
46
+ }>;
43
47
  }
44
48
  declare function deletePoolDefinition$1(httpClient: HttpClient): DeletePoolDefinitionSignature;
45
49
  interface DeletePoolDefinitionSignature {
@@ -47,7 +51,7 @@ interface DeletePoolDefinitionSignature {
47
51
  * Deletes a pool definition.
48
52
  * @param - ID of the pool definition to delete.
49
53
  */
50
- (poolDefinitionId: string, options?: DeletePoolDefinitionOptions | undefined): Promise<void>;
54
+ (poolDefinitionId: string, options?: DeletePoolDefinitionOptions): Promise<void>;
51
55
  }
52
56
  declare function bulkDeletePoolDefinitions$1(httpClient: HttpClient): BulkDeletePoolDefinitionsSignature;
53
57
  interface BulkDeletePoolDefinitionsSignature {
@@ -55,7 +59,7 @@ interface BulkDeletePoolDefinitionsSignature {
55
59
  * Deletes pool definitions.
56
60
  * @param - List of IDs of the pool definitions to delete.
57
61
  */
58
- (poolDefinitionIds: string[], options?: BulkDeletePoolDefinitionsOptions | undefined): Promise<BulkDeletePoolDefinitionsResponse>;
62
+ (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>>;
59
63
  }
60
64
  declare function getPoolDefinition$1(httpClient: HttpClient): GetPoolDefinitionSignature;
61
65
  interface GetPoolDefinitionSignature {
@@ -64,7 +68,7 @@ interface GetPoolDefinitionSignature {
64
68
  * @param - ID of the pool definition to retrieve.
65
69
  * @returns Retrieved pool definition.
66
70
  */
67
- (poolDefinitionId: string): Promise<PoolDefinition>;
71
+ (poolDefinitionId: string): Promise<NonNullablePaths<PoolDefinition, `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `programDefinitions` | `programDefinitions.${number}._id`, 5>>;
68
72
  }
69
73
  declare function queryPoolDefinitions$1(httpClient: HttpClient): QueryPoolDefinitionsSignature;
70
74
  interface QueryPoolDefinitionsSignature {
@@ -91,7 +95,9 @@ interface AddPoolDefinitionToProgramDefinitionSignature {
91
95
  * Pool definitions can be contained by multiple program definitions, so this doesn't affect other program definitions that contain this pool definition.
92
96
  * @param - ID of the pool definition to add to the program definition.
93
97
  */
94
- (poolDefinitionId: string, options: AddPoolDefinitionToProgramDefinitionOptions): Promise<AddPoolDefinitionToProgramDefinitionResponse>;
98
+ (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> & {
99
+ __validationErrorsType?: AddPoolDefinitionToProgramDefinitionValidationErrors;
100
+ }>;
95
101
  }
96
102
  declare function removePoolDefinitionFromProgramDefinition$1(httpClient: HttpClient): RemovePoolDefinitionFromProgramDefinitionSignature;
97
103
  interface RemovePoolDefinitionFromProgramDefinitionSignature {
@@ -101,7 +107,9 @@ interface RemovePoolDefinitionFromProgramDefinitionSignature {
101
107
  * Pool definitions don't need to be contained by a program definition, so this doesn't affect the usability of this pool definition.
102
108
  * @param - ID of the pool definition to remove from the program definition.
103
109
  */
104
- (poolDefinitionId: string, options: RemovePoolDefinitionFromProgramDefinitionOptions): Promise<RemovePoolDefinitionFromProgramDefinitionResponse>;
110
+ (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> & {
111
+ __validationErrorsType?: RemovePoolDefinitionFromProgramDefinitionValidationErrors;
112
+ }>;
105
113
  }
106
114
  declare function findPoolDefinitionsByProgramDefinition$1(httpClient: HttpClient): FindPoolDefinitionsByProgramDefinitionSignature;
107
115
  interface FindPoolDefinitionsByProgramDefinitionSignature {
@@ -109,7 +117,7 @@ interface FindPoolDefinitionsByProgramDefinitionSignature {
109
117
  * Retrieve all a program definition's pool definitions.
110
118
  * @param - ID of the program definition to retrieve its pool definitions.
111
119
  */
112
- (programDefinitionId: string, options: FindPoolDefinitionsByProgramDefinitionOptions): Promise<FindPoolDefinitionsByProgramDefinitionResponse>;
120
+ (programDefinitionId: string, options: NonNullablePaths<FindPoolDefinitionsByProgramDefinitionOptions, `namespace`, 2>): Promise<NonNullablePaths<FindPoolDefinitionsByProgramDefinitionResponse, `poolDefinitions` | `poolDefinitions.${number}.displayName` | `poolDefinitions.${number}.details.creditConfiguration.amount`, 6>>;
113
121
  }
114
122
 
115
123
  declare const createPoolDefinition: MaybeContext<BuildRESTFunction<typeof createPoolDefinition$1> & typeof createPoolDefinition$1>;
@@ -124,4 +132,4 @@ declare const addPoolDefinitionToProgramDefinition: MaybeContext<BuildRESTFuncti
124
132
  declare const removePoolDefinitionFromProgramDefinition: MaybeContext<BuildRESTFunction<typeof removePoolDefinitionFromProgramDefinition$1> & typeof removePoolDefinitionFromProgramDefinition$1>;
125
133
  declare const findPoolDefinitionsByProgramDefinition: MaybeContext<BuildRESTFunction<typeof findPoolDefinitionsByProgramDefinition$1> & typeof findPoolDefinitionsByProgramDefinition$1>;
126
134
 
127
- export { AddPoolDefinitionToProgramDefinitionOptions, AddPoolDefinitionToProgramDefinitionResponse, BulkCreatePoolDefinitionsOptions, BulkCreatePoolDefinitionsResponse, BulkDeletePoolDefinitionsOptions, BulkDeletePoolDefinitionsResponse, BulkUpdatePoolDefinitionsOptions, BulkUpdatePoolDefinitionsResponse, CreatePoolDefinitionOptions, DeletePoolDefinitionOptions, FindPoolDefinitionsByProgramDefinitionOptions, FindPoolDefinitionsByProgramDefinitionResponse, PoolDefinition, PoolDefinitionsQueryBuilder, RemovePoolDefinitionFromProgramDefinitionOptions, RemovePoolDefinitionFromProgramDefinitionResponse, UpdatePoolDefinition, UpdatePoolDefinitionOptions, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };
135
+ export { AddPoolDefinitionToProgramDefinitionOptions, AddPoolDefinitionToProgramDefinitionResponse, AddPoolDefinitionToProgramDefinitionValidationErrors, BulkCreatePoolDefinitionsOptions, BulkCreatePoolDefinitionsResponse, BulkDeletePoolDefinitionsOptions, BulkDeletePoolDefinitionsResponse, BulkUpdatePoolDefinitionsOptions, BulkUpdatePoolDefinitionsResponse, BulkUpdatePoolDefinitionsValidationErrors, CreatePoolDefinitionOptions, DeletePoolDefinitionOptions, FindPoolDefinitionsByProgramDefinitionOptions, FindPoolDefinitionsByProgramDefinitionResponse, PoolDefinition, PoolDefinitionsQueryBuilder, RemovePoolDefinitionFromProgramDefinitionOptions, RemovePoolDefinitionFromProgramDefinitionResponse, RemovePoolDefinitionFromProgramDefinitionValidationErrors, UpdatePoolDefinition, UpdatePoolDefinitionOptions, UpdatePoolDefinitionValidationErrors, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };