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.



6712
6713
6714
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6712

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:



6533
6534
6535
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6533

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:



6538
6539
6540
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6538

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) 


6546
6547
6548
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6546

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:



6552
6553
6554
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6552

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) 


6560
6561
6562
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6560

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:



6566
6567
6568
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6566

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) 


6574
6575
6576
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6574

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) 


6580
6581
6582
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6580

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:



6586
6587
6588
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6586

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) 


6595
6596
6597
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6595

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:



6601
6602
6603
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6601

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:



6606
6607
6608
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6606

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) 


6612
6613
6614
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6612

def kind
  @kind
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 offer object. If a user had saved this offer, 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>) 


6628
6629
6630
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6628

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:



6634
6635
6636
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6634

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:



6639
6640
6641
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6639

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:



6645
6646
6647
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6645

def messages
  @messages
end

#notify_preference ⇒ String

Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. Corresponds to the JSON property notifyPreference

Returns:

  • (String) 


6656
6657
6658
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6656

def notify_preference
  @notify_preference
end

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

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

Returns:



6661
6662
6663
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6661

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:



6666
6667
6668
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6666

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:



6672
6673
6674
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6672

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) 


6680
6681
6682
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6680

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) 


6687
6688
6689
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6687

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:



6694
6695
6696
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6694

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:



6700
6701
6702
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6700

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:



6705
6706
6707
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6705

def value_added_module_data
  @value_added_module_data
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


6710
6711
6712
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6710

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6717

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)
  @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)
  @notify_preference = args[:notify_preference] if args.key?(:notify_preference)
  @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)
  @value_added_module_data = args[:value_added_module_data] if args.key?(:value_added_module_data)
  @version = args[:version] if args.key?(:version)
end