Class: Google::Apis::WalletobjectsV1::TransitObject

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/walletobjects_v1/classes.rb,
lib/google/apis/walletobjects_v1/representations.rb,
lib/google/apis/walletobjects_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TransitObject

Returns a new instance of TransitObject.



8401
8402
8403
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8401

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#activation_status ⇒ Google::Apis::WalletobjectsV1::ActivationStatus

The activation status of the object. This field includes activation status if valuable supports activation. Corresponds to the JSON property activationStatus

Returns:



8136
8137
8138
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8136

def activation_status
  @activation_status
end

#app_link_data ⇒ Google::Apis::WalletobjectsV1::AppLinkData

Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed. Corresponds to the JSON property appLinkData

Returns:



8143
8144
8145
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8143

def app_link_data
  @app_link_data
end

#barcode ⇒ Google::Apis::WalletobjectsV1::Barcode

The barcode type and value. Corresponds to the JSON property barcode

Returns:



8148
8149
8150
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8148

def barcode
  @barcode
end

#class_id ⇒ String

Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. Corresponds to the JSON property classId

Returns:

  • (String) 


8156
8157
8158
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8156

def class_id
  @class_id
end

#class_reference ⇒ Google::Apis::WalletobjectsV1::TransitClass

A copy of the inherited fields of the parent class. These fields are retrieved during a GET. Corresponds to the JSON property classReference

Returns:



8162
8163
8164
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8162

def class_reference
  @class_reference
end

#concession_category ⇒ String

The concession category for the ticket. Corresponds to the JSON property concessionCategory

Returns:

  • (String) 


8167
8168
8169
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8167

def concession_category
  @concession_category
end

#custom_concession_category ⇒ Google::Apis::WalletobjectsV1::LocalizedString

A custom concession category to use when concessionCategory does not provide the right option. Both concessionCategory and customConcessionCategory may not be set. Corresponds to the JSON property customConcessionCategory

Returns:



8174
8175
8176
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8174

def custom_concession_category
  @custom_concession_category
end

#custom_ticket_status ⇒ Google::Apis::WalletobjectsV1::LocalizedString

A custom status to use for the ticket status value when ticketStatus does not provide the right option. Both ticketStatus and customTicketStatus may not be set. Corresponds to the JSON property customTicketStatus

Returns:



8181
8182
8183
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8181

def custom_ticket_status
  @custom_ticket_status
end

#device_context ⇒ Google::Apis::WalletobjectsV1::DeviceContext

Device context associated with the object. Corresponds to the JSON property deviceContext

Returns:



8186
8187
8188
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8186

def device_context
  @device_context
end

#disable_expiration_notification ⇒ Boolean Also known as: disable_expiration_notification?

Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the messages field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers. Corresponds to the JSON property disableExpirationNotification

Returns:

  • (Boolean) 


8194
8195
8196
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8194

def disable_expiration_notification
  @disable_expiration_notification
end

#grouping_info ⇒ Google::Apis::WalletobjectsV1::GroupingInfo

Information that controls how passes are grouped together. Corresponds to the JSON property groupingInfo

Returns:



8200
8201
8202
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8200

def grouping_info
  @grouping_info
end

#has_linked_device ⇒ Boolean Also known as: has_linked_device?

Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information. Corresponds to the JSON property hasLinkedDevice

Returns:

  • (Boolean) 


8208
8209
8210
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8208

def has_linked_device
  @has_linked_device
end

#has_users ⇒ Boolean Also known as: has_users?

Indicates if the object has users. This field is set by the platform. Corresponds to the JSON property hasUsers

Returns:

  • (Boolean) 


8214
8215
8216
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8214

def has_users
  @has_users
end

#hero_image ⇒ Google::Apis::WalletobjectsV1::Image

Wrapping type for Google hosted images. Next ID: 7 Corresponds to the JSON property heroImage

Returns:



8220
8221
8222
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8220

def hero_image
  @hero_image
end

#hex_background_color ⇒ String

The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as # ffcc00. You can also use the shorthand version of the RGB triplet which is # rgb, such as #fc0. Corresponds to the JSON property hexBackgroundColor

Returns:

  • (String) 


8229
8230
8231
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8229

def hex_background_color
  @hex_background_color
end

#id ⇒ String

Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'. Corresponds to the JSON property id

Returns:

  • (String) 


8238
8239
8240
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8238

def id
  @id
end

#image_modules_data ⇒ Array<Google::Apis::WalletobjectsV1::ImageModuleData>

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. Corresponds to the JSON property imageModulesData

Returns:



8244
8245
8246
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8244

def image_modules_data
  @image_modules_data
end

#info_module_data ⇒ Google::Apis::WalletobjectsV1::InfoModuleData

Deprecated. Use textModulesData instead. Corresponds to the JSON property infoModuleData

Returns:



8249
8250
8251
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8249

def info_module_data
  @info_module_data
end

#linked_object_ids ⇒ Array<String>

linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this transit object. If a user had saved this transit card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you. Corresponds to the JSON property linkedObjectIds

Returns:

  • (Array<String>) 


8265
8266
8267
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8265

def linked_object_ids
  @linked_object_ids
end

#links_module_data ⇒ Google::Apis::WalletobjectsV1::LinksModuleData

Links module data. If links module data is also defined on the class, both will be displayed. Corresponds to the JSON property linksModuleData

Returns:



8271
8272
8273
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8271

def links_module_data
  @links_module_data
end

#locations ⇒ Array<Google::Apis::WalletobjectsV1::LatLongPoint>

Note: This field is currently not supported to trigger geo notifications. Corresponds to the JSON property locations

Returns:



8276
8277
8278
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8276

def locations
  @locations
end

#messages ⇒ Array<Google::Apis::WalletobjectsV1::Message>

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. Corresponds to the JSON property messages

Returns:



8282
8283
8284
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8282

def messages
  @messages
end

#pass_constraints ⇒ Google::Apis::WalletobjectsV1::PassConstraints

Container for any constraints that may be placed on passes. Corresponds to the JSON property passConstraints

Returns:



8287
8288
8289
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8287

def pass_constraints
  @pass_constraints
end

#passenger_names ⇒ String

The name(s) of the passengers the ticket is assigned to. The above passengerType field is meant to give Google context on this field. Corresponds to the JSON property passengerNames

Returns:

  • (String) 


8293
8294
8295
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8293

def passenger_names
  @passenger_names
end

#passenger_type ⇒ String

The number of passengers. Corresponds to the JSON property passengerType

Returns:

  • (String) 


8298
8299
8300
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8298

def passenger_type
  @passenger_type
end

#purchase_details ⇒ Google::Apis::WalletobjectsV1::PurchaseDetails

Purchase details for this ticket. Corresponds to the JSON property purchaseDetails

Returns:



8303
8304
8305
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8303

def purchase_details
  @purchase_details
end

#rotating_barcode ⇒ Google::Apis::WalletobjectsV1::RotatingBarcode

The rotating barcode type and value. Corresponds to the JSON property rotatingBarcode

Returns:



8308
8309
8310
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8308

def rotating_barcode
  @rotating_barcode
end

#save_restrictions ⇒ Google::Apis::WalletobjectsV1::SaveRestrictions

Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. Corresponds to the JSON property saveRestrictions

Returns:



8314
8315
8316
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8314

def save_restrictions
  @save_restrictions
end

#smart_tap_redemption_value ⇒ String

The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields enableSmartTap and redemptionIssuers must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. Corresponds to the JSON property smartTapRedemptionValue

Returns:

  • (String) 


8322
8323
8324
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8322

def smart_tap_redemption_value
  @smart_tap_redemption_value
end

#state ⇒ String

Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an inactive object is moved to the "Expired passes" section. Corresponds to the JSON property state

Returns:

  • (String) 


8329
8330
8331
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8329

def state
  @state
end

#text_modules_data ⇒ Array<Google::Apis::WalletobjectsV1::TextModuleData>

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. Corresponds to the JSON property textModulesData

Returns:



8336
8337
8338
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8336

def text_modules_data
  @text_modules_data
end

#ticket_leg ⇒ Google::Apis::WalletobjectsV1::TicketLeg

A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the ticketLegs field instead. Both ticketLeg and ticketLegs may not be set. Corresponds to the JSON property ticketLeg

Returns:



8344
8345
8346
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8344

def ticket_leg
  @ticket_leg
end

#ticket_legs ⇒ Array<Google::Apis::WalletobjectsV1::TicketLeg>

Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the ticketLeg field instead. Both ticketLeg and ticketLegs may not be set. Corresponds to the JSON property ticketLegs

Returns:



8352
8353
8354
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8352

def ticket_legs
  @ticket_legs
end

#ticket_number ⇒ String

The number of the ticket. This is a unique identifier for the ticket in the transit operator's system. Corresponds to the JSON property ticketNumber

Returns:

  • (String) 


8358
8359
8360
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8358

def ticket_number
  @ticket_number
end

#ticket_restrictions ⇒ Google::Apis::WalletobjectsV1::TicketRestrictions

Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken. Corresponds to the JSON property ticketRestrictions

Returns:



8365
8366
8367
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8365

def ticket_restrictions
  @ticket_restrictions
end

#ticket_status ⇒ String

The status of the ticket. For states which affect display, use the state field instead. Corresponds to the JSON property ticketStatus

Returns:

  • (String) 


8371
8372
8373
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8371

def ticket_status
  @ticket_status
end

#trip_id ⇒ String

This id is used to group tickets together if the user has saved multiple tickets for the same trip. Corresponds to the JSON property tripId

Returns:

  • (String) 


8377
8378
8379
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8377

def trip_id
  @trip_id
end

#trip_type ⇒ String

Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination. Corresponds to the JSON property tripType

Returns:

  • (String) 


8383
8384
8385
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8383

def trip_type
  @trip_type
end

#valid_time_interval ⇒ Google::Apis::WalletobjectsV1::TimeInterval

The time period this object will be active and object can be used. An object' s state will be changed to expired when this time period has passed. Corresponds to the JSON property validTimeInterval

Returns:



8389
8390
8391
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8389

def valid_time_interval
  @valid_time_interval
end

#value_added_module_data ⇒ Array<Google::Apis::WalletobjectsV1::ValueAddedModuleData>

Optional value added module data. Maximum of ten on the object. Corresponds to the JSON property valueAddedModuleData

Returns:



8394
8395
8396
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8394

def value_added_module_data
  @value_added_module_data
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


8399
8400
8401
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8399

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 8406

def update!(**args)
  @activation_status = args[:activation_status] if args.key?(:activation_status)
  @app_link_data = args[:app_link_data] if args.key?(:app_link_data)
  @barcode = args[:barcode] if args.key?(:barcode)
  @class_id = args[:class_id] if args.key?(:class_id)
  @class_reference = args[:class_reference] if args.key?(:class_reference)
  @concession_category = args[:concession_category] if args.key?(:concession_category)
  @custom_concession_category = args[:custom_concession_category] if args.key?(:custom_concession_category)
  @custom_ticket_status = args[:custom_ticket_status] if args.key?(:custom_ticket_status)
  @device_context = args[:device_context] if args.key?(:device_context)
  @disable_expiration_notification = args[:disable_expiration_notification] if args.key?(:disable_expiration_notification)
  @grouping_info = args[:grouping_info] if args.key?(:grouping_info)
  @has_linked_device = args[:has_linked_device] if args.key?(:has_linked_device)
  @has_users = args[:has_users] if args.key?(:has_users)
  @hero_image = args[:hero_image] if args.key?(:hero_image)
  @hex_background_color = args[:hex_background_color] if args.key?(:hex_background_color)
  @id = args[:id] if args.key?(:id)
  @image_modules_data = args[:image_modules_data] if args.key?(:image_modules_data)
  @info_module_data = args[:info_module_data] if args.key?(:info_module_data)
  @linked_object_ids = args[:linked_object_ids] if args.key?(:linked_object_ids)
  @links_module_data = args[:links_module_data] if args.key?(:links_module_data)
  @locations = args[:locations] if args.key?(:locations)
  @messages = args[:messages] if args.key?(:messages)
  @pass_constraints = args[:pass_constraints] if args.key?(:pass_constraints)
  @passenger_names = args[:passenger_names] if args.key?(:passenger_names)
  @passenger_type = args[:passenger_type] if args.key?(:passenger_type)
  @purchase_details = args[:purchase_details] if args.key?(:purchase_details)
  @rotating_barcode = args[:rotating_barcode] if args.key?(:rotating_barcode)
  @save_restrictions = args[:save_restrictions] if args.key?(:save_restrictions)
  @smart_tap_redemption_value = args[:smart_tap_redemption_value] if args.key?(:smart_tap_redemption_value)
  @state = args[:state] if args.key?(:state)
  @text_modules_data = args[:text_modules_data] if args.key?(:text_modules_data)
  @ticket_leg = args[:ticket_leg] if args.key?(:ticket_leg)
  @ticket_legs = args[:ticket_legs] if args.key?(:ticket_legs)
  @ticket_number = args[:ticket_number] if args.key?(:ticket_number)
  @ticket_restrictions = args[:ticket_restrictions] if args.key?(:ticket_restrictions)
  @ticket_status = args[:ticket_status] if args.key?(:ticket_status)
  @trip_id = args[:trip_id] if args.key?(:trip_id)
  @trip_type = args[:trip_type] if args.key?(:trip_type)
  @valid_time_interval = args[:valid_time_interval] if args.key?(:valid_time_interval)
  @value_added_module_data = args[:value_added_module_data] if args.key?(:value_added_module_data)
  @version = args[:version] if args.key?(:version)
end