schema_org-rb 0.1.0

data/lib/schema_org/mixins/how_to_direction.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HowToDirection
+      include CreativeWork
+      include ListItem
+
+      def self.schema_property_definitions
+        {
+          after_media: {
+            schema_name: "afterMedia",
+            schema_url: "https://schema.org/afterMedia",
+            comment_lines: ["A media object representing the circumstances after performing this direction."].freeze,
+            ranges: ["MediaObject", "URL"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          before_media: {
+            schema_name: "beforeMedia",
+            schema_url: "https://schema.org/beforeMedia",
+            comment_lines: ["A media object representing the circumstances before performing this direction."].freeze,
+            ranges: ["MediaObject", "URL"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          during_media: {
+            schema_name: "duringMedia",
+            schema_url: "https://schema.org/duringMedia",
+            comment_lines: ["A media object representing the circumstances while performing this direction."].freeze,
+            ranges: ["MediaObject", "URL"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          perform_time: {
+            schema_name: "performTime",
+            schema_url: "https://schema.org/performTime",
+            comment_lines: ["The length of time it takes to perform instructions or a direction (not including time to prepare the supplies), in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601)."].freeze,
+            ranges: ["Duration"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          prep_time: {
+            schema_name: "prepTime",
+            schema_url: "https://schema.org/prepTime",
+            comment_lines: ["The length of time it takes to prepare the items to be used in instructions or a direction, in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601)."].freeze,
+            ranges: ["Duration"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          supply: {
+            schema_name: "supply",
+            schema_url: "https://schema.org/supply",
+            comment_lines: ["A sub-property of instrument. A supply consumed when performing instructions or a direction."].freeze,
+            ranges: ["HowToSupply", "Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          tool: {
+            schema_name: "tool",
+            schema_url: "https://schema.org/tool",
+            comment_lines: ["A sub property of instrument. An object used (but not consumed) when performing instructions or a direction."].freeze,
+            ranges: ["HowToTool", "Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          total_time: {
+            schema_name: "totalTime",
+            schema_url: "https://schema.org/totalTime",
+            comment_lines: ["The total time required to perform instructions or a direction (including time to prepare the supplies), in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601)."].freeze,
+            ranges: ["Duration"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze
+        }.freeze
+      end
+
+      # A media object representing the circumstances after performing this direction.
+      def after_media
+        read_property(:after_media)
+      end
+
+      # A media object representing the circumstances after performing this direction.
+      def after_media=(value)
+        write_property(:after_media, value)
+      end
+
+      # A media object representing the circumstances before performing this direction.
+      def before_media
+        read_property(:before_media)
+      end
+
+      # A media object representing the circumstances before performing this direction.
+      def before_media=(value)
+        write_property(:before_media, value)
+      end
+
+      # A media object representing the circumstances while performing this direction.
+      def during_media
+        read_property(:during_media)
+      end
+
+      # A media object representing the circumstances while performing this direction.
+      def during_media=(value)
+        write_property(:during_media, value)
+      end
+
+      # The length of time it takes to perform instructions or a direction (not including time to prepare the supplies), in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).
+      def perform_time
+        read_property(:perform_time)
+      end
+
+      # The length of time it takes to perform instructions or a direction (not including time to prepare the supplies), in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).
+      def perform_time=(value)
+        write_property(:perform_time, value)
+      end
+
+      # The length of time it takes to prepare the items to be used in instructions or a direction, in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).
+      def prep_time
+        read_property(:prep_time)
+      end
+
+      # The length of time it takes to prepare the items to be used in instructions or a direction, in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).
+      def prep_time=(value)
+        write_property(:prep_time, value)
+      end
+
+      # A sub-property of instrument. A supply consumed when performing instructions or a direction.
+      def supply
+        read_property(:supply)
+      end
+
+      # A sub-property of instrument. A supply consumed when performing instructions or a direction.
+      def supply=(value)
+        write_property(:supply, value)
+      end
+
+      # A sub property of instrument. An object used (but not consumed) when performing instructions or a direction.
+      def tool
+        read_property(:tool)
+      end
+
+      # A sub property of instrument. An object used (but not consumed) when performing instructions or a direction.
+      def tool=(value)
+        write_property(:tool, value)
+      end
+
+      # The total time required to perform instructions or a direction (including time to prepare the supplies), in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).
+      def total_time
+        read_property(:total_time)
+      end
+
+      # The total time required to perform instructions or a direction (including time to prepare the supplies), in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).
+      def total_time=(value)
+        write_property(:total_time, value)
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/how_to_item.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HowToItem
+      include ListItem
+
+      def self.schema_property_definitions
+        {
+          required_quantity: {
+            schema_name: "requiredQuantity",
+            schema_url: "https://schema.org/requiredQuantity",
+            comment_lines: ["The required quantity of the item(s)."].freeze,
+            ranges: ["Number", "QuantitativeValue", "Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze
+        }.freeze
+      end
+
+      # The required quantity of the item(s).
+      def required_quantity
+        read_property(:required_quantity)
+      end
+
+      # The required quantity of the item(s).
+      def required_quantity=(value)
+        write_property(:required_quantity, value)
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/how_to_section.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HowToSection
+      include CreativeWork
+      include ItemList
+      include ListItem
+
+      def self.schema_property_definitions
+        {
+          steps: {
+            schema_name: "steps",
+            schema_url: "https://schema.org/steps",
+            comment_lines: ["A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally misnamed 'steps'; 'step' is preferred)."].freeze,
+            ranges: ["CreativeWork", "ItemList", "Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: "step",
+            supersedes: nil
+          }.freeze
+        }.freeze
+      end
+
+      # A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally misnamed 'steps'; 'step' is preferred).
+      # Superseded by `step`.
+      def steps
+        read_property(:steps)
+      end
+
+      # A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally misnamed 'steps'; 'step' is preferred).
+      # Superseded by `step`.
+      def steps=(value)
+        write_property(:steps, value)
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/how_to_step.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HowToStep
+      include CreativeWork
+      include ItemList
+      include ListItem
+
+      def self.schema_property_definitions
+        {}.freeze
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/how_to_supply.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HowToSupply
+      include HowToItem
+
+      def self.schema_property_definitions
+        {
+          estimated_cost: {
+            schema_name: "estimatedCost",
+            schema_url: "https://schema.org/estimatedCost",
+            comment_lines: ["The estimated cost of the supply or supplies consumed when performing instructions."].freeze,
+            ranges: ["MonetaryAmount", "Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze
+        }.freeze
+      end
+
+      # The estimated cost of the supply or supplies consumed when performing instructions.
+      def estimated_cost
+        read_property(:estimated_cost)
+      end
+
+      # The estimated cost of the supply or supplies consumed when performing instructions.
+      def estimated_cost=(value)
+        write_property(:estimated_cost, value)
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/how_to_tip.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HowToTip
+      include CreativeWork
+      include ListItem
+
+      def self.schema_property_definitions
+        {}.freeze
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/how_to_tool.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HowToTool
+      include HowToItem
+
+      def self.schema_property_definitions
+        {}.freeze
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/hvac_business.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HVACBusiness
+      include HomeAndConstructionBusiness
+
+      def self.schema_property_definitions
+        {}.freeze
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/hyper_toc.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HyperToc
+      include CreativeWork
+
+      def self.schema_property_definitions
+        {
+          associated_media: {
+            schema_name: "associatedMedia",
+            schema_url: "https://schema.org/associatedMedia",
+            comment_lines: ["A media object that encodes this CreativeWork. This property is a synonym for encoding."].freeze,
+            ranges: ["MediaObject"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          toc_entry: {
+            schema_name: "tocEntry",
+            schema_url: "https://schema.org/tocEntry",
+            comment_lines: ["Indicates a [[HyperTocEntry]] in a [[HyperToc]]."].freeze,
+            ranges: ["HyperTocEntry"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze
+        }.freeze
+      end
+
+      # A media object that encodes this CreativeWork. This property is a synonym for encoding.
+      def associated_media
+        read_property(:associated_media)
+      end
+
+      # A media object that encodes this CreativeWork. This property is a synonym for encoding.
+      def associated_media=(value)
+        write_property(:associated_media, value)
+      end
+
+      # Indicates a [[HyperTocEntry]] in a [[HyperToc]].
+      def toc_entry
+        read_property(:toc_entry)
+      end
+
+      # Indicates a [[HyperTocEntry]] in a [[HyperToc]].
+      def toc_entry=(value)
+        write_property(:toc_entry, value)
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/hyper_toc_entry.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module HyperTocEntry
+      include CreativeWork
+
+      def self.schema_property_definitions
+        {
+          associated_media: {
+            schema_name: "associatedMedia",
+            schema_url: "https://schema.org/associatedMedia",
+            comment_lines: ["A media object that encodes this CreativeWork. This property is a synonym for encoding."].freeze,
+            ranges: ["MediaObject"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          toc_continuation: {
+            schema_name: "tocContinuation",
+            schema_url: "https://schema.org/tocContinuation",
+            comment_lines: ["A [[HyperTocEntry]] can have a [[tocContinuation]] indicated, which is another [[HyperTocEntry]] that would be the default next item to play or render."].freeze,
+            ranges: ["HyperTocEntry"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          utterances: {
+            schema_name: "utterances",
+            schema_url: "https://schema.org/utterances",
+            comment_lines: ["Text of an utterances (spoken words, lyrics etc.) that occurs at a certain section of a media object, represented as a [[HyperTocEntry]]."].freeze,
+            ranges: ["Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze
+        }.freeze
+      end
+
+      # A media object that encodes this CreativeWork. This property is a synonym for encoding.
+      def associated_media
+        read_property(:associated_media)
+      end
+
+      # A media object that encodes this CreativeWork. This property is a synonym for encoding.
+      def associated_media=(value)
+        write_property(:associated_media, value)
+      end
+
+      # A [[HyperTocEntry]] can have a [[tocContinuation]] indicated, which is another [[HyperTocEntry]] that would be the default next item to play or render.
+      def toc_continuation
+        read_property(:toc_continuation)
+      end
+
+      # A [[HyperTocEntry]] can have a [[tocContinuation]] indicated, which is another [[HyperTocEntry]] that would be the default next item to play or render.
+      def toc_continuation=(value)
+        write_property(:toc_continuation, value)
+      end
+
+      # Text of an utterances (spoken words, lyrics etc.) that occurs at a certain section of a media object, represented as a [[HyperTocEntry]].
+      def utterances
+        read_property(:utterances)
+      end
+
+      # Text of an utterances (spoken words, lyrics etc.) that occurs at a certain section of a media object, represented as a [[HyperTocEntry]].
+      def utterances=(value)
+        write_property(:utterances, value)
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/ice_cream_shop.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module IceCreamShop
+      include FoodEstablishment
+
+      def self.schema_property_definitions
+        {}.freeze
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/ignore_action.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module IgnoreAction
+      include AssessAction
+
+      def self.schema_property_definitions
+        {}.freeze
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/image_gallery.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module ImageGallery
+      include MediaGallery
+
+      def self.schema_property_definitions
+        {}.freeze
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/image_object.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module ImageObject
+      include MediaObject
+
+      def self.schema_property_definitions
+        {
+          caption: {
+            schema_name: "caption",
+            schema_url: "https://schema.org/caption",
+            comment_lines: ["The caption for this object. For downloadable machine formats (closed caption, subtitles etc.) use MediaObject and indicate the [[encodingFormat]]."].freeze,
+            ranges: ["MediaObject", "Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          embedded_text_caption: {
+            schema_name: "embeddedTextCaption",
+            schema_url: "https://schema.org/embeddedTextCaption",
+            comment_lines: ["Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'."].freeze,
+            ranges: ["Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          exif_data: {
+            schema_name: "exifData",
+            schema_url: "https://schema.org/exifData",
+            comment_lines: ["exif data for this object."].freeze,
+            ranges: ["PropertyValue", "Text"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze,
+          representative_of_page: {
+            schema_name: "representativeOfPage",
+            schema_url: "https://schema.org/representativeOfPage",
+            comment_lines: ["Indicates whether this image is representative of the content of the page."].freeze,
+            ranges: ["Boolean"].freeze,
+            external_ranges: [].freeze,
+            inverse_of: nil,
+            superseded_by: nil,
+            supersedes: nil
+          }.freeze
+        }.freeze
+      end
+
+      # The caption for this object. For downloadable machine formats (closed caption, subtitles etc.) use MediaObject and indicate the [[encodingFormat]].
+      def caption
+        read_property(:caption)
+      end
+
+      # The caption for this object. For downloadable machine formats (closed caption, subtitles etc.) use MediaObject and indicate the [[encodingFormat]].
+      def caption=(value)
+        write_property(:caption, value)
+      end
+
+      # Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'.
+      def embedded_text_caption
+        read_property(:embedded_text_caption)
+      end
+
+      # Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'.
+      def embedded_text_caption=(value)
+        write_property(:embedded_text_caption, value)
+      end
+
+      # exif data for this object.
+      def exif_data
+        read_property(:exif_data)
+      end
+
+      # exif data for this object.
+      def exif_data=(value)
+        write_property(:exif_data, value)
+      end
+
+      # Indicates whether this image is representative of the content of the page.
+      def representative_of_page
+        read_property(:representative_of_page)
+      end
+
+      # Indicates whether this image is representative of the content of the page.
+      def representative_of_page=(value)
+        write_property(:representative_of_page, value)
+      end
+    end
+  end
+end

data/lib/schema_org/mixins/image_object_snapshot.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Generated Ruby code is licensed under MIT.
+# Schema.org descriptions in comments and metadata are licensed under CC BY-SA 3.0.
+# See LICENSE-SCHEMA-ORG.txt.
+module SchemaOrg
+  module Mixins
+    module ImageObjectSnapshot
+      include ImageObject
+
+      def self.schema_property_definitions
+        {}.freeze
+      end
+    end
+  end
+end