openactive 0.1.2 → 0.2.0

data/lib/openactive/models/order_proposal.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Order](https://schema.org/Order), 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/Order, which means that any of this type's properties within schema.org may also be used.
     class OrderProposal < ::OpenActive::Models::OrderQuote
       # @!attribute type
       # @return [String]
@@ -19,6 +19,12 @@ module OpenActive
         "null",
       ]
 
+      # @return [Boolean,nil]
+      define_property :order_requires_approval, as: "orderRequiresApproval", types: [
+        "bool",
+        "null",
+      ]
+
       # @return [String]
       define_property :order_seller_note, as: "orderSellerNote", types: [
         "string",

data/lib/openactive/models/order_proposal_version_outdated_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: B failed due to a newer version of the `OrderProposal` existing than that specified by the Broker in `orderProposalVersion`.
+    #
+    # 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 OrderProposalVersionOutdatedError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "OrderProposalVersionOutdatedError"
+      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/order_quote.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Order](https://schema.org/Order), 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/Order, which means that any of this type's properties within schema.org may also be used.
     class OrderQuote < ::OpenActive::Models::Order
       # @!attribute type
       # @return [String]
@@ -13,21 +13,11 @@ module OpenActive
         "OpenActive::Models::Lease",
       ]
 
-      # @return [URI]
-      define_property :order_proposal_version, as: "orderProposalVersion", types: [
-        "URI",
-      ]
-
       # @return [Boolean,nil]
       define_property :order_requires_approval, as: "orderRequiresApproval", types: [
         "bool",
         "null",
       ]
-
-      # @return [OpenActive::Models::Payment]
-      define_property :payment, as: "payment", types: [
-        "OpenActive::Models::Payment",
-      ]
     end
   end
 end

data/lib/openactive/models/organization.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Organization](https://schema.org/Organization), 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/Organization, which means that any of this type's properties within schema.org may also be used.
     class Organization < ::OpenActive::Models::Schema::Organization
       # @!attribute type
       # @return [String]
@@ -37,6 +37,12 @@ module OpenActive
         "string",
       ]
 
+      # @return [Boolean,nil]
+      define_property :is_open_booking_allowed, as: "isOpenBookingAllowed", types: [
+        "bool",
+        "null",
+      ]
+
       # @return [String]
       define_property :legal_name, as: "legalName", types: [
         "string",
@@ -78,15 +84,20 @@ module OpenActive
         "string",
       ]
 
-      # @return [Array<OpenActive::Models::Schema::VideoObject>]
-      define_property :video, as: "beta:video", types: [
-        "OpenActive::Models::Schema::VideoObject[]",
-      ]
-
       # @return [String]
       define_property :formatted_description, as: "beta:formattedDescription", types: [
         "string",
       ]
+
+      # @return [Array<OpenActive::Models::VideoObject>]
+      define_property :video, as: "beta:video", types: [
+        "OpenActive::Models::VideoObject[]",
+      ]
+
+      # @return [Array<URI>]
+      define_property :formal_criteria_met, as: "beta:formalCriteriaMet", types: [
+        "URI[]",
+      ]
     end
   end
 end

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

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

data/lib/openactive/models/partial_schedule.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Schedule](https://pending.schema.org/Schedule), 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://pending.schema.org/Schedule.
     class PartialSchedule < ::OpenActive::Models::Schedule
       # @!attribute type
       # @return [String]
@@ -8,6 +8,21 @@ module OpenActive
         "PartialSchedule"
       end
 
+      # @return [String]
+      define_property :id_template, as: "idTemplate", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :scheduled_event_type, as: "scheduledEventType", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :url_template, as: "urlTemplate", types: [
+        "string",
+      ]
+
       # @return [String]
       define_property :time_zone, as: "beta:timeZone", types: [
         "string",

data/lib/openactive/models/patch_contains_excessive_properties_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: The Booking System recognises a PATCH request but the request object contains properties that the Broker is not permitted to update. Custom namespace properties are always excluded from consideration.
+    #
+    # 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 PatchContainsExcessivePropertiesError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "PatchContainsExcessivePropertiesError"
+      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/patch_not_allowed_on_property_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: The Booking System recognises a PATCH request but the request object contains one or many properties that the Broker is not permitted to update to the requested value.
+    #
+    # 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 PatchNotAllowedOnPropertyError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "PatchNotAllowedOnPropertyError"
+      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/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 Payment < ::OpenActive::Models::Schema::Thing
       # @!attribute type
       # @return [String]
@@ -7,13 +8,9 @@ module OpenActive
         "Payment"
       end
 
-      # @return [int,String,OpenActive::Models::PropertyValue,Array<OpenActive::Models::PropertyValue>,nil]
+      # @return [String]
       define_property :identifier, as: "identifier", types: [
-        "int",
         "string",
-        "OpenActive::Models::PropertyValue",
-        "OpenActive::Models::PropertyValue[]",
-        "null",
       ]
 
       # @return [String]
@@ -26,9 +23,14 @@ module OpenActive
         "string",
       ]
 
-      # @return [OpenActive::Enums::Schema::PaymentMethod,nil]
+      # @return [Array<OpenActive::Models::PropertyValue>]
+      define_property :additional_property, as: "additionalProperty", types: [
+        "OpenActive::Models::PropertyValue[]",
+      ]
+
+      # @return [OpenActive::Enums::PaymentMethod,nil]
       define_property :payment_method, as: "paymentMethod", types: [
-        "OpenActive::Enums::Schema::PaymentMethod",
+        "OpenActive::Enums::PaymentMethod",
         "null",
       ]
 

data/lib/openactive/models/person.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Person](https://schema.org/Person), 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/Person, which means that any of this type's properties within schema.org may also be used.
     class Person < ::OpenActive::Models::Schema::Person
       # @!attribute type
       # @return [String]
@@ -53,6 +53,12 @@ module OpenActive
         "string",
       ]
 
+      # @return [Boolean,nil]
+      define_property :is_open_booking_allowed, as: "isOpenBookingAllowed", types: [
+        "bool",
+        "null",
+      ]
+
       # @return [String]
       define_property :job_title, as: "jobTitle", types: [
         "string",
@@ -103,6 +109,11 @@ module OpenActive
       define_property :formatted_description, as: "beta:formattedDescription", types: [
         "string",
       ]
+
+      # @return [Array<URI>]
+      define_property :formal_criteria_met, as: "beta:formalCriteriaMet", types: [
+        "URI[]",
+      ]
     end
   end
 end

data/lib/openactive/models/place.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Place](https://schema.org/Place), 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/Place, which means that any of this type's properties within schema.org may also be used.
     class Place < ::OpenActive::Models::Schema::Place
       # @!attribute type
       # @return [String]
@@ -63,6 +63,11 @@ module OpenActive
         "OpenActive::Models::OpeningHoursSpecification[]",
       ]
 
+      # @return [Array<OpenActive::Models::OpeningHoursSpecification>]
+      define_property :special_opening_hours_specification, as: "specialOpeningHoursSpecification", types: [
+        "OpenActive::Models::OpeningHoursSpecification[]",
+      ]
+
       # @return [String]
       define_property :telephone, as: "telephone", types: [
         "string",

data/lib/openactive/models/postal_address.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [PostalAddress](https://schema.org/PostalAddress), 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/PostalAddress, which means that any of this type's properties within schema.org may also be used.
     class PostalAddress < ::OpenActive::Models::Schema::PostalAddress
       # @!attribute type
       # @return [String]

data/lib/openactive/models/price_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 PriceSpecification < ::OpenActive::Models::Schema::PriceSpecification
       # @!attribute type
       # @return [String]
@@ -8,6 +8,12 @@ module OpenActive
         "PriceSpecification"
       end
 
+      # @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/privacy_policy.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 PrivacyPolicy < ::OpenActive::Models::Terms
       # @!attribute type
       # @return [String]

data/lib/openactive/models/property_value.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [PropertyValue](https://schema.org/PropertyValue), 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/PropertyValue, which means that any of this type's properties within schema.org may also be used.
     class PropertyValue < ::OpenActive::Models::Schema::PropertyValue
       # @!attribute type
       # @return [String]
@@ -24,9 +24,9 @@ module OpenActive
         "URI",
       ]
 
-      # @return [int,String,nil]
+      # @return [Boolean,String,nil]
       define_property :value, as: "value", types: [
-        "int",
+        "bool",
         "string",
         "null",
       ]

data/lib/openactive/models/property_value_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 PropertyValueSpecification < ::OpenActive::Models::Schema::PropertyValueSpecification
       # @!attribute type
       # @return [String]
@@ -18,9 +18,10 @@ module OpenActive
         "string",
       ]
 
-      # @return [String]
+      # @return [Boolean,nil]
       define_property :value_required, as: "valueRequired", types: [
-        "string",
+        "bool",
+        "null",
       ]
     end
   end

data/lib/openactive/models/quantitative_value.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [QuantitativeValue](https://schema.org/QuantitativeValue), 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/QuantitativeValue, which means that any of this type's properties within schema.org may also be used.
     class QuantitativeValue < ::OpenActive::Models::Schema::QuantitativeValue
       # @!attribute type
       # @return [String]

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

data/lib/openactive/models/schedule.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [Schedule](https://pending.schema.org/Schedule), 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://pending.schema.org/Schedule.
     class Schedule < ::OpenActive::JsonLdModel
       # @!attribute type
       # @return [String]
@@ -46,9 +46,9 @@ module OpenActive
         "null",
       ]
 
-      # @return [URI]
+      # @return [String]
       define_property :id_template, as: "idTemplate", types: [
-        "URI",
+        "string",
       ]
 
       # @return [int,nil]
@@ -68,6 +68,11 @@ module OpenActive
         "string",
       ]
 
+      # @return [String]
+      define_property :schedule_timezone, as: "scheduleTimezone", types: [
+        "string",
+      ]
+
       # @return [Date,nil]
       define_property :start_date, as: "startDate", types: [
         "Date",
@@ -86,9 +91,9 @@ module OpenActive
         "null",
       ]
 
-      # @return [URI]
+      # @return [String]
       define_property :url_template, as: "urlTemplate", types: [
-        "URI",
+        "string",
       ]
 
       # @return [String]