Class: Google::Apis::WalletobjectsV1::EventTicketClass

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

Returns a new instance of EventTicketClass.



1767
1768
1769
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1767

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

Instance Attribute Details

#allow_multiple_users_per_object ⇒ Boolean Also known as: allow_multiple_users_per_object?

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead. Corresponds to the JSON property allowMultipleUsersPerObject

Returns:

  • (Boolean) 


1457
1458
1459
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1457

def allow_multiple_users_per_object
  @allow_multiple_users_per_object
end

#callback_options ⇒ Google::Apis::WalletobjectsV1::CallbackOptions

Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback. Corresponds to the JSON property callbackOptions

Returns:



1465
1466
1467
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1465

def callback_options
  @callback_options
end

#class_template_info ⇒ Google::Apis::WalletobjectsV1::ClassTemplateInfo

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display. Corresponds to the JSON property classTemplateInfo

Returns:



1471
1472
1473
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1471

def class_template_info
  @class_template_info
end

#confirmation_code_label ⇒ String

The label to use for the confirmation code value (eventTicketObject. reservationInfo.confirmationCode) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both confirmationCodeLabel and customConfirmationCodeLabel may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used. Corresponds to the JSON property confirmationCodeLabel

Returns:

  • (String) 


1482
1483
1484
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1482

def confirmation_code_label
  @confirmation_code_label
end

#country_code ⇒ String

Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale. Corresponds to the JSON property countryCode

Returns:

  • (String) 


1489
1490
1491
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1489

def country_code
  @country_code
end

#custom_confirmation_code_label ⇒ Google::Apis::WalletobjectsV1::LocalizedString

A custom label to use for the confirmation code value (eventTicketObject. reservationInfo.confirmationCode) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the confirmationCodeLabel options is not sufficient. Both confirmationCodeLabel and customConfirmationCodeLabel may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used. Corresponds to the JSON property customConfirmationCodeLabel

Returns:



1500
1501
1502
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1500

def custom_confirmation_code_label
  @custom_confirmation_code_label
end

#custom_gate_label ⇒ Google::Apis::WalletobjectsV1::LocalizedString

A custom label to use for the gate value (eventTicketObject.seatInfo.gate) on the card detail view. This should only be used if the default "Gate" label or one of the gateLabel options is not sufficient. Both gateLabel and customGateLabel may not be set. If neither is set, the label will default to " Gate", localized. If the gate field is unset, this label will not be used. Corresponds to the JSON property customGateLabel

Returns:



1509
1510
1511
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1509

def custom_gate_label
  @custom_gate_label
end

#custom_row_label ⇒ Google::Apis::WalletobjectsV1::LocalizedString

A custom label to use for the row value (eventTicketObject.seatInfo.row) on the card detail view. This should only be used if the default "Row" label or one of the rowLabel options is not sufficient. Both rowLabel and customRowLabel may not be set. If neither is set, the label will default to " Row", localized. If the row field is unset, this label will not be used. Corresponds to the JSON property customRowLabel

Returns:



1518
1519
1520
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1518

def custom_row_label
  @custom_row_label
end

#custom_seat_label ⇒ Google::Apis::WalletobjectsV1::LocalizedString

A custom label to use for the seat value (eventTicketObject.seatInfo.seat) on the card detail view. This should only be used if the default "Seat" label or one of the seatLabel options is not sufficient. Both seatLabel and customSeatLabel may not be set. If neither is set, the label will default to " Seat", localized. If the seat field is unset, this label will not be used. Corresponds to the JSON property customSeatLabel

Returns:



1527
1528
1529
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1527

def custom_seat_label
  @custom_seat_label
end

#custom_section_label ⇒ Google::Apis::WalletobjectsV1::LocalizedString

A custom label to use for the section value (eventTicketObject.seatInfo. section) on the card detail view. This should only be used if the default " Section" label or one of the sectionLabel options is not sufficient. Both sectionLabel and customSectionLabel may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used. Corresponds to the JSON property customSectionLabel

Returns:



1537
1538
1539
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1537

def custom_section_label
  @custom_section_label
end

#date_time ⇒ Google::Apis::WalletobjectsV1::EventDateTime

The date & time information of the event. Corresponds to the JSON property dateTime

Returns:



1542
1543
1544
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1542

def date_time
  @date_time
end

#enable_smart_tap ⇒ Boolean Also known as: enable_smart_tap?

Identifies whether this class supports Smart Tap. The redemptionIssuers and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap. Corresponds to the JSON property enableSmartTap

Returns:

  • (Boolean) 


1549
1550
1551
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1549

def enable_smart_tap
  @enable_smart_tap
end

#event_id ⇒ String

The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the classId (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets ( potentially unstable). Corresponds to the JSON property eventId

Returns:

  • (String) 


1562
1563
1564
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1562

def event_id
  @event_id
end

#event_name ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Required. The name of the event, such as "LA Dodgers at SF Giants". Corresponds to the JSON property eventName

Returns:



1567
1568
1569
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1567

def event_name
  @event_name
end

#fine_print ⇒ Google::Apis::WalletobjectsV1::LocalizedString

The fine print, terms, or conditions of the ticket. Corresponds to the JSON property finePrint

Returns:



1572
1573
1574
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1572

def fine_print
  @fine_print
end

#gate_label ⇒ String

The label to use for the gate value (eventTicketObject.seatInfo.gate) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both gateLabel and customGateLabel may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used. Corresponds to the JSON property gateLabel

Returns:

  • (String) 


1582
1583
1584
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1582

def gate_label
  @gate_label
end

#hero_image ⇒ Google::Apis::WalletobjectsV1::Image

Wrapping type for Google hosted images. Next ID: 7 Corresponds to the JSON property heroImage

Returns:



1587
1588
1589
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1587

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) 


1596
1597
1598
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1596

def hex_background_color
  @hex_background_color
end

#homepage_uri ⇒ Google::Apis::WalletobjectsV1::Uri

The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData ( when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object). Corresponds to the JSON property homepageUri

Returns:



1604
1605
1606
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1604

def homepage_uri
  @homepage_uri
end

#id ⇒ String

Required. The unique identifier for a class. This ID must be unique across all classes 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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. Corresponds to the JSON property id

Returns:

  • (String) 


1613
1614
1615
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1613

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:



1619
1620
1621
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1619

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:



1624
1625
1626
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1624

def info_module_data
  @info_module_data
end

#issuer_name ⇒ String

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property issuerName

Returns:

  • (String) 


1630
1631
1632
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1630

def issuer_name
  @issuer_name
end

#kind ⇒ String

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

Returns:

  • (String) 


1636
1637
1638
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1636

def kind
  @kind
end

#links_module_data ⇒ Google::Apis::WalletobjectsV1::LinksModuleData

Links module data. If links module data is also defined on the object, both will be displayed. Corresponds to the JSON property linksModuleData

Returns:



1642
1643
1644
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1642

def links_module_data
  @links_module_data
end

#localized_issuer_name ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property localizedIssuerName

Returns:



1648
1649
1650
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1648

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



1653
1654
1655
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1653

def locations
  @locations
end

#logo ⇒ Google::Apis::WalletobjectsV1::Image

Wrapping type for Google hosted images. Next ID: 7 Corresponds to the JSON property logo

Returns:



1658
1659
1660
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1658

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



1664
1665
1666
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1664

def messages
  @messages
end

#multiple_devices_and_holders_allowed_status ⇒ String

Identifies whether multiple users and devices will save the same object referencing this class. Corresponds to the JSON property multipleDevicesAndHoldersAllowedStatus

Returns:

  • (String) 


1670
1671
1672
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1670

def multiple_devices_and_holders_allowed_status
  @multiple_devices_and_holders_allowed_status
end

#redemption_issuers ⇒ Array<Fixnum>

Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The enableSmartTap and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap. Corresponds to the JSON property redemptionIssuers

Returns:

  • (Array<Fixnum>) 


1679
1680
1681
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1679

def redemption_issuers
  @redemption_issuers
end

#review ⇒ Google::Apis::WalletobjectsV1::Review

The review comments set by the platform when a class is marked approved or rejected. Corresponds to the JSON property review

Returns:



1685
1686
1687
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1685

def review
  @review
end

#review_status ⇒ String

Required. The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft. You should keep this field to draft when the class is under development. A draft class cannot be used to create any object. You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects. When updating an already approved class you should keep setting this field to underReview. Corresponds to the JSON property reviewStatus

Returns:

  • (String) 


1698
1699
1700
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1698

def review_status
  @review_status
end

#row_label ⇒ String

The label to use for the row value (eventTicketObject.seatInfo.row) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both rowLabel and customRowLabel may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used. Corresponds to the JSON property rowLabel

Returns:

  • (String) 


1707
1708
1709
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1707

def row_label
  @row_label
end

#seat_label ⇒ String

The label to use for the seat value (eventTicketObject.seatInfo.seat) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both seatLabel and customSeatLabel may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used. Corresponds to the JSON property seatLabel

Returns:

  • (String) 


1717
1718
1719
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1717

def seat_label
  @seat_label
end

#section_label ⇒ String

The label to use for the section value (eventTicketObject.seatInfo.section) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both sectionLabel and customSectionLabel may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used. Corresponds to the JSON property sectionLabel

Returns:

  • (String) 


1727
1728
1729
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1727

def section_label
  @section_label
end

#security_animation ⇒ Google::Apis::WalletobjectsV1::SecurityAnimation

Optional information about the security animation. If this is set a security animation will be rendered on pass details. Corresponds to the JSON property securityAnimation

Returns:



1733
1734
1735
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1733

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



1740
1741
1742
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1740

def text_modules_data
  @text_modules_data
end

#venue ⇒ Google::Apis::WalletobjectsV1::EventVenue

Event venue details. Corresponds to the JSON property venue

Returns:



1745
1746
1747
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1745

def venue
  @venue
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


1750
1751
1752
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1750

def version
  @version
end

#view_unlock_requirement ⇒ String

View Unlock Requirement options for the event ticket. Corresponds to the JSON property viewUnlockRequirement

Returns:

  • (String) 


1755
1756
1757
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1755

def view_unlock_requirement
  @view_unlock_requirement
end

#wide_logo ⇒ Google::Apis::WalletobjectsV1::Image

Wrapping type for Google hosted images. Next ID: 7 Corresponds to the JSON property wideLogo

Returns:



1760
1761
1762
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1760

def 
  @wide_logo
end

#word_mark ⇒ Google::Apis::WalletobjectsV1::Image

Wrapping type for Google hosted images. Next ID: 7 Corresponds to the JSON property wordMark

Returns:



1765
1766
1767
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1765

def word_mark
  @word_mark
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 1772

def update!(**args)
  @allow_multiple_users_per_object = args[:allow_multiple_users_per_object] if args.key?(:allow_multiple_users_per_object)
  @callback_options = args[:callback_options] if args.key?(:callback_options)
  @class_template_info = args[:class_template_info] if args.key?(:class_template_info)
  @confirmation_code_label = args[:confirmation_code_label] if args.key?(:confirmation_code_label)
  @country_code = args[:country_code] if args.key?(:country_code)
  @custom_confirmation_code_label = args[:custom_confirmation_code_label] if args.key?(:custom_confirmation_code_label)
  @custom_gate_label = args[:custom_gate_label] if args.key?(:custom_gate_label)
  @custom_row_label = args[:custom_row_label] if args.key?(:custom_row_label)
  @custom_seat_label = args[:custom_seat_label] if args.key?(:custom_seat_label)
  @custom_section_label = args[:custom_section_label] if args.key?(:custom_section_label)
  @date_time = args[:date_time] if args.key?(:date_time)
  @enable_smart_tap = args[:enable_smart_tap] if args.key?(:enable_smart_tap)
  @event_id = args[:event_id] if args.key?(:event_id)
  @event_name = args[:event_name] if args.key?(:event_name)
  @fine_print = args[:fine_print] if args.key?(:fine_print)
  @gate_label = args[:gate_label] if args.key?(:gate_label)
  @hero_image = args[:hero_image] if args.key?(:hero_image)
  @hex_background_color = args[:hex_background_color] if args.key?(:hex_background_color)
  @homepage_uri = args[:homepage_uri] if args.key?(:homepage_uri)
  @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)
  @issuer_name = args[:issuer_name] if args.key?(:issuer_name)
  @kind = args[:kind] if args.key?(:kind)
  @links_module_data = args[:links_module_data] if args.key?(:links_module_data)
  @localized_issuer_name = args[:localized_issuer_name] if args.key?(:localized_issuer_name)
  @locations = args[:locations] if args.key?(:locations)
  @logo = args[:logo] if args.key?(:logo)
  @messages = args[:messages] if args.key?(:messages)
  @multiple_devices_and_holders_allowed_status = args[:multiple_devices_and_holders_allowed_status] if args.key?(:multiple_devices_and_holders_allowed_status)
  @redemption_issuers = args[:redemption_issuers] if args.key?(:redemption_issuers)
  @review = args[:review] if args.key?(:review)
  @review_status = args[:review_status] if args.key?(:review_status)
  @row_label = args[:row_label] if args.key?(:row_label)
  @seat_label = args[:seat_label] if args.key?(:seat_label)
  @section_label = args[:section_label] if args.key?(:section_label)
  @security_animation = args[:security_animation] if args.key?(:security_animation)
  @text_modules_data = args[:text_modules_data] if args.key?(:text_modules_data)
  @venue = args[:venue] if args.key?(:venue)
  @version = args[:version] if args.key?(:version)
  @view_unlock_requirement = args[:view_unlock_requirement] if args.key?(:view_unlock_requirement)
  @wide_logo = args[:wide_logo] if args.key?(:wide_logo)
  @word_mark = args[:word_mark] if args.key?(:word_mark)
end