reach-api-sdk 1.0.194 → 1.0.195

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 (82) hide show
  1. package/dist/reach-sdk.d.ts +6676 -871
  2. package/dist/reach-sdk.js +4290 -272
  3. package/package.json +1 -1
  4. package/src/definition/swagger.yaml +16349 -4310
  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 +105 -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/RecentOrderActivityReportService.ts +87 -0
  49. package/src/services/RegisterReportService.ts +117 -0
  50. package/src/services/RescheduleLogService.ts +99 -0
  51. package/src/services/ScheduledSessionsSchedulesService.ts +123 -0
  52. package/src/services/ScheduledSessionsService.ts +249 -0
  53. package/src/services/SessionsService.ts +273 -0
  54. package/src/services/SlotOffersService.ts +99 -0
  55. package/src/services/SlotScheduleOffersService.ts +99 -0
  56. package/src/services/SlotSchedulesService.ts +129 -0
  57. package/src/services/SlotsService.ts +207 -0
  58. package/src/services/StripeAccountService.ts +99 -0
  59. package/src/services/SurveyAnswersService.ts +129 -0
  60. package/src/services/SurveyCompletionLogService.ts +123 -0
  61. package/src/services/SurveyQuestionsService.ts +93 -0
  62. package/src/services/SurveyReportExtendedService.ts +105 -0
  63. package/src/services/SurveysService.ts +123 -0
  64. package/src/services/TemplateDetailsService.ts +93 -0
  65. package/src/services/TemplateFieldPermissionsService.ts +93 -0
  66. package/src/services/TemplateOffersService.ts +93 -0
  67. package/src/services/TemplatesService.ts +93 -0
  68. package/src/services/TenantWebsiteSettingsService.ts +87 -0
  69. package/src/services/TenantsService.ts +93 -0
  70. package/src/services/TotalRevenueReportService.ts +111 -0
  71. package/src/services/UserPermissionsService.ts +93 -0
  72. package/src/services/UserProgrammesService.ts +111 -0
  73. package/src/services/UserProvidersService.ts +111 -0
  74. package/src/services/UsersService.ts +123 -0
  75. package/src/services/VenueManagersService.ts +111 -0
  76. package/src/services/VenuePerformanceService.ts +129 -0
  77. package/src/services/VenuesReportService.ts +93 -0
  78. package/src/services/VenuesService.ts +238 -0
  79. package/src/services/WaitlistActivityReportService.ts +123 -0
  80. package/src/services/WaitlistActivityService.ts +123 -0
  81. package/src/services/WaitlistOpportunityReportService.ts +117 -0
  82. package/src/services/WaitlistOpportunityService.ts +117 -0
@@ -423,6 +423,105 @@ export class RescheduleLogService {
423
423
  });
424
424
  }
425
425
 
426
+ /**
427
+ * Returns the number of results in the database given the provided search params.
428
+ * @returns number OK
429
+ * @throws ApiError
430
+ */
431
+ public count({
432
+ scheduledSessionId,
433
+ courseSessionId,
434
+ pageNumber,
435
+ take,
436
+ skip,
437
+ limitListRequests,
438
+ tenantId,
439
+ modifiedById,
440
+ modifiedByIds,
441
+ dateCreatedGte,
442
+ dateCreatedLte,
443
+ isLive,
444
+ sortOrderDirection,
445
+ }: {
446
+ /**
447
+ * Gets or sets the queryable scheduled session id.
448
+ */
449
+ scheduledSessionId?: string;
450
+ /**
451
+ * Gets or sets the queryable course session id.
452
+ */
453
+ courseSessionId?: string;
454
+ /**
455
+ * Gets or sets the page number for paged queries.
456
+ */
457
+ pageNumber?: number;
458
+ /**
459
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
460
+ */
461
+ take?: number;
462
+ /**
463
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
464
+ */
465
+ skip?: number;
466
+ /**
467
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
468
+ */
469
+ limitListRequests?: boolean;
470
+ /**
471
+ * Gets or sets the Tenant Id.
472
+ */
473
+ tenantId?: string;
474
+ /**
475
+ * Gets or sets the Modifed By Id.
476
+ */
477
+ modifiedById?: string;
478
+ /**
479
+ * Gets or sets the Modifed By Ids.
480
+ */
481
+ modifiedByIds?: Array<string>;
482
+ /**
483
+ * Gets or sets the Date Created greater than equal to.
484
+ */
485
+ dateCreatedGte?: string;
486
+ /**
487
+ * Gets or sets the Date Created less than equal to.
488
+ */
489
+ dateCreatedLte?: string;
490
+ /**
491
+ * Gets or sets the queryable only is live status.
492
+ */
493
+ isLive?: boolean;
494
+ /**
495
+ * Gets or sets the sort order direction.
496
+ */
497
+ sortOrderDirection?: SearchSortOrderDirection;
498
+ }): CancelablePromise<number> {
499
+ return this.httpRequest.request({
500
+ method: 'GET',
501
+ url: '/api/reschedule-logs/count',
502
+ query: {
503
+ ScheduledSessionId: scheduledSessionId,
504
+ CourseSessionId: courseSessionId,
505
+ PageNumber: pageNumber,
506
+ Take: take,
507
+ Skip: skip,
508
+ LimitListRequests: limitListRequests,
509
+ TenantId: tenantId,
510
+ ModifiedById: modifiedById,
511
+ ModifiedByIds: modifiedByIds,
512
+ DateCreatedGTE: dateCreatedGte,
513
+ DateCreatedLTE: dateCreatedLte,
514
+ IsLive: isLive,
515
+ SortOrderDirection: sortOrderDirection,
516
+ },
517
+ errors: {
518
+ 400: `Bad Request`,
519
+ 422: `Unprocessable Content`,
520
+ 500: `Internal Server Error`,
521
+ },
522
+ });
523
+ }
524
+
426
525
  /**
427
526
  * Gets a list of resources unpaged and without references.
428
527
  * @returns RescheduleLog OK
@@ -533,6 +533,129 @@ export class ScheduledSessionsSchedulesService {
533
533
  });
534
534
  }
535
535
 
536
+ /**
537
+ * Returns the number of results in the database given the provided search params.
538
+ * @returns number OK
539
+ * @throws ApiError
540
+ */
541
+ public count({
542
+ sessionId,
543
+ sessionIds,
544
+ lastRunDateTimeLte,
545
+ status,
546
+ statuses,
547
+ bookableOnly,
548
+ pageNumber,
549
+ take,
550
+ skip,
551
+ limitListRequests,
552
+ tenantId,
553
+ modifiedById,
554
+ modifiedByIds,
555
+ dateCreatedGte,
556
+ dateCreatedLte,
557
+ isLive,
558
+ sortOrderDirection,
559
+ }: {
560
+ /**
561
+ * Gets or sets the queryable session id.
562
+ */
563
+ sessionId?: string;
564
+ /**
565
+ * Gets or sets the queryable slot facility Ids.
566
+ */
567
+ sessionIds?: Array<string>;
568
+ /**
569
+ * Gets or sets the queryable slot schedule last run date.
570
+ */
571
+ lastRunDateTimeLte?: string;
572
+ /**
573
+ * Gets or sets the queryable schedule status.
574
+ */
575
+ status?: ScheduleStatus;
576
+ /**
577
+ * Gets or sets the queryable schedule statuses.
578
+ */
579
+ statuses?: Array<ScheduleStatus>;
580
+ /**
581
+ * Gets or sets a value indicating whether to only return course sessions contained in bookable courses.
582
+ */
583
+ bookableOnly?: boolean;
584
+ /**
585
+ * Gets or sets the page number for paged queries.
586
+ */
587
+ pageNumber?: number;
588
+ /**
589
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
590
+ */
591
+ take?: number;
592
+ /**
593
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
594
+ */
595
+ skip?: number;
596
+ /**
597
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
598
+ */
599
+ limitListRequests?: boolean;
600
+ /**
601
+ * Gets or sets the Tenant Id.
602
+ */
603
+ tenantId?: string;
604
+ /**
605
+ * Gets or sets the Modifed By Id.
606
+ */
607
+ modifiedById?: string;
608
+ /**
609
+ * Gets or sets the Modifed By Ids.
610
+ */
611
+ modifiedByIds?: Array<string>;
612
+ /**
613
+ * Gets or sets the Date Created greater than equal to.
614
+ */
615
+ dateCreatedGte?: string;
616
+ /**
617
+ * Gets or sets the Date Created less than equal to.
618
+ */
619
+ dateCreatedLte?: string;
620
+ /**
621
+ * Gets or sets the queryable only is live status.
622
+ */
623
+ isLive?: boolean;
624
+ /**
625
+ * Gets or sets the sort order direction.
626
+ */
627
+ sortOrderDirection?: SearchSortOrderDirection;
628
+ }): CancelablePromise<number> {
629
+ return this.httpRequest.request({
630
+ method: 'GET',
631
+ url: '/api/scheduled-session-schedules/count',
632
+ query: {
633
+ SessionId: sessionId,
634
+ SessionIds: sessionIds,
635
+ LastRunDateTimeLTE: lastRunDateTimeLte,
636
+ Status: status,
637
+ Statuses: statuses,
638
+ BookableOnly: bookableOnly,
639
+ PageNumber: pageNumber,
640
+ Take: take,
641
+ Skip: skip,
642
+ LimitListRequests: limitListRequests,
643
+ TenantId: tenantId,
644
+ ModifiedById: modifiedById,
645
+ ModifiedByIds: modifiedByIds,
646
+ DateCreatedGTE: dateCreatedGte,
647
+ DateCreatedLTE: dateCreatedLte,
648
+ IsLive: isLive,
649
+ SortOrderDirection: sortOrderDirection,
650
+ },
651
+ errors: {
652
+ 400: `Bad Request`,
653
+ 422: `Unprocessable Content`,
654
+ 500: `Internal Server Error`,
655
+ },
656
+ });
657
+ }
658
+
536
659
  /**
537
660
  * Gets a list of resources unpaged and without references.
538
661
  * @returns ScheduledSessionSchedule OK
@@ -944,6 +944,255 @@ export class ScheduledSessionsService {
944
944
  });
945
945
  }
946
946
 
947
+ /**
948
+ * Returns the number of results in the database given the provided search params.
949
+ * @returns number OK
950
+ * @throws ApiError
951
+ */
952
+ public count({
953
+ ids,
954
+ venueId,
955
+ programmeId,
956
+ sessionId,
957
+ sessionIds,
958
+ scheduleId,
959
+ status,
960
+ statuses,
961
+ bookingStatus,
962
+ startDateTimeLte,
963
+ startDateTimeGte,
964
+ endDateTimeLte,
965
+ endDateTimeGte,
966
+ remainingUsesLte,
967
+ remainingUsesGte,
968
+ futureOnly,
969
+ bookableOnly,
970
+ includeImages,
971
+ includeVenue,
972
+ includeOffers,
973
+ includeOrders,
974
+ hasAvailability,
975
+ excludeArchived,
976
+ orderFirstNameContains,
977
+ orderLastNameContains,
978
+ sortBy,
979
+ postCompletionEmailSent,
980
+ pageNumber,
981
+ take,
982
+ skip,
983
+ limitListRequests,
984
+ tenantId,
985
+ modifiedById,
986
+ modifiedByIds,
987
+ dateCreatedGte,
988
+ dateCreatedLte,
989
+ isLive,
990
+ sortOrderDirection,
991
+ }: {
992
+ /**
993
+ * Gets or sets the queryable scheduled session ids.
994
+ */
995
+ ids?: Array<string>;
996
+ /**
997
+ * Gets or sets the queryable scheduled session venue Id.
998
+ */
999
+ venueId?: string;
1000
+ /**
1001
+ * Gets or sets the queryable scheduled sessions programme Id.
1002
+ */
1003
+ programmeId?: string;
1004
+ /**
1005
+ * Gets or sets the queryable scheduled session facility Id.
1006
+ */
1007
+ sessionId?: string;
1008
+ /**
1009
+ * Gets or sets the queryable scheduled session facility Ids.
1010
+ */
1011
+ sessionIds?: Array<string>;
1012
+ /**
1013
+ * Gets or sets the queryable scheduled session facility individual Id.
1014
+ */
1015
+ scheduleId?: string;
1016
+ /**
1017
+ * Gets or sets the queryable scheduled session active status.
1018
+ */
1019
+ status?: SlotStatus;
1020
+ /**
1021
+ * Gets or sets the queryable scheduled session active status.
1022
+ */
1023
+ statuses?: Array<SlotStatus>;
1024
+ /**
1025
+ * Gets or sets the queryable booking status.
1026
+ */
1027
+ bookingStatus?: BookingStatus;
1028
+ /**
1029
+ * Gets or sets the queryable scheduled session start date time is less than or equal to.
1030
+ */
1031
+ startDateTimeLte?: string;
1032
+ /**
1033
+ * Gets or sets the queryable scheduled session start date time is greater than or equal to.
1034
+ */
1035
+ startDateTimeGte?: string;
1036
+ /**
1037
+ * Gets or sets the queryable scheduled session end date time is less than or equal to.
1038
+ */
1039
+ endDateTimeLte?: string;
1040
+ /**
1041
+ * Gets or sets the queryable scheduled session end date time is greater than or equal to.
1042
+ */
1043
+ endDateTimeGte?: string;
1044
+ /**
1045
+ * Gets or sets the queryable slot remaining uses is less than or equal to.
1046
+ */
1047
+ remainingUsesLte?: number;
1048
+ /**
1049
+ * Gets or sets the queryable slot remaining uses is greater than or equal to.
1050
+ */
1051
+ remainingUsesGte?: number;
1052
+ /**
1053
+ * Gets or sets a value indicating whether to only return future scheduled session.
1054
+ */
1055
+ futureOnly?: boolean;
1056
+ /**
1057
+ * Gets or sets a value indicating whether to only return bookable scheduled sessions.
1058
+ */
1059
+ bookableOnly?: boolean;
1060
+ /**
1061
+ * Gets or sets a value indicating whether to include image detail in the results.
1062
+ */
1063
+ includeImages?: boolean;
1064
+ /**
1065
+ * Gets or sets a value indicating whether to include venue detail in the results.
1066
+ */
1067
+ includeVenue?: boolean;
1068
+ /**
1069
+ * Gets or sets a value indicating whether to include offer detail in the results.
1070
+ */
1071
+ includeOffers?: boolean;
1072
+ /**
1073
+ * Gets or sets a value indicating whether to include order detail in the results.
1074
+ */
1075
+ includeOrders?: boolean;
1076
+ /**
1077
+ * Gets or sets a value indicating whether the scheduled session has availability.
1078
+ */
1079
+ hasAvailability?: boolean;
1080
+ /**
1081
+ * Gets or sets a value indicating whether to include scheduled sessions whose sessions have been archived.
1082
+ */
1083
+ excludeArchived?: boolean;
1084
+ /**
1085
+ * Gets or sets a value indicating whether the scheduled session has an order where the orders first name contains the given value.
1086
+ */
1087
+ orderFirstNameContains?: string;
1088
+ /**
1089
+ * Gets or sets a value indicating whether the scheduled session has an order where the orders last name contains the given value.
1090
+ */
1091
+ orderLastNameContains?: string;
1092
+ /**
1093
+ * Gets or sets which field to sort by.
1094
+ */
1095
+ sortBy?: ScheduledSessionSearchSortBy;
1096
+ /**
1097
+ * Gets or sets a value indicating whether the scheduled session post completion email has been sent.
1098
+ */
1099
+ postCompletionEmailSent?: boolean;
1100
+ /**
1101
+ * Gets or sets the page number for paged queries.
1102
+ */
1103
+ pageNumber?: number;
1104
+ /**
1105
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
1106
+ */
1107
+ take?: number;
1108
+ /**
1109
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
1110
+ */
1111
+ skip?: number;
1112
+ /**
1113
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
1114
+ */
1115
+ limitListRequests?: boolean;
1116
+ /**
1117
+ * Gets or sets the Tenant Id.
1118
+ */
1119
+ tenantId?: string;
1120
+ /**
1121
+ * Gets or sets the Modifed By Id.
1122
+ */
1123
+ modifiedById?: string;
1124
+ /**
1125
+ * Gets or sets the Modifed By Ids.
1126
+ */
1127
+ modifiedByIds?: Array<string>;
1128
+ /**
1129
+ * Gets or sets the Date Created greater than equal to.
1130
+ */
1131
+ dateCreatedGte?: string;
1132
+ /**
1133
+ * Gets or sets the Date Created less than equal to.
1134
+ */
1135
+ dateCreatedLte?: string;
1136
+ /**
1137
+ * Gets or sets the queryable only is live status.
1138
+ */
1139
+ isLive?: boolean;
1140
+ /**
1141
+ * Gets or sets the sort order direction.
1142
+ */
1143
+ sortOrderDirection?: SearchSortOrderDirection;
1144
+ }): CancelablePromise<number> {
1145
+ return this.httpRequest.request({
1146
+ method: 'GET',
1147
+ url: '/api/scheduled-sessions/count',
1148
+ query: {
1149
+ Ids: ids,
1150
+ VenueId: venueId,
1151
+ ProgrammeId: programmeId,
1152
+ SessionId: sessionId,
1153
+ SessionIds: sessionIds,
1154
+ ScheduleId: scheduleId,
1155
+ Status: status,
1156
+ Statuses: statuses,
1157
+ BookingStatus: bookingStatus,
1158
+ StartDateTimeLTE: startDateTimeLte,
1159
+ StartDateTimeGTE: startDateTimeGte,
1160
+ EndDateTimeLTE: endDateTimeLte,
1161
+ EndDateTimeGTE: endDateTimeGte,
1162
+ RemainingUsesLTE: remainingUsesLte,
1163
+ RemainingUsesGTE: remainingUsesGte,
1164
+ FutureOnly: futureOnly,
1165
+ BookableOnly: bookableOnly,
1166
+ IncludeImages: includeImages,
1167
+ IncludeVenue: includeVenue,
1168
+ IncludeOffers: includeOffers,
1169
+ IncludeOrders: includeOrders,
1170
+ HasAvailability: hasAvailability,
1171
+ ExcludeArchived: excludeArchived,
1172
+ OrderFirstNameContains: orderFirstNameContains,
1173
+ OrderLastNameContains: orderLastNameContains,
1174
+ SortBy: sortBy,
1175
+ PostCompletionEmailSent: postCompletionEmailSent,
1176
+ PageNumber: pageNumber,
1177
+ Take: take,
1178
+ Skip: skip,
1179
+ LimitListRequests: limitListRequests,
1180
+ TenantId: tenantId,
1181
+ ModifiedById: modifiedById,
1182
+ ModifiedByIds: modifiedByIds,
1183
+ DateCreatedGTE: dateCreatedGte,
1184
+ DateCreatedLTE: dateCreatedLte,
1185
+ IsLive: isLive,
1186
+ SortOrderDirection: sortOrderDirection,
1187
+ },
1188
+ errors: {
1189
+ 400: `Bad Request`,
1190
+ 422: `Unprocessable Content`,
1191
+ 500: `Internal Server Error`,
1192
+ },
1193
+ });
1194
+ }
1195
+
947
1196
  /**
948
1197
  * Gets a list of resources unpaged and without references.
949
1198
  * @returns ScheduledSession OK