reach-api-sdk 1.0.189 → 1.0.191
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/dist/reach-sdk.d.ts +298 -207
- package/dist/reach-sdk.js +217 -183
- package/package.json +1 -1
- package/src/definition/swagger.yaml +629 -513
- package/src/index.ts +2 -0
- package/src/models/EndUserIdentity.ts +30 -0
- package/src/models/EndUserIdentitySecureToken.ts +3 -1
- package/src/models/EventTiming.ts +12 -0
- package/src/services/DealsService.ts +24 -0
- package/src/services/EndUserIdentitySecureTokenService.ts +5 -5
- package/src/services/OrderItemsService.ts +49 -0
- package/src/services/PublicCustomersService.ts +1 -1
- package/src/services/PublicOrderItemsService.ts +189 -168
- package/src/services/PublicOrdersService.ts +227 -231
|
@@ -78,6 +78,233 @@ export class PublicOrdersService {
|
|
|
78
78
|
});
|
|
79
79
|
}
|
|
80
80
|
|
|
81
|
+
/**
|
|
82
|
+
* @returns OrderPage OK
|
|
83
|
+
* @throws ApiError
|
|
84
|
+
*/
|
|
85
|
+
public getPage({
|
|
86
|
+
xTenantSubdomain,
|
|
87
|
+
wildcard,
|
|
88
|
+
accessCode,
|
|
89
|
+
customerName,
|
|
90
|
+
email,
|
|
91
|
+
providerId,
|
|
92
|
+
venueId,
|
|
93
|
+
programmeId,
|
|
94
|
+
customerId,
|
|
95
|
+
orderIds,
|
|
96
|
+
sessionId,
|
|
97
|
+
facilityId,
|
|
98
|
+
courseId,
|
|
99
|
+
orderStage,
|
|
100
|
+
isBookedOrPendingPayment,
|
|
101
|
+
orderStages,
|
|
102
|
+
orderDateGte,
|
|
103
|
+
orderDateLte,
|
|
104
|
+
pageNumber,
|
|
105
|
+
take,
|
|
106
|
+
skip,
|
|
107
|
+
limitListRequests,
|
|
108
|
+
tenantId,
|
|
109
|
+
modifiedById,
|
|
110
|
+
modifiedByIds,
|
|
111
|
+
dateCreatedGte,
|
|
112
|
+
dateCreatedLte,
|
|
113
|
+
isLive,
|
|
114
|
+
sortOrderDirection,
|
|
115
|
+
}: {
|
|
116
|
+
xTenantSubdomain?: string;
|
|
117
|
+
/**
|
|
118
|
+
* Gets or sets the wildcard for use in a query search.
|
|
119
|
+
*/
|
|
120
|
+
wildcard?: string;
|
|
121
|
+
/**
|
|
122
|
+
* Gets or sets the access code for use in a query search.
|
|
123
|
+
*/
|
|
124
|
+
accessCode?: string;
|
|
125
|
+
/**
|
|
126
|
+
* Gets or sets the customer name for use in a query search.
|
|
127
|
+
*/
|
|
128
|
+
customerName?: string;
|
|
129
|
+
/**
|
|
130
|
+
* Gets or sets the email for use in a query search.
|
|
131
|
+
*/
|
|
132
|
+
email?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Gets or sets the provider Id for use in a query search.
|
|
135
|
+
*/
|
|
136
|
+
providerId?: string;
|
|
137
|
+
/**
|
|
138
|
+
* Gets or sets the venue Id for use in a query search.
|
|
139
|
+
*/
|
|
140
|
+
venueId?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Gets or sets the programme Id for use in a query search.
|
|
143
|
+
*/
|
|
144
|
+
programmeId?: string;
|
|
145
|
+
/**
|
|
146
|
+
* Gets or sets the customer Id for use in a query search.
|
|
147
|
+
*/
|
|
148
|
+
customerId?: string;
|
|
149
|
+
/**
|
|
150
|
+
* Gets or sets the queryable order ids.
|
|
151
|
+
*/
|
|
152
|
+
orderIds?: Array<string>;
|
|
153
|
+
/**
|
|
154
|
+
* Gets or sets the session Id for use in a query search.
|
|
155
|
+
*/
|
|
156
|
+
sessionId?: string;
|
|
157
|
+
/**
|
|
158
|
+
* Gets or sets the facility Id for use in a query search.
|
|
159
|
+
*/
|
|
160
|
+
facilityId?: string;
|
|
161
|
+
/**
|
|
162
|
+
* Gets or sets the course Id for use in a query search.
|
|
163
|
+
*/
|
|
164
|
+
courseId?: string;
|
|
165
|
+
/**
|
|
166
|
+
* Gets or sets the queryable order stage. This cannot be used in conjunction with IsBookedOrPendingPayment.
|
|
167
|
+
*/
|
|
168
|
+
orderStage?: OrderStage;
|
|
169
|
+
/**
|
|
170
|
+
* Gets or sets a value indicating whether to return orders that are either booked or pending payment. This cannot be used in conjunction with OrderStage.
|
|
171
|
+
*/
|
|
172
|
+
isBookedOrPendingPayment?: boolean;
|
|
173
|
+
/**
|
|
174
|
+
* Gets or sets the queryable order stages.
|
|
175
|
+
*/
|
|
176
|
+
orderStages?: Array<OrderStage>;
|
|
177
|
+
/**
|
|
178
|
+
* Gets or sets the queryable order date creted is greater than or equal to.
|
|
179
|
+
*/
|
|
180
|
+
orderDateGte?: string;
|
|
181
|
+
/**
|
|
182
|
+
* Gets or sets the queryable order date created is less than or equal to.
|
|
183
|
+
*/
|
|
184
|
+
orderDateLte?: string;
|
|
185
|
+
/**
|
|
186
|
+
* Gets or sets the page number for paged queries.
|
|
187
|
+
*/
|
|
188
|
+
pageNumber?: number;
|
|
189
|
+
/**
|
|
190
|
+
* Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
|
|
191
|
+
*/
|
|
192
|
+
take?: number;
|
|
193
|
+
/**
|
|
194
|
+
* Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
|
|
195
|
+
*/
|
|
196
|
+
skip?: number;
|
|
197
|
+
/**
|
|
198
|
+
* Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
|
|
199
|
+
*/
|
|
200
|
+
limitListRequests?: boolean;
|
|
201
|
+
/**
|
|
202
|
+
* Gets or sets the Tenant Id.
|
|
203
|
+
*/
|
|
204
|
+
tenantId?: string;
|
|
205
|
+
/**
|
|
206
|
+
* Gets or sets the Modifed By Id.
|
|
207
|
+
*/
|
|
208
|
+
modifiedById?: string;
|
|
209
|
+
/**
|
|
210
|
+
* Gets or sets the Modifed By Ids.
|
|
211
|
+
*/
|
|
212
|
+
modifiedByIds?: Array<string>;
|
|
213
|
+
/**
|
|
214
|
+
* Gets or sets the Date Created greater than equal to.
|
|
215
|
+
*/
|
|
216
|
+
dateCreatedGte?: string;
|
|
217
|
+
/**
|
|
218
|
+
* Gets or sets the Date Created less than equal to.
|
|
219
|
+
*/
|
|
220
|
+
dateCreatedLte?: string;
|
|
221
|
+
/**
|
|
222
|
+
* Gets or sets the queryable only is live status.
|
|
223
|
+
*/
|
|
224
|
+
isLive?: boolean;
|
|
225
|
+
/**
|
|
226
|
+
* Gets or sets the sort order direction.
|
|
227
|
+
*/
|
|
228
|
+
sortOrderDirection?: SearchSortOrderDirection;
|
|
229
|
+
}): CancelablePromise<OrderPage> {
|
|
230
|
+
return this.httpRequest.request({
|
|
231
|
+
method: 'GET',
|
|
232
|
+
url: '/api/public/orders',
|
|
233
|
+
headers: {
|
|
234
|
+
x_tenant_subdomain: xTenantSubdomain,
|
|
235
|
+
},
|
|
236
|
+
query: {
|
|
237
|
+
Wildcard: wildcard,
|
|
238
|
+
AccessCode: accessCode,
|
|
239
|
+
CustomerName: customerName,
|
|
240
|
+
Email: email,
|
|
241
|
+
ProviderId: providerId,
|
|
242
|
+
VenueId: venueId,
|
|
243
|
+
ProgrammeId: programmeId,
|
|
244
|
+
CustomerId: customerId,
|
|
245
|
+
OrderIds: orderIds,
|
|
246
|
+
SessionId: sessionId,
|
|
247
|
+
FacilityId: facilityId,
|
|
248
|
+
CourseId: courseId,
|
|
249
|
+
OrderStage: orderStage,
|
|
250
|
+
IsBookedOrPendingPayment: isBookedOrPendingPayment,
|
|
251
|
+
OrderStages: orderStages,
|
|
252
|
+
OrderDateGTE: orderDateGte,
|
|
253
|
+
OrderDateLTE: orderDateLte,
|
|
254
|
+
PageNumber: pageNumber,
|
|
255
|
+
Take: take,
|
|
256
|
+
Skip: skip,
|
|
257
|
+
LimitListRequests: limitListRequests,
|
|
258
|
+
TenantId: tenantId,
|
|
259
|
+
ModifiedById: modifiedById,
|
|
260
|
+
ModifiedByIds: modifiedByIds,
|
|
261
|
+
DateCreatedGTE: dateCreatedGte,
|
|
262
|
+
DateCreatedLTE: dateCreatedLte,
|
|
263
|
+
IsLive: isLive,
|
|
264
|
+
SortOrderDirection: sortOrderDirection,
|
|
265
|
+
},
|
|
266
|
+
errors: {
|
|
267
|
+
400: `Bad Request`,
|
|
268
|
+
422: `Unprocessable Content`,
|
|
269
|
+
500: `Internal Server Error`,
|
|
270
|
+
},
|
|
271
|
+
});
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* Deletes the resource.
|
|
276
|
+
* @returns any OK
|
|
277
|
+
* @throws ApiError
|
|
278
|
+
*/
|
|
279
|
+
public deleteByObject({
|
|
280
|
+
xTenantSubdomain,
|
|
281
|
+
requestBody,
|
|
282
|
+
}: {
|
|
283
|
+
/**
|
|
284
|
+
* The tenants subdomain.
|
|
285
|
+
*/
|
|
286
|
+
xTenantSubdomain?: string;
|
|
287
|
+
/**
|
|
288
|
+
* The <typeparamref name="TObject" /> model.
|
|
289
|
+
*/
|
|
290
|
+
requestBody?: Order;
|
|
291
|
+
}): CancelablePromise<any> {
|
|
292
|
+
return this.httpRequest.request({
|
|
293
|
+
method: 'DELETE',
|
|
294
|
+
url: '/api/public/orders',
|
|
295
|
+
headers: {
|
|
296
|
+
x_tenant_subdomain: xTenantSubdomain,
|
|
297
|
+
},
|
|
298
|
+
body: requestBody,
|
|
299
|
+
mediaType: 'application/json',
|
|
300
|
+
errors: {
|
|
301
|
+
400: `Bad Request`,
|
|
302
|
+
422: `Unprocessable Content`,
|
|
303
|
+
500: `Internal Server Error`,
|
|
304
|
+
},
|
|
305
|
+
});
|
|
306
|
+
}
|
|
307
|
+
|
|
81
308
|
/**
|
|
82
309
|
* Gets an Order and includes checks to ensure it is bookable.
|
|
83
310
|
* @returns Order OK
|
|
@@ -333,237 +560,6 @@ export class PublicOrdersService {
|
|
|
333
560
|
});
|
|
334
561
|
}
|
|
335
562
|
|
|
336
|
-
/**
|
|
337
|
-
* Deletes the resource.
|
|
338
|
-
* @returns any OK
|
|
339
|
-
* @throws ApiError
|
|
340
|
-
*/
|
|
341
|
-
public deleteByObject({
|
|
342
|
-
xTenantSubdomain,
|
|
343
|
-
requestBody,
|
|
344
|
-
}: {
|
|
345
|
-
/**
|
|
346
|
-
* The tenants subdomain.
|
|
347
|
-
*/
|
|
348
|
-
xTenantSubdomain?: string;
|
|
349
|
-
/**
|
|
350
|
-
* The <typeparamref name="TObject" /> model.
|
|
351
|
-
*/
|
|
352
|
-
requestBody?: Order;
|
|
353
|
-
}): CancelablePromise<any> {
|
|
354
|
-
return this.httpRequest.request({
|
|
355
|
-
method: 'DELETE',
|
|
356
|
-
url: '/api/public/orders',
|
|
357
|
-
headers: {
|
|
358
|
-
x_tenant_subdomain: xTenantSubdomain,
|
|
359
|
-
},
|
|
360
|
-
body: requestBody,
|
|
361
|
-
mediaType: 'application/json',
|
|
362
|
-
errors: {
|
|
363
|
-
400: `Bad Request`,
|
|
364
|
-
422: `Unprocessable Content`,
|
|
365
|
-
500: `Internal Server Error`,
|
|
366
|
-
},
|
|
367
|
-
});
|
|
368
|
-
}
|
|
369
|
-
|
|
370
|
-
/**
|
|
371
|
-
* Gets a list of resources.
|
|
372
|
-
* @returns OrderPage OK
|
|
373
|
-
* @throws ApiError
|
|
374
|
-
*/
|
|
375
|
-
public getPage({
|
|
376
|
-
xTenantSubdomain,
|
|
377
|
-
wildcard,
|
|
378
|
-
accessCode,
|
|
379
|
-
customerName,
|
|
380
|
-
email,
|
|
381
|
-
providerId,
|
|
382
|
-
venueId,
|
|
383
|
-
programmeId,
|
|
384
|
-
customerId,
|
|
385
|
-
orderIds,
|
|
386
|
-
sessionId,
|
|
387
|
-
facilityId,
|
|
388
|
-
courseId,
|
|
389
|
-
orderStage,
|
|
390
|
-
isBookedOrPendingPayment,
|
|
391
|
-
orderStages,
|
|
392
|
-
orderDateGte,
|
|
393
|
-
orderDateLte,
|
|
394
|
-
pageNumber,
|
|
395
|
-
take,
|
|
396
|
-
skip,
|
|
397
|
-
limitListRequests,
|
|
398
|
-
tenantId,
|
|
399
|
-
modifiedById,
|
|
400
|
-
modifiedByIds,
|
|
401
|
-
dateCreatedGte,
|
|
402
|
-
dateCreatedLte,
|
|
403
|
-
isLive,
|
|
404
|
-
sortOrderDirection,
|
|
405
|
-
}: {
|
|
406
|
-
/**
|
|
407
|
-
* The tenants subdomain.
|
|
408
|
-
*/
|
|
409
|
-
xTenantSubdomain?: string;
|
|
410
|
-
/**
|
|
411
|
-
* Gets or sets the wildcard for use in a query search.
|
|
412
|
-
*/
|
|
413
|
-
wildcard?: string;
|
|
414
|
-
/**
|
|
415
|
-
* Gets or sets the access code for use in a query search.
|
|
416
|
-
*/
|
|
417
|
-
accessCode?: string;
|
|
418
|
-
/**
|
|
419
|
-
* Gets or sets the customer name for use in a query search.
|
|
420
|
-
*/
|
|
421
|
-
customerName?: string;
|
|
422
|
-
/**
|
|
423
|
-
* Gets or sets the email for use in a query search.
|
|
424
|
-
*/
|
|
425
|
-
email?: string;
|
|
426
|
-
/**
|
|
427
|
-
* Gets or sets the provider Id for use in a query search.
|
|
428
|
-
*/
|
|
429
|
-
providerId?: string;
|
|
430
|
-
/**
|
|
431
|
-
* Gets or sets the venue Id for use in a query search.
|
|
432
|
-
*/
|
|
433
|
-
venueId?: string;
|
|
434
|
-
/**
|
|
435
|
-
* Gets or sets the programme Id for use in a query search.
|
|
436
|
-
*/
|
|
437
|
-
programmeId?: string;
|
|
438
|
-
/**
|
|
439
|
-
* Gets or sets the customer Id for use in a query search.
|
|
440
|
-
*/
|
|
441
|
-
customerId?: string;
|
|
442
|
-
/**
|
|
443
|
-
* Gets or sets the queryable order ids.
|
|
444
|
-
*/
|
|
445
|
-
orderIds?: Array<string>;
|
|
446
|
-
/**
|
|
447
|
-
* Gets or sets the session Id for use in a query search.
|
|
448
|
-
*/
|
|
449
|
-
sessionId?: string;
|
|
450
|
-
/**
|
|
451
|
-
* Gets or sets the facility Id for use in a query search.
|
|
452
|
-
*/
|
|
453
|
-
facilityId?: string;
|
|
454
|
-
/**
|
|
455
|
-
* Gets or sets the course Id for use in a query search.
|
|
456
|
-
*/
|
|
457
|
-
courseId?: string;
|
|
458
|
-
/**
|
|
459
|
-
* Gets or sets the queryable order stage. This cannot be used in conjunction with IsBookedOrPendingPayment.
|
|
460
|
-
*/
|
|
461
|
-
orderStage?: OrderStage;
|
|
462
|
-
/**
|
|
463
|
-
* Gets or sets a value indicating whether to return orders that are either booked or pending payment. This cannot be used in conjunction with OrderStage.
|
|
464
|
-
*/
|
|
465
|
-
isBookedOrPendingPayment?: boolean;
|
|
466
|
-
/**
|
|
467
|
-
* Gets or sets the queryable order stages.
|
|
468
|
-
*/
|
|
469
|
-
orderStages?: Array<OrderStage>;
|
|
470
|
-
/**
|
|
471
|
-
* Gets or sets the queryable order date creted is greater than or equal to.
|
|
472
|
-
*/
|
|
473
|
-
orderDateGte?: string;
|
|
474
|
-
/**
|
|
475
|
-
* Gets or sets the queryable order date created is less than or equal to.
|
|
476
|
-
*/
|
|
477
|
-
orderDateLte?: string;
|
|
478
|
-
/**
|
|
479
|
-
* Gets or sets the page number for paged queries.
|
|
480
|
-
*/
|
|
481
|
-
pageNumber?: number;
|
|
482
|
-
/**
|
|
483
|
-
* Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
|
|
484
|
-
*/
|
|
485
|
-
take?: number;
|
|
486
|
-
/**
|
|
487
|
-
* Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
|
|
488
|
-
*/
|
|
489
|
-
skip?: number;
|
|
490
|
-
/**
|
|
491
|
-
* Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
|
|
492
|
-
*/
|
|
493
|
-
limitListRequests?: boolean;
|
|
494
|
-
/**
|
|
495
|
-
* Gets or sets the Tenant Id.
|
|
496
|
-
*/
|
|
497
|
-
tenantId?: string;
|
|
498
|
-
/**
|
|
499
|
-
* Gets or sets the Modifed By Id.
|
|
500
|
-
*/
|
|
501
|
-
modifiedById?: string;
|
|
502
|
-
/**
|
|
503
|
-
* Gets or sets the Modifed By Ids.
|
|
504
|
-
*/
|
|
505
|
-
modifiedByIds?: Array<string>;
|
|
506
|
-
/**
|
|
507
|
-
* Gets or sets the Date Created greater than equal to.
|
|
508
|
-
*/
|
|
509
|
-
dateCreatedGte?: string;
|
|
510
|
-
/**
|
|
511
|
-
* Gets or sets the Date Created less than equal to.
|
|
512
|
-
*/
|
|
513
|
-
dateCreatedLte?: string;
|
|
514
|
-
/**
|
|
515
|
-
* Gets or sets the queryable only is live status.
|
|
516
|
-
*/
|
|
517
|
-
isLive?: boolean;
|
|
518
|
-
/**
|
|
519
|
-
* Gets or sets the sort order direction.
|
|
520
|
-
*/
|
|
521
|
-
sortOrderDirection?: SearchSortOrderDirection;
|
|
522
|
-
}): CancelablePromise<OrderPage> {
|
|
523
|
-
return this.httpRequest.request({
|
|
524
|
-
method: 'GET',
|
|
525
|
-
url: '/api/public/orders',
|
|
526
|
-
headers: {
|
|
527
|
-
x_tenant_subdomain: xTenantSubdomain,
|
|
528
|
-
},
|
|
529
|
-
query: {
|
|
530
|
-
Wildcard: wildcard,
|
|
531
|
-
AccessCode: accessCode,
|
|
532
|
-
CustomerName: customerName,
|
|
533
|
-
Email: email,
|
|
534
|
-
ProviderId: providerId,
|
|
535
|
-
VenueId: venueId,
|
|
536
|
-
ProgrammeId: programmeId,
|
|
537
|
-
CustomerId: customerId,
|
|
538
|
-
OrderIds: orderIds,
|
|
539
|
-
SessionId: sessionId,
|
|
540
|
-
FacilityId: facilityId,
|
|
541
|
-
CourseId: courseId,
|
|
542
|
-
OrderStage: orderStage,
|
|
543
|
-
IsBookedOrPendingPayment: isBookedOrPendingPayment,
|
|
544
|
-
OrderStages: orderStages,
|
|
545
|
-
OrderDateGTE: orderDateGte,
|
|
546
|
-
OrderDateLTE: orderDateLte,
|
|
547
|
-
PageNumber: pageNumber,
|
|
548
|
-
Take: take,
|
|
549
|
-
Skip: skip,
|
|
550
|
-
LimitListRequests: limitListRequests,
|
|
551
|
-
TenantId: tenantId,
|
|
552
|
-
ModifiedById: modifiedById,
|
|
553
|
-
ModifiedByIds: modifiedByIds,
|
|
554
|
-
DateCreatedGTE: dateCreatedGte,
|
|
555
|
-
DateCreatedLTE: dateCreatedLte,
|
|
556
|
-
IsLive: isLive,
|
|
557
|
-
SortOrderDirection: sortOrderDirection,
|
|
558
|
-
},
|
|
559
|
-
errors: {
|
|
560
|
-
400: `Bad Request`,
|
|
561
|
-
422: `Unprocessable Content`,
|
|
562
|
-
500: `Internal Server Error`,
|
|
563
|
-
},
|
|
564
|
-
});
|
|
565
|
-
}
|
|
566
|
-
|
|
567
563
|
/**
|
|
568
564
|
* Returns a value indicating whether the resource exists in the database given the provided search params.
|
|
569
565
|
* @returns boolean OK
|