reach-api-sdk 1.0.192 → 1.0.194

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.
@@ -8234,7 +8234,7 @@ paths:
8234
8234
  patch:
8235
8235
  tags:
8236
8236
  - Courses
8237
- summary: Asign deal to course />.
8237
+ summary: Assign deal to course />.
8238
8238
  operationId: AssignDeal
8239
8239
  parameters:
8240
8240
  - name: courseId
@@ -8304,7 +8304,7 @@ paths:
8304
8304
  patch:
8305
8305
  tags:
8306
8306
  - Courses
8307
- summary: Unasign deal from course />.
8307
+ summary: Unassign deal from course />.
8308
8308
  operationId: UnassignDeal
8309
8309
  parameters:
8310
8310
  - name: courseId
@@ -8370,6 +8370,132 @@ paths:
8370
8370
  text/json:
8371
8371
  schema:
8372
8372
  $ref: '#/components/schemas/ValidationResultModel'
8373
+ '/api/courses/{id}/set-featured':
8374
+ patch:
8375
+ tags:
8376
+ - Courses
8377
+ summary: Set the course as featured (displays more prominently on the storefront).
8378
+ operationId: SetFeatured
8379
+ parameters:
8380
+ - name: id
8381
+ in: path
8382
+ description: The course Id.
8383
+ required: true
8384
+ schema:
8385
+ type: string
8386
+ format: uuid
8387
+ responses:
8388
+ '200':
8389
+ description: OK
8390
+ content:
8391
+ text/plain:
8392
+ schema:
8393
+ $ref: '#/components/schemas/Course'
8394
+ application/json:
8395
+ schema:
8396
+ $ref: '#/components/schemas/Course'
8397
+ text/json:
8398
+ schema:
8399
+ $ref: '#/components/schemas/Course'
8400
+ '400':
8401
+ description: Bad Request
8402
+ content:
8403
+ text/plain:
8404
+ schema:
8405
+ $ref: '#/components/schemas/ReachError'
8406
+ application/json:
8407
+ schema:
8408
+ $ref: '#/components/schemas/ReachError'
8409
+ text/json:
8410
+ schema:
8411
+ $ref: '#/components/schemas/ReachError'
8412
+ '500':
8413
+ description: Internal Server Error
8414
+ content:
8415
+ text/plain:
8416
+ schema:
8417
+ $ref: '#/components/schemas/ReachError'
8418
+ application/json:
8419
+ schema:
8420
+ $ref: '#/components/schemas/ReachError'
8421
+ text/json:
8422
+ schema:
8423
+ $ref: '#/components/schemas/ReachError'
8424
+ '422':
8425
+ description: Unprocessable Content
8426
+ content:
8427
+ text/plain:
8428
+ schema:
8429
+ $ref: '#/components/schemas/ValidationResultModel'
8430
+ application/json:
8431
+ schema:
8432
+ $ref: '#/components/schemas/ValidationResultModel'
8433
+ text/json:
8434
+ schema:
8435
+ $ref: '#/components/schemas/ValidationResultModel'
8436
+ '/api/courses/{id}/remove-featured':
8437
+ patch:
8438
+ tags:
8439
+ - Courses
8440
+ summary: Remove the course as featured (displays as standard on the storefront).
8441
+ operationId: RemoveFeatured
8442
+ parameters:
8443
+ - name: id
8444
+ in: path
8445
+ description: The course Id.
8446
+ required: true
8447
+ schema:
8448
+ type: string
8449
+ format: uuid
8450
+ responses:
8451
+ '200':
8452
+ description: OK
8453
+ content:
8454
+ text/plain:
8455
+ schema:
8456
+ $ref: '#/components/schemas/Course'
8457
+ application/json:
8458
+ schema:
8459
+ $ref: '#/components/schemas/Course'
8460
+ text/json:
8461
+ schema:
8462
+ $ref: '#/components/schemas/Course'
8463
+ '400':
8464
+ description: Bad Request
8465
+ content:
8466
+ text/plain:
8467
+ schema:
8468
+ $ref: '#/components/schemas/ReachError'
8469
+ application/json:
8470
+ schema:
8471
+ $ref: '#/components/schemas/ReachError'
8472
+ text/json:
8473
+ schema:
8474
+ $ref: '#/components/schemas/ReachError'
8475
+ '500':
8476
+ description: Internal Server Error
8477
+ content:
8478
+ text/plain:
8479
+ schema:
8480
+ $ref: '#/components/schemas/ReachError'
8481
+ application/json:
8482
+ schema:
8483
+ $ref: '#/components/schemas/ReachError'
8484
+ text/json:
8485
+ schema:
8486
+ $ref: '#/components/schemas/ReachError'
8487
+ '422':
8488
+ description: Unprocessable Content
8489
+ content:
8490
+ text/plain:
8491
+ schema:
8492
+ $ref: '#/components/schemas/ValidationResultModel'
8493
+ application/json:
8494
+ schema:
8495
+ $ref: '#/components/schemas/ValidationResultModel'
8496
+ text/json:
8497
+ schema:
8498
+ $ref: '#/components/schemas/ValidationResultModel'
8373
8499
  /api/courses/v2-temporary-route:
8374
8500
  post:
8375
8501
  tags:
@@ -8776,6 +8902,11 @@ paths:
8776
8902
  description: Gets or sets a value indicating this an openactive reaquest.
8777
8903
  schema:
8778
8904
  type: boolean
8905
+ - name: DashboardRequest
8906
+ in: query
8907
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
8908
+ schema:
8909
+ type: boolean
8779
8910
  - name: BookingStatus
8780
8911
  in: query
8781
8912
  description: Gets or sets the queryable booking status.
@@ -9245,6 +9376,11 @@ paths:
9245
9376
  description: Gets or sets a value indicating this an openactive reaquest.
9246
9377
  schema:
9247
9378
  type: boolean
9379
+ - name: DashboardRequest
9380
+ in: query
9381
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
9382
+ schema:
9383
+ type: boolean
9248
9384
  - name: BookingStatus
9249
9385
  in: query
9250
9386
  description: Gets or sets the queryable booking status.
@@ -9536,6 +9672,11 @@ paths:
9536
9672
  description: Gets or sets a value indicating this an openactive reaquest.
9537
9673
  schema:
9538
9674
  type: boolean
9675
+ - name: DashboardRequest
9676
+ in: query
9677
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
9678
+ schema:
9679
+ type: boolean
9539
9680
  - name: BookingStatus
9540
9681
  in: query
9541
9682
  description: Gets or sets the queryable booking status.
@@ -9833,6 +9974,11 @@ paths:
9833
9974
  description: Gets or sets a value indicating this an openactive reaquest.
9834
9975
  schema:
9835
9976
  type: boolean
9977
+ - name: DashboardRequest
9978
+ in: query
9979
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
9980
+ schema:
9981
+ type: boolean
9836
9982
  - name: BookingStatus
9837
9983
  in: query
9838
9984
  description: Gets or sets the queryable booking status.
@@ -10683,6 +10829,11 @@ paths:
10683
10829
  description: Gets or sets a value indicating whether to include venue detail in the results.
10684
10830
  schema:
10685
10831
  type: boolean
10832
+ - name: IncludeOffers
10833
+ in: query
10834
+ description: Gets or sets a value indicating whether to include offer detail in the results.
10835
+ schema:
10836
+ type: boolean
10686
10837
  - name: ExcludeArchived
10687
10838
  in: query
10688
10839
  description: Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
@@ -11073,6 +11224,11 @@ paths:
11073
11224
  description: Gets or sets a value indicating whether to include venue detail in the results.
11074
11225
  schema:
11075
11226
  type: boolean
11227
+ - name: IncludeOffers
11228
+ in: query
11229
+ description: Gets or sets a value indicating whether to include offer detail in the results.
11230
+ schema:
11231
+ type: boolean
11076
11232
  - name: ExcludeArchived
11077
11233
  in: query
11078
11234
  description: Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
@@ -11285,6 +11441,11 @@ paths:
11285
11441
  description: Gets or sets a value indicating whether to include venue detail in the results.
11286
11442
  schema:
11287
11443
  type: boolean
11444
+ - name: IncludeOffers
11445
+ in: query
11446
+ description: Gets or sets a value indicating whether to include offer detail in the results.
11447
+ schema:
11448
+ type: boolean
11288
11449
  - name: ExcludeArchived
11289
11450
  in: query
11290
11451
  description: Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
@@ -11503,6 +11664,11 @@ paths:
11503
11664
  description: Gets or sets a value indicating whether to include venue detail in the results.
11504
11665
  schema:
11505
11666
  type: boolean
11667
+ - name: IncludeOffers
11668
+ in: query
11669
+ description: Gets or sets a value indicating whether to include offer detail in the results.
11670
+ schema:
11671
+ type: boolean
11506
11672
  - name: ExcludeArchived
11507
11673
  in: query
11508
11674
  description: Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
@@ -23680,6 +23846,11 @@ paths:
23680
23846
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
23681
23847
  schema:
23682
23848
  type: boolean
23849
+ - name: Featured
23850
+ in: query
23851
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
23852
+ schema:
23853
+ type: boolean
23683
23854
  - name: SearchGeoCenter
23684
23855
  in: query
23685
23856
  description: Gets or sets SearchGeoCenter.
@@ -23806,6 +23977,14 @@ paths:
23806
23977
  items:
23807
23978
  type: integer
23808
23979
  format: int32
23980
+ - name: ProgrammeIds
23981
+ in: query
23982
+ description: Gets or sets the Programme ids.
23983
+ schema:
23984
+ type: array
23985
+ items:
23986
+ type: string
23987
+ format: uuid
23809
23988
  - name: PageNumber
23810
23989
  in: query
23811
23990
  description: Gets or sets the page number for paged queries.
@@ -24044,6 +24223,11 @@ paths:
24044
24223
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
24045
24224
  schema:
24046
24225
  type: boolean
24226
+ - name: Featured
24227
+ in: query
24228
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
24229
+ schema:
24230
+ type: boolean
24047
24231
  - name: SearchGeoCenter
24048
24232
  in: query
24049
24233
  description: Gets or sets SearchGeoCenter.
@@ -24170,6 +24354,14 @@ paths:
24170
24354
  items:
24171
24355
  type: integer
24172
24356
  format: int32
24357
+ - name: ProgrammeIds
24358
+ in: query
24359
+ description: Gets or sets the Programme ids.
24360
+ schema:
24361
+ type: array
24362
+ items:
24363
+ type: string
24364
+ format: uuid
24173
24365
  - name: PageNumber
24174
24366
  in: query
24175
24367
  description: Gets or sets the page number for paged queries.
@@ -24339,6 +24531,11 @@ paths:
24339
24531
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
24340
24532
  schema:
24341
24533
  type: boolean
24534
+ - name: Featured
24535
+ in: query
24536
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
24537
+ schema:
24538
+ type: boolean
24342
24539
  - name: SearchGeoCenter
24343
24540
  in: query
24344
24541
  description: Gets or sets SearchGeoCenter.
@@ -24465,6 +24662,14 @@ paths:
24465
24662
  items:
24466
24663
  type: integer
24467
24664
  format: int32
24665
+ - name: ProgrammeIds
24666
+ in: query
24667
+ description: Gets or sets the Programme ids.
24668
+ schema:
24669
+ type: array
24670
+ items:
24671
+ type: string
24672
+ format: uuid
24468
24673
  - name: PageNumber
24469
24674
  in: query
24470
24675
  description: Gets or sets the page number for paged queries.
@@ -24634,6 +24839,11 @@ paths:
24634
24839
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
24635
24840
  schema:
24636
24841
  type: boolean
24842
+ - name: Featured
24843
+ in: query
24844
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
24845
+ schema:
24846
+ type: boolean
24637
24847
  - name: SearchGeoCenter
24638
24848
  in: query
24639
24849
  description: Gets or sets SearchGeoCenter.
@@ -24760,6 +24970,14 @@ paths:
24760
24970
  items:
24761
24971
  type: integer
24762
24972
  format: int32
24973
+ - name: ProgrammeIds
24974
+ in: query
24975
+ description: Gets or sets the Programme ids.
24976
+ schema:
24977
+ type: array
24978
+ items:
24979
+ type: string
24980
+ format: uuid
24763
24981
  - name: PageNumber
24764
24982
  in: query
24765
24983
  description: Gets or sets the page number for paged queries.
@@ -24935,6 +25153,11 @@ paths:
24935
25153
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
24936
25154
  schema:
24937
25155
  type: boolean
25156
+ - name: Featured
25157
+ in: query
25158
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
25159
+ schema:
25160
+ type: boolean
24938
25161
  - name: SearchGeoCenter
24939
25162
  in: query
24940
25163
  description: Gets or sets SearchGeoCenter.
@@ -25061,6 +25284,14 @@ paths:
25061
25284
  items:
25062
25285
  type: integer
25063
25286
  format: int32
25287
+ - name: ProgrammeIds
25288
+ in: query
25289
+ description: Gets or sets the Programme ids.
25290
+ schema:
25291
+ type: array
25292
+ items:
25293
+ type: string
25294
+ format: uuid
25064
25295
  - name: PageNumber
25065
25296
  in: query
25066
25297
  description: Gets or sets the page number for paged queries.
@@ -40518,6 +40749,11 @@ paths:
40518
40749
  schema:
40519
40750
  type: string
40520
40751
  format: uuid
40752
+ - name: DashboardRequest
40753
+ in: query
40754
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
40755
+ schema:
40756
+ type: boolean
40521
40757
  - name: PageNumber
40522
40758
  in: query
40523
40759
  description: Gets or sets the page number for paged queries.
@@ -40883,6 +41119,11 @@ paths:
40883
41119
  schema:
40884
41120
  type: string
40885
41121
  format: uuid
41122
+ - name: DashboardRequest
41123
+ in: query
41124
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
41125
+ schema:
41126
+ type: boolean
40886
41127
  - name: PageNumber
40887
41128
  in: query
40888
41129
  description: Gets or sets the page number for paged queries.
@@ -41070,6 +41311,11 @@ paths:
41070
41311
  schema:
41071
41312
  type: string
41072
41313
  format: uuid
41314
+ - name: DashboardRequest
41315
+ in: query
41316
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
41317
+ schema:
41318
+ type: boolean
41073
41319
  - name: PageNumber
41074
41320
  in: query
41075
41321
  description: Gets or sets the page number for paged queries.
@@ -41263,6 +41509,11 @@ paths:
41263
41509
  schema:
41264
41510
  type: string
41265
41511
  format: uuid
41512
+ - name: DashboardRequest
41513
+ in: query
41514
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
41515
+ schema:
41516
+ type: boolean
41266
41517
  - name: PageNumber
41267
41518
  in: query
41268
41519
  description: Gets or sets the page number for paged queries.
@@ -53687,7 +53938,7 @@ paths:
53687
53938
  summary: Gets calendar data.
53688
53939
  operationId: GetCalendarView
53689
53940
  parameters:
53690
- - name: x-tenant-subdomain
53941
+ - name: x_tenant_subdomain
53691
53942
  in: header
53692
53943
  description: The tenants subdomain.
53693
53944
  schema:
@@ -53944,6 +54195,11 @@ paths:
53944
54195
  description: Gets or sets a value indicating this an openactive reaquest.
53945
54196
  schema:
53946
54197
  type: boolean
54198
+ - name: DashboardRequest
54199
+ in: query
54200
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
54201
+ schema:
54202
+ type: boolean
53947
54203
  - name: BookingStatus
53948
54204
  in: query
53949
54205
  description: Gets or sets the queryable booking status.
@@ -54532,6 +54788,11 @@ paths:
54532
54788
  description: Gets or sets a value indicating this an openactive reaquest.
54533
54789
  schema:
54534
54790
  type: boolean
54791
+ - name: DashboardRequest
54792
+ in: query
54793
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
54794
+ schema:
54795
+ type: boolean
54535
54796
  - name: BookingStatus
54536
54797
  in: query
54537
54798
  description: Gets or sets the queryable booking status.
@@ -56478,6 +56739,11 @@ paths:
56478
56739
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
56479
56740
  schema:
56480
56741
  type: boolean
56742
+ - name: Featured
56743
+ in: query
56744
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
56745
+ schema:
56746
+ type: boolean
56481
56747
  - name: SearchGeoCenter
56482
56748
  in: query
56483
56749
  description: Gets or sets SearchGeoCenter.
@@ -56604,6 +56870,14 @@ paths:
56604
56870
  items:
56605
56871
  type: integer
56606
56872
  format: int32
56873
+ - name: ProgrammeIds
56874
+ in: query
56875
+ description: Gets or sets the Programme ids.
56876
+ schema:
56877
+ type: array
56878
+ items:
56879
+ type: string
56880
+ format: uuid
56607
56881
  - name: PageNumber
56608
56882
  in: query
56609
56883
  description: Gets or sets the page number for paged queries.
@@ -56773,6 +57047,11 @@ paths:
56773
57047
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
56774
57048
  schema:
56775
57049
  type: boolean
57050
+ - name: Featured
57051
+ in: query
57052
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
57053
+ schema:
57054
+ type: boolean
56776
57055
  - name: SearchGeoCenter
56777
57056
  in: query
56778
57057
  description: Gets or sets SearchGeoCenter.
@@ -56899,6 +57178,14 @@ paths:
56899
57178
  items:
56900
57179
  type: integer
56901
57180
  format: int32
57181
+ - name: ProgrammeIds
57182
+ in: query
57183
+ description: Gets or sets the Programme ids.
57184
+ schema:
57185
+ type: array
57186
+ items:
57187
+ type: string
57188
+ format: uuid
56902
57189
  - name: PageNumber
56903
57190
  in: query
56904
57191
  description: Gets or sets the page number for paged queries.
@@ -57073,6 +57360,11 @@ paths:
57073
57360
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
57074
57361
  schema:
57075
57362
  type: boolean
57363
+ - name: Featured
57364
+ in: query
57365
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
57366
+ schema:
57367
+ type: boolean
57076
57368
  - name: SearchGeoCenter
57077
57369
  in: query
57078
57370
  description: Gets or sets SearchGeoCenter.
@@ -57199,6 +57491,14 @@ paths:
57199
57491
  items:
57200
57492
  type: integer
57201
57493
  format: int32
57494
+ - name: ProgrammeIds
57495
+ in: query
57496
+ description: Gets or sets the Programme ids.
57497
+ schema:
57498
+ type: array
57499
+ items:
57500
+ type: string
57501
+ format: uuid
57202
57502
  - name: PageNumber
57203
57503
  in: query
57204
57504
  description: Gets or sets the page number for paged queries.
@@ -57465,6 +57765,11 @@ paths:
57465
57765
  description: Gets or sets a value indicating whether to inlcude the activities next availability.
57466
57766
  schema:
57467
57767
  type: boolean
57768
+ - name: Featured
57769
+ in: query
57770
+ description: Gets or sets a value indicating whether to filter on whether the activity is featured.
57771
+ schema:
57772
+ type: boolean
57468
57773
  - name: SearchGeoCenter
57469
57774
  in: query
57470
57775
  description: Gets or sets SearchGeoCenter.
@@ -57591,6 +57896,14 @@ paths:
57591
57896
  items:
57592
57897
  type: integer
57593
57898
  format: int32
57899
+ - name: ProgrammeIds
57900
+ in: query
57901
+ description: Gets or sets the Programme ids.
57902
+ schema:
57903
+ type: array
57904
+ items:
57905
+ type: string
57906
+ format: uuid
57594
57907
  - name: PageNumber
57595
57908
  in: query
57596
57909
  description: Gets or sets the page number for paged queries.
@@ -58920,6 +59233,11 @@ paths:
58920
59233
  description: Gets or sets a value indicating this an openactive reaquest.
58921
59234
  schema:
58922
59235
  type: boolean
59236
+ - name: DashboardRequest
59237
+ in: query
59238
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
59239
+ schema:
59240
+ type: boolean
58923
59241
  - name: NetworkId
58924
59242
  in: query
58925
59243
  description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -60126,6 +60444,11 @@ paths:
60126
60444
  schema:
60127
60445
  type: string
60128
60446
  format: uuid
60447
+ - name: DashboardRequest
60448
+ in: query
60449
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
60450
+ schema:
60451
+ type: boolean
60129
60452
  - name: PageNumber
60130
60453
  in: query
60131
60454
  description: Gets or sets the page number for paged queries.
@@ -60809,6 +61132,11 @@ paths:
60809
61132
  schema:
60810
61133
  type: string
60811
61134
  format: uuid
61135
+ - name: DashboardRequest
61136
+ in: query
61137
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
61138
+ schema:
61139
+ type: boolean
60812
61140
  - name: PageNumber
60813
61141
  in: query
60814
61142
  description: Gets or sets the page number for paged queries.
@@ -64945,6 +65273,11 @@ paths:
64945
65273
  description: Gets or sets a value indicating whether to include venue detail in the results.
64946
65274
  schema:
64947
65275
  type: boolean
65276
+ - name: IncludeOffers
65277
+ in: query
65278
+ description: Gets or sets a value indicating whether to include offer detail in the results.
65279
+ schema:
65280
+ type: boolean
64948
65281
  - name: IncludeOrders
64949
65282
  in: query
64950
65283
  description: Gets or sets a value indicating whether to include order detail in the results.
@@ -65511,6 +65844,11 @@ paths:
65511
65844
  description: Gets or sets a value indicating whether to include venue detail in the results.
65512
65845
  schema:
65513
65846
  type: boolean
65847
+ - name: IncludeOffers
65848
+ in: query
65849
+ description: Gets or sets a value indicating whether to include offer detail in the results.
65850
+ schema:
65851
+ type: boolean
65514
65852
  - name: IncludeOrders
65515
65853
  in: query
65516
65854
  description: Gets or sets a value indicating whether to include order detail in the results.
@@ -65869,6 +66207,11 @@ paths:
65869
66207
  description: Gets or sets a value indicating this an openactive reaquest.
65870
66208
  schema:
65871
66209
  type: boolean
66210
+ - name: DashboardRequest
66211
+ in: query
66212
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
66213
+ schema:
66214
+ type: boolean
65872
66215
  - name: NetworkId
65873
66216
  in: query
65874
66217
  description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -66339,6 +66682,11 @@ paths:
66339
66682
  description: Gets or sets a value indicating whether to include venue detail in the results.
66340
66683
  schema:
66341
66684
  type: boolean
66685
+ - name: IncludeOffers
66686
+ in: query
66687
+ description: Gets or sets a value indicating whether to include offer detail in the results.
66688
+ schema:
66689
+ type: boolean
66342
66690
  - name: IncludeOrders
66343
66691
  in: query
66344
66692
  description: Gets or sets a value indicating whether to include order detail in the results.
@@ -66798,6 +67146,11 @@ paths:
66798
67146
  description: Gets or sets a value indicating this an openactive reaquest.
66799
67147
  schema:
66800
67148
  type: boolean
67149
+ - name: DashboardRequest
67150
+ in: query
67151
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
67152
+ schema:
67153
+ type: boolean
66801
67154
  - name: NetworkId
66802
67155
  in: query
66803
67156
  description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -71562,6 +71915,19 @@ paths:
71562
71915
  schema:
71563
71916
  type: number
71564
71917
  format: float
71918
+ - name: DashboardRequest
71919
+ in: query
71920
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
71921
+ schema:
71922
+ type: boolean
71923
+ - name: ProgrammeIds
71924
+ in: query
71925
+ description: Gets or sets the programme ids.
71926
+ schema:
71927
+ type: array
71928
+ items:
71929
+ type: string
71930
+ format: uuid
71565
71931
  - name: PageNumber
71566
71932
  in: query
71567
71933
  description: Gets or sets the page number for paged queries.
@@ -71843,6 +72209,19 @@ paths:
71843
72209
  schema:
71844
72210
  type: number
71845
72211
  format: float
72212
+ - name: DashboardRequest
72213
+ in: query
72214
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
72215
+ schema:
72216
+ type: boolean
72217
+ - name: ProgrammeIds
72218
+ in: query
72219
+ description: Gets or sets the programme ids.
72220
+ schema:
72221
+ type: array
72222
+ items:
72223
+ type: string
72224
+ format: uuid
71846
72225
  - name: PageNumber
71847
72226
  in: query
71848
72227
  description: Gets or sets the page number for paged queries.
@@ -72297,6 +72676,19 @@ paths:
72297
72676
  schema:
72298
72677
  type: number
72299
72678
  format: float
72679
+ - name: DashboardRequest
72680
+ in: query
72681
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
72682
+ schema:
72683
+ type: boolean
72684
+ - name: ProgrammeIds
72685
+ in: query
72686
+ description: Gets or sets the programme ids.
72687
+ schema:
72688
+ type: array
72689
+ items:
72690
+ type: string
72691
+ format: uuid
72300
72692
  - name: PageNumber
72301
72693
  in: query
72302
72694
  description: Gets or sets the page number for paged queries.
@@ -78464,6 +78856,11 @@ paths:
78464
78856
  description: Gets or sets a value indicating whether to include venue detail in the results.
78465
78857
  schema:
78466
78858
  type: boolean
78859
+ - name: IncludeOffers
78860
+ in: query
78861
+ description: Gets or sets a value indicating whether to include offer detail in the results.
78862
+ schema:
78863
+ type: boolean
78467
78864
  - name: IncludeOrders
78468
78865
  in: query
78469
78866
  description: Gets or sets a value indicating whether to include order detail in the results.
@@ -78911,6 +79308,11 @@ paths:
78911
79308
  description: Gets or sets a value indicating whether to include venue detail in the results.
78912
79309
  schema:
78913
79310
  type: boolean
79311
+ - name: IncludeOffers
79312
+ in: query
79313
+ description: Gets or sets a value indicating whether to include offer detail in the results.
79314
+ schema:
79315
+ type: boolean
78914
79316
  - name: IncludeOrders
78915
79317
  in: query
78916
79318
  description: Gets or sets a value indicating whether to include order detail in the results.
@@ -79180,6 +79582,11 @@ paths:
79180
79582
  description: Gets or sets a value indicating whether to include venue detail in the results.
79181
79583
  schema:
79182
79584
  type: boolean
79585
+ - name: IncludeOffers
79586
+ in: query
79587
+ description: Gets or sets a value indicating whether to include offer detail in the results.
79588
+ schema:
79589
+ type: boolean
79183
79590
  - name: IncludeOrders
79184
79591
  in: query
79185
79592
  description: Gets or sets a value indicating whether to include order detail in the results.
@@ -79455,6 +79862,11 @@ paths:
79455
79862
  description: Gets or sets a value indicating whether to include venue detail in the results.
79456
79863
  schema:
79457
79864
  type: boolean
79865
+ - name: IncludeOffers
79866
+ in: query
79867
+ description: Gets or sets a value indicating whether to include offer detail in the results.
79868
+ schema:
79869
+ type: boolean
79458
79870
  - name: IncludeOrders
79459
79871
  in: query
79460
79872
  description: Gets or sets a value indicating whether to include order detail in the results.
@@ -81394,12 +81806,12 @@ paths:
81394
81806
  patch:
81395
81807
  tags:
81396
81808
  - Sessions
81397
- summary: Asign deal to session />.
81809
+ summary: Assign deal to session.
81398
81810
  operationId: AssignDeal
81399
81811
  parameters:
81400
81812
  - name: sessionId
81401
81813
  in: path
81402
- description: The course Id.
81814
+ description: The session Id.
81403
81815
  required: true
81404
81816
  schema:
81405
81817
  type: string
@@ -81464,12 +81876,12 @@ paths:
81464
81876
  patch:
81465
81877
  tags:
81466
81878
  - Sessions
81467
- summary: Unasign deal from session />.
81879
+ summary: Unassign deal from session.
81468
81880
  operationId: UnassignDeal
81469
81881
  parameters:
81470
81882
  - name: sessionId
81471
81883
  in: path
81472
- description: The course Id.
81884
+ description: The session Id.
81473
81885
  required: true
81474
81886
  schema:
81475
81887
  type: string
@@ -81530,6 +81942,132 @@ paths:
81530
81942
  text/json:
81531
81943
  schema:
81532
81944
  $ref: '#/components/schemas/ValidationResultModel'
81945
+ '/api/sessions/{id}/set-featured':
81946
+ patch:
81947
+ tags:
81948
+ - Sessions
81949
+ summary: Set the session as featured (displays more prominently on the storefront).
81950
+ operationId: SetFeatured
81951
+ parameters:
81952
+ - name: id
81953
+ in: path
81954
+ description: The session Id.
81955
+ required: true
81956
+ schema:
81957
+ type: string
81958
+ format: uuid
81959
+ responses:
81960
+ '200':
81961
+ description: OK
81962
+ content:
81963
+ text/plain:
81964
+ schema:
81965
+ $ref: '#/components/schemas/Session'
81966
+ application/json:
81967
+ schema:
81968
+ $ref: '#/components/schemas/Session'
81969
+ text/json:
81970
+ schema:
81971
+ $ref: '#/components/schemas/Session'
81972
+ '400':
81973
+ description: Bad Request
81974
+ content:
81975
+ text/plain:
81976
+ schema:
81977
+ $ref: '#/components/schemas/ReachError'
81978
+ application/json:
81979
+ schema:
81980
+ $ref: '#/components/schemas/ReachError'
81981
+ text/json:
81982
+ schema:
81983
+ $ref: '#/components/schemas/ReachError'
81984
+ '500':
81985
+ description: Internal Server Error
81986
+ content:
81987
+ text/plain:
81988
+ schema:
81989
+ $ref: '#/components/schemas/ReachError'
81990
+ application/json:
81991
+ schema:
81992
+ $ref: '#/components/schemas/ReachError'
81993
+ text/json:
81994
+ schema:
81995
+ $ref: '#/components/schemas/ReachError'
81996
+ '422':
81997
+ description: Unprocessable Content
81998
+ content:
81999
+ text/plain:
82000
+ schema:
82001
+ $ref: '#/components/schemas/ValidationResultModel'
82002
+ application/json:
82003
+ schema:
82004
+ $ref: '#/components/schemas/ValidationResultModel'
82005
+ text/json:
82006
+ schema:
82007
+ $ref: '#/components/schemas/ValidationResultModel'
82008
+ '/api/sessions/{id}/remove-featured':
82009
+ patch:
82010
+ tags:
82011
+ - Sessions
82012
+ summary: Remove the session as featured (displays as standard on the storefront).
82013
+ operationId: RemoveFeatured
82014
+ parameters:
82015
+ - name: id
82016
+ in: path
82017
+ description: The session Id.
82018
+ required: true
82019
+ schema:
82020
+ type: string
82021
+ format: uuid
82022
+ responses:
82023
+ '200':
82024
+ description: OK
82025
+ content:
82026
+ text/plain:
82027
+ schema:
82028
+ $ref: '#/components/schemas/Session'
82029
+ application/json:
82030
+ schema:
82031
+ $ref: '#/components/schemas/Session'
82032
+ text/json:
82033
+ schema:
82034
+ $ref: '#/components/schemas/Session'
82035
+ '400':
82036
+ description: Bad Request
82037
+ content:
82038
+ text/plain:
82039
+ schema:
82040
+ $ref: '#/components/schemas/ReachError'
82041
+ application/json:
82042
+ schema:
82043
+ $ref: '#/components/schemas/ReachError'
82044
+ text/json:
82045
+ schema:
82046
+ $ref: '#/components/schemas/ReachError'
82047
+ '500':
82048
+ description: Internal Server Error
82049
+ content:
82050
+ text/plain:
82051
+ schema:
82052
+ $ref: '#/components/schemas/ReachError'
82053
+ application/json:
82054
+ schema:
82055
+ $ref: '#/components/schemas/ReachError'
82056
+ text/json:
82057
+ schema:
82058
+ $ref: '#/components/schemas/ReachError'
82059
+ '422':
82060
+ description: Unprocessable Content
82061
+ content:
82062
+ text/plain:
82063
+ schema:
82064
+ $ref: '#/components/schemas/ValidationResultModel'
82065
+ application/json:
82066
+ schema:
82067
+ $ref: '#/components/schemas/ValidationResultModel'
82068
+ text/json:
82069
+ schema:
82070
+ $ref: '#/components/schemas/ValidationResultModel'
81533
82071
  /api/sessions/v2-temporary-route:
81534
82072
  post:
81535
82073
  tags:
@@ -81950,6 +82488,11 @@ paths:
81950
82488
  description: Gets or sets a value indicating this an openactive reaquest.
81951
82489
  schema:
81952
82490
  type: boolean
82491
+ - name: DashboardRequest
82492
+ in: query
82493
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
82494
+ schema:
82495
+ type: boolean
81953
82496
  - name: NetworkId
81954
82497
  in: query
81955
82498
  description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -82421,6 +82964,11 @@ paths:
82421
82964
  description: Gets or sets a value indicating this an openactive reaquest.
82422
82965
  schema:
82423
82966
  type: boolean
82967
+ - name: DashboardRequest
82968
+ in: query
82969
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
82970
+ schema:
82971
+ type: boolean
82424
82972
  - name: NetworkId
82425
82973
  in: query
82426
82974
  description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -82714,6 +83262,11 @@ paths:
82714
83262
  description: Gets or sets a value indicating this an openactive reaquest.
82715
83263
  schema:
82716
83264
  type: boolean
83265
+ - name: DashboardRequest
83266
+ in: query
83267
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
83268
+ schema:
83269
+ type: boolean
82717
83270
  - name: NetworkId
82718
83271
  in: query
82719
83272
  description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -83013,6 +83566,11 @@ paths:
83013
83566
  description: Gets or sets a value indicating this an openactive reaquest.
83014
83567
  schema:
83015
83568
  type: boolean
83569
+ - name: DashboardRequest
83570
+ in: query
83571
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
83572
+ schema:
83573
+ type: boolean
83016
83574
  - name: NetworkId
83017
83575
  in: query
83018
83576
  description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -113750,6 +114308,19 @@ paths:
113750
114308
  schema:
113751
114309
  type: number
113752
114310
  format: float
114311
+ - name: DashboardRequest
114312
+ in: query
114313
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
114314
+ schema:
114315
+ type: boolean
114316
+ - name: ProgrammeIds
114317
+ in: query
114318
+ description: Gets or sets the programme ids.
114319
+ schema:
114320
+ type: array
114321
+ items:
114322
+ type: string
114323
+ format: uuid
113753
114324
  - name: PageNumber
113754
114325
  in: query
113755
114326
  description: Gets or sets the page number for paged queries.
@@ -114147,6 +114718,19 @@ paths:
114147
114718
  schema:
114148
114719
  type: number
114149
114720
  format: float
114721
+ - name: DashboardRequest
114722
+ in: query
114723
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
114724
+ schema:
114725
+ type: boolean
114726
+ - name: ProgrammeIds
114727
+ in: query
114728
+ description: Gets or sets the programme ids.
114729
+ schema:
114730
+ type: array
114731
+ items:
114732
+ type: string
114733
+ format: uuid
114150
114734
  - name: PageNumber
114151
114735
  in: query
114152
114736
  description: Gets or sets the page number for paged queries.
@@ -114366,6 +114950,19 @@ paths:
114366
114950
  schema:
114367
114951
  type: number
114368
114952
  format: float
114953
+ - name: DashboardRequest
114954
+ in: query
114955
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
114956
+ schema:
114957
+ type: boolean
114958
+ - name: ProgrammeIds
114959
+ in: query
114960
+ description: Gets or sets the programme ids.
114961
+ schema:
114962
+ type: array
114963
+ items:
114964
+ type: string
114965
+ format: uuid
114369
114966
  - name: PageNumber
114370
114967
  in: query
114371
114968
  description: Gets or sets the page number for paged queries.
@@ -114591,6 +115188,19 @@ paths:
114591
115188
  schema:
114592
115189
  type: number
114593
115190
  format: float
115191
+ - name: DashboardRequest
115192
+ in: query
115193
+ description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
115194
+ schema:
115195
+ type: boolean
115196
+ - name: ProgrammeIds
115197
+ in: query
115198
+ description: Gets or sets the programme ids.
115199
+ schema:
115200
+ type: array
115201
+ items:
115202
+ type: string
115203
+ format: uuid
114594
115204
  - name: PageNumber
114595
115205
  in: query
114596
115206
  description: Gets or sets the page number for paged queries.
@@ -121735,6 +122345,10 @@ components:
121735
122345
  type: string
121736
122346
  description: Gets or sets the admin contact email.
121737
122347
  nullable: true
122348
+ sendReminder:
122349
+ type: boolean
122350
+ description: Gets or sets a valu indicating whether to send the reminder email.
122351
+ nullable: true
121738
122352
  reminderHoursBeforeStart:
121739
122353
  type: integer
121740
122354
  description: Gets or sets the reminder hours before start.
@@ -121884,6 +122498,12 @@ components:
121884
122498
  format: int32
121885
122499
  nullable: true
121886
122500
  readOnly: true
122501
+ totalSessions:
122502
+ type: integer
122503
+ description: Gets the courses total number of sessions.
122504
+ format: int32
122505
+ default: 0
122506
+ readOnly: true
121887
122507
  timePeriodLabel:
121888
122508
  type: string
121889
122509
  description: Gets the courses period label.
@@ -122822,6 +123442,16 @@ components:
122822
123442
  description: Gets the venues shortened formatted address.
122823
123443
  nullable: true
122824
123444
  readOnly: true
123445
+ isPromotional:
123446
+ type: boolean
123447
+ description: Gets a value indicating whether the deal is a promotional deal (manually entered by the user).
123448
+ default: false
123449
+ readOnly: true
123450
+ typeDisplayName:
123451
+ type: string
123452
+ description: Gets the user-friendly label for the deal type.
123453
+ nullable: true
123454
+ readOnly: true
122825
123455
  additionalProperties: false
122826
123456
  description: Post model for session deals.
122827
123457
  CreateEmailSettings:
@@ -123771,6 +124401,16 @@ components:
123771
124401
  description: Gets the venues shortened formatted address.
123772
124402
  nullable: true
123773
124403
  readOnly: true
124404
+ isPromotional:
124405
+ type: boolean
124406
+ description: Gets a value indicating whether the deal is a promotional deal (manually entered by the user).
124407
+ default: false
124408
+ readOnly: true
124409
+ typeDisplayName:
124410
+ type: string
124411
+ description: Gets the user-friendly label for the deal type.
124412
+ nullable: true
124413
+ readOnly: true
123774
124414
  additionalProperties: false
123775
124415
  description: Represents a deal within the Reach application.
123776
124416
  DealActivity:
@@ -124972,6 +125612,10 @@ components:
124972
125612
  type: boolean
124973
125613
  description: Gets or sets a value indicating whether there is an age restriction.
124974
125614
  default: false
125615
+ featured:
125616
+ type: boolean
125617
+ description: Gets or sets a value indicating whether the activity should be featured on the storefront.
125618
+ default: false
124975
125619
  startDateTime:
124976
125620
  type: string
124977
125621
  description: Gets or sets the start date.
@@ -130601,6 +131245,10 @@ components:
130601
131245
  type: string
130602
131246
  description: Gets or sets the admin contact email.
130603
131247
  nullable: true
131248
+ sendReminder:
131249
+ type: boolean
131250
+ description: Gets or sets a valu indicating whether to send the reminder email.
131251
+ nullable: true
130604
131252
  reminderHoursBeforeStart:
130605
131253
  type: integer
130606
131254
  description: Gets or sets the reminder hours before start.