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.



5054
5055
5056
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5054

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) 


4881
4882
4883
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4881

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) 


4887
4888
4889
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4887

def 
  @account_name
end

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

Optional information about the partner app link. Corresponds to the JSON property appLinkData

Returns:



4892
4893
4894
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4892

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:



4897
4898
4899
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4897

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) 


4905
4906
4907
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4905

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:



4911
4912
4913
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4911

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) 


4919
4920
4921
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4919

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:



4925
4926
4927
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4925

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) 


4933
4934
4935
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4933

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) 


4939
4940
4941
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4939

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:



4945
4946
4947
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4945

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) 


4954
4955
4956
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4954

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:



4960
4961
4962
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4960

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:



4965
4966
4967
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4965

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) 


4971
4972
4973
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4971

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


4978
4979
4980
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4978

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:



4984
4985
4986
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4984

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:



4989
4990
4991
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4989

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:



4994
4995
4996
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 4994

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:



5000
5001
5002
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5000

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:



5005
5006
5007
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5005

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:



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

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



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

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) 


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

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) 


5034
5035
5036
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5034

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:



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

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:



5047
5048
5049
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5047

def valid_time_interval
  @valid_time_interval
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


5052
5053
5054
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5052

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5059

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