Class: Google::Apis::WalletobjectsV1::FlightObject

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

Returns a new instance of FlightObject.



3041
3042
3043
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3041

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:



2843
2844
2845
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2843

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:



2848
2849
2850
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2848

def barcode
  @barcode
end

#boarding_and_seating_info ⇒ Google::Apis::WalletobjectsV1::BoardingAndSeatingInfo

Passenger specific information about boarding and seating. Corresponds to the JSON property boardingAndSeatingInfo

Returns:



2853
2854
2855
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2853

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


2861
2862
2863
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2861

def class_id
  @class_id
end

#class_reference ⇒ Google::Apis::WalletobjectsV1::FlightClass

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

Returns:



2867
2868
2869
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2867

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 Flights. Corresponds to the JSON property disableExpirationNotification

Returns:

  • (Boolean) 


2875
2876
2877
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2875

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:



2881
2882
2883
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2881

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) 


2889
2890
2891
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2889

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) 


2895
2896
2897
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2895

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:



2901
2902
2903
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2901

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) 


2910
2911
2912
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2910

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) 


2919
2920
2921
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2919

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:



2925
2926
2927
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2925

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:



2930
2931
2932
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2930

def info_module_data
  @info_module_data
end

#kind ⇒ String

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

Returns:

  • (String) 


2936
2937
2938
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2936

def kind
  @kind
end

#linked_object_ids ⇒ Array<String>

linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this flight object. If a user had saved this boarding pass, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you. Corresponds to the JSON property linkedObjectIds

Returns:

  • (Array<String>) 


2952
2953
2954
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2952

def linked_object_ids
  @linked_object_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:



2958
2959
2960
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2958

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:



2963
2964
2965
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2963

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:



2969
2970
2971
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2969

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:



2974
2975
2976
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2974

def pass_constraints
  @pass_constraints
end

#passenger_name ⇒ String

Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM" Corresponds to the JSON property passengerName

Returns:

  • (String) 


2980
2981
2982
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2980

def passenger_name
  @passenger_name
end

#reservation_info ⇒ Google::Apis::WalletobjectsV1::ReservationInfo

Required. Information about flight reservation. Corresponds to the JSON property reservationInfo

Returns:



2985
2986
2987
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2985

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:



2990
2991
2992
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2990

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:



2996
2997
2998
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 2996

def save_restrictions
  @save_restrictions
end

#security_program_logo ⇒ Google::Apis::WalletobjectsV1::Image

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

Returns:



3001
3002
3003
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3001

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


3009
3010
3011
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3009

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) 


3016
3017
3018
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3016

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:



3023
3024
3025
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3023

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:



3029
3030
3031
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3029

def valid_time_interval
  @valid_time_interval
end

#value_added_module_data ⇒ Array<Google::Apis::WalletobjectsV1::ValueAddedModuleData>

Optional value added module data. Maximum of ten on the object. Corresponds to the JSON property valueAddedModuleData

Returns:



3034
3035
3036
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3034

def value_added_module_data
  @value_added_module_data
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


3039
3040
3041
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3039

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3046

def update!(**args)
  @app_link_data = args[:app_link_data] if args.key?(:app_link_data)
  @barcode = args[:barcode] if args.key?(:barcode)
  @boarding_and_seating_info = args[:boarding_and_seating_info] if args.key?(:boarding_and_seating_info)
  @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)
  @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_object_ids = args[:linked_object_ids] if args.key?(:linked_object_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)
  @passenger_name = args[:passenger_name] if args.key?(:passenger_name)
  @reservation_info = args[:reservation_info] if args.key?(:reservation_info)
  @rotating_barcode = args[:rotating_barcode] if args.key?(:rotating_barcode)
  @save_restrictions = args[:save_restrictions] if args.key?(:save_restrictions)
  @security_program_logo = args[:security_program_logo] if args.key?(:security_program_logo)
  @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)
  @value_added_module_data = args[:value_added_module_data] if args.key?(:value_added_module_data)
  @version = args[:version] if args.key?(:version)
end