openactive 0.2.2 → 0.4.0

data/lib/openactive/models/customer_account.rb

@@ -0,0 +1,52 @@
+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 STILL SUBJECT TO CHANGE, as the [Customer Accounts proposal](https://github.com/openactive/customer-accounts) evolves.
+    #
+    # 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 CustomerAccount < ::OpenActive::Models::Schema::Thing
+      # @!attribute type
+      # @return [String]
+      def type
+        "CustomerAccount"
+      end
+
+      # @return [String]
+      define_property :identifier, as: "identifier", types: [
+        "string",
+      ]
+
+      # @return [Array<OpenActive::Models::Barcode>]
+      define_property :access_pass, as: "accessPass", types: [
+        "OpenActive::Models::Barcode[]",
+      ]
+
+      # @return [String]
+      define_property :account_number, as: "accountNumber", types: [
+        "string",
+      ]
+
+      # @return [OpenActive::Models::Organization,OpenActive::Models::Person]
+      define_property :customer, as: "customer", types: [
+        "OpenActive::Models::Organization",
+        "OpenActive::Models::Person",
+      ]
+
+      # @return [Array<OpenActive::Models::Entitlement>]
+      define_property :entitlement, as: "entitlement", types: [
+        "OpenActive::Models::Entitlement[]",
+      ]
+
+      # @return [Boolean,nil]
+      define_property :has_hidden_entitlements, as: "hasHiddenEntitlements", types: [
+        "bool",
+        "null",
+      ]
+
+      # @return [Array<OpenActive::Models::Action>]
+      define_property :outstanding_action, as: "outstandingAction", types: [
+        "OpenActive::Models::Action[]",
+      ]
+    end
+  end
+end

data/lib/openactive/models/entitlement.rb

@@ -0,0 +1,38 @@
+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 STILL SUBJECT TO CHANGE, as the [Customer Accounts proposal](https://github.com/openactive/customer-accounts) evolves.
+    #
+    # This type is derived from https://schema.org/Permit, which means that any of this type's properties within schema.org may also be used.
+    class Entitlement < ::OpenActive::Models::Schema::Permit
+      # @!attribute type
+      # @return [String]
+      def type
+        "Entitlement"
+      end
+
+      # @return [OpenActive::Models::Concept,URI]
+      define_property :entitlement_type, as: "entitlementType", types: [
+        "OpenActive::Models::Concept",
+        "URI",
+      ]
+
+      # @return [OpenActive::Models::Action]
+      define_property :evidence_request_action, as: "evidenceRequestAction", types: [
+        "OpenActive::Models::Action",
+      ]
+
+      # @return [Date,nil]
+      define_property :valid_from, as: "validFrom", types: [
+        "Date",
+        "null",
+      ]
+
+      # @return [Date,nil]
+      define_property :valid_until, as: "validUntil", types: [
+        "Date",
+        "null",
+      ]
+    end
+  end
+end

data/lib/openactive/models/event.rb

@@ -73,6 +73,11 @@ module OpenActive
         "OpenActive::Models::Person[]",
       ]
 
+      # @return [Array<String>]
+      define_property :customer_account_booking_restriction, as: "customerAccountBookingRestriction", types: [
+        "string[]",
+      ]
+
       # @return [ActiveSupport::Duration,nil]
       define_property :duration, as: "duration", types: [
         "DateInterval",
@@ -114,6 +119,12 @@ module OpenActive
         "null",
       ]
 
+      # @return [Boolean,nil]
+      define_property :is_open_booking_with_customer_account_allowed, as: "isOpenBookingWithCustomerAccountAllowed", types: [
+        "bool",
+        "null",
+      ]
+
       # @return [Array<OpenActive::Models::Person>]
       define_property :leader, as: "leader", types: [
         "OpenActive::Models::Person[]",
@@ -125,9 +136,10 @@ module OpenActive
         "OpenActive::Models::Concept[]",
       ]
 
-      # @return [OpenActive::Models::Place]
+      # @return [OpenActive::Models::Place,URI]
       define_property :location, as: "location", types: [
         "OpenActive::Models::Place",
+        "URI",
       ]
 
       # @return [int,nil]
@@ -174,16 +186,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",
       ]
@@ -241,9 +251,9 @@ module OpenActive
         "OpenActive::Models::VideoObject[]",
       ]
 
-      # @return [Array<OpenActive::Models::Schema::SportsActivityLocation>]
+      # @return [Array<OpenActive::Models::SportsActivityLocation>]
       define_property :sports_activity_location, as: "beta:sportsActivityLocation", types: [
-        "OpenActive::Models::Schema::SportsActivityLocation[]",
+        "OpenActive::Models::SportsActivityLocation[]",
       ]
 
       # @return [ActiveSupport::Duration,nil]
@@ -297,6 +307,12 @@ module OpenActive
         "null",
       ]
 
+      # @return [Boolean,nil]
+      define_property :is_scheduled_as_slots, as: "beta:isScheduledAsSlots", types: [
+        "bool",
+        "null",
+      ]
+
       # @return [OpenActive::Models::Schema::ContactPoint]
       define_property :contact_point, as: "beta:contactPoint", types: [
         "OpenActive::Models::Schema::ContactPoint",

data/lib/openactive/models/event_series.rb

@@ -8,16 +8,14 @@ module OpenActive
         "EventSeries"
       end
 
-      # @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",
       ]

data/lib/openactive/models/facility_use.rb

@@ -58,11 +58,21 @@ module OpenActive
         "OpenActive::Models::Concept[]",
       ]
 
+      # @return [Array<String>]
+      define_property :customer_account_booking_restriction, as: "customerAccountBookingRestriction", types: [
+        "string[]",
+      ]
+
       # @return [Array<OpenActive::Models::Slot>]
       define_property :event, as: "event", types: [
         "OpenActive::Models::Slot[]",
       ]
 
+      # @return [Array<OpenActive::Models::Concept>]
+      define_property :facility_type, as: "facilityType", types: [
+        "OpenActive::Models::Concept[]",
+      ]
+
       # @return [Array<OpenActive::Models::OpeningHoursSpecification>]
       define_property :hours_available, as: "hoursAvailable", types: [
         "OpenActive::Models::OpeningHoursSpecification[]",
@@ -78,9 +88,16 @@ module OpenActive
         "OpenActive::Models::IndividualFacilityUse[]",
       ]
 
-      # @return [OpenActive::Models::Place]
+      # @return [Boolean,nil]
+      define_property :is_open_booking_with_customer_account_allowed, as: "isOpenBookingWithCustomerAccountAllowed", types: [
+        "bool",
+        "null",
+      ]
+
+      # @return [OpenActive::Models::Place,URI]
       define_property :location, as: "location", types: [
         "OpenActive::Models::Place",
+        "URI",
       ]
 
       # @return [Array<OpenActive::Models::Offer>]
@@ -114,9 +131,9 @@ module OpenActive
         "OpenActive::Models::VideoObject[]",
       ]
 
-      # @return [Array<OpenActive::Models::Schema::SportsActivityLocation>]
+      # @return [Array<OpenActive::Models::SportsActivityLocation>]
       define_property :sports_activity_location, as: "beta:sportsActivityLocation", types: [
-        "OpenActive::Models::Schema::SportsActivityLocation[]",
+        "OpenActive::Models::SportsActivityLocation[]",
       ]
 
       # @return [ActiveSupport::Duration,nil]
@@ -126,7 +143,7 @@ module OpenActive
       ]
 
       # @return [Array<OpenActive::Models::Concept>]
-      define_property :facility_type, as: "beta:facilityType", types: [
+      define_property :facility_attribute, as: "beta:facilityAttribute", types: [
         "OpenActive::Models::Concept[]",
       ]
 

data/lib/openactive/models/file_upload_form_field_specification.rb

@@ -0,0 +1,12 @@
+module OpenActive
+  module Models
+    # 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 FileUploadFormFieldSpecification < ::OpenActive::Models::PropertyValueSpecification
+      # @!attribute type
+      # @return [String]
+      def type
+        "FileUploadFormFieldSpecification"
+      end
+    end
+  end
+end

data/lib/openactive/models/offer.rb

@@ -49,6 +49,11 @@ module OpenActive
         "null",
       ]
 
+      # @return [Array<OpenActive::Models::Concept>]
+      define_property :eligible_entitlement_type, as: "eligibleEntitlementType", types: [
+        "OpenActive::Models::Concept[]",
+      ]
+
       # @return [ActiveSupport::Duration,nil]
       define_property :latest_cancellation_before_start_date, as: "latestCancellationBeforeStartDate", types: [
         "DateInterval",
@@ -95,6 +100,12 @@ module OpenActive
         "null",
       ]
 
+      # @return [ActiveSupport::Duration,nil]
+      define_property :valid_through_before_start_date, as: "validThroughBeforeStartDate", types: [
+        "DateInterval",
+        "null",
+      ]
+
       # @return [OpenActive::Models::QuantitativeValue]
       define_property :party_size, as: "beta:partySize", types: [
         "OpenActive::Models::QuantitativeValue",

data/lib/openactive/models/offer_override.rb

@@ -24,6 +24,11 @@ module OpenActive
         "null",
       ]
 
+      # @return [Array<OpenActive::Models::Concept>]
+      define_property :eligible_entitlement_type, as: "eligibleEntitlementType", types: [
+        "OpenActive::Models::Concept[]",
+      ]
+
       # @return [ActiveSupport::Duration,nil]
       define_property :latest_cancellation_before_start_date, as: "latestCancellationBeforeStartDate", types: [
         "DateInterval",
@@ -47,6 +52,12 @@ module OpenActive
         "DateInterval",
         "null",
       ]
+
+      # @return [ActiveSupport::Duration,nil]
+      define_property :valid_through_before_start_date, as: "validThroughBeforeStartDate", types: [
+        "DateInterval",
+        "null",
+      ]
     end
   end
 end

data/lib/openactive/models/on_demand_event.rb

@@ -20,9 +20,10 @@ module OpenActive
         "null",
       ]
 
-      # @return [OpenActive::Models::Place]
+      # @return [OpenActive::Models::Place,URI]
       define_property :location, as: "location", types: [
         "OpenActive::Models::Place",
+        "URI",
       ]
 
       # @return [int,nil]
@@ -53,16 +54,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",
       ]

data/lib/openactive/models/organization.rb

@@ -37,6 +37,12 @@ module OpenActive
         "string",
       ]
 
+      # @return [OpenActive::Models::CustomerAccount,URI]
+      define_property :has_account, as: "hasAccount", types: [
+        "OpenActive::Models::CustomerAccount",
+        "URI",
+      ]
+
       # @return [Boolean,nil]
       define_property :is_open_booking_allowed, as: "isOpenBookingAllowed", types: [
         "bool",

data/lib/openactive/models/person.rb

@@ -37,13 +37,19 @@ module OpenActive
         "string",
       ]
 
+      # @return [OpenActive::Models::Person]
+      define_property :emergency_contact, as: "emergencyContact", types: [
+        "OpenActive::Models::Person",
+      ]
+
       # @return [String]
       define_property :family_name, as: "familyName", types: [
         "string",
       ]
 
-      # @return [OpenActive::Enums::Schema::GenderType,nil]
+      # @return [String,OpenActive::Enums::Schema::GenderType,nil]
       define_property :gender, as: "gender", types: [
+        "string",
         "OpenActive::Enums::Schema::GenderType",
         "null",
       ]
@@ -53,6 +59,12 @@ module OpenActive
         "string",
       ]
 
+      # @return [OpenActive::Models::CustomerAccount,URI]
+      define_property :has_account, as: "hasAccount", types: [
+        "OpenActive::Models::CustomerAccount",
+        "URI",
+      ]
+
       # @return [Boolean,nil]
       define_property :is_open_booking_allowed, as: "isOpenBookingAllowed", types: [
         "bool",

data/lib/openactive/models/place.rb

@@ -38,9 +38,10 @@ module OpenActive
         "OpenActive::Models::LocationFeatureSpecification[]",
       ]
 
-      # @return [OpenActive::Models::Place]
+      # @return [OpenActive::Models::Place,URI]
       define_property :contained_in_place, as: "containedInPlace", types: [
         "OpenActive::Models::Place",
+        "URI",
       ]
 
       # @return [Array<OpenActive::Models::Place>]
@@ -48,6 +49,11 @@ module OpenActive
         "OpenActive::Models::Place[]",
       ]
 
+      # @return [String]
+      define_property :email, as: "email", types: [
+        "string",
+      ]
+
       # @return [OpenActive::Models::GeoCoordinates]
       define_property :geo, as: "geo", types: [
         "OpenActive::Models::GeoCoordinates",
@@ -82,6 +88,21 @@ module OpenActive
       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 [OpenActive::Models::Organization]
+      define_property :service_operator, as: "beta:serviceOperator", types: [
+        "OpenActive::Models::Organization",
+      ]
+
+      # @return [Array<OpenActive::Models::Concept>]
+      define_property :place_type, as: "beta:placeType", types: [
+        "OpenActive::Models::Concept[]",
+      ]
     end
   end
 end

data/lib/openactive/models/property_value.rb

@@ -24,9 +24,10 @@ module OpenActive
         "URI",
       ]
 
-      # @return [Boolean,String,nil]
+      # @return [Boolean,URI,String,nil]
       define_property :value, as: "value", types: [
         "bool",
+        "URI",
         "string",
         "null",
       ]

data/lib/openactive/models/scheduled_session.rb

@@ -8,6 +8,12 @@ module OpenActive
         "ScheduledSession"
       end
 
+      # @return [OpenActive::Models::Person,OpenActive::Models::Organization]
+      define_property :organizer, as: "organizer", types: [
+        "OpenActive::Models::Person",
+        "OpenActive::Models::Organization",
+      ]
+
       # @return [DateTime,nil]
       define_property :start_date, as: "startDate", types: [
         "DateTime",

data/lib/openactive/models/schema/accommodation.rb

@@ -8,46 +8,31 @@ module OpenActive
           "schema:Accommodation"
         end
 
+        # @return [int,nil]
+        define_property :number_of_bathrooms_total, as: "numberOfBathroomsTotal", types: [
+          "int",
+          "null",
+        ]
+
         # @return [OpenActive::Models::Schema::QuantitativeValue,BigDecimal,URI,nil]
-        define_property :number_of_bedrooms, as: "numberOfBedrooms", types: [
+        define_property :number_of_rooms, as: "numberOfRooms", types: [
           "OpenActive::Models::Schema::QuantitativeValue",
           "Number",
           "URI",
           "null",
         ]
 
-        # @return [String]
-        define_property :floor_level, as: "floorLevel", types: [
-          "string",
-        ]
-
-        # @return [String]
-        define_property :permitted_usage, as: "permittedUsage", types: [
+        # @return [String,Boolean,nil]
+        define_property :pets_allowed, as: "petsAllowed", types: [
           "string",
-        ]
-
-        # @return [URI]
-        define_property :tour_booking_page, as: "tourBookingPage", types: [
-          "URI",
-        ]
-
-        # @return [BigDecimal,nil]
-        define_property :number_of_partial_bathrooms, as: "numberOfPartialBathrooms", types: [
-          "Number",
+          "bool",
           "null",
         ]
 
-        # @return [ActiveSupport::Duration,OpenActive::Models::Schema::QuantitativeValue,URI,nil]
-        define_property :lease_length, as: "leaseLength", types: [
-          "DateInterval",
+        # @return [OpenActive::Models::Schema::QuantitativeValue,URI]
+        define_property :floor_size, as: "floorSize", types: [
           "OpenActive::Models::Schema::QuantitativeValue",
           "URI",
-          "null",
-        ]
-
-        # @return [String]
-        define_property :accommodation_category, as: "accommodationCategory", types: [
-          "string",
         ]
 
         # @return [OpenActive::Models::Schema::FloorPlan,URI]
@@ -56,18 +41,20 @@ module OpenActive
           "URI",
         ]
 
-        # @return [OpenActive::Models::Schema::QuantitativeValue,URI]
-        define_property :floor_size, as: "floorSize", types: [
-          "OpenActive::Models::Schema::QuantitativeValue",
+        # @return [URI]
+        define_property :tour_booking_page, as: "tourBookingPage", types: [
           "URI",
         ]
 
-        # @return [BigDecimal,OpenActive::Models::Schema::QuantitativeValue,URI,nil]
-        define_property :number_of_rooms, as: "numberOfRooms", types: [
-          "Number",
+        # @return [String]
+        define_property :accommodation_category, as: "accommodationCategory", types: [
+          "string",
+        ]
+
+        # @return [OpenActive::Models::Schema::QuantitativeValue,URI]
+        define_property :occupancy, as: "occupancy", types: [
           "OpenActive::Models::Schema::QuantitativeValue",
           "URI",
-          "null",
         ]
 
         # @return [OpenActive::Models::Schema::LocationFeatureSpecification,URI]
@@ -76,28 +63,55 @@ module OpenActive
           "URI",
         ]
 
-        # @return [int,nil]
-        define_property :number_of_bathrooms_total, as: "numberOfBathroomsTotal", types: [
-          "int",
+        # @return [BigDecimal,nil]
+        define_property :number_of_full_bathrooms, as: "numberOfFullBathrooms", types: [
+          "Number",
           "null",
         ]
 
-        # @return [String,Boolean,nil]
-        define_property :pets_allowed, as: "petsAllowed", types: [
-          "string",
-          "bool",
+        # @return [BigDecimal,nil]
+        define_property :number_of_partial_bathrooms, as: "numberOfPartialBathrooms", types: [
+          "Number",
           "null",
         ]
 
         # @return [BigDecimal,nil]
-        define_property :number_of_full_bathrooms, as: "numberOfFullBathrooms", types: [
+        define_property :year_built, as: "yearBuilt", types: [
           "Number",
           "null",
         ]
 
-        # @return [BigDecimal,nil]
-        define_property :year_built, as: "yearBuilt", types: [
+        # @return [String]
+        define_property :floor_level, as: "floorLevel", types: [
+          "string",
+        ]
+
+        # @return [String]
+        define_property :permitted_usage, as: "permittedUsage", types: [
+          "string",
+        ]
+
+        # @return [OpenActive::Models::Schema::QuantitativeValue,ActiveSupport::Duration,URI,nil]
+        define_property :lease_length, as: "leaseLength", types: [
+          "OpenActive::Models::Schema::QuantitativeValue",
+          "DateInterval",
+          "URI",
+          "null",
+        ]
+
+        # @return [OpenActive::Models::Schema::BedType,OpenActive::Models::Schema::BedDetails,String,URI]
+        define_property :bed, as: "bed", types: [
+          "OpenActive::Models::Schema::BedType",
+          "OpenActive::Models::Schema::BedDetails",
+          "string",
+          "URI",
+        ]
+
+        # @return [OpenActive::Models::Schema::QuantitativeValue,BigDecimal,URI,nil]
+        define_property :number_of_bedrooms, as: "numberOfBedrooms", types: [
+          "OpenActive::Models::Schema::QuantitativeValue",
           "Number",
+          "URI",
           "null",
         ]
       end