SemanticWeb-Schema/lib/SemanticWeb/Schema/Demand.pm
use utf8;
package SemanticWeb::Schema::Demand;
# ABSTRACT: A demand entity represents the public
use v5.14;
use Moo;
extends qw/ SemanticWeb::Schema::Intangible /;
use MooX::JSON_LD 'Demand';
use Ref::Util qw/ is_plain_hashref /;
# RECOMMEND PREREQ: Ref::Util::XS
use namespace::autoclean;
our $VERSION = 'v23.0.0';
has accepted_payment_method => (
is => 'rw',
predicate => '_has_accepted_payment_method',
json_ld => 'acceptedPaymentMethod',
);
has advance_booking_requirement => (
is => 'rw',
predicate => '_has_advance_booking_requirement',
json_ld => 'advanceBookingRequirement',
);
has area_served => (
is => 'rw',
predicate => '_has_area_served',
json_ld => 'areaServed',
);
has asin => (
is => 'rw',
predicate => '_has_asin',
json_ld => 'asin',
);
has availability => (
is => 'rw',
predicate => '_has_availability',
json_ld => 'availability',
);
has availability_ends => (
is => 'rw',
predicate => '_has_availability_ends',
json_ld => 'availabilityEnds',
);
has availability_starts => (
is => 'rw',
predicate => '_has_availability_starts',
json_ld => 'availabilityStarts',
);
has available_at_or_from => (
is => 'rw',
predicate => '_has_available_at_or_from',
json_ld => 'availableAtOrFrom',
);
has available_delivery_method => (
is => 'rw',
predicate => '_has_available_delivery_method',
json_ld => 'availableDeliveryMethod',
);
has business_function => (
is => 'rw',
predicate => '_has_business_function',
json_ld => 'businessFunction',
);
has delivery_lead_time => (
is => 'rw',
predicate => '_has_delivery_lead_time',
json_ld => 'deliveryLeadTime',
);
has eligible_customer_type => (
is => 'rw',
predicate => '_has_eligible_customer_type',
json_ld => 'eligibleCustomerType',
);
has eligible_duration => (
is => 'rw',
predicate => '_has_eligible_duration',
json_ld => 'eligibleDuration',
);
has eligible_quantity => (
is => 'rw',
predicate => '_has_eligible_quantity',
json_ld => 'eligibleQuantity',
);
has eligible_region => (
is => 'rw',
predicate => '_has_eligible_region',
json_ld => 'eligibleRegion',
);
has eligible_transaction_volume => (
is => 'rw',
predicate => '_has_eligible_transaction_volume',
json_ld => 'eligibleTransactionVolume',
);
has gtin => (
is => 'rw',
predicate => '_has_gtin',
json_ld => 'gtin',
);
has gtin12 => (
is => 'rw',
predicate => '_has_gtin12',
json_ld => 'gtin12',
);
has gtin13 => (
is => 'rw',
predicate => '_has_gtin13',
json_ld => 'gtin13',
);
has gtin14 => (
is => 'rw',
predicate => '_has_gtin14',
json_ld => 'gtin14',
);
has gtin8 => (
is => 'rw',
predicate => '_has_gtin8',
json_ld => 'gtin8',
);
has includes_object => (
is => 'rw',
predicate => '_has_includes_object',
json_ld => 'includesObject',
);
has ineligible_region => (
is => 'rw',
predicate => '_has_ineligible_region',
json_ld => 'ineligibleRegion',
);
has inventory_level => (
is => 'rw',
predicate => '_has_inventory_level',
json_ld => 'inventoryLevel',
);
has item_condition => (
is => 'rw',
predicate => '_has_item_condition',
json_ld => 'itemCondition',
);
has item_offered => (
is => 'rw',
predicate => '_has_item_offered',
json_ld => 'itemOffered',
);
has mpn => (
is => 'rw',
predicate => '_has_mpn',
json_ld => 'mpn',
);
has price_specification => (
is => 'rw',
predicate => '_has_price_specification',
json_ld => 'priceSpecification',
);
has seller => (
is => 'rw',
predicate => '_has_seller',
json_ld => 'seller',
);
has serial_number => (
is => 'rw',
predicate => '_has_serial_number',
json_ld => 'serialNumber',
);
has sku => (
is => 'rw',
predicate => '_has_sku',
json_ld => 'sku',
);
has valid_from => (
is => 'rw',
predicate => '_has_valid_from',
json_ld => 'validFrom',
);
has valid_through => (
is => 'rw',
predicate => '_has_valid_through',
json_ld => 'validThrough',
);
has warranty => (
is => 'rw',
predicate => '_has_warranty',
json_ld => 'warranty',
);
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
SemanticWeb::Schema::Demand - A demand entity represents the public
=head1 VERSION
version v23.0.0
=head1 DESCRIPTION
A demand entity represents the public, not necessarily binding, not
necessarily exclusive, announcement by an organization or person to seek a
certain type of goods or services. For describing demand using this type,
the very same properties used for Offer apply.
=head1 ATTRIBUTES
=head2 C<accepted_payment_method>
C<acceptedPaymentMethod>
The payment method(s) accepted by seller for this offer.
A accepted_payment_method should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::LoanOrCredit']>
=item C<InstanceOf['SemanticWeb::Schema::PaymentMethod']>
=back
=head2 C<_has_accepted_payment_method>
A predicate for the L</accepted_payment_method> attribute.
=head2 C<advance_booking_requirement>
C<advanceBookingRequirement>
The amount of time that is required between accepting the offer and the
actual usage of the resource or service.
A advance_booking_requirement should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::QuantitativeValue']>
=back
=head2 C<_has_advance_booking_requirement>
A predicate for the L</advance_booking_requirement> attribute.
=head2 C<area_served>
C<areaServed>
The geographic area where a service or offered item is provided.
A area_served should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::AdministrativeArea']>
=item C<InstanceOf['SemanticWeb::Schema::GeoShape']>
=item C<InstanceOf['SemanticWeb::Schema::Place']>
=item C<Str>
=back
=head2 C<_has_area_served>
A predicate for the L</area_served> attribute.
=head2 C<asin>
An Amazon Standard Identification Number (ASIN) is a 10-character
alphanumeric unique identifier assigned by Amazon.com and its partners for
product identification within the Amazon organization (summary from
[Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Nu
mber)'s article). Note also that this is a definition for how to include
ASINs in Schema.org data, and not a definition of ASINs in general - see
documentation from Amazon for authoritative details. ASINs are most
commonly encoded as text strings, but the [asin] property supports URL/URI
as potential values too.
A asin should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_asin>
A predicate for the L</asin> attribute.
=head2 C<availability>
The availability of this item—for example In stock, Out of stock,
Pre-order, etc.
A availability should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::ItemAvailability']>
=back
=head2 C<_has_availability>
A predicate for the L</availability> attribute.
=head2 C<availability_ends>
C<availabilityEnds>
The end of the availability of the product or service included in the
offer.
A availability_ends should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_availability_ends>
A predicate for the L</availability_ends> attribute.
=head2 C<availability_starts>
C<availabilityStarts>
The beginning of the availability of the product or service included in the
offer.
A availability_starts should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_availability_starts>
A predicate for the L</availability_starts> attribute.
=head2 C<available_at_or_from>
C<availableAtOrFrom>
The place(s) from which the offer can be obtained (e.g. store locations).
A available_at_or_from should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Place']>
=back
=head2 C<_has_available_at_or_from>
A predicate for the L</available_at_or_from> attribute.
=head2 C<available_delivery_method>
C<availableDeliveryMethod>
The delivery method(s) available for this offer.
A available_delivery_method should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::DeliveryMethod']>
=back
=head2 C<_has_available_delivery_method>
A predicate for the L</available_delivery_method> attribute.
=head2 C<business_function>
C<businessFunction>
The business function (e.g. sell, lease, repair, dispose) of the offer or
component of a bundle (TypeAndQuantityNode). The default is
http://purl.org/goodrelations/v1#Sell.
A business_function should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::BusinessFunction']>
=back
=head2 C<_has_business_function>
A predicate for the L</business_function> attribute.
=head2 C<delivery_lead_time>
C<deliveryLeadTime>
The typical delay between the receipt of the order and the goods either
leaving the warehouse or being prepared for pickup, in case the delivery
method is on site pickup.
A delivery_lead_time should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::QuantitativeValue']>
=back
=head2 C<_has_delivery_lead_time>
A predicate for the L</delivery_lead_time> attribute.
=head2 C<eligible_customer_type>
C<eligibleCustomerType>
The type(s) of customers for which the given offer is valid.
A eligible_customer_type should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::BusinessEntityType']>
=back
=head2 C<_has_eligible_customer_type>
A predicate for the L</eligible_customer_type> attribute.
=head2 C<eligible_duration>
C<eligibleDuration>
The duration for which the given offer is valid.
A eligible_duration should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::QuantitativeValue']>
=back
=head2 C<_has_eligible_duration>
A predicate for the L</eligible_duration> attribute.
=head2 C<eligible_quantity>
C<eligibleQuantity>
The interval and unit of measurement of ordering quantities for which the
offer or price specification is valid. This allows e.g. specifying that a
certain freight charge is valid only for a certain quantity.
A eligible_quantity should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::QuantitativeValue']>
=back
=head2 C<_has_eligible_quantity>
A predicate for the L</eligible_quantity> attribute.
=head2 C<eligible_region>
C<eligibleRegion>
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.
See also [[ineligibleRegion]].
A eligible_region should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::GeoShape']>
=item C<InstanceOf['SemanticWeb::Schema::Place']>
=item C<Str>
=back
=head2 C<_has_eligible_region>
A predicate for the L</eligible_region> attribute.
=head2 C<eligible_transaction_volume>
C<eligibleTransactionVolume>
The transaction volume, in a monetary unit, for which the offer or price
specification is valid, e.g. for indicating a minimal purchasing volume, to
express free shipping above a certain order volume, or to limit the
acceptance of credit cards to purchases to a certain minimal amount.
A eligible_transaction_volume should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::PriceSpecification']>
=back
=head2 C<_has_eligible_transaction_volume>
A predicate for the L</eligible_transaction_volume> attribute.
=head2 C<gtin>
A Global Trade Item Number (L<GTIN|https://www.gs1.org/standards/id-keys/gtin>). GTINs identify trade items, including products and services, using numeric identification codes.
The GS1 L<digital link specifications|https://www.gs1.org/standards/Digital-Link/> express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also L<schema.org tracking issue|https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809> for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a L<valid GS1 check digit|https://www.gs1.org/services/check-digit-calculator> and meet the other rules for valid GTINs. See also L<GS1's GTIN Summary|http://www.gs1.org/barcodes/technical/idkeys/gtin> and L<Wikipedia|https://en.wikipedia.org/wiki/Global_Trade_Item_Number> for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.
Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
A gtin should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_gtin>
A predicate for the L</gtin> attribute.
=head2 C<gtin12>
The GTIN-12 code of the product, or the product to which the offer refers.
The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C.
Company Prefix, Item Reference, and Check Digit used to identify trade
items. See [GS1 GTIN
Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more
details.
A gtin12 should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_gtin12>
A predicate for the L</gtin12> attribute.
=head2 C<gtin13>
The GTIN-13 code of the product, or the product to which the offer refers.
This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit
UPC codes can be converted into a GTIN-13 code by simply adding a preceding
zero. See [GS1 GTIN
Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more
details.
A gtin13 should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_gtin13>
A predicate for the L</gtin13> attribute.
=head2 C<gtin14>
The GTIN-14 code of the product, or the product to which the offer refers.
See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)
for more details.
A gtin14 should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_gtin14>
A predicate for the L</gtin14> attribute.
=head2 C<gtin8>
The GTIN-8 code of the product, or the product to which the offer refers.
This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN
Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more
details.
A gtin8 should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_gtin8>
A predicate for the L</gtin8> attribute.
=head2 C<includes_object>
C<includesObject>
This links to a node or nodes indicating the exact quantity of the products included in an L<SemanticWeb::Schema::Offer> or L<SemanticWeb::Schema::ProductCollection>.
A includes_object should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::TypeAndQuantityNode']>
=back
=head2 C<_has_includes_object>
A predicate for the L</includes_object> attribute.
=head2 C<ineligible_region>
C<ineligibleRegion>
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.
See also [[eligibleRegion]].
A ineligible_region should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::GeoShape']>
=item C<InstanceOf['SemanticWeb::Schema::Place']>
=item C<Str>
=back
=head2 C<_has_ineligible_region>
A predicate for the L</ineligible_region> attribute.
=head2 C<inventory_level>
C<inventoryLevel>
The current approximate inventory level for the item or items.
A inventory_level should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::QuantitativeValue']>
=back
=head2 C<_has_inventory_level>
A predicate for the L</inventory_level> attribute.
=head2 C<item_condition>
C<itemCondition>
A predefined value from OfferItemCondition specifying the condition of the
product or service, or the products or services included in the offer. Also
used for product return policies to specify the condition of products
accepted for returns.
A item_condition should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::OfferItemCondition']>
=back
=head2 C<_has_item_condition>
A predicate for the L</item_condition> attribute.
=head2 C<item_offered>
C<itemOffered>
An item being offered (or demanded). The transactional nature of the offer or demand is documented using [[businessFunction]], e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
A item_offered should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::AggregateOffer']>
=item C<InstanceOf['SemanticWeb::Schema::CreativeWork']>
=item C<InstanceOf['SemanticWeb::Schema::Event']>
=item C<InstanceOf['SemanticWeb::Schema::MenuItem']>
=item C<InstanceOf['SemanticWeb::Schema::Product']>
=item C<InstanceOf['SemanticWeb::Schema::Service']>
=item C<InstanceOf['SemanticWeb::Schema::Trip']>
=back
=head2 C<_has_item_offered>
A predicate for the L</item_offered> attribute.
=head2 C<mpn>
The Manufacturer Part Number (MPN) of the product, or the product to which
the offer refers.
A mpn should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_mpn>
A predicate for the L</mpn> attribute.
=head2 C<price_specification>
C<priceSpecification>
One or more detailed price specifications, indicating the unit price and
delivery or payment charges.
A price_specification should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::PriceSpecification']>
=back
=head2 C<_has_price_specification>
A predicate for the L</price_specification> attribute.
=head2 C<seller>
An entity which offers (sells / leases / lends / loans) the services /
goods. A seller may also be a provider.
A seller should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::Organization']>
=item C<InstanceOf['SemanticWeb::Schema::Person']>
=back
=head2 C<_has_seller>
A predicate for the L</seller> attribute.
=head2 C<serial_number>
C<serialNumber>
The serial number or any alphanumeric identifier of a particular product.
When attached to an offer, it is a shortcut for the serial number of the
product included in the offer.
A serial_number should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_serial_number>
A predicate for the L</serial_number> attribute.
=head2 C<sku>
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a
product or service, or the product to which the offer refers.
A sku should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_sku>
A predicate for the L</sku> attribute.
=head2 C<valid_from>
C<validFrom>
The date when the item becomes valid.
A valid_from should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_valid_from>
A predicate for the L</valid_from> attribute.
=head2 C<valid_through>
C<validThrough>
The date after when the item is not valid. For example the end of an offer,
salary period, or a period of opening hours.
A valid_through should be one of the following types:
=over
=item C<Str>
=back
=head2 C<_has_valid_through>
A predicate for the L</valid_through> attribute.
=head2 C<warranty>
The warranty promise(s) included in the offer.
A warranty should be one of the following types:
=over
=item C<InstanceOf['SemanticWeb::Schema::WarrantyPromise']>
=back
=head2 C<_has_warranty>
A predicate for the L</warranty> attribute.
=head1 SEE ALSO
L<SemanticWeb::Schema::Intangible>
=head1 SOURCE
The development version is on github at L<https://github.com/robrwo/SemanticWeb-Schema>
and may be cloned from L<git://github.com/robrwo/SemanticWeb-Schema.git>
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
L<https://github.com/robrwo/SemanticWeb-Schema/issues>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHOR
Robert Rothenberg <rrwo@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2018-2023 by Robert Rothenberg.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
=cut