openactive 0.1.0 → 0.2.2

data/lib/openactive/models/on_demand_event.rb

@@ -0,0 +1,86 @@
+module OpenActive
+  module Models
+    # This type is derived from https://schema.org/OnDemandEvent, which means that any of this type's properties within schema.org may also be used.
+    class OnDemandEvent < ::OpenActive::Models::Event
+      # @!attribute type
+      # @return [String]
+      def type
+        "OnDemandEvent"
+      end
+
+      # @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]
+      define_property :event_status, as: "eventStatus", types: [
+        "OpenActive::Enums::Schema::EventStatusType",
+        "null",
+      ]
+
+      # @return [OpenActive::Models::Place]
+      define_property :location, as: "location", types: [
+        "OpenActive::Models::Place",
+      ]
+
+      # @return [int,nil]
+      define_property :maximum_attendee_capacity, as: "maximumAttendeeCapacity", types: [
+        "int",
+        "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",
+      ]
+
+      # @return [int,nil]
+      define_property :remaining_attendee_capacity, as: "remainingAttendeeCapacity", types: [
+        "int",
+        "null",
+      ]
+
+      # @return [String]
+      define_property :scheduling_note, as: "schedulingNote", types: [
+        "string",
+      ]
+
+      # @return [Date,DateTime,nil]
+      define_property :start_date, as: "startDate", types: [
+        "Date",
+        "DateTime",
+        "null",
+      ]
+
+      # @return [Date,DateTime,nil]
+      define_property :end_date, as: "endDate", types: [
+        "Date",
+        "DateTime",
+        "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::MediaObject]
+      define_property :work_featured, as: "workFeatured", types: [
+        "OpenActive::Models::MediaObject",
+      ]
+    end
+  end
+end

data/lib/openactive/models/open_booking_error.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 OpenBookingError < ::OpenActive::Models::Schema::Thing
       # @!attribute type
       # @return [String]
@@ -22,16 +23,6 @@ module OpenActive
         "URI",
       ]
 
-      # @return [Array<String>]
-      define_property :invalid_params, as: "invalidParams", types: [
-        "string[]",
-      ]
-
-      # @return [String]
-      define_property :method, as: "method", types: [
-        "string",
-      ]
-
       # @return [String]
       define_property :request_id, as: "requestId", types: [
         "string",

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

data/lib/openactive/models/opening_hours_specification.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [OpeningHoursSpecification](https://schema.org/OpeningHoursSpecification), 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/OpeningHoursSpecification, which means that any of this type's properties within schema.org may also be used.
     class OpeningHoursSpecification < ::OpenActive::Models::Schema::OpeningHoursSpecification
       # @!attribute type
       # @return [String]
@@ -14,9 +14,9 @@ module OpenActive
         "null",
       ]
 
-      # @return [OpenActive::Enums::Schema::DayOfWeek,nil]
+      # @return [Array<OpenActive::Enums::Schema::DayOfWeek>,nil]
       define_property :day_of_week, as: "dayOfWeek", types: [
-        "OpenActive::Enums::Schema::DayOfWeek",
+        "OpenActive::Enums::Schema::DayOfWeek[]",
         "null",
       ]
 
@@ -25,6 +25,18 @@ module OpenActive
         "Time",
         "null",
       ]
+
+      # @return [Date,nil]
+      define_property :valid_from, as: "validFrom", types: [
+        "Date",
+        "null",
+      ]
+
+      # @return [Date,nil]
+      define_property :valid_through, as: "validThrough", types: [
+        "Date",
+        "null",
+      ]
     end
   end
 end

data/lib/openactive/models/opportunity_capacity_is_reserved_by_lease_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The available capacity required to book a specific Opportunity is reserved by a lease held by another Customer.  If the `OrderItem` is repeated (for multiple attendees) this error MUST only be included in the API response against the `OrderItem`s which are in excess of the capacity but which are reserved by the lease of another Customer - for example in an Opportunity with a `remainingAttendeeCapacity` of 3, with 1 additional space held by another lease, then for an `OrderQuote` with 9 `OrderItem`s related to it, this error would only be emitted against 1 of the `OrderItem`s, with `OpportunityHasInsufficientCapacityError` emitted against the other 5 of the `OrderItem`s. This helps a Customer to know whether they should try again.
+    #
+    # 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 OpportunityCapacityIsReservedByLeaseError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "OpportunityCapacityIsReservedByLeaseError"
       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/opportunity_has_insufficient_capacity_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: There are not enough available spaces in the Opportunity contained in the `orderedItem` property of the `OrderItem` to fulfil the number of repeated `OrderItem`s.  If the `OrderItem` is repeated (for multiple attendees) this error MUST only be included in the API response against the `OrderItem`s which are in excess of the capacity - for example in an Opportunity with a `remainingAttendeeCapacity` of 2 and with 5 `OrderItem`s related to it, this error would only be emitted against 3 of the `OrderItem`s.
+    #
+    # 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 OpportunityHasInsufficientCapacityError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "OpportunityHasInsufficientCapacityError"
       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/opportunity_intractable_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: The `orderedItem` and `acceptedOffer` combination specified currently cannot be booked due to an inconsistent state within 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 OpportunityIntractableError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "OpportunityIntractableError"
+      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/opportunity_is_full_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: There are no available spaces for the Opportunity contained in the `orderedItem` property.
+    #
+    # 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 OpportunityIsFullError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "OpportunityIsFullError"
       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/opportunity_is_in_conflict_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The specific `OrderItem`s against which this error is emitted are not able to be booked together.
+    #
+    # 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 OpportunityIsInConflictError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "OpportunityIsInConflictError"
       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/opportunity_offer_pair_not_bookable_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: The `orderedItem` and `acceptedOffer` combination specified are not bookable, as defined in the Open Booking API specification.
+    #
+    # 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 OpportunityOfferPairNotBookableError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "OpportunityOfferPairNotBookableError"
+      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.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 Order < ::OpenActive::Models::Schema::Order
       # @!attribute type
       # @return [String]
@@ -8,13 +8,9 @@ module OpenActive
         "Order"
       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 [OpenActive::Models::BookingService]
@@ -65,10 +61,11 @@ module OpenActive
         "OpenActive::Models::Payment",
       ]
 
-      # @return [OpenActive::Models::Person,OpenActive::Models::Organization]
+      # @return [OpenActive::Models::Person,OpenActive::Models::Organization,URI]
       define_property :seller, as: "seller", types: [
         "OpenActive::Models::Person",
         "OpenActive::Models::Organization",
+        "URI",
       ]
 
       # @return [Boolean,nil]

data/lib/openactive/models/order_already_exists_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Order UUID used for an `OrderQuote` already represents a completed `Order` with a different set of `OrderItem`s to those specified (note call to B is idempotent for the case where `OrderItem`s match). This happens in the rare event of a Order UUID clash.
+    #
+    # 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 OrderAlreadyExistsError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "OrderAlreadyExistsError"
       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_creation_failed_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: B failed for a reason not specified by a defined type of error in the Open Booking API specification.
+    #
+    # 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 OrderCreationFailedError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "OrderCreationFailedError"
       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_item.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # This type is derived from [OrderItem](https://schema.org/OrderItem), 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/OrderItem, which means that any of this type's properties within schema.org may also be used.
     class OrderItem < ::OpenActive::Models::Schema::OrderItem
       # @!attribute type
       # @return [String]
@@ -8,9 +8,15 @@ module OpenActive
         "OrderItem"
       end
 
-      # @return [OpenActive::Models::Offer]
+      # @return [OpenActive::Models::Offer,URI]
       define_property :accepted_offer, as: "acceptedOffer", types: [
         "OpenActive::Models::Offer",
+        "URI",
+      ]
+
+      # @return [OpenActive::Models::VirtualLocation]
+      define_property :access_channel, as: "accessChannel", types: [
+        "OpenActive::Models::VirtualLocation",
       ]
 
       # @return [Array<OpenActive::Models::PropertyValue>]
@@ -19,29 +25,19 @@ module OpenActive
       ]
 
       # @return [Array<OpenActive::Models::ImageObject>]
-      define_property :access_token, as: "accessToken", types: [
+      define_property :access_pass, as: "accessPass", types: [
         "OpenActive::Models::ImageObject[]",
       ]
 
-      # @return [Array<OpenActive::Models::PropertyValue>]
-      define_property :additional_property, as: "additionalProperty", types: [
-        "OpenActive::Models::PropertyValue[]",
-      ]
-
-      # @return [Boolean,nil]
-      define_property :allow_customer_cancellation_full_refund, as: "allowCustomerCancellationFullRefund", types: [
-        "bool",
-        "null",
-      ]
-
       # @return [OpenActive::Models::Person]
       define_property :attendee, as: "attendee", types: [
         "OpenActive::Models::Person",
       ]
 
-      # @return [Array<URI>]
+      # @return [Array<OpenActive::Enums::PropertyEnumeration>,nil]
       define_property :attendee_details_required, as: "attendeeDetailsRequired", types: [
-        "URI[]",
+        "OpenActive::Enums::PropertyEnumeration[]",
+        "null",
       ]
 
       # @return [String]
@@ -59,9 +55,10 @@ module OpenActive
         "OpenActive::Models::OpenBookingError[]",
       ]
 
-      # @return [OpenActive::Models::Event]
+      # @return [OpenActive::Models::Event,URI]
       define_property :ordered_item, as: "orderedItem", types: [
         "OpenActive::Models::Event",
+        "URI",
       ]
 
       # @return [Array<OpenActive::Models::PropertyValueSpecification>]
@@ -80,6 +77,12 @@ module OpenActive
         "null",
       ]
 
+      # @return [int,nil]
+      define_property :position, as: "position", types: [
+        "int",
+        "null",
+      ]
+
       # @return [Array<OpenActive::Models::TaxChargeSpecification>]
       define_property :unit_tax_specification, as: "unitTaxSpecification", types: [
         "OpenActive::Models::TaxChargeSpecification[]",