Class: SchemaOrg::FinancialIncentive

Inherits:
Base
  • Object
show all
Includes:
Mixins::FinancialIncentive, _FinancialIncentive
Defined in:
lib/schema_org/types/financial_incentive.rb,
sig/schema_org.rbs

Overview

https://schema.org/FinancialIncentive

Represents financial incentives for goods/services offered by an organization (or individual).

Typically contains the [[name]] of the incentive, the [[incentivizedItem]], the [[incentiveAmount]], the [[incentiveStatus]], [[incentiveType]], the [[provider]] of the incentive, and [[eligibleWithSupplier]].

Optionally contains criteria on whether the incentive is limited based on [[purchaseType]], [[purchasePriceLimit]], [[incomeLimit]], and the [[qualifiedExpense]].

Constant Summary collapse

SCHEMA_NAME = 
"FinancialIncentive"
SCHEMA_TYPES = 
[self, SchemaOrg::Intangible, SchemaOrg::Thing].freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixins::FinancialIncentive

#area_served, #area_served=, #eligible_with_supplier, #eligible_with_supplier=, #incentive_amount, #incentive_amount=, #incentive_status, #incentive_status=, #incentive_type, #incentive_type=, #incentivized_item, #incentivized_item=, #income_limit, #income_limit=, #provider, #provider=, #publisher, #publisher=, #purchase_price_limit, #purchase_price_limit=, #purchase_type, #purchase_type=, #qualified_expense, #qualified_expense=, schema_property_definitions, #valid_from, #valid_from=, #valid_through, #valid_through=

Methods included from Mixins::Intangible

schema_property_definitions

Methods included from Mixins::Thing

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #same_as, #same_as=, schema_property_definitions, #subject_of, #subject_of=, #url, #url=

Methods included from _FinancialIncentive

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #area_served, #area_served=, #description, #description=, #disambiguating_description, #disambiguating_description=, #eligible_with_supplier, #eligible_with_supplier=, #identifier, #identifier=, #image, #image=, #incentive_amount, #incentive_amount=, #incentive_status, #incentive_status=, #incentive_type, #incentive_type=, #incentivized_item, #incentivized_item=, #income_limit, #income_limit=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #provider, #provider=, #publisher, #publisher=, #purchase_price_limit, #purchase_price_limit=, #purchase_type, #purchase_type=, #qualified_expense, #qualified_expense=, #same_as, #same_as=, #subject_of, #subject_of=, #url, #url=, #valid_from, #valid_from=, #valid_through, #valid_through=

Class Method Details

.new(**properties) ⇒ FinancialIncentive

Parameters:

Returns:



34
35
36
 
# File 'lib/schema_org/types/financial_incentive.rb', line 34

def new(**properties)
  super
end

.schema_name ⇒ String

Returns:

  • (String) 


21
22
23
 
# File 'lib/schema_org/types/financial_incentive.rb', line 21

def schema_name
  SCHEMA_NAME
end

.schema_type?(other_type) ⇒ Boolean

Parameters:

  • (Object)

Returns:



29
30
31
32
 
# File 'lib/schema_org/types/financial_incentive.rb', line 29

def schema_type?(other_type)
  Base.schema_type_argument!(other_type)
  SCHEMA_TYPES.include?(other_type)
end

.schema_types ⇒ ::Array[::Class]

Returns:

  • (::Array[::Class]) 


25
26
27
 
# File 'lib/schema_org/types/financial_incentive.rb', line 25

def schema_types
  SCHEMA_TYPES
end

Instance Method Details

#schema_type? ⇒ Boolean

Parameters:

  • (Object)

Returns:



46987
 
# File 'sig/schema_org.rbs', line 46987

def schema_type?: (untyped) -> bool

#schema_types ⇒ ::Array[::Class]

Returns:

  • (::Array[::Class]) 


46986
 
# File 'sig/schema_org.rbs', line 46986

def schema_types: () -> ::Array[::Class]