Class: Google::Apis::WalletobjectsV1::EventTicketObject

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

Returns a new instance of EventTicketObject.



2076
2077
2078
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2076

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:



1884
1885
1886
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1884

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:



1889
1890
1891
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1889

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) 


1897
1898
1899
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1897

def class_id
  @class_id
end

#class_reference ⇒ Google::Apis::WalletobjectsV1::EventTicketClass

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

Returns:



1903
1904
1905
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1903

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) 


1911
1912
1913
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1911

def disable_expiration_notification
  @disable_expiration_notification
end

#face_value ⇒ Google::Apis::WalletobjectsV1::Money

The face value of the ticket, matching what would be printed on a physical version of the ticket. Corresponds to the JSON property faceValue

Returns:



1918
1919
1920
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1918

def face_value
  @face_value
end

#grouping_info ⇒ Google::Apis::WalletobjectsV1::GroupingInfo

Information that controls how passes are grouped together. Corresponds to the JSON property groupingInfo

Returns:



1923
1924
1925
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1923

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) 


1931
1932
1933
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1931

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) 


1937
1938
1939
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1937

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:



1943
1944
1945
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1943

def hero_image
  @hero_image
end

#hex_background_color ⇒ String

The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as # ffcc00. You can also use the shorthand version of the RGB triplet which is # rgb, such as #fc0. Corresponds to the JSON property hexBackgroundColor

Returns:

  • (String) 


1952
1953
1954
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1952

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


1961
1962
1963
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1961

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:



1967
1968
1969
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1967

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:



1972
1973
1974
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1972

def info_module_data
  @info_module_data
end

#kind ⇒ String

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

Returns:

  • (String) 


1978
1979
1980
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1978

def kind
  @kind
end

#linked_offer_ids ⇒ Array<String>

A list of offer objects linked to this event ticket. 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>) 


1985
1986
1987
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1985

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:



1991
1992
1993
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1991

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:



1996
1997
1998
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1996

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:



2002
2003
2004
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2002

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:



2007
2008
2009
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2007

def pass_constraints
  @pass_constraints
end

#reservation_info ⇒ Google::Apis::WalletobjectsV1::EventReservationInfo

Reservation details for this ticket. This is expected to be shared amongst all tickets that were purchased in the same order. Corresponds to the JSON property reservationInfo

Returns:



2013
2014
2015
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2013

def reservation_info
  @reservation_info
end

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

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

Returns:



2018
2019
2020
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2018

def rotating_barcode
  @rotating_barcode
end

#seat_info ⇒ Google::Apis::WalletobjectsV1::EventSeat

Seating details for this ticket. Corresponds to the JSON property seatInfo

Returns:



2023
2024
2025
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2023

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


2031
2032
2033
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2031

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) 


2038
2039
2040
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2038

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:



2045
2046
2047
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2045

def text_modules_data
  @text_modules_data
end

#ticket_holder_name ⇒ String

Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe". Corresponds to the JSON property ticketHolderName

Returns:

  • (String) 


2051
2052
2053
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2051

def ticket_holder_name
  @ticket_holder_name
end

#ticket_number ⇒ String

The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.). Corresponds to the JSON property ticketNumber

Returns:

  • (String) 


2058
2059
2060
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2058

def ticket_number
  @ticket_number
end

#ticket_type ⇒ Google::Apis::WalletobjectsV1::LocalizedString

The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard". Corresponds to the JSON property ticketType

Returns:



2063
2064
2065
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2063

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



2069
2070
2071
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2069

def valid_time_interval
  @valid_time_interval
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


2074
2075
2076
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2074

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2081

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)
  @face_value = args[:face_value] if args.key?(:face_value)
  @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)
  @hex_background_color = args[:hex_background_color] if args.key?(:hex_background_color)
  @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)
  @messages = args[:messages] if args.key?(:messages)
  @pass_constraints = args[:pass_constraints] if args.key?(:pass_constraints)
  @reservation_info = args[:reservation_info] if args.key?(:reservation_info)
  @rotating_barcode = args[:rotating_barcode] if args.key?(:rotating_barcode)
  @seat_info = args[:seat_info] if args.key?(:seat_info)
  @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)
  @ticket_holder_name = args[:ticket_holder_name] if args.key?(:ticket_holder_name)
  @ticket_number = args[:ticket_number] if args.key?(:ticket_number)
  @ticket_type = args[:ticket_type] if args.key?(:ticket_type)
  @valid_time_interval = args[:valid_time_interval] if args.key?(:valid_time_interval)
  @version = args[:version] if args.key?(:version)
end