reach-api-sdk 1.0.201 → 1.0.203

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 (38) hide show
  1. package/dist/reach-sdk.d.ts +1117 -31
  2. package/dist/reach-sdk.js +1234 -428
  3. package/package.json +1 -1
  4. package/src/apiClient.ts +6 -0
  5. package/src/definition/swagger.yaml +3928 -1186
  6. package/src/index.ts +9 -0
  7. package/src/models/CourseEmailWaitlistPatch.ts +22 -0
  8. package/src/models/CreateOffer.ts +16 -0
  9. package/src/models/GenericActivity.ts +12 -0
  10. package/src/models/Offer.ts +25 -0
  11. package/src/models/OfferPost.ts +16 -0
  12. package/src/models/OrderItemReportSummary.ts +38 -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/Session.ts +12 -0
  17. package/src/models/TemplateOffer.ts +16 -0
  18. package/src/models/UpdateOffer.ts +16 -0
  19. package/src/models/UserPermission.ts +4 -0
  20. package/src/models/UserPermissionPatch.ts +4 -0
  21. package/src/models/Venue.ts +4 -0
  22. package/src/models/VenueType.ts +42 -0
  23. package/src/models/VenueTypePage.ts +12 -0
  24. package/src/models/VenueTypePatch.ts +26 -0
  25. package/src/models/VenueTypePost.ts +22 -0
  26. package/src/services/CoursesService.ts +35 -0
  27. package/src/services/GenericActivityService.ts +36 -0
  28. package/src/services/OffersService.ts +30 -0
  29. package/src/services/OrderItemReportService.ts +124 -0
  30. package/src/services/OrderItemsService.ts +30 -0
  31. package/src/services/PlacesService.ts +57 -0
  32. package/src/services/PublicGenericActivityService.ts +24 -0
  33. package/src/services/PublicOrderItemsService.ts +12 -0
  34. package/src/services/PublicVenueTypesService.ts +401 -0
  35. package/src/services/PublicVenuesService.ts +18 -0
  36. package/src/services/ScheduledSessionsService.ts +35 -0
  37. package/src/services/VenueTypeService.ts +662 -0
  38. package/src/services/VenuesService.ts +30 -0
@@ -150,6 +150,7 @@ export class OffersService {
150
150
  * @throws ApiError
151
151
  */
152
152
  public getPage({
153
+ ids,
153
154
  facilityId,
154
155
  facilityIds,
155
156
  facilityIndividualId,
@@ -175,6 +176,10 @@ export class OffersService {
175
176
  isLive,
176
177
  sortOrderDirection,
177
178
  }: {
179
+ /**
180
+ * Gets or sets the queryable ids.
181
+ */
182
+ ids?: Array<string>;
178
183
  /**
179
184
  * Gets or sets the queryable facility id.
180
185
  */
@@ -276,6 +281,7 @@ export class OffersService {
276
281
  method: 'GET',
277
282
  url: '/api/offers',
278
283
  query: {
284
+ Ids: ids,
279
285
  FacilityId: facilityId,
280
286
  FacilityIds: facilityIds,
281
287
  FacilityIndividualId: facilityIndividualId,
@@ -396,6 +402,7 @@ export class OffersService {
396
402
  * @throws ApiError
397
403
  */
398
404
  public exists({
405
+ ids,
399
406
  facilityId,
400
407
  facilityIds,
401
408
  facilityIndividualId,
@@ -421,6 +428,10 @@ export class OffersService {
421
428
  isLive,
422
429
  sortOrderDirection,
423
430
  }: {
431
+ /**
432
+ * Gets or sets the queryable ids.
433
+ */
434
+ ids?: Array<string>;
424
435
  /**
425
436
  * Gets or sets the queryable facility id.
426
437
  */
@@ -522,6 +533,7 @@ export class OffersService {
522
533
  method: 'GET',
523
534
  url: '/api/offers/exists',
524
535
  query: {
536
+ Ids: ids,
525
537
  FacilityId: facilityId,
526
538
  FacilityIds: facilityIds,
527
539
  FacilityIndividualId: facilityIndividualId,
@@ -561,6 +573,7 @@ export class OffersService {
561
573
  * @throws ApiError
562
574
  */
563
575
  public count({
576
+ ids,
564
577
  facilityId,
565
578
  facilityIds,
566
579
  facilityIndividualId,
@@ -586,6 +599,10 @@ export class OffersService {
586
599
  isLive,
587
600
  sortOrderDirection,
588
601
  }: {
602
+ /**
603
+ * Gets or sets the queryable ids.
604
+ */
605
+ ids?: Array<string>;
589
606
  /**
590
607
  * Gets or sets the queryable facility id.
591
608
  */
@@ -687,6 +704,7 @@ export class OffersService {
687
704
  method: 'GET',
688
705
  url: '/api/offers/count',
689
706
  query: {
707
+ Ids: ids,
690
708
  FacilityId: facilityId,
691
709
  FacilityIds: facilityIds,
692
710
  FacilityIndividualId: facilityIndividualId,
@@ -726,6 +744,7 @@ export class OffersService {
726
744
  * @throws ApiError
727
745
  */
728
746
  public getListWithoutReferences({
747
+ ids,
729
748
  facilityId,
730
749
  facilityIds,
731
750
  facilityIndividualId,
@@ -751,6 +770,10 @@ export class OffersService {
751
770
  isLive,
752
771
  sortOrderDirection,
753
772
  }: {
773
+ /**
774
+ * Gets or sets the queryable ids.
775
+ */
776
+ ids?: Array<string>;
754
777
  /**
755
778
  * Gets or sets the queryable facility id.
756
779
  */
@@ -852,6 +875,7 @@ export class OffersService {
852
875
  method: 'GET',
853
876
  url: '/api/offers/without-references',
854
877
  query: {
878
+ Ids: ids,
855
879
  FacilityId: facilityId,
856
880
  FacilityIds: facilityIds,
857
881
  FacilityIndividualId: facilityIndividualId,
@@ -891,6 +915,7 @@ export class OffersService {
891
915
  * @throws ApiError
892
916
  */
893
917
  public getListIdName({
918
+ ids,
894
919
  facilityId,
895
920
  facilityIds,
896
921
  facilityIndividualId,
@@ -916,6 +941,10 @@ export class OffersService {
916
941
  isLive,
917
942
  sortOrderDirection,
918
943
  }: {
944
+ /**
945
+ * Gets or sets the queryable ids.
946
+ */
947
+ ids?: Array<string>;
919
948
  /**
920
949
  * Gets or sets the queryable facility id.
921
950
  */
@@ -1017,6 +1046,7 @@ export class OffersService {
1017
1046
  method: 'GET',
1018
1047
  url: '/api/offers/id-name',
1019
1048
  query: {
1049
+ Ids: ids,
1020
1050
  FacilityId: facilityId,
1021
1051
  FacilityIds: facilityIds,
1022
1052
  FacilityIndividualId: facilityIndividualId,
@@ -7,6 +7,7 @@ import type { OrderItemReport } from '../models/OrderItemReport';
7
7
  import type { OrderItemReportPage } from '../models/OrderItemReportPage';
8
8
  import type { OrderItemReportPatch } from '../models/OrderItemReportPatch';
9
9
  import type { OrderItemReportPost } from '../models/OrderItemReportPost';
10
+ import type { OrderItemReportSummary } from '../models/OrderItemReportSummary';
10
11
  import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
11
12
 
12
13
  import type { CancelablePromise } from '../core/CancelablePromise';
@@ -148,6 +149,129 @@ export class OrderItemReportService {
148
149
  });
149
150
  }
150
151
 
152
+ /**
153
+ * Get summary for order items.
154
+ * @returns OrderItemReportSummary OK
155
+ * @throws ApiError
156
+ */
157
+ public getSummary({
158
+ venueId,
159
+ userId,
160
+ programmeId,
161
+ startDateGte,
162
+ startDateLte,
163
+ dateRange,
164
+ pageNumber,
165
+ take,
166
+ skip,
167
+ limitListRequests,
168
+ tenantId,
169
+ modifiedById,
170
+ modifiedByIds,
171
+ dateCreatedGte,
172
+ dateCreatedLte,
173
+ isLive,
174
+ sortOrderDirection,
175
+ }: {
176
+ /**
177
+ * Gets or sets the Venue Id.
178
+ */
179
+ venueId?: string;
180
+ /**
181
+ * Gets or sets the User Id.
182
+ */
183
+ userId?: string;
184
+ /**
185
+ * Gets or sets the Programme Id.
186
+ */
187
+ programmeId?: string;
188
+ /**
189
+ * Gets or sets the starting date greater than or equal to.
190
+ */
191
+ startDateGte?: string;
192
+ /**
193
+ * Gets or sets the starting date less than or equal to.
194
+ */
195
+ startDateLte?: string;
196
+ /**
197
+ * Gets or sets a custom date range.
198
+ */
199
+ dateRange?: CustomDateRange;
200
+ /**
201
+ * Gets or sets the page number for paged queries.
202
+ */
203
+ pageNumber?: number;
204
+ /**
205
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
206
+ */
207
+ take?: number;
208
+ /**
209
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
210
+ */
211
+ skip?: number;
212
+ /**
213
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
214
+ */
215
+ limitListRequests?: boolean;
216
+ /**
217
+ * Gets or sets the Tenant Id.
218
+ */
219
+ tenantId?: string;
220
+ /**
221
+ * Gets or sets the Modifed By Id.
222
+ */
223
+ modifiedById?: string;
224
+ /**
225
+ * Gets or sets the Modifed By Ids.
226
+ */
227
+ modifiedByIds?: Array<string>;
228
+ /**
229
+ * Gets or sets the Date Created greater than equal to.
230
+ */
231
+ dateCreatedGte?: string;
232
+ /**
233
+ * Gets or sets the Date Created less than equal to.
234
+ */
235
+ dateCreatedLte?: string;
236
+ /**
237
+ * Gets or sets the queryable only is live status.
238
+ */
239
+ isLive?: boolean;
240
+ /**
241
+ * Gets or sets the sort order direction.
242
+ */
243
+ sortOrderDirection?: SearchSortOrderDirection;
244
+ }): CancelablePromise<OrderItemReportSummary> {
245
+ return this.httpRequest.request({
246
+ method: 'GET',
247
+ url: '/api/order-items-report/summary',
248
+ query: {
249
+ VenueId: venueId,
250
+ UserId: userId,
251
+ ProgrammeId: programmeId,
252
+ StartDateGTE: startDateGte,
253
+ StartDateLTE: startDateLte,
254
+ DateRange: dateRange,
255
+ PageNumber: pageNumber,
256
+ Take: take,
257
+ Skip: skip,
258
+ LimitListRequests: limitListRequests,
259
+ TenantId: tenantId,
260
+ ModifiedById: modifiedById,
261
+ ModifiedByIds: modifiedByIds,
262
+ DateCreatedGTE: dateCreatedGte,
263
+ DateCreatedLTE: dateCreatedLte,
264
+ IsLive: isLive,
265
+ SortOrderDirection: sortOrderDirection,
266
+ },
267
+ errors: {
268
+ 400: `Bad Request`,
269
+ 422: `Unprocessable Content`,
270
+ 500: `Internal Server Error`,
271
+ },
272
+ });
273
+ }
274
+
151
275
  /**
152
276
  * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
153
277
  * @returns OrderItemReport OK
@@ -198,6 +198,7 @@ export class OrderItemsService {
198
198
  scheduledSessionId,
199
199
  slotId,
200
200
  courseId,
201
+ offerId,
201
202
  status,
202
203
  statuses,
203
204
  parentOrderItemId,
@@ -236,6 +237,10 @@ export class OrderItemsService {
236
237
  * Gets or sets the queryable course id.
237
238
  */
238
239
  courseId?: string;
240
+ /**
241
+ * Gets or sets the queryable offer id.
242
+ */
243
+ offerId?: string;
239
244
  /**
240
245
  * Gets or sets the queryable order item status id.
241
246
  */
@@ -314,6 +319,7 @@ export class OrderItemsService {
314
319
  ScheduledSessionId: scheduledSessionId,
315
320
  SlotId: slotId,
316
321
  CourseId: courseId,
322
+ OfferId: offerId,
317
323
  Status: status,
318
324
  Statuses: statuses,
319
325
  ParentOrderItemId: parentOrderItemId,
@@ -432,6 +438,7 @@ export class OrderItemsService {
432
438
  scheduledSessionId,
433
439
  slotId,
434
440
  courseId,
441
+ offerId,
435
442
  status,
436
443
  statuses,
437
444
  parentOrderItemId,
@@ -470,6 +477,10 @@ export class OrderItemsService {
470
477
  * Gets or sets the queryable course id.
471
478
  */
472
479
  courseId?: string;
480
+ /**
481
+ * Gets or sets the queryable offer id.
482
+ */
483
+ offerId?: string;
473
484
  /**
474
485
  * Gets or sets the queryable order item status id.
475
486
  */
@@ -548,6 +559,7 @@ export class OrderItemsService {
548
559
  ScheduledSessionId: scheduledSessionId,
549
560
  SlotId: slotId,
550
561
  CourseId: courseId,
562
+ OfferId: offerId,
551
563
  Status: status,
552
564
  Statuses: statuses,
553
565
  ParentOrderItemId: parentOrderItemId,
@@ -585,6 +597,7 @@ export class OrderItemsService {
585
597
  scheduledSessionId,
586
598
  slotId,
587
599
  courseId,
600
+ offerId,
588
601
  status,
589
602
  statuses,
590
603
  parentOrderItemId,
@@ -623,6 +636,10 @@ export class OrderItemsService {
623
636
  * Gets or sets the queryable course id.
624
637
  */
625
638
  courseId?: string;
639
+ /**
640
+ * Gets or sets the queryable offer id.
641
+ */
642
+ offerId?: string;
626
643
  /**
627
644
  * Gets or sets the queryable order item status id.
628
645
  */
@@ -701,6 +718,7 @@ export class OrderItemsService {
701
718
  ScheduledSessionId: scheduledSessionId,
702
719
  SlotId: slotId,
703
720
  CourseId: courseId,
721
+ OfferId: offerId,
704
722
  Status: status,
705
723
  Statuses: statuses,
706
724
  ParentOrderItemId: parentOrderItemId,
@@ -738,6 +756,7 @@ export class OrderItemsService {
738
756
  scheduledSessionId,
739
757
  slotId,
740
758
  courseId,
759
+ offerId,
741
760
  status,
742
761
  statuses,
743
762
  parentOrderItemId,
@@ -776,6 +795,10 @@ export class OrderItemsService {
776
795
  * Gets or sets the queryable course id.
777
796
  */
778
797
  courseId?: string;
798
+ /**
799
+ * Gets or sets the queryable offer id.
800
+ */
801
+ offerId?: string;
779
802
  /**
780
803
  * Gets or sets the queryable order item status id.
781
804
  */
@@ -854,6 +877,7 @@ export class OrderItemsService {
854
877
  ScheduledSessionId: scheduledSessionId,
855
878
  SlotId: slotId,
856
879
  CourseId: courseId,
880
+ OfferId: offerId,
857
881
  Status: status,
858
882
  Statuses: statuses,
859
883
  ParentOrderItemId: parentOrderItemId,
@@ -891,6 +915,7 @@ export class OrderItemsService {
891
915
  scheduledSessionId,
892
916
  slotId,
893
917
  courseId,
918
+ offerId,
894
919
  status,
895
920
  statuses,
896
921
  parentOrderItemId,
@@ -929,6 +954,10 @@ export class OrderItemsService {
929
954
  * Gets or sets the queryable course id.
930
955
  */
931
956
  courseId?: string;
957
+ /**
958
+ * Gets or sets the queryable offer id.
959
+ */
960
+ offerId?: string;
932
961
  /**
933
962
  * Gets or sets the queryable order item status id.
934
963
  */
@@ -1007,6 +1036,7 @@ export class OrderItemsService {
1007
1036
  ScheduledSessionId: scheduledSessionId,
1008
1037
  SlotId: slotId,
1009
1038
  CourseId: courseId,
1039
+ OfferId: offerId,
1010
1040
  Status: status,
1011
1041
  Statuses: statuses,
1012
1042
  ParentOrderItemId: parentOrderItemId,
@@ -70,4 +70,61 @@ export class PlacesService {
70
70
  },
71
71
  });
72
72
  }
73
+
74
+ /**
75
+ * GetPrediction.
76
+ * @returns any OK
77
+ * @throws ApiError
78
+ */
79
+ public getStaticMap({
80
+ lat,
81
+ lng,
82
+ zoom = 14,
83
+ width = 400,
84
+ height = 287,
85
+ type = 'roadmap',
86
+ }: {
87
+ /**
88
+ * lat.
89
+ */
90
+ lat?: number;
91
+ /**
92
+ * lng.
93
+ */
94
+ lng?: number;
95
+ /**
96
+ * zoom.
97
+ */
98
+ zoom?: number;
99
+ /**
100
+ * width.
101
+ */
102
+ width?: number;
103
+ /**
104
+ * height.
105
+ */
106
+ height?: number;
107
+ /**
108
+ * type.
109
+ */
110
+ type?: string;
111
+ }): CancelablePromise<any> {
112
+ return this.httpRequest.request({
113
+ method: 'GET',
114
+ url: '/api/external/places/static-map',
115
+ query: {
116
+ lat: lat,
117
+ lng: lng,
118
+ zoom: zoom,
119
+ width: width,
120
+ height: height,
121
+ type: type,
122
+ },
123
+ errors: {
124
+ 400: `Bad Request`,
125
+ 422: `Unprocessable Content`,
126
+ 500: `Internal Server Error`,
127
+ },
128
+ });
129
+ }
73
130
  }
@@ -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,
@@ -1015,6 +1033,7 @@ export class PublicGenericActivityService {
1015
1033
  periodsOfWeek,
1016
1034
  additionalSupport,
1017
1035
  amenity,
1036
+ venueTypeIds,
1018
1037
  programmeIds,
1019
1038
  pageNumber,
1020
1039
  take,
@@ -1164,6 +1183,10 @@ export class PublicGenericActivityService {
1164
1183
  * Gets or sets AmenityId.
1165
1184
  */
1166
1185
  amenity?: Array<number>;
1186
+ /**
1187
+ * Gets or sets a list of venue type ids.
1188
+ */
1189
+ venueTypeIds?: Array<string>;
1167
1190
  /**
1168
1191
  * Gets or sets the Programme ids.
1169
1192
  */
@@ -1253,6 +1276,7 @@ export class PublicGenericActivityService {
1253
1276
  PeriodsOfWeek: periodsOfWeek,
1254
1277
  AdditionalSupport: additionalSupport,
1255
1278
  Amenity: amenity,
1279
+ VenueTypeIds: venueTypeIds,
1256
1280
  ProgrammeIds: programmeIds,
1257
1281
  PageNumber: pageNumber,
1258
1282
  Take: take,
@@ -27,6 +27,7 @@ export class PublicOrderItemsService {
27
27
  scheduledSessionId,
28
28
  slotId,
29
29
  courseId,
30
+ offerId,
30
31
  status,
31
32
  statuses,
32
33
  parentOrderItemId,
@@ -66,6 +67,10 @@ export class PublicOrderItemsService {
66
67
  * Gets or sets the queryable course id.
67
68
  */
68
69
  courseId?: string;
70
+ /**
71
+ * Gets or sets the queryable offer id.
72
+ */
73
+ offerId?: string;
69
74
  /**
70
75
  * Gets or sets the queryable order item status id.
71
76
  */
@@ -147,6 +152,7 @@ export class PublicOrderItemsService {
147
152
  ScheduledSessionId: scheduledSessionId,
148
153
  SlotId: slotId,
149
154
  CourseId: courseId,
155
+ OfferId: offerId,
150
156
  Status: status,
151
157
  Statuses: statuses,
152
158
  ParentOrderItemId: parentOrderItemId,
@@ -432,6 +438,7 @@ export class PublicOrderItemsService {
432
438
  scheduledSessionId,
433
439
  slotId,
434
440
  courseId,
441
+ offerId,
435
442
  status,
436
443
  statuses,
437
444
  parentOrderItemId,
@@ -474,6 +481,10 @@ export class PublicOrderItemsService {
474
481
  * Gets or sets the queryable course id.
475
482
  */
476
483
  courseId?: string;
484
+ /**
485
+ * Gets or sets the queryable offer id.
486
+ */
487
+ offerId?: string;
477
488
  /**
478
489
  * Gets or sets the queryable order item status id.
479
490
  */
@@ -555,6 +566,7 @@ export class PublicOrderItemsService {
555
566
  ScheduledSessionId: scheduledSessionId,
556
567
  SlotId: slotId,
557
568
  CourseId: courseId,
569
+ OfferId: offerId,
558
570
  Status: status,
559
571
  Statuses: statuses,
560
572
  ParentOrderItemId: parentOrderItemId,