Class: Google::Apis::WalletobjectsV1::OfferClass

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

Returns a new instance of OfferClass.



5996
5997
5998
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5996

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) 


5745
5746
5747
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5745

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:



5753
5754
5755
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5753

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:



5759
5760
5761
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5759

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


5766
5767
5768
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5766

def country_code
  @country_code
end

#details ⇒ String

The details of the offer. Corresponds to the JSON property details

Returns:

  • (String) 


5771
5772
5773
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5771

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


5778
5779
5780
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5778

def enable_smart_tap
  @enable_smart_tap
end

#fine_print ⇒ String

The fine print or terms of the offer, such as "20% off any t-shirt at Adam's Apparel." Corresponds to the JSON property finePrint

Returns:

  • (String) 


5785
5786
5787
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5785

def fine_print
  @fine_print
end

#help_uri ⇒ Google::Apis::WalletobjectsV1::Uri

The help link for the offer, such as http://myownpersonaldomain.com/help Corresponds to the JSON property helpUri

Returns:



5790
5791
5792
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5790

def help_uri
  @help_uri
end

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

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

Returns:



5795
5796
5797
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5795

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) 


5804
5805
5806
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5804

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:



5812
5813
5814
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5812

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) 


5821
5822
5823
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5821

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:



5827
5828
5829
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5827

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:



5832
5833
5834
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5832

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) 


5838
5839
5840
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5838

def issuer_name
  @issuer_name
end

#kind ⇒ String

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

Returns:

  • (String) 


5844
5845
5846
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5844

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:



5850
5851
5852
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5850

def links_module_data
  @links_module_data
end

#localized_details ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the details. Corresponds to the JSON property localizedDetails

Returns:



5855
5856
5857
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5855

def localized_details
  @localized_details
end

#localized_fine_print ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the fine_print. Corresponds to the JSON property localizedFinePrint

Returns:



5860
5861
5862
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5860

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



5866
5867
5868
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5866

def localized_issuer_name
  @localized_issuer_name
end

#localized_provider ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the provider. Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property localizedProvider

Returns:



5872
5873
5874
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5872

def localized_provider
  @localized_provider
end

#localized_short_title ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the short title. Recommended maximum length is 20 characters. Corresponds to the JSON property localizedShortTitle

Returns:



5878
5879
5880
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5878

def localized_short_title
  @localized_short_title
end

#localized_title ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the title. Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property localizedTitle

Returns:



5884
5885
5886
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5884

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



5889
5890
5891
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5889

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:



5895
5896
5897
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5895

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) 


5901
5902
5903
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5901

def multiple_devices_and_holders_allowed_status
  @multiple_devices_and_holders_allowed_status
end

#provider ⇒ String

Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property provider

Returns:

  • (String) 


5908
5909
5910
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5908

def provider
  @provider
end

#redemption_channel ⇒ String

Required. The redemption channels applicable to this offer. Corresponds to the JSON property redemptionChannel

Returns:

  • (String) 


5913
5914
5915
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5913

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


5922
5923
5924
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5922

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:



5928
5929
5930
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5928

def review
  @review
end

#review_status ⇒ String

Required. The status of the class. This field can be set to draft or 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) 


5942
5943
5944
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5942

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



5948
5949
5950
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5948

def security_animation
  @security_animation
end

#short_title ⇒ String

A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters. Corresponds to the JSON property shortTitle

Returns:

  • (String) 


5955
5956
5957
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5955

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



5962
5963
5964
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5962

def text_modules_data
  @text_modules_data
end

#title ⇒ String

Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property title

Returns:

  • (String) 


5969
5970
5971
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5969

def title
  @title
end

#title_image ⇒ Google::Apis::WalletobjectsV1::Image

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

Returns:



5974
5975
5976
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5974

def title_image
  @title_image
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


5979
5980
5981
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5979

def version
  @version
end

#view_unlock_requirement ⇒ String

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

Returns:

  • (String) 


5984
5985
5986
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5984

def view_unlock_requirement
  @view_unlock_requirement
end

#wide_title_image ⇒ Google::Apis::WalletobjectsV1::Image

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

Returns:



5989
5990
5991
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5989

def wide_title_image
  @wide_title_image
end

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

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

Returns:



5994
5995
5996
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5994

def word_mark
  @word_mark
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 6001

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)
  @country_code = args[:country_code] if args.key?(:country_code)
  @details = args[:details] if args.key?(:details)
  @enable_smart_tap = args[:enable_smart_tap] if args.key?(:enable_smart_tap)
  @fine_print = args[:fine_print] if args.key?(:fine_print)
  @help_uri = args[:help_uri] if args.key?(:help_uri)
  @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_details = args[:localized_details] if args.key?(:localized_details)
  @localized_fine_print = args[:localized_fine_print] if args.key?(:localized_fine_print)
  @localized_issuer_name = args[:localized_issuer_name] if args.key?(:localized_issuer_name)
  @localized_provider = args[:localized_provider] if args.key?(:localized_provider)
  @localized_short_title = args[:localized_short_title] if args.key?(:localized_short_title)
  @localized_title = args[:localized_title] if args.key?(:localized_title)
  @locations = args[:locations] if args.key?(:locations)
  @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)
  @provider = args[:provider] if args.key?(:provider)
  @redemption_channel = args[:redemption_channel] if args.key?(:redemption_channel)
  @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)
  @security_animation = args[:security_animation] if args.key?(:security_animation)
  @short_title = args[:short_title] if args.key?(:short_title)
  @text_modules_data = args[:text_modules_data] if args.key?(:text_modules_data)
  @title = args[:title] if args.key?(:title)
  @title_image = args[:title_image] if args.key?(:title_image)
  @version = args[:version] if args.key?(:version)
  @view_unlock_requirement = args[:view_unlock_requirement] if args.key?(:view_unlock_requirement)
  @wide_title_image = args[:wide_title_image] if args.key?(:wide_title_image)
  @word_mark = args[:word_mark] if args.key?(:word_mark)
end