openactive 0.1.0 → 0.2.2

data/lib/openactive/models/concept_collection.rb

@@ -1,6 +1,7 @@
 module OpenActive
   module Models
-    # [NOTICE: This is a beta class, and is highly likely to change in future versions of this library.].
+    # [NOTICE: This is a beta class, and is highly likely to change in future versions of this library.]
+    # This type is derived from https://schema.org/CreativeWork, which means that any of this type's properties within schema.org may also be used.
     class ConceptCollection < ::OpenActive::Models::Schema::CreativeWork
       # @!attribute type
       # @return [String]

data/lib/openactive/models/concept_scheme.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    # This type is derived from http://www.w3.org/2004/02/skos/core#ConceptScheme.
     class ConceptScheme < ::OpenActive::JsonLdModel
       # @!attribute type
       # @return [String]

data/lib/openactive/models/course.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Course](https://schema.org/Course), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    # This type is derived from https://schema.org/Course, which means that any of this type's properties within schema.org may also be used.
     class Course < ::OpenActive::Models::Schema::Course
       # @!attribute type
       # @return [String]
@@ -27,15 +27,54 @@ module OpenActive
         "string",
       ]
 
+      # @return [String]
+      define_property :accessibility_information, as: "accessibilityInformation", types: [
+        "string",
+      ]
+
+      # @return [Array<OpenActive::Models::Concept>]
+      define_property :accessibility_support, as: "accessibilitySupport", types: [
+        "OpenActive::Models::Concept[]",
+      ]
+
       # @return [Array<OpenActive::Models::Concept>]
       define_property :activity, as: "activity", types: [
         "OpenActive::Models::Concept[]",
       ]
 
-      # @return [OpenActive::Models::Person,OpenActive::Models::Organization]
+      # @return [OpenActive::Models::QuantitativeValue]
+      define_property :age_range, as: "ageRange", types: [
+        "OpenActive::Models::QuantitativeValue",
+      ]
+
+      # @return [OpenActive::Models::Person,OpenActive::Models::Organization,URI]
       define_property :author, as: "author", types: [
         "OpenActive::Models::Person",
         "OpenActive::Models::Organization",
+        "URI",
+      ]
+
+      # @return [Array<String>,Array<OpenActive::Models::Concept>]
+      define_property :category, as: "category", types: [
+        "string[]",
+        "OpenActive::Models::Concept[]",
+      ]
+
+      # @return [OpenActive::Enums::GenderRestrictionType,nil]
+      define_property :gender_restriction, as: "genderRestriction", types: [
+        "OpenActive::Enums::GenderRestrictionType",
+        "null",
+      ]
+
+      # @return [Array<OpenActive::Models::ImageObject>]
+      define_property :image, as: "image", types: [
+        "OpenActive::Models::ImageObject[]",
+      ]
+
+      # @return [Array<String>,Array<OpenActive::Models::Concept>]
+      define_property :level, as: "level", types: [
+        "string[]",
+        "OpenActive::Models::Concept[]",
       ]
 
       # @return [URI]
@@ -43,14 +82,9 @@ module OpenActive
         "URI",
       ]
 
-      # @return [Array<OpenActive::Models::Schema::VideoObject>]
+      # @return [Array<OpenActive::Models::VideoObject>]
       define_property :video, as: "beta:video", types: [
-        "OpenActive::Models::Schema::VideoObject[]",
-      ]
-
-      # @return [OpenActive::Models::ImageObject]
-      define_property :logo, as: "beta:logo", types: [
-        "OpenActive::Models::ImageObject",
+        "OpenActive::Models::VideoObject[]",
       ]
     end
   end

data/lib/openactive/models/course_instance.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [CourseInstance](https://schema.org/CourseInstance), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    # This type is derived from https://schema.org/CourseInstance, which means that any of this type's properties within schema.org may also be used.
     class CourseInstance < ::OpenActive::Models::Event
       # @!attribute type
       # @return [String]
@@ -8,6 +8,38 @@ module OpenActive
         "CourseInstance"
       end
 
+      # @return [Array<OpenActive::Models::Schedule>]
+      define_property :event_schedule, as: "eventSchedule", types: [
+        "OpenActive::Models::Schedule[]",
+      ]
+
+      # @return [OpenActive::Models::Course]
+      define_property :instance_of_course, as: "instanceOfCourse", types: [
+        "OpenActive::Models::Course",
+      ]
+
+      # @return [Date,nil]
+      define_property :start_date, as: "startDate", types: [
+        "Date",
+        "null",
+      ]
+
+      # @return [Date,nil]
+      define_property :end_date, as: "endDate", types: [
+        "Date",
+        "null",
+      ]
+
+      # @return [Array<OpenActive::Models::Event>]
+      define_property :sub_event, as: "subEvent", types: [
+        "OpenActive::Models::Event[]",
+      ]
+
+      # @return [OpenActive::Models::Event]
+      define_property :super_event, as: "superEvent", types: [
+        "OpenActive::Models::Event",
+      ]
+
       # @return [OpenActive::Models::Course]
       define_property :course, as: "beta:course", types: [
         "OpenActive::Models::Course",

data/lib/openactive/models/creche.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [LocationFeatureSpecification](https://schema.org/LocationFeatureSpecification), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    # This type is derived from https://schema.org/LocationFeatureSpecification, which means that any of this type's properties within schema.org may also be used.
     class Creche < ::OpenActive::Models::LocationFeatureSpecification
       # @!attribute type
       # @return [String]

data/lib/openactive/models/customer_notice_simulate_action.rb

@@ -0,0 +1,13 @@
+module OpenActive
+  module Models
+    # [NOTICE: This class is part of the Open Booking API Test Interface, and MUST NOT be used in production.]
+    # This type is derived from https://schema.org/Action, which means that any of this type's properties within schema.org may also be used.
+    class CustomerNoticeSimulateAction < ::OpenActive::Models::OpenBookingSimulateAction
+      # @!attribute type
+      # @return [String]
+      def type
+        "test:CustomerNoticeSimulateAction"
+      end
+    end
+  end
+end

data/lib/openactive/models/data_catalog.rb

@@ -0,0 +1,53 @@
+module OpenActive
+  module Models
+    #
+    # EARLY RELEASE NOTICE: This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback. It is mostly stable, as it based entirely on schema.org. HOWEVER, IT IS STILL SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves.
+    #
+    # This type is derived from https://schema.org/DataCatalog, which means that any of this type's properties within schema.org may also be used.
+    class DataCatalog < ::OpenActive::Models::Schema::DataCatalog
+      # @!attribute type
+      # @return [String]
+      def type
+        "DataCatalog"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [Array<URI>]
+      define_property :dataset, as: "dataset", types: [
+        "URI[]",
+      ]
+
+      # @return [DateTime,nil]
+      define_property :date_modified, as: "dateModified", types: [
+        "DateTime",
+        "null",
+      ]
+
+      # @return [Date,DateTime,nil]
+      define_property :date_published, as: "datePublished", types: [
+        "Date",
+        "DateTime",
+        "null",
+      ]
+
+      # @return [Array<URI>]
+      define_property :has_part, as: "hasPart", types: [
+        "URI[]",
+      ]
+
+      # @return [URI]
+      define_property :license, as: "license", types: [
+        "URI",
+      ]
+
+      # @return [OpenActive::Models::Organization]
+      define_property :publisher, as: "publisher", types: [
+        "OpenActive::Models::Organization",
+      ]
+    end
+  end
+end

data/lib/openactive/models/data_download.rb

@@ -1,11 +1,9 @@
 module OpenActive
   module Models
     #
-    # ## **EARLY RELEASE NOTICE**
-    # In order to expedite the OpenActive tooling work, this class has been added to the model for the purposes of testing.
-    # IT IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://www.openactive.io/dataset-api-discovery/EditorsDraft/) evolves.
+    # EARLY RELEASE NOTICE: This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback. IT IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves.
     #
-    # This type is derived from [DataDownload](https://schema.org/DataDownload), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    # This type is derived from https://schema.org/DataDownload, which means that any of this type's properties within schema.org may also be used.
     class DataDownload < ::OpenActive::Models::Schema::DataDownload
       # @!attribute type
       # @return [String]
@@ -13,6 +11,11 @@ module OpenActive
         "DataDownload"
       end
 
+      # @return [String]
+      define_property :identifier, as: "identifier", types: [
+        "string",
+      ]
+
       # @return [String]
       define_property :name, as: "name", types: [
         "string",

data/lib/openactive/models/dataset.rb

@@ -1,11 +1,9 @@
 module OpenActive
   module Models
     #
-    # ## **EARLY RELEASE NOTICE**
-    # In order to expedite the OpenActive tooling work, this class has been added to the model for the purposes of testing.
-    # IT IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://www.openactive.io/dataset-api-discovery/EditorsDraft/) evolves.
+    # EARLY RELEASE NOTICE: This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback. It is mostly stable, as it based almost entirely on schema.org. HOWEVER, IT IS STILL SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves.
     #
-    # This type is derived from [Dataset](https://schema.org/Dataset), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    # This type is derived from https://schema.org/Dataset, which means that any of this type's properties within schema.org may also be used.
     class Dataset < ::OpenActive::Models::Schema::Dataset
       # @!attribute type
       # @return [String]

data/lib/openactive/models/dropdown_form_field_specification.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [PropertyValueSpecification](https://schema.org/PropertyValueSpecification), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    # This type is derived from https://schema.org/PropertyValueSpecification, which means that any of this type's properties within schema.org may also be used.
     class DropdownFormFieldSpecification < ::OpenActive::Models::PropertyValueSpecification
       # @!attribute type
       # @return [String]

data/lib/openactive/models/dynamic_payment.rb

@@ -1,5 +1,6 @@
 module OpenActive
   module Models
+    # This type is derived from https://schema.org/Thing, which means that any of this type's properties within schema.org may also be used.
     class DynamicPayment < ::OpenActive::Models::Payment
       # @!attribute type
       # @return [String]

data/lib/openactive/models/event.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Event](https://schema.org/Event), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    # This type is derived from https://schema.org/Event, which means that any of this type's properties within schema.org may also be used.
     class Event < ::OpenActive::Models::Schema::Event
       # @!attribute type
       # @return [String]
@@ -42,11 +42,21 @@ module OpenActive
         "OpenActive::Models::Concept[]",
       ]
 
+      # @return [Array<String>]
+      define_property :additional_admission_restriction, as: "additionalAdmissionRestriction", types: [
+        "string[]",
+      ]
+
       # @return [OpenActive::Models::QuantitativeValue]
       define_property :age_range, as: "ageRange", types: [
         "OpenActive::Models::QuantitativeValue",
       ]
 
+      # @return [OpenActive::Models::QuantitativeValue]
+      define_property :age_restriction, as: "ageRestriction", types: [
+        "OpenActive::Models::QuantitativeValue",
+      ]
+
       # @return [String]
       define_property :attendee_instructions, as: "attendeeInstructions", types: [
         "string",
@@ -69,9 +79,10 @@ module OpenActive
         "null",
       ]
 
-      # @return [Array<OpenActive::Models::Schedule>]
-      define_property :event_schedule, as: "eventSchedule", types: [
-        "OpenActive::Models::Schedule[]",
+      # @return [OpenActive::Enums::Schema::EventAttendanceModeEnumeration,nil]
+      define_property :event_attendance_mode, as: "eventAttendanceMode", types: [
+        "OpenActive::Enums::Schema::EventAttendanceModeEnumeration",
+        "null",
       ]
 
       # @return [OpenActive::Enums::Schema::EventStatusType,nil]
@@ -125,6 +136,12 @@ module OpenActive
         "null",
       ]
 
+      # @return [int,nil]
+      define_property :maximum_virtual_attendee_capacity, as: "maximumVirtualAttendeeCapacity", types: [
+        "int",
+        "null",
+      ]
+
       # @return [String]
       define_property :meeting_point, as: "meetingPoint", types: [
         "string",
@@ -141,11 +158,6 @@ module OpenActive
         "OpenActive::Models::Organization",
       ]
 
-      # @return [Array<OpenActive::Models::Action>]
-      define_property :potential_action, as: "potentialAction", types: [
-        "OpenActive::Models::Action[]",
-      ]
-
       # @return [OpenActive::Models::Brand]
       define_property :programme, as: "programme", types: [
         "OpenActive::Models::Brand",
@@ -191,25 +203,53 @@ module OpenActive
         "URI",
       ]
 
+      # @return [String]
+      define_property :formatted_description, as: "beta:formattedDescription", types: [
+        "string",
+      ]
+
       # @return [OpenActive::Models::QuantitativeValue]
       define_property :distance, as: "beta:distance", types: [
         "OpenActive::Models::QuantitativeValue",
       ]
 
-      # @return [OpenActive::Models::QuantitativeValue]
-      define_property :estimated_duration, as: "beta:estimatedDuration", types: [
-        "OpenActive::Models::QuantitativeValue",
+      # @return [int,nil]
+      define_property :attendee_count, as: "beta:attendeeCount", types: [
+        "int",
+        "null",
+      ]
+
+      # @return [int,nil]
+      define_property :registration_count, as: "beta:registrationCount", types: [
+        "int",
+        "null",
       ]
 
       # @return [Boolean,nil]
-      define_property :is_virtually_coached, as: "beta:isVirtuallyCoached", types: [
+      define_property :is_wheelchair_accessible, as: "beta:isWheelchairAccessible", types: [
         "bool",
         "null",
       ]
 
-      # @return [String]
-      define_property :formatted_description, as: "beta:formattedDescription", types: [
-        "string",
+      # @return [OpenActive::Models::QuantitativeValue]
+      define_property :estimated_duration, as: "beta:estimatedDuration", types: [
+        "OpenActive::Models::QuantitativeValue",
+      ]
+
+      # @return [Array<OpenActive::Models::VideoObject>]
+      define_property :video, as: "beta:video", types: [
+        "OpenActive::Models::VideoObject[]",
+      ]
+
+      # @return [Array<OpenActive::Models::Schema::SportsActivityLocation>]
+      define_property :sports_activity_location, as: "beta:sportsActivityLocation", types: [
+        "OpenActive::Models::Schema::SportsActivityLocation[]",
+      ]
+
+      # @return [ActiveSupport::Duration,nil]
+      define_property :offer_validity_period, as: "beta:offerValidityPeriod", types: [
+        "DateInterval",
+        "null",
       ]
 
       # @return [OpenActive::Enums::FacilitySettingType,nil]
@@ -218,42 +258,65 @@ module OpenActive
         "null",
       ]
 
-      # @return [ActiveSupport::Duration,nil]
-      define_property :offer_validity_period, as: "beta:offerValidityPeriod", types: [
-        "DateInterval",
+      # @return [Boolean,nil]
+      define_property :is_virtually_coached, as: "beta:isVirtuallyCoached", types: [
+        "bool",
         "null",
       ]
 
-      # @return [Array<OpenActive::Models::SportsActivityLocation>]
-      define_property :sports_activity_location, as: "beta:sportsActivityLocation", types: [
-        "OpenActive::Models::SportsActivityLocation[]",
+      # @return [OpenActive::Models::VirtualLocation]
+      define_property :virtual_location, as: "beta:virtualLocation", types: [
+        "OpenActive::Models::VirtualLocation",
       ]
 
-      # @return [Array<OpenActive::Models::Schema::VideoObject>]
-      define_property :video, as: "beta:video", types: [
-        "OpenActive::Models::Schema::VideoObject[]",
+      # @return [OpenActive::Models::Place]
+      define_property :affiliated_location, as: "beta:affiliatedLocation", types: [
+        "OpenActive::Models::Place",
       ]
 
-      # @return [String]
-      define_property :availability, as: "beta:availability", types: [
-        "string",
+      # @return [Boolean,nil]
+      define_property :is_interactivity_preferred, as: "beta:isInteractivityPreferred", types: [
+        "bool",
+        "null",
+      ]
+
+      # @return [OpenActive::Enums::RequiredStatusType,nil]
+      define_property :participant_supplied_equipment, as: "beta:participantSuppliedEquipment", types: [
+        "OpenActive::Enums::RequiredStatusType",
+        "null",
+      ]
+
+      # @return [URI]
+      define_property :donation_payment_url, as: "beta:donationPaymentUrl", types: [
+        "URI",
       ]
 
       # @return [Boolean,nil]
-      define_property :is_wheelchair_accessible, as: "beta:isWheelchairAccessible", types: [
+      define_property :is_first_session_accessible_for_free, as: "beta:isFirstSessionAccessibleForFree", types: [
         "bool",
         "null",
       ]
 
-      # @return [int,nil]
-      define_property :registration_count, as: "beta:registrationCount", types: [
-        "int",
+      # @return [OpenActive::Models::Schema::ContactPoint]
+      define_property :contact_point, as: "beta:contactPoint", types: [
+        "OpenActive::Models::Schema::ContactPoint",
+      ]
+
+      # @return [Array<OpenActive::Enums::BookingChannelType>,nil]
+      define_property :booking_channel, as: "beta:bookingChannel", types: [
+        "OpenActive::Enums::BookingChannelType[]",
         "null",
       ]
 
-      # @return [int,nil]
-      define_property :attendee_count, as: "beta:attendeeCount", types: [
-        "int",
+      # @return [OpenActive::Enums::TestOpenBookingFlowEnumeration,nil]
+      define_property :test_open_booking_flow, as: "test:testOpenBookingFlow", types: [
+        "OpenActive::Enums::TestOpenBookingFlowEnumeration",
+        "null",
+      ]
+
+      # @return [OpenActive::Enums::TestOpportunityCriteriaEnumeration,nil]
+      define_property :test_opportunity_criteria, as: "test:testOpportunityCriteria", types: [
+        "OpenActive::Enums::TestOpportunityCriteriaEnumeration",
         "null",
       ]
     end