openactive 0.1.0 → 0.2.2

data/lib/openactive/models/seller_reject_order_proposal_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 SellerRejectOrderProposalSimulateAction < ::OpenActive::Models::OpenBookingSimulateAction
+      # @!attribute type
+      # @return [String]
+      def type
+        "test:SellerRejectOrderProposalSimulateAction"
+      end
+    end
+  end
+end

data/lib/openactive/models/seller_requested_cancellation_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 SellerRequestedCancellationSimulateAction < ::OpenActive::Models::OpenBookingSimulateAction
+      # @!attribute type
+      # @return [String]
+      def type
+        "test:SellerRequestedCancellationSimulateAction"
+      end
+    end
+  end
+end

data/lib/openactive/models/seller_requested_cancellation_with_message_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 SellerRequestedCancellationWithMessageSimulateAction < ::OpenActive::Models::OpenBookingSimulateAction
+      # @!attribute type
+      # @return [String]
+      def type
+        "test:SellerRequestedCancellationWithMessageSimulateAction"
+      end
+    end
+  end
+end

data/lib/openactive/models/session_series.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 SessionSeries < ::OpenActive::Models::Event
       # @!attribute type
       # @return [String]
@@ -8,6 +8,11 @@ module OpenActive
         "SessionSeries"
       end
 
+      # @return [Array<OpenActive::Models::Schedule>]
+      define_property :event_schedule, as: "eventSchedule", types: [
+        "OpenActive::Models::Schedule[]",
+      ]
+
       # @return [int,nil]
       define_property :remaining_attendee_capacity, as: "remainingAttendeeCapacity", types: [
         "int",

data/lib/openactive/models/short_answer_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 ShortAnswerFormFieldSpecification < ::OpenActive::Models::PropertyValueSpecification
       # @!attribute type
       # @return [String]

data/lib/openactive/models/showers.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 Showers < ::OpenActive::Models::LocationFeatureSpecification
       # @!attribute type
       # @return [String]

data/lib/openactive/models/slot.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 Slot < ::OpenActive::Models::Event
       # @!attribute type
       # @return [String]
@@ -47,6 +47,11 @@ module OpenActive
         "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 +74,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]
@@ -80,11 +86,10 @@ module OpenActive
         "null",
       ]
 
-      # @return [URI,OpenActive::Models::IndividualFacilityUse,OpenActive::Models::FacilityUse]
+      # @return [OpenActive::Models::FacilityUse,URI]
       define_property :facility_use, as: "facilityUse", types: [
-        "URI",
-        "OpenActive::Models::IndividualFacilityUse",
         "OpenActive::Models::FacilityUse",
+        "URI",
       ]
 
       # @return [OpenActive::Enums::GenderRestrictionType,nil]
@@ -138,6 +143,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",
@@ -148,17 +159,6 @@ module OpenActive
         "OpenActive::Models::Offer[]",
       ]
 
-      # @return [OpenActive::Models::Person,OpenActive::Models::Organization]
-      define_property :organizer, as: "organizer", types: [
-        "OpenActive::Models::Person",
-        "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",
@@ -181,16 +181,14 @@ module OpenActive
         "string",
       ]
 
-      # @return [Date,DateTime,nil]
+      # @return [DateTime,nil]
       define_property :start_date, as: "startDate", types: [
-        "Date",
         "DateTime",
         "null",
       ]
 
-      # @return [Date,DateTime,nil]
+      # @return [DateTime,nil]
       define_property :end_date, as: "endDate", types: [
-        "Date",
         "DateTime",
         "null",
       ]
@@ -210,9 +208,9 @@ module OpenActive
         "URI",
       ]
 
-      # @return [Array<OpenActive::Models::SportsActivityLocation>]
+      # @return [Array<OpenActive::Models::Schema::SportsActivityLocation>]
       define_property :sports_activity_location, as: "beta:sportsActivityLocation", types: [
-        "OpenActive::Models::SportsActivityLocation[]",
+        "OpenActive::Models::Schema::SportsActivityLocation[]",
       ]
     end
   end

data/lib/openactive/models/tax_charge_specification.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [PriceSpecification](https://schema.org/PriceSpecification), 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/PriceSpecification, which means that any of this type's properties within schema.org may also be used.
     class TaxChargeSpecification < ::OpenActive::Models::PriceSpecification
       # @!attribute type
       # @return [String]
@@ -22,6 +22,12 @@ module OpenActive
         "string",
       ]
 
+      # @return [OpenActive::Enums::RequiredStatusType,nil]
+      define_property :open_booking_prepayment, as: "openBookingPrepayment", types: [
+        "OpenActive::Enums::RequiredStatusType",
+        "null",
+      ]
+
       # @return [BigDecimal,nil]
       define_property :price, as: "price", types: [
         "Number",

data/lib/openactive/models/temporarily_unable_to_create_order_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Booking System is unable for technical reasons to create an `Order` where the data provided to it is sufficient to allow it to do so.
+    #
+    # 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 TemporarilyUnableToCreateOrderError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "TemporarilyUnableToCreateOrderError"
       end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [int,nil]
+      define_property :status_code, as: "statusCode", types: [
+        "int",
+        "null",
+      ]
     end
   end
 end

data/lib/openactive/models/temporarily_unable_to_delete_order_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Booking System is unable for technical reasons to delete an `Order` where the data provided to it is sufficient to allow it to do so.
+    #
+    # 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 TemporarilyUnableToDeleteOrderError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "TemporarilyUnableToDeleteOrderError"
       end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [int,nil]
+      define_property :status_code, as: "statusCode", types: [
+        "int",
+        "null",
+      ]
     end
   end
 end

data/lib/openactive/models/temporarily_unable_to_produce_order_quote_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Booking System is unable for technical reasons to produce an `OrderQuote` where the data provided to it is sufficient to allow it to do so.
+    #
+    # 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 TemporarilyUnableToProduceOrderQuoteError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "TemporarilyUnableToProduceOrderQuoteError"
       end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [int,nil]
+      define_property :status_code, as: "statusCode", types: [
+        "int",
+        "null",
+      ]
     end
   end
 end

data/lib/openactive/models/temporarily_unable_to_update_order_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Booking System is unable for technical reasons to update an `Order` (which includes processing the PATCH for cancellation) where the data provided to it is sufficient to allow it to do so.
+    #
+    # 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 TemporarilyUnableToUpdateOrderError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "TemporarilyUnableToUpdateOrderError"
       end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [int,nil]
+      define_property :status_code, as: "statusCode", types: [
+        "int",
+        "null",
+      ]
     end
   end
 end

data/lib/openactive/models/terms.rb

@@ -1,5 +1,6 @@
 module OpenActive
   module Models
+    # This type is derived from https://schema.org/DigitalDocument, which means that any of this type's properties within schema.org may also be used.
     class Terms < ::OpenActive::Models::Schema::DigitalDocument
       # @!attribute type
       # @return [String]
@@ -12,6 +13,12 @@ module OpenActive
         "string",
       ]
 
+      # @return [DateTime,nil]
+      define_property :date_modified, as: "dateModified", types: [
+        "DateTime",
+        "null",
+      ]
+
       # @return [Boolean,nil]
       define_property :requires_explicit_consent, as: "requiresExplicitConsent", types: [
         "bool",

data/lib/openactive/models/terms_of_use.rb

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

data/lib/openactive/models/toilets.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 Toilets < ::OpenActive::Models::LocationFeatureSpecification
       # @!attribute type
       # @return [String]

data/lib/openactive/models/too_many_requests_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Booking System is rate-limiting the Broker.
+    #
+    # 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 TooManyRequestsError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "TooManyRequestsError"
       end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [int,nil]
+      define_property :status_code, as: "statusCode", types: [
+        "int",
+        "null",
+      ]
     end
   end
 end

data/lib/openactive/models/total_payment_due_mismatch_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The `totalPaymentDue` property of the submitted `Order` or `OrderProposal` does not match the value calculated for that `Order` or `OrderProposal` by the Booking System.
+    #
+    # 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 TotalPaymentDueMismatchError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "TotalPaymentDueMismatchError"
       end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [int,nil]
+      define_property :status_code, as: "statusCode", types: [
+        "int",
+        "null",
+      ]
     end
   end
 end

data/lib/openactive/models/towels.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 Towels < ::OpenActive::Models::LocationFeatureSpecification
       # @!attribute type
       # @return [String]

data/lib/openactive/models/trust_certification.rb

@@ -0,0 +1,18 @@
+module OpenActive
+  module Models
+    # [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/Thing, which means that any of this type's properties within schema.org may also be used.
+    class TrustCertification < ::OpenActive::Models::Schema::Thing
+      # @!attribute type
+      # @return [String]
+      def type
+        "beta:TrustCertification"
+      end
+
+      # @return [OpenActive::Models::CertificationLevel]
+      define_property :certification_level, as: "beta:certificationLevel", types: [
+        "OpenActive::Models::CertificationLevel",
+      ]
+    end
+  end
+end