GiftCardObject

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

interface GiftCardObject {

appLinkData?: AppLinkData;

balance?: Money;

balanceUpdateTime?: DateTime;

barcode?: Barcode;

cardNumber?: string;

classId?: string;

classReference?: GiftCardClass;

disableExpirationNotification?: boolean;

eventNumber?: string;

groupingInfo?: GroupingInfo;

hasLinkedDevice?: boolean;

hasUsers?: boolean;

heroImage?: Image;

id?: string;

imageModulesData?: ImageModuleData[];

infoModuleData?: InfoModuleData;

kind?: string;

linksModuleData?: LinksModuleData;

locations?: LatLongPoint[];

messages?: Message[];

passConstraints?: PassConstraints;

pin?: string;

rotatingBarcode?: RotatingBarcode;

smartTapRedemptionValue?: string;

state?:

| "STATE_UNSPECIFIED"

| "ACTIVE"

| "active"

| "COMPLETED"

| "completed"

| "EXPIRED"

| "expired"

| "INACTIVE"

| "inactive";

textModulesData?: TextModuleData[];

validTimeInterval?: TimeInterval;

version?: bigint;

}

§Properties

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 class only object AppLinkData will be displayed.

balance?: Money

[src]

The card's monetary balance.

balanceUpdateTime?: DateTime

[src]

The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.

barcode?: Barcode

[src]

The barcode type and value.

cardNumber?: string

[src]

Required. The card's number.

classId?: string

[src]

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.

classReference?: GiftCardClass

[src]

A copy of the inherited fields of the parent class. These fields are retrieved during a GET.

disableExpirationNotification?: boolean

[src]

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

eventNumber?: string

[src]

The card's event number, an optional field used by some gift cards.

groupingInfo?: GroupingInfo

[src]

Information that controls how passes are grouped together.

hasLinkedDevice?: boolean

[src]

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.

hasUsers?: boolean

[src]

Indicates if the object has users. This field is set by the platform.

heroImage?: Image

[src]

Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.

id?: string

[src]

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

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.

kind?: string

[src]

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

linksModuleData?: LinksModuleData

[src]

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

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.

passConstraints?: PassConstraints

[src]

Pass constraints for the object. Includes limiting NFC and screenshot behaviors.

pin?: string

[src]

The card's PIN.

rotatingBarcode?: RotatingBarcode

[src]

The rotating barcode type and value.

smartTapRedemptionValue?: string

[src]

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.

[src]

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.

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.

validTimeInterval?: TimeInterval

[src]

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.

version?: bigint

[src]

Deprecated