Merge pull request #222 from Soean/schema_v_28_1

Upgrade to schema.org v28.1

generator/Console/GenerateCommand.php

@@ -31,7 +31,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $generator = new PackageGenerator();
 
         $definitions = new Definitions([
-            'core' => 'https://raw.githubusercontent.com/schemaorg/schemaorg/main/data/releases/24.0/schemaorg-all-https.jsonld',
+            'core' => 'https://raw.githubusercontent.com/schemaorg/schemaorg/main/data/releases/28.1/schemaorg-all-https.jsonld',
         ]);
 
         if (! $input->getOption('local')) {

src/AMRadioChannel.php

@@ -72,7 +72,7 @@ public function broadcastChannelId($broadcastChannelId)
     /**
      * The frequency used for over-the-air broadcasts. Numeric values or simple
      * ranges, e.g. 87-99. In addition a shortcut idiom is supported for
-     * frequences of AM and FM radio channels, e.g. "87 FM".
+     * frequencies of AM and FM radio channels, e.g. "87 FM".
      *
      * @param \Spatie\SchemaOrg\Contracts\BroadcastFrequencySpecificationContract|\Spatie\SchemaOrg\Contracts\BroadcastFrequencySpecificationContract[]|string|string[] $broadcastFrequency
      *

src/APIReference.php

@@ -780,7 +780,8 @@ public function dateModified($dateModified)
     }
 
     /**
-     * Date of first broadcast/publication.
+     * Date of first publication or broadcast. For example the date a
+     * [[CreativeWork]] was broadcast or a [[Certification]] was issued.
      *
      * @param \DateTimeInterface|\DateTimeInterface[] $datePublished
      *
@@ -1050,9 +1051,10 @@ public function executableLibraryName($executableLibraryName)
     /**
      * Date the content expires and is no longer useful or available. For
      * example a [[VideoObject]] or [[NewsArticle]] whose availability or
-     * relevance is time-limited, or a [[ClaimReview]] fact check whose
-     * publisher wants to indicate that it may no longer be relevant (or helpful
-     * to highlight) after some date.
+     * relevance is time-limited, a [[ClaimReview]] fact check whose publisher
+     * wants to indicate that it may no longer be relevant (or helpful to
+     * highlight) after some date, or a [[Certification]] the validity has
+     * expired.
      *
      * @param \DateTimeInterface|\DateTimeInterface[] $expires
      *

src/AboutPage.php

@@ -717,7 +717,8 @@ public function dateModified($dateModified)
     }
 
     /**
-     * Date of first broadcast/publication.
+     * Date of first publication or broadcast. For example the date a
+     * [[CreativeWork]] was broadcast or a [[Certification]] was issued.
      *
      * @param \DateTimeInterface|\DateTimeInterface[] $datePublished
      *
@@ -959,9 +960,10 @@ public function exampleOfWork($exampleOfWork)
     /**
      * Date the content expires and is no longer useful or available. For
      * example a [[VideoObject]] or [[NewsArticle]] whose availability or
-     * relevance is time-limited, or a [[ClaimReview]] fact check whose
-     * publisher wants to indicate that it may no longer be relevant (or helpful
-     * to highlight) after some date.
+     * relevance is time-limited, a [[ClaimReview]] fact check whose publisher
+     * wants to indicate that it may no longer be relevant (or helpful to
+     * highlight) after some date, or a [[Certification]] the validity has
+     * expired.
      *
      * @param \DateTimeInterface|\DateTimeInterface[] $expires
      *

src/AcceptAction.php

@@ -20,6 +20,20 @@
  */
 class AcceptAction extends BaseType implements AcceptActionContract, ActionContract, AllocateActionContract, OrganizeActionContract, ThingContract
 {
+    /**
+     * Description of the process by which the action was performed.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\HowToContract|\Spatie\SchemaOrg\Contracts\HowToContract[] $actionProcess
+     *
+     * @return static
+     *
+     * @see https://schema.org/actionProcess
+     */
+    public function actionProcess($actionProcess)
+    {
+        return $this->setProperty('actionProcess', $actionProcess);
+    }
+
     /**
      * Indicates the current disposition of the Action.
      *

src/Accommodation.php

@@ -557,6 +557,22 @@ public function globalLocationNumber($globalLocationNumber)
         return $this->setProperty('globalLocationNumber', $globalLocationNumber);
     }
 
+    /**
+     * Certification information about a product, organization, service, place,
+     * or person.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\CertificationContract|\Spatie\SchemaOrg\Contracts\CertificationContract[] $hasCertification
+     *
+     * @return static
+     *
+     * @see https://schema.org/hasCertification
+     * @link https://github.com/schemaorg/schemaorg/issues/3230
+     */
+    public function hasCertification($hasCertification)
+    {
+        return $this->setProperty('hasCertification', $hasCertification);
+    }
+
     /**
      * Indicates whether some facility (e.g. [[FoodEstablishment]],
      * [[CovidTestingFacility]]) offers a service that can be used by driving
@@ -577,6 +593,34 @@ public function hasDriveThroughService($hasDriveThroughService)
         return $this->setProperty('hasDriveThroughService', $hasDriveThroughService);
     }
 
+    /**
+     * The [GS1 digital link](https://www.gs1.org/standards/gs1-digital-link)
+     * associated with the object. This URL should conform to the particular
+     * requirements of digital links. The link should only contain the
+     * Application Identifiers (AIs) that are relevant for the entity being
+     * annotated, for instance a [[Product]] or an [[Organization]], and for the
+     * correct granularity. In particular, for products:<ul>* A Digital Link
+     * that contains a serial number (AI ```21```) should only be present on
+     * instances of [[IndividualProduct]]* A Digital Link that contains a lot
+     * number (AI ```10```) should be annotated as [[SomeProduct]] if only
+     * products from that lot are sold, or [[IndividualProduct]] if there is
+     * only a specific product.* A Digital Link that contains a global model
+     * number (AI ```8013```)  should be attached to a [[Product]] or a
+     * [[ProductModel]]. Other item types should be adapted similarly.
+     *
+     * @param string|string[] $hasGS1DigitalLink
+     *
+     * @return static
+     *
+     * @see https://schema.org/hasGS1DigitalLink
+     * @see https://pending.schema.org
+     * @link https://github.com/schemaorg/schemaorg/issues/3475
+     */
+    public function hasGS1DigitalLink($hasGS1DigitalLink)
+    {
+        return $this->setProperty('hasGS1DigitalLink', $hasGS1DigitalLink);
+    }
+
     /**
      * A URL to a map of the place.
      *

src/AccountingService.php

@@ -20,6 +20,22 @@
  */
 class AccountingService extends BaseType implements AccountingServiceContract, FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract
 {
+    /**
+     * The payment method(s) that are accepted in general by an organization, or
+     * for some specific demand or offer.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\LoanOrCreditContract|\Spatie\SchemaOrg\Contracts\LoanOrCreditContract[]|\Spatie\SchemaOrg\Contracts\PaymentMethodContract|\Spatie\SchemaOrg\Contracts\PaymentMethodContract[]|string|string[] $acceptedPaymentMethod
+     *
+     * @return static
+     *
+     * @see https://schema.org/acceptedPaymentMethod
+     * @link https://github.com/schemaorg/schemaorg/issues/3537
+     */
+    public function acceptedPaymentMethod($acceptedPaymentMethod)
+    {
+        return $this->setProperty('acceptedPaymentMethod', $acceptedPaymentMethod);
+    }
+
     /**
      * For a [[NewsMediaOrganization]] or other news-related [[Organization]], a
      * statement about public engagement activities (for news media, the
@@ -616,9 +632,9 @@ public function feesAndCommissionsSpecification($feesAndCommissionsSpecification
     }
 
     /**
-     * A person who founded this organization.
+     * A person or organization who founded this organization.
      *
-     * @param \Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $founder
+     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $founder
      *
      * @return static
      *
@@ -906,6 +922,22 @@ public function globalLocationNumber($globalLocationNumber)
         return $this->setProperty('globalLocationNumber', $globalLocationNumber);
     }
 
+    /**
+     * Certification information about a product, organization, service, place,
+     * or person.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\CertificationContract|\Spatie\SchemaOrg\Contracts\CertificationContract[] $hasCertification
+     *
+     * @return static
+     *
+     * @see https://schema.org/hasCertification
+     * @link https://github.com/schemaorg/schemaorg/issues/3230
+     */
+    public function hasCertification($hasCertification)
+    {
+        return $this->setProperty('hasCertification', $hasCertification);
+    }
+
     /**
      * A credential awarded to the Person or Organization.
      *
@@ -942,6 +974,34 @@ public function hasDriveThroughService($hasDriveThroughService)
         return $this->setProperty('hasDriveThroughService', $hasDriveThroughService);
     }
 
+    /**
+     * The [GS1 digital link](https://www.gs1.org/standards/gs1-digital-link)
+     * associated with the object. This URL should conform to the particular
+     * requirements of digital links. The link should only contain the
+     * Application Identifiers (AIs) that are relevant for the entity being
+     * annotated, for instance a [[Product]] or an [[Organization]], and for the
+     * correct granularity. In particular, for products:<ul>* A Digital Link
+     * that contains a serial number (AI ```21```) should only be present on
+     * instances of [[IndividualProduct]]* A Digital Link that contains a lot
+     * number (AI ```10```) should be annotated as [[SomeProduct]] if only
+     * products from that lot are sold, or [[IndividualProduct]] if there is
+     * only a specific product.* A Digital Link that contains a global model
+     * number (AI ```8013```)  should be attached to a [[Product]] or a
+     * [[ProductModel]]. Other item types should be adapted similarly.
+     *
+     * @param string|string[] $hasGS1DigitalLink
+     *
+     * @return static
+     *
+     * @see https://schema.org/hasGS1DigitalLink
+     * @see https://pending.schema.org
+     * @link https://github.com/schemaorg/schemaorg/issues/3475
+     */
+    public function hasGS1DigitalLink($hasGS1DigitalLink)
+    {
+        return $this->setProperty('hasGS1DigitalLink', $hasGS1DigitalLink);
+    }
+
     /**
      * A URL to a map of the place.
      *
@@ -956,6 +1016,22 @@ public function hasMap($hasMap)
         return $this->setProperty('hasMap', $hasMap);
     }
 
+    /**
+     * MemberProgram offered by an Organization, for example an eCommerce
+     * merchant or an airline.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\MemberProgramContract|\Spatie\SchemaOrg\Contracts\MemberProgramContract[] $hasMemberProgram
+     *
+     * @return static
+     *
+     * @see https://schema.org/hasMemberProgram
+     * @link https://github.com/schemaorg/schemaorg/issues/3563
+     */
+    public function hasMemberProgram($hasMemberProgram)
+    {
+        return $this->setProperty('hasMemberProgram', $hasMemberProgram);
+    }
+
     /**
      * Specifies a MerchantReturnPolicy that may be applicable.
      *
@@ -1098,12 +1174,22 @@ public function isicV4($isicV4)
     }
 
     /**
-     * An organization identifier as defined in ISO 6523(-1). Note that many
-     * existing organization identifiers such as
-     * [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)
-     * and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523
-     * identifier by setting the ICD part of the ISO 6523 identifier
-     * accordingly.
+     * An organization identifier as defined in [ISO
+     * 6523(-1)](https://en.wikipedia.org/wiki/ISO/IEC_6523). The identifier
+     * should be in the `XXXX:YYYYYY:ZZZ` or `XXXX:YYYYYY`format. Where `XXXX`
+     * is a 4 digit _ICD_ (International Code Designator), `YYYYYY` is an _OID_
+     * (Organization Identifier) with all formatting characters (dots, dashes,
+     * spaces) removed with a maximal length of 35 characters, and `ZZZ` is an
+     * optional OPI (Organization Part Identifier) with a maximum length of 35
+     * characters. The various components (ICD, OID, OPI) are joined with a
+     * colon character (ASCII `0x3a`). Note that many existing organization
+     * identifiers defined as attributes like
+     * [leiCode](https://schema.org/leiCode) (`0199`),
+     * [duns](https://schema.org/duns) (`0060`) or
+     * [GLN](https://schema.org/globalLocationNumber) (`0088`) can be expressed
+     * using ISO-6523. If possible, ISO-6523 codes should be preferred to
+     * populating [vatID](https://schema.org/vatID) or
+     * [taxID](https://schema.org/taxID), as ISO identifiers are less ambiguous.
      *
      * @param string|string[] $iso6523Code
      *
@@ -1351,7 +1437,7 @@ public function member($member)
      * An Organization (or ProgramMembership) to which this Person or
      * Organization belongs.
      *
-     * @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract[] $memberOf
+     * @param \Spatie\SchemaOrg\Contracts\MemberProgramTierContract|\Spatie\SchemaOrg\Contracts\MemberProgramTierContract[]|\Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract[] $memberOf
      *
      * @return static
      *
@@ -1710,6 +1796,23 @@ public function serviceArea($serviceArea)
         return $this->setProperty('serviceArea', $serviceArea);
     }
 
+    /**
+     * A statement of knowledge, skill, ability, task or any other assertion
+     * expressing a competency that is either claimed by a person, an
+     * organization or desired or required to fulfill a role or to work in an
+     * occupation.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $skills
+     *
+     * @return static
+     *
+     * @see https://schema.org/skills
+     */
+    public function skills($skills)
+    {
+        return $this->setProperty('skills', $skills);
+    }
+
     /**
      * A slogan or motto associated with the item.
      *

src/AchieveAction.php

@@ -15,6 +15,20 @@
  */
 class AchieveAction extends BaseType implements AchieveActionContract, ActionContract, ThingContract
 {
+    /**
+     * Description of the process by which the action was performed.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\HowToContract|\Spatie\SchemaOrg\Contracts\HowToContract[] $actionProcess
+     *
+     * @return static
+     *
+     * @see https://schema.org/actionProcess
+     */
+    public function actionProcess($actionProcess)
+    {
+        return $this->setProperty('actionProcess', $actionProcess);
+    }
+
     /**
      * Indicates the current disposition of the Action.
      *

src/Action.php

@@ -20,6 +20,20 @@
  */
 class Action extends BaseType implements ActionContract, ThingContract
 {
+    /**
+     * Description of the process by which the action was performed.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\HowToContract|\Spatie\SchemaOrg\Contracts\HowToContract[] $actionProcess
+     *
+     * @return static
+     *
+     * @see https://schema.org/actionProcess
+     */
+    public function actionProcess($actionProcess)
+    {
+        return $this->setProperty('actionProcess', $actionProcess);
+    }
+
     /**
      * Indicates the current disposition of the Action.
      *

src/ActivateAction.php

@@ -16,6 +16,20 @@
  */
 class ActivateAction extends BaseType implements ActivateActionContract, ActionContract, ControlActionContract, ThingContract
 {
+    /**
+     * Description of the process by which the action was performed.
+     *
+     * @param \Spatie\SchemaOrg\Contracts\HowToContract|\Spatie\SchemaOrg\Contracts\HowToContract[] $actionProcess
+     *
+     * @return static
+     *
+     * @see https://schema.org/actionProcess
+     */
+    public function actionProcess($actionProcess)
+    {
+        return $this->setProperty('actionProcess', $actionProcess);
+    }
+
     /**
      * Indicates the current disposition of the Action.
      *