FlightClass

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

interface FlightClass {

allowMultipleUsersPerObject?: boolean;

appLinkData?: AppLinkData;

boardingAndSeatingPolicy?: BoardingAndSeatingPolicy;

callbackOptions?: CallbackOptions;

classTemplateInfo?: ClassTemplateInfo;

countryCode?: string;

destination?: AirportInfo;

enableSmartTap?: boolean;

flightHeader?: FlightHeader;

flightStatus?:

| "FLIGHT_STATUS_UNSPECIFIED"

| "SCHEDULED"

| "scheduled"

| "ACTIVE"

| "active"

| "LANDED"

| "landed"

| "CANCELLED"

| "cancelled"

| "REDIRECTED"

| "redirected"

| "DIVERTED"

| "diverted";

heroImage?: Image;

hexBackgroundColor?: string;

homepageUri?: Uri;

id?: string;

imageModulesData?: ImageModuleData[];

infoModuleData?: InfoModuleData;

issuerName?: string;

kind?: string;

languageOverride?: string;

linksModuleData?: LinksModuleData;

localBoardingDateTime?: string;

localEstimatedOrActualArrivalDateTime?: string;

localEstimatedOrActualDepartureDateTime?: string;

localGateClosingDateTime?: string;

localizedIssuerName?: LocalizedString;

localScheduledArrivalDateTime?: string;

localScheduledDepartureDateTime?: string;

locations?: LatLongPoint[];

messages?: Message[];

multipleDevicesAndHoldersAllowedStatus?:

| "STATUS_UNSPECIFIED"

| "MULTIPLE_HOLDERS"

| "ONE_USER_ALL_DEVICES"

| "ONE_USER_ONE_DEVICE"

| "multipleHolders"

| "oneUserAllDevices"

| "oneUserOneDevice";

origin?: AirportInfo;

redemptionIssuers?: bigint[];

review?: Review;

reviewStatus?:

| "REVIEW_STATUS_UNSPECIFIED"

| "UNDER_REVIEW"

| "underReview"

| "APPROVED"

| "approved"

| "REJECTED"

| "rejected"

| "DRAFT"

| "draft";

securityAnimation?: SecurityAnimation;

textModulesData?: TextModuleData[];

version?: bigint;

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

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.

boardingAndSeatingPolicy?: BoardingAndSeatingPolicy

[src]

Policies for boarding and seating. These will inform which labels will be shown to users.

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.

destination?: AirportInfo

[src]

Required. Destination airport.

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.

flightHeader?: FlightHeader

[src]

Required. Information about the flight carrier and number.

[src]

Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.

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#flightClass".

languageOverride?: string

[src]

If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

linksModuleData?: LinksModuleData

[src]

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

localBoardingDateTime?: string

[src]

The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.

localEstimatedOrActualArrivalDateTime?: string

[src]

The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.

localEstimatedOrActualDepartureDateTime?: string

[src]

The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true:

It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.

localGateClosingDateTime?: string

[src]

The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.

localizedIssuerName?: LocalizedString

[src]

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

localScheduledArrivalDateTime?: string

[src]

The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set localEstimatedOrActualArrivalDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.

localScheduledDepartureDateTime?: string

[src]

Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set localEstimatedOrActualDepartureDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.

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.

origin?: AirportInfo

[src]

Required. Origin airport.

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

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.

version?: bigint

[src]

Deprecated

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

[src]

View Unlock Requirement options for the boarding pass.

wordMark?: Image

[src]

Deprecated.