Gcp/walletobjects

@swamp/gcp/walletobjectsv2026.10.23.1· AGPL-3.0-or-later(was none)· 3d agoBEHAVIORS

01README

Google Cloud walletobjects infrastructure models

02Release Notes

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

03Behaviors16

eventticketclass.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
callbackOptions?	object	no	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.
classTemplateInfo?	object	no	If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
confirmationCodeLabel?	enum	no	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.
countryCode?	string	no	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.
customConfirmationCodeLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customGateLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customRowLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customSeatLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customSectionLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
dateTime?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
enableSmartTap?	boolean	no	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.
eventId?	string	no	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).
eventName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
finePrint?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
gateLabel?	enum	no	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.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
issuerName?	string	no	Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
localizedIssuerName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
logo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
multipleDevicesAndHoldersAllowedStatus?	enum	no	Identifies whether multiple users and devices will save the same object referencing this class.
notifyPreference?	enum	no	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.
redemptionIssuers?	array	no	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?	object	no	The review comments set by the platform when a class is marked `approved` or `rejected`.
reviewStatus?	enum	no	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`.
rowLabel?	enum	no	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.
seatLabel?	enum	no	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.
sectionLabel?	enum	no	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.
securityAnimation?	object	no	Type of animation.
textModulesData?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
venue?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
viewUnlockRequirement?	enum	no	View Unlock Requirement options for the event ticket.
wideLogo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
wordMark?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create()

Create a eventticketclass

fn get(identifier: string)

Get a eventticketclass

Argument	Type	Required	Description
identifier	string	yes	The id of the eventticketclass

fn update(identifier?: string)

Update eventticketclass attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific eventticketclass by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync eventticketclass state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific eventticketclass by id (e.g. one discovered by list)

fn list(issuerId?: string, maxResults?: number, token?: string, maxPages?: number)

List eventticketclass resources

Argument	Type	Required	Description
issuerId?	string	no	The ID of the issuer authorized to list classes.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the event ticket class with the given class ID.

eventticketobject.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
barcode?	object	no	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.
classId?	string	no	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?	object	no	Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
disableExpirationNotification?	boolean	no	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.
faceValue?	object	no	The currency code, such as "USD" or "EUR."
groupingInfo?	object	no	Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
hasLinkedDevice?	boolean	no	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	no	Indicates if the object has users. This field is set by the platform.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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`.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
linkedObjectIds?	array	no	linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this event ticket object. If a user had saved this event ticket, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
linkedOfferIds?	array	no	A list of offer objects linked to this event ticket. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
notifyPreference?	enum	no	Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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.
passConstraints?	object	no	The NFC constraints for the pass.
reservationInfo?	object	no	The confirmation code of the event reservation. This may also take the form of an "order number", "confirmation number", "reservation number", or other equivalent.
rotatingBarcode?	object	no	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.
saveRestrictions?	object	no	Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won\'t be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
seatInfo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
smartTapRedemptionValue?	string	no	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.
state?	enum	no	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?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
ticketHolderName?	string	no	Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
ticketNumber?	string	no	The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
ticketType?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
validTimeInterval?	object	no	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.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create(waitForReady?: boolean)

Create a eventticketobject

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a eventticketobject

Argument	Type	Required	Description
identifier	string	yes	The id of the eventticketobject

fn update(identifier?: string, waitForReady?: boolean)

Update eventticketobject attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific eventticketobject by id (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync(identifier?: string)

Sync eventticketobject state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific eventticketobject by id (e.g. one discovered by list)

fn list(classId?: string, maxResults?: number, token?: string, maxPages?: number)

List eventticketobject resources

Argument	Type	Required	Description
classId?	string	no	The ID of the class whose objects will be listed.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

fn modifylinkedofferobjects(linkedOfferObjectIds?: any)

modifylinkedofferobjects

Argument	Type	Required	Description
linkedOfferObjectIds?	any	no

Resources

state(infinite)— Returns the event ticket object with the given object ID.

flightclass.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
boardingAndSeatingPolicy?	object	no	Indicates the policy the airline uses for boarding. If unset, Google will default to `zoneBased`.
callbackOptions?	object	no	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.
classTemplateInfo?	object	no	If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
countryCode?	string	no	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?	object	no	Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
enableSmartTap?	boolean	no	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?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
flightStatus?	enum	no	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?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
issuerName?	string	no	Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
languageOverride?	string	no	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?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
localBoardingDateTime?	string	no	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.
localEstimatedOrActualArrivalDateTime?	string	no	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.
localEstimatedOrActualDepartureDateTime?	string	no	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.
localGateClosingDateTime?	string	no	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.
localScheduledArrivalDateTime?	string	no	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.
localScheduledDepartureDateTime?	string	no	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.
localizedIssuerName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
multipleDevicesAndHoldersAllowedStatus?	enum	no	Identifies whether multiple users and devices will save the same object referencing this class.
notifyPreference?	enum	no	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.
origin?	object	no	Three character IATA airport code. This is a required field for `origin` and `destination`. Eg: "SFO"
redemptionIssuers?	array	no	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?	object	no	The review comments set by the platform when a class is marked `approved` or `rejected`.
reviewStatus?	enum	no	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?	object	no	Type of animation.
textModulesData?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
viewUnlockRequirement?	enum	no	View Unlock Requirement options for the boarding pass.
wordMark?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create()

Create a flightclass

fn get(identifier: string)

Get a flightclass

Argument	Type	Required	Description
identifier	string	yes	The id of the flightclass

fn update(identifier?: string)

Update flightclass attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific flightclass by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync flightclass state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific flightclass by id (e.g. one discovered by list)

fn list(issuerId?: string, maxResults?: number, token?: string, maxPages?: number)

List flightclass resources

Argument	Type	Required	Description
issuerId?	string	no	The ID of the issuer authorized to list classes.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the flight class with the given class ID.

flightobject.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
barcode?	object	no	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.
boardingAndSeatingInfo?	object	no	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.
classId?	string	no	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?	object	no	Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
disableExpirationNotification?	boolean	no	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 Flights.
groupingInfo?	object	no	Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
hasLinkedDevice?	boolean	no	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	no	Indicates if the object has users. This field is set by the platform.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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`.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
linkedObjectIds?	array	no	linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this flight object. If a user had saved this boarding pass, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
notifyPreference?	enum	no	Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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.
passConstraints?	object	no	The NFC constraints for the pass.
passengerName?	string	no	Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
reservationInfo?	object	no	Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
rotatingBarcode?	object	no	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.
saveRestrictions?	object	no	Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won\'t be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
securityProgramLogo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
smartTapRedemptionValue?	string	no	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.
state?	enum	no	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?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
validTimeInterval?	object	no	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.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create(waitForReady?: boolean)

Create a flightobject

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a flightobject

Argument	Type	Required	Description
identifier	string	yes	The id of the flightobject

fn update(identifier?: string, waitForReady?: boolean)

Update flightobject attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific flightobject by id (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync(identifier?: string)

Sync flightobject state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific flightobject by id (e.g. one discovered by list)

fn list(classId?: string, maxResults?: number, token?: string, maxPages?: number)

List flightobject resources

Argument	Type	Required	Description
classId?	string	no	The ID of the class whose objects will be listed.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the flight object with the given object ID.

genericclass.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
callbackOptions?	object	no	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.
classTemplateInfo?	object	no	If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
enableSmartTap?	boolean	no	Available only to Smart Tap enabled partners. Contact support for additional guidance.
id?	string	no	Required. The unique identifier for the class. This ID must be unique across all from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
imageModulesData?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
multipleDevicesAndHoldersAllowedStatus?	enum	no	Identifies whether multiple users and devices will save the same object referencing this class.
redemptionIssuers?	array	no	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.
securityAnimation?	object	no	Type of animation.
textModulesData?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
viewUnlockRequirement?	enum	no	View Unlock Requirement options for the generic pass.

fn create()

Create a genericclass

fn get(identifier: string)

Get a genericclass

Argument	Type	Required	Description
identifier	string	yes	The id of the genericclass

fn update(identifier?: string)

Update genericclass attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific genericclass by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync genericclass state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific genericclass by id (e.g. one discovered by list)

fn list(issuerId?: string, maxResults?: number, token?: string, maxPages?: number)

List genericclass resources

Argument	Type	Required	Description
issuerId?	string	no	The ID of the issuer authorized to list classes.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Generic Class

genericobject.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
barcode?	object	no	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.
cardTitle?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
classId?	string	no	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 `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you.
genericType?	enum	no	Specify which `GenericType` the card belongs to.
groupingInfo?	object	no	Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
hasUsers?	boolean	no	Indicates if the object has users. This field is set by the platform.
header?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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 and if logo is not set, a color would be chosen by Google.
id?	string	no	Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
imageModulesData?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
linkedObjectIds?	array	no	linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this generic object. If a user had saved this generic card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
logo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
notifications?	object	no	Indicates if the object needs to have expiry notification enabled.
passConstraints?	object	no	The NFC constraints for the pass.
rotatingBarcode?	object	no	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.
saveRestrictions?	object	no	Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won\'t be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
smartTapRedemptionValue?	string	no	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.
state?	enum	no	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. If this is not provided, the object would be considered `ACTIVE`.
subheader?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
textModulesData?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
validTimeInterval?	object	no	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.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
wideLogo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create(waitForReady?: boolean)

Create a genericobject

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a genericobject

Argument	Type	Required	Description
identifier	string	yes	The id of the genericobject

fn update(identifier?: string, waitForReady?: boolean)

Update genericobject attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific genericobject by id (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync(identifier?: string)

Sync genericobject state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific genericobject by id (e.g. one discovered by list)

fn list(classId?: string, maxResults?: number, token?: string, maxPages?: number)

List genericobject resources

Argument	Type	Required	Description
classId?	string	no	The ID of the class whose objects will be listed.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Generic Object

giftcardclass.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
allowBarcodeRedemption?	boolean	no	Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
callbackOptions?	object	no	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.
cardNumberLabel?	string	no	The label to display for the card number, such as "Card Number".
classTemplateInfo?	object	no	If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
countryCode?	string	no	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.
enableSmartTap?	boolean	no	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.
eventNumberLabel?	string	no	The label to display for event number, such as "Target Event #".
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
issuerName?	string	no	Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
localizedCardNumberLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedEventNumberLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedIssuerName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedMerchantName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedPinLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
merchantName?	string	no	Merchant name, such as "Adam\'s Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
messages?	array	no	The message body.
multipleDevicesAndHoldersAllowedStatus?	enum	no	Identifies whether multiple users and devices will save the same object referencing this class.
notifyPreference?	enum	no	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.
pinLabel?	string	no	The label to display for the PIN, such as "4-digit PIN".
programLogo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
redemptionIssuers?	array	no	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?	object	no	The review comments set by the platform when a class is marked `approved` or `rejected`.
reviewStatus?	enum	no	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?	object	no	Type of animation.
textModulesData?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
viewUnlockRequirement?	enum	no	View Unlock Requirement options for the gift card.
wideProgramLogo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
wordMark?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create()

Create a giftcardclass

fn get(identifier: string)

Get a giftcardclass

Argument	Type	Required	Description
identifier	string	yes	The id of the giftcardclass

fn update(identifier?: string)

Update giftcardclass attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific giftcardclass by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync giftcardclass state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific giftcardclass by id (e.g. one discovered by list)

fn list(issuerId?: string, maxResults?: number, token?: string, maxPages?: number)

List giftcardclass resources

Argument	Type	Required	Description
issuerId?	string	no	The ID of the issuer authorized to list classes.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the gift card class with the given class ID.

giftcardobject.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
balance?	object	no	The currency code, such as "USD" or "EUR."
balanceUpdateTime?	object	no	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.
barcode?	object	no	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.
cardNumber?	string	no	Required. The card's number.
classId?	string	no	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?	object	no	Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
disableExpirationNotification?	boolean	no	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	no	The card's event number, an optional field used by some gift cards.
groupingInfo?	object	no	Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
hasLinkedDevice?	boolean	no	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	no	Indicates if the object has users. This field is set by the platform.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
linkedObjectIds?	array	no	linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
notifyPreference?	enum	no	Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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.
passConstraints?	object	no	The NFC constraints for the pass.
pin?	string	no	The card's PIN.
rotatingBarcode?	object	no	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.
saveRestrictions?	object	no	Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won\'t be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
smartTapRedemptionValue?	string	no	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.
state?	enum	no	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?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
validTimeInterval?	object	no	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.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create(waitForReady?: boolean)

Create a giftcardobject

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a giftcardobject

Argument	Type	Required	Description
identifier	string	yes	The id of the giftcardobject

fn update(identifier?: string, waitForReady?: boolean)

Update giftcardobject attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific giftcardobject by id (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync(identifier?: string)

Sync giftcardobject state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific giftcardobject by id (e.g. one discovered by list)

fn list(classId?: string, maxResults?: number, token?: string, maxPages?: number)

List giftcardobject resources

Argument	Type	Required	Description
classId?	string	no	The ID of the class whose objects will be listed.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the gift card object with the given object ID.

issuer.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
callbackOptions?	object	no	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.
contactInfo?	object	no	Email addresses which will receive alerts.
homepageUrl?	string	no	URL for the issuer's home page.
issuerId?	string	no	The unique identifier for an issuer account. This is automatically generated when the issuer is inserted.
name?	string	no	The account name of the issuer.
smartTapMerchantData?	object	no	Available only to Smart Tap enabled partners. Contact support for additional guidance.

fn create()

Create a issuer

fn get(identifier: string)

Get a issuer

Argument	Type	Required	Description
identifier	string	yes	The id of the issuer

fn update(identifier?: string)

Update issuer attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific issuer by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync issuer state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific issuer by id (e.g. one discovered by list)

fn list(maxPages?: number)

List issuer resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Returns the issuer with the given issuer ID.

loyaltyclass.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
accountIdLabel?	string	no	The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
accountNameLabel?	string	no	The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
callbackOptions?	object	no	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.
classTemplateInfo?	object	no	If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
countryCode?	string	no	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.
discoverableProgram?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
enableSmartTap?	boolean	no	Identifies whether this class supports Smart Tap. The `redemptionIssuers` and one of object level `smartTapRedemptionLevel`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
issuerName?	string	no	Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
localizedAccountIdLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedAccountNameLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedIssuerName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedProgramName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedRewardsTier?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedRewardsTierLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedSecondaryRewardsTier?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedSecondaryRewardsTierLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
multipleDevicesAndHoldersAllowedStatus?	enum	no	Identifies whether multiple users and devices will save the same object referencing this class.
notifyPreference?	enum	no	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.
programLogo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
programName?	string	no	Required. The program name, such as "Adam\'s Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
redemptionIssuers?	array	no	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 one of object level `smartTapRedemptionValue`, barcode.value`, or `accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
review?	object	no	The review comments set by the platform when a class is marked `approved` or `rejected`.
reviewStatus?	enum	no	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`.
rewardsTier?	string	no	The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
rewardsTierLabel?	string	no	The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
secondaryRewardsTier?	string	no	The secondary rewards tier, such as "Gold" or "Platinum."
secondaryRewardsTierLabel?	string	no	The secondary rewards tier label, such as "Rewards Tier."
securityAnimation?	object	no	Type of animation.
textModulesData?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
viewUnlockRequirement?	enum	no	View Unlock Requirement options for the loyalty card.
wideProgramLogo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
wordMark?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create()

Create a loyaltyclass

fn get(identifier: string)

Get a loyaltyclass

Argument	Type	Required	Description
identifier	string	yes	The id of the loyaltyclass

fn update(identifier?: string)

Update loyaltyclass attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific loyaltyclass by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync loyaltyclass state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific loyaltyclass by id (e.g. one discovered by list)

fn list(issuerId?: string, maxResults?: number, token?: string, maxPages?: number)

List loyaltyclass resources

Argument	Type	Required	Description
issuerId?	string	no	The ID of the issuer authorized to list classes.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the loyalty class with the given class ID.

loyaltyobject.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
accountId?	string	no	The loyalty account identifier. Recommended maximum length is 20 characters.
accountName?	string	no	The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
barcode?	object	no	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.
classId?	string	no	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?	object	no	The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
disableExpirationNotification?	boolean	no	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.
groupingInfo?	object	no	Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
hasLinkedDevice?	boolean	no	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	no	Indicates if the object has users. This field is set by the platform.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
linkedObjectIds?	array	no	linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this loyalty object. If a user had saved this loyalty card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
linkedOfferIds?	array	no	A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
loyaltyPoints?	object	no	The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
notifyPreference?	enum	no	Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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.
passConstraints?	object	no	The NFC constraints for the pass.
rotatingBarcode?	object	no	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.
saveRestrictions?	object	no	Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won\'t be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
secondaryLoyaltyPoints?	object	no	The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
smartTapRedemptionValue?	string	no	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. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
state?	enum	no	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?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
validTimeInterval?	object	no	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.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create(waitForReady?: boolean)

Create a loyaltyobject

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a loyaltyobject

Argument	Type	Required	Description
identifier	string	yes	The id of the loyaltyobject

fn update(identifier?: string, waitForReady?: boolean)

Update loyaltyobject attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific loyaltyobject by id (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync(identifier?: string)

Sync loyaltyobject state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific loyaltyobject by id (e.g. one discovered by list)

fn list(classId?: string, maxResults?: number, token?: string, maxPages?: number)

List loyaltyobject resources

Argument	Type	Required	Description
classId?	string	no	The ID of the class whose objects will be listed.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

fn modifylinkedofferobjects(linkedOfferObjectIds?: any)

modifylinkedofferobjects

Argument	Type	Required	Description
linkedOfferObjectIds?	any	no

Resources

state(infinite)— Returns the loyalty object with the given object ID.

offerclass.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
callbackOptions?	object	no	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.
classTemplateInfo?	object	no	If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
countryCode?	string	no	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	no	The details of the offer.
enableSmartTap?	boolean	no	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	no	The fine print or terms of the offer, such as "20% off any t-shirt at Adam\'s Apparel."
helpUri?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
issuerName?	string	no	Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
localizedDetails?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedFinePrint?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedIssuerName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedProvider?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedShortTitle?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
localizedTitle?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
multipleDevicesAndHoldersAllowedStatus?	enum	no	Identifies whether multiple users and devices will save the same object referencing this class.
notifyPreference?	enum	no	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.
provider?	string	no	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.
redemptionChannel?	enum	no	Required. The redemption channels applicable to this offer.
redemptionIssuers?	array	no	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?	object	no	The review comments set by the platform when a class is marked `approved` or `rejected`.
reviewStatus?	enum	no	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?	object	no	Type of animation.
shortTitle?	string	no	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?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
title?	string	no	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?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
viewUnlockRequirement?	enum	no	View Unlock Requirement options for the offer.
wideTitleImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
wordMark?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create()

Create a offerclass

fn get(identifier: string)

Get a offerclass

Argument	Type	Required	Description
identifier	string	yes	The id of the offerclass

fn update(identifier?: string)

Update offerclass attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific offerclass by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync offerclass state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific offerclass by id (e.g. one discovered by list)

fn list(issuerId?: string, maxResults?: number, token?: string, maxPages?: number)

List offerclass resources

Argument	Type	Required	Description
issuerId?	string	no	The ID of the issuer authorized to list classes.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the offer class with the given class ID.

offerobject.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
barcode?	object	no	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.
classId?	string	no	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?	object	no	Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
disableExpirationNotification?	boolean	no	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.
groupingInfo?	object	no	Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
hasLinkedDevice?	boolean	no	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	no	Indicates if the object has users. This field is set by the platform.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
linkedObjectIds?	array	no	linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this offer object. If a user had saved this offer, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID.identifier where the former is issued by Google and the latter is chosen by you.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
locations?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#latLongPoint"`.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
notifyPreference?	enum	no	Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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.
passConstraints?	object	no	The NFC constraints for the pass.
rotatingBarcode?	object	no	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.
saveRestrictions?	object	no	Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won\'t be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
smartTapRedemptionValue?	string	no	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.
state?	enum	no	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?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
validTimeInterval?	object	no	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.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create(waitForReady?: boolean)

Create a offerobject

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a offerobject

Argument	Type	Required	Description
identifier	string	yes	The id of the offerobject

fn update(identifier?: string, waitForReady?: boolean)

Update offerobject attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific offerobject by id (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync(identifier?: string)

Sync offerobject state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific offerobject by id (e.g. one discovered by list)

fn list(classId?: string, maxResults?: number, token?: string, maxPages?: number)

List offerobject resources

Argument	Type	Required	Description
classId?	string	no	The ID of the class whose objects will be listed.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the offer object with the given object ID.

permissions.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
issuerId?	string	no	ID of the issuer the list of permissions refer to.
permissions?	array	no	The email address of the user, group, or service account to which this permission refers to.

fn get(identifier: string)

Get a permissions

Argument	Type	Required	Description
identifier	string	yes	The id of the permissions

fn update(identifier?: string)

Update permissions attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific permissions by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync permissions state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific permissions by id (e.g. one discovered by list)

Resources

state(infinite)— Returns the permissions for the given issuer id.

transitclass.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
activationOptions?	object	no	HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
callbackOptions?	object	no	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.
classTemplateInfo?	object	no	If more than one reference is supplied, then the first one that references a non-empty field will be displayed.
countryCode?	string	no	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.
customCarriageLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customCoachLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customConcessionCategoryLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customConfirmationCodeLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customDiscountMessageLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customFareClassLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customFareNameLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customOtherRestrictionsLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customPlatformLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customPurchaseFaceValueLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customPurchasePriceLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customPurchaseReceiptNumberLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customRouteRestrictionsDetailsLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customRouteRestrictionsLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customSeatLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customTicketNumberLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customTimeRestrictionsLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customTransitTerminusNameLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customZoneLabel?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
enableSingleLegItinerary?	boolean	no	Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.
enableSmartTap?	boolean	no	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.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
issuerName?	string	no	Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
languageOverride?	string	no	If this field is present, transit tickets 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?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
localizedIssuerName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
logo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
multipleDevicesAndHoldersAllowedStatus?	enum	no	Identifies whether multiple users and devices will save the same object referencing this class.
notifyPreference?	enum	no	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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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.
redemptionIssuers?	array	no	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?	object	no	The review comments set by the platform when a class is marked `approved` or `rejected`.
reviewStatus?	enum	no	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?	object	no	Type of animation.
textModulesData?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
transitOperatorName?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
transitType?	enum	no	Required. The type of transit this class represents, such as "bus".
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
viewUnlockRequirement?	enum	no	View Unlock Requirement options for the transit ticket.
watermark?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
wideLogo?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
wordMark?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create()

Create a transitclass

fn get(identifier: string)

Get a transitclass

Argument	Type	Required	Description
identifier	string	yes	The id of the transitclass

fn update(identifier?: string)

Update transitclass attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific transitclass by id (e.g. one discovered by list)

fn sync(identifier?: string)

Sync transitclass state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific transitclass by id (e.g. one discovered by list)

fn list(issuerId?: string, maxResults?: number, token?: string, maxPages?: number)

List transitclass resources

Argument	Type	Required	Description
issuerId?	string	no	The ID of the issuer authorized to list classes.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` classes are available in a list. For example, if you have a list of 200 classes and you call list with `maxResults` set to 20, list will return the first 20 classes and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 classes.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the transit class with the given class ID.

transitobject.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
activationStatus?	object	no	The activation status for the object. Required if the class has `activationOptions` set.
appLinkData?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
barcode?	object	no	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.
classId?	string	no	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?	object	no	HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
concessionCategory?	enum	no	The concession category for the ticket.
customConcessionCategory?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
customTicketStatus?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
deviceContext?	object	no	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.
disableExpirationNotification?	boolean	no	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.
groupingInfo?	object	no	Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
hasLinkedDevice?	boolean	no	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	no	Indicates if the object has users. This field is set by the platform.
heroImage?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
hexBackgroundColor?	string	no	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`.
id?	string	no	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?	array	no	The ID associated with an image module. This field is here to enable ease of management of image modules.
infoModuleData?	object	no	The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.
linkedObjectIds?	array	no	linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this transit object. If a user had saved this transit card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
linksModuleData?	object	no	The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when `description` is part of an image.
merchantLocations?	array	no	The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
messages?	array	no	The message body.
notifyPreference?	enum	no	Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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.
passConstraints?	object	no	The NFC constraints for the pass.
passengerNames?	string	no	The name(s) of the passengers the ticket is assigned to. The above `passengerType` field is meant to give Google context on this field.
passengerType?	enum	no	The number of passengers.
purchaseDetails?	object	no	ID of the account used to purchase the ticket.
rotatingBarcode?	object	no	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.
saveRestrictions?	object	no	Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won\'t be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.
smartTapRedemptionValue?	string	no	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.
state?	enum	no	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?	array	no	The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
ticketLeg?	object	no	The date/time of arrival. 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 destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the destination station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
ticketLegs?	array	no	The date/time of arrival. 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 destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be `2018-06-05T20:00:00`. If the local date/time at the destination station is 4 hours before UTC, an offset of `-04:00` may be appended. Without offset information, some rich features may not be available.
ticketNumber?	string	no	The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.
ticketRestrictions?	object	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.
ticketStatus?	enum	no	The status of the ticket. For states which affect display, use the `state` field instead.
tripId?	string	no	This id is used to group tickets together if the user has saved multiple tickets for the same trip.
tripType?	enum	no	Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
validTimeInterval?	object	no	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.
valueAddedModuleData?	array	no	Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`.

fn create(waitForReady?: boolean)

Create a transitobject

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a transitobject

Argument	Type	Required	Description
identifier	string	yes	The id of the transitobject

fn update(identifier?: string, waitForReady?: boolean)

Update transitobject attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific transitobject by id (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync(identifier?: string)

Sync transitobject state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific transitobject by id (e.g. one discovered by list)

fn list(classId?: string, maxResults?: number, token?: string, maxPages?: number)

List transitobject resources

Argument	Type	Required	Description
classId?	string	no	The ID of the class whose objects will be listed.
maxResults?	number	no	Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined.
token?	string	no	Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn addmessage(message?: any)

addmessage

Argument	Type	Required	Description
message?	any	no

Resources

state(infinite)— Returns the transit object with the given object ID.

04Previous Versions19

2026.10.13.1Oct 13, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.10.06.1Oct 6, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.09.29.1Sep 29, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

Modified 1 behaviors

2026.08.12.2Aug 12, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.07.29.1Jul 30, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.07.21.3Jul 21, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.07.21.1Jul 21, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, transitclass, transitobject

2026.07.20.1Jul 20, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.07.19.1Jul 19, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.07.18.1Jul 18, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.07.17.1Jul 17, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, transitclass, transitobject

2026.06.08.2Jun 8, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.06.07.1Jun 7, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.05.25.3May 25, 2026

Updated: issuer

Modified 1 behaviors

2026.05.24.1May 24, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.05.21.2May 21, 2026

Updated: eventticketclass, eventticketobject, flightclass, flightobject, genericclass, genericobject, giftcardclass, giftcardobject, issuer, loyaltyclass, loyaltyobject, offerclass, offerobject, permissions, transitclass, transitobject

2026.05.21.1May 21, 2026

2026.05.19.2May 19, 2026

2026.05.19.1May 19, 2026

05Stats

100 / 100

Downloads

Archive size

968.3 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#gcp #google-cloud #walletobjects #cloud #infrastructure