reach-api-sdk 1.0.202 → 1.0.204

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 (36) hide show
  1. package/dist/reach-sdk.d.ts +1702 -480
  2. package/dist/reach-sdk.js +1127 -212
  3. package/package.json +1 -1
  4. package/src/apiClient.ts +6 -0
  5. package/src/definition/swagger.yaml +5022 -2064
  6. package/src/index.ts +8 -0
  7. package/src/models/CourseEmailWaitlistPatch.ts +22 -0
  8. package/src/models/CreateOffer.ts +8 -0
  9. package/src/models/CreateQuestion.ts +4 -0
  10. package/src/models/Offer.ts +8 -0
  11. package/src/models/OfferPatch.ts +8 -0
  12. package/src/models/OfferPost.ts +8 -0
  13. package/src/models/Permission.ts +4 -0
  14. package/src/models/PermissionPatch.ts +4 -0
  15. package/src/models/ScheduledSessionEmailWaitlistPatch.ts +22 -0
  16. package/src/models/SurveyCompletionLog.ts +4 -0
  17. package/src/models/SurveyQuestionType.ts +5 -0
  18. package/src/models/TemplateOffer.ts +24 -0
  19. package/src/models/UpdateOffer.ts +8 -0
  20. package/src/models/UserPermission.ts +4 -0
  21. package/src/models/UserPermissionPatch.ts +4 -0
  22. package/src/models/Venue.ts +4 -0
  23. package/src/models/VenueType.ts +42 -0
  24. package/src/models/VenueTypePage.ts +12 -0
  25. package/src/models/VenueTypePatch.ts +26 -0
  26. package/src/models/VenueTypePost.ts +22 -0
  27. package/src/services/CoursesService.ts +35 -0
  28. package/src/services/GenericActivityService.ts +36 -0
  29. package/src/services/PublicGenericActivityService.ts +323 -0
  30. package/src/services/PublicSurveyCompletionLogsService.ts +12 -0
  31. package/src/services/PublicVenueTypesService.ts +401 -0
  32. package/src/services/PublicVenuesService.ts +237 -0
  33. package/src/services/ScheduledSessionsService.ts +35 -0
  34. package/src/services/SurveyCompletionLogService.ts +30 -0
  35. package/src/services/VenueTypeService.ts +662 -0
  36. package/src/services/VenuesService.ts +30 -0
@@ -84,6 +84,7 @@ export class PublicGenericActivityService {
84
84
  periodsOfWeek,
85
85
  additionalSupport,
86
86
  amenity,
87
+ venueTypeIds,
87
88
  programmeIds,
88
89
  pageNumber,
89
90
  take,
@@ -230,6 +231,10 @@ export class PublicGenericActivityService {
230
231
  * Gets or sets AmenityId.
231
232
  */
232
233
  amenity?: Array<number>;
234
+ /**
235
+ * Gets or sets a list of venue type ids.
236
+ */
237
+ venueTypeIds?: Array<string>;
233
238
  /**
234
239
  * Gets or sets the Programme ids.
235
240
  */
@@ -319,6 +324,7 @@ export class PublicGenericActivityService {
319
324
  PeriodsOfWeek: periodsOfWeek,
320
325
  AdditionalSupport: additionalSupport,
321
326
  Amenity: amenity,
327
+ VenueTypeIds: venueTypeIds,
322
328
  ProgrammeIds: programmeIds,
323
329
  PageNumber: pageNumber,
324
330
  Take: take,
@@ -379,6 +385,7 @@ export class PublicGenericActivityService {
379
385
  periodsOfWeek,
380
386
  additionalSupport,
381
387
  amenity,
388
+ venueTypeIds,
382
389
  programmeIds,
383
390
  pageNumber,
384
391
  take,
@@ -524,6 +531,10 @@ export class PublicGenericActivityService {
524
531
  * Gets or sets AmenityId.
525
532
  */
526
533
  amenity?: Array<number>;
534
+ /**
535
+ * Gets or sets a list of venue type ids.
536
+ */
537
+ venueTypeIds?: Array<string>;
527
538
  /**
528
539
  * Gets or sets the Programme ids.
529
540
  */
@@ -610,6 +621,7 @@ export class PublicGenericActivityService {
610
621
  PeriodsOfWeek: periodsOfWeek,
611
622
  AdditionalSupport: additionalSupport,
612
623
  Amenity: amenity,
624
+ VenueTypeIds: venueTypeIds,
613
625
  ProgrammeIds: programmeIds,
614
626
  PageNumber: pageNumber,
615
627
  Take: take,
@@ -671,6 +683,7 @@ export class PublicGenericActivityService {
671
683
  periodsOfWeek,
672
684
  additionalSupport,
673
685
  amenity,
686
+ venueTypeIds,
674
687
  programmeIds,
675
688
  pageNumber,
676
689
  take,
@@ -820,6 +833,10 @@ export class PublicGenericActivityService {
820
833
  * Gets or sets AmenityId.
821
834
  */
822
835
  amenity?: Array<number>;
836
+ /**
837
+ * Gets or sets a list of venue type ids.
838
+ */
839
+ venueTypeIds?: Array<string>;
823
840
  /**
824
841
  * Gets or sets the Programme ids.
825
842
  */
@@ -909,6 +926,7 @@ export class PublicGenericActivityService {
909
926
  PeriodsOfWeek: periodsOfWeek,
910
927
  AdditionalSupport: additionalSupport,
911
928
  Amenity: amenity,
929
+ VenueTypeIds: venueTypeIds,
912
930
  ProgrammeIds: programmeIds,
913
931
  PageNumber: pageNumber,
914
932
  Take: take,
@@ -975,6 +993,305 @@ export class PublicGenericActivityService {
975
993
  });
976
994
  }
977
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
+
978
1295
  /**
979
1296
  * Returns a value indicating whether the resource exists in the database given the provided search params.
980
1297
  * @returns boolean OK
@@ -1015,6 +1332,7 @@ export class PublicGenericActivityService {
1015
1332
  periodsOfWeek,
1016
1333
  additionalSupport,
1017
1334
  amenity,
1335
+ venueTypeIds,
1018
1336
  programmeIds,
1019
1337
  pageNumber,
1020
1338
  take,
@@ -1164,6 +1482,10 @@ export class PublicGenericActivityService {
1164
1482
  * Gets or sets AmenityId.
1165
1483
  */
1166
1484
  amenity?: Array<number>;
1485
+ /**
1486
+ * Gets or sets a list of venue type ids.
1487
+ */
1488
+ venueTypeIds?: Array<string>;
1167
1489
  /**
1168
1490
  * Gets or sets the Programme ids.
1169
1491
  */
@@ -1253,6 +1575,7 @@ export class PublicGenericActivityService {
1253
1575
  PeriodsOfWeek: periodsOfWeek,
1254
1576
  AdditionalSupport: additionalSupport,
1255
1577
  Amenity: amenity,
1578
+ VenueTypeIds: venueTypeIds,
1256
1579
  ProgrammeIds: programmeIds,
1257
1580
  PageNumber: pageNumber,
1258
1581
  Take: take,
@@ -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,