Class: Google::Apis::WalletobjectsV1::OfferObject

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) ⇒ OfferObject

Returns a new instance of OfferObject.



6391
6392
6393
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6391

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:



6244
6245
6246
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6244

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:



6249
6250
6251
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6249

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) 


6257
6258
6259
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6257

def class_id
  @class_id
end

#class_reference ⇒ Google::Apis::WalletobjectsV1::OfferClass

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

Returns:



6263
6264
6265
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6263

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


6271
6272
6273
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6271

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:



6277
6278
6279
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6277

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) 


6285
6286
6287
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6285

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) 


6291
6292
6293
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6291

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:



6297
6298
6299
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6297

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


6306
6307
6308
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6306

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:



6312
6313
6314
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6312

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:



6317
6318
6319
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6317

def info_module_data
  @info_module_data
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " walletobjects#offerObject". Corresponds to the JSON property kind

Returns:

  • (String) 


6323
6324
6325
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6323

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



6329
6330
6331
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6329

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:



6334
6335
6336
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6334

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:



6340
6341
6342
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6340

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:



6345
6346
6347
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6345

def pass_constraints
  @pass_constraints
end

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

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

Returns:



6350
6351
6352
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6350

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:



6356
6357
6358
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6356

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) 


6364
6365
6366
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6364

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) 


6371
6372
6373
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6371

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:



6378
6379
6380
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6378

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



6384
6385
6386
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6384

def valid_time_interval
  @valid_time_interval
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


6389
6390
6391
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6389

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6396

def update!(**args)
  @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)
  @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)
  @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)
  @kind = args[:kind] if args.key?(:kind)
  @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)
  @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)
  @valid_time_interval = args[:valid_time_interval] if args.key?(:valid_time_interval)
  @version = args[:version] if args.key?(:version)
end