reach-api-sdk 1.0.202 → 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.
package/src/index.ts CHANGED
@@ -42,6 +42,7 @@ export type { Course } from './models/Course';
42
42
  export { CourseBookingCutoff } from './models/CourseBookingCutoff';
43
43
  export type { CourseCreate } from './models/CourseCreate';
44
44
  export type { CourseEmailAttendeesPatch } from './models/CourseEmailAttendeesPatch';
45
+ export type { CourseEmailWaitlistPatch } from './models/CourseEmailWaitlistPatch';
45
46
  export type { CoursePage } from './models/CoursePage';
46
47
  export type { CoursePatch } from './models/CoursePatch';
47
48
  export type { CoursePost } from './models/CoursePost';
@@ -271,6 +272,7 @@ export type { RescheduleLogPost } from './models/RescheduleLogPost';
271
272
  export type { ResolveSecureAccessTokenRequest } from './models/ResolveSecureAccessTokenRequest';
272
273
  export type { ScheduledSession } from './models/ScheduledSession';
273
274
  export type { ScheduledSessionEmailAttendeesPatch } from './models/ScheduledSessionEmailAttendeesPatch';
275
+ export type { ScheduledSessionEmailWaitlistPatch } from './models/ScheduledSessionEmailWaitlistPatch';
274
276
  export type { ScheduledSessionPage } from './models/ScheduledSessionPage';
275
277
  export type { ScheduledSessionPatch } from './models/ScheduledSessionPatch';
276
278
  export type { ScheduledSessionPost } from './models/ScheduledSessionPost';
@@ -433,6 +435,10 @@ export type { VenuesReport } from './models/VenuesReport';
433
435
  export type { VenuesReportPage } from './models/VenuesReportPage';
434
436
  export type { VenuesReportPatch } from './models/VenuesReportPatch';
435
437
  export type { VenuesReportPost } from './models/VenuesReportPost';
438
+ export type { VenueType } from './models/VenueType';
439
+ export type { VenueTypePage } from './models/VenueTypePage';
440
+ export type { VenueTypePatch } from './models/VenueTypePatch';
441
+ export type { VenueTypePost } from './models/VenueTypePost';
436
442
  export type { WaitlistActivity } from './models/WaitlistActivity';
437
443
  export type { WaitlistActivityPage } from './models/WaitlistActivityPage';
438
444
  export type { WaitlistActivityPatch } from './models/WaitlistActivityPatch';
@@ -528,6 +534,7 @@ export { PublicSurveyQuestionsService } from './services/PublicSurveyQuestionsSe
528
534
  export { PublicSurveysService } from './services/PublicSurveysService';
529
535
  export { PublicTenantsService } from './services/PublicTenantsService';
530
536
  export { PublicVenuesService } from './services/PublicVenuesService';
537
+ export { PublicVenueTypesService } from './services/PublicVenueTypesService';
531
538
  export { PublicWaitlistActivityService } from './services/PublicWaitlistActivityService';
532
539
  export { PublicWaitlistOpportunityService } from './services/PublicWaitlistOpportunityService';
533
540
  export { RecentOrderActivityReportService } from './services/RecentOrderActivityReportService';
@@ -564,6 +571,7 @@ export { VenueManagersService } from './services/VenueManagersService';
564
571
  export { VenuePerformanceService } from './services/VenuePerformanceService';
565
572
  export { VenuesService } from './services/VenuesService';
566
573
  export { VenuesReportService } from './services/VenuesReportService';
574
+ export { VenueTypeService } from './services/VenueTypeService';
567
575
  export { WaitlistActivityService } from './services/WaitlistActivityService';
568
576
  export { WaitlistActivityReportService } from './services/WaitlistActivityReportService';
569
577
  export { WaitlistOpportunityService } from './services/WaitlistOpportunityService';
@@ -0,0 +1,22 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ /**
7
+ * Post model for email course waitlist.
8
+ */
9
+ export type CourseEmailWaitlistPatch = {
10
+ /**
11
+ * Gets or sets the tenant Id.
12
+ */
13
+ tenantId: string;
14
+ /**
15
+ * Gets or sets the Id.
16
+ */
17
+ id: string;
18
+ /**
19
+ * Gets or sets the message body.
20
+ */
21
+ message?: string | null;
22
+ };
@@ -95,4 +95,8 @@ export type Permission = {
95
95
  * Gets or sets a value indicating whether a venue manager has send emails permissions.
96
96
  */
97
97
  venueManagerSendEmails?: boolean;
98
+ /**
99
+ * Gets or sets a value indicating whether a venue manager has manage opportunity permissions.
100
+ */
101
+ venueManagerManageOpportunity?: boolean;
98
102
  };
@@ -79,4 +79,8 @@ export type PermissionPatch = {
79
79
  * Gets or sets a value indicating whether a venue manager has send emails permissions.
80
80
  */
81
81
  venueManagerSendEmails?: boolean;
82
+ /**
83
+ * Gets or sets a value indicating whether a venue manager has manage opportunity permissions.
84
+ */
85
+ venueManagerManageOpportunity?: boolean;
82
86
  };
@@ -0,0 +1,22 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ /**
7
+ * Post model for emailing scheduled session waitlist.
8
+ */
9
+ export type ScheduledSessionEmailWaitlistPatch = {
10
+ /**
11
+ * Gets or sets the tenant Id.
12
+ */
13
+ tenantId: string;
14
+ /**
15
+ * Gets or sets the Id.
16
+ */
17
+ id: string;
18
+ /**
19
+ * Gets or sets the message body.
20
+ */
21
+ message?: string | null;
22
+ };
@@ -59,4 +59,20 @@ export type TemplateOffer = {
59
59
  * Gets or sets a value indicating whether the offer is active.
60
60
  */
61
61
  active?: boolean;
62
+ /**
63
+ * Gets or sets the maximum number of this offer that can be sold per opportunity.
64
+ */
65
+ maxAvailablePerOpportunity?: number | null;
66
+ /**
67
+ * Gets or sets when this offer becomes available for booking.
68
+ */
69
+ availableFrom?: string | null;
70
+ /**
71
+ * Gets or sets when this offer stops being available for booking.
72
+ */
73
+ availableUntil?: string | null;
74
+ /**
75
+ * Gets or sets the offer description.
76
+ */
77
+ description?: string | null;
62
78
  };
@@ -99,4 +99,8 @@ export type UserPermission = {
99
99
  * Gets or sets a value indicating whether a venue manager has send emails permissions.
100
100
  */
101
101
  sendEmails?: boolean;
102
+ /**
103
+ * Gets or sets a value indicating whether a venue manager has manage opportunity permissions.
104
+ */
105
+ manageOpportunity?: boolean;
102
106
  };
@@ -79,4 +79,8 @@ export type UserPermissionPatch = {
79
79
  * Gets or sets a value indicating whether a venue manager has send emails permissions.
80
80
  */
81
81
  sendEmails?: boolean;
82
+ /**
83
+ * Gets or sets a value indicating whether a venue manager has manage opportunity permissions.
84
+ */
85
+ manageOpportunity?: boolean;
82
86
  };
@@ -76,6 +76,10 @@ export type Venue = {
76
76
  * Gets a formatted label representation for the activity types available at the venue.
77
77
  */
78
78
  readonly activityTypesAvailableFormatted?: string | null;
79
+ /**
80
+ * Gets or sets the venue type id.
81
+ */
82
+ venueTypeId?: string | null;
79
83
  /**
80
84
  * Gets or sets the user that the venue is assigned to.
81
85
  */
@@ -0,0 +1,42 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ /**
7
+ * Represents a Venues type within the Reach application.
8
+ */
9
+ export type VenueType = {
10
+ /**
11
+ * Gets or sets the entities Id.
12
+ */
13
+ id?: string;
14
+ /**
15
+ * Gets or sets the tenant Id.
16
+ */
17
+ tenantId: string;
18
+ /**
19
+ * Gets or sets the created date of this entity.
20
+ */
21
+ dateCreated: string;
22
+ /**
23
+ * Gets or sets the last modified date of this entity.
24
+ */
25
+ dateModified: string;
26
+ /**
27
+ * Gets or sets the modified by Id.
28
+ */
29
+ modifiedById?: string | null;
30
+ /**
31
+ * Gets or sets a value indicating whether the record is live and available for use within the application.
32
+ */
33
+ isLive: boolean;
34
+ /**
35
+ * Gets or sets the venue types name.
36
+ */
37
+ name?: string | null;
38
+ /**
39
+ * Gets or sets the venues types description.
40
+ */
41
+ description?: string | null;
42
+ };
@@ -0,0 +1,12 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ import type { Pagination } from './Pagination';
7
+ import type { VenueType } from './VenueType';
8
+
9
+ export type VenueTypePage = {
10
+ pagination: Pagination;
11
+ readonly items: Array<VenueType>;
12
+ };
@@ -0,0 +1,26 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ /**
7
+ * Post model for venue type updates.
8
+ */
9
+ export type VenueTypePatch = {
10
+ /**
11
+ * Gets or sets the tenant Id.
12
+ */
13
+ tenantId: string;
14
+ /**
15
+ * Gets or sets the Id.
16
+ */
17
+ id: string;
18
+ /**
19
+ * Gets or sets the venue types name.
20
+ */
21
+ name?: string | null;
22
+ /**
23
+ * Gets or sets the venues types description.
24
+ */
25
+ description?: string | null;
26
+ };
@@ -0,0 +1,22 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ /**
7
+ * Post model for venue type inserts.
8
+ */
9
+ export type VenueTypePost = {
10
+ /**
11
+ * Gets or sets the tenant Id.
12
+ */
13
+ tenantId: string;
14
+ /**
15
+ * Gets or sets the venue types name.
16
+ */
17
+ name?: string | null;
18
+ /**
19
+ * Gets or sets the venues types description.
20
+ */
21
+ description?: string | null;
22
+ };
@@ -6,6 +6,7 @@ import type { BookingStatus } from '../models/BookingStatus';
6
6
  import type { Course } from '../models/Course';
7
7
  import type { CourseCreate } from '../models/CourseCreate';
8
8
  import type { CourseEmailAttendeesPatch } from '../models/CourseEmailAttendeesPatch';
9
+ import type { CourseEmailWaitlistPatch } from '../models/CourseEmailWaitlistPatch';
9
10
  import type { CoursePage } from '../models/CoursePage';
10
11
  import type { CoursePatch } from '../models/CoursePatch';
11
12
  import type { CoursePost } from '../models/CoursePost';
@@ -210,6 +211,40 @@ export class CoursesService {
210
211
  });
211
212
  }
212
213
 
214
+ /**
215
+ * Emails all on waitlist for the opportunity />.
216
+ * @returns ScheduledSession OK
217
+ * @throws ApiError
218
+ */
219
+ public contactWaitlist({
220
+ courseId,
221
+ requestBody,
222
+ }: {
223
+ /**
224
+ * The course Id.
225
+ */
226
+ courseId: string;
227
+ /**
228
+ * The patch model.
229
+ */
230
+ requestBody?: CourseEmailWaitlistPatch;
231
+ }): CancelablePromise<ScheduledSession> {
232
+ return this.httpRequest.request({
233
+ method: 'PATCH',
234
+ url: '/api/courses/{courseId}/email-waitlist',
235
+ path: {
236
+ courseId: courseId,
237
+ },
238
+ body: requestBody,
239
+ mediaType: 'application/json',
240
+ errors: {
241
+ 400: `Bad Request`,
242
+ 422: `Unprocessable Content`,
243
+ 500: `Internal Server Error`,
244
+ },
245
+ });
246
+ }
247
+
213
248
  /**
214
249
  * Sends the post course completion email />.
215
250
  * @returns any OK
@@ -171,6 +171,7 @@ export class GenericActivityService {
171
171
  periodsOfWeek,
172
172
  additionalSupport,
173
173
  amenity,
174
+ venueTypeIds,
174
175
  programmeIds,
175
176
  pageNumber,
176
177
  take,
@@ -316,6 +317,10 @@ export class GenericActivityService {
316
317
  * Gets or sets AmenityId.
317
318
  */
318
319
  amenity?: Array<number>;
320
+ /**
321
+ * Gets or sets a list of venue type ids.
322
+ */
323
+ venueTypeIds?: Array<string>;
319
324
  /**
320
325
  * Gets or sets the Programme ids.
321
326
  */
@@ -402,6 +407,7 @@ export class GenericActivityService {
402
407
  PeriodsOfWeek: periodsOfWeek,
403
408
  AdditionalSupport: additionalSupport,
404
409
  Amenity: amenity,
410
+ VenueTypeIds: venueTypeIds,
405
411
  ProgrammeIds: programmeIds,
406
412
  PageNumber: pageNumber,
407
413
  Take: take,
@@ -489,6 +495,7 @@ export class GenericActivityService {
489
495
  periodsOfWeek,
490
496
  additionalSupport,
491
497
  amenity,
498
+ venueTypeIds,
492
499
  programmeIds,
493
500
  pageNumber,
494
501
  take,
@@ -634,6 +641,10 @@ export class GenericActivityService {
634
641
  * Gets or sets AmenityId.
635
642
  */
636
643
  amenity?: Array<number>;
644
+ /**
645
+ * Gets or sets a list of venue type ids.
646
+ */
647
+ venueTypeIds?: Array<string>;
637
648
  /**
638
649
  * Gets or sets the Programme ids.
639
650
  */
@@ -720,6 +731,7 @@ export class GenericActivityService {
720
731
  PeriodsOfWeek: periodsOfWeek,
721
732
  AdditionalSupport: additionalSupport,
722
733
  Amenity: amenity,
734
+ VenueTypeIds: venueTypeIds,
723
735
  ProgrammeIds: programmeIds,
724
736
  PageNumber: pageNumber,
725
737
  Take: take,
@@ -780,6 +792,7 @@ export class GenericActivityService {
780
792
  periodsOfWeek,
781
793
  additionalSupport,
782
794
  amenity,
795
+ venueTypeIds,
783
796
  programmeIds,
784
797
  pageNumber,
785
798
  take,
@@ -925,6 +938,10 @@ export class GenericActivityService {
925
938
  * Gets or sets AmenityId.
926
939
  */
927
940
  amenity?: Array<number>;
941
+ /**
942
+ * Gets or sets a list of venue type ids.
943
+ */
944
+ venueTypeIds?: Array<string>;
928
945
  /**
929
946
  * Gets or sets the Programme ids.
930
947
  */
@@ -1011,6 +1028,7 @@ export class GenericActivityService {
1011
1028
  PeriodsOfWeek: periodsOfWeek,
1012
1029
  AdditionalSupport: additionalSupport,
1013
1030
  Amenity: amenity,
1031
+ VenueTypeIds: venueTypeIds,
1014
1032
  ProgrammeIds: programmeIds,
1015
1033
  PageNumber: pageNumber,
1016
1034
  Take: take,
@@ -1071,6 +1089,7 @@ export class GenericActivityService {
1071
1089
  periodsOfWeek,
1072
1090
  additionalSupport,
1073
1091
  amenity,
1092
+ venueTypeIds,
1074
1093
  programmeIds,
1075
1094
  pageNumber,
1076
1095
  take,
@@ -1216,6 +1235,10 @@ export class GenericActivityService {
1216
1235
  * Gets or sets AmenityId.
1217
1236
  */
1218
1237
  amenity?: Array<number>;
1238
+ /**
1239
+ * Gets or sets a list of venue type ids.
1240
+ */
1241
+ venueTypeIds?: Array<string>;
1219
1242
  /**
1220
1243
  * Gets or sets the Programme ids.
1221
1244
  */
@@ -1302,6 +1325,7 @@ export class GenericActivityService {
1302
1325
  PeriodsOfWeek: periodsOfWeek,
1303
1326
  AdditionalSupport: additionalSupport,
1304
1327
  Amenity: amenity,
1328
+ VenueTypeIds: venueTypeIds,
1305
1329
  ProgrammeIds: programmeIds,
1306
1330
  PageNumber: pageNumber,
1307
1331
  Take: take,
@@ -1362,6 +1386,7 @@ export class GenericActivityService {
1362
1386
  periodsOfWeek,
1363
1387
  additionalSupport,
1364
1388
  amenity,
1389
+ venueTypeIds,
1365
1390
  programmeIds,
1366
1391
  pageNumber,
1367
1392
  take,
@@ -1507,6 +1532,10 @@ export class GenericActivityService {
1507
1532
  * Gets or sets AmenityId.
1508
1533
  */
1509
1534
  amenity?: Array<number>;
1535
+ /**
1536
+ * Gets or sets a list of venue type ids.
1537
+ */
1538
+ venueTypeIds?: Array<string>;
1510
1539
  /**
1511
1540
  * Gets or sets the Programme ids.
1512
1541
  */
@@ -1593,6 +1622,7 @@ export class GenericActivityService {
1593
1622
  PeriodsOfWeek: periodsOfWeek,
1594
1623
  AdditionalSupport: additionalSupport,
1595
1624
  Amenity: amenity,
1625
+ VenueTypeIds: venueTypeIds,
1596
1626
  ProgrammeIds: programmeIds,
1597
1627
  PageNumber: pageNumber,
1598
1628
  Take: take,
@@ -1653,6 +1683,7 @@ export class GenericActivityService {
1653
1683
  periodsOfWeek,
1654
1684
  additionalSupport,
1655
1685
  amenity,
1686
+ venueTypeIds,
1656
1687
  programmeIds,
1657
1688
  pageNumber,
1658
1689
  take,
@@ -1798,6 +1829,10 @@ export class GenericActivityService {
1798
1829
  * Gets or sets AmenityId.
1799
1830
  */
1800
1831
  amenity?: Array<number>;
1832
+ /**
1833
+ * Gets or sets a list of venue type ids.
1834
+ */
1835
+ venueTypeIds?: Array<string>;
1801
1836
  /**
1802
1837
  * Gets or sets the Programme ids.
1803
1838
  */
@@ -1884,6 +1919,7 @@ export class GenericActivityService {
1884
1919
  PeriodsOfWeek: periodsOfWeek,
1885
1920
  AdditionalSupport: additionalSupport,
1886
1921
  Amenity: amenity,
1922
+ VenueTypeIds: venueTypeIds,
1887
1923
  ProgrammeIds: programmeIds,
1888
1924
  PageNumber: pageNumber,
1889
1925
  Take: take,
@@ -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,