openactive 0.1.0 → 0.2.2

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

data/lib/openactive/models/invalid_opportunity_or_offer_id_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: The `@id` provided for the `orderedItem` or `acceptedOffer` does not match a recognised URL format 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 InvalidOpportunityOrOfferIdError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "InvalidOpportunityOrOfferIdError"
+      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_payment_details_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The `payment` property of the `OrderQuote` or `Order` contains data that is not accepted by the Booking System for reconciliation, e.g. an invalid `accountId`.
+    #
+    # 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 InvalidPaymentDetailsError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "InvalidPaymentDetailsError"
       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/lease.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 Lease < ::OpenActive::Models::Schema::Thing
       # @!attribute type
       # @return [String]

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

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

data/lib/openactive/models/media_object.rb

@@ -0,0 +1,44 @@
+module OpenActive
+  module Models
+    # This type is derived from https://schema.org/MediaObject, which means that any of this type's properties within schema.org may also be used.
+    class MediaObject < ::OpenActive::Models::Schema::MediaObject
+      # @!attribute type
+      # @return [String]
+      def type
+        "MediaObject"
+      end
+
+      # @return [URI]
+      define_property :content_url, as: "contentUrl", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :embed_url, as: "embedUrl", types: [
+        "URI",
+      ]
+
+      # @return [int,nil]
+      define_property :height, as: "height", types: [
+        "int",
+        "null",
+      ]
+
+      # @return [Array<OpenActive::Models::ImageObject>]
+      define_property :thumbnail, as: "thumbnail", types: [
+        "OpenActive::Models::ImageObject[]",
+      ]
+
+      # @return [URI]
+      define_property :url, as: "url", types: [
+        "URI",
+      ]
+
+      # @return [int,nil]
+      define_property :width, as: "width", types: [
+        "int",
+        "null",
+      ]
+    end
+  end
+end

data/lib/openactive/models/method_not_allowed_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: The Booking System does not recognise the specific HTTP verb used for the endpoint requested.
+    #
+    # 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 MethodNotAllowedError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "MethodNotAllowedError"
+      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/missing_payment_details_error.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Models
+    #
+    # Error Use Case: The `payment` property of the `Order` is absent when it is expected to be provided.
+    #
+    # 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 MissingPaymentDetailsError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "MissingPaymentDetailsError"
+      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/no_apitoken_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Broker did not supply an API key.
+    #
+    # 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 NoAPITokenError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "NoAPITokenError"
       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/not_found_error.rb

@@ -1,11 +1,26 @@
 module OpenActive
   module Models
+    #
+    # Error Use Case: The Booking System does not have the generic resource specified.
+    #
+    # 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 NotFoundError < ::OpenActive::Models::OpenBookingError
       # @!attribute type
       # @return [String]
       def type
         "NotFoundError"
       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/offer.rb

@@ -1,6 +1,6 @@
 module OpenActive
   module Models
-    # 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.
+    # 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 Offer < ::OpenActive::Models::Schema::Offer
       # @!attribute type
       # @return [String]
@@ -33,17 +33,22 @@ module OpenActive
         "null",
       ]
 
-      # @return [OpenActive::Enums::RequiredStatusType,nil]
-      define_property :advance_booking, as: "advanceBooking", types: [
-        "OpenActive::Enums::RequiredStatusType",
-        "null",
+      # @return [OpenActive::Models::QuantitativeValue]
+      define_property :age_range, as: "ageRange", types: [
+        "OpenActive::Models::QuantitativeValue",
       ]
 
       # @return [OpenActive::Models::QuantitativeValue]
-      define_property :age_range, as: "ageRange", types: [
+      define_property :age_restriction, as: "ageRestriction", types: [
         "OpenActive::Models::QuantitativeValue",
       ]
 
+      # @return [Boolean,nil]
+      define_property :allow_customer_cancellation_full_refund, as: "allowCustomerCancellationFullRefund", types: [
+        "bool",
+        "null",
+      ]
+
       # @return [ActiveSupport::Duration,nil]
       define_property :latest_cancellation_before_start_date, as: "latestCancellationBeforeStartDate", types: [
         "DateInterval",
@@ -57,7 +62,13 @@ module OpenActive
       ]
 
       # @return [OpenActive::Enums::RequiredStatusType,nil]
-      define_property :prepayment, as: "prepayment", types: [
+      define_property :open_booking_in_advance, as: "openBookingInAdvance", types: [
+        "OpenActive::Enums::RequiredStatusType",
+        "null",
+      ]
+
+      # @return [OpenActive::Enums::RequiredStatusType,nil]
+      define_property :open_booking_prepayment, as: "openBookingPrepayment", types: [
         "OpenActive::Enums::RequiredStatusType",
         "null",
       ]
@@ -84,10 +95,9 @@ module OpenActive
         "null",
       ]
 
-      # @return [Array<OpenActive::Enums::AvailableChannelType>,nil]
-      define_property :available_channel, as: "beta:availableChannel", types: [
-        "OpenActive::Enums::AvailableChannelType[]",
-        "null",
+      # @return [OpenActive::Models::QuantitativeValue]
+      define_property :party_size, as: "beta:partySize", types: [
+        "OpenActive::Models::QuantitativeValue",
       ]
     end
   end

data/lib/openactive/models/offer_override.rb

@@ -1,12 +1,52 @@
 module OpenActive
   module Models
-    # 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.
+    # 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 OfferOverride < ::OpenActive::Models::Offer
       # @!attribute type
       # @return [String]
       def type
         "OfferOverride"
       end
+
+      # @return [OpenActive::Models::QuantitativeValue]
+      define_property :age_range, as: "ageRange", types: [
+        "OpenActive::Models::QuantitativeValue",
+      ]
+
+      # @return [OpenActive::Models::QuantitativeValue]
+      define_property :age_restriction, as: "ageRestriction", types: [
+        "OpenActive::Models::QuantitativeValue",
+      ]
+
+      # @return [Boolean,nil]
+      define_property :allow_customer_cancellation_full_refund, as: "allowCustomerCancellationFullRefund", types: [
+        "bool",
+        "null",
+      ]
+
+      # @return [ActiveSupport::Duration,nil]
+      define_property :latest_cancellation_before_start_date, as: "latestCancellationBeforeStartDate", types: [
+        "DateInterval",
+        "null",
+      ]
+
+      # @return [OpenActive::Enums::RequiredStatusType,nil]
+      define_property :open_booking_in_advance, as: "openBookingInAdvance", types: [
+        "OpenActive::Enums::RequiredStatusType",
+        "null",
+      ]
+
+      # @return [OpenActive::Enums::RequiredStatusType,nil]
+      define_property :open_booking_prepayment, as: "openBookingPrepayment", types: [
+        "OpenActive::Enums::RequiredStatusType",
+        "null",
+      ]
+
+      # @return [ActiveSupport::Duration,nil]
+      define_property :valid_from_before_start_date, as: "validFromBeforeStartDate", types: [
+        "DateInterval",
+        "null",
+      ]
     end
   end
 end