openactive 0.1.2 → 0.2.0

data/lib/openactive/models/geo_coordinates.rb

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

data/lib/openactive/models/gone_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: An `Order` has been soft-deleted by an Order Deletion request.
+    #
+    # 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 GoneError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "GoneError"
       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/headline_event.rb

@@ -1,17 +1,12 @@
 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 HeadlineEvent < ::OpenActive::Models::Event
       # @!attribute type
       # @return [String]
       def type
         "HeadlineEvent"
       end
-
-      # @return [Array<OpenActive::Models::Schedule>]
-      define_property :event_schedule, as: "eventSchedule", types: [
-        "OpenActive::Models::Schedule[]",
-      ]
     end
   end
 end

data/lib/openactive/models/image_object.rb

@@ -1,13 +1,23 @@
 module OpenActive
   module Models
-    # This type is derived from [ImageObject](https://schema.org/ImageObject), 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.
-    class ImageObject < ::OpenActive::Models::Schema::ImageObject
+    # This type is derived from https://schema.org/ImageObject, which means that any of this type's properties within schema.org may also be used.
+    class ImageObject < ::OpenActive::Models::MediaObject
       # @!attribute type
       # @return [String]
       def type
         "ImageObject"
       end
 
+      # @return [URI]
+      define_property :content_url, as: "contentUrl", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :embed_url, as: "embedUrl", types: [
+        "URI",
+      ]
+
       # @return [Array<OpenActive::Models::ImageObject>]
       define_property :thumbnail, as: "thumbnail", types: [
         "OpenActive::Models::ImageObject[]",

data/lib/openactive/models/incomplete_attendee_details_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The `attendeeDetailsRequired` properties of the `attendee` are not supplied within a `Person` object.
+    #
+    # 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 IncompleteAttendeeDetailsError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "IncompleteAttendeeDetailsError"
       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/incomplete_broker_details_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The `name` property is not supplied within the `Organisation` object describing the Broker; or the `broker` property supplied is not a valid `Organisation` object.
+    #
+    # 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 IncompleteBrokerDetailsError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "IncompleteBrokerDetailsError"
       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/incomplete_customer_details_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The `email` address of the Customer is not supplied within a `Person` object; or the `customer` property supplied is not a valid `Person` or `Organization` object.
+    #
+    # 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 IncompleteCustomerDetailsError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "IncompleteCustomerDetailsError"
       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/incomplete_intake_form_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The `orderItemIntakeFormResponse` is missing fields that are specified as `valueRequired` within the `orderItemIntakeForm`.
+    #
+    # 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 IncompleteIntakeFormError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "IncompleteIntakeFormError"
       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/incomplete_order_item_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: There is a missing `acceptedOffer` or `orderedItem` property on the `OrderItem`.
+    #
+    # 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 IncompleteOrderItemError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "IncompleteOrderItemError"
       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/incomplete_payment_details_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The `payment` property of the `Order` does not include `identifier`.
+    #
+    # 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 IncompletePaymentDetailsError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "IncompletePaymentDetailsError"
       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/indicative_offer.rb

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

data/lib/openactive/models/individual_facility_use.rb

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

data/lib/openactive/models/internal_application_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: An unexpected exception has been thrown by the application.
+    #
+    # 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 InternalApplicationError < ::OpenActive::Models::InternalOpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "InternalApplicationError"
+      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/internal_library_configuration_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: An exception has been thrown due to the misconfiguration of an OpenActive SDK library or component.
+    #
+    # 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 InternalLibraryConfigurationError < ::OpenActive::Models::InternalOpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "InternalLibraryConfigurationError"
+      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/internal_library_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: An unexpected exception has been thrown by an OpenActive SDK library or component.
+    #
+    # 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 InternalLibraryError < ::OpenActive::Models::InternalOpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "InternalLibraryError"
+      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/internal_open_booking_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: A generic internal error type, which is not intended to be used directly.
+    #
+    # 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 InternalOpenBookingError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "InternalOpenBookingError"
+      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/invalid_apitoken_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Broker supplied an invalid API key, either malformed or expired.
+    #
+    # 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 InvalidAPITokenError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "InvalidAPITokenError"
       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/invalid_authorization_details_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Broker supplied an invalid set of authorization details, either malformed or expired.
+    #
+    # 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 InvalidAuthorizationDetailsError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "InvalidAuthorizationDetailsError"
       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/invalid_intake_form_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The `orderItemIntakeFormResponse` contains invalid fields that do not match those specified by the `orderItemIntakeForm`.
+    #
+    # 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 InvalidIntakeFormError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "InvalidIntakeFormError"
       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