Class: Google::Apis::WalletobjectsV1::GenericObject

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

Overview

Generic Object

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GenericObject

Returns a new instance of GenericObject.



3473
3474
3475
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3473

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

Instance Attribute Details

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:



3301
3302
3303
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3301

def app_link_data
  @app_link_data
end

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

The barcode type and value. If pass does not have a barcode, we can allow the issuer to set Barcode.alternate_text and display just that. Corresponds to the JSON property barcode

Returns:



3307
3308
3309
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3307

def barcode
  @barcode
end

#card_title ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Required. The header of the pass. This is usually the Business name such as " XXX Gym", "AAA Insurance". This field is required and appears in the header row at the very top of the pass. Corresponds to the JSON property cardTitle

Returns:



3314
3315
3316
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3314

def card_title
  @card_title
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 issuerID.identifier where issuerID is issued by Google and identifier is chosen by you. Corresponds to the JSON property classId

Returns:

  • (String) 


3322
3323
3324
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3322

def class_id
  @class_id
end

#generic_type ⇒ String

Specify which GenericType the card belongs to. Corresponds to the JSON property genericType

Returns:

  • (String) 


3327
3328
3329
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3327

def generic_type
  @generic_type
end

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

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

Returns:



3332
3333
3334
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3332

def grouping_info
  @grouping_info
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) 


3337
3338
3339
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3337

def has_users
  @has_users
end

#header ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Required. The title of the pass, such as "50% off coupon" or "Library card" or "Voucher". This field is required and appears in the title row of the pass detail view. Corresponds to the JSON property header

Returns:



3345
3346
3347
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3345

def header
  @header
end

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

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

Returns:



3350
3351
3352
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3350

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 and if logo is not set, a color would be chosen by Google. Corresponds to the JSON property hexBackgroundColor

Returns:

  • (String) 


3357
3358
3359
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3357

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 needs to follow the format issuerID. identifier where issuerID is issued by Google and identifier is chosen by you. The unique identifier can only include alphanumeric characters, ., _, or -. Corresponds to the JSON property id

Returns:

  • (String) 


3366
3367
3368
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3366

def id
  @id
end

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

Image module data. Only one of the image from class and one from object level will be rendered when both set. Corresponds to the JSON property imageModulesData

Returns:



3372
3373
3374
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3372

def image_modules_data
  @image_modules_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 generic object. If a user had saved this generic 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>) 


3388
3389
3390
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3388

def linked_object_ids
  @linked_object_ids
end

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

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

Returns:



3395
3396
3397
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3395

def links_module_data
  @links_module_data
end

#logo ⇒ Google::Apis::WalletobjectsV1::Image

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

Returns:



3400
3401
3402
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3400

def 
  @logo
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:



3406
3407
3408
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3406

def messages
  @messages
end

#notifications ⇒ Google::Apis::WalletobjectsV1::Notifications

Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. expiryNotification takes precedence over upcomingNotification. In other words if expiryNotification is set, we ignore the upcomingNotification field. Corresponds to the JSON property notifications

Returns:



3414
3415
3416
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3414

def notifications
  @notifications
end

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

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

Returns:



3419
3420
3421
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3419

def pass_constraints
  @pass_constraints
end

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

The rotating barcode settings/details. Corresponds to the JSON property rotatingBarcode

Returns:



3424
3425
3426
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3424

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:



3430
3431
3432
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3430

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) 


3438
3439
3440
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3438

def smart_tap_redemption_value
  @smart_tap_redemption_value
end

#state ⇒ String

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. If this is not provided, the object would be considered ACTIVE. Corresponds to the JSON property state

Returns:

  • (String) 


3446
3447
3448
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3446

def state
  @state
end

#subheader ⇒ Google::Apis::WalletobjectsV1::LocalizedString

The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. Corresponds to the JSON property subheader

Returns:



3452
3453
3454
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3452

def subheader
  @subheader
end

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

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

Returns:



3459
3460
3461
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3459

def text_modules_data
  @text_modules_data
end

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

The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices. Corresponds to the JSON property validTimeInterval

Returns:



3466
3467
3468
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3466

def valid_time_interval
  @valid_time_interval
end

#wide_logo ⇒ Google::Apis::WalletobjectsV1::Image

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

Returns:



3471
3472
3473
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3471

def 
  @wide_logo
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3478

def update!(**args)
  @app_link_data = args[:app_link_data] if args.key?(:app_link_data)
  @barcode = args[:barcode] if args.key?(:barcode)
  @card_title = args[:card_title] if args.key?(:card_title)
  @class_id = args[:class_id] if args.key?(:class_id)
  @generic_type = args[:generic_type] if args.key?(:generic_type)
  @grouping_info = args[:grouping_info] if args.key?(:grouping_info)
  @has_users = args[:has_users] if args.key?(:has_users)
  @header = args[:header] if args.key?(:header)
  @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)
  @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)
  @logo = args[:logo] if args.key?(:logo)
  @messages = args[:messages] if args.key?(:messages)
  @notifications = args[:notifications] if args.key?(:notifications)
  @pass_constraints = args[:pass_constraints] if args.key?(:pass_constraints)
  @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)
  @subheader = args[:subheader] if args.key?(:subheader)
  @text_modules_data = args[:text_modules_data] if args.key?(:text_modules_data)
  @valid_time_interval = args[:valid_time_interval] if args.key?(:valid_time_interval)
  @wide_logo = args[:wide_logo] if args.key?(:wide_logo)
end