reach-api-sdk 1.0.203 → 1.0.205

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.
@@ -31,4 +31,12 @@ export type CreateOffer = {
31
31
  * Gets or sets the offer description.
32
32
  */
33
33
  description?: string | null;
34
+ /**
35
+ * Gets or sets the survey id.
36
+ */
37
+ surveyId?: string | null;
38
+ /**
39
+ * Gets or sets the post completion survey id.
40
+ */
41
+ postCompletionSurveyId?: string | null;
34
42
  };
@@ -23,6 +23,10 @@ export type CreateQuestion = {
23
23
  */
24
24
  number: number;
25
25
  type: SurveyQuestionType;
26
+ /**
27
+ * Gets or sets a value indicating whether question is required or not.
28
+ */
29
+ required: boolean;
26
30
  /**
27
31
  * Gets or sets the survey question options.
28
32
  */
@@ -53,6 +53,14 @@ export type Offer = {
53
53
  * Gets or sets the course id.
54
54
  */
55
55
  courseId?: string | null;
56
+ /**
57
+ * Gets or sets the survey id.
58
+ */
59
+ surveyId?: string | null;
60
+ /**
61
+ * Gets or sets the survey id.
62
+ */
63
+ postCompletionSurveyId?: string | null;
56
64
  /**
57
65
  * Gets or sets the offer name.
58
66
  */
@@ -31,6 +31,14 @@ export type OfferPatch = {
31
31
  * Gets or sets the course id.
32
32
  */
33
33
  courseId?: string | null;
34
+ /**
35
+ * Gets or sets the survey id.
36
+ */
37
+ surveyId?: string | null;
38
+ /**
39
+ * Gets or sets the post completion survey id.
40
+ */
41
+ postCompletionSurveyId?: string | null;
34
42
  /**
35
43
  * Gets or sets the offer name.
36
44
  */
@@ -27,6 +27,14 @@ export type OfferPost = {
27
27
  * Gets or sets the course id.
28
28
  */
29
29
  courseId?: string | null;
30
+ /**
31
+ * Gets or sets the survey id.
32
+ */
33
+ surveyId?: string | null;
34
+ /**
35
+ * Gets or sets the post completion survey id.
36
+ */
37
+ postCompletionSurveyId?: string | null;
30
38
  /**
31
39
  * Gets or sets the offer name.
32
40
  */
@@ -55,4 +55,8 @@ export type SurveyCompletionLog = {
55
55
  * Gets or sets the course id.
56
56
  */
57
57
  courseId?: string | null;
58
+ /**
59
+ * Gets or sets the offer id.
60
+ */
61
+ offerId?: string | null;
58
62
  };
@@ -11,4 +11,9 @@ export enum SurveyQuestionType {
11
11
  SELECT = 'Select',
12
12
  CHECKBOX = 'Checkbox',
13
13
  NUMBER = 'Number',
14
+ TEXT_LONG = 'TextLong',
15
+ BOOLEAN = 'Boolean',
16
+ DATE = 'Date',
17
+ RATING = 'Rating',
18
+ FILE_UPLOAD = 'FileUpload',
14
19
  }
@@ -75,4 +75,12 @@ export type TemplateOffer = {
75
75
  * Gets or sets the offer description.
76
76
  */
77
77
  description?: string | null;
78
+ /**
79
+ * Gets or sets the survey id.
80
+ */
81
+ surveyId?: string | null;
82
+ /**
83
+ * Gets or sets the survey id.
84
+ */
85
+ postCompletionSurveyId?: string | null;
78
86
  };
@@ -35,4 +35,12 @@ export type UpdateOffer = {
35
35
  * Gets or sets the offer description.
36
36
  */
37
37
  description?: string | null;
38
+ /**
39
+ * Gets or sets the survey id.
40
+ */
41
+ surveyId?: string | null;
42
+ /**
43
+ * Gets or sets the post completion survey id.
44
+ */
45
+ postCompletionSurveyId?: string | null;
38
46
  };
@@ -993,6 +993,305 @@ export class PublicGenericActivityService {
993
993
  });
994
994
  }
995
995
 
996
+ /**
997
+ * Retrieves a paged list of activities using optimized raw SQL queries.
998
+ * This endpoint loads all related data (images, offers, sessions) in a single query using JSON aggregation,
999
+ * eliminating the overhead of OnPagedItemsLoaded method. Returns only minimal required fields.
1000
+ * @returns GenericActivityPage OK
1001
+ * @throws ApiError
1002
+ */
1003
+ public getPageOptimized({
1004
+ wildcard,
1005
+ venueId,
1006
+ providerId,
1007
+ programmeId,
1008
+ online,
1009
+ archived,
1010
+ deleted,
1011
+ activityType,
1012
+ includeNextOpportunity,
1013
+ featured,
1014
+ _private,
1015
+ searchGeoCenter,
1016
+ openactiveActivityId,
1017
+ activityId,
1018
+ activityIds,
1019
+ networkId,
1020
+ tenantStatus,
1021
+ lat,
1022
+ lng,
1023
+ distance,
1024
+ minAgeLte,
1025
+ minAgeGte,
1026
+ maxAgeLte,
1027
+ maxAgeGte,
1028
+ priceTotalGte,
1029
+ priceTotalLte,
1030
+ timeOfDay,
1031
+ startDateTimeGte,
1032
+ endDateTimeLte,
1033
+ gender,
1034
+ periodsOfWeek,
1035
+ additionalSupport,
1036
+ amenity,
1037
+ venueTypeIds,
1038
+ programmeIds,
1039
+ pageNumber,
1040
+ take,
1041
+ skip,
1042
+ limitListRequests,
1043
+ tenantId,
1044
+ modifiedById,
1045
+ modifiedByIds,
1046
+ dateCreatedGte,
1047
+ dateCreatedLte,
1048
+ isLive,
1049
+ sortOrderDirection,
1050
+ }: {
1051
+ /**
1052
+ * Gets or sets the wildcard for use in a query search.
1053
+ */
1054
+ wildcard?: string;
1055
+ /**
1056
+ * Gets or sets the queryable Venue Id.
1057
+ */
1058
+ venueId?: string;
1059
+ /**
1060
+ * Gets or sets the queryable Provider Id.
1061
+ */
1062
+ providerId?: string;
1063
+ /**
1064
+ * Gets or sets the queryable Programme Id.
1065
+ */
1066
+ programmeId?: string;
1067
+ /**
1068
+ * Gets or sets a value indicating whether return online activities.
1069
+ */
1070
+ online?: boolean;
1071
+ /**
1072
+ * Gets or sets a value indicating whether to include archived activities.
1073
+ */
1074
+ archived?: boolean;
1075
+ /**
1076
+ * Gets or sets a value indicating whether to include deleted activities.
1077
+ */
1078
+ deleted?: boolean;
1079
+ /**
1080
+ * Gets or sets the activity type.
1081
+ */
1082
+ activityType?: ActivityType;
1083
+ /**
1084
+ * Gets or sets a value indicating whether to inlcude the activities next availability.
1085
+ */
1086
+ includeNextOpportunity?: boolean;
1087
+ /**
1088
+ * Gets or sets a value indicating whether to filter on whether the activity is featured.
1089
+ */
1090
+ featured?: boolean;
1091
+ /**
1092
+ * Gets or sets a value indicating does session is private or no.
1093
+ */
1094
+ _private?: boolean;
1095
+ /**
1096
+ * Gets or sets SearchGeoCenter.
1097
+ */
1098
+ searchGeoCenter?: string;
1099
+ /**
1100
+ * Gets or sets OpenactiveActivityId.
1101
+ */
1102
+ openactiveActivityId?: string;
1103
+ /**
1104
+ * Gets or sets Activity id.
1105
+ */
1106
+ activityId?: number;
1107
+ /**
1108
+ * Gets or sets the queryable session Activity ids.
1109
+ */
1110
+ activityIds?: Array<number>;
1111
+ /**
1112
+ * Gets or sets a value indicating whether to include only sessions by given NetworkId.
1113
+ */
1114
+ networkId?: string;
1115
+ /**
1116
+ * Gets or sets a value indicating whether the results should return a specific tenant status.
1117
+ */
1118
+ tenantStatus?: TenantStatus;
1119
+ /**
1120
+ * Gets or sets Lat.
1121
+ */
1122
+ lat?: number;
1123
+ /**
1124
+ * Gets or sets Lng.
1125
+ */
1126
+ lng?: number;
1127
+ /**
1128
+ * Gets or sets Distance.
1129
+ */
1130
+ distance?: number;
1131
+ /**
1132
+ * Gets or sets MinAgeLTE.
1133
+ */
1134
+ minAgeLte?: number;
1135
+ /**
1136
+ * Gets or sets MinAgeGTE.
1137
+ */
1138
+ minAgeGte?: number;
1139
+ /**
1140
+ * Gets or sets MaxAgeLTE.
1141
+ */
1142
+ maxAgeLte?: number;
1143
+ /**
1144
+ * Gets or sets MaxAgeGTE.
1145
+ */
1146
+ maxAgeGte?: number;
1147
+ /**
1148
+ * Gets or sets PriceTotalGTE.
1149
+ */
1150
+ priceTotalGte?: number;
1151
+ /**
1152
+ * Gets or sets PriceTotalLTE.
1153
+ */
1154
+ priceTotalLte?: number;
1155
+ /**
1156
+ * Gets or sets TimeOfDay.
1157
+ */
1158
+ timeOfDay?: string;
1159
+ /**
1160
+ * Gets or sets StartDateTimeGTE.
1161
+ */
1162
+ startDateTimeGte?: string;
1163
+ /**
1164
+ * Gets or sets EndDateTimeLTE.
1165
+ */
1166
+ endDateTimeLte?: string;
1167
+ /**
1168
+ * Gets or sets Gender.
1169
+ */
1170
+ gender?: Gender;
1171
+ /**
1172
+ * Gets or sets PeriodsOfWeek.
1173
+ */
1174
+ periodsOfWeek?: PeriodsOfWeek;
1175
+ /**
1176
+ * Gets or sets AdditionalSupport.
1177
+ */
1178
+ additionalSupport?: Array<string>;
1179
+ /**
1180
+ * Gets or sets AmenityId.
1181
+ */
1182
+ amenity?: Array<number>;
1183
+ /**
1184
+ * Gets or sets a list of venue type ids.
1185
+ */
1186
+ venueTypeIds?: Array<string>;
1187
+ /**
1188
+ * Gets or sets the Programme ids.
1189
+ */
1190
+ programmeIds?: Array<string>;
1191
+ /**
1192
+ * Gets or sets the page number for paged queries.
1193
+ */
1194
+ pageNumber?: number;
1195
+ /**
1196
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
1197
+ */
1198
+ take?: number;
1199
+ /**
1200
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
1201
+ */
1202
+ skip?: number;
1203
+ /**
1204
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
1205
+ */
1206
+ limitListRequests?: boolean;
1207
+ /**
1208
+ * Gets or sets the Tenant Id.
1209
+ */
1210
+ tenantId?: string;
1211
+ /**
1212
+ * Gets or sets the Modifed By Id.
1213
+ */
1214
+ modifiedById?: string;
1215
+ /**
1216
+ * Gets or sets the Modifed By Ids.
1217
+ */
1218
+ modifiedByIds?: Array<string>;
1219
+ /**
1220
+ * Gets or sets the Date Created greater than equal to.
1221
+ */
1222
+ dateCreatedGte?: string;
1223
+ /**
1224
+ * Gets or sets the Date Created less than equal to.
1225
+ */
1226
+ dateCreatedLte?: string;
1227
+ /**
1228
+ * Gets or sets the queryable only is live status.
1229
+ */
1230
+ isLive?: boolean;
1231
+ /**
1232
+ * Gets or sets the sort order direction.
1233
+ */
1234
+ sortOrderDirection?: SearchSortOrderDirection;
1235
+ }): CancelablePromise<GenericActivityPage> {
1236
+ return this.httpRequest.request({
1237
+ method: 'GET',
1238
+ url: '/api/public/all-activities/network/optimized',
1239
+ query: {
1240
+ Wildcard: wildcard,
1241
+ VenueId: venueId,
1242
+ ProviderId: providerId,
1243
+ ProgrammeId: programmeId,
1244
+ Online: online,
1245
+ Archived: archived,
1246
+ Deleted: deleted,
1247
+ ActivityType: activityType,
1248
+ IncludeNextOpportunity: includeNextOpportunity,
1249
+ Featured: featured,
1250
+ Private: _private,
1251
+ SearchGeoCenter: searchGeoCenter,
1252
+ OpenactiveActivityId: openactiveActivityId,
1253
+ ActivityId: activityId,
1254
+ ActivityIds: activityIds,
1255
+ NetworkId: networkId,
1256
+ TenantStatus: tenantStatus,
1257
+ Lat: lat,
1258
+ Lng: lng,
1259
+ Distance: distance,
1260
+ MinAgeLTE: minAgeLte,
1261
+ MinAgeGTE: minAgeGte,
1262
+ MaxAgeLTE: maxAgeLte,
1263
+ MaxAgeGTE: maxAgeGte,
1264
+ PriceTotalGTE: priceTotalGte,
1265
+ PriceTotalLTE: priceTotalLte,
1266
+ TimeOfDay: timeOfDay,
1267
+ StartDateTimeGTE: startDateTimeGte,
1268
+ EndDateTimeLTE: endDateTimeLte,
1269
+ Gender: gender,
1270
+ PeriodsOfWeek: periodsOfWeek,
1271
+ AdditionalSupport: additionalSupport,
1272
+ Amenity: amenity,
1273
+ VenueTypeIds: venueTypeIds,
1274
+ ProgrammeIds: programmeIds,
1275
+ PageNumber: pageNumber,
1276
+ Take: take,
1277
+ Skip: skip,
1278
+ LimitListRequests: limitListRequests,
1279
+ TenantId: tenantId,
1280
+ ModifiedById: modifiedById,
1281
+ ModifiedByIds: modifiedByIds,
1282
+ DateCreatedGTE: dateCreatedGte,
1283
+ DateCreatedLTE: dateCreatedLte,
1284
+ IsLive: isLive,
1285
+ SortOrderDirection: sortOrderDirection,
1286
+ },
1287
+ errors: {
1288
+ 400: `Bad Request`,
1289
+ 422: `Unprocessable Content`,
1290
+ 500: `Internal Server Error`,
1291
+ },
1292
+ });
1293
+ }
1294
+
996
1295
  /**
997
1296
  * Returns a value indicating whether the resource exists in the database given the provided search params.
998
1297
  * @returns boolean OK
@@ -89,6 +89,7 @@ export class PublicSurveyCompletionLogsService {
89
89
  orderItemId,
90
90
  sessionId,
91
91
  courseId,
92
+ offerId,
92
93
  pageNumber,
93
94
  take,
94
95
  skip,
@@ -126,6 +127,10 @@ export class PublicSurveyCompletionLogsService {
126
127
  * Gets or sets the queryable Course Id.
127
128
  */
128
129
  courseId?: string;
130
+ /**
131
+ * Gets or sets the queryable Offer Id.
132
+ */
133
+ offerId?: string;
129
134
  /**
130
135
  * Gets or sets the page number for paged queries.
131
136
  */
@@ -184,6 +189,7 @@ export class PublicSurveyCompletionLogsService {
184
189
  OrderItemId: orderItemId,
185
190
  SessionId: sessionId,
186
191
  CourseId: courseId,
192
+ OfferId: offerId,
187
193
  PageNumber: pageNumber,
188
194
  Take: take,
189
195
  Skip: skip,
@@ -353,6 +359,7 @@ export class PublicSurveyCompletionLogsService {
353
359
  orderItemId,
354
360
  sessionId,
355
361
  courseId,
362
+ offerId,
356
363
  pageNumber,
357
364
  take,
358
365
  skip,
@@ -393,6 +400,10 @@ export class PublicSurveyCompletionLogsService {
393
400
  * Gets or sets the queryable Course Id.
394
401
  */
395
402
  courseId?: string;
403
+ /**
404
+ * Gets or sets the queryable Offer Id.
405
+ */
406
+ offerId?: string;
396
407
  /**
397
408
  * Gets or sets the page number for paged queries.
398
409
  */
@@ -451,6 +462,7 @@ export class PublicSurveyCompletionLogsService {
451
462
  OrderItemId: orderItemId,
452
463
  SessionId: sessionId,
453
464
  CourseId: courseId,
465
+ OfferId: offerId,
454
466
  PageNumber: pageNumber,
455
467
  Take: take,
456
468
  Skip: skip,
@@ -554,6 +554,225 @@ export class PublicVenuesService {
554
554
  });
555
555
  }
556
556
 
557
+ /**
558
+ * Get Venues for a network using optimized query.
559
+ * @returns VenuePage OK
560
+ * @throws ApiError
561
+ */
562
+ public getNetworkPageOptimized({
563
+ ids,
564
+ wildcard,
565
+ name,
566
+ streetAddress,
567
+ addressPostalcode,
568
+ nameLike,
569
+ slug,
570
+ assignedTo,
571
+ stripeAccountId,
572
+ searchGeoCenter,
573
+ publishedOnWeb,
574
+ archived,
575
+ networkId,
576
+ tenantStatus,
577
+ programmeId,
578
+ includeOpportunityImages,
579
+ includeOpportunityOffers,
580
+ includeNextOpportunity,
581
+ distance,
582
+ dashboardRequest,
583
+ programmeIds,
584
+ venueTypeIds,
585
+ pageNumber,
586
+ take,
587
+ skip,
588
+ limitListRequests,
589
+ tenantId,
590
+ modifiedById,
591
+ modifiedByIds,
592
+ dateCreatedGte,
593
+ dateCreatedLte,
594
+ isLive,
595
+ sortOrderDirection,
596
+ }: {
597
+ /**
598
+ * Gets or sets the queryable venue ids.
599
+ */
600
+ ids?: Array<string>;
601
+ /**
602
+ * Gets or sets the queryable venue name wildcard.
603
+ */
604
+ wildcard?: string;
605
+ /**
606
+ * Gets or sets the queryable venue name.
607
+ */
608
+ name?: string;
609
+ /**
610
+ * Gets or sets the queryable venue street address.
611
+ */
612
+ streetAddress?: string;
613
+ /**
614
+ * Gets or sets the queryable venue address postal code.
615
+ */
616
+ addressPostalcode?: string;
617
+ /**
618
+ * Gets or sets the queryable venue name wildcard.
619
+ */
620
+ nameLike?: string;
621
+ /**
622
+ * Gets or sets the queryable venue url slug.
623
+ */
624
+ slug?: string;
625
+ /**
626
+ * Gets or sets the queryable assign to Id.
627
+ */
628
+ assignedTo?: string;
629
+ /**
630
+ * Gets or sets the queryable stripe account Id.
631
+ */
632
+ stripeAccountId?: string;
633
+ /**
634
+ * Gets or sets the queryable search geo center.
635
+ */
636
+ searchGeoCenter?: string;
637
+ /**
638
+ * Gets or sets a value indicating whether to show published venues.
639
+ */
640
+ publishedOnWeb?: boolean;
641
+ /**
642
+ * Gets or sets a value indicating whether to include archived venues.
643
+ */
644
+ archived?: boolean;
645
+ /**
646
+ * Gets or sets a value indicating whether to include only sessions by given NetworkId.
647
+ */
648
+ networkId?: string;
649
+ /**
650
+ * Gets or sets a value indicating whether the results should return a specific tenant status.
651
+ */
652
+ tenantStatus?: TenantStatus;
653
+ /**
654
+ * Gets or sets the queryable programme Id.
655
+ */
656
+ programmeId?: string;
657
+ /**
658
+ * Gets or sets a value indicating whether to inlcude the venues opportunity images.
659
+ */
660
+ includeOpportunityImages?: boolean;
661
+ /**
662
+ * Gets or sets a value indicating whether to inlcude the venues opportunity offers.
663
+ */
664
+ includeOpportunityOffers?: boolean;
665
+ /**
666
+ * Gets or sets a value indicating whether to inlcude the venues opportunity next availability.
667
+ */
668
+ includeNextOpportunity?: boolean;
669
+ /**
670
+ * Gets or sets Distance.
671
+ */
672
+ distance?: number;
673
+ /**
674
+ * Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
675
+ */
676
+ dashboardRequest?: boolean;
677
+ /**
678
+ * Gets or sets the programme ids.
679
+ */
680
+ programmeIds?: Array<string>;
681
+ /**
682
+ * Gets or sets the venue type ids.
683
+ */
684
+ venueTypeIds?: Array<string>;
685
+ /**
686
+ * Gets or sets the page number for paged queries.
687
+ */
688
+ pageNumber?: number;
689
+ /**
690
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
691
+ */
692
+ take?: number;
693
+ /**
694
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
695
+ */
696
+ skip?: number;
697
+ /**
698
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
699
+ */
700
+ limitListRequests?: boolean;
701
+ /**
702
+ * Gets or sets the Tenant Id.
703
+ */
704
+ tenantId?: string;
705
+ /**
706
+ * Gets or sets the Modifed By Id.
707
+ */
708
+ modifiedById?: string;
709
+ /**
710
+ * Gets or sets the Modifed By Ids.
711
+ */
712
+ modifiedByIds?: Array<string>;
713
+ /**
714
+ * Gets or sets the Date Created greater than equal to.
715
+ */
716
+ dateCreatedGte?: string;
717
+ /**
718
+ * Gets or sets the Date Created less than equal to.
719
+ */
720
+ dateCreatedLte?: string;
721
+ /**
722
+ * Gets or sets the queryable only is live status.
723
+ */
724
+ isLive?: boolean;
725
+ /**
726
+ * Gets or sets the sort order direction.
727
+ */
728
+ sortOrderDirection?: SearchSortOrderDirection;
729
+ }): CancelablePromise<VenuePage> {
730
+ return this.httpRequest.request({
731
+ method: 'GET',
732
+ url: '/api/public/venues/network/optimized',
733
+ query: {
734
+ Ids: ids,
735
+ Wildcard: wildcard,
736
+ Name: name,
737
+ StreetAddress: streetAddress,
738
+ AddressPostalcode: addressPostalcode,
739
+ NameLike: nameLike,
740
+ Slug: slug,
741
+ AssignedTo: assignedTo,
742
+ StripeAccountId: stripeAccountId,
743
+ SearchGeoCenter: searchGeoCenter,
744
+ PublishedOnWeb: publishedOnWeb,
745
+ Archived: archived,
746
+ NetworkId: networkId,
747
+ TenantStatus: tenantStatus,
748
+ ProgrammeId: programmeId,
749
+ IncludeOpportunityImages: includeOpportunityImages,
750
+ IncludeOpportunityOffers: includeOpportunityOffers,
751
+ IncludeNextOpportunity: includeNextOpportunity,
752
+ Distance: distance,
753
+ DashboardRequest: dashboardRequest,
754
+ ProgrammeIds: programmeIds,
755
+ VenueTypeIds: venueTypeIds,
756
+ PageNumber: pageNumber,
757
+ Take: take,
758
+ Skip: skip,
759
+ LimitListRequests: limitListRequests,
760
+ TenantId: tenantId,
761
+ ModifiedById: modifiedById,
762
+ ModifiedByIds: modifiedByIds,
763
+ DateCreatedGTE: dateCreatedGte,
764
+ DateCreatedLTE: dateCreatedLte,
765
+ IsLive: isLive,
766
+ SortOrderDirection: sortOrderDirection,
767
+ },
768
+ errors: {
769
+ 400: `Bad Request`,
770
+ 422: `Unprocessable Content`,
771
+ 500: `Internal Server Error`,
772
+ },
773
+ });
774
+ }
775
+
557
776
  /**
558
777
  * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
559
778
  * @returns Venue OK