Class: Google::Apis::WalletobjectsV1::GiftCardClass

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

Returns a new instance of GiftCardClass.



3637
3638
3639
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3637

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

Instance Attribute Details

#allow_barcode_redemption ⇒ Boolean Also known as: allow_barcode_redemption?

Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed. Corresponds to the JSON property allowBarcodeRedemption

Returns:

  • (Boolean) 


3408
3409
3410
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3408

def allow_barcode_redemption
  @allow_barcode_redemption
end

#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) 


3414
3415
3416
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3414

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:



3422
3423
3424
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3422

def callback_options
  @callback_options
end

#card_number_label ⇒ String

The label to display for the card number, such as "Card Number". Corresponds to the JSON property cardNumberLabel

Returns:

  • (String) 


3427
3428
3429
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3427

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



3433
3434
3435
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3433

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) 


3440
3441
3442
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3440

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


3447
3448
3449
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3447

def enable_smart_tap
  @enable_smart_tap
end

#event_number_label ⇒ String

The label to display for event number, such as "Target Event #". Corresponds to the JSON property eventNumberLabel

Returns:

  • (String) 


3453
3454
3455
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3453

def event_number_label
  @event_number_label
end

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

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

Returns:



3458
3459
3460
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3458

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) 


3467
3468
3469
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3467

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:



3475
3476
3477
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3475

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) 


3484
3485
3486
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3484

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:



3490
3491
3492
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3490

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:



3495
3496
3497
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3495

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) 


3501
3502
3503
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3501

def issuer_name
  @issuer_name
end

#kind ⇒ String

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

Returns:

  • (String) 


3507
3508
3509
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3507

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:



3513
3514
3515
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3513

def links_module_data
  @links_module_data
end

#localized_card_number_label ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the card_number_label. Corresponds to the JSON property localizedCardNumberLabel

Returns:



3518
3519
3520
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3518

def localized_card_number_label
  @localized_card_number_label
end

#localized_event_number_label ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the event_number_label. Corresponds to the JSON property localizedEventNumberLabel

Returns:



3523
3524
3525
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3523

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



3529
3530
3531
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3529

def localized_issuer_name
  @localized_issuer_name
end

#localized_merchant_name ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property localizedMerchantName

Returns:



3536
3537
3538
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3536

def localized_merchant_name
  @localized_merchant_name
end

#localized_pin_label ⇒ Google::Apis::WalletobjectsV1::LocalizedString

Translated strings for the pin_label. Corresponds to the JSON property localizedPinLabel

Returns:



3541
3542
3543
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3541

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



3546
3547
3548
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3546

def locations
  @locations
end

#merchant_name ⇒ String

Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens. Corresponds to the JSON property merchantName

Returns:

  • (String) 


3552
3553
3554
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3552

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



3558
3559
3560
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3558

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) 


3564
3565
3566
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3564

def multiple_devices_and_holders_allowed_status
  @multiple_devices_and_holders_allowed_status
end

#pin_label ⇒ String

The label to display for the PIN, such as "4-digit PIN". Corresponds to the JSON property pinLabel

Returns:

  • (String) 


3569
3570
3571
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3569

def pin_label
  @pin_label
end

#program_logo ⇒ Google::Apis::WalletobjectsV1::Image

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

Returns:



3574
3575
3576
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3574

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


3583
3584
3585
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3583

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:



3589
3590
3591
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3589

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) 


3602
3603
3604
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3602

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:



3608
3609
3610
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3608

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:



3615
3616
3617
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3615

def text_modules_data
  @text_modules_data
end

#version ⇒ Fixnum

Deprecated Corresponds to the JSON property version

Returns:

  • (Fixnum) 


3620
3621
3622
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3620

def version
  @version
end

#view_unlock_requirement ⇒ String

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

Returns:

  • (String) 


3625
3626
3627
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3625

def view_unlock_requirement
  @view_unlock_requirement
end

#wide_program_logo ⇒ Google::Apis::WalletobjectsV1::Image

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

Returns:



3630
3631
3632
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3630

def 
  @wide_program_logo
end

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

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

Returns:



3635
3636
3637
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3635

def word_mark
  @word_mark
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 3642

def update!(**args)
  @allow_barcode_redemption = args[:allow_barcode_redemption] if args.key?(:allow_barcode_redemption)
  @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)
  @card_number_label = args[:card_number_label] if args.key?(:card_number_label)
  @class_template_info = args[:class_template_info] if args.key?(:class_template_info)
  @country_code = args[:country_code] if args.key?(:country_code)
  @enable_smart_tap = args[:enable_smart_tap] if args.key?(:enable_smart_tap)
  @event_number_label = args[:event_number_label] if args.key?(:event_number_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_card_number_label = args[:localized_card_number_label] if args.key?(:localized_card_number_label)
  @localized_event_number_label = args[:localized_event_number_label] if args.key?(:localized_event_number_label)
  @localized_issuer_name = args[:localized_issuer_name] if args.key?(:localized_issuer_name)
  @localized_merchant_name = args[:localized_merchant_name] if args.key?(:localized_merchant_name)
  @localized_pin_label = args[:localized_pin_label] if args.key?(:localized_pin_label)
  @locations = args[:locations] if args.key?(:locations)
  @merchant_name = args[:merchant_name] if args.key?(:merchant_name)
  @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)
  @pin_label = args[:pin_label] if args.key?(:pin_label)
  @program_logo = args[:program_logo] if args.key?(:program_logo)
  @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)
  @text_modules_data = args[:text_modules_data] if args.key?(:text_modules_data)
  @version = args[:version] if args.key?(:version)
  @view_unlock_requirement = args[:view_unlock_requirement] if args.key?(:view_unlock_requirement)
  @wide_program_logo = args[:wide_program_logo] if args.key?(:wide_program_logo)
  @word_mark = args[:word_mark] if args.key?(:word_mark)
end