OfferClass

import type { OfferClass } from "https://googleapis.deno.dev/v1/walletobjects:v1.ts";

interface OfferClass {

allowMultipleUsersPerObject?: boolean;

appLinkData?: AppLinkData;

callbackOptions?: CallbackOptions;

classTemplateInfo?: ClassTemplateInfo;

countryCode?: string;

details?: string;

enableSmartTap?: boolean;

finePrint?: string;

helpUri?: Uri;

heroImage?: Image;

hexBackgroundColor?: string;

homepageUri?: Uri;

id?: string;

imageModulesData?: ImageModuleData[];

infoModuleData?: InfoModuleData;

issuerName?: string;

kind?: string;

linksModuleData?: LinksModuleData;

localizedDetails?: LocalizedString;

localizedFinePrint?: LocalizedString;

localizedIssuerName?: LocalizedString;

localizedProvider?: LocalizedString;

localizedShortTitle?: LocalizedString;

localizedTitle?: LocalizedString;

locations?: LatLongPoint[];

messages?: Message[];

multipleDevicesAndHoldersAllowedStatus?:

| "STATUS_UNSPECIFIED"

| "MULTIPLE_HOLDERS"

| "ONE_USER_ALL_DEVICES"

| "ONE_USER_ONE_DEVICE"

| "multipleHolders"

| "oneUserAllDevices"

| "oneUserOneDevice";

provider?: string;

redemptionChannel?:

| "REDEMPTION_CHANNEL_UNSPECIFIED"

| "INSTORE"

| "instore"

| "ONLINE"

| "online"

| "BOTH"

| "both"

| "TEMPORARY_PRICE_REDUCTION"

| "temporaryPriceReduction";

redemptionIssuers?: bigint[];

review?: Review;

reviewStatus?:

| "REVIEW_STATUS_UNSPECIFIED"

| "UNDER_REVIEW"

| "underReview"

| "APPROVED"

| "approved"

| "REJECTED"

| "rejected"

| "DRAFT"

| "draft";

securityAnimation?: SecurityAnimation;

shortTitle?: string;

textModulesData?: TextModuleData[];

title?: string;

titleImage?: Image;

version?: bigint;

viewUnlockRequirement?: "VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED" | "UNLOCK_NOT_REQUIRED" | "UNLOCK_REQUIRED_TO_VIEW";

wideTitleImage?: Image;

wordMark?: Image;

}

§Properties

allowMultipleUsersPerObject?: boolean

[src]

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

appLinkData?: AppLinkData

[src]

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.

callbackOptions?: CallbackOptions

[src]

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.

classTemplateInfo?: ClassTemplateInfo

[src]

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

countryCode?: string

[src]

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.

details?: string

[src]

The details of the offer.

enableSmartTap?: boolean

[src]

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.

finePrint?: string

[src]

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

helpUri?: Uri

[src]

The help link for the offer, such as http://myownpersonaldomain.com/help

heroImage?: Image

[src]

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.

hexBackgroundColor?: string

[src]

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.

homepageUri?: Uri

[src]

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

id?: string

[src]

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 '-'.

imageModulesData?: ImageModuleData[]

[src]

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

infoModuleData?: InfoModuleData

[src]

Deprecated. Use textModulesData instead.

issuerName?: string

[src]

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

kind?: string

[src]

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

linksModuleData?: LinksModuleData

[src]

Links module data. If links module data is also defined on the object, both will be displayed.

localizedDetails?: LocalizedString

[src]

Translated strings for the details.

localizedFinePrint?: LocalizedString

[src]

Translated strings for the fine_print.

localizedIssuerName?: LocalizedString

[src]

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

localizedProvider?: LocalizedString

[src]

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

localizedShortTitle?: LocalizedString

[src]

Translated strings for the short title. Recommended maximum length is 20 characters.

localizedTitle?: LocalizedString

[src]

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

locations?: LatLongPoint[]

[src]

Note: This field is currently not supported to trigger geo notifications.

messages?: Message[]

[src]

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.

[src]

Identifies whether multiple users and devices will save the same object referencing this class.

provider?: string

[src]

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.

[src]

Required. The redemption channels applicable to this offer.

redemptionIssuers?: bigint[]

[src]

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.

review?: Review

[src]

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

[src]

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.

securityAnimation?: SecurityAnimation

[src]

Optional information about the security animation. If this is set a security animation will be rendered on pass details.

shortTitle?: string

[src]

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.

textModulesData?: TextModuleData[]

[src]

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.

title?: string

[src]

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.

titleImage?: Image

[src]

The title image of the offer. This image is displayed in both the details and list views of the app.

version?: bigint

[src]

Deprecated

viewUnlockRequirement?: "VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED" | "UNLOCK_NOT_REQUIRED" | "UNLOCK_REQUIRED_TO_VIEW"

[src]

View Unlock Requirement options for the offer.

wideTitleImage?: Image

[src]

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.

wordMark?: Image

[src]

Deprecated.