@wix/auto_sdk_benefit-programs_programs 1.0.8 → 1.0.9
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/{internal/cjs/src/benefit-programs-v1-program-programs.universal.d.ts → benefit-programs-v1-program-programs.universal-D8MzGxN_.d.mts} +81 -248
- package/build/{cjs/src/benefit-programs-v1-program-programs.universal.d.ts → benefit-programs-v1-program-programs.universal-D8MzGxN_.d.ts} +81 -248
- package/build/index.d.mts +113 -0
- package/build/index.d.ts +113 -0
- package/build/index.js +764 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +726 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/benefit-programs-v1-program-programs.universal.d.ts → internal/benefit-programs-v1-program-programs.universal-D8MzGxN_.d.mts} +81 -248
- package/build/internal/{es/src/benefit-programs-v1-program-programs.universal.d.ts → benefit-programs-v1-program-programs.universal-D8MzGxN_.d.ts} +81 -248
- package/build/internal/index.d.mts +113 -0
- package/build/internal/index.d.ts +113 -0
- package/build/internal/index.js +764 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +726 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +437 -0
- package/build/internal/meta.d.ts +437 -0
- package/build/internal/meta.js +530 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +495 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +437 -0
- package/build/meta.d.ts +437 -0
- package/build/meta.js +530 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +495 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.context.d.ts +0 -13
- package/build/cjs/src/benefit-programs-v1-program-programs.context.js +0 -22
- package/build/cjs/src/benefit-programs-v1-program-programs.context.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.http.d.ts +0 -57
- package/build/cjs/src/benefit-programs-v1-program-programs.http.js +0 -376
- package/build/cjs/src/benefit-programs-v1-program-programs.http.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.meta.d.ts +0 -25
- package/build/cjs/src/benefit-programs-v1-program-programs.meta.js +0 -199
- package/build/cjs/src/benefit-programs-v1-program-programs.meta.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.public.d.ts +0 -105
- package/build/cjs/src/benefit-programs-v1-program-programs.public.js +0 -67
- package/build/cjs/src/benefit-programs-v1-program-programs.public.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.types.d.ts +0 -650
- package/build/cjs/src/benefit-programs-v1-program-programs.types.js +0 -63
- package/build/cjs/src/benefit-programs-v1-program-programs.types.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.universal.js +0 -495
- package/build/cjs/src/benefit-programs-v1-program-programs.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/benefit-programs-v1-program-programs.context.d.ts +0 -13
- package/build/es/src/benefit-programs-v1-program-programs.context.js +0 -13
- package/build/es/src/benefit-programs-v1-program-programs.context.js.map +0 -1
- package/build/es/src/benefit-programs-v1-program-programs.http.d.ts +0 -57
- package/build/es/src/benefit-programs-v1-program-programs.http.js +0 -364
- package/build/es/src/benefit-programs-v1-program-programs.http.js.map +0 -1
- package/build/es/src/benefit-programs-v1-program-programs.meta.d.ts +0 -25
- package/build/es/src/benefit-programs-v1-program-programs.meta.js +0 -164
- package/build/es/src/benefit-programs-v1-program-programs.meta.js.map +0 -1
- package/build/es/src/benefit-programs-v1-program-programs.public.d.ts +0 -105
- package/build/es/src/benefit-programs-v1-program-programs.public.js +0 -49
- package/build/es/src/benefit-programs-v1-program-programs.public.js.map +0 -1
- package/build/es/src/benefit-programs-v1-program-programs.types.d.ts +0 -650
- package/build/es/src/benefit-programs-v1-program-programs.types.js +0 -60
- package/build/es/src/benefit-programs-v1-program-programs.types.js.map +0 -1
- package/build/es/src/benefit-programs-v1-program-programs.universal.js +0 -460
- package/build/es/src/benefit-programs-v1-program-programs.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.context.d.ts +0 -13
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.context.js +0 -22
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.context.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.d.ts +0 -57
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.js +0 -376
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.meta.d.ts +0 -25
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.meta.js +0 -199
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.meta.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.public.d.ts +0 -105
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.public.js +0 -67
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.public.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.d.ts +0 -650
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.js +0 -63
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.universal.js +0 -495
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.context.d.ts +0 -13
- package/build/internal/es/src/benefit-programs-v1-program-programs.context.js +0 -13
- package/build/internal/es/src/benefit-programs-v1-program-programs.context.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.http.d.ts +0 -57
- package/build/internal/es/src/benefit-programs-v1-program-programs.http.js +0 -364
- package/build/internal/es/src/benefit-programs-v1-program-programs.http.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.meta.d.ts +0 -25
- package/build/internal/es/src/benefit-programs-v1-program-programs.meta.js +0 -164
- package/build/internal/es/src/benefit-programs-v1-program-programs.meta.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.public.d.ts +0 -105
- package/build/internal/es/src/benefit-programs-v1-program-programs.public.js +0 -49
- package/build/internal/es/src/benefit-programs-v1-program-programs.public.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.types.d.ts +0 -650
- package/build/internal/es/src/benefit-programs-v1-program-programs.types.js +0 -60
- package/build/internal/es/src/benefit-programs-v1-program-programs.types.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.universal.js +0 -460
- package/build/internal/es/src/benefit-programs-v1-program-programs.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Program {
|
|
1
|
+
interface Program {
|
|
3
2
|
/**
|
|
4
3
|
* Program ID.
|
|
5
4
|
* @format GUID
|
|
@@ -51,7 +50,7 @@ export interface Program {
|
|
|
51
50
|
*/
|
|
52
51
|
displayName?: string | null;
|
|
53
52
|
/**
|
|
54
|
-
* Namespace for your app or site's benefit programs.
|
|
53
|
+
* 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.
|
|
55
54
|
* @minLength 1
|
|
56
55
|
* @maxLength 50
|
|
57
56
|
* @immutable
|
|
@@ -77,7 +76,7 @@ export interface Program {
|
|
|
77
76
|
*/
|
|
78
77
|
programDefinition?: ProgramDefinitionInfo;
|
|
79
78
|
}
|
|
80
|
-
|
|
79
|
+
declare enum ProgramStatus {
|
|
81
80
|
/** Undefined program status. */
|
|
82
81
|
UNDEFINED = "UNDEFINED",
|
|
83
82
|
/** Program is active. */
|
|
@@ -86,16 +85,16 @@ export declare enum ProgramStatus {
|
|
|
86
85
|
PAUSED = "PAUSED",
|
|
87
86
|
/** Program has ended. It can't be resumed. */
|
|
88
87
|
ENDED = "ENDED",
|
|
89
|
-
/** Program is being activated for the first time. This status
|
|
88
|
+
/** Program is being activated for the first time. This status exists for a short time during processing. */
|
|
90
89
|
PROVISIONING = "PROVISIONING",
|
|
91
|
-
/** Program is being paused. This status
|
|
90
|
+
/** Program is being paused. This status exists for a short time during processing. */
|
|
92
91
|
PAUSING = "PAUSING",
|
|
93
|
-
/** Program is being re-activated after being paused. This status
|
|
92
|
+
/** Program is being re-activated after being paused. This status exists for a short time during processing. */
|
|
94
93
|
RESUMING = "RESUMING",
|
|
95
|
-
/** Program is being ended. This status
|
|
94
|
+
/** Program is being ended. This status exists for a short time during processing. */
|
|
96
95
|
ENDING = "ENDING"
|
|
97
96
|
}
|
|
98
|
-
|
|
97
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
99
98
|
/**
|
|
100
99
|
* ID of a site visitor that hasn't logged in to the site.
|
|
101
100
|
* @format GUID
|
|
@@ -113,7 +112,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
113
112
|
wixUserId?: string;
|
|
114
113
|
}
|
|
115
114
|
/** @oneof */
|
|
116
|
-
|
|
115
|
+
interface CommonIdentificationDataIdOneOf {
|
|
117
116
|
/**
|
|
118
117
|
* ID of a site visitor that hasn't logged in to the site.
|
|
119
118
|
* @format GUID
|
|
@@ -130,7 +129,7 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
130
129
|
*/
|
|
131
130
|
wixUserId?: string;
|
|
132
131
|
}
|
|
133
|
-
|
|
132
|
+
declare enum IdentityType {
|
|
134
133
|
/** Unknown type. This value is not used. */
|
|
135
134
|
UNKNOWN = "UNKNOWN",
|
|
136
135
|
/** A site visitor who has not logged in. */
|
|
@@ -140,7 +139,7 @@ export declare enum IdentityType {
|
|
|
140
139
|
/** A Wix account holder, such as a site owner or contributor. */
|
|
141
140
|
WIX_USER = "WIX_USER"
|
|
142
141
|
}
|
|
143
|
-
|
|
142
|
+
interface ExtendedFields {
|
|
144
143
|
/**
|
|
145
144
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
146
145
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -151,7 +150,7 @@ export interface ExtendedFields {
|
|
|
151
150
|
*/
|
|
152
151
|
namespaces?: Record<string, Record<string, any>>;
|
|
153
152
|
}
|
|
154
|
-
|
|
153
|
+
interface ProgramDefinitionInfo {
|
|
155
154
|
/**
|
|
156
155
|
* Program definition ID.
|
|
157
156
|
* @format GUID
|
|
@@ -165,28 +164,28 @@ export interface ProgramDefinitionInfo {
|
|
|
165
164
|
*/
|
|
166
165
|
externalId?: string | null;
|
|
167
166
|
}
|
|
168
|
-
|
|
167
|
+
interface ProgramProvisioned {
|
|
169
168
|
/** Program which has been provisioned */
|
|
170
169
|
program?: Program;
|
|
171
170
|
}
|
|
172
|
-
|
|
171
|
+
interface ProgramRenewed {
|
|
173
172
|
/** Program which has been renewed */
|
|
174
173
|
program?: Program;
|
|
175
174
|
}
|
|
176
|
-
|
|
175
|
+
interface ProgramEnded {
|
|
177
176
|
/** Program which has been ended */
|
|
178
177
|
program?: Program;
|
|
179
178
|
}
|
|
180
|
-
|
|
179
|
+
interface ProgramPaused {
|
|
181
180
|
/** Program which has been paused */
|
|
182
181
|
program?: Program;
|
|
183
182
|
}
|
|
184
|
-
|
|
183
|
+
interface ProgramResumed {
|
|
185
184
|
/** Program which has been resumed */
|
|
186
185
|
program?: Program;
|
|
187
186
|
}
|
|
188
187
|
/** In case pool_definition_id is provided should test if it's part of a package. If it is, reject the request */
|
|
189
|
-
|
|
188
|
+
interface ProvisionProgramRequest {
|
|
190
189
|
/** The program definition or pool definition to use to provision the program. */
|
|
191
190
|
poolDefinitionLookupId: PoolDefinitionLookupId;
|
|
192
191
|
/** Program beneficiary. */
|
|
@@ -198,7 +197,7 @@ export interface ProvisionProgramRequest {
|
|
|
198
197
|
*/
|
|
199
198
|
programStatus?: ProvisionProgramRequestProgramStatus;
|
|
200
199
|
/**
|
|
201
|
-
* Namespace for your app or site's benefit programs.
|
|
200
|
+
* 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.
|
|
202
201
|
* @minLength 1
|
|
203
202
|
* @maxLength 50
|
|
204
203
|
*/
|
|
@@ -206,7 +205,7 @@ export interface ProvisionProgramRequest {
|
|
|
206
205
|
/**
|
|
207
206
|
* Program name.
|
|
208
207
|
*
|
|
209
|
-
* If you're provisioning the program from a program definition, you may want to use the same name that used for the program definition.
|
|
208
|
+
* If you're provisioning the program from a program definition, you may want to use the same name that was used for the program definition.
|
|
210
209
|
* @maxLength 64
|
|
211
210
|
*/
|
|
212
211
|
displayName?: string | null;
|
|
@@ -216,7 +215,7 @@ export interface ProvisionProgramRequest {
|
|
|
216
215
|
*/
|
|
217
216
|
externalProgramId: string;
|
|
218
217
|
}
|
|
219
|
-
|
|
218
|
+
interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
|
|
220
219
|
/**
|
|
221
220
|
* Pool definition ID.
|
|
222
221
|
* @format GUID
|
|
@@ -229,7 +228,7 @@ export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
|
|
|
229
228
|
programDefinitionId?: string;
|
|
230
229
|
}
|
|
231
230
|
/** @oneof */
|
|
232
|
-
|
|
231
|
+
interface PoolDefinitionLookupIdIdOneOf {
|
|
233
232
|
/**
|
|
234
233
|
* Pool definition ID.
|
|
235
234
|
* @format GUID
|
|
@@ -241,22 +240,22 @@ export interface PoolDefinitionLookupIdIdOneOf {
|
|
|
241
240
|
*/
|
|
242
241
|
programDefinitionId?: string;
|
|
243
242
|
}
|
|
244
|
-
|
|
243
|
+
declare enum ProvisionProgramRequestProgramStatus {
|
|
245
244
|
/** Program is active. */
|
|
246
245
|
ACTIVE = "ACTIVE",
|
|
247
246
|
/** Program is paused. */
|
|
248
247
|
PAUSED = "PAUSED"
|
|
249
248
|
}
|
|
250
|
-
|
|
249
|
+
interface ProvisionProgramResponse {
|
|
251
250
|
/**
|
|
252
|
-
* Job ID of the provisioning of the program.
|
|
251
|
+
* Job ID of the provisioning of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
|
|
253
252
|
* @format GUID
|
|
254
253
|
*/
|
|
255
254
|
jobId?: string;
|
|
256
255
|
/** Provisioned program. */
|
|
257
256
|
program?: Program;
|
|
258
257
|
}
|
|
259
|
-
|
|
258
|
+
interface ProgramAlreadyExists {
|
|
260
259
|
/**
|
|
261
260
|
* Key of a program that already exists
|
|
262
261
|
* @format GUID
|
|
@@ -269,69 +268,69 @@ export interface ProgramAlreadyExists {
|
|
|
269
268
|
namespace?: string;
|
|
270
269
|
}
|
|
271
270
|
/** Updates the pool credit amount according to the configuration. */
|
|
272
|
-
|
|
271
|
+
interface RenewProgramRequest {
|
|
273
272
|
/**
|
|
274
273
|
* ID of the program to renew.
|
|
275
274
|
* @format GUID
|
|
276
275
|
*/
|
|
277
276
|
programId: string;
|
|
278
277
|
}
|
|
279
|
-
|
|
278
|
+
interface RenewProgramResponse {
|
|
280
279
|
/**
|
|
281
|
-
* Job ID of the program renewal.
|
|
280
|
+
* Job ID of the program renewal. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
|
|
282
281
|
* @format GUID
|
|
283
282
|
*/
|
|
284
283
|
jobId?: string;
|
|
285
284
|
}
|
|
286
|
-
|
|
285
|
+
interface PauseProgramRequest {
|
|
287
286
|
/**
|
|
288
287
|
* ID of the program to pause.
|
|
289
288
|
* @format GUID
|
|
290
289
|
*/
|
|
291
290
|
programId: string;
|
|
292
291
|
}
|
|
293
|
-
|
|
292
|
+
interface PauseProgramResponse {
|
|
294
293
|
/**
|
|
295
|
-
* Job ID of the pausing of the program.
|
|
294
|
+
* Job ID of the pausing of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
|
|
296
295
|
* @format GUID
|
|
297
296
|
*/
|
|
298
297
|
jobId?: string;
|
|
299
298
|
}
|
|
300
|
-
|
|
299
|
+
interface ProgramStatusTransitionNotAllowed {
|
|
301
300
|
/** Current status of the program */
|
|
302
301
|
currentStatus?: ProgramStatus;
|
|
303
302
|
/** Status to which the program is being transitioned */
|
|
304
303
|
requestedStatus?: ProgramStatus;
|
|
305
304
|
}
|
|
306
|
-
|
|
305
|
+
interface ResumeProgramRequest {
|
|
307
306
|
/**
|
|
308
307
|
* ID of program to resume.
|
|
309
308
|
* @format GUID
|
|
310
309
|
*/
|
|
311
310
|
programId: string;
|
|
312
311
|
}
|
|
313
|
-
|
|
312
|
+
interface ResumeProgramResponse {
|
|
314
313
|
/**
|
|
315
|
-
* Job ID of the resuming of the program.
|
|
314
|
+
* Job ID of the resuming of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
|
|
316
315
|
* @format GUID
|
|
317
316
|
*/
|
|
318
317
|
jobId?: string;
|
|
319
318
|
}
|
|
320
|
-
|
|
319
|
+
interface EndProgramRequest {
|
|
321
320
|
/**
|
|
322
321
|
* ID of the program to end.
|
|
323
322
|
* @format GUID
|
|
324
323
|
*/
|
|
325
324
|
programId: string;
|
|
326
325
|
}
|
|
327
|
-
|
|
326
|
+
interface EndProgramResponse {
|
|
328
327
|
/**
|
|
329
|
-
* Job ID of the ending of the program.
|
|
328
|
+
* Job ID of the ending of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
|
|
330
329
|
* @format GUID
|
|
331
330
|
*/
|
|
332
331
|
jobId?: string;
|
|
333
332
|
}
|
|
334
|
-
|
|
333
|
+
interface UpdateProgramStatusRequest {
|
|
335
334
|
/**
|
|
336
335
|
* Program to update
|
|
337
336
|
* @format GUID
|
|
@@ -344,11 +343,11 @@ export interface UpdateProgramStatusRequest {
|
|
|
344
343
|
/** Status to update */
|
|
345
344
|
targetStatus?: ProgramStatus;
|
|
346
345
|
}
|
|
347
|
-
|
|
346
|
+
interface UpdateProgramStatusResponse {
|
|
348
347
|
/** The updated Program */
|
|
349
348
|
program?: Program;
|
|
350
349
|
}
|
|
351
|
-
|
|
350
|
+
interface UpsertMigratedProgramRequest {
|
|
352
351
|
/**
|
|
353
352
|
* Order id
|
|
354
353
|
* @format GUID
|
|
@@ -372,40 +371,40 @@ export interface UpsertMigratedProgramRequest {
|
|
|
372
371
|
*/
|
|
373
372
|
planName?: string;
|
|
374
373
|
}
|
|
375
|
-
|
|
374
|
+
declare enum OrderStatus {
|
|
376
375
|
UNKNOWN = "UNKNOWN",
|
|
377
376
|
ACTIVE = "ACTIVE",
|
|
378
377
|
PAUSED = "PAUSED",
|
|
379
378
|
ENDED = "ENDED"
|
|
380
379
|
}
|
|
381
|
-
|
|
380
|
+
interface UpsertMigratedProgramResponse {
|
|
382
381
|
/** Inserted or updated program */
|
|
383
382
|
program?: Program;
|
|
384
383
|
}
|
|
385
|
-
|
|
384
|
+
interface UpdateProgramRequest {
|
|
386
385
|
/** Program to update. */
|
|
387
386
|
program: Program;
|
|
388
387
|
}
|
|
389
|
-
|
|
388
|
+
interface UpdateProgramResponse {
|
|
390
389
|
/** Updated program. */
|
|
391
390
|
program?: Program;
|
|
392
391
|
}
|
|
393
|
-
|
|
392
|
+
interface GetProgramRequest {
|
|
394
393
|
/**
|
|
395
394
|
* ID of the program to retrieve.
|
|
396
395
|
* @format GUID
|
|
397
396
|
*/
|
|
398
397
|
programId: string;
|
|
399
398
|
}
|
|
400
|
-
|
|
399
|
+
interface GetProgramResponse {
|
|
401
400
|
/** Retrieved program. */
|
|
402
401
|
program?: Program;
|
|
403
402
|
}
|
|
404
|
-
|
|
403
|
+
interface QueryProgramsRequest {
|
|
405
404
|
/** Filter, sort, and paging to apply to the query. */
|
|
406
405
|
query?: CursorQuery;
|
|
407
406
|
}
|
|
408
|
-
|
|
407
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
409
408
|
/** 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`. */
|
|
410
409
|
cursorPaging?: CursorPaging;
|
|
411
410
|
/**
|
|
@@ -421,11 +420,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
421
420
|
sort?: Sorting[];
|
|
422
421
|
}
|
|
423
422
|
/** @oneof */
|
|
424
|
-
|
|
423
|
+
interface CursorQueryPagingMethodOneOf {
|
|
425
424
|
/** 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`. */
|
|
426
425
|
cursorPaging?: CursorPaging;
|
|
427
426
|
}
|
|
428
|
-
|
|
427
|
+
interface Sorting {
|
|
429
428
|
/**
|
|
430
429
|
* Field to sort by.
|
|
431
430
|
* @maxLength 512
|
|
@@ -438,13 +437,13 @@ export interface Sorting {
|
|
|
438
437
|
*/
|
|
439
438
|
order?: SortOrder;
|
|
440
439
|
}
|
|
441
|
-
|
|
440
|
+
declare enum SortOrder {
|
|
442
441
|
/** Ascending sort order. */
|
|
443
442
|
ASC = "ASC",
|
|
444
443
|
/** Descending sort order. */
|
|
445
444
|
DESC = "DESC"
|
|
446
445
|
}
|
|
447
|
-
|
|
446
|
+
interface CursorPaging {
|
|
448
447
|
/**
|
|
449
448
|
* Maximum number of items to return.
|
|
450
449
|
* @max 100
|
|
@@ -459,13 +458,13 @@ export interface CursorPaging {
|
|
|
459
458
|
*/
|
|
460
459
|
cursor?: string | null;
|
|
461
460
|
}
|
|
462
|
-
|
|
461
|
+
interface QueryProgramsResponse {
|
|
463
462
|
/** List of retrieved programs. */
|
|
464
463
|
programs?: Program[];
|
|
465
464
|
/** Metadata for the paginated results. */
|
|
466
465
|
metadata?: CursorPagingMetadata;
|
|
467
466
|
}
|
|
468
|
-
|
|
467
|
+
interface CursorPagingMetadata {
|
|
469
468
|
/** Number of items returned in the response. */
|
|
470
469
|
count?: number | null;
|
|
471
470
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -478,7 +477,7 @@ export interface CursorPagingMetadata {
|
|
|
478
477
|
*/
|
|
479
478
|
hasNext?: boolean | null;
|
|
480
479
|
}
|
|
481
|
-
|
|
480
|
+
interface Cursors {
|
|
482
481
|
/**
|
|
483
482
|
* Cursor string pointing to the next page in the list of results.
|
|
484
483
|
* @maxLength 16000
|
|
@@ -490,9 +489,9 @@ export interface Cursors {
|
|
|
490
489
|
*/
|
|
491
490
|
prev?: string | null;
|
|
492
491
|
}
|
|
493
|
-
|
|
492
|
+
interface GetProgramByExternalIdAndNamespaceRequest {
|
|
494
493
|
/**
|
|
495
|
-
* Namespace for your app or site's benefit programs.
|
|
494
|
+
* 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.
|
|
496
495
|
* @minLength 1
|
|
497
496
|
* @maxLength 50
|
|
498
497
|
*/
|
|
@@ -503,11 +502,11 @@ export interface GetProgramByExternalIdAndNamespaceRequest {
|
|
|
503
502
|
*/
|
|
504
503
|
externalId: string;
|
|
505
504
|
}
|
|
506
|
-
|
|
505
|
+
interface GetProgramByExternalIdAndNamespaceResponse {
|
|
507
506
|
/** Retrieved program. */
|
|
508
507
|
program?: Program;
|
|
509
508
|
}
|
|
510
|
-
|
|
509
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
511
510
|
createdEvent?: EntityCreatedEvent;
|
|
512
511
|
updatedEvent?: EntityUpdatedEvent;
|
|
513
512
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -550,19 +549,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
550
549
|
entityEventSequence?: string | null;
|
|
551
550
|
}
|
|
552
551
|
/** @oneof */
|
|
553
|
-
|
|
552
|
+
interface DomainEventBodyOneOf {
|
|
554
553
|
createdEvent?: EntityCreatedEvent;
|
|
555
554
|
updatedEvent?: EntityUpdatedEvent;
|
|
556
555
|
deletedEvent?: EntityDeletedEvent;
|
|
557
556
|
actionEvent?: ActionEvent;
|
|
558
557
|
}
|
|
559
|
-
|
|
558
|
+
interface EntityCreatedEvent {
|
|
560
559
|
entity?: string;
|
|
561
560
|
}
|
|
562
|
-
|
|
561
|
+
interface RestoreInfo {
|
|
563
562
|
deletedDate?: Date | null;
|
|
564
563
|
}
|
|
565
|
-
|
|
564
|
+
interface EntityUpdatedEvent {
|
|
566
565
|
/**
|
|
567
566
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
568
567
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -570,14 +569,14 @@ export interface EntityUpdatedEvent {
|
|
|
570
569
|
*/
|
|
571
570
|
currentEntity?: string;
|
|
572
571
|
}
|
|
573
|
-
|
|
572
|
+
interface EntityDeletedEvent {
|
|
574
573
|
/** Entity that was deleted */
|
|
575
574
|
deletedEntity?: string | null;
|
|
576
575
|
}
|
|
577
|
-
|
|
576
|
+
interface ActionEvent {
|
|
578
577
|
body?: string;
|
|
579
578
|
}
|
|
580
|
-
|
|
579
|
+
interface MessageEnvelope {
|
|
581
580
|
/**
|
|
582
581
|
* App instance ID.
|
|
583
582
|
* @format GUID
|
|
@@ -593,7 +592,7 @@ export interface MessageEnvelope {
|
|
|
593
592
|
/** Stringify payload. */
|
|
594
593
|
data?: string;
|
|
595
594
|
}
|
|
596
|
-
|
|
595
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
597
596
|
/**
|
|
598
597
|
* ID of a site visitor that has not logged in to the site.
|
|
599
598
|
* @format GUID
|
|
@@ -618,7 +617,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
618
617
|
identityType?: WebhookIdentityType;
|
|
619
618
|
}
|
|
620
619
|
/** @oneof */
|
|
621
|
-
|
|
620
|
+
interface IdentificationDataIdOneOf {
|
|
622
621
|
/**
|
|
623
622
|
* ID of a site visitor that has not logged in to the site.
|
|
624
623
|
* @format GUID
|
|
@@ -640,37 +639,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
640
639
|
*/
|
|
641
640
|
appId?: string;
|
|
642
641
|
}
|
|
643
|
-
|
|
642
|
+
declare enum WebhookIdentityType {
|
|
644
643
|
UNKNOWN = "UNKNOWN",
|
|
645
644
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
646
645
|
MEMBER = "MEMBER",
|
|
647
646
|
WIX_USER = "WIX_USER",
|
|
648
647
|
APP = "APP"
|
|
649
648
|
}
|
|
650
|
-
|
|
651
|
-
/**
|
|
652
|
-
* Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
|
|
653
|
-
*
|
|
654
|
-
* You can provision a program from a program definition or a pool definition:
|
|
655
|
-
* - **Program definition**: The program has pools that are created from the pool definitions in the program definition.
|
|
656
|
-
* - **Pool definition**: The program has 1 pool that is created from the pool definition.
|
|
657
|
-
* @param poolDefinitionLookupId - The program definition or pool definition to use to provision the program.
|
|
658
|
-
* @public
|
|
659
|
-
* @documentationMaturity preview
|
|
660
|
-
* @requiredField options.beneficiary
|
|
661
|
-
* @requiredField options.externalProgramId
|
|
662
|
-
* @requiredField options.namespace
|
|
663
|
-
* @requiredField poolDefinitionLookupId
|
|
664
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_PROVISION
|
|
665
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
666
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
667
|
-
* @applicableIdentity APP
|
|
668
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.ProvisionProgram
|
|
669
|
-
*/
|
|
670
|
-
export declare function provisionProgram(poolDefinitionLookupId: PoolDefinitionLookupId, options?: NonNullablePaths<ProvisionProgramOptions, `beneficiary` | `externalProgramId` | `namespace`>): Promise<NonNullablePaths<ProvisionProgramResponse, `jobId` | {
|
|
671
|
-
[P in ProgramNonNullablePaths]: `program.${P}`;
|
|
672
|
-
}[ProgramNonNullablePaths]>>;
|
|
673
|
-
export interface ProvisionProgramOptions {
|
|
649
|
+
interface ProvisionProgramOptions {
|
|
674
650
|
/** Program beneficiary. */
|
|
675
651
|
beneficiary: CommonIdentificationData;
|
|
676
652
|
/**
|
|
@@ -680,7 +656,7 @@ export interface ProvisionProgramOptions {
|
|
|
680
656
|
*/
|
|
681
657
|
programStatus?: ProvisionProgramRequestProgramStatus;
|
|
682
658
|
/**
|
|
683
|
-
* Namespace for your app or site's benefit programs.
|
|
659
|
+
* 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.
|
|
684
660
|
* @minLength 1
|
|
685
661
|
* @maxLength 50
|
|
686
662
|
*/
|
|
@@ -688,7 +664,7 @@ export interface ProvisionProgramOptions {
|
|
|
688
664
|
/**
|
|
689
665
|
* Program name.
|
|
690
666
|
*
|
|
691
|
-
* If you're provisioning the program from a program definition, you may want to use the same name that used for the program definition.
|
|
667
|
+
* If you're provisioning the program from a program definition, you may want to use the same name that was used for the program definition.
|
|
692
668
|
* @maxLength 64
|
|
693
669
|
*/
|
|
694
670
|
displayName?: string | null;
|
|
@@ -698,87 +674,7 @@ export interface ProvisionProgramOptions {
|
|
|
698
674
|
*/
|
|
699
675
|
externalProgramId: string;
|
|
700
676
|
}
|
|
701
|
-
|
|
702
|
-
* Renews the specified program.
|
|
703
|
-
*
|
|
704
|
-
* Balances are handled for each pool in the program as defined in the pool's credit configuration.
|
|
705
|
-
* @param programId - ID of the program to renew.
|
|
706
|
-
* @public
|
|
707
|
-
* @documentationMaturity preview
|
|
708
|
-
* @requiredField programId
|
|
709
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_RENEW
|
|
710
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
711
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
712
|
-
* @applicableIdentity APP
|
|
713
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.RenewProgram
|
|
714
|
-
*/
|
|
715
|
-
export declare function renewProgram(programId: string): Promise<NonNullablePaths<RenewProgramResponse, `jobId`>>;
|
|
716
|
-
/**
|
|
717
|
-
* Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
|
|
718
|
-
* @param programId - ID of the program to pause.
|
|
719
|
-
* @public
|
|
720
|
-
* @documentationMaturity preview
|
|
721
|
-
* @requiredField programId
|
|
722
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_PAUSE
|
|
723
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
724
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
725
|
-
* @applicableIdentity APP
|
|
726
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.PauseProgram
|
|
727
|
-
*/
|
|
728
|
-
export declare function pauseProgram(programId: string): Promise<NonNullablePaths<PauseProgramResponse, `jobId`>>;
|
|
729
|
-
/**
|
|
730
|
-
* Resumes the specified program.
|
|
731
|
-
*
|
|
732
|
-
* Call this method for paused programs.
|
|
733
|
-
* @param programId - ID of program to resume.
|
|
734
|
-
* @public
|
|
735
|
-
* @documentationMaturity preview
|
|
736
|
-
* @requiredField programId
|
|
737
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_RESUME
|
|
738
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
739
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
740
|
-
* @applicableIdentity APP
|
|
741
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.ResumeProgram
|
|
742
|
-
*/
|
|
743
|
-
export declare function resumeProgram(programId: string): Promise<NonNullablePaths<ResumeProgramResponse, `jobId`>>;
|
|
744
|
-
/**
|
|
745
|
-
* Ends the specified program.
|
|
746
|
-
*
|
|
747
|
-
* Benefits in the program's pools can't be redeemed until the program is resumed.
|
|
748
|
-
* @param programId - ID of the program to end.
|
|
749
|
-
* @public
|
|
750
|
-
* @documentationMaturity preview
|
|
751
|
-
* @requiredField programId
|
|
752
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_END
|
|
753
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
754
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
755
|
-
* @applicableIdentity APP
|
|
756
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.EndProgram
|
|
757
|
-
*/
|
|
758
|
-
export declare function endProgram(programId: string): Promise<NonNullablePaths<EndProgramResponse, `jobId`>>;
|
|
759
|
-
/**
|
|
760
|
-
* Updates a program.
|
|
761
|
-
*
|
|
762
|
-
* Each time the program definition is updated,
|
|
763
|
-
* `revision` increments by 1.
|
|
764
|
-
* The current `revision` must be passed when updating the program definition.
|
|
765
|
-
* This ensures you're working with the latest program definition
|
|
766
|
-
* and prevents unintended overwrites.
|
|
767
|
-
* @param _id - Program ID.
|
|
768
|
-
* @public
|
|
769
|
-
* @documentationMaturity preview
|
|
770
|
-
* @requiredField _id
|
|
771
|
-
* @requiredField program
|
|
772
|
-
* @requiredField program.revision
|
|
773
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_UPDATE
|
|
774
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
775
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
776
|
-
* @applicableIdentity APP
|
|
777
|
-
* @returns Updated program.
|
|
778
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.UpdateProgram
|
|
779
|
-
*/
|
|
780
|
-
export declare function updateProgram(_id: string, program: NonNullablePaths<UpdateProgram, `revision`>): Promise<NonNullablePaths<Program, ProgramNonNullablePaths>>;
|
|
781
|
-
export interface UpdateProgram {
|
|
677
|
+
interface UpdateProgram {
|
|
782
678
|
/**
|
|
783
679
|
* Program ID.
|
|
784
680
|
* @format GUID
|
|
@@ -830,7 +726,7 @@ export interface UpdateProgram {
|
|
|
830
726
|
*/
|
|
831
727
|
displayName?: string | null;
|
|
832
728
|
/**
|
|
833
|
-
* Namespace for your app or site's benefit programs.
|
|
729
|
+
* 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.
|
|
834
730
|
* @minLength 1
|
|
835
731
|
* @maxLength 50
|
|
836
732
|
* @immutable
|
|
@@ -856,49 +752,6 @@ export interface UpdateProgram {
|
|
|
856
752
|
*/
|
|
857
753
|
programDefinition?: ProgramDefinitionInfo;
|
|
858
754
|
}
|
|
859
|
-
/**
|
|
860
|
-
* Retrieves a program.
|
|
861
|
-
* @param programId - ID of the program to retrieve.
|
|
862
|
-
* @public
|
|
863
|
-
* @documentationMaturity preview
|
|
864
|
-
* @requiredField programId
|
|
865
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
|
|
866
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
867
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
868
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
869
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
870
|
-
* @permissionScope Manage Events
|
|
871
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
872
|
-
* @applicableIdentity APP
|
|
873
|
-
* @returns Retrieved program.
|
|
874
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.GetProgram
|
|
875
|
-
*/
|
|
876
|
-
export declare function getProgram(programId: string): Promise<NonNullablePaths<Program, ProgramNonNullablePaths>>;
|
|
877
|
-
/**
|
|
878
|
-
* Creates a query to retrieve a list of programs.
|
|
879
|
-
*
|
|
880
|
-
* The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
|
|
881
|
-
*
|
|
882
|
-
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
883
|
-
*
|
|
884
|
-
* You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that Query Programs returns.
|
|
885
|
-
*
|
|
886
|
-
* Query Programs has a default paging limit of 50, which you can override.
|
|
887
|
-
*
|
|
888
|
-
* For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
|
|
889
|
-
* @public
|
|
890
|
-
* @documentationMaturity preview
|
|
891
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
892
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
893
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
894
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
895
|
-
* @permissionScope Manage Events
|
|
896
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
897
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
|
|
898
|
-
* @applicableIdentity APP
|
|
899
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.QueryPrograms
|
|
900
|
-
*/
|
|
901
|
-
export declare function queryPrograms(): ProgramsQueryBuilder;
|
|
902
755
|
interface QueryCursorResult {
|
|
903
756
|
cursors: Cursors;
|
|
904
757
|
hasNext: () => boolean;
|
|
@@ -906,13 +759,13 @@ interface QueryCursorResult {
|
|
|
906
759
|
length: number;
|
|
907
760
|
pageSize: number;
|
|
908
761
|
}
|
|
909
|
-
|
|
762
|
+
interface ProgramsQueryResult extends QueryCursorResult {
|
|
910
763
|
items: Program[];
|
|
911
764
|
query: ProgramsQueryBuilder;
|
|
912
765
|
next: () => Promise<ProgramsQueryResult>;
|
|
913
766
|
prev: () => Promise<ProgramsQueryResult>;
|
|
914
767
|
}
|
|
915
|
-
|
|
768
|
+
interface ProgramsQueryBuilder {
|
|
916
769
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
917
770
|
* @param value - Value to compare against.
|
|
918
771
|
* @documentationMaturity preview
|
|
@@ -976,32 +829,12 @@ export interface ProgramsQueryBuilder {
|
|
|
976
829
|
/** @documentationMaturity preview */
|
|
977
830
|
find: () => Promise<ProgramsQueryResult>;
|
|
978
831
|
}
|
|
979
|
-
|
|
980
|
-
* Retrieves a program with the specified external ID and namespace.
|
|
981
|
-
* @param namespace - Namespace for your app or site's benefit programs.
|
|
982
|
-
* @public
|
|
983
|
-
* @documentationMaturity preview
|
|
984
|
-
* @requiredField namespace
|
|
985
|
-
* @requiredField options
|
|
986
|
-
* @requiredField options.externalId
|
|
987
|
-
* @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
|
|
988
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
989
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
990
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
991
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
992
|
-
* @permissionScope Manage Events
|
|
993
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
994
|
-
* @applicableIdentity APP
|
|
995
|
-
* @fqn wix.benefit_programs.v1.program.ProgramService.GetProgramByExternalIdAndNamespace
|
|
996
|
-
*/
|
|
997
|
-
export declare function getProgramByExternalIdAndNamespace(namespace: string, options: NonNullablePaths<GetProgramByExternalIdAndNamespaceOptions, `externalId`>): Promise<NonNullablePaths<GetProgramByExternalIdAndNamespaceResponse, {
|
|
998
|
-
[P in ProgramNonNullablePaths]: `program.${P}`;
|
|
999
|
-
}[ProgramNonNullablePaths]>>;
|
|
1000
|
-
export interface GetProgramByExternalIdAndNamespaceOptions {
|
|
832
|
+
interface GetProgramByExternalIdAndNamespaceOptions {
|
|
1001
833
|
/**
|
|
1002
834
|
* Program's external ID.
|
|
1003
835
|
* @format GUID
|
|
1004
836
|
*/
|
|
1005
837
|
externalId: string;
|
|
1006
838
|
}
|
|
1007
|
-
|
|
839
|
+
|
|
840
|
+
export { type DomainEventBodyOneOf as $, type UpdateProgramStatusResponse as A, type UpsertMigratedProgramRequest as B, type CommonIdentificationData as C, type UpsertMigratedProgramResponse as D, type EndProgramResponse as E, type UpdateProgramRequest as F, type GetProgramByExternalIdAndNamespaceOptions as G, type UpdateProgramResponse as H, IdentityType as I, type GetProgramRequest as J, type GetProgramResponse as K, type CursorQuery as L, type CursorQueryPagingMethodOneOf as M, type Sorting as N, OrderStatus as O, type PoolDefinitionLookupId as P, type QueryProgramsRequest as Q, type RenewProgramResponse as R, SortOrder as S, type CursorPaging as T, type UpdateProgram as U, type QueryProgramsResponse as V, WebhookIdentityType as W, type CursorPagingMetadata as X, type Cursors as Y, type GetProgramByExternalIdAndNamespaceRequest as Z, type DomainEvent as _, type ProvisionProgramOptions as a, type EntityCreatedEvent as a0, type RestoreInfo as a1, type EntityUpdatedEvent as a2, type EntityDeletedEvent as a3, type ActionEvent as a4, type MessageEnvelope as a5, type IdentificationData as a6, type IdentificationDataIdOneOf as a7, type ProgramsQueryResult as a8, type ProvisionProgramResponse as b, type PauseProgramResponse as c, type ResumeProgramResponse as d, type Program as e, type ProgramsQueryBuilder as f, type GetProgramByExternalIdAndNamespaceResponse as g, ProgramStatus as h, ProvisionProgramRequestProgramStatus as i, type CommonIdentificationDataIdOneOf as j, type ExtendedFields as k, type ProgramDefinitionInfo as l, type ProgramProvisioned as m, type ProgramRenewed as n, type ProgramEnded as o, type ProgramPaused as p, type ProgramResumed as q, type ProvisionProgramRequest as r, type PoolDefinitionLookupIdIdOneOf as s, type ProgramAlreadyExists as t, type RenewProgramRequest as u, type PauseProgramRequest as v, type ProgramStatusTransitionNotAllowed as w, type ResumeProgramRequest as x, type EndProgramRequest as y, type UpdateProgramStatusRequest as z };
|