googleapis
Version:
Google APIs Client Library for Node.js
858 lines • 787 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace walletobjects_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Wallet API
*
* API for issuers to save and manage Google Wallet Objects.
*
* @example
* ```js
* const {google} = require('googleapis');
* const walletobjects = google.walletobjects('v1');
* ```
*/
export class Walletobjects {
context: APIRequestContext;
eventticketclass: Resource$Eventticketclass;
eventticketobject: Resource$Eventticketobject;
flightclass: Resource$Flightclass;
flightobject: Resource$Flightobject;
genericclass: Resource$Genericclass;
genericobject: Resource$Genericobject;
giftcardclass: Resource$Giftcardclass;
giftcardobject: Resource$Giftcardobject;
issuer: Resource$Issuer;
jwt: Resource$Jwt;
loyaltyclass: Resource$Loyaltyclass;
loyaltyobject: Resource$Loyaltyobject;
media: Resource$Media;
offerclass: Resource$Offerclass;
offerobject: Resource$Offerobject;
permissions: Resource$Permissions;
smarttap: Resource$Smarttap;
transitclass: Resource$Transitclass;
transitobject: Resource$Transitobject;
walletobjects: Resource$Walletobjects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* ActivationOptions for the class
*/
export interface Schema$ActivationOptions {
/**
* HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
*/
activationUrl?: string | null;
/**
* Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.
*/
allowReactivation?: boolean | null;
}
/**
* The activation status of the object. This field includes activation status if valuable supports activation.
*/
export interface Schema$ActivationStatus {
state?: string | null;
}
/**
* Resource used when the AddMessage endpoints are called.
*/
export interface Schema$AddMessageRequest {
message?: Schema$Message;
}
export interface Schema$AirportInfo {
/**
* Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
*/
airportIataCode?: string | null;
/**
* Optional field that overrides the airport city name defined by IATA. By default, Google takes the `airportIataCode` provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
*/
airportNameOverride?: Schema$LocalizedString;
/**
* A name of the gate. Eg: "B59" or "59"
*/
gate?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string `"walletobjects#airportInfo"`.
*/
kind?: string | null;
/**
* Terminal name. Eg: "INTL" or "I"
*/
terminal?: string | null;
}
export interface Schema$AppLinkData {
/**
* Optional information about the partner app link.
*/
androidAppLinkInfo?: Schema$AppLinkDataAppLinkInfo;
/**
* Optional display text for the app link button. Character limit is 30.
*/
displayText?: Schema$LocalizedString;
/**
* Deprecated. Links to open iOS apps are not supported.
*/
iosAppLinkInfo?: Schema$AppLinkDataAppLinkInfo;
/**
* Optional information about the partner web link.
*/
webAppLinkInfo?: Schema$AppLinkDataAppLinkInfo;
}
export interface Schema$AppLinkDataAppLinkInfo {
/**
* Deprecated. Image isn't supported in the app link module.
*/
appLogoImage?: Schema$Image;
/**
* Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
*/
appTarget?: Schema$AppLinkDataAppLinkInfoAppTarget;
/**
* Deprecated. Description isn't supported in the app link module.
*/
description?: Schema$LocalizedString;
/**
* Deprecated. Title isn't supported in the app link module.
*/
title?: Schema$LocalizedString;
}
export interface Schema$AppLinkDataAppLinkInfoAppTarget {
/**
* Package name for AppTarget. For example: com.google.android.gm
*/
packageName?: string | null;
/**
* URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.
*/
targetUri?: Schema$Uri;
}
export interface Schema$AuthenticationKey {
/**
* Available only to Smart Tap enabled partners. Contact support for additional guidance.
*/
id?: number | null;
/**
* Available only to Smart Tap enabled partners. Contact support for additional guidance.
*/
publicKeyPem?: string | null;
}
export interface Schema$Barcode {
/**
* An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
*/
alternateText?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string `"walletobjects#barcode"`.
*/
kind?: string | null;
/**
* The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
*/
renderEncoding?: string | null;
/**
* Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
*/
showCodeText?: Schema$LocalizedString;
/**
* The type of barcode.
*/
type?: string | null;
/**
* The value encoded in the barcode.
*/
value?: string | null;
}
export interface Schema$BarcodeSectionDetail {
/**
* A reference to an existing text-based or image field to display.
*/
fieldSelector?: Schema$FieldSelector;
}
/**
* Information to read/write to blobstore2.
*/
export interface Schema$Blobstore2Info {
/**
* The blob generation id.
*/
blobGeneration?: string | null;
/**
* The blob id, e.g., /blobstore/prod/playground/scotty
*/
blobId?: string | null;
/**
* A serialized External Read Token passed from Bigstore -\> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
*/
downloadExternalReadToken?: string | null;
/**
* Read handle passed from Bigstore -\> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
*/
downloadReadHandle?: string | null;
/**
* The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
*/
readToken?: string | null;
/**
* A serialized Object Fragment List Creation Info passed from Bigstore -\> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
*/
uploadFragmentListCreationInfo?: string | null;
/**
* Metadata passed from Blobstore -\> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
*/
uploadMetadataContainer?: string | null;
}
export interface Schema$BoardingAndSeatingInfo {
/**
* Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set.
*/
boardingDoor?: string | null;
/**
* The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object.
*/
boardingGroup?: string | null;
/**
* The value of boarding position. eg: "76"
*/
boardingPosition?: string | null;
/**
* A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
*/
boardingPrivilegeImage?: Schema$Image;
/**
* Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`.
*/
kind?: string | null;
/**
* The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate"
*/
seatAssignment?: Schema$LocalizedString;
/**
* The value of the seat class. eg: "Economy" or "Economy Plus"
*/
seatClass?: string | null;
/**
* The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A"
*/
seatNumber?: string | null;
/**
* The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
*/
sequenceNumber?: string | null;
}
export interface Schema$BoardingAndSeatingPolicy {
/**
* Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
*/
boardingPolicy?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingPolicy"`.
*/
kind?: string | null;
/**
* Seating policy which dictates how we display the seat class. If unset, Google will default to `cabinBased`.
*/
seatClassPolicy?: string | null;
}
export interface Schema$CallbackOptions {
/**
* URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
*/
updateRequestUrl?: string | null;
/**
* The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.
*/
url?: string | null;
}
export interface Schema$CardBarcodeSectionDetails {
/**
* Optional information to display below the barcode.
*/
firstBottomDetail?: Schema$BarcodeSectionDetail;
/**
* Optional information to display above the barcode. If `secondTopDetail` is defined, this will be displayed to the start side of this detail section.
*/
firstTopDetail?: Schema$BarcodeSectionDetail;
/**
* Optional second piece of information to display above the barcode. If `firstTopDetail` is defined, this will be displayed to the end side of this detail section.
*/
secondTopDetail?: Schema$BarcodeSectionDetail;
}
export interface Schema$CardRowOneItem {
/**
* The item to be displayed in the row. This item will be automatically centered.
*/
item?: Schema$TemplateItem;
}
export interface Schema$CardRowTemplateInfo {
/**
* Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
*/
oneItem?: Schema$CardRowOneItem;
/**
* Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
*/
threeItems?: Schema$CardRowThreeItems;
/**
* Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.
*/
twoItems?: Schema$CardRowTwoItems;
}
export interface Schema$CardRowThreeItems {
/**
* The item to be displayed at the end of the row. This item will be aligned to the right.
*/
endItem?: Schema$TemplateItem;
/**
* The item to be displayed in the middle of the row. This item will be centered between the start and end items.
*/
middleItem?: Schema$TemplateItem;
/**
* The item to be displayed at the start of the row. This item will be aligned to the left.
*/
startItem?: Schema$TemplateItem;
}
export interface Schema$CardRowTwoItems {
/**
* The item to be displayed at the end of the row. This item will be aligned to the right.
*/
endItem?: Schema$TemplateItem;
/**
* The item to be displayed at the start of the row. This item will be aligned to the left.
*/
startItem?: Schema$TemplateItem;
}
export interface Schema$CardTemplateOverride {
/**
* Template information for rows in the card view. At most three rows are allowed to be specified.
*/
cardRowTemplateInfos?: Schema$CardRowTemplateInfo[];
}
export interface Schema$ClassTemplateInfo {
/**
* Specifies extra information to be displayed above and below the barcode.
*/
cardBarcodeSectionDetails?: Schema$CardBarcodeSectionDetails;
/**
* Override for the card view.
*/
cardTemplateOverride?: Schema$CardTemplateOverride;
/**
* Override for the details view (beneath the card view).
*/
detailsTemplateOverride?: Schema$DetailsTemplateOverride;
/**
* Override for the passes list view.
*/
listTemplateOverride?: Schema$ListTemplateOverride;
}
/**
* A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
*/
export interface Schema$CompositeMedia {
/**
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
*/
blobRef?: string | null;
/**
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
*/
blobstore2Info?: Schema$Blobstore2Info;
/**
* A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
*/
cosmoBinaryReference?: string | null;
/**
* crc32.c hash for the payload.
*/
crc32cHash?: number | null;
/**
* Media data, set if reference_type is INLINE
*/
inline?: string | null;
/**
* Size of the data, in bytes
*/
length?: string | null;
/**
* MD5 hash for the payload.
*/
md5Hash?: string | null;
/**
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
*/
objectId?: Schema$ObjectId;
/**
* Path to the data, set if reference_type is PATH
*/
path?: string | null;
/**
* Describes what the field reference contains.
*/
referenceType?: string | null;
/**
* SHA-1 hash for the payload.
*/
sha1Hash?: string | null;
}
/**
* Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
*/
export interface Schema$ContentTypeInfo {
/**
* Scotty's best guess of what the content type of the file is.
*/
bestGuess?: string | null;
/**
* The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
*/
fromBytes?: string | null;
/**
* The content type of the file derived from the file extension of the original file name used by the client.
*/
fromFileName?: string | null;
/**
* The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
*/
fromHeader?: string | null;
/**
* The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
*/
fromUrlPath?: string | null;
}
export interface Schema$DateTime {
/**
* An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
*/
date?: string | null;
}
export interface Schema$DetailsItemInfo {
/**
* The item to be displayed in the details list.
*/
item?: Schema$TemplateItem;
}
export interface Schema$DetailsTemplateOverride {
/**
* Information for the "nth" item displayed in the details list.
*/
detailsItemInfos?: Schema$DetailsItemInfo[];
}
/**
* Device context associated with the object.
*/
export interface Schema$DeviceContext {
/**
* If set, redemption information will only be returned to the given device upon activation of the object. This should not be used as a stable identifier to trace a user's device. It can change across different passes for the same device or even across different activations for the same device. When setting this, callers must also set has_linked_device on the object being activated.
*/
deviceToken?: string | null;
}
/**
* Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$DiffChecksumsResponse {
/**
* Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
*/
checksumsLocation?: Schema$CompositeMedia;
/**
* The chunk size of checksums. Must be a multiple of 256KB.
*/
chunkSizeBytes?: string | null;
/**
* If set, calculate the checksums based on the contents and return them to the caller.
*/
objectLocation?: Schema$CompositeMedia;
/**
* The total size of the server object.
*/
objectSizeBytes?: string | null;
/**
* The object version of the object the checksums are being returned for.
*/
objectVersion?: string | null;
}
/**
* Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$DiffDownloadResponse {
/**
* The original object location.
*/
objectLocation?: Schema$CompositeMedia;
}
/**
* A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$DiffUploadRequest {
/**
* The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
*/
checksumsInfo?: Schema$CompositeMedia;
/**
* The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
*/
objectInfo?: Schema$CompositeMedia;
/**
* The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
*/
objectVersion?: string | null;
}
/**
* Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$DiffUploadResponse {
/**
* The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
*/
objectVersion?: string | null;
/**
* The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
*/
originalObject?: Schema$CompositeMedia;
}
/**
* Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$DiffVersionResponse {
/**
* The total size of the server object.
*/
objectSizeBytes?: string | null;
/**
* The version of the object stored at the server.
*/
objectVersion?: string | null;
}
/**
* Information about how a class may be discovered and instantiated from within the Google Wallet app. This is done by searching for a loyalty or gift card program and scanning or manually entering.
*/
export interface Schema$DiscoverableProgram {
/**
* Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
*/
merchantSigninInfo?: Schema$DiscoverableProgramMerchantSigninInfo;
/**
* Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
*/
merchantSignupInfo?: Schema$DiscoverableProgramMerchantSignupInfo;
/**
* Visibility state of the discoverable program.
*/
state?: string | null;
}
/**
* Information about the merchant hosted signin flow for a program.
*/
export interface Schema$DiscoverableProgramMerchantSigninInfo {
/**
* The URL to direct the user to for the merchant's signin site.
*/
signinWebsite?: Schema$Uri;
}
/**
* Information about the merchant hosted signup flow for a program.
*/
export interface Schema$DiscoverableProgramMerchantSignupInfo {
/**
* User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.
*/
signupSharedDatas?: string[] | null;
/**
* The URL to direct the user to for the merchant's signup site.
*/
signupWebsite?: Schema$Uri;
}
/**
* Parameters specific to media downloads.
*/
export interface Schema$DownloadParameters {
/**
* A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
*/
allowGzipCompression?: boolean | null;
/**
* Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
*/
ignoreRange?: boolean | null;
}
export interface Schema$EventDateTime {
/**
* A custom label to use for the doors open value (`doorsOpen`) on the card detail view. This should only be used if the default "Doors Open" label or one of the `doorsOpenLabel` options is not sufficient. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
*/
customDoorsOpenLabel?: Schema$LocalizedString;
/**
* The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
*/
doorsOpen?: string | null;
/**
* The label to use for the doors open value (`doorsOpen`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `doorsOpenLabel` and `customDoorsOpenLabel` may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
*/
doorsOpenLabel?: string | null;
/**
* The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
*/
end?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventDateTime"`.
*/
kind?: string | null;
/**
* The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the venue is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
*/
start?: string | null;
}
export interface Schema$EventReservationInfo {
/**
* The confirmation code of the event reservation. This may also take the form of an "order number", "confirmation number", "reservation number", or other equivalent.
*/
confirmationCode?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventReservationInfo"`.
*/
kind?: string | null;
}
export interface Schema$EventSeat {
/**
* The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
*/
gate?: Schema$LocalizedString;
/**
* Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventSeat"`.
*/
kind?: string | null;
/**
* The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
*/
row?: Schema$LocalizedString;
/**
* The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
*/
seat?: Schema$LocalizedString;
/**
* The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
*/
section?: Schema$LocalizedString;
}
export interface Schema$EventTicketClass {
/**
* Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
*/
allowMultipleUsersPerObject?: boolean | null;
/**
* 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.
*/
appLinkData?: Schema$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.
*/
callbackOptions?: Schema$CallbackOptions;
/**
* Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
*/
classTemplateInfo?: Schema$ClassTemplateInfo;
/**
* The label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
*/
confirmationCodeLabel?: string | null;
/**
* 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.
*/
countryCode?: string | null;
/**
* A custom label to use for the confirmation code value (`eventTicketObject.reservationInfo.confirmationCode`) on the card detail view. This should only be used if the default "Confirmation Code" label or one of the `confirmationCodeLabel` options is not sufficient. Both `confirmationCodeLabel` and `customConfirmationCodeLabel` may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
*/
customConfirmationCodeLabel?: Schema$LocalizedString;
/**
* A custom label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. This should only be used if the default "Gate" label or one of the `gateLabel` options is not sufficient. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
*/
customGateLabel?: Schema$LocalizedString;
/**
* A custom label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. This should only be used if the default "Row" label or one of the `rowLabel` options is not sufficient. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
*/
customRowLabel?: Schema$LocalizedString;
/**
* A custom label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. This should only be used if the default "Seat" label or one of the `seatLabel` options is not sufficient. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
*/
customSeatLabel?: Schema$LocalizedString;
/**
* A custom label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. This should only be used if the default "Section" label or one of the `sectionLabel` options is not sufficient. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
*/
customSectionLabel?: Schema$LocalizedString;
/**
* The date & time information of the event.
*/
dateTime?: Schema$EventDateTime;
/**
* 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.
*/
enableSmartTap?: boolean | null;
/**
* The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the `classId` (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
*/
eventId?: string | null;
/**
* Required. The name of the event, such as "LA Dodgers at SF Giants".
*/
eventName?: Schema$LocalizedString;
/**
* The fine print, terms, or conditions of the ticket.
*/
finePrint?: Schema$LocalizedString;
/**
* The label to use for the gate value (`eventTicketObject.seatInfo.gate`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `gateLabel` and `customGateLabel` may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
*/
gateLabel?: string | null;
/**
* 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.
*/
heroImage?: Schema$Image;
/**
* 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`.
*/
hexBackgroundColor?: string | null;
/**
* 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).
*/
homepageUri?: Schema$Uri;
/**
* 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 '-'.
*/
id?: string | null;
/**
* Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
*/
imageModulesData?: Schema$ImageModuleData[];
/**
* Deprecated. Use textModulesData instead.
*/
infoModuleData?: Schema$InfoModuleData;
/**
* Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
*/
issuerName?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`.
*/
kind?: string | null;
/**
* Links module data. If links module data is also defined on the object, both will be displayed.
*/
linksModuleData?: Schema$LinksModuleData;
/**
* Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
*/
localizedIssuerName?: Schema$LocalizedString;
/**
* Note: This field is currently not supported to trigger geo notifications.
*/
locations?: Schema$LatLongPoint[];
/**
* The logo image of the ticket. This image is displayed in the card detail view of the app.
*/
logo?: Schema$Image;
/**
* 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.
*/
merchantLocations?: Schema$MerchantLocation[];
/**
* 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.
*/
messages?: Schema$Message[];
/**
* Identifies whether multiple users and devices will save the same object referencing this class.
*/
multipleDevicesAndHoldersAllowedStatus?: string | null;
/**
* 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.
*/
notifyPreference?: string | null;
/**
* 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.
*/
redemptionIssuers?: string[] | null;
/**
* The review comments set by the platform when a class is marked `approved` or `rejected`.
*/
review?: Schema$Review;
/**
* 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`.
*/
reviewStatus?: string | null;
/**
* The label to use for the row value (`eventTicketObject.seatInfo.row`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `rowLabel` and `customRowLabel` may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
*/
rowLabel?: string | null;
/**
* The label to use for the seat value (`eventTicketObject.seatInfo.seat`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `seatLabel` and `customSeatLabel` may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
*/
seatLabel?: string | null;
/**
* The label to use for the section value (`eventTicketObject.seatInfo.section`) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both `sectionLabel` and `customSectionLabel` may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
*/
sectionLabel?: string | null;
/**
* Optional information about the security animation. If this is set a security animation will be rendered on pass details.
*/
securityAnimation?: Schema$SecurityAnimation;
/**
* 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.
*/
textModulesData?: Schema$TextModuleData[];
/**
* Optional value ad