<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Walletobjects;
class OfferClass extends \Google\Collection
{
/**
* Unspecified preference.
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_STATUS_UNSPECIFIED = 'STATUS_UNSPECIFIED';
/**
* The Pass object is shareable by a user and can be saved by any number of
* different users, and on any number of devices. Partners typically use this
* setup for passes that do not need to be restricted to a single user or
* pinned to a single device.
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_MULTIPLE_HOLDERS = 'MULTIPLE_HOLDERS';
/**
* An object can only be saved by one user, but this user can view and use it
* on multiple of their devices. Once the first user saves the object, no
* other user will be allowed to view or save it.
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_ONE_USER_ALL_DEVICES = 'ONE_USER_ALL_DEVICES';
/**
* An object can only be saved by one user on a single device. Intended for
* use by select partners in limited circumstances. An example use case is a
* transit ticket that should be "device pinned", meaning it can be saved,
* viewed and used only by a single user on a single device. Contact support
* for additional information.
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_ONE_USER_ONE_DEVICE = 'ONE_USER_ONE_DEVICE';
/**
* Legacy alias for `MULTIPLE_HOLDERS`. Deprecated.
*
* @deprecated
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_multipleHolders = 'multipleHolders';
/**
* Legacy alias for `ONE_USER_ALL_DEVICES`. Deprecated.
*
* @deprecated
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_oneUserAllDevices = 'oneUserAllDevices';
/**
* Legacy alias for `ONE_USER_ONE_DEVICE`. Deprecated.
*
* @deprecated
*/
public const MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_oneUserOneDevice = 'oneUserOneDevice';
/**
* Default behavior is no notifications sent.
*/
public const NOTIFY_PREFERENCE_NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED = 'NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED';
/**
* This value will result in a notification being sent, if the updated fields
* are part of an allowlist.
*/
public const NOTIFY_PREFERENCE_NOTIFY_ON_UPDATE = 'NOTIFY_ON_UPDATE';
public const REDEMPTION_CHANNEL_REDEMPTION_CHANNEL_UNSPECIFIED = 'REDEMPTION_CHANNEL_UNSPECIFIED';
public const REDEMPTION_CHANNEL_INSTORE = 'INSTORE';
/**
* Legacy alias for `INSTORE`. Deprecated.
*
* @deprecated
*/
public const REDEMPTION_CHANNEL_instore = 'instore';
public const REDEMPTION_CHANNEL_ONLINE = 'ONLINE';
/**
* Legacy alias for `ONLINE`. Deprecated.
*
* @deprecated
*/
public const REDEMPTION_CHANNEL_online = 'online';
public const REDEMPTION_CHANNEL_BOTH = 'BOTH';
/**
* Legacy alias for `BOTH`. Deprecated.
*
* @deprecated
*/
public const REDEMPTION_CHANNEL_both = 'both';
public const REDEMPTION_CHANNEL_TEMPORARY_PRICE_REDUCTION = 'TEMPORARY_PRICE_REDUCTION';
/**
* Legacy alias for `TEMPORARY_PRICE_REDUCTION`. Deprecated.
*
* @deprecated
*/
public const REDEMPTION_CHANNEL_temporaryPriceReduction = 'temporaryPriceReduction';
public const REVIEW_STATUS_REVIEW_STATUS_UNSPECIFIED = 'REVIEW_STATUS_UNSPECIFIED';
public const REVIEW_STATUS_UNDER_REVIEW = 'UNDER_REVIEW';
/**
* Legacy alias for `UNDER_REVIEW`. Deprecated.
*
* @deprecated
*/
public const REVIEW_STATUS_underReview = 'underReview';
public const REVIEW_STATUS_APPROVED = 'APPROVED';
/**
* Legacy alias for `APPROVED`. Deprecated.
*
* @deprecated
*/
public const REVIEW_STATUS_approved = 'approved';
public const REVIEW_STATUS_REJECTED = 'REJECTED';
/**
* Legacy alias for `REJECTED`. Deprecated.
*
* @deprecated
*/
public const REVIEW_STATUS_rejected = 'rejected';
public const REVIEW_STATUS_DRAFT = 'DRAFT';
/**
* Legacy alias for `DRAFT`. Deprecated.
*
* @deprecated
*/
public const REVIEW_STATUS_draft = 'draft';
/**
* Default value, same as UNLOCK_NOT_REQUIRED.
*/
public const VIEW_UNLOCK_REQUIREMENT_VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED = 'VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED';
/**
* Default behavior for all the existing Passes if ViewUnlockRequirement is
* not set.
*/
public const VIEW_UNLOCK_REQUIREMENT_UNLOCK_NOT_REQUIRED = 'UNLOCK_NOT_REQUIRED';
/**
* Requires the user to unlock their device each time the pass is viewed. If
* the user removes their device lock after saving the pass, then they will be
* prompted to create a device lock before the pass can be viewed.
*/
public const VIEW_UNLOCK_REQUIREMENT_UNLOCK_REQUIRED_TO_VIEW = 'UNLOCK_REQUIRED_TO_VIEW';
protected $collection_key = 'valueAddedModuleData';
/**
* Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
*
* @deprecated
* @var bool
*/
public $allowMultipleUsersPerObject;
protected $appLinkDataType = AppLinkData::class;
protected $appLinkDataDataType = '';
protected $callbackOptionsType = CallbackOptions::class;
protected $callbackOptionsDataType = '';
protected $classTemplateInfoType = ClassTemplateInfo::class;
protected $classTemplateInfoDataType = '';
/**
* 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.
*
* @var string
*/
public $countryCode;
/**
* The details of the offer.
*
* @var string
*/
public $details;
/**
* 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.
*
* @var bool
*/
public $enableSmartTap;
/**
* The fine print or terms of the offer, such as "20% off any t-shirt at
* Adam's Apparel."
*
* @var string
*/
public $finePrint;
protected $helpUriType = Uri::class;
protected $helpUriDataType = '';
protected $heroImageType = Image::class;
protected $heroImageDataType = '';
/**
* 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`.
*
* @var string
*/
public $hexBackgroundColor;
protected $homepageUriType = Uri::class;
protected $homepageUriDataType = '';
/**
* 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 '-'.
*
* @var string
*/
public $id;
protected $imageModulesDataType = ImageModuleData::class;
protected $imageModulesDataDataType = 'array';
protected $infoModuleDataType = InfoModuleData::class;
protected $infoModuleDataDataType = '';
/**
* Required. The issuer name. Recommended maximum length is 20 characters to
* ensure full string is displayed on smaller screens.
*
* @var string
*/
public $issuerName;
/**
* Identifies what kind of resource this is. Value: the fixed string
* `"walletobjects#offerClass"`.
*
* @deprecated
* @var string
*/
public $kind;
protected $linksModuleDataType = LinksModuleData::class;
protected $linksModuleDataDataType = '';
protected $localizedDetailsType = LocalizedString::class;
protected $localizedDetailsDataType = '';
protected $localizedFinePrintType = LocalizedString::class;
protected $localizedFinePrintDataType = '';
protected $localizedIssuerNameType = LocalizedString::class;
protected $localizedIssuerNameDataType = '';
protected $localizedProviderType = LocalizedString::class;
protected $localizedProviderDataType = '';
protected $localizedShortTitleType = LocalizedString::class;
protected $localizedShortTitleDataType = '';
protected $localizedTitleType = LocalizedString::class;
protected $localizedTitleDataType = '';
protected $locationsType = LatLongPoint::class;
protected $locationsDataType = 'array';
protected $merchantLocationsType = MerchantLocation::class;
protected $merchantLocationsDataType = 'array';
protected $messagesType = Message::class;
protected $messagesDataType = 'array';
/**
* Identifies whether multiple users and devices will save the same object
* referencing this class.
*
* @var string
*/
public $multipleDevicesAndHoldersAllowedStatus;
/**
* Whether or not field updates to this class should trigger notifications.
* When set to NOTIFY, we will attempt to trigger a field update notification
* to users. These notifications will only be sent to users if the field is
* part of an allowlist. If not specified, no notification will be triggered.
* This setting is ephemeral and needs to be set with each PATCH or UPDATE
* request, otherwise a notification will not be triggered.
*
* @var string
*/
public $notifyPreference;
/**
* 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.
*
* @var string
*/
public $provider;
/**
* Required. The redemption channels applicable to this offer.
*
* @var string
*/
public $redemptionChannel;
/**
* 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.
*
* @var string[]
*/
public $redemptionIssuers;
protected $reviewType = Review::class;
protected $reviewDataType = '';
/**
* 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`.
*
* @var string
*/
public $reviewStatus;
protected $securityAnimationType = SecurityAnimation::class;
protected $securityAnimationDataType = '';
/**
* 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.
*
* @var string
*/
public $shortTitle;
protected $textModulesDataType = TextModuleData::class;
protected $textModulesDataDataType = 'array';
/**
* 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.
*
* @var string
*/
public $title;
protected $titleImageType = Image::class;
protected $titleImageDataType = '';
protected $valueAddedModuleDataType = ValueAddedModuleData::class;
protected $valueAddedModuleDataDataType = 'array';
/**
* Deprecated
*
* @deprecated
* @var string
*/
public $version;
/**
* View Unlock Requirement options for the offer.
*
* @var string
*/
public $viewUnlockRequirement;
protected $wideTitleImageType = Image::class;
protected $wideTitleImageDataType = '';
protected $wordMarkType = Image::class;
protected $wordMarkDataType = '';
/**
* Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
*
* @deprecated
* @param bool $allowMultipleUsersPerObject
*/
public function setAllowMultipleUsersPerObject($allowMultipleUsersPerObject)
{
$this->allowMultipleUsersPerObject = $allowMultipleUsersPerObject;
}
/**
* @deprecated
* @return bool
*/
public function getAllowMultipleUsersPerObject()
{
return $this->allowMultipleUsersPerObject;
}
/**
* 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 object
* that will be used instead.
*
* @param AppLinkData $appLinkData
*/
public function setAppLinkData(AppLinkData $appLinkData)
{
$this->appLinkData = $appLinkData;
}
/**
* @return AppLinkData
*/
public function getAppLinkData()
{
return $this->appLinkData;
}
/**
* 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.
*
* @param CallbackOptions $callbackOptions
*/
public function setCallbackOptions(CallbackOptions $callbackOptions)
{
$this->callbackOptions = $callbackOptions;
}
/**
* @return CallbackOptions
*/
public function getCallbackOptions()
{
return $this->callbackOptions;
}
/**
* Template information about how the class should be displayed. If unset,
* Google will fallback to a default set of fields to display.
*
* @param ClassTemplateInfo $classTemplateInfo
*/
public function setClassTemplateInfo(ClassTemplateInfo $classTemplateInfo)
{
$this->classTemplateInfo = $classTemplateInfo;
}
/**
* @return ClassTemplateInfo
*/
public function getClassTemplateInfo()
{
return $this->classTemplateInfo;
}
/**
* 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.
*
* @param string $countryCode
*/
public function setCountryCode($countryCode)
{
$this->countryCode = $countryCode;
}
/**
* @return string
*/
public function getCountryCode()
{
return $this->countryCode;
}
/**
* The details of the offer.
*
* @param string $details
*/
public function setDetails($details)
{
$this->details = $details;
}
/**
* @return string
*/
public function getDetails()
{
return $this->details;
}
/**
* 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.
*
* @param bool $enableSmartTap
*/
public function setEnableSmartTap($enableSmartTap)
{
$this->enableSmartTap = $enableSmartTap;
}
/**
* @return bool
*/
public function getEnableSmartTap()
{
return $this->enableSmartTap;
}
/**
* The fine print or terms of the offer, such as "20% off any t-shirt at
* Adam's Apparel."
*
* @param string $finePrint
*/
public function setFinePrint($finePrint)
{
$this->finePrint = $finePrint;
}
/**
* @return string
*/
public function getFinePrint()
{
return $this->finePrint;
}
/**
* The help link for the offer, such as `http://myownpersonaldomain.com/help`
*
* @param Uri $helpUri
*/
public function setHelpUri(Uri $helpUri)
{
$this->helpUri = $helpUri;
}
/**
* @return Uri
*/
public function getHelpUri()
{
return $this->helpUri;
}
/**
* Optional banner image displayed on the front of the card. If none is
* present, nothing will be displayed. The image will display at 100% width.
*
* @param Image $heroImage
*/
public function setHeroImage(Image $heroImage)
{
$this->heroImage = $heroImage;
}
/**
* @return Image
*/
public function getHeroImage()
{
return $this->heroImage;
}
/**
* 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`.
*
* @param string $hexBackgroundColor
*/
public function setHexBackgroundColor($hexBackgroundColor)
{
$this->hexBackgroundColor = $hexBackgroundColor;
}
/**
* @return string
*/
public function getHexBackgroundColor()
{
return $this->hexBackgroundColor;
}
/**
* 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).
*
* @param Uri $homepageUri
*/
public function setHomepageUri(Uri $homepageUri)
{
$this->homepageUri = $homepageUri;
}
/**
* @return Uri
*/
public function getHomepageUri()
{
return $this->homepageUri;
}
/**
* 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 '-'.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Image module data. The maximum number of these fields displayed is 1 from
* object level and 1 for class object level.
*
* @param ImageModuleData[] $imageModulesData
*/
public function setImageModulesData($imageModulesData)
{
$this->imageModulesData = $imageModulesData;
}
/**
* @return ImageModuleData[]
*/
public function getImageModulesData()
{
return $this->imageModulesData;
}
/**
* Deprecated. Use textModulesData instead.
*
* @deprecated
* @param InfoModuleData $infoModuleData
*/
public function setInfoModuleData(InfoModuleData $infoModuleData)
{
$this->infoModuleData = $infoModuleData;
}
/**
* @deprecated
* @return InfoModuleData
*/
public function getInfoModuleData()
{
return $this->infoModuleData;
}
/**
* Required. The issuer name. Recommended maximum length is 20 characters to
* ensure full string is displayed on smaller screens.
*
* @param string $issuerName
*/
public function setIssuerName($issuerName)
{
$this->issuerName = $issuerName;
}
/**
* @return string
*/
public function getIssuerName()
{
return $this->issuerName;
}
/**
* Identifies what kind of resource this is. Value: the fixed string
* `"walletobjects#offerClass"`.
*
* @deprecated
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @deprecated
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* Links module data. If links module data is also defined on the object, both
* will be displayed.
*
* @param LinksModuleData $linksModuleData
*/
public function setLinksModuleData(LinksModuleData $linksModuleData)
{
$this->linksModuleData = $linksModuleData;
}
/**
* @return LinksModuleData
*/
public function getLinksModuleData()
{
return $this->linksModuleData;
}
/**
* Translated strings for the details.
*
* @param LocalizedString $localizedDetails
*/
public function setLocalizedDetails(LocalizedString $localizedDetails)
{
$this->localizedDetails = $localizedDetails;
}
/**
* @return LocalizedString
*/
public function getLocalizedDetails()
{
return $this->localizedDetails;
}
/**
* Translated strings for the fine_print.
*
* @param LocalizedString $localizedFinePrint
*/
public function setLocalizedFinePrint(LocalizedString $localizedFinePrint)
{
$this->localizedFinePrint = $localizedFinePrint;
}
/**
* @return LocalizedString
*/
public function getLocalizedFinePrint()
{
return $this->localizedFinePrint;
}
/**
* Translated strings for the issuer_name. Recommended maximum length is 20
* characters to ensure full string is displayed on smaller screens.
*
* @param LocalizedString $localizedIssuerName
*/
public function setLocalizedIssuerName(LocalizedString $localizedIssuerName)
{
$this->localizedIssuerName = $localizedIssuerName;
}
/**
* @return LocalizedString
*/
public function getLocalizedIssuerName()
{
return $this->localizedIssuerName;
}
/**
* Translated strings for the provider. Recommended maximum length is 12
* characters to ensure full string is displayed on smaller screens.
*
* @param LocalizedString $localizedProvider
*/
public function setLocalizedProvider(LocalizedString $localizedProvider)
{
$this->localizedProvider = $localizedProvider;
}
/**
* @return LocalizedString
*/
public function getLocalizedProvider()
{
return $this->localizedProvider;
}
/**
* Translated strings for the short title. Recommended maximum length is 20
* characters.
*
* @param LocalizedString $localizedShortTitle
*/
public function setLocalizedShortTitle(LocalizedString $localizedShortTitle)
{
$this->localizedShortTitle = $localizedShortTitle;
}
/**
* @return LocalizedString
*/
public function getLocalizedShortTitle()
{
return $this->localizedShortTitle;
}
/**
* Translated strings for the title. Recommended maximum length is 60
* characters to ensure full string is displayed on smaller screens.
*
* @param LocalizedString $localizedTitle
*/
public function setLocalizedTitle(LocalizedString $localizedTitle)
{
$this->localizedTitle = $localizedTitle;
}
/**
* @return LocalizedString
*/
public function getLocalizedTitle()
{
return $this->localizedTitle;
}
/**
* Note: This field is currently not supported to trigger geo notifications.
*
* @deprecated
* @param LatLongPoint[] $locations
*/
public function setLocations($locations)
{
$this->locations = $locations;
}
/**
* @deprecated
* @return LatLongPoint[]
*/
public function getLocations()
{
return $this->locations;
}
/**
* Merchant locations. There is a maximum of ten on the class. Any additional
* MerchantLocations added beyond the 10 will be rejected. These locations
* will trigger a notification when a user enters within a Google-set radius
* of the point. This field replaces the deprecated LatLongPoints.
*
* @param MerchantLocation[] $merchantLocations
*/
public function setMerchantLocations($merchantLocations)
{
$this->merchantLocations = $merchantLocations;
}
/**
* @return MerchantLocation[]
*/
public function getMerchantLocations()
{
return $this->merchantLocations;
}
/**
* 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.
*
* @param Message[] $messages
*/
public function setMessages($messages)
{
$this->messages = $messages;
}
/**
* @return Message[]
*/
public function getMessages()
{
return $this->messages;
}
/**
* Identifies whether multiple users and devices will save the same object
* referencing this class.
*
* Accepted values: STATUS_UNSPECIFIED, MULTIPLE_HOLDERS,
* ONE_USER_ALL_DEVICES, ONE_USER_ONE_DEVICE, multipleHolders,
* oneUserAllDevices, oneUserOneDevice
*
* @param self::MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_* $multipleDevicesAndHoldersAllowedStatus
*/
public function setMultipleDevicesAndHoldersAllowedStatus($multipleDevicesAndHoldersAllowedStatus)
{
$this->multipleDevicesAndHoldersAllowedStatus = $multipleDevicesAndHoldersAllowedStatus;
}
/**
* @return self::MULTIPLE_DEVICES_AND_HOLDERS_ALLOWED_STATUS_*
*/
public function getMultipleDevicesAndHoldersAllowedStatus()
{
return $this->multipleDevicesAndHoldersAllowedStatus;
}
/**
* Whether or not field updates to this class should trigger notifications.
* When set to NOTIFY, we will attempt to trigger a field update notification
* to users. These notifications will only be sent to users if the field is
* part of an allowlist. If not specified, no notification will be triggered.
* This setting is ephemeral and needs to be set with each PATCH or UPDATE
* request, otherwise a notification will not be triggered.
*
* Accepted values: NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED,
* NOTIFY_ON_UPDATE
*
* @param self::NOTIFY_PREFERENCE_* $notifyPreference
*/
public function setNotifyPreference($notifyPreference)
{
$this->notifyPreference = $notifyPreference;
}
/**
* @return self::NOTIFY_PREFERENCE_*
*/
public function getNotifyPreference()
{
return $this->notifyPreference;
}
/**
* 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.
*
* @param string $provider
*/
public function setProvider($provider)
{
$this->provider = $provider;
}
/**
* @return string
*/
public function getProvider()
{
return $this->provider;
}
/**
* Required. The redemption channels applicable to this offer.
*
* Accepted values: REDEMPTION_CHANNEL_UNSPECIFIED, INSTORE, instore, ONLINE,
* online, BOTH, both, TEMPORARY_PRICE_REDUCTION, temporaryPriceReduction
*
* @param self::REDEMPTION_CHANNEL_* $redemptionChannel
*/
public function setRedemptionChannel($redemptionChannel)
{
$this->redemptionChannel = $redemptionChannel;
}
/**
* @return self::REDEMPTION_CHANNEL_*
*/
public function getRedemptionChannel()
{
return $this->redemptionChannel;
}
/**
* 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.
*
* @param string[] $redemptionIssuers
*/
public function setRedemptionIssuers($redemptionIssuers)
{
$this->redemptionIssuers = $redemptionIssuers;
}
/**
* @return string[]
*/
public function getRedemptionIssuers()
{
return $this->redemptionIssuers;
}
/**
* The review comments set by the platform when a class is marked `approved`
* or `rejected`.
*
* @param Review $review
*/
public function setReview(Review $review)
{
$this->review = $review;
}
/**
* @return Review
*/
public function getReview()
{
return $this->review;
}
/**
* 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`.
*
* Accepted values: REVIEW_STATUS_UNSPECIFIED, UNDER_REVIEW, underReview,
* APPROVED, approved, REJECTED, rejected, DRAFT, draft
*
* @param self::REVIEW_STATUS_* $reviewStatus
*/
public function setReviewStatus($reviewStatus)
{
$this->reviewStatus = $reviewStatus;
}
/**
* @return self::REVIEW_STATUS_*
*/
public function getReviewStatus()
{
return $this->reviewStatus;
}
/**
* Optional information about the security animation. If this is set a
* security animation will be rendered on pass details.
*
* @param SecurityAnimation $securityAnimation
*/
public function setSecurityAnimation(SecurityAnimation $securityAnimation)
{
$this->securityAnimation = $securityAnimation;
}
/**
* @return SecurityAnimation
*/
public function getSecurityAnimation()
{
return $this->securityAnimation;
}
/**
* 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.
*
* @param string $shortTitle
*/
public function setShortTitle($shortTitle)
{
$this->shortTitle = $shortTitle;
}
/**
* @return string
*/
public function getShortTitle()
{
return $this->shortTitle;
}
/**
* 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.
*
* @param TextModuleData[] $textModulesData
*/
public function setTextModulesData($textModulesData)
{
$this->textModulesData = $textModulesData;
}
/**
* @return TextModuleData[]
*/
public function getTextModulesData()
{
return $this->textModulesData;
}
/**
* 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.
*
* @param string $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
/**
* The title image of the offer. This image is displayed in both the details
* and list views of the app.
*
* @param Image $titleImage
*/
public function setTitleImage(Image $titleImage)
{
$this->titleImage = $titleImage;
}
/**
* @return Image
*/
public function getTitleImage()
{
return $this->titleImage;
}
/**
* Optional value added module data. Maximum of ten on the class. For a pass
* only ten will be displayed, prioritizing those from the object.
*
* @param ValueAddedModuleData[] $valueAddedModuleData
*/
public function setValueAddedModuleData($valueAddedModuleData)
{
$this->valueAddedModuleData = $valueAddedModuleData;
}
/**
* @return ValueAddedModuleData[]
*/
public function getValueAddedModuleData()
{
return $this->valueAddedModuleData;
}
/**
* Deprecated
*
* @deprecated
* @param string $version
*/
public function setVersion($version)
{
$this->version = $version;
}
/**
* @deprecated
* @return string
*/
public function getVersion()
{
return $this->version;
}
/**
* View Unlock Requirement options for the offer.
*
* Accepted values: VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED, UNLOCK_NOT_REQUIRED,
* UNLOCK_REQUIRED_TO_VIEW
*
* @param self::VIEW_UNLOCK_REQUIREMENT_* $viewUnlockRequirement
*/
public function setViewUnlockRequirement($viewUnlockRequirement)
{
$this->viewUnlockRequirement = $viewUnlockRequirement;
}
/**
* @return self::VIEW_UNLOCK_REQUIREMENT_*
*/
public function getViewUnlockRequirement()
{
return $this->viewUnlockRequirement;
}
/**
* The wide title image of the offer. When provided, this will be used in
* place of the title image in the top left of the card view.
*
* @param Image $wideTitleImage
*/
public function setWideTitleImage(Image $wideTitleImage)
{
$this->wideTitleImage = $wideTitleImage;
}
/**
* @return Image
*/
public function getWideTitleImage()
{
return $this->wideTitleImage;
}
/**
* Deprecated.
*
* @deprecated
* @param Image $wordMark
*/
public function setWordMark(Image $wordMark)
{
$this->wordMark = $wordMark;
}
/**
* @deprecated
* @return Image
*/
public function getWordMark()
{
return $this->wordMark;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OfferClass::class, 'Google_Service_Walletobjects_OfferClass');