Class: Google::Apis::WalletobjectsV1::GiftCardObject
- Inherits:
-
Object
- Object
- Google::Apis::WalletobjectsV1::GiftCardObject
- 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
-
#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.
-
#balance ⇒ Google::Apis::WalletobjectsV1::Money
The card's monetary balance.
-
#balance_update_time ⇒ Google::Apis::WalletobjectsV1::DateTime
The date and time when the balance was last updated.
-
#barcode ⇒ Google::Apis::WalletobjectsV1::Barcode
The barcode type and value.
-
#card_number ⇒ String
Required.
-
#class_id ⇒ String
Required.
-
#class_reference ⇒ Google::Apis::WalletobjectsV1::GiftCardClass
A copy of the inherited fields of the parent class.
-
#disable_expiration_notification ⇒ Boolean
(also: #disable_expiration_notification?)
Indicates if notifications should explicitly be suppressed.
-
#event_number ⇒ String
The card's event number, an optional field used by some gift cards.
-
#grouping_info ⇒ Google::Apis::WalletobjectsV1::GroupingInfo
Information that controls how passes are grouped together.
-
#has_linked_device ⇒ Boolean
(also: #has_linked_device?)
Whether this object is currently linked to a single device.
-
#has_users ⇒ Boolean
(also: #has_users?)
Indicates if the object has users.
-
#hero_image ⇒ Google::Apis::WalletobjectsV1::Image
Wrapping type for Google hosted images.
-
#id ⇒ String
Required.
-
#image_modules_data ⇒ Array<Google::Apis::WalletobjectsV1::ImageModuleData>
Image module data.
-
#info_module_data ⇒ Google::Apis::WalletobjectsV1::InfoModuleData
Deprecated.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#links_module_data ⇒ Google::Apis::WalletobjectsV1::LinksModuleData
Links module data.
-
#locations ⇒ Array<Google::Apis::WalletobjectsV1::LatLongPoint>
Note: This field is currently not supported to trigger geo notifications.
-
#messages ⇒ Array<Google::Apis::WalletobjectsV1::Message>
An array of messages displayed in the app.
-
#pass_constraints ⇒ Google::Apis::WalletobjectsV1::PassConstraints
Container for any constraints that may be placed on passes.
-
#pin ⇒ String
The card's PIN.
-
#rotating_barcode ⇒ Google::Apis::WalletobjectsV1::RotatingBarcode
The rotating barcode type and value.
-
#smart_tap_redemption_value ⇒ String
The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
-
#state ⇒ String
Required.
-
#text_modules_data ⇒ Array<Google::Apis::WalletobjectsV1::TextModuleData>
Text module data.
-
#valid_time_interval ⇒ Google::Apis::WalletobjectsV1::TimeInterval
The time period this object will be
active
and object can be used. -
#version ⇒ Fixnum
Deprecated Corresponds to the JSON property
version
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GiftCardObject
constructor
A new instance of GiftCardObject.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GiftCardObject
Returns a new instance of GiftCardObject.
3992 3993 3994 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3992 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
3824 3825 3826 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3824 def app_link_data @app_link_data end |
#balance ⇒ Google::Apis::WalletobjectsV1::Money
The card's monetary balance.
Corresponds to the JSON property balance
3829 3830 3831 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3829 def balance @balance end |
#balance_update_time ⇒ Google::Apis::WalletobjectsV1::DateTime
The date and time when the balance was last updated. Offset is required. If
balance is updated and this property is not provided, system will default to
the current time.
Corresponds to the JSON property balanceUpdateTime
3836 3837 3838 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3836 def balance_update_time @balance_update_time end |
#barcode ⇒ Google::Apis::WalletobjectsV1::Barcode
The barcode type and value.
Corresponds to the JSON property barcode
3841 3842 3843 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3841 def @barcode end |
#card_number ⇒ String
Required. The card's number.
Corresponds to the JSON property cardNumber
3846 3847 3848 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3846 def card_number @card_number 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
3854 3855 3856 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3854 def class_id @class_id end |
#class_reference ⇒ Google::Apis::WalletobjectsV1::GiftCardClass
A copy of the inherited fields of the parent class. These fields are retrieved
during a GET.
Corresponds to the JSON property classReference
3860 3861 3862 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3860 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
3868 3869 3870 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3868 def disable_expiration_notification @disable_expiration_notification end |
#event_number ⇒ String
The card's event number, an optional field used by some gift cards.
Corresponds to the JSON property eventNumber
3874 3875 3876 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3874 def event_number @event_number end |
#grouping_info ⇒ Google::Apis::WalletobjectsV1::GroupingInfo
Information that controls how passes are grouped together.
Corresponds to the JSON property groupingInfo
3879 3880 3881 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3879 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
3887 3888 3889 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3887 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
3893 3894 3895 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3893 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
3899 3900 3901 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3899 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
3908 3909 3910 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3908 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
3914 3915 3916 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3914 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
3919 3920 3921 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3919 def info_module_data @info_module_data end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "
walletobjects#giftCardObject"
.
Corresponds to the JSON property kind
3925 3926 3927 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3925 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
3931 3932 3933 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3931 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
3936 3937 3938 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3936 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
3942 3943 3944 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3942 def @messages end |
#pass_constraints ⇒ Google::Apis::WalletobjectsV1::PassConstraints
Container for any constraints that may be placed on passes.
Corresponds to the JSON property passConstraints
3947 3948 3949 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3947 def pass_constraints @pass_constraints end |
#pin ⇒ String
The card's PIN.
Corresponds to the JSON property pin
3952 3953 3954 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3952 def pin @pin end |
#rotating_barcode ⇒ Google::Apis::WalletobjectsV1::RotatingBarcode
The rotating barcode type and value.
Corresponds to the JSON property rotatingBarcode
3957 3958 3959 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3957 def @rotating_barcode 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
3965 3966 3967 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3965 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
3972 3973 3974 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3972 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
3979 3980 3981 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3979 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
3985 3986 3987 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3985 def valid_time_interval @valid_time_interval end |
#version ⇒ Fixnum
Deprecated
Corresponds to the JSON property version
3990 3991 3992 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3990 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 |
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3997 def update!(**args) @app_link_data = args[:app_link_data] if args.key?(:app_link_data) @balance = args[:balance] if args.key?(:balance) @balance_update_time = args[:balance_update_time] if args.key?(:balance_update_time) @barcode = args[:barcode] if args.key?(:barcode) @card_number = args[:card_number] if args.key?(:card_number) @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) @event_number = args[:event_number] if args.key?(:event_number) @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) @pin = args[:pin] if args.key?(:pin) @rotating_barcode = args[:rotating_barcode] if args.key?(:rotating_barcode) @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 |