reach-api-sdk 1.0.190 → 1.0.192

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.
Files changed (32) hide show
  1. package/dist/reach-sdk.d.ts +756 -419
  2. package/dist/reach-sdk.js +355 -182
  3. package/package.json +1 -1
  4. package/src/apiClient.ts +3 -0
  5. package/src/definition/swagger.yaml +1129 -651
  6. package/src/index.ts +4 -0
  7. package/src/models/Course.ts +4 -0
  8. package/src/models/EndUserIdentity.ts +30 -0
  9. package/src/models/EndUserIdentitySecureToken.ts +2 -0
  10. package/src/models/EventTiming.ts +12 -0
  11. package/src/models/Session.ts +4 -0
  12. package/src/models/TenantWebsiteSetting.ts +3 -0
  13. package/src/models/UpcomingLayout.ts +12 -0
  14. package/src/services/BookingService.ts +36 -0
  15. package/src/services/CoursesService.ts +24 -0
  16. package/src/services/DealsService.ts +24 -0
  17. package/src/services/EndUserIdentitySecureTokenService.ts +4 -4
  18. package/src/services/LeasingService.ts +24 -0
  19. package/src/services/OrderItemsService.ts +73 -0
  20. package/src/services/OrdersService.ts +24 -0
  21. package/src/services/PublicBookingService.ts +12 -0
  22. package/src/services/PublicCalendarService.ts +57 -0
  23. package/src/services/PublicCoursesService.ts +12 -0
  24. package/src/services/PublicLeasingService.ts +12 -0
  25. package/src/services/PublicNetworksService.ts +6 -0
  26. package/src/services/PublicOrderItemsService.ts +201 -168
  27. package/src/services/PublicOrdersService.ts +239 -231
  28. package/src/services/PublicScheduledSessionsService.ts +12 -0
  29. package/src/services/PublicSessionsService.ts +18 -0
  30. package/src/services/ScheduledSessionsSchedulesService.ts +24 -0
  31. package/src/services/ScheduledSessionsService.ts +24 -0
  32. package/src/services/SessionsService.ts +24 -0
@@ -2,6 +2,7 @@
2
2
  /* istanbul ignore file */
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
+ import type { EventTiming } from '../models/EventTiming';
5
6
  import type { OrderItem } from '../models/OrderItem';
6
7
  import type { OrderItemPage } from '../models/OrderItemPage';
7
8
  import type { OrderItemPatch } from '../models/OrderItemPatch';
@@ -200,6 +201,9 @@ export class OrderItemsService {
200
201
  status,
201
202
  statuses,
202
203
  parentOrderItemId,
204
+ orderByOpportunityStartdate,
205
+ eventTiming,
206
+ endUserIdentityId,
203
207
  pageNumber,
204
208
  take,
205
209
  skip,
@@ -244,6 +248,18 @@ export class OrderItemsService {
244
248
  * Gets or sets the queryable parent order item id id.
245
249
  */
246
250
  parentOrderItemId?: string;
251
+ /**
252
+ * Gets or sets the queryable order by opportunity start date value.
253
+ */
254
+ orderByOpportunityStartdate?: boolean;
255
+ /**
256
+ * Gets or sets the queryable event timing.
257
+ */
258
+ eventTiming?: EventTiming;
259
+ /**
260
+ * Gets or sets the end user identity Id for use in a query search.
261
+ */
262
+ endUserIdentityId?: string;
247
263
  /**
248
264
  * Gets or sets the page number for paged queries.
249
265
  */
@@ -301,6 +317,9 @@ export class OrderItemsService {
301
317
  Status: status,
302
318
  Statuses: statuses,
303
319
  ParentOrderItemId: parentOrderItemId,
320
+ OrderByOpportunityStartdate: orderByOpportunityStartdate,
321
+ EventTiming: eventTiming,
322
+ EndUserIdentityId: endUserIdentityId,
304
323
  PageNumber: pageNumber,
305
324
  Take: take,
306
325
  Skip: skip,
@@ -416,6 +435,9 @@ export class OrderItemsService {
416
435
  status,
417
436
  statuses,
418
437
  parentOrderItemId,
438
+ orderByOpportunityStartdate,
439
+ eventTiming,
440
+ endUserIdentityId,
419
441
  pageNumber,
420
442
  take,
421
443
  skip,
@@ -460,6 +482,18 @@ export class OrderItemsService {
460
482
  * Gets or sets the queryable parent order item id id.
461
483
  */
462
484
  parentOrderItemId?: string;
485
+ /**
486
+ * Gets or sets the queryable order by opportunity start date value.
487
+ */
488
+ orderByOpportunityStartdate?: boolean;
489
+ /**
490
+ * Gets or sets the queryable event timing.
491
+ */
492
+ eventTiming?: EventTiming;
493
+ /**
494
+ * Gets or sets the end user identity Id for use in a query search.
495
+ */
496
+ endUserIdentityId?: string;
463
497
  /**
464
498
  * Gets or sets the page number for paged queries.
465
499
  */
@@ -517,6 +551,9 @@ export class OrderItemsService {
517
551
  Status: status,
518
552
  Statuses: statuses,
519
553
  ParentOrderItemId: parentOrderItemId,
554
+ OrderByOpportunityStartdate: orderByOpportunityStartdate,
555
+ EventTiming: eventTiming,
556
+ EndUserIdentityId: endUserIdentityId,
520
557
  PageNumber: pageNumber,
521
558
  Take: take,
522
559
  Skip: skip,
@@ -551,6 +588,9 @@ export class OrderItemsService {
551
588
  status,
552
589
  statuses,
553
590
  parentOrderItemId,
591
+ orderByOpportunityStartdate,
592
+ eventTiming,
593
+ endUserIdentityId,
554
594
  pageNumber,
555
595
  take,
556
596
  skip,
@@ -595,6 +635,18 @@ export class OrderItemsService {
595
635
  * Gets or sets the queryable parent order item id id.
596
636
  */
597
637
  parentOrderItemId?: string;
638
+ /**
639
+ * Gets or sets the queryable order by opportunity start date value.
640
+ */
641
+ orderByOpportunityStartdate?: boolean;
642
+ /**
643
+ * Gets or sets the queryable event timing.
644
+ */
645
+ eventTiming?: EventTiming;
646
+ /**
647
+ * Gets or sets the end user identity Id for use in a query search.
648
+ */
649
+ endUserIdentityId?: string;
598
650
  /**
599
651
  * Gets or sets the page number for paged queries.
600
652
  */
@@ -652,6 +704,9 @@ export class OrderItemsService {
652
704
  Status: status,
653
705
  Statuses: statuses,
654
706
  ParentOrderItemId: parentOrderItemId,
707
+ OrderByOpportunityStartdate: orderByOpportunityStartdate,
708
+ EventTiming: eventTiming,
709
+ EndUserIdentityId: endUserIdentityId,
655
710
  PageNumber: pageNumber,
656
711
  Take: take,
657
712
  Skip: skip,
@@ -686,6 +741,9 @@ export class OrderItemsService {
686
741
  status,
687
742
  statuses,
688
743
  parentOrderItemId,
744
+ orderByOpportunityStartdate,
745
+ eventTiming,
746
+ endUserIdentityId,
689
747
  pageNumber,
690
748
  take,
691
749
  skip,
@@ -730,6 +788,18 @@ export class OrderItemsService {
730
788
  * Gets or sets the queryable parent order item id id.
731
789
  */
732
790
  parentOrderItemId?: string;
791
+ /**
792
+ * Gets or sets the queryable order by opportunity start date value.
793
+ */
794
+ orderByOpportunityStartdate?: boolean;
795
+ /**
796
+ * Gets or sets the queryable event timing.
797
+ */
798
+ eventTiming?: EventTiming;
799
+ /**
800
+ * Gets or sets the end user identity Id for use in a query search.
801
+ */
802
+ endUserIdentityId?: string;
733
803
  /**
734
804
  * Gets or sets the page number for paged queries.
735
805
  */
@@ -787,6 +857,9 @@ export class OrderItemsService {
787
857
  Status: status,
788
858
  Statuses: statuses,
789
859
  ParentOrderItemId: parentOrderItemId,
860
+ OrderByOpportunityStartdate: orderByOpportunityStartdate,
861
+ EventTiming: eventTiming,
862
+ EndUserIdentityId: endUserIdentityId,
790
863
  PageNumber: pageNumber,
791
864
  Take: take,
792
865
  Skip: skip,
@@ -476,6 +476,7 @@ export class OrdersService {
476
476
  orderStages,
477
477
  orderDateGte,
478
478
  orderDateLte,
479
+ endUserIdentityId,
479
480
  pageNumber,
480
481
  take,
481
482
  skip,
@@ -556,6 +557,10 @@ export class OrdersService {
556
557
  * Gets or sets the queryable order date created is less than or equal to.
557
558
  */
558
559
  orderDateLte?: string;
560
+ /**
561
+ * Gets or sets the end user identity Id for use in a query search.
562
+ */
563
+ endUserIdentityId?: string;
559
564
  /**
560
565
  * Gets or sets the page number for paged queries.
561
566
  */
@@ -622,6 +627,7 @@ export class OrdersService {
622
627
  OrderStages: orderStages,
623
628
  OrderDateGTE: orderDateGte,
624
629
  OrderDateLTE: orderDateLte,
630
+ EndUserIdentityId: endUserIdentityId,
625
631
  PageNumber: pageNumber,
626
632
  Take: take,
627
633
  Skip: skip,
@@ -746,6 +752,7 @@ export class OrdersService {
746
752
  orderStages,
747
753
  orderDateGte,
748
754
  orderDateLte,
755
+ endUserIdentityId,
749
756
  pageNumber,
750
757
  take,
751
758
  skip,
@@ -826,6 +833,10 @@ export class OrdersService {
826
833
  * Gets or sets the queryable order date created is less than or equal to.
827
834
  */
828
835
  orderDateLte?: string;
836
+ /**
837
+ * Gets or sets the end user identity Id for use in a query search.
838
+ */
839
+ endUserIdentityId?: string;
829
840
  /**
830
841
  * Gets or sets the page number for paged queries.
831
842
  */
@@ -892,6 +903,7 @@ export class OrdersService {
892
903
  OrderStages: orderStages,
893
904
  OrderDateGTE: orderDateGte,
894
905
  OrderDateLTE: orderDateLte,
906
+ EndUserIdentityId: endUserIdentityId,
895
907
  PageNumber: pageNumber,
896
908
  Take: take,
897
909
  Skip: skip,
@@ -935,6 +947,7 @@ export class OrdersService {
935
947
  orderStages,
936
948
  orderDateGte,
937
949
  orderDateLte,
950
+ endUserIdentityId,
938
951
  pageNumber,
939
952
  take,
940
953
  skip,
@@ -1015,6 +1028,10 @@ export class OrdersService {
1015
1028
  * Gets or sets the queryable order date created is less than or equal to.
1016
1029
  */
1017
1030
  orderDateLte?: string;
1031
+ /**
1032
+ * Gets or sets the end user identity Id for use in a query search.
1033
+ */
1034
+ endUserIdentityId?: string;
1018
1035
  /**
1019
1036
  * Gets or sets the page number for paged queries.
1020
1037
  */
@@ -1081,6 +1098,7 @@ export class OrdersService {
1081
1098
  OrderStages: orderStages,
1082
1099
  OrderDateGTE: orderDateGte,
1083
1100
  OrderDateLTE: orderDateLte,
1101
+ EndUserIdentityId: endUserIdentityId,
1084
1102
  PageNumber: pageNumber,
1085
1103
  Take: take,
1086
1104
  Skip: skip,
@@ -1124,6 +1142,7 @@ export class OrdersService {
1124
1142
  orderStages,
1125
1143
  orderDateGte,
1126
1144
  orderDateLte,
1145
+ endUserIdentityId,
1127
1146
  pageNumber,
1128
1147
  take,
1129
1148
  skip,
@@ -1204,6 +1223,10 @@ export class OrdersService {
1204
1223
  * Gets or sets the queryable order date created is less than or equal to.
1205
1224
  */
1206
1225
  orderDateLte?: string;
1226
+ /**
1227
+ * Gets or sets the end user identity Id for use in a query search.
1228
+ */
1229
+ endUserIdentityId?: string;
1207
1230
  /**
1208
1231
  * Gets or sets the page number for paged queries.
1209
1232
  */
@@ -1270,6 +1293,7 @@ export class OrdersService {
1270
1293
  OrderStages: orderStages,
1271
1294
  OrderDateGTE: orderDateGte,
1272
1295
  OrderDateLTE: orderDateLte,
1296
+ EndUserIdentityId: endUserIdentityId,
1273
1297
  PageNumber: pageNumber,
1274
1298
  Take: take,
1275
1299
  Skip: skip,
@@ -211,6 +211,7 @@ export class PublicBookingService {
211
211
  orderStages,
212
212
  orderDateGte,
213
213
  orderDateLte,
214
+ endUserIdentityId,
214
215
  pageNumber,
215
216
  take,
216
217
  skip,
@@ -299,6 +300,10 @@ export class PublicBookingService {
299
300
  * Gets or sets the queryable order date created is less than or equal to.
300
301
  */
301
302
  orderDateLte?: string;
303
+ /**
304
+ * Gets or sets the end user identity Id for use in a query search.
305
+ */
306
+ endUserIdentityId?: string;
302
307
  /**
303
308
  * Gets or sets the page number for paged queries.
304
309
  */
@@ -369,6 +374,7 @@ export class PublicBookingService {
369
374
  OrderStages: orderStages,
370
375
  OrderDateGTE: orderDateGte,
371
376
  OrderDateLTE: orderDateLte,
377
+ EndUserIdentityId: endUserIdentityId,
372
378
  PageNumber: pageNumber,
373
379
  Take: take,
374
380
  Skip: skip,
@@ -484,6 +490,7 @@ export class PublicBookingService {
484
490
  orderStages,
485
491
  orderDateGte,
486
492
  orderDateLte,
493
+ endUserIdentityId,
487
494
  pageNumber,
488
495
  take,
489
496
  skip,
@@ -572,6 +579,10 @@ export class PublicBookingService {
572
579
  * Gets or sets the queryable order date created is less than or equal to.
573
580
  */
574
581
  orderDateLte?: string;
582
+ /**
583
+ * Gets or sets the end user identity Id for use in a query search.
584
+ */
585
+ endUserIdentityId?: string;
575
586
  /**
576
587
  * Gets or sets the page number for paged queries.
577
588
  */
@@ -642,6 +653,7 @@ export class PublicBookingService {
642
653
  OrderStages: orderStages,
643
654
  OrderDateGTE: orderDateGte,
644
655
  OrderDateLTE: orderDateLte,
656
+ EndUserIdentityId: endUserIdentityId,
645
657
  PageNumber: pageNumber,
646
658
  Take: take,
647
659
  Skip: skip,
@@ -0,0 +1,57 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { CancelablePromise } from '../core/CancelablePromise';
6
+ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
7
+
8
+ export class PublicCalendarService {
9
+ constructor(public readonly httpRequest: BaseHttpRequest) {}
10
+
11
+ /**
12
+ * Gets calendar data.
13
+ * @returns any OK
14
+ * @throws ApiError
15
+ */
16
+ public getCalendarView({
17
+ xTenantSubdomain,
18
+ startDateTimeGte,
19
+ venueId,
20
+ programmeId,
21
+ }: {
22
+ /**
23
+ * The tenants subdomain.
24
+ */
25
+ xTenantSubdomain?: string;
26
+ /**
27
+ * Gets or sets the queryable calendar item start date time is greater than or equal to.
28
+ */
29
+ startDateTimeGte?: string;
30
+ /**
31
+ * Gets or sets the venue Id for use in a query search.
32
+ */
33
+ venueId?: string;
34
+ /**
35
+ * Gets or sets the programme Id for use in a query search.
36
+ */
37
+ programmeId?: string;
38
+ }): CancelablePromise<any> {
39
+ return this.httpRequest.request({
40
+ method: 'GET',
41
+ url: '/api/public/calendar',
42
+ headers: {
43
+ 'x-tenant-subdomain': xTenantSubdomain,
44
+ },
45
+ query: {
46
+ StartDateTimeGTE: startDateTimeGte,
47
+ VenueId: venueId,
48
+ ProgrammeId: programmeId,
49
+ },
50
+ errors: {
51
+ 400: `Bad Request`,
52
+ 422: `Unprocessable Content`,
53
+ 500: `Internal Server Error`,
54
+ },
55
+ });
56
+ }
57
+ }
@@ -105,6 +105,7 @@ export class PublicCoursesService {
105
105
  remainingUsesGte,
106
106
  futureOnly,
107
107
  online,
108
+ featured,
108
109
  hasAvailability,
109
110
  orderFirstNameContains,
110
111
  orderLastNameContains,
@@ -207,6 +208,10 @@ export class PublicCoursesService {
207
208
  * Gets or sets a value indicating whether return online courses.
208
209
  */
209
210
  online?: boolean;
211
+ /**
212
+ * Gets or sets a value indicating whether the course is featured on the storefront.
213
+ */
214
+ featured?: boolean;
210
215
  /**
211
216
  * Gets or sets a value indicating whether the scheduled session has availability.
212
217
  */
@@ -315,6 +320,7 @@ export class PublicCoursesService {
315
320
  RemainingUsesGTE: remainingUsesGte,
316
321
  FutureOnly: futureOnly,
317
322
  Online: online,
323
+ Featured: featured,
318
324
  HasAvailability: hasAvailability,
319
325
  OrderFirstNameContains: orderFirstNameContains,
320
326
  OrderLastNameContains: orderLastNameContains,
@@ -507,6 +513,7 @@ export class PublicCoursesService {
507
513
  remainingUsesGte,
508
514
  futureOnly,
509
515
  online,
516
+ featured,
510
517
  hasAvailability,
511
518
  orderFirstNameContains,
512
519
  orderLastNameContains,
@@ -612,6 +619,10 @@ export class PublicCoursesService {
612
619
  * Gets or sets a value indicating whether return online courses.
613
620
  */
614
621
  online?: boolean;
622
+ /**
623
+ * Gets or sets a value indicating whether the course is featured on the storefront.
624
+ */
625
+ featured?: boolean;
615
626
  /**
616
627
  * Gets or sets a value indicating whether the scheduled session has availability.
617
628
  */
@@ -720,6 +731,7 @@ export class PublicCoursesService {
720
731
  RemainingUsesGTE: remainingUsesGte,
721
732
  FutureOnly: futureOnly,
722
733
  Online: online,
734
+ Featured: featured,
723
735
  HasAvailability: hasAvailability,
724
736
  OrderFirstNameContains: orderFirstNameContains,
725
737
  OrderLastNameContains: orderLastNameContains,
@@ -365,6 +365,7 @@ export class PublicLeasingService {
365
365
  orderStages,
366
366
  orderDateGte,
367
367
  orderDateLte,
368
+ endUserIdentityId,
368
369
  pageNumber,
369
370
  take,
370
371
  skip,
@@ -449,6 +450,10 @@ export class PublicLeasingService {
449
450
  * Gets or sets the queryable order date created is less than or equal to.
450
451
  */
451
452
  orderDateLte?: string;
453
+ /**
454
+ * Gets or sets the end user identity Id for use in a query search.
455
+ */
456
+ endUserIdentityId?: string;
452
457
  /**
453
458
  * Gets or sets the page number for paged queries.
454
459
  */
@@ -518,6 +523,7 @@ export class PublicLeasingService {
518
523
  OrderStages: orderStages,
519
524
  OrderDateGTE: orderDateGte,
520
525
  OrderDateLTE: orderDateLte,
526
+ EndUserIdentityId: endUserIdentityId,
521
527
  PageNumber: pageNumber,
522
528
  Take: take,
523
529
  Skip: skip,
@@ -562,6 +568,7 @@ export class PublicLeasingService {
562
568
  orderStages,
563
569
  orderDateGte,
564
570
  orderDateLte,
571
+ endUserIdentityId,
565
572
  pageNumber,
566
573
  take,
567
574
  skip,
@@ -646,6 +653,10 @@ export class PublicLeasingService {
646
653
  * Gets or sets the queryable order date created is less than or equal to.
647
654
  */
648
655
  orderDateLte?: string;
656
+ /**
657
+ * Gets or sets the end user identity Id for use in a query search.
658
+ */
659
+ endUserIdentityId?: string;
649
660
  /**
650
661
  * Gets or sets the page number for paged queries.
651
662
  */
@@ -715,6 +726,7 @@ export class PublicLeasingService {
715
726
  OrderStages: orderStages,
716
727
  OrderDateGTE: orderDateGte,
717
728
  OrderDateLTE: orderDateLte,
729
+ EndUserIdentityId: endUserIdentityId,
718
730
  PageNumber: pageNumber,
719
731
  Take: take,
720
732
  Skip: skip,
@@ -27,6 +27,7 @@ export class PublicNetworksService {
27
27
  paymentPolicyId,
28
28
  futureOnly,
29
29
  online,
30
+ featured,
30
31
  programmeId,
31
32
  includeNextOpportunity,
32
33
  allowTemplating,
@@ -89,6 +90,10 @@ export class PublicNetworksService {
89
90
  * Gets or sets a value indicating whether return online sessions.
90
91
  */
91
92
  online?: boolean;
93
+ /**
94
+ * Gets or sets a value indicating whether the session is featured on the storefront.
95
+ */
96
+ featured?: boolean;
92
97
  /**
93
98
  * Gets or sets the queryable Programme Id.
94
99
  */
@@ -233,6 +238,7 @@ export class PublicNetworksService {
233
238
  PaymentPolicyId: paymentPolicyId,
234
239
  FutureOnly: futureOnly,
235
240
  Online: online,
241
+ Featured: featured,
236
242
  ProgrammeId: programmeId,
237
243
  IncludeNextOpportunity: includeNextOpportunity,
238
244
  AllowTemplating: allowTemplating,