reach-api-sdk 1.0.217 → 1.0.219

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 (74) hide show
  1. package/dist/reach-sdk.d.ts +3711 -580
  2. package/dist/reach-sdk.js +2422 -284
  3. package/package.json +1 -1
  4. package/src/apiClient.ts +18 -0
  5. package/src/definition/swagger.yaml +19899 -12337
  6. package/src/index.ts +26 -0
  7. package/src/models/AccessCredential.ts +74 -0
  8. package/src/models/AccessCredentialPage.ts +12 -0
  9. package/src/models/AccessCredentialPatch.ts +18 -0
  10. package/src/models/AccessCredentialPost.ts +14 -0
  11. package/src/models/ActivityType.ts +1 -0
  12. package/src/models/CodelocksLock.ts +62 -0
  13. package/src/models/CodelocksLockPage.ts +12 -0
  14. package/src/models/CodelocksLockPatch.ts +46 -0
  15. package/src/models/CodelocksLockPost.ts +42 -0
  16. package/src/models/Course.ts +4 -0
  17. package/src/models/CourseCreate.ts +4 -0
  18. package/src/models/CoursePatch.ts +4 -0
  19. package/src/models/CourseSession.ts +1 -1
  20. package/src/models/DealActivity.ts +4 -0
  21. package/src/models/DealActivityPost.ts +4 -0
  22. package/src/models/EmailSetting.ts +4 -0
  23. package/src/models/Facility.ts +8 -4
  24. package/src/models/FacilityPatch.ts +4 -0
  25. package/src/models/FacilityPost.ts +4 -0
  26. package/src/models/FeatureAnnouncementDismissPost.ts +14 -0
  27. package/src/models/FeatureAnnouncementForUserDto.ts +38 -0
  28. package/src/models/GenericActivity.ts +4 -0
  29. package/src/models/Image.ts +4 -0
  30. package/src/models/IntegrationCodelocksSettings.ts +38 -0
  31. package/src/models/IntegrationCodelocksSettingsCreate.ts +18 -0
  32. package/src/models/IntegrationCodelocksSettingsPage.ts +12 -0
  33. package/src/models/IntegrationCodelocksSettingsPatch.ts +22 -0
  34. package/src/models/IntegrationCodelocksSettingsPost.ts +18 -0
  35. package/src/models/IntegrationQueue.ts +4 -0
  36. package/src/models/IntegrationType.ts +1 -0
  37. package/src/models/NotificationType.ts +1 -0
  38. package/src/models/Offer.ts +4 -0
  39. package/src/models/OfferPatch.ts +4 -0
  40. package/src/models/OfferPost.ts +4 -0
  41. package/src/models/OpportunityType.ts +1 -0
  42. package/src/models/Order.ts +3 -3
  43. package/src/models/OrderItem.ts +11 -3
  44. package/src/models/OrderItemCodelocksAccess.ts +14 -0
  45. package/src/models/OrderItemReport.ts +25 -1
  46. package/src/models/OrderPatchItem.ts +4 -0
  47. package/src/models/OrderPostItem.ts +4 -0
  48. package/src/models/SellableItem.ts +194 -0
  49. package/src/models/SellableItemPage.ts +12 -0
  50. package/src/models/SellableItemPatch.ts +150 -0
  51. package/src/models/SellableItemPost.ts +145 -0
  52. package/src/models/Session.ts +4 -0
  53. package/src/models/SessionCreate.ts +4 -0
  54. package/src/models/SessionPatch.ts +4 -0
  55. package/src/models/Survey.ts +3 -3
  56. package/src/models/SurveyAnswer.ts +4 -4
  57. package/src/models/SurveyQuestion.ts +3 -3
  58. package/src/models/SurveyQuestionOption.ts +2 -2
  59. package/src/models/WaitlistActivity.ts +3 -3
  60. package/src/models/WaitlistOpportunity.ts +4 -4
  61. package/src/services/AccessCredentialsService.ts +812 -0
  62. package/src/services/CodelocksLocksService.ts +752 -0
  63. package/src/services/DealActivitiesService.ts +60 -0
  64. package/src/services/EmailSettingsService.ts +30 -0
  65. package/src/services/FeatureAnnouncementsService.ts +56 -0
  66. package/src/services/ImagesService.ts +30 -0
  67. package/src/services/IntegrationCodelocksSettingsService.ts +689 -0
  68. package/src/services/IntegrationQueueService.ts +30 -0
  69. package/src/services/OffersService.ts +60 -0
  70. package/src/services/OrderItemsService.ts +30 -0
  71. package/src/services/PublicOrderItemsService.ts +12 -0
  72. package/src/services/PublicSellableItemsService.ts +473 -0
  73. package/src/services/SellableItemsService.ts +962 -0
  74. package/src/services/SessionsService.ts +2 -2
@@ -224,6 +224,8 @@ export class DealActivitiesService {
224
224
  courseIds,
225
225
  sessionId,
226
226
  sessionIds,
227
+ sellableItemId,
228
+ sellableItemIds,
227
229
  pageNumber,
228
230
  take,
229
231
  skip,
@@ -260,6 +262,14 @@ export class DealActivitiesService {
260
262
  * Gets or sets the queryable session ids.
261
263
  */
262
264
  sessionIds?: Array<string>;
265
+ /**
266
+ * Gets or sets the queryable sellable item id.
267
+ */
268
+ sellableItemId?: string;
269
+ /**
270
+ * Gets or sets the queryable sellable item ids.
271
+ */
272
+ sellableItemIds?: Array<string>;
263
273
  /**
264
274
  * Gets or sets the page number for paged queries.
265
275
  */
@@ -315,6 +325,8 @@ export class DealActivitiesService {
315
325
  CourseIds: courseIds,
316
326
  SessionId: sessionId,
317
327
  SessionIds: sessionIds,
328
+ SellableItemId: sellableItemId,
329
+ SellableItemIds: sellableItemIds,
318
330
  PageNumber: pageNumber,
319
331
  Take: take,
320
332
  Skip: skip,
@@ -428,6 +440,8 @@ export class DealActivitiesService {
428
440
  courseIds,
429
441
  sessionId,
430
442
  sessionIds,
443
+ sellableItemId,
444
+ sellableItemIds,
431
445
  pageNumber,
432
446
  take,
433
447
  skip,
@@ -464,6 +478,14 @@ export class DealActivitiesService {
464
478
  * Gets or sets the queryable session ids.
465
479
  */
466
480
  sessionIds?: Array<string>;
481
+ /**
482
+ * Gets or sets the queryable sellable item id.
483
+ */
484
+ sellableItemId?: string;
485
+ /**
486
+ * Gets or sets the queryable sellable item ids.
487
+ */
488
+ sellableItemIds?: Array<string>;
467
489
  /**
468
490
  * Gets or sets the page number for paged queries.
469
491
  */
@@ -519,6 +541,8 @@ export class DealActivitiesService {
519
541
  CourseIds: courseIds,
520
542
  SessionId: sessionId,
521
543
  SessionIds: sessionIds,
544
+ SellableItemId: sellableItemId,
545
+ SellableItemIds: sellableItemIds,
522
546
  PageNumber: pageNumber,
523
547
  Take: take,
524
548
  Skip: skip,
@@ -551,6 +575,8 @@ export class DealActivitiesService {
551
575
  courseIds,
552
576
  sessionId,
553
577
  sessionIds,
578
+ sellableItemId,
579
+ sellableItemIds,
554
580
  pageNumber,
555
581
  take,
556
582
  skip,
@@ -587,6 +613,14 @@ export class DealActivitiesService {
587
613
  * Gets or sets the queryable session ids.
588
614
  */
589
615
  sessionIds?: Array<string>;
616
+ /**
617
+ * Gets or sets the queryable sellable item id.
618
+ */
619
+ sellableItemId?: string;
620
+ /**
621
+ * Gets or sets the queryable sellable item ids.
622
+ */
623
+ sellableItemIds?: Array<string>;
590
624
  /**
591
625
  * Gets or sets the page number for paged queries.
592
626
  */
@@ -642,6 +676,8 @@ export class DealActivitiesService {
642
676
  CourseIds: courseIds,
643
677
  SessionId: sessionId,
644
678
  SessionIds: sessionIds,
679
+ SellableItemId: sellableItemId,
680
+ SellableItemIds: sellableItemIds,
645
681
  PageNumber: pageNumber,
646
682
  Take: take,
647
683
  Skip: skip,
@@ -674,6 +710,8 @@ export class DealActivitiesService {
674
710
  courseIds,
675
711
  sessionId,
676
712
  sessionIds,
713
+ sellableItemId,
714
+ sellableItemIds,
677
715
  pageNumber,
678
716
  take,
679
717
  skip,
@@ -710,6 +748,14 @@ export class DealActivitiesService {
710
748
  * Gets or sets the queryable session ids.
711
749
  */
712
750
  sessionIds?: Array<string>;
751
+ /**
752
+ * Gets or sets the queryable sellable item id.
753
+ */
754
+ sellableItemId?: string;
755
+ /**
756
+ * Gets or sets the queryable sellable item ids.
757
+ */
758
+ sellableItemIds?: Array<string>;
713
759
  /**
714
760
  * Gets or sets the page number for paged queries.
715
761
  */
@@ -765,6 +811,8 @@ export class DealActivitiesService {
765
811
  CourseIds: courseIds,
766
812
  SessionId: sessionId,
767
813
  SessionIds: sessionIds,
814
+ SellableItemId: sellableItemId,
815
+ SellableItemIds: sellableItemIds,
768
816
  PageNumber: pageNumber,
769
817
  Take: take,
770
818
  Skip: skip,
@@ -797,6 +845,8 @@ export class DealActivitiesService {
797
845
  courseIds,
798
846
  sessionId,
799
847
  sessionIds,
848
+ sellableItemId,
849
+ sellableItemIds,
800
850
  pageNumber,
801
851
  take,
802
852
  skip,
@@ -833,6 +883,14 @@ export class DealActivitiesService {
833
883
  * Gets or sets the queryable session ids.
834
884
  */
835
885
  sessionIds?: Array<string>;
886
+ /**
887
+ * Gets or sets the queryable sellable item id.
888
+ */
889
+ sellableItemId?: string;
890
+ /**
891
+ * Gets or sets the queryable sellable item ids.
892
+ */
893
+ sellableItemIds?: Array<string>;
836
894
  /**
837
895
  * Gets or sets the page number for paged queries.
838
896
  */
@@ -888,6 +946,8 @@ export class DealActivitiesService {
888
946
  CourseIds: courseIds,
889
947
  SessionId: sessionId,
890
948
  SessionIds: sessionIds,
949
+ SellableItemId: sellableItemId,
950
+ SellableItemIds: sellableItemIds,
891
951
  PageNumber: pageNumber,
892
952
  Take: take,
893
953
  Skip: skip,
@@ -155,6 +155,7 @@ export class EmailSettingsService {
155
155
  facilityId,
156
156
  sessionId,
157
157
  courseId,
158
+ sellableItemId,
158
159
  pageNumber,
159
160
  take,
160
161
  skip,
@@ -187,6 +188,10 @@ export class EmailSettingsService {
187
188
  * Gets or sets the queryable Course Id.
188
189
  */
189
190
  courseId?: string;
191
+ /**
192
+ * Gets or sets the queryable sellable item Id.
193
+ */
194
+ sellableItemId?: string;
190
195
  /**
191
196
  * Gets or sets the page number for paged queries.
192
197
  */
@@ -241,6 +246,7 @@ export class EmailSettingsService {
241
246
  FacilityId: facilityId,
242
247
  SessionId: sessionId,
243
248
  CourseId: courseId,
249
+ SellableItemId: sellableItemId,
244
250
  PageNumber: pageNumber,
245
251
  Take: take,
246
252
  Skip: skip,
@@ -353,6 +359,7 @@ export class EmailSettingsService {
353
359
  facilityId,
354
360
  sessionId,
355
361
  courseId,
362
+ sellableItemId,
356
363
  pageNumber,
357
364
  take,
358
365
  skip,
@@ -385,6 +392,10 @@ export class EmailSettingsService {
385
392
  * Gets or sets the queryable Course Id.
386
393
  */
387
394
  courseId?: string;
395
+ /**
396
+ * Gets or sets the queryable sellable item Id.
397
+ */
398
+ sellableItemId?: string;
388
399
  /**
389
400
  * Gets or sets the page number for paged queries.
390
401
  */
@@ -439,6 +450,7 @@ export class EmailSettingsService {
439
450
  FacilityId: facilityId,
440
451
  SessionId: sessionId,
441
452
  CourseId: courseId,
453
+ SellableItemId: sellableItemId,
442
454
  PageNumber: pageNumber,
443
455
  Take: take,
444
456
  Skip: skip,
@@ -470,6 +482,7 @@ export class EmailSettingsService {
470
482
  facilityId,
471
483
  sessionId,
472
484
  courseId,
485
+ sellableItemId,
473
486
  pageNumber,
474
487
  take,
475
488
  skip,
@@ -502,6 +515,10 @@ export class EmailSettingsService {
502
515
  * Gets or sets the queryable Course Id.
503
516
  */
504
517
  courseId?: string;
518
+ /**
519
+ * Gets or sets the queryable sellable item Id.
520
+ */
521
+ sellableItemId?: string;
505
522
  /**
506
523
  * Gets or sets the page number for paged queries.
507
524
  */
@@ -556,6 +573,7 @@ export class EmailSettingsService {
556
573
  FacilityId: facilityId,
557
574
  SessionId: sessionId,
558
575
  CourseId: courseId,
576
+ SellableItemId: sellableItemId,
559
577
  PageNumber: pageNumber,
560
578
  Take: take,
561
579
  Skip: skip,
@@ -587,6 +605,7 @@ export class EmailSettingsService {
587
605
  facilityId,
588
606
  sessionId,
589
607
  courseId,
608
+ sellableItemId,
590
609
  pageNumber,
591
610
  take,
592
611
  skip,
@@ -619,6 +638,10 @@ export class EmailSettingsService {
619
638
  * Gets or sets the queryable Course Id.
620
639
  */
621
640
  courseId?: string;
641
+ /**
642
+ * Gets or sets the queryable sellable item Id.
643
+ */
644
+ sellableItemId?: string;
622
645
  /**
623
646
  * Gets or sets the page number for paged queries.
624
647
  */
@@ -673,6 +696,7 @@ export class EmailSettingsService {
673
696
  FacilityId: facilityId,
674
697
  SessionId: sessionId,
675
698
  CourseId: courseId,
699
+ SellableItemId: sellableItemId,
676
700
  PageNumber: pageNumber,
677
701
  Take: take,
678
702
  Skip: skip,
@@ -704,6 +728,7 @@ export class EmailSettingsService {
704
728
  facilityId,
705
729
  sessionId,
706
730
  courseId,
731
+ sellableItemId,
707
732
  pageNumber,
708
733
  take,
709
734
  skip,
@@ -736,6 +761,10 @@ export class EmailSettingsService {
736
761
  * Gets or sets the queryable Course Id.
737
762
  */
738
763
  courseId?: string;
764
+ /**
765
+ * Gets or sets the queryable sellable item Id.
766
+ */
767
+ sellableItemId?: string;
739
768
  /**
740
769
  * Gets or sets the page number for paged queries.
741
770
  */
@@ -790,6 +819,7 @@ export class EmailSettingsService {
790
819
  FacilityId: facilityId,
791
820
  SessionId: sessionId,
792
821
  CourseId: courseId,
822
+ SellableItemId: sellableItemId,
793
823
  PageNumber: pageNumber,
794
824
  Take: take,
795
825
  Skip: skip,
@@ -0,0 +1,56 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { FeatureAnnouncementDismissPost } from '../models/FeatureAnnouncementDismissPost';
6
+ import type { FeatureAnnouncementForUserDto } from '../models/FeatureAnnouncementForUserDto';
7
+
8
+ import type { CancelablePromise } from '../core/CancelablePromise';
9
+ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
10
+
11
+ export class FeatureAnnouncementsService {
12
+ constructor(public readonly httpRequest: BaseHttpRequest) {}
13
+
14
+ /**
15
+ * Returns active announcements for the current user (filtered by schedule, dismissal, role, and latest version per slug).
16
+ * @returns FeatureAnnouncementForUserDto OK
17
+ * @throws ApiError
18
+ */
19
+ public getActive(): CancelablePromise<Array<FeatureAnnouncementForUserDto>> {
20
+ return this.httpRequest.request({
21
+ method: 'GET',
22
+ url: '/api/feature-announcements/active',
23
+ errors: {
24
+ 400: `Bad Request`,
25
+ 422: `Unprocessable Content`,
26
+ 500: `Internal Server Error`,
27
+ },
28
+ });
29
+ }
30
+
31
+ /**
32
+ * Records a dismissal for the current user (idempotent).
33
+ * @returns any OK
34
+ * @throws ApiError
35
+ */
36
+ public dismiss({
37
+ requestBody,
38
+ }: {
39
+ /**
40
+ * Dismissal body.
41
+ */
42
+ requestBody?: FeatureAnnouncementDismissPost;
43
+ }): CancelablePromise<any> {
44
+ return this.httpRequest.request({
45
+ method: 'POST',
46
+ url: '/api/feature-announcements/dismiss',
47
+ body: requestBody,
48
+ mediaType: 'application/json',
49
+ errors: {
50
+ 400: `Bad Request`,
51
+ 422: `Unprocessable Content`,
52
+ 500: `Internal Server Error`,
53
+ },
54
+ });
55
+ }
56
+ }
@@ -184,6 +184,7 @@ export class ImagesService {
184
184
  sessionIds,
185
185
  courseId,
186
186
  courseIds,
187
+ sellableItemIds,
187
188
  programmeId,
188
189
  programmeIds,
189
190
  pageNumber,
@@ -230,6 +231,10 @@ export class ImagesService {
230
231
  * Gets or sets the queryable course ids.
231
232
  */
232
233
  courseIds?: Array<string>;
234
+ /**
235
+ * Gets or sets the queryable sellable item ids.
236
+ */
237
+ sellableItemIds?: Array<string>;
233
238
  /**
234
239
  * Gets or sets the queryable programme id.
235
240
  */
@@ -295,6 +300,7 @@ export class ImagesService {
295
300
  SessionIds: sessionIds,
296
301
  CourseId: courseId,
297
302
  CourseIds: courseIds,
303
+ SellableItemIds: sellableItemIds,
298
304
  ProgrammeId: programmeId,
299
305
  ProgrammeIds: programmeIds,
300
306
  PageNumber: pageNumber,
@@ -412,6 +418,7 @@ export class ImagesService {
412
418
  sessionIds,
413
419
  courseId,
414
420
  courseIds,
421
+ sellableItemIds,
415
422
  programmeId,
416
423
  programmeIds,
417
424
  pageNumber,
@@ -458,6 +465,10 @@ export class ImagesService {
458
465
  * Gets or sets the queryable course ids.
459
466
  */
460
467
  courseIds?: Array<string>;
468
+ /**
469
+ * Gets or sets the queryable sellable item ids.
470
+ */
471
+ sellableItemIds?: Array<string>;
461
472
  /**
462
473
  * Gets or sets the queryable programme id.
463
474
  */
@@ -523,6 +534,7 @@ export class ImagesService {
523
534
  SessionIds: sessionIds,
524
535
  CourseId: courseId,
525
536
  CourseIds: courseIds,
537
+ SellableItemIds: sellableItemIds,
526
538
  ProgrammeId: programmeId,
527
539
  ProgrammeIds: programmeIds,
528
540
  PageNumber: pageNumber,
@@ -559,6 +571,7 @@ export class ImagesService {
559
571
  sessionIds,
560
572
  courseId,
561
573
  courseIds,
574
+ sellableItemIds,
562
575
  programmeId,
563
576
  programmeIds,
564
577
  pageNumber,
@@ -605,6 +618,10 @@ export class ImagesService {
605
618
  * Gets or sets the queryable course ids.
606
619
  */
607
620
  courseIds?: Array<string>;
621
+ /**
622
+ * Gets or sets the queryable sellable item ids.
623
+ */
624
+ sellableItemIds?: Array<string>;
608
625
  /**
609
626
  * Gets or sets the queryable programme id.
610
627
  */
@@ -670,6 +687,7 @@ export class ImagesService {
670
687
  SessionIds: sessionIds,
671
688
  CourseId: courseId,
672
689
  CourseIds: courseIds,
690
+ SellableItemIds: sellableItemIds,
673
691
  ProgrammeId: programmeId,
674
692
  ProgrammeIds: programmeIds,
675
693
  PageNumber: pageNumber,
@@ -706,6 +724,7 @@ export class ImagesService {
706
724
  sessionIds,
707
725
  courseId,
708
726
  courseIds,
727
+ sellableItemIds,
709
728
  programmeId,
710
729
  programmeIds,
711
730
  pageNumber,
@@ -752,6 +771,10 @@ export class ImagesService {
752
771
  * Gets or sets the queryable course ids.
753
772
  */
754
773
  courseIds?: Array<string>;
774
+ /**
775
+ * Gets or sets the queryable sellable item ids.
776
+ */
777
+ sellableItemIds?: Array<string>;
755
778
  /**
756
779
  * Gets or sets the queryable programme id.
757
780
  */
@@ -817,6 +840,7 @@ export class ImagesService {
817
840
  SessionIds: sessionIds,
818
841
  CourseId: courseId,
819
842
  CourseIds: courseIds,
843
+ SellableItemIds: sellableItemIds,
820
844
  ProgrammeId: programmeId,
821
845
  ProgrammeIds: programmeIds,
822
846
  PageNumber: pageNumber,
@@ -853,6 +877,7 @@ export class ImagesService {
853
877
  sessionIds,
854
878
  courseId,
855
879
  courseIds,
880
+ sellableItemIds,
856
881
  programmeId,
857
882
  programmeIds,
858
883
  pageNumber,
@@ -899,6 +924,10 @@ export class ImagesService {
899
924
  * Gets or sets the queryable course ids.
900
925
  */
901
926
  courseIds?: Array<string>;
927
+ /**
928
+ * Gets or sets the queryable sellable item ids.
929
+ */
930
+ sellableItemIds?: Array<string>;
902
931
  /**
903
932
  * Gets or sets the queryable programme id.
904
933
  */
@@ -964,6 +993,7 @@ export class ImagesService {
964
993
  SessionIds: sessionIds,
965
994
  CourseId: courseId,
966
995
  CourseIds: courseIds,
996
+ SellableItemIds: sellableItemIds,
967
997
  ProgrammeId: programmeId,
968
998
  ProgrammeIds: programmeIds,
969
999
  PageNumber: pageNumber,