Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
192 changes: 186 additions & 6 deletions OpenActive.NET/enums/PropertyEnumeration.cs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion OpenActive.NET/enums/TestOpenBookingFlowEnumeration.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace OpenActive.NET
{
/// <summary>
/// [NOTICE: This enumeration is part of the Open Booking API Test Interface, and MUST NOT be used in production.]
/// An enumeration of open booking flows that an opportunity can be booked with.
/// An enumeration of [open booking flow](https://openactive.io/open-booking-api/EditorsDraft/1.0CR3/#booking-flows) that an [Opportunity and Offer pair](https://openactive.io/open-booking-api/EditorsDraft/1.0CR3/#definition-of-a-bookable-opportunity-and-offer-pair) can be booked with.
/// </summary>
public enum TestOpenBookingFlowEnumeration
{
Expand Down
4 changes: 2 additions & 2 deletions OpenActive.NET/models/BookingService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public override string ToString()
/// </summary>
[DataMember(Name = "hasCredential", EmitDefaultValue = false, Order = 8)]
[JsonConverter(typeof(ValuesConverter))]
public virtual Uri HasCredential { get; set; }
public new virtual Uri HasCredential { get; set; }

/// <summary>
/// The version of the application, useful for on-premise installations. Note this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves.
Expand All @@ -70,7 +70,7 @@ public override string ToString()
/// </summary>
[DataMember(Name = "termsOfService", EmitDefaultValue = false, Order = 10)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<Terms> TermsOfService { get; set; }
public new virtual List<Terms> TermsOfService { get; set; }

/// <summary>
/// The URL of the website of the Booking System.
Expand Down
2 changes: 1 addition & 1 deletion OpenActive.NET/models/CourseInstance.cs
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "eventSchedule", EmitDefaultValue = false, Order = 7)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<Schedule> EventSchedule { get; set; }
public new virtual List<Schedule> EventSchedule { get; set; }

/// <summary>
/// The description of the Course for which this is a distinct instance.
Expand Down
2 changes: 1 addition & 1 deletion OpenActive.NET/models/Dataset.cs
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "documentation", EmitDefaultValue = false, Order = 16)]
[JsonConverter(typeof(ValuesConverter))]
public virtual Uri Documentation { get; set; }
public new virtual Uri Documentation { get; set; }

/// <summary>
/// An array of languages included in the Dataset's content. Please use one of the language codes from the IETF BCP 47 standard.
Expand Down
9 changes: 5 additions & 4 deletions OpenActive.NET/models/Event.cs
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@
/// </example>
[DataMember(Name = "eventAttendanceMode", EmitDefaultValue = false, Order = 21)]
[JsonConverter(typeof(ValuesConverter))]
public virtual EventAttendanceModeEnumeration? EventAttendanceMode { get; set; }
public new virtual EventAttendanceModeEnumeration? EventAttendanceMode { get; set; }

/// <summary>
/// The status of an event. Can be used to indicate rescheduled or cancelled events
Expand Down Expand Up @@ -436,7 +436,7 @@
/// </example>
[DataMember(Name = "maximumVirtualAttendeeCapacity", EmitDefaultValue = false, Order = 32)]
[JsonConverter(typeof(ValuesConverter))]
public virtual long? MaximumVirtualAttendeeCapacity { get; set; }
public new virtual long? MaximumVirtualAttendeeCapacity { get; set; }

/// <summary>
/// Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.
Expand All @@ -462,7 +462,7 @@
/// "name": "Adult",
/// "price": 3.3,
/// "priceCurrency": "GBP",
/// "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"

Check warning on line 465 in OpenActive.NET/models/Event.cs

View workflow job for this annotation

GitHub Actions / test

XML comment has badly formed XML -- 'Reference to undefined entity 'Culture'.'

Check warning on line 465 in OpenActive.NET/models/Event.cs

View workflow job for this annotation

GitHub Actions / test

XML comment has badly formed XML -- 'Reference to undefined entity 'Activities'.'
/// }
/// ]
/// </code>
Expand Down Expand Up @@ -529,7 +529,7 @@
public virtual string SchedulingNote { get; set; }

/// <summary>
/// The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.
/// The start date and time of the event. Can be specified as a schema:DateTime.
/// </summary>
/// <example>
/// <code>
Expand All @@ -541,7 +541,7 @@
public new virtual DateTimeValue StartDate { get; set; }

/// <summary>
/// The end date and time of the event. Can be specified as a schema:Date or schema:DateTime
/// The end date and time of the event. Can be specified as a schema:DateTime
/// It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.
/// </summary>
/// <example>
Expand Down Expand Up @@ -781,6 +781,7 @@

/// <summary>
/// [NOTICE: This property is part of the Open Booking API Test Interface, and MUST NOT be used in production.]
/// The [open booking flow](https://openactive.io/open-booking-api/EditorsDraft/1.0CR3/#booking-flows) that a created [Opportunity and Offer pair](https://openactive.io/open-booking-api/EditorsDraft/1.0CR3/#definition-of-a-bookable-opportunity-and-offer-pair) should support.
/// </summary>
[DataMember(Name = "test:testOpenBookingFlow", EmitDefaultValue = false, Order = 1064)]
[JsonConverter(typeof(ValuesConverter))]
Expand Down
2 changes: 1 addition & 1 deletion OpenActive.NET/models/EventSeries.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
namespace OpenActive.NET
{
/// <summary>
/// This type is derived from https://pending.schema.org/EventSeries.
/// This type is derived from https://schema.org/EventSeries, which means that any of this type's properties within schema.org may also be used.
/// </summary>
[DataContract]
public partial class EventSeries : Event
Expand Down
2 changes: 1 addition & 1 deletion OpenActive.NET/models/FacilityUse.cs
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@
/// "name": "Adult",
/// "price": 7.5,
/// "priceCurrency": "GBP",
/// "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"

Check warning on line 337 in OpenActive.NET/models/FacilityUse.cs

View workflow job for this annotation

GitHub Actions / test

XML comment has badly formed XML -- 'Reference to undefined entity 'Culture'.'

Check warning on line 337 in OpenActive.NET/models/FacilityUse.cs

View workflow job for this annotation

GitHub Actions / test

XML comment has badly formed XML -- 'Reference to undefined entity 'Activities'.'
/// }
/// </code>
/// </example>
Expand All @@ -356,7 +356,7 @@
/// </example>
[DataMember(Name = "provider", EmitDefaultValue = false, Order = 25)]
[JsonConverter(typeof(ValuesConverter))]
public virtual Organization Provider { get; set; }
public new virtual Organization Provider { get; set; }

/// <summary>
/// A URL to a web page (or section of a page) that describes the facility use.
Expand Down
12 changes: 11 additions & 1 deletion OpenActive.NET/models/Organization.cs
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ public override string ToString()
/// </summary>
[DataMember(Name = "termsOfService", EmitDefaultValue = false, Order = 19)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<Terms> TermsOfService { get; set; }
public new virtual List<Terms> TermsOfService { get; set; }

/// <summary>
/// A definitive canonical URL for the Organization.
Expand Down Expand Up @@ -235,5 +235,15 @@ public override string ToString()
[DataMember(Name = "beta:formalCriteriaMet", EmitDefaultValue = false, Order = 1024)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<Uri> FormalCriteriaMet { get; set; }

/// <summary>
/// [NOTICE: This is a beta property, and is highly likely to change in future versions of this library.]
/// The date on which the details of this organization were last verified as correct by the publisher. Unlike `schema:dateModified`, this changes when the details are confirmed, even if nothing in them has changed.
///
/// If you are using this property, please join the discussion at proposal [#313](https://github.com/openactive/modelling-opportunity-data/issues/313).
/// </summary>
[DataMember(Name = "beta:dateVerified", EmitDefaultValue = false, Order = 1025)]
[JsonConverter(typeof(OpenActiveDateTimeValuesConverter))]
public virtual DateValue DateVerified { get; set; }
}
}
2 changes: 1 addition & 1 deletion OpenActive.NET/models/PartialSchedule.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
namespace OpenActive.NET
{
/// <summary>
/// This type is derived from https://pending.schema.org/Schedule.
/// This type is derived from https://schema.org/Schedule, which means that any of this type's properties within schema.org may also be used.
/// </summary>
[DataContract]
public partial class PartialSchedule : Schedule
Expand Down
6 changes: 3 additions & 3 deletions OpenActive.NET/models/Person.cs
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "gender", EmitDefaultValue = false, Order = 14)]
[JsonConverter(typeof(ValuesConverter))]
public virtual SingleValues<string, Schema.NET.GenderType?> Gender { get; set; }
public new virtual SingleValues<string, Schema.NET.GenderType?> Gender { get; set; }

/// <summary>
/// A first name for the person.
Expand Down Expand Up @@ -177,7 +177,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "jobTitle", EmitDefaultValue = false, Order = 18)]
[JsonConverter(typeof(ValuesConverter))]
public virtual string JobTitle { get; set; }
public new virtual string JobTitle { get; set; }

/// <summary>
/// The official name of the organization, e.g. the registered company name.
Expand Down Expand Up @@ -243,7 +243,7 @@ public override string ToString()
/// </summary>
[DataMember(Name = "termsOfService", EmitDefaultValue = false, Order = 24)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<Terms> TermsOfService { get; set; }
public new virtual List<Terms> TermsOfService { get; set; }

/// <summary>
/// A URL where more information about the person may be found
Expand Down
45 changes: 37 additions & 8 deletions OpenActive.NET/models/Place.cs
Original file line number Diff line number Diff line change
Expand Up @@ -160,15 +160,34 @@
public new virtual ReferenceValue<Place> ContainedInPlace { get; set; }

/// <summary>
/// Places that exist within this place
/// A specific identifiable facility (`SportsActivityLocation`) or place (`Place`) that exist within this place
/// </summary>
/// <example>
/// <code>
/// "containsPlace": {
/// "@type": "Place",
/// "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
/// "name": "Center Parcs Sports Plaza"
/// }
/// "containsPlace": [
/// {
/// "@type": "SportsActivityLocation",
/// "@id": "https://api.example.com/places/1402CBP20150217/sports-activity-locations/3",
/// "url": "https://www.better.org.uk/leisure-centre/manchester/belle-vue-sports-village/facilities",
/// "name": "Studio",
/// "description": "We have a great range of Fitness Classes at Belle Vue Leisure Centre including Group Cycle, Zumba, Pilates and much much more.",
/// "image": [
/// {
/// "@type": "ImageObject",
/// "url": "https://res-1.cloudinary.com/gll/image/upload/c_fit,f_auto,h_169,w_384/v1592158966/production/0065/7/66/PHOTO-2020-06-09-14-25-53_3.jpg"
/// }
/// ],
/// "specialOpeningHoursSpecification": [
/// {
/// "@type": "OpeningHoursSpecification",
/// "opens": "00:00",
/// "closes": "00:00",
/// "validFrom": "2022-01-01",
/// "validThrough": "2022-12-31"
/// }
/// ]
/// }
/// ]
/// </code>
/// </example>
[DataMember(Name = "containsPlace", EmitDefaultValue = false, Order = 13)]
Expand Down Expand Up @@ -279,13 +298,23 @@
[JsonConverter(typeof(ValuesConverter))]
public virtual List<VideoObject> Video { get; set; }

/// <summary>
/// [NOTICE: This is a beta property, and is highly likely to change in future versions of this library.]
/// A related virtual tour.
///
/// If you are using this property, please join the discussion at proposal [#306](https://github.com/openactive/modelling-opportunity-data/issues/306).
/// </summary>
[DataMember(Name = "beta:virtualTour", EmitDefaultValue = false, Order = 1023)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<Schema.NET.3DModel> VirtualTour { get; set; }

Check failure on line 309 in OpenActive.NET/models/Place.cs

View workflow job for this annotation

GitHub Actions / test

Syntax error, ',' expected

Check failure on line 309 in OpenActive.NET/models/Place.cs

View workflow job for this annotation

GitHub Actions / test

Syntax error, ',' expected

Check failure on line 309 in OpenActive.NET/models/Place.cs

View workflow job for this annotation

GitHub Actions / test

Syntax error, ',' expected

Check failure on line 309 in OpenActive.NET/models/Place.cs

View workflow job for this annotation

GitHub Actions / test

Syntax error, ',' expected

/// <summary>
/// [NOTICE: This is a beta property, and is highly likely to change in future versions of this library.]
/// The organization responsible for the operation of the `Place`.
///
/// If you are using this property, please join the discussion at proposal [#307](https://github.com/openactive/modelling-opportunity-data/issues/307).
/// </summary>
[DataMember(Name = "beta:serviceOperator", EmitDefaultValue = false, Order = 1023)]
[DataMember(Name = "beta:serviceOperator", EmitDefaultValue = false, Order = 1024)]
[JsonConverter(typeof(ValuesConverter))]
public virtual Organization ServiceOperator { get; set; }

Expand All @@ -295,7 +324,7 @@
///
/// If you are using this property, please join the discussion at proposal [#1](https://github.com/openactive/place-types/issues/1).
/// </summary>
[DataMember(Name = "beta:placeType", EmitDefaultValue = false, Order = 1024)]
[DataMember(Name = "beta:placeType", EmitDefaultValue = false, Order = 1025)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<Concept> PlaceType { get; set; }
}
Expand Down
30 changes: 15 additions & 15 deletions OpenActive.NET/models/Schedule.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
namespace OpenActive.NET
{
/// <summary>
/// This type is derived from https://pending.schema.org/Schedule.
/// This type is derived from https://schema.org/Schedule, which means that any of this type's properties within schema.org may also be used.
/// </summary>
[DataContract]
public partial class Schedule : Schema.NET.JsonLdObject
public partial class Schedule : Schema.NET.Schedule
{
/// <summary>
/// Returns the JSON-LD representation of this instance.
Expand Down Expand Up @@ -57,7 +57,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "byDay", EmitDefaultValue = false, Order = 7)]
[JsonConverter(typeof(ValuesConverter))]
public virtual SingleValues<List<string>, List<Schema.NET.DayOfWeek>> ByDay { get; set; }
public new virtual SingleValues<List<string>, List<Schema.NET.DayOfWeek>> ByDay { get; set; }

/// <summary>
/// Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.
Expand All @@ -71,7 +71,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "byMonth", EmitDefaultValue = false, Order = 8)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<long> ByMonth { get; set; }
public new virtual List<long> ByMonth { get; set; }

/// <summary>
/// Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31
Expand All @@ -85,7 +85,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "byMonthDay", EmitDefaultValue = false, Order = 9)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<long> ByMonthDay { get; set; }
public new virtual List<long> ByMonthDay { get; set; }

/// <summary>
/// The duration of the event given in [ISO8601] format.
Expand All @@ -97,7 +97,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "duration", EmitDefaultValue = false, Order = 10)]
[JsonConverter(typeof(OpenActiveTimeSpanToISO8601DurationValuesConverter))]
public virtual TimeSpan? Duration { get; set; }
public new virtual TimeSpan? Duration { get; set; }

/// <summary>
/// The end time of the event.
Expand All @@ -109,7 +109,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "endTime", EmitDefaultValue = false, Order = 11)]
[JsonConverter(typeof(OpenActiveDateTimeValuesConverter))]
public virtual TimeValue EndTime { get; set; }
public new virtual TimeValue EndTime { get; set; }

/// <summary>
/// Exception dates where the schedule should not generate an event.
Expand All @@ -128,7 +128,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "exceptDate", EmitDefaultValue = false, Order = 12)]
[JsonConverter(typeof(ValuesConverter))]
public virtual List<DateTimeOffset> ExceptDate { get; set; }
public new virtual List<DateTimeOffset> ExceptDate { get; set; }

/// <summary>
/// An RFC6570 compliant URI template that can be used to generate a unique identifier (`@id`) for every event described by the schedule. This property is required if the data provider is supporting third-party booking via the Open Booking API, or providing complimentary individual `subEvent`s.
Expand All @@ -152,7 +152,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "repeatCount", EmitDefaultValue = false, Order = 14)]
[JsonConverter(typeof(ValuesConverter))]
public virtual long? RepeatCount { get; set; }
public new virtual long? RepeatCount { get; set; }

/// <summary>
/// Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.
Expand All @@ -164,7 +164,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "repeatFrequency", EmitDefaultValue = false, Order = 15)]
[JsonConverter(typeof(OpenActiveTimeSpanToISO8601DurationValuesConverter))]
public virtual TimeSpan? RepeatFrequency { get; set; }
public new virtual TimeSpan? RepeatFrequency { get; set; }

/// <summary>
/// The type of event this schedule related to.
Expand All @@ -188,7 +188,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "scheduleTimezone", EmitDefaultValue = false, Order = 17)]
[JsonConverter(typeof(ValuesConverter))]
public virtual string ScheduleTimezone { get; set; }
public new virtual string ScheduleTimezone { get; set; }

/// <summary>
/// The start date of the event.
Expand All @@ -200,7 +200,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "startDate", EmitDefaultValue = false, Order = 18)]
[JsonConverter(typeof(OpenActiveDateTimeValuesConverter))]
public virtual DateValue StartDate { get; set; }
public new virtual DateValue StartDate { get; set; }

/// <summary>
/// The end date of the schedule.
Expand All @@ -212,7 +212,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "endDate", EmitDefaultValue = false, Order = 19)]
[JsonConverter(typeof(OpenActiveDateTimeValuesConverter))]
public virtual DateValue EndDate { get; set; }
public new virtual DateValue EndDate { get; set; }

/// <summary>
/// The start time of the event.
Expand All @@ -224,7 +224,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "startTime", EmitDefaultValue = false, Order = 20)]
[JsonConverter(typeof(OpenActiveDateTimeValuesConverter))]
public virtual TimeValue StartTime { get; set; }
public new virtual TimeValue StartTime { get; set; }

/// <summary>
/// An RFC6570 compliant URI template that can be used to generate a unique `url` for every event described by the schedule. This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.
Expand All @@ -236,7 +236,7 @@ public override string ToString()
/// </example>
[DataMember(Name = "urlTemplate", EmitDefaultValue = false, Order = 21)]
[JsonConverter(typeof(ValuesConverter))]
public virtual string UrlTemplate { get; set; }
public new virtual string UrlTemplate { get; set; }

/// <summary>
/// [DEPRECATED: This term has graduated from the beta namespace and is highly likely to be removed in future versions of this library, please use `scheduleTimezone` instead.]
Expand Down
Loading
Loading