@wix/auto_sdk_benefit-programs_program-definitions 1.0.0
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 +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.context.d.ts +10 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.context.js +16 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.context.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +35 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js +283 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.meta.d.ts +24 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.meta.js +142 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.meta.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +72 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.js +46 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +319 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js +42 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +528 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js +323 -0
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.context.d.ts +10 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.context.js +10 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.context.js.map +1 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +35 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.js +274 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.meta.d.ts +24 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.meta.js +110 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.meta.js.map +1 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +72 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.public.js +34 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +319 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.js +39 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +528 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js +291 -0
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.context.d.ts +10 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.context.js +16 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.context.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +35 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js +283 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.meta.d.ts +24 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.meta.js +142 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.meta.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +72 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.js +46 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +319 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js +42 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +528 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js +323 -0
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.context.d.ts +10 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.context.js +10 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.context.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +35 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.js +274 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.meta.d.ts +24 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.meta.js +110 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.meta.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +72 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.public.js +34 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +319 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.js +39 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +528 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js +291 -0
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
|
|
2
|
+
import { queryBuilder } from '@wix/sdk-runtime/query-builder';
|
|
3
|
+
import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
|
|
4
|
+
import * as ambassadorWixBenefitProgramsV1ProgramDefinition from './benefit-programs-v1-program-definition-program-definitions.http.js';
|
|
5
|
+
export var Cascade;
|
|
6
|
+
(function (Cascade) {
|
|
7
|
+
/** Unknown cascade. */
|
|
8
|
+
Cascade["UNKNOWN_CASCADE"] = "UNKNOWN_CASCADE";
|
|
9
|
+
/**
|
|
10
|
+
* Updates the associated benefit pools to reflect the new or modified pool definition. The benefits will appear in existing programs at the beginning of their next renewal cycle.
|
|
11
|
+
*
|
|
12
|
+
* Existing programs will be updated in their next renewal cycle.
|
|
13
|
+
*/
|
|
14
|
+
Cascade["NEXT_RENEWAL"] = "NEXT_RENEWAL";
|
|
15
|
+
/**
|
|
16
|
+
* Updates the associated benefit pools to reflect the new or modified pool definition immediately.
|
|
17
|
+
*
|
|
18
|
+
* Existing programs will be updated immediately.
|
|
19
|
+
*/
|
|
20
|
+
Cascade["IMMEDIATELY"] = "IMMEDIATELY";
|
|
21
|
+
/**
|
|
22
|
+
* Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
|
|
23
|
+
*
|
|
24
|
+
* Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
|
|
25
|
+
*/
|
|
26
|
+
Cascade["FUTURE_PROVISIONS"] = "FUTURE_PROVISIONS";
|
|
27
|
+
})(Cascade || (Cascade = {}));
|
|
28
|
+
export var SortOrder;
|
|
29
|
+
(function (SortOrder) {
|
|
30
|
+
/** Ascending sort order. */
|
|
31
|
+
SortOrder["ASC"] = "ASC";
|
|
32
|
+
/** Descending sort order. */
|
|
33
|
+
SortOrder["DESC"] = "DESC";
|
|
34
|
+
})(SortOrder || (SortOrder = {}));
|
|
35
|
+
export var WebhookIdentityType;
|
|
36
|
+
(function (WebhookIdentityType) {
|
|
37
|
+
WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
|
|
38
|
+
WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
|
|
39
|
+
WebhookIdentityType["MEMBER"] = "MEMBER";
|
|
40
|
+
WebhookIdentityType["WIX_USER"] = "WIX_USER";
|
|
41
|
+
WebhookIdentityType["APP"] = "APP";
|
|
42
|
+
})(WebhookIdentityType || (WebhookIdentityType = {}));
|
|
43
|
+
/**
|
|
44
|
+
* Creates a new program definition.
|
|
45
|
+
* @param programDefinition - Program definition to create.
|
|
46
|
+
* @public
|
|
47
|
+
* @documentationMaturity preview
|
|
48
|
+
* @requiredField programDefinition
|
|
49
|
+
* @requiredField programDefinition.externalId
|
|
50
|
+
* @requiredField programDefinition.namespace
|
|
51
|
+
* @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_CREATE
|
|
52
|
+
* @returns Created program definition.
|
|
53
|
+
* @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.CreateProgramDefinition
|
|
54
|
+
*/
|
|
55
|
+
export async function createProgramDefinition(programDefinition) {
|
|
56
|
+
// @ts-ignore
|
|
57
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
58
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
|
59
|
+
programDefinition: programDefinition,
|
|
60
|
+
});
|
|
61
|
+
const reqOpts = ambassadorWixBenefitProgramsV1ProgramDefinition.createProgramDefinition(payload);
|
|
62
|
+
sideEffects?.onSiteCall?.();
|
|
63
|
+
try {
|
|
64
|
+
const result = await httpClient.request(reqOpts);
|
|
65
|
+
sideEffects?.onSuccess?.(result);
|
|
66
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data)
|
|
67
|
+
?.programDefinition;
|
|
68
|
+
}
|
|
69
|
+
catch (err) {
|
|
70
|
+
const transformedError = sdkTransformError(err, {
|
|
71
|
+
spreadPathsToArguments: {},
|
|
72
|
+
explicitPathsToArguments: { programDefinition: '$[0]' },
|
|
73
|
+
singleArgumentUnchanged: false,
|
|
74
|
+
}, ['programDefinition']);
|
|
75
|
+
sideEffects?.onError?.(err);
|
|
76
|
+
throw transformedError;
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Updates a program definition.
|
|
81
|
+
*
|
|
82
|
+
* Each time the program definition is updated,
|
|
83
|
+
* `revision` increments by 1.
|
|
84
|
+
* The current `revision` must be passed when updating the program definition.
|
|
85
|
+
* This ensures you're working with the latest program definition
|
|
86
|
+
* and prevents unintended overwrites.
|
|
87
|
+
* @param _id - Program definition ID.
|
|
88
|
+
* @public
|
|
89
|
+
* @documentationMaturity preview
|
|
90
|
+
* @requiredField _id
|
|
91
|
+
* @requiredField programDefinition
|
|
92
|
+
* @requiredField programDefinition.revision
|
|
93
|
+
* @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_UPDATE
|
|
94
|
+
* @returns Updated program definition.
|
|
95
|
+
* @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.UpdateProgramDefinition
|
|
96
|
+
*/
|
|
97
|
+
export async function updateProgramDefinition(_id, programDefinition) {
|
|
98
|
+
// @ts-ignore
|
|
99
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
100
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
|
101
|
+
programDefinition: { ...programDefinition, id: _id },
|
|
102
|
+
});
|
|
103
|
+
const reqOpts = ambassadorWixBenefitProgramsV1ProgramDefinition.updateProgramDefinition(payload);
|
|
104
|
+
sideEffects?.onSiteCall?.();
|
|
105
|
+
try {
|
|
106
|
+
const result = await httpClient.request(reqOpts);
|
|
107
|
+
sideEffects?.onSuccess?.(result);
|
|
108
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data)
|
|
109
|
+
?.programDefinition;
|
|
110
|
+
}
|
|
111
|
+
catch (err) {
|
|
112
|
+
const transformedError = sdkTransformError(err, {
|
|
113
|
+
spreadPathsToArguments: { programDefinition: '$[1]' },
|
|
114
|
+
explicitPathsToArguments: { 'programDefinition.id': '$[0]' },
|
|
115
|
+
singleArgumentUnchanged: false,
|
|
116
|
+
}, ['_id', 'programDefinition']);
|
|
117
|
+
sideEffects?.onError?.(err);
|
|
118
|
+
throw transformedError;
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Deletes a program definition.
|
|
123
|
+
* @param programDefinitionId - ID of the ProgramDefinition to delete.
|
|
124
|
+
* @public
|
|
125
|
+
* @documentationMaturity preview
|
|
126
|
+
* @requiredField programDefinitionId
|
|
127
|
+
* @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_DELETE
|
|
128
|
+
* @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.DeleteProgramDefinition
|
|
129
|
+
*/
|
|
130
|
+
export async function deleteProgramDefinition(programDefinitionId, options) {
|
|
131
|
+
// @ts-ignore
|
|
132
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
133
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
|
134
|
+
programDefinitionId: programDefinitionId,
|
|
135
|
+
cascadeType: options?.cascadeType,
|
|
136
|
+
});
|
|
137
|
+
const reqOpts = ambassadorWixBenefitProgramsV1ProgramDefinition.deleteProgramDefinition(payload);
|
|
138
|
+
sideEffects?.onSiteCall?.();
|
|
139
|
+
try {
|
|
140
|
+
const result = await httpClient.request(reqOpts);
|
|
141
|
+
sideEffects?.onSuccess?.(result);
|
|
142
|
+
}
|
|
143
|
+
catch (err) {
|
|
144
|
+
const transformedError = sdkTransformError(err, {
|
|
145
|
+
spreadPathsToArguments: {},
|
|
146
|
+
explicitPathsToArguments: {
|
|
147
|
+
programDefinitionId: '$[0]',
|
|
148
|
+
cascadeType: '$[1].cascadeType',
|
|
149
|
+
},
|
|
150
|
+
singleArgumentUnchanged: false,
|
|
151
|
+
}, ['programDefinitionId', 'options']);
|
|
152
|
+
sideEffects?.onError?.(err);
|
|
153
|
+
throw transformedError;
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Retrieves a program definition.
|
|
158
|
+
* @param programDefinitionId - ID of the program definition to retrieve.
|
|
159
|
+
* @public
|
|
160
|
+
* @documentationMaturity preview
|
|
161
|
+
* @requiredField programDefinitionId
|
|
162
|
+
* @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
|
|
163
|
+
* @applicableIdentity VISITOR
|
|
164
|
+
* @returns Retrieved program definition.
|
|
165
|
+
* @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinition
|
|
166
|
+
*/
|
|
167
|
+
export async function getProgramDefinition(programDefinitionId) {
|
|
168
|
+
// @ts-ignore
|
|
169
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
170
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
|
171
|
+
programDefinitionId: programDefinitionId,
|
|
172
|
+
});
|
|
173
|
+
const reqOpts = ambassadorWixBenefitProgramsV1ProgramDefinition.getProgramDefinition(payload);
|
|
174
|
+
sideEffects?.onSiteCall?.();
|
|
175
|
+
try {
|
|
176
|
+
const result = await httpClient.request(reqOpts);
|
|
177
|
+
sideEffects?.onSuccess?.(result);
|
|
178
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data)
|
|
179
|
+
?.programDefinition;
|
|
180
|
+
}
|
|
181
|
+
catch (err) {
|
|
182
|
+
const transformedError = sdkTransformError(err, {
|
|
183
|
+
spreadPathsToArguments: {},
|
|
184
|
+
explicitPathsToArguments: { programDefinitionId: '$[0]' },
|
|
185
|
+
singleArgumentUnchanged: false,
|
|
186
|
+
}, ['programDefinitionId']);
|
|
187
|
+
sideEffects?.onError?.(err);
|
|
188
|
+
throw transformedError;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Retrieves a program definition by specifying the program definition's external ID and associated namespace.
|
|
193
|
+
*
|
|
194
|
+
* Use this method when you need to retrieve a program definition without its program definition ID.
|
|
195
|
+
* @param namespace - Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
|
|
196
|
+
* @public
|
|
197
|
+
* @documentationMaturity preview
|
|
198
|
+
* @requiredField namespace
|
|
199
|
+
* @requiredField options
|
|
200
|
+
* @requiredField options.externalId
|
|
201
|
+
* @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
|
|
202
|
+
* @applicableIdentity VISITOR
|
|
203
|
+
* @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinitionByExternalIdAndNamespace
|
|
204
|
+
*/
|
|
205
|
+
export async function getProgramDefinitionByExternalIdAndNamespace(namespace, options) {
|
|
206
|
+
// @ts-ignore
|
|
207
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
208
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
|
209
|
+
namespace: namespace,
|
|
210
|
+
externalId: options?.externalId,
|
|
211
|
+
});
|
|
212
|
+
const reqOpts = ambassadorWixBenefitProgramsV1ProgramDefinition.getProgramDefinitionByExternalIdAndNamespace(payload);
|
|
213
|
+
sideEffects?.onSiteCall?.();
|
|
214
|
+
try {
|
|
215
|
+
const result = await httpClient.request(reqOpts);
|
|
216
|
+
sideEffects?.onSuccess?.(result);
|
|
217
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data);
|
|
218
|
+
}
|
|
219
|
+
catch (err) {
|
|
220
|
+
const transformedError = sdkTransformError(err, {
|
|
221
|
+
spreadPathsToArguments: {},
|
|
222
|
+
explicitPathsToArguments: {
|
|
223
|
+
namespace: '$[0]',
|
|
224
|
+
externalId: '$[1].externalId',
|
|
225
|
+
},
|
|
226
|
+
singleArgumentUnchanged: false,
|
|
227
|
+
}, ['namespace', 'options']);
|
|
228
|
+
sideEffects?.onError?.(err);
|
|
229
|
+
throw transformedError;
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Creates a query to retrieve a list of program definitions.
|
|
234
|
+
*
|
|
235
|
+
* The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
|
|
236
|
+
*
|
|
237
|
+
* The returned object contains the query definition, which is used to run the query using the [`find()`](/program-definitions/program-definitions-query-builder/find) function.
|
|
238
|
+
*
|
|
239
|
+
* You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryProgramDefinitions()` returns.
|
|
240
|
+
*
|
|
241
|
+
* The following `ProgramDefinitionsQueryBuilder` functions are supported for `queryProgramDefinitions()`. For a full description of the program definition object, see the object returned for the [`items`](/program-definitions/program-definitions-query-result/items) property in `ProgramDefinitionsQueryResult`.
|
|
242
|
+
* @public
|
|
243
|
+
* @documentationMaturity preview
|
|
244
|
+
* @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
|
|
245
|
+
* @applicableIdentity VISITOR
|
|
246
|
+
* @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.QueryProgramDefinitions
|
|
247
|
+
*/
|
|
248
|
+
export function queryProgramDefinitions() {
|
|
249
|
+
// @ts-ignore
|
|
250
|
+
const { httpClient, sideEffects } = arguments[0];
|
|
251
|
+
return queryBuilder({
|
|
252
|
+
func: async (payload) => {
|
|
253
|
+
const reqOpts = ambassadorWixBenefitProgramsV1ProgramDefinition.queryProgramDefinitions(payload);
|
|
254
|
+
sideEffects?.onSiteCall?.();
|
|
255
|
+
try {
|
|
256
|
+
const result = await httpClient.request(reqOpts);
|
|
257
|
+
sideEffects?.onSuccess?.(result);
|
|
258
|
+
return result;
|
|
259
|
+
}
|
|
260
|
+
catch (err) {
|
|
261
|
+
sideEffects?.onError?.(err);
|
|
262
|
+
throw err;
|
|
263
|
+
}
|
|
264
|
+
},
|
|
265
|
+
requestTransformer: (query) => {
|
|
266
|
+
const args = [query, {}];
|
|
267
|
+
return renameKeysFromSDKRequestToRESTRequest({
|
|
268
|
+
...args?.[1],
|
|
269
|
+
query: args?.[0],
|
|
270
|
+
});
|
|
271
|
+
},
|
|
272
|
+
responseTransformer: ({ data, }) => {
|
|
273
|
+
const transformedData = renameKeysFromRESTResponseToSDKResponse(data);
|
|
274
|
+
return {
|
|
275
|
+
items: transformedData?.programDefinitions,
|
|
276
|
+
pagingMetadata: transformedData?.metadata,
|
|
277
|
+
};
|
|
278
|
+
},
|
|
279
|
+
errorTransformer: (err) => {
|
|
280
|
+
const transformedError = sdkTransformError(err, {
|
|
281
|
+
spreadPathsToArguments: {},
|
|
282
|
+
explicitPathsToArguments: { query: '$[0]' },
|
|
283
|
+
singleArgumentUnchanged: false,
|
|
284
|
+
});
|
|
285
|
+
throw transformedError;
|
|
286
|
+
},
|
|
287
|
+
pagingMethod: 'CURSOR',
|
|
288
|
+
transformationPaths: {},
|
|
289
|
+
});
|
|
290
|
+
}
|
|
291
|
+
//# sourceMappingURL=benefit-programs-v1-program-definition-program-definitions.universal.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.universal.js","sourceRoot":"","sources":["../../../../src/benefit-programs-v1-program-definition-program-definitions.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,+CAA+C,MAAM,sEAAsE,CAAC;AAkFxI,MAAM,CAAN,IAAY,OAqBX;AArBD,WAAY,OAAO;IACjB,uBAAuB;IACvB,8CAAmC,CAAA;IACnC;;;;OAIG;IACH,wCAA6B,CAAA;IAC7B;;;;OAIG;IACH,sCAA2B,CAAA;IAC3B;;;;OAIG;IACH,kDAAuC,CAAA;AACzC,CAAC,EArBW,OAAO,KAAP,OAAO,QAqBlB;AA+DD,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAiLD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,iBAAoC;IAEpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,iBAAiB,EAAE,iBAAiB;KACrC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,uBAAuB,CACrE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;YACvD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,mBAAmB,CAAC,CACtB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,GAAkB,EAClB,iBAA0C;IAE1C,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,iBAAiB,EAAE,EAAE,GAAG,iBAAiB,EAAE,EAAE,EAAE,GAAG,EAAE;KACrD,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,uBAAuB,CACrE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;YACrD,wBAAwB,EAAE,EAAE,sBAAsB,EAAE,MAAM,EAAE;YAC5D,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAC7B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAuCD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,mBAA2B,EAC3B,OAAwC;IAExC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,mBAAmB,EAAE,mBAAmB;QACxC,WAAW,EAAE,OAAO,EAAE,WAAW;KAClC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,uBAAuB,CACrE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,mBAAmB,EAAE,MAAM;gBAC3B,WAAW,EAAE,kBAAkB;aAChC;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,qBAAqB,EAAE,SAAS,CAAC,CACnC,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAUD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,mBAA2B;IAE3B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,mBAAmB,EAAE,mBAAmB;KACzC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,oBAAoB,CAClE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE;YACzD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,qBAAqB,CAAC,CACxB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,4CAA4C,CAChE,SAAiB,EACjB,OAA4D;IAE5D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,SAAS,EAAE,SAAS;QACpB,UAAU,EAAE,OAAO,EAAE,UAAU;KAChC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,4CAA4C,CAC1F,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,SAAS,EAAE,MAAM;gBACjB,UAAU,EAAE,iBAAiB;aAC9B;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,EAAE,SAAS,CAAC,CACzB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAOD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,uBAAuB;IACrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,YAAY,CAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAuC,EAAE,EAAE;YACtD,MAAM,OAAO,GACX,+CAA+C,CAAC,uBAAuB,CACrE,OAAO,CACR,CAAC;YAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAA8C,EAAE,EAAE;YACrE,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAAkD,CAAC;YAC1E,OAAO,qCAAqC,CAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EACpB,IAAI,GAC0C,EAAE,EAAE;YAClD,MAAM,eAAe,GAAG,uCAAuC,CAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,kBAAkB;gBAC1C,cAAc,EAAE,eAAe,EAAE,QAAQ;aAC1C,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@wix/auto_sdk_benefit-programs_program-definitions",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"publishConfig": {
|
|
5
|
+
"registry": "https://registry.npmjs.org/",
|
|
6
|
+
"access": "public"
|
|
7
|
+
},
|
|
8
|
+
"keywords": [],
|
|
9
|
+
"sideEffects": false,
|
|
10
|
+
"main": "./build/cjs/index.js",
|
|
11
|
+
"types": "./build/es/index.d.ts",
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"import": "./build/es/index.js",
|
|
15
|
+
"require": "./build/cjs/index.js",
|
|
16
|
+
"types": "./build/es/index.d.ts"
|
|
17
|
+
},
|
|
18
|
+
"./package.json": "./package.json",
|
|
19
|
+
"./meta": {
|
|
20
|
+
"import": "./build/es/meta.js",
|
|
21
|
+
"require": "./build/cjs/meta.js",
|
|
22
|
+
"types": "./build/es/meta.d.ts"
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"build",
|
|
27
|
+
"meta",
|
|
28
|
+
"service-plugins"
|
|
29
|
+
],
|
|
30
|
+
"dependencies": {
|
|
31
|
+
"@wix/sdk-runtime": "^0.3.35",
|
|
32
|
+
"@wix/sdk-types": "^1.12.4"
|
|
33
|
+
},
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"typescript": "^5.3.2"
|
|
36
|
+
},
|
|
37
|
+
"scripts": {
|
|
38
|
+
"build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
|
|
39
|
+
"test": ":"
|
|
40
|
+
},
|
|
41
|
+
"wix": {
|
|
42
|
+
"artifact": {
|
|
43
|
+
"artifactId": "auto-sdk-benefit-programs-program-definitions",
|
|
44
|
+
"groupId": "com.wixpress.public-sdk-dependencies"
|
|
45
|
+
},
|
|
46
|
+
"sdkDependency": {
|
|
47
|
+
"fqdnNamespace": "programDefinitions",
|
|
48
|
+
"fqdn": "wix.benefit_programs.v1.program_definition"
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
"falconPackageHash": "70d12b3270b6c2202ba699785e7b4d72f9afab2719dbaa08f1ec3aca"
|
|
52
|
+
}
|