Module: SchemaOrg::Mixins::ParcelDelivery

Includes:
Intangible
Included in:
ParcelDelivery
Defined in:
lib/schema_org/mixins/parcel_delivery.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from 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=, #subject_of, #subject_of=, #url, #url=

Class Method Details

.schema_property_definitions ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 11

def self.schema_property_definitions
  {
    carrier: {
      schema_name: "carrier",
      schema_url: "https://schema.org/carrier",
      comment_lines: ["'carrier' is an out-dated term indicating the 'provider' for parcel delivery and flights."].freeze,
      ranges: ["Organization"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: "provider",
      supersedes: nil
    }.freeze,
    delivery_address: {
      schema_name: "deliveryAddress",
      schema_url: "https://schema.org/deliveryAddress",
      comment_lines: ["Destination address."].freeze,
      ranges: ["PostalAddress"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    delivery_status: {
      schema_name: "deliveryStatus",
      schema_url: "https://schema.org/deliveryStatus",
      comment_lines: ["New entry added as the package passes through each leg of its journey (from shipment to final delivery)."].freeze,
      ranges: ["DeliveryEvent"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    expected_arrival_from: {
      schema_name: "expectedArrivalFrom",
      schema_url: "https://schema.org/expectedArrivalFrom",
      comment_lines: ["The earliest date the package may arrive."].freeze,
      ranges: ["Date", "DateTime"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    expected_arrival_until: {
      schema_name: "expectedArrivalUntil",
      schema_url: "https://schema.org/expectedArrivalUntil",
      comment_lines: ["The latest date the package may arrive."].freeze,
      ranges: ["Date", "DateTime"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_delivery_method: {
      schema_name: "hasDeliveryMethod",
      schema_url: "https://schema.org/hasDeliveryMethod",
      comment_lines: ["Method used for delivery or shipping."].freeze,
      ranges: ["DeliveryMethod"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    item_shipped: {
      schema_name: "itemShipped",
      schema_url: "https://schema.org/itemShipped",
      comment_lines: ["Item(s) being shipped."].freeze,
      ranges: ["Product"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    origin_address: {
      schema_name: "originAddress",
      schema_url: "https://schema.org/originAddress",
      comment_lines: ["Shipper's address."].freeze,
      ranges: ["PostalAddress"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    part_of_order: {
      schema_name: "partOfOrder",
      schema_url: "https://schema.org/partOfOrder",
      comment_lines: ["The overall order the items in this delivery were included in."].freeze,
      ranges: ["Order"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    provider: {
      schema_name: "provider",
      schema_url: "https://schema.org/provider",
      comment_lines: ["The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller."].freeze,
      ranges: ["Organization", "Person"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["carrier"].freeze
    }.freeze,
    tracking_number: {
      schema_name: "trackingNumber",
      schema_url: "https://schema.org/trackingNumber",
      comment_lines: ["Shipper tracking number."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    tracking_url: {
      schema_name: "trackingUrl",
      schema_url: "https://schema.org/trackingUrl",
      comment_lines: ["Tracking url for the parcel delivery."].freeze,
      ranges: ["URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze
  }.freeze
end

Instance Method Details

#carrier ⇒ Object

'carrier' is an out-dated term indicating the 'provider' for parcel delivery and flights. Superseded by provider.



138
139
140
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 138

def carrier
  read_property(:carrier)
end

#carrier=(value) ⇒ Object

'carrier' is an out-dated term indicating the 'provider' for parcel delivery and flights. Superseded by provider.



144
145
146
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 144

def carrier=(value)
  write_property(:carrier, value)
end

#delivery_address ⇒ Object

Destination address.



149
150
151
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 149

def delivery_address
  read_property(:delivery_address)
end

#delivery_address=(value) ⇒ Object

Destination address.



154
155
156
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 154

def delivery_address=(value)
  write_property(:delivery_address, value)
end

#delivery_status ⇒ Object

New entry added as the package passes through each leg of its journey (from shipment to final delivery).



159
160
161
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 159

def delivery_status
  read_property(:delivery_status)
end

#delivery_status=(value) ⇒ Object

New entry added as the package passes through each leg of its journey (from shipment to final delivery).



164
165
166
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 164

def delivery_status=(value)
  write_property(:delivery_status, value)
end

#expected_arrival_from ⇒ Object

The earliest date the package may arrive.



169
170
171
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 169

def expected_arrival_from
  read_property(:expected_arrival_from)
end

#expected_arrival_from=(value) ⇒ Object

The earliest date the package may arrive.



174
175
176
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 174

def expected_arrival_from=(value)
  write_property(:expected_arrival_from, value)
end

#expected_arrival_until ⇒ Object

The latest date the package may arrive.



179
180
181
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 179

def expected_arrival_until
  read_property(:expected_arrival_until)
end

#expected_arrival_until=(value) ⇒ Object

The latest date the package may arrive.



184
185
186
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 184

def expected_arrival_until=(value)
  write_property(:expected_arrival_until, value)
end

#has_delivery_method ⇒ Object

Method used for delivery or shipping.



189
190
191
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 189

def has_delivery_method
  read_property(:has_delivery_method)
end

#has_delivery_method=(value) ⇒ Object

Method used for delivery or shipping.



194
195
196
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 194

def has_delivery_method=(value)
  write_property(:has_delivery_method, value)
end

#item_shipped ⇒ Object

Item(s) being shipped.



199
200
201
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 199

def item_shipped
  read_property(:item_shipped)
end

#item_shipped=(value) ⇒ Object

Item(s) being shipped.



204
205
206
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 204

def item_shipped=(value)
  write_property(:item_shipped, value)
end

#origin_address ⇒ Object

Shipper's address.



209
210
211
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 209

def origin_address
  read_property(:origin_address)
end

#origin_address=(value) ⇒ Object

Shipper's address.



214
215
216
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 214

def origin_address=(value)
  write_property(:origin_address, value)
end

#part_of_order ⇒ Object

The overall order the items in this delivery were included in.



219
220
221
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 219

def part_of_order
  read_property(:part_of_order)
end

#part_of_order=(value) ⇒ Object

The overall order the items in this delivery were included in.



224
225
226
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 224

def part_of_order=(value)
  write_property(:part_of_order, value)
end

#provider ⇒ Object

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier.



230
231
232
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 230

def provider
  read_property(:provider)
end

#provider=(value) ⇒ Object

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier.



236
237
238
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 236

def provider=(value)
  write_property(:provider, value)
end

#tracking_number ⇒ Object

Shipper tracking number.



241
242
243
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 241

def tracking_number
  read_property(:tracking_number)
end

#tracking_number=(value) ⇒ Object

Shipper tracking number.



246
247
248
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 246

def tracking_number=(value)
  write_property(:tracking_number, value)
end

#tracking_url ⇒ Object

Tracking url for the parcel delivery.



251
252
253
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 251

def tracking_url
  read_property(:tracking_url)
end

#tracking_url=(value) ⇒ Object

Tracking url for the parcel delivery.



256
257
258
 
# File 'lib/schema_org/mixins/parcel_delivery.rb', line 256

def tracking_url=(value)
  write_property(:tracking_url, value)
end