reach-api-sdk 1.0.1 → 1.0.3

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 (52) hide show
  1. package/dist/reach-sdk.d.ts +434 -166
  2. package/dist/reach-sdk.js +342 -1
  3. package/package.json +1 -1
  4. package/src/{ApiClient.ts → apiClient.ts} +242 -239
  5. package/src/definition/swagger.yaml +58949 -58566
  6. package/src/index.ts +234 -230
  7. package/src/models/CoursePage.ts +11 -13
  8. package/src/models/CourseSessionPage.ts +11 -13
  9. package/src/models/CourseSessionSchedulePage.ts +11 -13
  10. package/src/models/CustomerPage.ts +11 -13
  11. package/src/models/EmailReminderSchedulePage.ts +11 -13
  12. package/src/models/EmailSettingPage.ts +11 -13
  13. package/src/models/FacilityIndividualPage.ts +11 -13
  14. package/src/models/FacilityPage.ts +11 -13
  15. package/src/models/GenericActivityPage.ts +11 -13
  16. package/src/models/ImagePage.ts +11 -13
  17. package/src/models/NotificationQueuePage.ts +11 -13
  18. package/src/models/NotificationSettingPage.ts +11 -13
  19. package/src/models/OfferPage.ts +11 -13
  20. package/src/models/OpenactiveFeedIntermediatePage.ts +11 -13
  21. package/src/models/OpenactiveFeedItemPage.ts +11 -13
  22. package/src/models/OrderItemPage.ts +11 -13
  23. package/src/models/OrderPage.ts +11 -13
  24. package/src/models/OrderTokenPage.ts +11 -13
  25. package/src/models/OrgCourseUtilisationPage.ts +11 -13
  26. package/src/models/PageMeta.ts +25 -0
  27. package/src/models/PaymentPage.ts +11 -13
  28. package/src/models/PermissionPage.ts +11 -13
  29. package/src/models/ProgrammePage.ts +11 -13
  30. package/src/models/RecentOrderActivityReportPage.ts +11 -13
  31. package/src/models/ScheduledSessionPage.ts +11 -13
  32. package/src/models/ScheduledSessionSchedulePage.ts +11 -13
  33. package/src/models/SessionPage.ts +11 -13
  34. package/src/models/SlotOfferPage.ts +11 -13
  35. package/src/models/SlotPage.ts +11 -13
  36. package/src/models/SlotScheduleOfferPage.ts +11 -13
  37. package/src/models/SlotSchedulePage.ts +11 -13
  38. package/src/models/StripeAccountPage.ts +11 -13
  39. package/src/models/SurveyAnswerPage.ts +11 -13
  40. package/src/models/SurveyPage.ts +11 -13
  41. package/src/models/SurveyQuestionPage.ts +11 -13
  42. package/src/models/SurveyReportExtended.ts +33 -0
  43. package/src/models/SurveyReportExtendedPage.ts +11 -0
  44. package/src/models/TenantPage.ts +11 -13
  45. package/src/models/TenantWebsiteSettingPage.ts +11 -13
  46. package/src/models/TotalRevenueReportPage.ts +11 -13
  47. package/src/models/UserPage.ts +11 -13
  48. package/src/models/VenuePage.ts +11 -13
  49. package/src/models/VenuesReportPage.ts +11 -13
  50. package/src/models/WaitlistActivityPage.ts +11 -13
  51. package/src/models/WaitlistOpportunityPage.ts +11 -13
  52. package/src/services/SurveyReportExtendedService.ts +618 -0
@@ -3253,11 +3253,30 @@ type Order = {
3253
3253
  cancellable?: CustomerCancellationOption;
3254
3254
  };
3255
3255
 
3256
- type OrderPage = {
3256
+ /**
3257
+ * Describes meta data for results returned as pages.
3258
+ */
3259
+ type PageMeta = {
3260
+ /**
3261
+ * Gets the page number.
3262
+ */
3257
3263
  readonly pageNumber?: number;
3264
+ /**
3265
+ * Gets the total number of pages.
3266
+ */
3258
3267
  readonly totalPages?: number;
3268
+ /**
3269
+ * Gets the total number of items in each page.
3270
+ */
3259
3271
  readonly itemsPerPage?: number;
3272
+ /**
3273
+ * Gets the total number of items.
3274
+ */
3260
3275
  readonly totalItems?: number;
3276
+ };
3277
+
3278
+ type OrderPage = {
3279
+ meta?: PageMeta;
3261
3280
  readonly items?: Array<Order> | null;
3262
3281
  };
3263
3282
 
@@ -3926,10 +3945,7 @@ declare class CountryService {
3926
3945
  }
3927
3946
 
3928
3947
  type CoursePage = {
3929
- readonly pageNumber?: number;
3930
- readonly totalPages?: number;
3931
- readonly itemsPerPage?: number;
3932
- readonly totalItems?: number;
3948
+ meta?: PageMeta;
3933
3949
  readonly items?: Array<Course> | null;
3934
3950
  };
3935
3951
 
@@ -4467,10 +4483,7 @@ declare class CoursesService {
4467
4483
  }
4468
4484
 
4469
4485
  type CourseSessionPage = {
4470
- readonly pageNumber?: number;
4471
- readonly totalPages?: number;
4472
- readonly itemsPerPage?: number;
4473
- readonly totalItems?: number;
4486
+ meta?: PageMeta;
4474
4487
  readonly items?: Array<CourseSession> | null;
4475
4488
  };
4476
4489
 
@@ -4870,10 +4883,7 @@ declare class CourseSessionsService {
4870
4883
  }
4871
4884
 
4872
4885
  type CourseSessionSchedulePage = {
4873
- readonly pageNumber?: number;
4874
- readonly totalPages?: number;
4875
- readonly itemsPerPage?: number;
4876
- readonly totalItems?: number;
4886
+ meta?: PageMeta;
4877
4887
  readonly items?: Array<CourseSessionSchedule> | null;
4878
4888
  };
4879
4889
 
@@ -5189,10 +5199,7 @@ declare class CourseSessionSchedulesService {
5189
5199
  }
5190
5200
 
5191
5201
  type CustomerPage = {
5192
- readonly pageNumber?: number;
5193
- readonly totalPages?: number;
5194
- readonly itemsPerPage?: number;
5195
- readonly totalItems?: number;
5202
+ meta?: PageMeta;
5196
5203
  readonly items?: Array<Customer> | null;
5197
5204
  };
5198
5205
 
@@ -5645,10 +5652,7 @@ type EmailReminderSchedule = {
5645
5652
  };
5646
5653
 
5647
5654
  type EmailReminderSchedulePage = {
5648
- readonly pageNumber?: number;
5649
- readonly totalPages?: number;
5650
- readonly itemsPerPage?: number;
5651
- readonly totalItems?: number;
5655
+ meta?: PageMeta;
5652
5656
  readonly items?: Array<EmailReminderSchedule> | null;
5653
5657
  };
5654
5658
 
@@ -5987,10 +5991,7 @@ type EmailSetting = {
5987
5991
  };
5988
5992
 
5989
5993
  type EmailSettingPage = {
5990
- readonly pageNumber?: number;
5991
- readonly totalPages?: number;
5992
- readonly itemsPerPage?: number;
5993
- readonly totalItems?: number;
5994
+ meta?: PageMeta;
5994
5995
  readonly items?: Array<EmailSetting> | null;
5995
5996
  };
5996
5997
 
@@ -6277,10 +6278,7 @@ declare class EmailSettingsService {
6277
6278
  }
6278
6279
 
6279
6280
  type FacilityPage = {
6280
- readonly pageNumber?: number;
6281
- readonly totalPages?: number;
6282
- readonly itemsPerPage?: number;
6283
- readonly totalItems?: number;
6281
+ meta?: PageMeta;
6284
6282
  readonly items?: Array<Facility> | null;
6285
6283
  };
6286
6284
 
@@ -6625,10 +6623,7 @@ declare class FacilitiesService {
6625
6623
  }
6626
6624
 
6627
6625
  type FacilityIndividualPage = {
6628
- readonly pageNumber?: number;
6629
- readonly totalPages?: number;
6630
- readonly itemsPerPage?: number;
6631
- readonly totalItems?: number;
6626
+ meta?: PageMeta;
6632
6627
  readonly items?: Array<FacilityIndividual> | null;
6633
6628
  };
6634
6629
 
@@ -7009,10 +7004,7 @@ type GenericActivity = {
7009
7004
  };
7010
7005
 
7011
7006
  type GenericActivityPage = {
7012
- readonly pageNumber?: number;
7013
- readonly totalPages?: number;
7014
- readonly itemsPerPage?: number;
7015
- readonly totalItems?: number;
7007
+ meta?: PageMeta;
7016
7008
  readonly items?: Array<GenericActivity> | null;
7017
7009
  };
7018
7010
 
@@ -7442,10 +7434,7 @@ declare class GeocodeService {
7442
7434
  }
7443
7435
 
7444
7436
  type ImagePage = {
7445
- readonly pageNumber?: number;
7446
- readonly totalPages?: number;
7447
- readonly itemsPerPage?: number;
7448
- readonly totalItems?: number;
7437
+ meta?: PageMeta;
7449
7438
  readonly items?: Array<Image> | null;
7450
7439
  };
7451
7440
 
@@ -8400,10 +8389,7 @@ type NotificationQueue = {
8400
8389
  };
8401
8390
 
8402
8391
  type NotificationQueuePage = {
8403
- readonly pageNumber?: number;
8404
- readonly totalPages?: number;
8405
- readonly itemsPerPage?: number;
8406
- readonly totalItems?: number;
8392
+ meta?: PageMeta;
8407
8393
  readonly items?: Array<NotificationQueue> | null;
8408
8394
  };
8409
8395
 
@@ -8758,10 +8744,7 @@ type NotificationSetting = {
8758
8744
  };
8759
8745
 
8760
8746
  type NotificationSettingPage = {
8761
- readonly pageNumber?: number;
8762
- readonly totalPages?: number;
8763
- readonly itemsPerPage?: number;
8764
- readonly totalItems?: number;
8747
+ meta?: PageMeta;
8765
8748
  readonly items?: Array<NotificationSetting> | null;
8766
8749
  };
8767
8750
 
@@ -9168,10 +9151,7 @@ declare class NotificationSettingsService {
9168
9151
  }
9169
9152
 
9170
9153
  type OfferPage = {
9171
- readonly pageNumber?: number;
9172
- readonly totalPages?: number;
9173
- readonly itemsPerPage?: number;
9174
- readonly totalItems?: number;
9154
+ meta?: PageMeta;
9175
9155
  readonly items?: Array<Offer> | null;
9176
9156
  };
9177
9157
 
@@ -9597,10 +9577,7 @@ type OpenactiveFeedIntermediate = {
9597
9577
  };
9598
9578
 
9599
9579
  type OpenactiveFeedIntermediatePage = {
9600
- readonly pageNumber?: number;
9601
- readonly totalPages?: number;
9602
- readonly itemsPerPage?: number;
9603
- readonly totalItems?: number;
9580
+ meta?: PageMeta;
9604
9581
  readonly items?: Array<OpenactiveFeedIntermediate> | null;
9605
9582
  };
9606
9583
 
@@ -9908,10 +9885,7 @@ type OpenactiveFeedItem = {
9908
9885
  };
9909
9886
 
9910
9887
  type OpenactiveFeedItemPage = {
9911
- readonly pageNumber?: number;
9912
- readonly totalPages?: number;
9913
- readonly itemsPerPage?: number;
9914
- readonly totalItems?: number;
9888
+ meta?: PageMeta;
9915
9889
  readonly items?: Array<OpenactiveFeedItem> | null;
9916
9890
  };
9917
9891
 
@@ -10174,10 +10148,7 @@ declare class OpenactiveFeedItemService {
10174
10148
  }
10175
10149
 
10176
10150
  type OrderItemPage = {
10177
- readonly pageNumber?: number;
10178
- readonly totalPages?: number;
10179
- readonly itemsPerPage?: number;
10180
- readonly totalItems?: number;
10151
+ meta?: PageMeta;
10181
10152
  readonly items?: Array<OrderItem> | null;
10182
10153
  };
10183
10154
 
@@ -10965,10 +10936,7 @@ type OrgCourseUtilisation = {
10965
10936
  };
10966
10937
 
10967
10938
  type OrgCourseUtilisationPage = {
10968
- readonly pageNumber?: number;
10969
- readonly totalPages?: number;
10970
- readonly itemsPerPage?: number;
10971
- readonly totalItems?: number;
10939
+ meta?: PageMeta;
10972
10940
  readonly items?: Array<OrgCourseUtilisation> | null;
10973
10941
  };
10974
10942
 
@@ -11405,10 +11373,7 @@ declare class OrgCourseUtilisationService {
11405
11373
  }
11406
11374
 
11407
11375
  type PaymentPage = {
11408
- readonly pageNumber?: number;
11409
- readonly totalPages?: number;
11410
- readonly itemsPerPage?: number;
11411
- readonly totalItems?: number;
11376
+ meta?: PageMeta;
11412
11377
  readonly items?: Array<Payment> | null;
11413
11378
  };
11414
11379
 
@@ -11733,10 +11698,7 @@ type Permission = {
11733
11698
  };
11734
11699
 
11735
11700
  type PermissionPage = {
11736
- readonly pageNumber?: number;
11737
- readonly totalPages?: number;
11738
- readonly itemsPerPage?: number;
11739
- readonly totalItems?: number;
11701
+ meta?: PageMeta;
11740
11702
  readonly items?: Array<Permission> | null;
11741
11703
  };
11742
11704
 
@@ -12064,10 +12026,7 @@ declare class PlacesService {
12064
12026
  }
12065
12027
 
12066
12028
  type ProgrammePage = {
12067
- readonly pageNumber?: number;
12068
- readonly totalPages?: number;
12069
- readonly itemsPerPage?: number;
12070
- readonly totalItems?: number;
12029
+ meta?: PageMeta;
12071
12030
  readonly items?: Array<Programme> | null;
12072
12031
  };
12073
12032
 
@@ -13888,10 +13847,7 @@ type OrderToken = {
13888
13847
  };
13889
13848
 
13890
13849
  type OrderTokenPage = {
13891
- readonly pageNumber?: number;
13892
- readonly totalPages?: number;
13893
- readonly itemsPerPage?: number;
13894
- readonly totalItems?: number;
13850
+ meta?: PageMeta;
13895
13851
  readonly items?: Array<OrderToken> | null;
13896
13852
  };
13897
13853
 
@@ -14343,10 +14299,7 @@ declare class PublicProgrammesService {
14343
14299
  }
14344
14300
 
14345
14301
  type ScheduledSessionPage = {
14346
- readonly pageNumber?: number;
14347
- readonly totalPages?: number;
14348
- readonly itemsPerPage?: number;
14349
- readonly totalItems?: number;
14302
+ meta?: PageMeta;
14350
14303
  readonly items?: Array<ScheduledSession> | null;
14351
14304
  };
14352
14305
 
@@ -14704,10 +14657,7 @@ declare class PublicScheduledSessionsService {
14704
14657
  }
14705
14658
 
14706
14659
  type SessionPage = {
14707
- readonly pageNumber?: number;
14708
- readonly totalPages?: number;
14709
- readonly itemsPerPage?: number;
14710
- readonly totalItems?: number;
14660
+ meta?: PageMeta;
14711
14661
  readonly items?: Array<Session> | null;
14712
14662
  };
14713
14663
 
@@ -15101,10 +15051,7 @@ declare class PublicSessionsService {
15101
15051
  }
15102
15052
 
15103
15053
  type SlotPage = {
15104
- readonly pageNumber?: number;
15105
- readonly totalPages?: number;
15106
- readonly itemsPerPage?: number;
15107
- readonly totalItems?: number;
15054
+ meta?: PageMeta;
15108
15055
  readonly items?: Array<Slot> | null;
15109
15056
  };
15110
15057
 
@@ -15705,10 +15652,7 @@ type SurveyQuestion = {
15705
15652
  };
15706
15653
 
15707
15654
  type SurveyQuestionPage = {
15708
- readonly pageNumber?: number;
15709
- readonly totalPages?: number;
15710
- readonly itemsPerPage?: number;
15711
- readonly totalItems?: number;
15655
+ meta?: PageMeta;
15712
15656
  readonly items?: Array<SurveyQuestion> | null;
15713
15657
  };
15714
15658
 
@@ -16009,10 +15953,7 @@ type Survey = {
16009
15953
  };
16010
15954
 
16011
15955
  type SurveyPage = {
16012
- readonly pageNumber?: number;
16013
- readonly totalPages?: number;
16014
- readonly itemsPerPage?: number;
16015
- readonly totalItems?: number;
15956
+ meta?: PageMeta;
16016
15957
  readonly items?: Array<Survey> | null;
16017
15958
  };
16018
15959
 
@@ -16203,10 +16144,7 @@ declare class PublicSurveysService {
16203
16144
  }
16204
16145
 
16205
16146
  type TenantPage = {
16206
- readonly pageNumber?: number;
16207
- readonly totalPages?: number;
16208
- readonly itemsPerPage?: number;
16209
- readonly totalItems?: number;
16147
+ meta?: PageMeta;
16210
16148
  readonly items?: Array<Tenant> | null;
16211
16149
  };
16212
16150
 
@@ -16427,10 +16365,7 @@ declare class PublicTenantsService {
16427
16365
  }
16428
16366
 
16429
16367
  type VenuePage = {
16430
- readonly pageNumber?: number;
16431
- readonly totalPages?: number;
16432
- readonly itemsPerPage?: number;
16433
- readonly totalItems?: number;
16368
+ meta?: PageMeta;
16434
16369
  readonly items?: Array<Venue> | null;
16435
16370
  };
16436
16371
 
@@ -16717,10 +16652,7 @@ declare class PublicVenuesService {
16717
16652
  }
16718
16653
 
16719
16654
  type WaitlistActivityPage = {
16720
- readonly pageNumber?: number;
16721
- readonly totalPages?: number;
16722
- readonly itemsPerPage?: number;
16723
- readonly totalItems?: number;
16655
+ meta?: PageMeta;
16724
16656
  readonly items?: Array<WaitlistActivity> | null;
16725
16657
  };
16726
16658
 
@@ -16955,10 +16887,7 @@ declare class PublicWaitlistActivityService {
16955
16887
  }
16956
16888
 
16957
16889
  type WaitlistOpportunityPage = {
16958
- readonly pageNumber?: number;
16959
- readonly totalPages?: number;
16960
- readonly itemsPerPage?: number;
16961
- readonly totalItems?: number;
16890
+ meta?: PageMeta;
16962
16891
  readonly items?: Array<WaitlistOpportunity> | null;
16963
16892
  };
16964
16893
 
@@ -17263,10 +17192,7 @@ type RecentOrderActivityReport = {
17263
17192
  };
17264
17193
 
17265
17194
  type RecentOrderActivityReportPage = {
17266
- readonly pageNumber?: number;
17267
- readonly totalPages?: number;
17268
- readonly itemsPerPage?: number;
17269
- readonly totalItems?: number;
17195
+ meta?: PageMeta;
17270
17196
  readonly items?: Array<RecentOrderActivityReport> | null;
17271
17197
  };
17272
17198
 
@@ -18067,10 +17993,7 @@ declare class ScheduledSessionsService {
18067
17993
  }
18068
17994
 
18069
17995
  type ScheduledSessionSchedulePage = {
18070
- readonly pageNumber?: number;
18071
- readonly totalPages?: number;
18072
- readonly itemsPerPage?: number;
18073
- readonly totalItems?: number;
17996
+ meta?: PageMeta;
18074
17997
  readonly items?: Array<ScheduledSessionSchedule> | null;
18075
17998
  };
18076
17999
 
@@ -18794,10 +18717,7 @@ type SlotOffer = {
18794
18717
  };
18795
18718
 
18796
18719
  type SlotOfferPage = {
18797
- readonly pageNumber?: number;
18798
- readonly totalPages?: number;
18799
- readonly itemsPerPage?: number;
18800
- readonly totalItems?: number;
18720
+ meta?: PageMeta;
18801
18721
  readonly items?: Array<SlotOffer> | null;
18802
18722
  };
18803
18723
 
@@ -19578,10 +19498,7 @@ type SlotScheduleOffer = {
19578
19498
  };
19579
19499
 
19580
19500
  type SlotScheduleOfferPage = {
19581
- readonly pageNumber?: number;
19582
- readonly totalPages?: number;
19583
- readonly itemsPerPage?: number;
19584
- readonly totalItems?: number;
19501
+ meta?: PageMeta;
19585
19502
  readonly items?: Array<SlotScheduleOffer> | null;
19586
19503
  };
19587
19504
 
@@ -19844,10 +19761,7 @@ declare class SlotScheduleOffersService {
19844
19761
  }
19845
19762
 
19846
19763
  type SlotSchedulePage = {
19847
- readonly pageNumber?: number;
19848
- readonly totalPages?: number;
19849
- readonly itemsPerPage?: number;
19850
- readonly totalItems?: number;
19764
+ meta?: PageMeta;
19851
19765
  readonly items?: Array<SlotSchedule> | null;
19852
19766
  };
19853
19767
 
@@ -20193,10 +20107,7 @@ declare class SlotSchedulesService {
20193
20107
  }
20194
20108
 
20195
20109
  type StripeAccountPage = {
20196
- readonly pageNumber?: number;
20197
- readonly totalPages?: number;
20198
- readonly itemsPerPage?: number;
20199
- readonly totalItems?: number;
20110
+ meta?: PageMeta;
20200
20111
  readonly items?: Array<StripeAccount> | null;
20201
20112
  };
20202
20113
 
@@ -20599,10 +20510,7 @@ type SurveyAnswer = {
20599
20510
  };
20600
20511
 
20601
20512
  type SurveyAnswerPage = {
20602
- readonly pageNumber?: number;
20603
- readonly totalPages?: number;
20604
- readonly itemsPerPage?: number;
20605
- readonly totalItems?: number;
20513
+ meta?: PageMeta;
20606
20514
  readonly items?: Array<SurveyAnswer> | null;
20607
20515
  };
20608
20516
 
@@ -21254,6 +21162,377 @@ declare class SurveyQuestionsService {
21254
21162
  }): CancelablePromise<boolean>;
21255
21163
  }
21256
21164
 
21165
+ /**
21166
+ * Represents the venue report model.
21167
+ */
21168
+ type SurveyReportExtended = {
21169
+ /**
21170
+ * Gets or sets the entities Id.
21171
+ */
21172
+ id?: string;
21173
+ /**
21174
+ * Gets or sets the tenant Id.
21175
+ */
21176
+ tenantId?: string;
21177
+ /**
21178
+ * Gets or sets the created date of this entity.
21179
+ */
21180
+ dateCreated?: string;
21181
+ /**
21182
+ * Gets or sets the last modified date of this entity.
21183
+ */
21184
+ dateModified?: string;
21185
+ /**
21186
+ * Gets or sets the modified by Id.
21187
+ */
21188
+ modifiedById?: string | null;
21189
+ /**
21190
+ * Gets or sets a value indicating whether the record is live and available for use within the application.
21191
+ */
21192
+ isLive?: boolean;
21193
+ };
21194
+
21195
+ type SurveyReportExtendedPage = {
21196
+ meta?: PageMeta;
21197
+ readonly items?: Array<SurveyReportExtended> | null;
21198
+ };
21199
+
21200
+ declare class SurveyReportExtendedService {
21201
+ readonly httpRequest: BaseHttpRequest;
21202
+ constructor(httpRequest: BaseHttpRequest);
21203
+ /**
21204
+ * Exports the venues list to a csv format.
21205
+ * Endpoint has AllowAnonymous attr, however the jwt is validated in the method body (in support of authenticated file downloads.
21206
+ * @returns any Success
21207
+ * @throws ApiError
21208
+ */
21209
+ exportToCsv({ surveyId, slotId, opportunityType, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
21210
+ /**
21211
+ * Gets or sets the Survey Id.
21212
+ */
21213
+ surveyId?: string;
21214
+ /**
21215
+ * Gets or sets the Slot Id/Scheduled Session Id/Course Id.
21216
+ */
21217
+ slotId?: string;
21218
+ /**
21219
+ * Gets or sets the Opportunity Type.
21220
+ */
21221
+ opportunityType?: string;
21222
+ /**
21223
+ * Gets or sets the page number for paged queries.
21224
+ */
21225
+ pageNumber?: number;
21226
+ /**
21227
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
21228
+ */
21229
+ take?: number;
21230
+ /**
21231
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
21232
+ */
21233
+ limitListRequests?: boolean;
21234
+ /**
21235
+ * Gets or sets the Tenant Id.
21236
+ */
21237
+ tenantId?: string;
21238
+ /**
21239
+ * Gets or sets the Modifed By Id.
21240
+ */
21241
+ modifiedById?: string;
21242
+ /**
21243
+ * Gets or sets the Modifed By Ids.
21244
+ */
21245
+ modifiedByIds?: Array<string>;
21246
+ /**
21247
+ * Gets or sets the Date Created greater than equal to.
21248
+ */
21249
+ dateCreatedGte?: string;
21250
+ /**
21251
+ * Gets or sets the Date Created less than equal to.
21252
+ */
21253
+ dateCreatedLte?: string;
21254
+ /**
21255
+ * Gets or sets the queryable only is live status.
21256
+ */
21257
+ isLive?: boolean;
21258
+ /**
21259
+ * Gets or sets the sort order direction.
21260
+ */
21261
+ sortOrderDirection?: SearchSortOrderDirection;
21262
+ formData?: {
21263
+ /**
21264
+ * Gets or sets the auth token.
21265
+ */
21266
+ Token?: string;
21267
+ };
21268
+ }): CancelablePromise<any>;
21269
+ /**
21270
+ * Gets the resource by its Id.
21271
+ * @returns SurveyReportExtended Success
21272
+ * @throws ApiError
21273
+ */
21274
+ getObject({ id, }: {
21275
+ /**
21276
+ * The <typeparamref name="TObject" /> id.
21277
+ */
21278
+ id: string;
21279
+ }): CancelablePromise<SurveyReportExtended>;
21280
+ /**
21281
+ * Deletes the resource.
21282
+ * @returns any Success
21283
+ * @throws ApiError
21284
+ */
21285
+ deleteById({ id, }: {
21286
+ /**
21287
+ * The <typeparamref name="TObject" /> id.
21288
+ */
21289
+ id: string;
21290
+ }): CancelablePromise<any>;
21291
+ /**
21292
+ * Returns a value indicating whether the resource exists in the database given the provided search params.
21293
+ * @returns boolean Success
21294
+ * @throws ApiError
21295
+ */
21296
+ exists({ surveyId, slotId, opportunityType, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
21297
+ /**
21298
+ * Gets or sets the Survey Id.
21299
+ */
21300
+ surveyId?: string;
21301
+ /**
21302
+ * Gets or sets the Slot Id/Scheduled Session Id/Course Id.
21303
+ */
21304
+ slotId?: string;
21305
+ /**
21306
+ * Gets or sets the Opportunity Type.
21307
+ */
21308
+ opportunityType?: string;
21309
+ /**
21310
+ * Gets or sets the page number for paged queries.
21311
+ */
21312
+ pageNumber?: number;
21313
+ /**
21314
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
21315
+ */
21316
+ take?: number;
21317
+ /**
21318
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
21319
+ */
21320
+ limitListRequests?: boolean;
21321
+ /**
21322
+ * Gets or sets the Tenant Id.
21323
+ */
21324
+ tenantId?: string;
21325
+ /**
21326
+ * Gets or sets the Modifed By Id.
21327
+ */
21328
+ modifiedById?: string;
21329
+ /**
21330
+ * Gets or sets the Modifed By Ids.
21331
+ */
21332
+ modifiedByIds?: Array<string>;
21333
+ /**
21334
+ * Gets or sets the Date Created greater than equal to.
21335
+ */
21336
+ dateCreatedGte?: string;
21337
+ /**
21338
+ * Gets or sets the Date Created less than equal to.
21339
+ */
21340
+ dateCreatedLte?: string;
21341
+ /**
21342
+ * Gets or sets the queryable only is live status.
21343
+ */
21344
+ isLive?: boolean;
21345
+ /**
21346
+ * Gets or sets the sort order direction.
21347
+ */
21348
+ sortOrderDirection?: SearchSortOrderDirection;
21349
+ }): CancelablePromise<boolean>;
21350
+ /**
21351
+ * Gets a list of resources.
21352
+ * @returns SurveyReportExtendedPage Success
21353
+ * @throws ApiError
21354
+ */
21355
+ getPage({ surveyId, slotId, opportunityType, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
21356
+ /**
21357
+ * Gets or sets the Survey Id.
21358
+ */
21359
+ surveyId?: string;
21360
+ /**
21361
+ * Gets or sets the Slot Id/Scheduled Session Id/Course Id.
21362
+ */
21363
+ slotId?: string;
21364
+ /**
21365
+ * Gets or sets the Opportunity Type.
21366
+ */
21367
+ opportunityType?: string;
21368
+ /**
21369
+ * Gets or sets the page number for paged queries.
21370
+ */
21371
+ pageNumber?: number;
21372
+ /**
21373
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
21374
+ */
21375
+ take?: number;
21376
+ /**
21377
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
21378
+ */
21379
+ limitListRequests?: boolean;
21380
+ /**
21381
+ * Gets or sets the Tenant Id.
21382
+ */
21383
+ tenantId?: string;
21384
+ /**
21385
+ * Gets or sets the Modifed By Id.
21386
+ */
21387
+ modifiedById?: string;
21388
+ /**
21389
+ * Gets or sets the Modifed By Ids.
21390
+ */
21391
+ modifiedByIds?: Array<string>;
21392
+ /**
21393
+ * Gets or sets the Date Created greater than equal to.
21394
+ */
21395
+ dateCreatedGte?: string;
21396
+ /**
21397
+ * Gets or sets the Date Created less than equal to.
21398
+ */
21399
+ dateCreatedLte?: string;
21400
+ /**
21401
+ * Gets or sets the queryable only is live status.
21402
+ */
21403
+ isLive?: boolean;
21404
+ /**
21405
+ * Gets or sets the sort order direction.
21406
+ */
21407
+ sortOrderDirection?: SearchSortOrderDirection;
21408
+ }): CancelablePromise<SurveyReportExtendedPage>;
21409
+ /**
21410
+ * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
21411
+ * @returns SurveyReportExtended Success
21412
+ * @throws ApiError
21413
+ */
21414
+ post({ requestBody, }: {
21415
+ /**
21416
+ * The <typeparamref name="TObject" /> model.
21417
+ */
21418
+ requestBody?: SurveyReportExtended;
21419
+ }): CancelablePromise<SurveyReportExtended>;
21420
+ /**
21421
+ * Patches the resource.
21422
+ * @returns SurveyReportExtended Success
21423
+ * @throws ApiError
21424
+ */
21425
+ patch({ requestBody, }: {
21426
+ /**
21427
+ * The <typeparamref name="TObject" /> model.
21428
+ */
21429
+ requestBody?: SurveyReportExtended;
21430
+ }): CancelablePromise<SurveyReportExtended>;
21431
+ /**
21432
+ * Deletes the resource.
21433
+ * @returns any Success
21434
+ * @throws ApiError
21435
+ */
21436
+ deleteByObject({ requestBody, }: {
21437
+ /**
21438
+ * The <typeparamref name="TObject" /> model.
21439
+ */
21440
+ requestBody?: SurveyReportExtended;
21441
+ }): CancelablePromise<any>;
21442
+ /**
21443
+ * Gets a list of resources.
21444
+ * @returns SurveyReportExtended Success
21445
+ * @throws ApiError
21446
+ */
21447
+ getListIdName({ surveyId, slotId, opportunityType, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
21448
+ /**
21449
+ * Gets or sets the Survey Id.
21450
+ */
21451
+ surveyId?: string;
21452
+ /**
21453
+ * Gets or sets the Slot Id/Scheduled Session Id/Course Id.
21454
+ */
21455
+ slotId?: string;
21456
+ /**
21457
+ * Gets or sets the Opportunity Type.
21458
+ */
21459
+ opportunityType?: string;
21460
+ /**
21461
+ * Gets or sets the page number for paged queries.
21462
+ */
21463
+ pageNumber?: number;
21464
+ /**
21465
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
21466
+ */
21467
+ take?: number;
21468
+ /**
21469
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
21470
+ */
21471
+ limitListRequests?: boolean;
21472
+ /**
21473
+ * Gets or sets the Tenant Id.
21474
+ */
21475
+ tenantId?: string;
21476
+ /**
21477
+ * Gets or sets the Modifed By Id.
21478
+ */
21479
+ modifiedById?: string;
21480
+ /**
21481
+ * Gets or sets the Modifed By Ids.
21482
+ */
21483
+ modifiedByIds?: Array<string>;
21484
+ /**
21485
+ * Gets or sets the Date Created greater than equal to.
21486
+ */
21487
+ dateCreatedGte?: string;
21488
+ /**
21489
+ * Gets or sets the Date Created less than equal to.
21490
+ */
21491
+ dateCreatedLte?: string;
21492
+ /**
21493
+ * Gets or sets the queryable only is live status.
21494
+ */
21495
+ isLive?: boolean;
21496
+ /**
21497
+ * Gets or sets the sort order direction.
21498
+ */
21499
+ sortOrderDirection?: SearchSortOrderDirection;
21500
+ }): CancelablePromise<Array<SurveyReportExtended>>;
21501
+ /**
21502
+ * Inserts a list of resources.
21503
+ * @returns SurveyReportExtended Success
21504
+ * @throws ApiError
21505
+ */
21506
+ postList({ requestBody, }: {
21507
+ /**
21508
+ * The list of <typeparamref name="TObject" />.
21509
+ */
21510
+ requestBody?: Array<SurveyReportExtended>;
21511
+ }): CancelablePromise<Array<SurveyReportExtended>>;
21512
+ /**
21513
+ * Patches the resource.
21514
+ * @returns SurveyReportExtended Success
21515
+ * @throws ApiError
21516
+ */
21517
+ patchWithReferences({ requestBody, }: {
21518
+ /**
21519
+ * The <typeparamref name="TObject" /> model.
21520
+ */
21521
+ requestBody?: SurveyReportExtended;
21522
+ }): CancelablePromise<SurveyReportExtended>;
21523
+ /**
21524
+ * Returns a value indicating whether the resource is deletable.
21525
+ * @returns boolean Success
21526
+ * @throws ApiError
21527
+ */
21528
+ canDelete({ id, }: {
21529
+ /**
21530
+ * The <typeparamref name="TObject" /> id.
21531
+ */
21532
+ id: string;
21533
+ }): CancelablePromise<boolean>;
21534
+ }
21535
+
21257
21536
  declare class SurveysService {
21258
21537
  readonly httpRequest: BaseHttpRequest;
21259
21538
  constructor(httpRequest: BaseHttpRequest);
@@ -21886,10 +22165,7 @@ declare class TenantsService {
21886
22165
  }
21887
22166
 
21888
22167
  type TenantWebsiteSettingPage = {
21889
- readonly pageNumber?: number;
21890
- readonly totalPages?: number;
21891
- readonly itemsPerPage?: number;
21892
- readonly totalItems?: number;
22168
+ meta?: PageMeta;
21893
22169
  readonly items?: Array<TenantWebsiteSetting> | null;
21894
22170
  };
21895
22171
 
@@ -22276,10 +22552,7 @@ type TotalRevenueReport = {
22276
22552
  };
22277
22553
 
22278
22554
  type TotalRevenueReportPage = {
22279
- readonly pageNumber?: number;
22280
- readonly totalPages?: number;
22281
- readonly itemsPerPage?: number;
22282
- readonly totalItems?: number;
22555
+ meta?: PageMeta;
22283
22556
  readonly items?: Array<TotalRevenueReport> | null;
22284
22557
  };
22285
22558
 
@@ -22566,10 +22839,7 @@ declare class TotalRevenueReportService {
22566
22839
  }
22567
22840
 
22568
22841
  type UserPage = {
22569
- readonly pageNumber?: number;
22570
- readonly totalPages?: number;
22571
- readonly itemsPerPage?: number;
22572
- readonly totalItems?: number;
22842
+ meta?: PageMeta;
22573
22843
  readonly items?: Array<User> | null;
22574
22844
  };
22575
22845
 
@@ -23334,10 +23604,7 @@ type VenuesReport = {
23334
23604
  };
23335
23605
 
23336
23606
  type VenuesReportPage = {
23337
- readonly pageNumber?: number;
23338
- readonly totalPages?: number;
23339
- readonly itemsPerPage?: number;
23340
- readonly totalItems?: number;
23607
+ meta?: PageMeta;
23341
23608
  readonly items?: Array<VenuesReport> | null;
23342
23609
  };
23343
23610
 
@@ -24340,6 +24607,7 @@ declare class ApiClient {
24340
24607
  readonly surfaces: SurfacesService;
24341
24608
  readonly surveyAnswers: SurveyAnswersService;
24342
24609
  readonly surveyQuestions: SurveyQuestionsService;
24610
+ readonly surveyReportExtended: SurveyReportExtendedService;
24343
24611
  readonly surveys: SurveysService;
24344
24612
  readonly tenants: TenantsService;
24345
24613
  readonly tenantWebsiteSettings: TenantWebsiteSettingsService;
@@ -24447,4 +24715,4 @@ type ReachError = {
24447
24715
  readonly clientError?: any;
24448
24716
  };
24449
24717
 
24450
- export { Activity, ActivityService, ActivityType, AdvanceBooking, Amenity, AmenityService, ApiClient, ApiError, AppUserRole, ApplicationRole, AutoCompleteResponseModel, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CoursePage, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulesService, CourseSessionsService, CoursesService, Customer, CustomerCancellationOption, CustomerPage, CustomerType, CustomersService, DayOfWeek, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingsService, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, GenericActivity, GenericActivityPage, GenericActivityService, GeocodeResponseModel, GeocodeService, GooglePrediction, HttpStatusCode, IOpportunity, Image, ImagePage, ImagesService, InviteStatus, LeasingService, LoqateGeocode, LoqatePlaceResult, LoqatePlacesService, LoqatePrediction, Northeast, NotificationQueue, NotificationQueuePage, NotificationQueueService, NotificationSetting, NotificationSettingPage, NotificationSettingsService, NotificationType, Offer, OfferPage, OffersService, OpenAPI, OpenAPIConfig, OpenactiveFeedIntermediate, OpenactiveFeedIntermediatePage, OpenactiveFeedIntermediateService, OpenactiveFeedItem, OpenactiveFeedItemPage, OpenactiveFeedItemService, OpportunityType, Order, OrderItem, OrderItemPage, OrderItemStatus, OrderItemsService, OrderPage, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Payment, PaymentMethod, PaymentPage, PaymentsService, Permission, PermissionPage, PermissionsService, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammesService, PublicBookingService, PublicCoursesService, PublicFacilitiesService, PublicHealthCheckService, PublicLeasingService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicScheduledSessionsService, PublicSessionsService, PublicSlotsService, PublicStripeWebhookService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantsService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportService, ScheduleStatus, ScheduledSession, ScheduledSessionPage, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, Session, SessionGender, SessionPage, SessionType, SessionsService, Slot, SlotAvailabilityStatus, SlotOffer, SlotOfferPage, SlotOffersService, SlotPage, SlotSchedule, SlotScheduleOffer, SlotScheduleOfferPage, SlotScheduleOffersService, SlotSchedulePage, SlotSchedulesService, SlotStatus, SlotsService, Southwest, StripeAccount, StripeAccountPage, StripeAccountService, StructuredFormatting, Surface, SurfacesService, Survey, SurveyAnswer, SurveyAnswerPage, SurveyAnswersService, SurveyPage, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveySubmissionModel, SurveyType, SurveysService, Tax, Tenant, TenantPage, TenantWebsiteSetting, TenantWebsiteSettingPage, TenantWebsiteSettingsService, TenantsService, Timezone, TimezoneService, TotalRevenueReport, TotalRevenueReportPage, TotalRevenueReportService, User, UserPage, UserRole, UsersService, Venue, VenueOpeningHours, VenuePage, VenuesReport, VenuesReportPage, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityService };
24718
+ export { Activity, ActivityService, ActivityType, AdvanceBooking, Amenity, AmenityService, ApiClient, ApiError, AppUserRole, ApplicationRole, AutoCompleteResponseModel, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CoursePage, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulesService, CourseSessionsService, CoursesService, Customer, CustomerCancellationOption, CustomerPage, CustomerType, CustomersService, DayOfWeek, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingsService, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, GenericActivity, GenericActivityPage, GenericActivityService, GeocodeResponseModel, GeocodeService, GooglePrediction, HttpStatusCode, IOpportunity, Image, ImagePage, ImagesService, InviteStatus, LeasingService, LoqateGeocode, LoqatePlaceResult, LoqatePlacesService, LoqatePrediction, Northeast, NotificationQueue, NotificationQueuePage, NotificationQueueService, NotificationSetting, NotificationSettingPage, NotificationSettingsService, NotificationType, Offer, OfferPage, OffersService, OpenAPI, OpenAPIConfig, OpenactiveFeedIntermediate, OpenactiveFeedIntermediatePage, OpenactiveFeedIntermediateService, OpenactiveFeedItem, OpenactiveFeedItemPage, OpenactiveFeedItemService, OpportunityType, Order, OrderItem, OrderItemPage, OrderItemStatus, OrderItemsService, OrderPage, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, PageMeta, Payment, PaymentMethod, PaymentPage, PaymentsService, Permission, PermissionPage, PermissionsService, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammesService, PublicBookingService, PublicCoursesService, PublicFacilitiesService, PublicHealthCheckService, PublicLeasingService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicScheduledSessionsService, PublicSessionsService, PublicSlotsService, PublicStripeWebhookService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantsService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportService, ScheduleStatus, ScheduledSession, ScheduledSessionPage, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, Session, SessionGender, SessionPage, SessionType, SessionsService, Slot, SlotAvailabilityStatus, SlotOffer, SlotOfferPage, SlotOffersService, SlotPage, SlotSchedule, SlotScheduleOffer, SlotScheduleOfferPage, SlotScheduleOffersService, SlotSchedulePage, SlotSchedulesService, SlotStatus, SlotsService, Southwest, StripeAccount, StripeAccountPage, StripeAccountService, StructuredFormatting, Surface, SurfacesService, Survey, SurveyAnswer, SurveyAnswerPage, SurveyAnswersService, SurveyPage, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedService, SurveySubmissionModel, SurveyType, SurveysService, Tax, Tenant, TenantPage, TenantWebsiteSetting, TenantWebsiteSettingPage, TenantWebsiteSettingsService, TenantsService, Timezone, TimezoneService, TotalRevenueReport, TotalRevenueReportPage, TotalRevenueReportService, User, UserPage, UserRole, UsersService, Venue, VenueOpeningHours, VenuePage, VenuesReport, VenuesReportPage, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityService };