SEO.JSONLD.Class (SEO v0.3.0-rc.0)

A class, also often called a 'Type'; equivalent to rdfs:Class.

Helper for building a Schema.org Class JSON-LD structure.

Summary

Types

attrs()

t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "Class", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a Class JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:superseded_by) =>
      :abdomen
      | :activation_fee
      | :active_action_status
      | :active_not_recruiting
      | :aerobic_activity
      | :album_release
      | :alcohol_consideration
      | :algorithmic_media_digital_source
      | :algorithmically_enhanced_digital_source
      | :all_wheel_drive_configuration
      | :allergies_health_aspect
      | :anaerobic_activity
      | :android_platform
      | :anesthesia
      | :appearance
      | :audiobook_format
      | :authoritative_legal_value
      | :ayurvedic
      | :back_order
      | :bacteria
      | :balance
      | :basic_income
      | :benefits_health_aspect
      | :body_measurement_arm
      | :body_measurement_bust
      | :body_measurement_chest
      | :body_measurement_foot
      | :body_measurement_hand
      | :body_measurement_head
      | :body_measurement_height
      | :body_measurement_hips
      | :body_measurement_inside_leg
      | :body_measurement_neck
      | :body_measurement_underbust
      | :body_measurement_waist
      | :body_measurement_weight
      | :broadcast_release
      | :business_support
      | :by_bank_transfer_in_advance
      | :by_invoice
      | :cardiovascular
      | :cardiovascular_exam
      | :case_series
      | :cash
      | :cassette_format
      | :causes_health_aspect
      | :cd_format
      | :certification_active
      | :certification_inactive
      | :charitable_incorporated_organization
      | :check_in_advance
      | :chiropractic
      | :cleaning_fee
      | :clinician
      | :co_op
      | :cod
      | :cohort_study
      | :comment_permission
      | :community_health
      | :compilation_album
      | :completed
      | :completed_action_status
      | :composite_capture_digital_source
      | :composite_digital_source
      | :composite_synthetic_digital_source
      | :composite_with_trained_algorithmic_media_digital_source
      | :contagiousness_health_aspect
      | :cross_sectional
      | :ct
      | :damaged_condition
      | :dangerous_good_consideration
      | :data_driven_media_digital_source
      | :de_cooperative_charity
      | :de_foundation_charity
      | :de_joint_stock_company_charity
      | :de_limited_liability_charity
      | :de_not_registered_association_charity
      | :de_public_charity
      | :de_registered_association_charity
      | :decontextualized_content
      | :definitive_legal_value
      | :demo_album
      | :demo_game_availability
      | :dentistry
      | :dermatologic
      | :dermatology
      | :desktop_web_platform
      | :diabetic_diet
      | :diagnostic
      | :diet_nutrition
      | :digital_art_digital_source
      | :digital_audio_tape_format
      | :digital_capture_digital_source
      | :digital_format
      | :direct_debit
      | :disability_support
      | :discontinued
      | :distance_fee
      | :dj_mix_album
      | :double_blinded_trial
      | :downpayment
      | :driving_school_vehicle_usage
      | :dvd_format
      | :e_book
      | :ear
      | :edited_or_cropped_content
      | :effectiveness_health_aspect
      | :emergency
      | :endocrine
      | :energy_star_certified
      | :enrolling_by_invitation
      | :ep_release
      | :eu_energy_efficiency_category_a
      | :eu_energy_efficiency_category_a1_plus
      | :eu_energy_efficiency_category_a2_plus
      | :eu_energy_efficiency_category_a3_plus
      | :eu_energy_efficiency_category_b
      | :eu_energy_efficiency_category_c
      | :eu_energy_efficiency_category_d
      | :eu_energy_efficiency_category_e
      | :eu_energy_efficiency_category_f
      | :eu_energy_efficiency_category_g
      | :event_cancelled
      | :event_moved_online
      | :event_postponed
      | :event_rescheduled
      | :event_scheduled
      | :evidence_level_a
      | :evidence_level_b
      | :evidence_level_c
      | :example_measurement_method_enum
      | :exchange_refund
      | :eye
      | :failed_action_status
      | :fd_acategory_a
      | :fd_acategory_b
      | :fd_acategory_c
      | :fd_acategory_d
      | :fd_acategory_x
      | :fd_anot_evaluated
      | :female
      | :flexibility
      | :four_wheel_drive_configuration
      | :free_return
      | :friday
      | :front_wheel_drive_configuration
      | :fulfillment_type_collection_point
      | :fulfillment_type_delivery
      | :fulfillment_type_pickup_dropoff
      | :fulfillment_type_pickup_in_store
      | :fulfillment_type_scheduled_delivery
      | :full_game_availability
      | :full_refund
      | :fungus
      | :gastroenterologic
      | :generic_web_platform
      | :genetic
      | :genitourinary
      | :geriatric
      | :getting_access_health_aspect
      | :gluten_free_diet
      | :graphic_novel
      | :group_boarding_policy
      | :gynecologic
      | :halal_diet
      | :hardcover
      | :head
      | :health_care
      | :healthcare_consideration
      | :hearing_impaired_supported
      | :hematologic
      | :hindu_diet
      | :homeopathic
      | :how_it_works_health_aspect
      | :how_or_where_health_aspect
      | :in_force
      | :in_stock
      | :in_store_only
      | :in_store_prepay
      | :incentive_qualified_expense_type_goods_only
      | :incentive_qualified_expense_type_goods_or_services
      | :incentive_qualified_expense_type_services_only
      | :incentive_qualified_expense_type_utility_bill
      | :incentive_status_active
      | :incentive_status_in_development
      | :incentive_status_on_hold
      | :incentive_status_retired
      | :incentive_type_loan
      | :incentive_type_rebate_or_subsidy
      | :incentive_type_tax_credit
      | :incentive_type_tax_deduction
      | :incentive_type_tax_waiver
      | :infectious
      | :ingredients_health_aspect
      | :installment
      | :international_trial
      | :invoice_price
      | :ios_platform
      | :it_cooperative_charity
      | :it_mutual_aid_charity
      | :it_social_company_charity
      | :it_social_promotion_charity
      | :it_sport_company_charity
      | :it_volunteer_association_charity
      | :item_list_order_ascending
      | :item_list_order_descending
      | :item_list_unordered
      | :keep_product
      | :kosher_diet
      | :laboratory_science
      | :laser_disc_format
      | :left_hand_driving
      | :leisure_time_activity
      | :limited_availability
      | :limited_by_guarantee_charity
      | :list_price
      | :live_album
      | :living_with_health_aspect
      | :locker_delivery
      | :longitudinal
      | :low_calorie_diet
      | :low_fat_diet
      | :low_lactose_diet
      | :low_salt_diet
      | :lung
      | :made_to_order
      | :male
      | :may_treat_health_aspect
      | :medical_researcher
      | :merchant_return_finite_return_window
      | :merchant_return_not_permitted
      | :merchant_return_unlimited_window
      | :merchant_return_unspecified
      | :midwifery
      | :minimum_advertised_price
      | :minor_human_edits_digital_source
      | :misconceptions_health_aspect
      | :mixed_event_attendance_mode
      | :mixtape_album
      | :mobile_web_platform
      | :monday
      | :mri
      | :msrp
      | :multi_center_trial
      | :multi_frame_computational_capture_digital_source
      | :multi_player
      | :multicellular_parasite
      | :musculoskeletal
      | :musculoskeletal_exam
      | :narcotic_consideration
      | :neck
      | :negative_film_digital_source
      | :neuro
      | :neurologic
      | :new_condition
      | :noninvasive_procedure
      | :nonprofit501a
      | :nonprofit501c1
      | :nonprofit501c10
      | :nonprofit501c11
      | :nonprofit501c12
      | :nonprofit501c13
      | :nonprofit501c14
      | :nonprofit501c15
      | :nonprofit501c16
      | :nonprofit501c17
      | :nonprofit501c18
      | :nonprofit501c19
      | :nonprofit501c2
      | :nonprofit501c20
      | :nonprofit501c21
      | :nonprofit501c22
      | :nonprofit501c23
      | :nonprofit501c24
      | :nonprofit501c25
      | :nonprofit501c26
      | :nonprofit501c27
      | :nonprofit501c28
      | :nonprofit501c3
      | :nonprofit501c4
      | :nonprofit501c5
      | :nonprofit501c6
      | :nonprofit501c7
      | :nonprofit501c8
      | :nonprofit501c9
      | :nonprofit501d
      | :nonprofit501e
      | :nonprofit501f
      | :nonprofit501k
      | :nonprofit501n
      | :nonprofit501q
      | :nonprofit527
      | :nonprofit_anbi
      | :nonprofit_sbbi
      | :nose
      | :not_in_force
      | :not_yet_recruiting
      | :nursing
      | :observational
      | :obstetric
      | :occupational_activity
      | :official_legal_value
      | :offline_event_attendance_mode
      | :offline_permanently
      | :offline_temporarily
      | :on_site_pickup
      | :oncologic
      | :one_time_payments
      | :online
      | :online_event_attendance_mode
      | :online_full
      | :online_only
      | :open_trial
      | :optometric
      | :order_cancelled
      | :order_delivered
      | :order_in_transit
      | :order_payment_due
      | :order_pickup_available
      | :order_problem
      | :order_processing
      | :order_returned
      | :original_media_content
      | :original_shipping_fees
      | :osteopathic
      | :otc
      | :otolaryngologic
      | :out_of_stock
      | :overview_health_aspect
      | :paid_leave
      | :pamphlet
      | :paperback
      | :parcel_service
      | :parental_support
      | :parking_map
      | :partially_in_force
      | :pathology
      | :patient_experience_health_aspect
      | :payment_automatically_applied
      | :payment_complete
      | :payment_declined
      | :payment_due
      | :payment_past_due
      | :pediatric
      | :percutaneous_procedure
      | :pet
      | :pharmacy_specialty
      | :phone_carrier_payment
      | :physiotherapy
      | :placebo_controlled_trial
      | :plastic_surgery
      | :podiatric
      | :positive_film_digital_source
      | :potential_action_status
      | :pre_order
      | :pre_sale
      | :pregnancy_health_aspect
      | :prescription_only
      | :prevention_health_aspect
      | :primary_care
      | :print_digital_source
      | :prion
      | :prognosis_health_aspect
      | :protozoa
      | :psychiatric
      | :public_health
      | :public_holidays
      | :pulmonary
      | :purchase_type_lease
      | :purchase_type_new_purchase
      | :purchase_type_trade_in
      | :purchase_type_used_purchase
      | :radiography
      | :randomized_trial
      | :read_permission
      | :rear_wheel_drive_configuration
      | :recruiting
      | :reduced_relevance_for_children_consideration
      | :refurbished_condition
      | :registry
      | :regular_price
      | :reimbursement_cap
      | :related_topics_health_aspect
      | :remix_album
      | :renal
      | :rental_vehicle_usage
      | :reservation_cancelled
      | :reservation_confirmed
      | :reservation_hold
      | :reservation_pending
      | :reserved
      | :respiratory_therapy
      | :restocking_fees
      | :results_available
      | :results_not_available
      | :retail
      | :return_at_kiosk
      | :return_by_mail
      | :return_fees_customer_responsibility
      | :return_in_store
      | :return_label_customer_responsibility
      | :return_label_download_and_print
      | :return_label_in_box
      | :return_shipping_fees
      | :rheumatologic
      | :right_hand_driving
      | :risks_or_complications_health_aspect
      | :rsvp_response_maybe
      | :rsvp_response_no
      | :rsvp_response_yes
      | :safety_health_aspect
      | :sale_price
      | :satire_or_parody_content
      | :saturday
      | :screen_capture_digital_source
      | :screening_health_aspect
      | :seating_map
      | :see_doctor_health_aspect
      | :self_care_health_aspect
      | :sexual_content_consideration
      | :side_effects_health_aspect
      | :single_blinded_trial
      | :single_center_trial
      | :single_player
      | :single_release
      | :size_system_imperial
      | :size_system_metric
      | :skin
      | :sold_out
      | :soundtrack_album
      | :speech_pathology
      | :spoken_word_album
      | :srp
      | :staged_content
      | :stages_health_aspect
      | :store_credit_refund
      | :strength_training
      | :strikethrough_price
      | :studio_album
      | :subscription
      | :sunday
      | :surgical
      | :suspended
      | :symptoms_health_aspect
      | :taxi_vehicle_usage
      | :terminated
      | :therapeutic
      | :throat
      | :thursday
      | :tier_benefit_loyalty_points
      | :tier_benefit_loyalty_price
      | :tier_benefit_loyalty_returns
      | :tier_benefit_loyalty_shipping
      | :tobacco_nicotine_consideration
      | :toll_free
      | :toxicologic
      | :traditional_chinese
      | :trained_algorithmic_media_digital_source
      | :transformed_content
      | :transit_map
      | :treatments_health_aspect
      | :triple_blinded_trial
      | :tuesday
      | :types_health_aspect
      | :uk_trust
      | :ultrasound
      | :unclassified_adult_consideration
      | :unemployment_support
      | :unincorporated_association_charity
      | :unofficial_legal_value
      | :urologic
      | :usage_or_schedule_health_aspect
      | :used_condition
      | :vegan_diet
      | :vegetarian_diet
      | :venue_map
      | :vinyl_format
      | :violence_consideration
      | :virtual_recording_digital_source
      | :virus
      | :weapon_consideration
      | :wearable_measurement_back
      | :wearable_measurement_chest_or_bust
      | :wearable_measurement_collar
      | :wearable_measurement_cup
      | :wearable_measurement_height
      | :wearable_measurement_hips
      | :wearable_measurement_inseam
      | :wearable_measurement_length
      | :wearable_measurement_outside_leg
      | :wearable_measurement_sleeve
      | :wearable_measurement_waist
      | :wearable_measurement_width
      | :wearable_size_group_big
      | :wearable_size_group_boys
      | :wearable_size_group_extra_short
      | :wearable_size_group_extra_tall
      | :wearable_size_group_girls
      | :wearable_size_group_husky
      | :wearable_size_group_infants
      | :wearable_size_group_juniors
      | :wearable_size_group_maternity
      | :wearable_size_group_mens
      | :wearable_size_group_misses
      | :wearable_size_group_petite
      | :wearable_size_group_plus
      | :wearable_size_group_regular
      | :wearable_size_group_short
      | :wearable_size_group_tall
      | :wearable_size_group_womens
      | :wearable_size_system_au
      | :wearable_size_system_br
      | :wearable_size_system_cn
      | :wearable_size_system_continental
      | :wearable_size_system_de
      | :wearable_size_system_en13402
      | :wearable_size_system_europe
      | :wearable_size_system_fr
      | :wearable_size_system_gs1
      | :wearable_size_system_it
      | :wearable_size_system_jp
      | :wearable_size_system_mx
      | :wearable_size_system_uk
      | :wearable_size_system_us
      | :wednesday
      | :western_conventional
      | :wholesale
      | :withdrawn
      | :write_permission
      | :x_ray
      | :zone_boarding_policy
      | SEO.JSONLD.Property.t()
      | map()
      | t(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      superseded_by:
        :abdomen
        | :activation_fee
        | :active_action_status
        | :active_not_recruiting
        | :aerobic_activity
        | :album_release
        | :alcohol_consideration
        | :algorithmic_media_digital_source
        | :algorithmically_enhanced_digital_source
        | :all_wheel_drive_configuration
        | :allergies_health_aspect
        | :anaerobic_activity
        | :android_platform
        | :anesthesia
        | :appearance
        | :audiobook_format
        | :authoritative_legal_value
        | :ayurvedic
        | :back_order
        | :bacteria
        | :balance
        | :basic_income
        | :benefits_health_aspect
        | :body_measurement_arm
        | :body_measurement_bust
        | :body_measurement_chest
        | :body_measurement_foot
        | :body_measurement_hand
        | :body_measurement_head
        | :body_measurement_height
        | :body_measurement_hips
        | :body_measurement_inside_leg
        | :body_measurement_neck
        | :body_measurement_underbust
        | :body_measurement_waist
        | :body_measurement_weight
        | :broadcast_release
        | :business_support
        | :by_bank_transfer_in_advance
        | :by_invoice
        | :cardiovascular
        | :cardiovascular_exam
        | :case_series
        | :cash
        | :cassette_format
        | :causes_health_aspect
        | :cd_format
        | :certification_active
        | :certification_inactive
        | :charitable_incorporated_organization
        | :check_in_advance
        | :chiropractic
        | :cleaning_fee
        | :clinician
        | :co_op
        | :cod
        | :cohort_study
        | :comment_permission
        | :community_health
        | :compilation_album
        | :completed
        | :completed_action_status
        | :composite_capture_digital_source
        | :composite_digital_source
        | :composite_synthetic_digital_source
        | :composite_with_trained_algorithmic_media_digital_source
        | :contagiousness_health_aspect
        | :cross_sectional
        | :ct
        | :damaged_condition
        | :dangerous_good_consideration
        | :data_driven_media_digital_source
        | :de_cooperative_charity
        | :de_foundation_charity
        | :de_joint_stock_company_charity
        | :de_limited_liability_charity
        | :de_not_registered_association_charity
        | :de_public_charity
        | :de_registered_association_charity
        | :decontextualized_content
        | :definitive_legal_value
        | :demo_album
        | :demo_game_availability
        | :dentistry
        | :dermatologic
        | :dermatology
        | :desktop_web_platform
        | :diabetic_diet
        | :diagnostic
        | :diet_nutrition
        | :digital_art_digital_source
        | :digital_audio_tape_format
        | :digital_capture_digital_source
        | :digital_format
        | :direct_debit
        | :disability_support
        | :discontinued
        | :distance_fee
        | :dj_mix_album
        | :double_blinded_trial
        | :downpayment
        | :driving_school_vehicle_usage
        | :dvd_format
        | :e_book
        | :ear
        | :edited_or_cropped_content
        | :effectiveness_health_aspect
        | :emergency
        | :endocrine
        | :energy_star_certified
        | :enrolling_by_invitation
        | :ep_release
        | :eu_energy_efficiency_category_a
        | :eu_energy_efficiency_category_a1_plus
        | :eu_energy_efficiency_category_a2_plus
        | :eu_energy_efficiency_category_a3_plus
        | :eu_energy_efficiency_category_b
        | :eu_energy_efficiency_category_c
        | :eu_energy_efficiency_category_d
        | :eu_energy_efficiency_category_e
        | :eu_energy_efficiency_category_f
        | :eu_energy_efficiency_category_g
        | :event_cancelled
        | :event_moved_online
        | :event_postponed
        | :event_rescheduled
        | :event_scheduled
        | :evidence_level_a
        | :evidence_level_b
        | :evidence_level_c
        | :example_measurement_method_enum
        | :exchange_refund
        | :eye
        | :failed_action_status
        | :fd_acategory_a
        | :fd_acategory_b
        | :fd_acategory_c
        | :fd_acategory_d
        | :fd_acategory_x
        | :fd_anot_evaluated
        | :female
        | :flexibility
        | :four_wheel_drive_configuration
        | :free_return
        | :friday
        | :front_wheel_drive_configuration
        | :fulfillment_type_collection_point
        | :fulfillment_type_delivery
        | :fulfillment_type_pickup_dropoff
        | :fulfillment_type_pickup_in_store
        | :fulfillment_type_scheduled_delivery
        | :full_game_availability
        | :full_refund
        | :fungus
        | :gastroenterologic
        | :generic_web_platform
        | :genetic
        | :genitourinary
        | :geriatric
        | :getting_access_health_aspect
        | :gluten_free_diet
        | :graphic_novel
        | :group_boarding_policy
        | :gynecologic
        | :halal_diet
        | :hardcover
        | :head
        | :health_care
        | :healthcare_consideration
        | :hearing_impaired_supported
        | :hematologic
        | :hindu_diet
        | :homeopathic
        | :how_it_works_health_aspect
        | :how_or_where_health_aspect
        | :in_force
        | :in_stock
        | :in_store_only
        | :in_store_prepay
        | :incentive_qualified_expense_type_goods_only
        | :incentive_qualified_expense_type_goods_or_services
        | :incentive_qualified_expense_type_services_only
        | :incentive_qualified_expense_type_utility_bill
        | :incentive_status_active
        | :incentive_status_in_development
        | :incentive_status_on_hold
        | :incentive_status_retired
        | :incentive_type_loan
        | :incentive_type_rebate_or_subsidy
        | :incentive_type_tax_credit
        | :incentive_type_tax_deduction
        | :incentive_type_tax_waiver
        | :infectious
        | :ingredients_health_aspect
        | :installment
        | :international_trial
        | :invoice_price
        | :ios_platform
        | :it_cooperative_charity
        | :it_mutual_aid_charity
        | :it_social_company_charity
        | :it_social_promotion_charity
        | :it_sport_company_charity
        | :it_volunteer_association_charity
        | :item_list_order_ascending
        | :item_list_order_descending
        | :item_list_unordered
        | :keep_product
        | :kosher_diet
        | :laboratory_science
        | :laser_disc_format
        | :left_hand_driving
        | :leisure_time_activity
        | :limited_availability
        | :limited_by_guarantee_charity
        | :list_price
        | :live_album
        | :living_with_health_aspect
        | :locker_delivery
        | :longitudinal
        | :low_calorie_diet
        | :low_fat_diet
        | :low_lactose_diet
        | :low_salt_diet
        | :lung
        | :made_to_order
        | :male
        | :may_treat_health_aspect
        | :medical_researcher
        | :merchant_return_finite_return_window
        | :merchant_return_not_permitted
        | :merchant_return_unlimited_window
        | :merchant_return_unspecified
        | :midwifery
        | :minimum_advertised_price
        | :minor_human_edits_digital_source
        | :misconceptions_health_aspect
        | :mixed_event_attendance_mode
        | :mixtape_album
        | :mobile_web_platform
        | :monday
        | :mri
        | :msrp
        | :multi_center_trial
        | :multi_frame_computational_capture_digital_source
        | :multi_player
        | :multicellular_parasite
        | :musculoskeletal
        | :musculoskeletal_exam
        | :narcotic_consideration
        | :neck
        | :negative_film_digital_source
        | :neuro
        | :neurologic
        | :new_condition
        | :noninvasive_procedure
        | :nonprofit501a
        | :nonprofit501c1
        | :nonprofit501c10
        | :nonprofit501c11
        | :nonprofit501c12
        | :nonprofit501c13
        | :nonprofit501c14
        | :nonprofit501c15
        | :nonprofit501c16
        | :nonprofit501c17
        | :nonprofit501c18
        | :nonprofit501c19
        | :nonprofit501c2
        | :nonprofit501c20
        | :nonprofit501c21
        | :nonprofit501c22
        | :nonprofit501c23
        | :nonprofit501c24
        | :nonprofit501c25
        | :nonprofit501c26
        | :nonprofit501c27
        | :nonprofit501c28
        | :nonprofit501c3
        | :nonprofit501c4
        | :nonprofit501c5
        | :nonprofit501c6
        | :nonprofit501c7
        | :nonprofit501c8
        | :nonprofit501c9
        | :nonprofit501d
        | :nonprofit501e
        | :nonprofit501f
        | :nonprofit501k
        | :nonprofit501n
        | :nonprofit501q
        | :nonprofit527
        | :nonprofit_anbi
        | :nonprofit_sbbi
        | :nose
        | :not_in_force
        | :not_yet_recruiting
        | :nursing
        | :observational
        | :obstetric
        | :occupational_activity
        | :official_legal_value
        | :offline_event_attendance_mode
        | :offline_permanently
        | :offline_temporarily
        | :on_site_pickup
        | :oncologic
        | :one_time_payments
        | :online
        | :online_event_attendance_mode
        | :online_full
        | :online_only
        | :open_trial
        | :optometric
        | :order_cancelled
        | :order_delivered
        | :order_in_transit
        | :order_payment_due
        | :order_pickup_available
        | :order_problem
        | :order_processing
        | :order_returned
        | :original_media_content
        | :original_shipping_fees
        | :osteopathic
        | :otc
        | :otolaryngologic
        | :out_of_stock
        | :overview_health_aspect
        | :paid_leave
        | :pamphlet
        | :paperback
        | :parcel_service
        | :parental_support
        | :parking_map
        | :partially_in_force
        | :pathology
        | :patient_experience_health_aspect
        | :payment_automatically_applied
        | :payment_complete
        | :payment_declined
        | :payment_due
        | :payment_past_due
        | :pediatric
        | :percutaneous_procedure
        | :pet
        | :pharmacy_specialty
        | :phone_carrier_payment
        | :physiotherapy
        | :placebo_controlled_trial
        | :plastic_surgery
        | :podiatric
        | :positive_film_digital_source
        | :potential_action_status
        | :pre_order
        | :pre_sale
        | :pregnancy_health_aspect
        | :prescription_only
        | :prevention_health_aspect
        | :primary_care
        | :print_digital_source
        | :prion
        | :prognosis_health_aspect
        | :protozoa
        | :psychiatric
        | :public_health
        | :public_holidays
        | :pulmonary
        | :purchase_type_lease
        | :purchase_type_new_purchase
        | :purchase_type_trade_in
        | :purchase_type_used_purchase
        | :radiography
        | :randomized_trial
        | :read_permission
        | :rear_wheel_drive_configuration
        | :recruiting
        | :reduced_relevance_for_children_consideration
        | :refurbished_condition
        | :registry
        | :regular_price
        | :reimbursement_cap
        | :related_topics_health_aspect
        | :remix_album
        | :renal
        | :rental_vehicle_usage
        | :reservation_cancelled
        | :reservation_confirmed
        | :reservation_hold
        | :reservation_pending
        | :reserved
        | :respiratory_therapy
        | :restocking_fees
        | :results_available
        | :results_not_available
        | :retail
        | :return_at_kiosk
        | :return_by_mail
        | :return_fees_customer_responsibility
        | :return_in_store
        | :return_label_customer_responsibility
        | :return_label_download_and_print
        | :return_label_in_box
        | :return_shipping_fees
        | :rheumatologic
        | :right_hand_driving
        | :risks_or_complications_health_aspect
        | :rsvp_response_maybe
        | :rsvp_response_no
        | :rsvp_response_yes
        | :safety_health_aspect
        | :sale_price
        | :satire_or_parody_content
        | :saturday
        | :screen_capture_digital_source
        | :screening_health_aspect
        | :seating_map
        | :see_doctor_health_aspect
        | :self_care_health_aspect
        | :sexual_content_consideration
        | :side_effects_health_aspect
        | :single_blinded_trial
        | :single_center_trial
        | :single_player
        | :single_release
        | :size_system_imperial
        | :size_system_metric
        | :skin
        | :sold_out
        | :soundtrack_album
        | :speech_pathology
        | :spoken_word_album
        | :srp
        | :staged_content
        | :stages_health_aspect
        | :store_credit_refund
        | :strength_training
        | :strikethrough_price
        | :studio_album
        | :subscription
        | :sunday
        | :surgical
        | :suspended
        | :symptoms_health_aspect
        | :taxi_vehicle_usage
        | :terminated
        | :therapeutic
        | :throat
        | :thursday
        | :tier_benefit_loyalty_points
        | :tier_benefit_loyalty_price
        | :tier_benefit_loyalty_returns
        | :tier_benefit_loyalty_shipping
        | :tobacco_nicotine_consideration
        | :toll_free
        | :toxicologic
        | :traditional_chinese
        | :trained_algorithmic_media_digital_source
        | :transformed_content
        | :transit_map
        | :treatments_health_aspect
        | :triple_blinded_trial
        | :tuesday
        | :types_health_aspect
        | :uk_trust
        | :ultrasound
        | :unclassified_adult_consideration
        | :unemployment_support
        | :unincorporated_association_charity
        | :unofficial_legal_value
        | :urologic
        | :usage_or_schedule_health_aspect
        | :used_condition
        | :vegan_diet
        | :vegetarian_diet
        | :venue_map
        | :vinyl_format
        | :violence_consideration
        | :virtual_recording_digital_source
        | :virus
        | :weapon_consideration
        | :wearable_measurement_back
        | :wearable_measurement_chest_or_bust
        | :wearable_measurement_collar
        | :wearable_measurement_cup
        | :wearable_measurement_height
        | :wearable_measurement_hips
        | :wearable_measurement_inseam
        | :wearable_measurement_length
        | :wearable_measurement_outside_leg
        | :wearable_measurement_sleeve
        | :wearable_measurement_waist
        | :wearable_measurement_width
        | :wearable_size_group_big
        | :wearable_size_group_boys
        | :wearable_size_group_extra_short
        | :wearable_size_group_extra_tall
        | :wearable_size_group_girls
        | :wearable_size_group_husky
        | :wearable_size_group_infants
        | :wearable_size_group_juniors
        | :wearable_size_group_maternity
        | :wearable_size_group_mens
        | :wearable_size_group_misses
        | :wearable_size_group_petite
        | :wearable_size_group_plus
        | :wearable_size_group_regular
        | :wearable_size_group_short
        | :wearable_size_group_tall
        | :wearable_size_group_womens
        | :wearable_size_system_au
        | :wearable_size_system_br
        | :wearable_size_system_cn
        | :wearable_size_system_continental
        | :wearable_size_system_de
        | :wearable_size_system_en13402
        | :wearable_size_system_europe
        | :wearable_size_system_fr
        | :wearable_size_system_gs1
        | :wearable_size_system_it
        | :wearable_size_system_jp
        | :wearable_size_system_mx
        | :wearable_size_system_uk
        | :wearable_size_system_us
        | :wednesday
        | :western_conventional
        | :wholesale
        | :withdrawn
        | :write_permission
        | :x_ray
        | :zone_boarding_policy
        | SEO.JSONLD.Property.t()
        | map()
        | t(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a Class JSON-LD map.

Fields

:superseded_by - Relates a term (i.e. a property, class or enumeration) to one that supersedes it. One of: :abdomen, :activation_fee, :active_action_status, :active_not_recruiting, :aerobic_activity, :album_release, :alcohol_consideration, :algorithmic_media_digital_source, :algorithmically_enhanced_digital_source, :all_wheel_drive_configuration, :allergies_health_aspect, :anaerobic_activity, :android_platform, :anesthesia, :appearance, :audiobook_format, :authoritative_legal_value, :ayurvedic, :back_order, :bacteria, :balance, :basic_income, :benefits_health_aspect, :body_measurement_arm, :body_measurement_bust, :body_measurement_chest, :body_measurement_foot, :body_measurement_hand, :body_measurement_head, :body_measurement_height, :body_measurement_hips, :body_measurement_inside_leg, :body_measurement_neck, :body_measurement_underbust, :body_measurement_waist, :body_measurement_weight, :broadcast_release, :business_support, :by_bank_transfer_in_advance, :by_invoice, :cardiovascular, :cardiovascular_exam, :case_series, :cash, :cassette_format, :causes_health_aspect, :cd_format, :certification_active, :certification_inactive, :charitable_incorporated_organization, :check_in_advance, :chiropractic, :cleaning_fee, :clinician, :co_op, :cod, :cohort_study, :comment_permission, :community_health, :compilation_album, :completed, :completed_action_status, :composite_capture_digital_source, :composite_digital_source, :composite_synthetic_digital_source, :composite_with_trained_algorithmic_media_digital_source, :contagiousness_health_aspect, :cross_sectional, :ct, :damaged_condition, :dangerous_good_consideration, :data_driven_media_digital_source, :de_cooperative_charity, :de_foundation_charity, :de_joint_stock_company_charity, :de_limited_liability_charity, :de_not_registered_association_charity, :de_public_charity, :de_registered_association_charity, :decontextualized_content, :definitive_legal_value, :demo_album, :demo_game_availability, :dentistry, :dermatologic, :dermatology, :desktop_web_platform, :diabetic_diet, :diagnostic, :diet_nutrition, :digital_art_digital_source, :digital_audio_tape_format, :digital_capture_digital_source, :digital_format, :direct_debit, :disability_support, :discontinued, :distance_fee, :dj_mix_album, :double_blinded_trial, :downpayment, :driving_school_vehicle_usage, :dvd_format, :e_book, :ear, :edited_or_cropped_content, :effectiveness_health_aspect, :emergency, :endocrine, :energy_star_certified, :enrolling_by_invitation, :ep_release, :eu_energy_efficiency_category_a, :eu_energy_efficiency_category_a1_plus, :eu_energy_efficiency_category_a2_plus, :eu_energy_efficiency_category_a3_plus, :eu_energy_efficiency_category_b, :eu_energy_efficiency_category_c, :eu_energy_efficiency_category_d, :eu_energy_efficiency_category_e, :eu_energy_efficiency_category_f, :eu_energy_efficiency_category_g, :event_cancelled, :event_moved_online, :event_postponed, :event_rescheduled, :event_scheduled, :evidence_level_a, :evidence_level_b, :evidence_level_c, :example_measurement_method_enum, :exchange_refund, :eye, :failed_action_status, :fd_acategory_a, :fd_acategory_b, :fd_acategory_c, :fd_acategory_d, :fd_acategory_x, :fd_anot_evaluated, :female, :flexibility, :four_wheel_drive_configuration, :free_return, :friday, :front_wheel_drive_configuration, :fulfillment_type_collection_point, :fulfillment_type_delivery, :fulfillment_type_pickup_dropoff, :fulfillment_type_pickup_in_store, :fulfillment_type_scheduled_delivery, :full_game_availability, :full_refund, :fungus, :gastroenterologic, :generic_web_platform, :genetic, :genitourinary, :geriatric, :getting_access_health_aspect, :gluten_free_diet, :graphic_novel, :group_boarding_policy, :gynecologic, :halal_diet, :hardcover, :head, :health_care, :healthcare_consideration, :hearing_impaired_supported, :hematologic, :hindu_diet, :homeopathic, :how_it_works_health_aspect, :how_or_where_health_aspect, :in_force, :in_stock, :in_store_only, :in_store_prepay, :incentive_qualified_expense_type_goods_only, :incentive_qualified_expense_type_goods_or_services, :incentive_qualified_expense_type_services_only, :incentive_qualified_expense_type_utility_bill, :incentive_status_active, :incentive_status_in_development, :incentive_status_on_hold, :incentive_status_retired, :incentive_type_loan, :incentive_type_rebate_or_subsidy, :incentive_type_tax_credit, :incentive_type_tax_deduction, :incentive_type_tax_waiver, :infectious, :ingredients_health_aspect, :installment, :international_trial, :invoice_price, :ios_platform, :it_cooperative_charity, :it_mutual_aid_charity, :it_social_company_charity, :it_social_promotion_charity, :it_sport_company_charity, :it_volunteer_association_charity, :item_list_order_ascending, :item_list_order_descending, :item_list_unordered, :keep_product, :kosher_diet, :laboratory_science, :laser_disc_format, :left_hand_driving, :leisure_time_activity, :limited_availability, :limited_by_guarantee_charity, :list_price, :live_album, :living_with_health_aspect, :locker_delivery, :longitudinal, :low_calorie_diet, :low_fat_diet, :low_lactose_diet, :low_salt_diet, :lung, :made_to_order, :male, :may_treat_health_aspect, :medical_researcher, :merchant_return_finite_return_window, :merchant_return_not_permitted, :merchant_return_unlimited_window, :merchant_return_unspecified, :midwifery, :minimum_advertised_price, :minor_human_edits_digital_source, :misconceptions_health_aspect, :mixed_event_attendance_mode, :mixtape_album, :mobile_web_platform, :monday, :mri, :msrp, :multi_center_trial, :multi_frame_computational_capture_digital_source, :multi_player, :multicellular_parasite, :musculoskeletal, :musculoskeletal_exam, :narcotic_consideration, :neck, :negative_film_digital_source, :neuro, :neurologic, :new_condition, :noninvasive_procedure, :nonprofit501a, :nonprofit501c1, :nonprofit501c10, :nonprofit501c11, :nonprofit501c12, :nonprofit501c13, :nonprofit501c14, :nonprofit501c15, :nonprofit501c16, :nonprofit501c17, :nonprofit501c18, :nonprofit501c19, :nonprofit501c2, :nonprofit501c20, :nonprofit501c21, :nonprofit501c22, :nonprofit501c23, :nonprofit501c24, :nonprofit501c25, :nonprofit501c26, :nonprofit501c27, :nonprofit501c28, :nonprofit501c3, :nonprofit501c4, :nonprofit501c5, :nonprofit501c6, :nonprofit501c7, :nonprofit501c8, :nonprofit501c9, :nonprofit501d, :nonprofit501e, :nonprofit501f, :nonprofit501k, :nonprofit501n, :nonprofit501q, :nonprofit527, :nonprofit_anbi, :nonprofit_sbbi, :nose, :not_in_force, :not_yet_recruiting, :nursing, :observational, :obstetric, :occupational_activity, :official_legal_value, :offline_event_attendance_mode, :offline_permanently, :offline_temporarily, :on_site_pickup, :oncologic, :one_time_payments, :online, :online_event_attendance_mode, :online_full, :online_only, :open_trial, :optometric, :order_cancelled, :order_delivered, :order_in_transit, :order_payment_due, :order_pickup_available, :order_problem, :order_processing, :order_returned, :original_media_content, :original_shipping_fees, :osteopathic, :otc, :otolaryngologic, :out_of_stock, :overview_health_aspect, :paid_leave, :pamphlet, :paperback, :parcel_service, :parental_support, :parking_map, :partially_in_force, :pathology, :patient_experience_health_aspect, :payment_automatically_applied, :payment_complete, :payment_declined, :payment_due, :payment_past_due, :pediatric, :percutaneous_procedure, :pet, :pharmacy_specialty, :phone_carrier_payment, :physiotherapy, :placebo_controlled_trial, :plastic_surgery, :podiatric, :positive_film_digital_source, :potential_action_status, :pre_order, :pre_sale, :pregnancy_health_aspect, :prescription_only, :prevention_health_aspect, :primary_care, :print_digital_source, :prion, :prognosis_health_aspect, :protozoa, :psychiatric, :public_health, :public_holidays, :pulmonary, :purchase_type_lease, :purchase_type_new_purchase, :purchase_type_trade_in, :purchase_type_used_purchase, :radiography, :randomized_trial, :read_permission, :rear_wheel_drive_configuration, :recruiting, :reduced_relevance_for_children_consideration, :refurbished_condition, :registry, :regular_price, :reimbursement_cap, :related_topics_health_aspect, :remix_album, :renal, :rental_vehicle_usage, :reservation_cancelled, :reservation_confirmed, :reservation_hold, :reservation_pending, :reserved, :respiratory_therapy, :restocking_fees, :results_available, :results_not_available, :retail, :return_at_kiosk, :return_by_mail, :return_fees_customer_responsibility, :return_in_store, :return_label_customer_responsibility, :return_label_download_and_print, :return_label_in_box, :return_shipping_fees, :rheumatologic, :right_hand_driving, :risks_or_complications_health_aspect, :rsvp_response_maybe, :rsvp_response_no, :rsvp_response_yes, :safety_health_aspect, :sale_price, :satire_or_parody_content, :saturday, :screen_capture_digital_source, :screening_health_aspect, :seating_map, :see_doctor_health_aspect, :self_care_health_aspect, :sexual_content_consideration, :side_effects_health_aspect, :single_blinded_trial, :single_center_trial, :single_player, :single_release, :size_system_imperial, :size_system_metric, :skin, :sold_out, :soundtrack_album, :speech_pathology, :spoken_word_album, :srp, :staged_content, :stages_health_aspect, :store_credit_refund, :strength_training, :strikethrough_price, :studio_album, :subscription, :sunday, :surgical, :suspended, :symptoms_health_aspect, :taxi_vehicle_usage, :terminated, :therapeutic, :throat, :thursday, :tier_benefit_loyalty_points, :tier_benefit_loyalty_price, :tier_benefit_loyalty_returns, :tier_benefit_loyalty_shipping, :tobacco_nicotine_consideration, :toll_free, :toxicologic, :traditional_chinese, :trained_algorithmic_media_digital_source, :transformed_content, :transit_map, :treatments_health_aspect, :triple_blinded_trial, :tuesday, :types_health_aspect, :uk_trust, :ultrasound, :unclassified_adult_consideration, :unemployment_support, :unincorporated_association_charity, :unofficial_legal_value, :urologic, :usage_or_schedule_health_aspect, :used_condition, :vegan_diet, :vegetarian_diet, :venue_map, :vinyl_format, :violence_consideration, :virtual_recording_digital_source, :virus, :weapon_consideration, :wearable_measurement_back, :wearable_measurement_chest_or_bust, :wearable_measurement_collar, :wearable_measurement_cup, :wearable_measurement_height, :wearable_measurement_hips, :wearable_measurement_inseam, :wearable_measurement_length, :wearable_measurement_outside_leg, :wearable_measurement_sleeve, :wearable_measurement_waist, :wearable_measurement_width, :wearable_size_group_big, :wearable_size_group_boys, :wearable_size_group_extra_short, :wearable_size_group_extra_tall, :wearable_size_group_girls, :wearable_size_group_husky, :wearable_size_group_infants, :wearable_size_group_juniors, :wearable_size_group_maternity, :wearable_size_group_mens, :wearable_size_group_misses, :wearable_size_group_petite, :wearable_size_group_plus, :wearable_size_group_regular, :wearable_size_group_short, :wearable_size_group_tall, :wearable_size_group_womens, :wearable_size_system_au, :wearable_size_system_br, :wearable_size_system_cn, :wearable_size_system_continental, :wearable_size_system_de, :wearable_size_system_en13402, :wearable_size_system_europe, :wearable_size_system_fr, :wearable_size_system_gs1, :wearable_size_system_it, :wearable_size_system_jp, :wearable_size_system_mx, :wearable_size_system_uk, :wearable_size_system_us, :wednesday, :western_conventional, :wholesale, :withdrawn, :write_permission, :x_ray, :zone_boarding_policy.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties:

SEO.JSONLD.Thing