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
@@ -0,0 +1,401 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
6
+ import type { VenueType } from '../models/VenueType';
7
+ import type { VenueTypePage } from '../models/VenueTypePage';
8
+ import type { VenueTypePatch } from '../models/VenueTypePatch';
9
+ import type { VenueTypePost } from '../models/VenueTypePost';
10
+
11
+ import type { CancelablePromise } from '../core/CancelablePromise';
12
+ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
13
+
14
+ export class PublicVenueTypesService {
15
+ constructor(public readonly httpRequest: BaseHttpRequest) {}
16
+
17
+ /**
18
+ * @returns VenueType OK
19
+ * @throws ApiError
20
+ */
21
+ public getObject({
22
+ id,
23
+ xTenantSubdomain,
24
+ }: {
25
+ id: string;
26
+ xTenantSubdomain?: string;
27
+ }): CancelablePromise<VenueType> {
28
+ return this.httpRequest.request({
29
+ method: 'GET',
30
+ url: '/api/public/venue-types/{id}',
31
+ path: {
32
+ id: id,
33
+ },
34
+ headers: {
35
+ x_tenant_subdomain: xTenantSubdomain,
36
+ },
37
+ errors: {
38
+ 400: `Bad Request`,
39
+ 422: `Unprocessable Content`,
40
+ 500: `Internal Server Error`,
41
+ },
42
+ });
43
+ }
44
+
45
+ /**
46
+ * Deletes the resource.
47
+ * @returns any OK
48
+ * @throws ApiError
49
+ */
50
+ public deleteById({
51
+ id,
52
+ xTenantSubdomain,
53
+ }: {
54
+ /**
55
+ * The <typeparamref name="TObject" /> id.
56
+ */
57
+ id: string;
58
+ /**
59
+ * The tenants subdomain.
60
+ */
61
+ xTenantSubdomain?: string;
62
+ }): CancelablePromise<any> {
63
+ return this.httpRequest.request({
64
+ method: 'DELETE',
65
+ url: '/api/public/venue-types/{id}',
66
+ path: {
67
+ id: id,
68
+ },
69
+ headers: {
70
+ x_tenant_subdomain: xTenantSubdomain,
71
+ },
72
+ errors: {
73
+ 400: `Bad Request`,
74
+ 422: `Unprocessable Content`,
75
+ 500: `Internal Server Error`,
76
+ },
77
+ });
78
+ }
79
+
80
+ /**
81
+ * @returns VenueTypePage OK
82
+ * @throws ApiError
83
+ */
84
+ public getPage({
85
+ xTenantSubdomain,
86
+ pageNumber,
87
+ take,
88
+ skip,
89
+ limitListRequests,
90
+ tenantId,
91
+ modifiedById,
92
+ modifiedByIds,
93
+ dateCreatedGte,
94
+ dateCreatedLte,
95
+ isLive,
96
+ sortOrderDirection,
97
+ }: {
98
+ xTenantSubdomain?: string;
99
+ /**
100
+ * Gets or sets the page number for paged queries.
101
+ */
102
+ pageNumber?: number;
103
+ /**
104
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
105
+ */
106
+ take?: number;
107
+ /**
108
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
109
+ */
110
+ skip?: number;
111
+ /**
112
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
113
+ */
114
+ limitListRequests?: boolean;
115
+ /**
116
+ * Gets or sets the Tenant Id.
117
+ */
118
+ tenantId?: string;
119
+ /**
120
+ * Gets or sets the Modifed By Id.
121
+ */
122
+ modifiedById?: string;
123
+ /**
124
+ * Gets or sets the Modifed By Ids.
125
+ */
126
+ modifiedByIds?: Array<string>;
127
+ /**
128
+ * Gets or sets the Date Created greater than equal to.
129
+ */
130
+ dateCreatedGte?: string;
131
+ /**
132
+ * Gets or sets the Date Created less than equal to.
133
+ */
134
+ dateCreatedLte?: string;
135
+ /**
136
+ * Gets or sets the queryable only is live status.
137
+ */
138
+ isLive?: boolean;
139
+ /**
140
+ * Gets or sets the sort order direction.
141
+ */
142
+ sortOrderDirection?: SearchSortOrderDirection;
143
+ }): CancelablePromise<VenueTypePage> {
144
+ return this.httpRequest.request({
145
+ method: 'GET',
146
+ url: '/api/public/venue-types',
147
+ headers: {
148
+ x_tenant_subdomain: xTenantSubdomain,
149
+ },
150
+ query: {
151
+ PageNumber: pageNumber,
152
+ Take: take,
153
+ Skip: skip,
154
+ LimitListRequests: limitListRequests,
155
+ TenantId: tenantId,
156
+ ModifiedById: modifiedById,
157
+ ModifiedByIds: modifiedByIds,
158
+ DateCreatedGTE: dateCreatedGte,
159
+ DateCreatedLTE: dateCreatedLte,
160
+ IsLive: isLive,
161
+ SortOrderDirection: sortOrderDirection,
162
+ },
163
+ errors: {
164
+ 400: `Bad Request`,
165
+ 422: `Unprocessable Content`,
166
+ 500: `Internal Server Error`,
167
+ },
168
+ });
169
+ }
170
+
171
+ /**
172
+ * Deletes the resource.
173
+ * @returns any OK
174
+ * @throws ApiError
175
+ */
176
+ public deleteByObject({
177
+ xTenantSubdomain,
178
+ requestBody,
179
+ }: {
180
+ /**
181
+ * The tenants subdomain.
182
+ */
183
+ xTenantSubdomain?: string;
184
+ /**
185
+ * The <typeparamref name="TObject" /> model.
186
+ */
187
+ requestBody?: VenueType;
188
+ }): CancelablePromise<any> {
189
+ return this.httpRequest.request({
190
+ method: 'DELETE',
191
+ url: '/api/public/venue-types',
192
+ headers: {
193
+ x_tenant_subdomain: xTenantSubdomain,
194
+ },
195
+ body: requestBody,
196
+ mediaType: 'application/json',
197
+ errors: {
198
+ 400: `Bad Request`,
199
+ 422: `Unprocessable Content`,
200
+ 500: `Internal Server Error`,
201
+ },
202
+ });
203
+ }
204
+
205
+ /**
206
+ * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
207
+ * @returns VenueType OK
208
+ * @throws ApiError
209
+ */
210
+ public post({
211
+ xTenantSubdomain,
212
+ requestBody,
213
+ }: {
214
+ /**
215
+ * The tenants subdomain.
216
+ */
217
+ xTenantSubdomain?: string;
218
+ /**
219
+ * The <typeparamref name="TObject" /> model.
220
+ */
221
+ requestBody?: VenueTypePost;
222
+ }): CancelablePromise<VenueType> {
223
+ return this.httpRequest.request({
224
+ method: 'POST',
225
+ url: '/api/public/venue-types/v2-temporary-route',
226
+ headers: {
227
+ x_tenant_subdomain: xTenantSubdomain,
228
+ },
229
+ body: requestBody,
230
+ mediaType: 'application/json',
231
+ errors: {
232
+ 400: `Bad Request`,
233
+ 422: `Unprocessable Content`,
234
+ 500: `Internal Server Error`,
235
+ },
236
+ });
237
+ }
238
+
239
+ /**
240
+ * Patches the resource.
241
+ * @returns VenueType OK
242
+ * @throws ApiError
243
+ */
244
+ public patch({
245
+ xTenantSubdomain,
246
+ requestBody,
247
+ }: {
248
+ /**
249
+ * The tenants subdomain.
250
+ */
251
+ xTenantSubdomain?: string;
252
+ /**
253
+ * The <typeparamref name="TObject" /> model.
254
+ */
255
+ requestBody?: VenueTypePatch;
256
+ }): CancelablePromise<VenueType> {
257
+ return this.httpRequest.request({
258
+ method: 'PATCH',
259
+ url: '/api/public/venue-types/v2-temporary-route',
260
+ headers: {
261
+ x_tenant_subdomain: xTenantSubdomain,
262
+ },
263
+ body: requestBody,
264
+ mediaType: 'application/json',
265
+ errors: {
266
+ 400: `Bad Request`,
267
+ 422: `Unprocessable Content`,
268
+ 500: `Internal Server Error`,
269
+ },
270
+ });
271
+ }
272
+
273
+ /**
274
+ * Inserts a list of resources.
275
+ * @returns VenueType OK
276
+ * @throws ApiError
277
+ */
278
+ public postList({
279
+ xTenantSubdomain,
280
+ requestBody,
281
+ }: {
282
+ /**
283
+ * The tenants subdomain.
284
+ */
285
+ xTenantSubdomain?: string;
286
+ /**
287
+ * The list of <typeparamref name="TObject" />.
288
+ */
289
+ requestBody?: Array<VenueTypePost>;
290
+ }): CancelablePromise<Array<VenueType>> {
291
+ return this.httpRequest.request({
292
+ method: 'POST',
293
+ url: '/api/public/venue-types/v2-temporary-route/list',
294
+ headers: {
295
+ x_tenant_subdomain: xTenantSubdomain,
296
+ },
297
+ body: requestBody,
298
+ mediaType: 'application/json',
299
+ errors: {
300
+ 400: `Bad Request`,
301
+ 422: `Unprocessable Content`,
302
+ 500: `Internal Server Error`,
303
+ },
304
+ });
305
+ }
306
+
307
+ /**
308
+ * Returns a value indicating whether the resource exists in the database given the provided search params.
309
+ * @returns boolean OK
310
+ * @throws ApiError
311
+ */
312
+ public exists({
313
+ xTenantSubdomain,
314
+ pageNumber,
315
+ take,
316
+ skip,
317
+ limitListRequests,
318
+ tenantId,
319
+ modifiedById,
320
+ modifiedByIds,
321
+ dateCreatedGte,
322
+ dateCreatedLte,
323
+ isLive,
324
+ sortOrderDirection,
325
+ }: {
326
+ /**
327
+ * The tenants subdomain.
328
+ */
329
+ xTenantSubdomain?: string;
330
+ /**
331
+ * Gets or sets the page number for paged queries.
332
+ */
333
+ pageNumber?: number;
334
+ /**
335
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
336
+ */
337
+ take?: number;
338
+ /**
339
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
340
+ */
341
+ skip?: number;
342
+ /**
343
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
344
+ */
345
+ limitListRequests?: boolean;
346
+ /**
347
+ * Gets or sets the Tenant Id.
348
+ */
349
+ tenantId?: string;
350
+ /**
351
+ * Gets or sets the Modifed By Id.
352
+ */
353
+ modifiedById?: string;
354
+ /**
355
+ * Gets or sets the Modifed By Ids.
356
+ */
357
+ modifiedByIds?: Array<string>;
358
+ /**
359
+ * Gets or sets the Date Created greater than equal to.
360
+ */
361
+ dateCreatedGte?: string;
362
+ /**
363
+ * Gets or sets the Date Created less than equal to.
364
+ */
365
+ dateCreatedLte?: string;
366
+ /**
367
+ * Gets or sets the queryable only is live status.
368
+ */
369
+ isLive?: boolean;
370
+ /**
371
+ * Gets or sets the sort order direction.
372
+ */
373
+ sortOrderDirection?: SearchSortOrderDirection;
374
+ }): CancelablePromise<boolean> {
375
+ return this.httpRequest.request({
376
+ method: 'GET',
377
+ url: '/api/public/venue-types/exists',
378
+ headers: {
379
+ x_tenant_subdomain: xTenantSubdomain,
380
+ },
381
+ query: {
382
+ PageNumber: pageNumber,
383
+ Take: take,
384
+ Skip: skip,
385
+ LimitListRequests: limitListRequests,
386
+ TenantId: tenantId,
387
+ ModifiedById: modifiedById,
388
+ ModifiedByIds: modifiedByIds,
389
+ DateCreatedGTE: dateCreatedGte,
390
+ DateCreatedLTE: dateCreatedLte,
391
+ IsLive: isLive,
392
+ SortOrderDirection: sortOrderDirection,
393
+ },
394
+ errors: {
395
+ 400: `Bad Request`,
396
+ 422: `Unprocessable Content`,
397
+ 500: `Internal Server Error`,
398
+ },
399
+ });
400
+ }
401
+ }
@@ -105,6 +105,7 @@ export class PublicVenuesService {
105
105
  distance,
106
106
  dashboardRequest,
107
107
  programmeIds,
108
+ venueTypeIds,
108
109
  pageNumber,
109
110
  take,
110
111
  skip,
@@ -202,6 +203,10 @@ export class PublicVenuesService {
202
203
  * Gets or sets the programme ids.
203
204
  */
204
205
  programmeIds?: Array<string>;
206
+ /**
207
+ * Gets or sets the venue type ids.
208
+ */
209
+ venueTypeIds?: Array<string>;
205
210
  /**
206
211
  * Gets or sets the page number for paged queries.
207
212
  */
@@ -275,6 +280,7 @@ export class PublicVenuesService {
275
280
  Distance: distance,
276
281
  DashboardRequest: dashboardRequest,
277
282
  ProgrammeIds: programmeIds,
283
+ VenueTypeIds: venueTypeIds,
278
284
  PageNumber: pageNumber,
279
285
  Take: take,
280
286
  Skip: skip,
@@ -356,6 +362,7 @@ export class PublicVenuesService {
356
362
  distance,
357
363
  dashboardRequest,
358
364
  programmeIds,
365
+ venueTypeIds,
359
366
  pageNumber,
360
367
  take,
361
368
  skip,
@@ -452,6 +459,10 @@ export class PublicVenuesService {
452
459
  * Gets or sets the programme ids.
453
460
  */
454
461
  programmeIds?: Array<string>;
462
+ /**
463
+ * Gets or sets the venue type ids.
464
+ */
465
+ venueTypeIds?: Array<string>;
455
466
  /**
456
467
  * Gets or sets the page number for paged queries.
457
468
  */
@@ -522,6 +533,7 @@ export class PublicVenuesService {
522
533
  Distance: distance,
523
534
  DashboardRequest: dashboardRequest,
524
535
  ProgrammeIds: programmeIds,
536
+ VenueTypeIds: venueTypeIds,
525
537
  PageNumber: pageNumber,
526
538
  Take: take,
527
539
  Skip: skip,
@@ -672,6 +684,7 @@ export class PublicVenuesService {
672
684
  distance,
673
685
  dashboardRequest,
674
686
  programmeIds,
687
+ venueTypeIds,
675
688
  pageNumber,
676
689
  take,
677
690
  skip,
@@ -772,6 +785,10 @@ export class PublicVenuesService {
772
785
  * Gets or sets the programme ids.
773
786
  */
774
787
  programmeIds?: Array<string>;
788
+ /**
789
+ * Gets or sets the venue type ids.
790
+ */
791
+ venueTypeIds?: Array<string>;
775
792
  /**
776
793
  * Gets or sets the page number for paged queries.
777
794
  */
@@ -845,6 +862,7 @@ export class PublicVenuesService {
845
862
  Distance: distance,
846
863
  DashboardRequest: dashboardRequest,
847
864
  ProgrammeIds: programmeIds,
865
+ VenueTypeIds: venueTypeIds,
848
866
  PageNumber: pageNumber,
849
867
  Take: take,
850
868
  Skip: skip,
@@ -5,6 +5,7 @@
5
5
  import type { BookingStatus } from '../models/BookingStatus';
6
6
  import type { ScheduledSession } from '../models/ScheduledSession';
7
7
  import type { ScheduledSessionEmailAttendeesPatch } from '../models/ScheduledSessionEmailAttendeesPatch';
8
+ import type { ScheduledSessionEmailWaitlistPatch } from '../models/ScheduledSessionEmailWaitlistPatch';
8
9
  import type { ScheduledSessionPage } from '../models/ScheduledSessionPage';
9
10
  import type { ScheduledSessionPatch } from '../models/ScheduledSessionPatch';
10
11
  import type { ScheduledSessionPost } from '../models/ScheduledSessionPost';
@@ -201,6 +202,40 @@ export class ScheduledSessionsService {
201
202
  });
202
203
  }
203
204
 
205
+ /**
206
+ * Emails all on waitlist onto the opportunity />.
207
+ * @returns ScheduledSession OK
208
+ * @throws ApiError
209
+ */
210
+ public contactWaitlist({
211
+ scheduledSessionId,
212
+ requestBody,
213
+ }: {
214
+ /**
215
+ * The scheduled session Id.
216
+ */
217
+ scheduledSessionId: string;
218
+ /**
219
+ * The patch model.
220
+ */
221
+ requestBody?: ScheduledSessionEmailWaitlistPatch;
222
+ }): CancelablePromise<ScheduledSession> {
223
+ return this.httpRequest.request({
224
+ method: 'PATCH',
225
+ url: '/api/scheduled-sessions/{scheduledSessionId}/email-waitlist',
226
+ path: {
227
+ scheduledSessionId: scheduledSessionId,
228
+ },
229
+ body: requestBody,
230
+ mediaType: 'application/json',
231
+ errors: {
232
+ 400: `Bad Request`,
233
+ 422: `Unprocessable Content`,
234
+ 500: `Internal Server Error`,
235
+ },
236
+ });
237
+ }
238
+
204
239
  /**
205
240
  * Cleans table of leased and conflicted scheduled sessions.
206
241
  * @returns number OK