reach-api-sdk 1.0.209 → 1.0.211
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/dist/reach-sdk.d.ts +2742 -647
- package/dist/reach-sdk.js +2636 -935
- package/package.json +1 -1
- package/src/apiClient.ts +15 -0
- package/src/definition/swagger.yaml +7106 -1465
- package/src/index.ts +28 -0
- package/src/models/AddressBookItem.ts +26 -0
- package/src/models/AddressBooksRequest.ts +22 -0
- package/src/models/Customer.ts +0 -4
- package/src/models/DotdigitalCanonicalField.ts +17 -0
- package/src/models/DotdigitalSourceType.ts +15 -0
- package/src/models/IntegrationDotdigitalFieldMap.ts +55 -0
- package/src/models/IntegrationDotdigitalFieldMapPage.ts +12 -0
- package/src/models/IntegrationDotdigitalFieldMapPatch.ts +18 -0
- package/src/models/IntegrationDotdigitalFieldMapPost.ts +14 -0
- package/src/models/IntegrationDotdigitalLog.ts +65 -0
- package/src/models/IntegrationDotdigitalLogPage.ts +12 -0
- package/src/models/IntegrationDotdigitalLogPatch.ts +18 -0
- package/src/models/IntegrationDotdigitalLogPost.ts +14 -0
- package/src/models/IntegrationDotdigitalLogStatus.ts +13 -0
- package/src/models/IntegrationDotdigitalSettings.ts +66 -0
- package/src/models/IntegrationDotdigitalSettingsCreate.ts +38 -0
- package/src/models/IntegrationDotdigitalSettingsPage.ts +12 -0
- package/src/models/IntegrationDotdigitalSettingsPatch.ts +18 -0
- package/src/models/IntegrationDotdigitalSettingsPost.ts +14 -0
- package/src/models/IntegrationQueue.ts +57 -0
- package/src/models/IntegrationQueuePage.ts +12 -0
- package/src/models/IntegrationQueuePatch.ts +18 -0
- package/src/models/IntegrationQueuePost.ts +14 -0
- package/src/models/IntegrationType.ts +11 -0
- package/src/models/OrderItem.ts +4 -0
- package/src/models/OrderItemReport.ts +4 -0
- package/src/services/CourseSessionsService.ts +30 -0
- package/src/services/CustomersService.ts +42 -0
- package/src/services/DotdigitalService.ts +39 -0
- package/src/services/IntegrationDotDigitalSettingsService.ts +708 -0
- package/src/services/IntegrationDotdigitalFieldMapService.ts +662 -0
- package/src/services/IntegrationDotdigitalLogService.ts +662 -0
- package/src/services/IntegrationQueueService.ts +739 -0
- package/src/services/PublicCalendarService.ts +6 -0
- package/src/services/PublicCustomersService.ts +12 -0
- package/src/services/PublicScheduledSessionsService.ts +12 -0
- package/src/services/PublicSessionsService.ts +6 -0
- package/src/services/PublicVenuesService.ts +48 -0
- package/src/services/ScheduledSessionsService.ts +30 -0
- package/src/services/VenuesService.ts +60 -0
|
@@ -233,6 +233,7 @@ export class CourseSessionsService {
|
|
|
233
233
|
ids,
|
|
234
234
|
venueId,
|
|
235
235
|
programmeId,
|
|
236
|
+
providerId,
|
|
236
237
|
courseId,
|
|
237
238
|
courseIds,
|
|
238
239
|
scheduleId,
|
|
@@ -272,6 +273,10 @@ export class CourseSessionsService {
|
|
|
272
273
|
* Gets or sets the queryable course sessions programme Id.
|
|
273
274
|
*/
|
|
274
275
|
programmeId?: string;
|
|
276
|
+
/**
|
|
277
|
+
* Gets or sets the queryable course session provider Id.
|
|
278
|
+
*/
|
|
279
|
+
providerId?: string;
|
|
275
280
|
/**
|
|
276
281
|
* Gets or sets the queryable course session Id.
|
|
277
282
|
*/
|
|
@@ -384,6 +389,7 @@ export class CourseSessionsService {
|
|
|
384
389
|
Ids: ids,
|
|
385
390
|
VenueId: venueId,
|
|
386
391
|
ProgrammeId: programmeId,
|
|
392
|
+
ProviderId: providerId,
|
|
387
393
|
CourseId: courseId,
|
|
388
394
|
CourseIds: courseIds,
|
|
389
395
|
ScheduleId: scheduleId,
|
|
@@ -509,6 +515,7 @@ export class CourseSessionsService {
|
|
|
509
515
|
ids,
|
|
510
516
|
venueId,
|
|
511
517
|
programmeId,
|
|
518
|
+
providerId,
|
|
512
519
|
courseId,
|
|
513
520
|
courseIds,
|
|
514
521
|
scheduleId,
|
|
@@ -548,6 +555,10 @@ export class CourseSessionsService {
|
|
|
548
555
|
* Gets or sets the queryable course sessions programme Id.
|
|
549
556
|
*/
|
|
550
557
|
programmeId?: string;
|
|
558
|
+
/**
|
|
559
|
+
* Gets or sets the queryable course session provider Id.
|
|
560
|
+
*/
|
|
561
|
+
providerId?: string;
|
|
551
562
|
/**
|
|
552
563
|
* Gets or sets the queryable course session Id.
|
|
553
564
|
*/
|
|
@@ -660,6 +671,7 @@ export class CourseSessionsService {
|
|
|
660
671
|
Ids: ids,
|
|
661
672
|
VenueId: venueId,
|
|
662
673
|
ProgrammeId: programmeId,
|
|
674
|
+
ProviderId: providerId,
|
|
663
675
|
CourseId: courseId,
|
|
664
676
|
CourseIds: courseIds,
|
|
665
677
|
ScheduleId: scheduleId,
|
|
@@ -704,6 +716,7 @@ export class CourseSessionsService {
|
|
|
704
716
|
ids,
|
|
705
717
|
venueId,
|
|
706
718
|
programmeId,
|
|
719
|
+
providerId,
|
|
707
720
|
courseId,
|
|
708
721
|
courseIds,
|
|
709
722
|
scheduleId,
|
|
@@ -743,6 +756,10 @@ export class CourseSessionsService {
|
|
|
743
756
|
* Gets or sets the queryable course sessions programme Id.
|
|
744
757
|
*/
|
|
745
758
|
programmeId?: string;
|
|
759
|
+
/**
|
|
760
|
+
* Gets or sets the queryable course session provider Id.
|
|
761
|
+
*/
|
|
762
|
+
providerId?: string;
|
|
746
763
|
/**
|
|
747
764
|
* Gets or sets the queryable course session Id.
|
|
748
765
|
*/
|
|
@@ -855,6 +872,7 @@ export class CourseSessionsService {
|
|
|
855
872
|
Ids: ids,
|
|
856
873
|
VenueId: venueId,
|
|
857
874
|
ProgrammeId: programmeId,
|
|
875
|
+
ProviderId: providerId,
|
|
858
876
|
CourseId: courseId,
|
|
859
877
|
CourseIds: courseIds,
|
|
860
878
|
ScheduleId: scheduleId,
|
|
@@ -899,6 +917,7 @@ export class CourseSessionsService {
|
|
|
899
917
|
ids,
|
|
900
918
|
venueId,
|
|
901
919
|
programmeId,
|
|
920
|
+
providerId,
|
|
902
921
|
courseId,
|
|
903
922
|
courseIds,
|
|
904
923
|
scheduleId,
|
|
@@ -938,6 +957,10 @@ export class CourseSessionsService {
|
|
|
938
957
|
* Gets or sets the queryable course sessions programme Id.
|
|
939
958
|
*/
|
|
940
959
|
programmeId?: string;
|
|
960
|
+
/**
|
|
961
|
+
* Gets or sets the queryable course session provider Id.
|
|
962
|
+
*/
|
|
963
|
+
providerId?: string;
|
|
941
964
|
/**
|
|
942
965
|
* Gets or sets the queryable course session Id.
|
|
943
966
|
*/
|
|
@@ -1050,6 +1073,7 @@ export class CourseSessionsService {
|
|
|
1050
1073
|
Ids: ids,
|
|
1051
1074
|
VenueId: venueId,
|
|
1052
1075
|
ProgrammeId: programmeId,
|
|
1076
|
+
ProviderId: providerId,
|
|
1053
1077
|
CourseId: courseId,
|
|
1054
1078
|
CourseIds: courseIds,
|
|
1055
1079
|
ScheduleId: scheduleId,
|
|
@@ -1094,6 +1118,7 @@ export class CourseSessionsService {
|
|
|
1094
1118
|
ids,
|
|
1095
1119
|
venueId,
|
|
1096
1120
|
programmeId,
|
|
1121
|
+
providerId,
|
|
1097
1122
|
courseId,
|
|
1098
1123
|
courseIds,
|
|
1099
1124
|
scheduleId,
|
|
@@ -1133,6 +1158,10 @@ export class CourseSessionsService {
|
|
|
1133
1158
|
* Gets or sets the queryable course sessions programme Id.
|
|
1134
1159
|
*/
|
|
1135
1160
|
programmeId?: string;
|
|
1161
|
+
/**
|
|
1162
|
+
* Gets or sets the queryable course session provider Id.
|
|
1163
|
+
*/
|
|
1164
|
+
providerId?: string;
|
|
1136
1165
|
/**
|
|
1137
1166
|
* Gets or sets the queryable course session Id.
|
|
1138
1167
|
*/
|
|
@@ -1245,6 +1274,7 @@ export class CourseSessionsService {
|
|
|
1245
1274
|
Ids: ids,
|
|
1246
1275
|
VenueId: venueId,
|
|
1247
1276
|
ProgrammeId: programmeId,
|
|
1277
|
+
ProviderId: providerId,
|
|
1248
1278
|
CourseId: courseId,
|
|
1249
1279
|
CourseIds: courseIds,
|
|
1250
1280
|
ScheduleId: scheduleId,
|
|
@@ -121,6 +121,7 @@ export class CustomersService {
|
|
|
121
121
|
wildcard,
|
|
122
122
|
displayEmail,
|
|
123
123
|
venueId,
|
|
124
|
+
providerId,
|
|
124
125
|
programmeId,
|
|
125
126
|
marketingOptIn,
|
|
126
127
|
isActiveCustomer,
|
|
@@ -150,6 +151,10 @@ export class CustomersService {
|
|
|
150
151
|
* Gets or sets the venue id for use in a query search.
|
|
151
152
|
*/
|
|
152
153
|
venueId?: string;
|
|
154
|
+
/**
|
|
155
|
+
* Gets or sets the provider id for use in a query search.
|
|
156
|
+
*/
|
|
157
|
+
providerId?: string;
|
|
153
158
|
/**
|
|
154
159
|
* Gets or sets the programme id for use in a query search - filtering for customers who have touch points with the programme.
|
|
155
160
|
*/
|
|
@@ -224,6 +229,7 @@ export class CustomersService {
|
|
|
224
229
|
Wildcard: wildcard,
|
|
225
230
|
DisplayEmail: displayEmail,
|
|
226
231
|
VenueId: venueId,
|
|
232
|
+
ProviderId: providerId,
|
|
227
233
|
ProgrammeId: programmeId,
|
|
228
234
|
MarketingOptIn: marketingOptIn,
|
|
229
235
|
IsActiveCustomer: isActiveCustomer,
|
|
@@ -260,6 +266,7 @@ export class CustomersService {
|
|
|
260
266
|
wildcard,
|
|
261
267
|
displayEmail,
|
|
262
268
|
venueId,
|
|
269
|
+
providerId,
|
|
263
270
|
programmeId,
|
|
264
271
|
marketingOptIn,
|
|
265
272
|
isActiveCustomer,
|
|
@@ -289,6 +296,10 @@ export class CustomersService {
|
|
|
289
296
|
* Gets or sets the venue id for use in a query search.
|
|
290
297
|
*/
|
|
291
298
|
venueId?: string;
|
|
299
|
+
/**
|
|
300
|
+
* Gets or sets the provider id for use in a query search.
|
|
301
|
+
*/
|
|
302
|
+
providerId?: string;
|
|
292
303
|
/**
|
|
293
304
|
* Gets or sets the programme id for use in a query search - filtering for customers who have touch points with the programme.
|
|
294
305
|
*/
|
|
@@ -363,6 +374,7 @@ export class CustomersService {
|
|
|
363
374
|
Wildcard: wildcard,
|
|
364
375
|
DisplayEmail: displayEmail,
|
|
365
376
|
VenueId: venueId,
|
|
377
|
+
ProviderId: providerId,
|
|
366
378
|
ProgrammeId: programmeId,
|
|
367
379
|
MarketingOptIn: marketingOptIn,
|
|
368
380
|
IsActiveCustomer: isActiveCustomer,
|
|
@@ -528,6 +540,7 @@ export class CustomersService {
|
|
|
528
540
|
wildcard,
|
|
529
541
|
displayEmail,
|
|
530
542
|
venueId,
|
|
543
|
+
providerId,
|
|
531
544
|
programmeId,
|
|
532
545
|
marketingOptIn,
|
|
533
546
|
isActiveCustomer,
|
|
@@ -556,6 +569,10 @@ export class CustomersService {
|
|
|
556
569
|
* Gets or sets the venue id for use in a query search.
|
|
557
570
|
*/
|
|
558
571
|
venueId?: string;
|
|
572
|
+
/**
|
|
573
|
+
* Gets or sets the provider id for use in a query search.
|
|
574
|
+
*/
|
|
575
|
+
providerId?: string;
|
|
559
576
|
/**
|
|
560
577
|
* Gets or sets the programme id for use in a query search - filtering for customers who have touch points with the programme.
|
|
561
578
|
*/
|
|
@@ -624,6 +641,7 @@ export class CustomersService {
|
|
|
624
641
|
Wildcard: wildcard,
|
|
625
642
|
DisplayEmail: displayEmail,
|
|
626
643
|
VenueId: venueId,
|
|
644
|
+
ProviderId: providerId,
|
|
627
645
|
ProgrammeId: programmeId,
|
|
628
646
|
MarketingOptIn: marketingOptIn,
|
|
629
647
|
IsActiveCustomer: isActiveCustomer,
|
|
@@ -738,6 +756,7 @@ export class CustomersService {
|
|
|
738
756
|
wildcard,
|
|
739
757
|
displayEmail,
|
|
740
758
|
venueId,
|
|
759
|
+
providerId,
|
|
741
760
|
programmeId,
|
|
742
761
|
marketingOptIn,
|
|
743
762
|
isActiveCustomer,
|
|
@@ -766,6 +785,10 @@ export class CustomersService {
|
|
|
766
785
|
* Gets or sets the venue id for use in a query search.
|
|
767
786
|
*/
|
|
768
787
|
venueId?: string;
|
|
788
|
+
/**
|
|
789
|
+
* Gets or sets the provider id for use in a query search.
|
|
790
|
+
*/
|
|
791
|
+
providerId?: string;
|
|
769
792
|
/**
|
|
770
793
|
* Gets or sets the programme id for use in a query search - filtering for customers who have touch points with the programme.
|
|
771
794
|
*/
|
|
@@ -834,6 +857,7 @@ export class CustomersService {
|
|
|
834
857
|
Wildcard: wildcard,
|
|
835
858
|
DisplayEmail: displayEmail,
|
|
836
859
|
VenueId: venueId,
|
|
860
|
+
ProviderId: providerId,
|
|
837
861
|
ProgrammeId: programmeId,
|
|
838
862
|
MarketingOptIn: marketingOptIn,
|
|
839
863
|
IsActiveCustomer: isActiveCustomer,
|
|
@@ -867,6 +891,7 @@ export class CustomersService {
|
|
|
867
891
|
wildcard,
|
|
868
892
|
displayEmail,
|
|
869
893
|
venueId,
|
|
894
|
+
providerId,
|
|
870
895
|
programmeId,
|
|
871
896
|
marketingOptIn,
|
|
872
897
|
isActiveCustomer,
|
|
@@ -895,6 +920,10 @@ export class CustomersService {
|
|
|
895
920
|
* Gets or sets the venue id for use in a query search.
|
|
896
921
|
*/
|
|
897
922
|
venueId?: string;
|
|
923
|
+
/**
|
|
924
|
+
* Gets or sets the provider id for use in a query search.
|
|
925
|
+
*/
|
|
926
|
+
providerId?: string;
|
|
898
927
|
/**
|
|
899
928
|
* Gets or sets the programme id for use in a query search - filtering for customers who have touch points with the programme.
|
|
900
929
|
*/
|
|
@@ -963,6 +992,7 @@ export class CustomersService {
|
|
|
963
992
|
Wildcard: wildcard,
|
|
964
993
|
DisplayEmail: displayEmail,
|
|
965
994
|
VenueId: venueId,
|
|
995
|
+
ProviderId: providerId,
|
|
966
996
|
ProgrammeId: programmeId,
|
|
967
997
|
MarketingOptIn: marketingOptIn,
|
|
968
998
|
IsActiveCustomer: isActiveCustomer,
|
|
@@ -996,6 +1026,7 @@ export class CustomersService {
|
|
|
996
1026
|
wildcard,
|
|
997
1027
|
displayEmail,
|
|
998
1028
|
venueId,
|
|
1029
|
+
providerId,
|
|
999
1030
|
programmeId,
|
|
1000
1031
|
marketingOptIn,
|
|
1001
1032
|
isActiveCustomer,
|
|
@@ -1024,6 +1055,10 @@ export class CustomersService {
|
|
|
1024
1055
|
* Gets or sets the venue id for use in a query search.
|
|
1025
1056
|
*/
|
|
1026
1057
|
venueId?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Gets or sets the provider id for use in a query search.
|
|
1060
|
+
*/
|
|
1061
|
+
providerId?: string;
|
|
1027
1062
|
/**
|
|
1028
1063
|
* Gets or sets the programme id for use in a query search - filtering for customers who have touch points with the programme.
|
|
1029
1064
|
*/
|
|
@@ -1092,6 +1127,7 @@ export class CustomersService {
|
|
|
1092
1127
|
Wildcard: wildcard,
|
|
1093
1128
|
DisplayEmail: displayEmail,
|
|
1094
1129
|
VenueId: venueId,
|
|
1130
|
+
ProviderId: providerId,
|
|
1095
1131
|
ProgrammeId: programmeId,
|
|
1096
1132
|
MarketingOptIn: marketingOptIn,
|
|
1097
1133
|
IsActiveCustomer: isActiveCustomer,
|
|
@@ -1125,6 +1161,7 @@ export class CustomersService {
|
|
|
1125
1161
|
wildcard,
|
|
1126
1162
|
displayEmail,
|
|
1127
1163
|
venueId,
|
|
1164
|
+
providerId,
|
|
1128
1165
|
programmeId,
|
|
1129
1166
|
marketingOptIn,
|
|
1130
1167
|
isActiveCustomer,
|
|
@@ -1153,6 +1190,10 @@ export class CustomersService {
|
|
|
1153
1190
|
* Gets or sets the venue id for use in a query search.
|
|
1154
1191
|
*/
|
|
1155
1192
|
venueId?: string;
|
|
1193
|
+
/**
|
|
1194
|
+
* Gets or sets the provider id for use in a query search.
|
|
1195
|
+
*/
|
|
1196
|
+
providerId?: string;
|
|
1156
1197
|
/**
|
|
1157
1198
|
* Gets or sets the programme id for use in a query search - filtering for customers who have touch points with the programme.
|
|
1158
1199
|
*/
|
|
@@ -1221,6 +1262,7 @@ export class CustomersService {
|
|
|
1221
1262
|
Wildcard: wildcard,
|
|
1222
1263
|
DisplayEmail: displayEmail,
|
|
1223
1264
|
VenueId: venueId,
|
|
1265
|
+
ProviderId: providerId,
|
|
1224
1266
|
ProgrammeId: programmeId,
|
|
1225
1267
|
MarketingOptIn: marketingOptIn,
|
|
1226
1268
|
IsActiveCustomer: isActiveCustomer,
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
import type { AddressBookItem } from '../models/AddressBookItem';
|
|
6
|
+
import type { AddressBooksRequest } from '../models/AddressBooksRequest';
|
|
7
|
+
|
|
8
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
9
|
+
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
10
|
+
|
|
11
|
+
export class DotdigitalService {
|
|
12
|
+
constructor(public readonly httpRequest: BaseHttpRequest) {}
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Returns a suggestion for an activity description based on given attributes.
|
|
16
|
+
* @returns AddressBookItem OK
|
|
17
|
+
* @throws ApiError
|
|
18
|
+
*/
|
|
19
|
+
public getAddressBooks({
|
|
20
|
+
requestBody,
|
|
21
|
+
}: {
|
|
22
|
+
/**
|
|
23
|
+
* The attributes to use to generate the the open AI response.
|
|
24
|
+
*/
|
|
25
|
+
requestBody?: AddressBooksRequest;
|
|
26
|
+
}): CancelablePromise<Array<AddressBookItem>> {
|
|
27
|
+
return this.httpRequest.request({
|
|
28
|
+
method: 'POST',
|
|
29
|
+
url: '/api/external/dotdigital/address-books',
|
|
30
|
+
body: requestBody,
|
|
31
|
+
mediaType: 'application/json',
|
|
32
|
+
errors: {
|
|
33
|
+
400: `Bad Request`,
|
|
34
|
+
422: `Unprocessable Content`,
|
|
35
|
+
500: `Internal Server Error`,
|
|
36
|
+
},
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
}
|