Class: Google::Apis::WalletobjectsV1::LoyaltyObject

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

Returns a new instance of LoyaltyObject.



5191
5192
5193
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5191

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

Instance Attribute Details

#account_id ⇒ String

The loyalty account identifier. Recommended maximum length is 20 characters. Corresponds to the JSON property accountId

Returns:

  • (String) 


5010
5011
5012
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5010

def 
  @account_id
end

#account_name ⇒ String

The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property accountName

Returns:

  • (String) 


5016
5017
5018
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5016

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



5023
5024
5025
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5023

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:



5028
5029
5030
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5028

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) 


5036
5037
5038
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5036

def class_id
  @class_id
end

#class_reference ⇒ Google::Apis::WalletobjectsV1::LoyaltyClass

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

Returns:



5042
5043
5044
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5042

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) 


5050
5051
5052
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5050

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:



5056
5057
5058
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5056

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) 


5064
5065
5066
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5064

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) 


5070
5071
5072
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5070

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:



5076
5077
5078
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5076

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) 


5085
5086
5087
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5085

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:



5091
5092
5093
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5091

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:



5096
5097
5098
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5096

def info_module_data
  @info_module_data
end

#kind ⇒ String

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

Returns:

  • (String) 


5102
5103
5104
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5102

def kind
  @kind
end

#linked_offer_ids ⇒ Array<String>

A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object 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 linkedOfferIds

Returns:

  • (Array<String>) 


5109
5110
5111
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5109

def linked_offer_ids
  @linked_offer_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:



5115
5116
5117
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5115

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:



5120
5121
5122
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5120

def locations
  @locations
end

#loyalty_points ⇒ Google::Apis::WalletobjectsV1::LoyaltyPoints

The loyalty reward points label, balance, and type. Corresponds to the JSON property loyaltyPoints

Returns:



5125
5126
5127
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5125

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



5131
5132
5133
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5131

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:



5136
5137
5138
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5136

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:



5141
5142
5143
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5141

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:



5147
5148
5149
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5147

def save_restrictions
  @save_restrictions
end

#secondary_loyalty_points ⇒ Google::Apis::WalletobjectsV1::LoyaltyPoints

The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. Corresponds to the JSON property secondaryLoyaltyPoints

Returns:



5153
5154
5155
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5153

def secondary_loyalty_points
  @secondary_loyalty_points
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. If this value is not set but the class level fields enableSmartTap and redemptionIssuers are set up correctly, the barcode.value or the accountId fields are used as fallback if present. Corresponds to the JSON property smartTapRedemptionValue

Returns:

  • (String) 


5164
5165
5166
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5164

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) 


5171
5172
5173
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5171

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:



5178
5179
5180
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5178

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:



5184
5185
5186
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5184

def valid_time_interval
  @valid_time_interval
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


5189
5190
5191
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5189

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5196

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @account_name = args[:account_name] if args.key?(:account_name)
  @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_offer_ids = args[:linked_offer_ids] if args.key?(:linked_offer_ids)
  @links_module_data = args[:links_module_data] if args.key?(:links_module_data)
  @locations = args[:locations] if args.key?(:locations)
  @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points)
  @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)
  @secondary_loyalty_points = args[:secondary_loyalty_points] if args.key?(:secondary_loyalty_points)
  @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