reach-api-sdk 1.0.194 → 1.0.196

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 (83) hide show
  1. package/dist/reach-sdk.d.ts +7203 -1320
  2. package/dist/reach-sdk.js +4096 -26
  3. package/package.json +1 -1
  4. package/src/definition/swagger.yaml +16630 -4446
  5. package/src/index.ts +1 -0
  6. package/src/models/Tenant.ts +2 -0
  7. package/src/models/TenantStatus.ts +12 -0
  8. package/src/services/ActivityPerformanceService.ts +129 -0
  9. package/src/services/AttendeesService.ts +111 -0
  10. package/src/services/BadEnglandReportService.ts +87 -0
  11. package/src/services/BookingService.ts +201 -0
  12. package/src/services/CancellationPoliciesService.ts +111 -0
  13. package/src/services/CourseSessionSchedulesService.ts +117 -0
  14. package/src/services/CourseSessionsService.ts +213 -0
  15. package/src/services/CoursesService.ts +273 -0
  16. package/src/services/CustomersService.ts +129 -0
  17. package/src/services/DealActivitiesService.ts +123 -0
  18. package/src/services/DealsService.ts +123 -0
  19. package/src/services/DiscountCodeUsesService.ts +136 -0
  20. package/src/services/EmailReminderSchedulesService.ts +117 -0
  21. package/src/services/EmailSettingsService.ts +117 -0
  22. package/src/services/FacilitiesService.ts +135 -0
  23. package/src/services/FacilityIndividualsService.ts +93 -0
  24. package/src/services/GenericActivityService.ts +316 -0
  25. package/src/services/ImageUploadHistoryService.ts +99 -0
  26. package/src/services/ImagesService.ts +147 -0
  27. package/src/services/LeasingService.ts +195 -0
  28. package/src/services/LocationsReportService.ts +105 -0
  29. package/src/services/NotificationQueueService.ts +99 -0
  30. package/src/services/NotificationSettingsService.ts +177 -0
  31. package/src/services/OffersService.ts +165 -0
  32. package/src/services/OpenactiveFeedIntermediateService.ts +93 -0
  33. package/src/services/OpenactiveFeedItemService.ts +99 -0
  34. package/src/services/OpportunityRegisterService.ts +147 -0
  35. package/src/services/OrderItemReportService.ts +123 -0
  36. package/src/services/OrderItemsService.ts +153 -24
  37. package/src/services/OrdersService.ts +195 -0
  38. package/src/services/OrgCourseUtilisationService.ts +147 -0
  39. package/src/services/PaymentPoliciesService.ts +111 -0
  40. package/src/services/PaymentsService.ts +93 -0
  41. package/src/services/PermissionsService.ts +87 -0
  42. package/src/services/PlatformPayoutsService.ts +99 -0
  43. package/src/services/ProgrammesService.ts +117 -0
  44. package/src/services/ProvidersService.ts +189 -0
  45. package/src/services/PublicGenericActivityService.ts +25 -0
  46. package/src/services/PublicOrderItemsService.ts +0 -12
  47. package/src/services/PublicVenuesService.ts +19 -0
  48. package/src/services/PublicWaitlistOpportunityService.ts +12 -0
  49. package/src/services/RecentOrderActivityReportService.ts +87 -0
  50. package/src/services/RegisterReportService.ts +117 -0
  51. package/src/services/RescheduleLogService.ts +99 -0
  52. package/src/services/ScheduledSessionsSchedulesService.ts +123 -0
  53. package/src/services/ScheduledSessionsService.ts +249 -0
  54. package/src/services/SessionsService.ts +273 -0
  55. package/src/services/SlotOffersService.ts +99 -0
  56. package/src/services/SlotScheduleOffersService.ts +99 -0
  57. package/src/services/SlotSchedulesService.ts +129 -0
  58. package/src/services/SlotsService.ts +207 -0
  59. package/src/services/StripeAccountService.ts +99 -0
  60. package/src/services/SurveyAnswersService.ts +129 -0
  61. package/src/services/SurveyCompletionLogService.ts +123 -0
  62. package/src/services/SurveyQuestionsService.ts +93 -0
  63. package/src/services/SurveyReportExtendedService.ts +105 -0
  64. package/src/services/SurveysService.ts +123 -0
  65. package/src/services/TemplateDetailsService.ts +93 -0
  66. package/src/services/TemplateFieldPermissionsService.ts +93 -0
  67. package/src/services/TemplateOffersService.ts +93 -0
  68. package/src/services/TemplatesService.ts +93 -0
  69. package/src/services/TenantWebsiteSettingsService.ts +87 -0
  70. package/src/services/TenantsService.ts +93 -0
  71. package/src/services/TotalRevenueReportService.ts +111 -0
  72. package/src/services/UserPermissionsService.ts +93 -0
  73. package/src/services/UserProgrammesService.ts +111 -0
  74. package/src/services/UserProvidersService.ts +111 -0
  75. package/src/services/UsersService.ts +123 -0
  76. package/src/services/VenueManagersService.ts +111 -0
  77. package/src/services/VenuePerformanceService.ts +129 -0
  78. package/src/services/VenuesReportService.ts +93 -0
  79. package/src/services/VenuesService.ts +238 -0
  80. package/src/services/WaitlistActivityReportService.ts +123 -0
  81. package/src/services/WaitlistActivityService.ts +123 -0
  82. package/src/services/WaitlistOpportunityReportService.ts +170 -0
  83. package/src/services/WaitlistOpportunityService.ts +147 -0
@@ -26,6 +26,7 @@ export class WaitlistOpportunityReportService {
26
26
  scheduledSessionId,
27
27
  courseId,
28
28
  email,
29
+ futureOnly,
29
30
  pageNumber,
30
31
  take,
31
32
  skip,
@@ -59,6 +60,10 @@ export class WaitlistOpportunityReportService {
59
60
  * Gets or sets the queryable Email.
60
61
  */
61
62
  email?: string;
63
+ /**
64
+ * Gets or sets a value indicating whether to filter for future opportunities only.
65
+ */
66
+ futureOnly?: boolean;
62
67
  /**
63
68
  * Gets or sets the page number for paged queries.
64
69
  */
@@ -119,6 +124,7 @@ export class WaitlistOpportunityReportService {
119
124
  ScheduledSessionId: scheduledSessionId,
120
125
  CourseId: courseId,
121
126
  Email: email,
127
+ FutureOnly: futureOnly,
122
128
  PageNumber: pageNumber,
123
129
  Take: take,
124
130
  Skip: skip,
@@ -141,6 +147,23 @@ export class WaitlistOpportunityReportService {
141
147
  });
142
148
  }
143
149
 
150
+ /**
151
+ * Gets waitlist conversion statistics.
152
+ * @returns any OK
153
+ * @throws ApiError
154
+ */
155
+ public getConversionStats(): CancelablePromise<any> {
156
+ return this.httpRequest.request({
157
+ method: 'GET',
158
+ url: '/api/waitlist-opportunity-report/conversion-stats',
159
+ errors: {
160
+ 400: `Bad Request`,
161
+ 422: `Unprocessable Content`,
162
+ 500: `Internal Server Error`,
163
+ },
164
+ });
165
+ }
166
+
144
167
  /**
145
168
  * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
146
169
  * @returns WaitlistOpportunityReport OK
@@ -282,6 +305,7 @@ export class WaitlistOpportunityReportService {
282
305
  scheduledSessionId,
283
306
  courseId,
284
307
  email,
308
+ futureOnly,
285
309
  pageNumber,
286
310
  take,
287
311
  skip,
@@ -314,6 +338,10 @@ export class WaitlistOpportunityReportService {
314
338
  * Gets or sets the queryable Email.
315
339
  */
316
340
  email?: string;
341
+ /**
342
+ * Gets or sets a value indicating whether to filter for future opportunities only.
343
+ */
344
+ futureOnly?: boolean;
317
345
  /**
318
346
  * Gets or sets the page number for paged queries.
319
347
  */
@@ -368,6 +396,7 @@ export class WaitlistOpportunityReportService {
368
396
  ScheduledSessionId: scheduledSessionId,
369
397
  CourseId: courseId,
370
398
  Email: email,
399
+ FutureOnly: futureOnly,
371
400
  PageNumber: pageNumber,
372
401
  Take: take,
373
402
  Skip: skip,
@@ -480,6 +509,7 @@ export class WaitlistOpportunityReportService {
480
509
  scheduledSessionId,
481
510
  courseId,
482
511
  email,
512
+ futureOnly,
483
513
  pageNumber,
484
514
  take,
485
515
  skip,
@@ -512,6 +542,10 @@ export class WaitlistOpportunityReportService {
512
542
  * Gets or sets the queryable Email.
513
543
  */
514
544
  email?: string;
545
+ /**
546
+ * Gets or sets a value indicating whether to filter for future opportunities only.
547
+ */
548
+ futureOnly?: boolean;
515
549
  /**
516
550
  * Gets or sets the page number for paged queries.
517
551
  */
@@ -566,6 +600,130 @@ export class WaitlistOpportunityReportService {
566
600
  ScheduledSessionId: scheduledSessionId,
567
601
  CourseId: courseId,
568
602
  Email: email,
603
+ FutureOnly: futureOnly,
604
+ PageNumber: pageNumber,
605
+ Take: take,
606
+ Skip: skip,
607
+ LimitListRequests: limitListRequests,
608
+ TenantId: tenantId,
609
+ ModifiedById: modifiedById,
610
+ ModifiedByIds: modifiedByIds,
611
+ DateCreatedGTE: dateCreatedGte,
612
+ DateCreatedLTE: dateCreatedLte,
613
+ IsLive: isLive,
614
+ SortOrderDirection: sortOrderDirection,
615
+ },
616
+ errors: {
617
+ 400: `Bad Request`,
618
+ 422: `Unprocessable Content`,
619
+ 500: `Internal Server Error`,
620
+ },
621
+ });
622
+ }
623
+
624
+ /**
625
+ * Returns the number of results in the database given the provided search params.
626
+ * @returns number OK
627
+ * @throws ApiError
628
+ */
629
+ public count({
630
+ userId,
631
+ slotId,
632
+ scheduledSessionId,
633
+ courseId,
634
+ email,
635
+ futureOnly,
636
+ pageNumber,
637
+ take,
638
+ skip,
639
+ limitListRequests,
640
+ tenantId,
641
+ modifiedById,
642
+ modifiedByIds,
643
+ dateCreatedGte,
644
+ dateCreatedLte,
645
+ isLive,
646
+ sortOrderDirection,
647
+ }: {
648
+ /**
649
+ * Gets or sets the queryable User Id.
650
+ */
651
+ userId?: string;
652
+ /**
653
+ * Gets or sets the queryable Slot Id.
654
+ */
655
+ slotId?: string;
656
+ /**
657
+ * Gets or sets the queryable Scheduled Session Id.
658
+ */
659
+ scheduledSessionId?: string;
660
+ /**
661
+ * Gets or sets the queryable Course Id.
662
+ */
663
+ courseId?: string;
664
+ /**
665
+ * Gets or sets the queryable Email.
666
+ */
667
+ email?: string;
668
+ /**
669
+ * Gets or sets a value indicating whether to filter for future opportunities only.
670
+ */
671
+ futureOnly?: boolean;
672
+ /**
673
+ * Gets or sets the page number for paged queries.
674
+ */
675
+ pageNumber?: number;
676
+ /**
677
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
678
+ */
679
+ take?: number;
680
+ /**
681
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
682
+ */
683
+ skip?: number;
684
+ /**
685
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
686
+ */
687
+ limitListRequests?: boolean;
688
+ /**
689
+ * Gets or sets the Tenant Id.
690
+ */
691
+ tenantId?: string;
692
+ /**
693
+ * Gets or sets the Modifed By Id.
694
+ */
695
+ modifiedById?: string;
696
+ /**
697
+ * Gets or sets the Modifed By Ids.
698
+ */
699
+ modifiedByIds?: Array<string>;
700
+ /**
701
+ * Gets or sets the Date Created greater than equal to.
702
+ */
703
+ dateCreatedGte?: string;
704
+ /**
705
+ * Gets or sets the Date Created less than equal to.
706
+ */
707
+ dateCreatedLte?: string;
708
+ /**
709
+ * Gets or sets the queryable only is live status.
710
+ */
711
+ isLive?: boolean;
712
+ /**
713
+ * Gets or sets the sort order direction.
714
+ */
715
+ sortOrderDirection?: SearchSortOrderDirection;
716
+ }): CancelablePromise<number> {
717
+ return this.httpRequest.request({
718
+ method: 'GET',
719
+ url: '/api/waitlist-opportunity-report/count',
720
+ query: {
721
+ UserId: userId,
722
+ SlotId: slotId,
723
+ ScheduledSessionId: scheduledSessionId,
724
+ CourseId: courseId,
725
+ Email: email,
726
+ FutureOnly: futureOnly,
569
727
  PageNumber: pageNumber,
570
728
  Take: take,
571
729
  Skip: skip,
@@ -597,6 +755,7 @@ export class WaitlistOpportunityReportService {
597
755
  scheduledSessionId,
598
756
  courseId,
599
757
  email,
758
+ futureOnly,
600
759
  pageNumber,
601
760
  take,
602
761
  skip,
@@ -629,6 +788,10 @@ export class WaitlistOpportunityReportService {
629
788
  * Gets or sets the queryable Email.
630
789
  */
631
790
  email?: string;
791
+ /**
792
+ * Gets or sets a value indicating whether to filter for future opportunities only.
793
+ */
794
+ futureOnly?: boolean;
632
795
  /**
633
796
  * Gets or sets the page number for paged queries.
634
797
  */
@@ -683,6 +846,7 @@ export class WaitlistOpportunityReportService {
683
846
  ScheduledSessionId: scheduledSessionId,
684
847
  CourseId: courseId,
685
848
  Email: email,
849
+ FutureOnly: futureOnly,
686
850
  PageNumber: pageNumber,
687
851
  Take: take,
688
852
  Skip: skip,
@@ -714,6 +878,7 @@ export class WaitlistOpportunityReportService {
714
878
  scheduledSessionId,
715
879
  courseId,
716
880
  email,
881
+ futureOnly,
717
882
  pageNumber,
718
883
  take,
719
884
  skip,
@@ -746,6 +911,10 @@ export class WaitlistOpportunityReportService {
746
911
  * Gets or sets the queryable Email.
747
912
  */
748
913
  email?: string;
914
+ /**
915
+ * Gets or sets a value indicating whether to filter for future opportunities only.
916
+ */
917
+ futureOnly?: boolean;
749
918
  /**
750
919
  * Gets or sets the page number for paged queries.
751
920
  */
@@ -800,6 +969,7 @@ export class WaitlistOpportunityReportService {
800
969
  ScheduledSessionId: scheduledSessionId,
801
970
  CourseId: courseId,
802
971
  Email: email,
972
+ FutureOnly: futureOnly,
803
973
  PageNumber: pageNumber,
804
974
  Take: take,
805
975
  Skip: skip,
@@ -155,6 +155,7 @@ export class WaitlistOpportunityService {
155
155
  scheduledSessionId,
156
156
  courseId,
157
157
  email,
158
+ futureOnly,
158
159
  pageNumber,
159
160
  take,
160
161
  skip,
@@ -187,6 +188,10 @@ export class WaitlistOpportunityService {
187
188
  * Gets or sets the queryable Email.
188
189
  */
189
190
  email?: string;
191
+ /**
192
+ * Gets or sets a value indicating whether to filter for future opportunities only.
193
+ */
194
+ futureOnly?: boolean;
190
195
  /**
191
196
  * Gets or sets the page number for paged queries.
192
197
  */
@@ -241,6 +246,7 @@ export class WaitlistOpportunityService {
241
246
  ScheduledSessionId: scheduledSessionId,
242
247
  CourseId: courseId,
243
248
  Email: email,
249
+ FutureOnly: futureOnly,
244
250
  PageNumber: pageNumber,
245
251
  Take: take,
246
252
  Skip: skip,
@@ -353,6 +359,7 @@ export class WaitlistOpportunityService {
353
359
  scheduledSessionId,
354
360
  courseId,
355
361
  email,
362
+ futureOnly,
356
363
  pageNumber,
357
364
  take,
358
365
  skip,
@@ -385,6 +392,10 @@ export class WaitlistOpportunityService {
385
392
  * Gets or sets the queryable Email.
386
393
  */
387
394
  email?: string;
395
+ /**
396
+ * Gets or sets a value indicating whether to filter for future opportunities only.
397
+ */
398
+ futureOnly?: boolean;
388
399
  /**
389
400
  * Gets or sets the page number for paged queries.
390
401
  */
@@ -439,6 +450,130 @@ export class WaitlistOpportunityService {
439
450
  ScheduledSessionId: scheduledSessionId,
440
451
  CourseId: courseId,
441
452
  Email: email,
453
+ FutureOnly: futureOnly,
454
+ PageNumber: pageNumber,
455
+ Take: take,
456
+ Skip: skip,
457
+ LimitListRequests: limitListRequests,
458
+ TenantId: tenantId,
459
+ ModifiedById: modifiedById,
460
+ ModifiedByIds: modifiedByIds,
461
+ DateCreatedGTE: dateCreatedGte,
462
+ DateCreatedLTE: dateCreatedLte,
463
+ IsLive: isLive,
464
+ SortOrderDirection: sortOrderDirection,
465
+ },
466
+ errors: {
467
+ 400: `Bad Request`,
468
+ 422: `Unprocessable Content`,
469
+ 500: `Internal Server Error`,
470
+ },
471
+ });
472
+ }
473
+
474
+ /**
475
+ * Returns the number of results in the database given the provided search params.
476
+ * @returns number OK
477
+ * @throws ApiError
478
+ */
479
+ public count({
480
+ userId,
481
+ slotId,
482
+ scheduledSessionId,
483
+ courseId,
484
+ email,
485
+ futureOnly,
486
+ pageNumber,
487
+ take,
488
+ skip,
489
+ limitListRequests,
490
+ tenantId,
491
+ modifiedById,
492
+ modifiedByIds,
493
+ dateCreatedGte,
494
+ dateCreatedLte,
495
+ isLive,
496
+ sortOrderDirection,
497
+ }: {
498
+ /**
499
+ * Gets or sets the queryable User Id.
500
+ */
501
+ userId?: string;
502
+ /**
503
+ * Gets or sets the queryable Slot Id.
504
+ */
505
+ slotId?: string;
506
+ /**
507
+ * Gets or sets the queryable Scheduled Session Id.
508
+ */
509
+ scheduledSessionId?: string;
510
+ /**
511
+ * Gets or sets the queryable Course Id.
512
+ */
513
+ courseId?: string;
514
+ /**
515
+ * Gets or sets the queryable Email.
516
+ */
517
+ email?: string;
518
+ /**
519
+ * Gets or sets a value indicating whether to filter for future opportunities only.
520
+ */
521
+ futureOnly?: boolean;
522
+ /**
523
+ * Gets or sets the page number for paged queries.
524
+ */
525
+ pageNumber?: number;
526
+ /**
527
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
528
+ */
529
+ take?: number;
530
+ /**
531
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
532
+ */
533
+ skip?: number;
534
+ /**
535
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
536
+ */
537
+ limitListRequests?: boolean;
538
+ /**
539
+ * Gets or sets the Tenant Id.
540
+ */
541
+ tenantId?: string;
542
+ /**
543
+ * Gets or sets the Modifed By Id.
544
+ */
545
+ modifiedById?: string;
546
+ /**
547
+ * Gets or sets the Modifed By Ids.
548
+ */
549
+ modifiedByIds?: Array<string>;
550
+ /**
551
+ * Gets or sets the Date Created greater than equal to.
552
+ */
553
+ dateCreatedGte?: string;
554
+ /**
555
+ * Gets or sets the Date Created less than equal to.
556
+ */
557
+ dateCreatedLte?: string;
558
+ /**
559
+ * Gets or sets the queryable only is live status.
560
+ */
561
+ isLive?: boolean;
562
+ /**
563
+ * Gets or sets the sort order direction.
564
+ */
565
+ sortOrderDirection?: SearchSortOrderDirection;
566
+ }): CancelablePromise<number> {
567
+ return this.httpRequest.request({
568
+ method: 'GET',
569
+ url: '/api/waitlist-opportunity/count',
570
+ query: {
571
+ UserId: userId,
572
+ SlotId: slotId,
573
+ ScheduledSessionId: scheduledSessionId,
574
+ CourseId: courseId,
575
+ Email: email,
576
+ FutureOnly: futureOnly,
442
577
  PageNumber: pageNumber,
443
578
  Take: take,
444
579
  Skip: skip,
@@ -470,6 +605,7 @@ export class WaitlistOpportunityService {
470
605
  scheduledSessionId,
471
606
  courseId,
472
607
  email,
608
+ futureOnly,
473
609
  pageNumber,
474
610
  take,
475
611
  skip,
@@ -502,6 +638,10 @@ export class WaitlistOpportunityService {
502
638
  * Gets or sets the queryable Email.
503
639
  */
504
640
  email?: string;
641
+ /**
642
+ * Gets or sets a value indicating whether to filter for future opportunities only.
643
+ */
644
+ futureOnly?: boolean;
505
645
  /**
506
646
  * Gets or sets the page number for paged queries.
507
647
  */
@@ -556,6 +696,7 @@ export class WaitlistOpportunityService {
556
696
  ScheduledSessionId: scheduledSessionId,
557
697
  CourseId: courseId,
558
698
  Email: email,
699
+ FutureOnly: futureOnly,
559
700
  PageNumber: pageNumber,
560
701
  Take: take,
561
702
  Skip: skip,
@@ -587,6 +728,7 @@ export class WaitlistOpportunityService {
587
728
  scheduledSessionId,
588
729
  courseId,
589
730
  email,
731
+ futureOnly,
590
732
  pageNumber,
591
733
  take,
592
734
  skip,
@@ -619,6 +761,10 @@ export class WaitlistOpportunityService {
619
761
  * Gets or sets the queryable Email.
620
762
  */
621
763
  email?: string;
764
+ /**
765
+ * Gets or sets a value indicating whether to filter for future opportunities only.
766
+ */
767
+ futureOnly?: boolean;
622
768
  /**
623
769
  * Gets or sets the page number for paged queries.
624
770
  */
@@ -673,6 +819,7 @@ export class WaitlistOpportunityService {
673
819
  ScheduledSessionId: scheduledSessionId,
674
820
  CourseId: courseId,
675
821
  Email: email,
822
+ FutureOnly: futureOnly,
676
823
  PageNumber: pageNumber,
677
824
  Take: take,
678
825
  Skip: skip,