Package analytics is a reverse proxy.

Package event_tickets is a reverse proxy.

Package flights is a reverse proxy.

Package members is a reverse proxy.

Package raw is a reverse proxy.

Package scheduler is a reverse proxy.

Package single_use_coupons is a reverse proxy.

RegisterCertificatesHandler registers the http handlers for service Certificates to "mux".

RegisterCertificatesHandlerClient registers the http handlers for service Certificates to "mux".

RegisterCertificatesHandlerFromEndpoint is same as RegisterCertificatesHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

RegisterCertificatesHandlerServer registers the http handlers for service Certificates to "mux".

RegisterDistributionHandler registers the http handlers for service Distribution to "mux".

RegisterDistributionHandlerClient registers the http handlers for service Distribution to "mux".

RegisterDistributionHandlerFromEndpoint is same as RegisterDistributionHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

RegisterDistributionHandlerServer registers the http handlers for service Distribution to "mux".

RegisterImagesHandler registers the http handlers for service Images to "mux".

RegisterImagesHandlerClient registers the http handlers for service Images to "mux".

RegisterImagesHandlerFromEndpoint is same as RegisterImagesHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

RegisterImagesHandlerServer registers the http handlers for service Images to "mux".

RegisterIntegrationsHandler registers the http handlers for service Integrations to "mux".

RegisterIntegrationsHandlerClient registers the http handlers for service Integrations to "mux".

RegisterIntegrationsHandlerFromEndpoint is same as RegisterIntegrationsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

RegisterIntegrationsHandlerServer registers the http handlers for service Integrations to "mux".

RegisterMessagesHandler registers the http handlers for service Messages to "mux".

RegisterMessagesHandlerClient registers the http handlers for service Messages to "mux".

RegisterMessagesHandlerFromEndpoint is same as RegisterMessagesHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

RegisterMessagesHandlerServer registers the http handlers for service Messages to "mux".

RegisterTemplatesHandler registers the http handlers for service Templates to "mux".

RegisterTemplatesHandlerClient registers the http handlers for service Templates to "mux".

RegisterTemplatesHandlerFromEndpoint is same as RegisterTemplatesHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

RegisterTemplatesHandlerServer registers the http handlers for service Templates to "mux".

RegisterUsersHandler registers the http handlers for service Users to "mux".

RegisterUsersHandlerClient registers the http handlers for service Users to "mux".

RegisterUsersHandlerFromEndpoint is same as RegisterUsersHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

RegisterUsersHandlerServer registers the http handlers for service Users to "mux".

Invokes DELETE request to delete existing record on the third party app.

Invokes POST request to create a record the third party app.

Invokes PUT request to update existing record on the third party app.

Use if you do not wish to support Apple Wallet.

Aztec codes are commonly used by the transportation industry such as tickets and airline boarding passes.

Supports any character of the ASCII 128 character set which can store highly diversified information.

This does not set a barcode.

2D barcode which can store multiple data encodings.

QR code can store 4 types of data: numeric, alphanumeric, byte/binary, and Kanji (Chinese characters).

Triggered when coupon is issued.

Triggered when coupon record is deleted.

Triggered when coupon is redeemed.

Triggered when any of coupon field is updated.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

Date containing year, month and date.

A value of money amount in float (e.g.

Date containing month and date.

Date containing year and month.

Date containing year, month and date.

IMAGE = 15; // we can comment out IMAGE when backend implement the string logic for uploaded image file.

A number (No decimal support).

A number with decimal support.

A list of key value pairs.

default.

The only difference with TEXT is that TEXT_LONG renders textarea tag on the data collection landing page.

Zero based enum, don't use 0.

Set so any card scanned gets automatically redeemed.

Set so any card scanned gets automatically validated.

Set so any card scanned gets a certain amount of points subtracted automatically.

Set so any card scanned gets automatically checked in or out.

Set so any card scanned gets a certain amount of points added automatically.

Zero based enum, don't use 0.

Set so any card scanned gets automatically validated.

Unique pass link is distributed via email (will use default PK email template if no custom Email Template is provided).

Unique pass link is distributed via SMS (will use default PK SMS template if no custom SMS Template is provided).

Hide default external Id field on top right of the template.

Hide default full name field on top left of the template.

The digital card expires after the number of days after the digital card issuing.

Please do not use this enum.

Expiry date is set with year, month and date.

If you want to change expiry date for each digital card, you can use this expiry type.

The digital card will set as NULL and the pass will not expire..

When a registration form is completed.

When a sign up is completed.

This is the default pixel tracking page visits.

When a purchase is made or checkout flow is completed.

When a person books an appointment to visit one of your locations.

When a person starts a free trial of a product or service you offer.

When a person applies for a product, service, or program you offer.

When a person applies to a start a paid subscription for a product or service you offer.

A visit to a web page you care about (for example, a product page or landing page).

Custom fields are fields which are created only for pass render purpose and does not belong to other field type.

Meta fields.

PII fields.

Protocol specific fields.

Universal fields used across protocols (e.g.

Female.

Male.

Use only where gender is not known.

This is the default GA event tracking page visits.

When a user redeems the coupon.

This is the default GA even tracking page visits.

When a user submits the data collection form.

When a user clicks the Add to Apple Wallet button.

When a user switches the language.

This is the default GA event tracking page visits.

When a user clicks the Save to Google Pay button.

When a user clicks the view pass in Apple Wallet button.

Boarding 1-99.

This field must be of type DateTime.

This field must be of type DateTime.

This field must be of type DateTime.

This field must be of type DateTime.

This field must be of type DateTime.

This field must be of type Currency.

Event 100-199.

This field must be of type DateTime.

This field must be of type Currency.

This field must be of type DateTime.

Gift 200-299.

Loyalty 300-399.

Offer 400-499.

Common Fields >= 1000.

This field must be of type Currency.

Transit 500-599.

This field must be of type DateTime.

This field must be of type Currency.

This field must be of type DateTime.

This field must be of type DateTime.

Use if you do not wish to support Google Pay.

Google Pay - used to denote airline alliance on boarding pass types (<=1600px x 80px).

used for user App images in Google Pay (Google approval required, 300px x 300px).

Apple logo can be used where a rectangular design is preferred for Apple Passes only.

used only be Apple Event Ticket designs, this image is blurred to form a background and so can be a low quality image.

used on a landing page or email.

Apple Wallet strip image for EventTicket pass types (1125px x 294px).

displays above the barcode for Apple Wallet Boarding pass tickets (858px x 45px).

Hero is the Google Pay strip and is also used in the dialog box when installing (1032px x 336px).

Mandatory icon, used in Apple Wallet lock screen (87px x 87px).

Logo is circle-cropped by Google Pay, a 15% safety margin is recommended (660px x 660px).

used for Google Pay in wallet promotional messages - for Apple Pay, the message will be rendered on a mobile website (1860px x <=930px).

For Apple Pay NFC passes whitelisted for personalization.

Google Pay - used to denote a boarding privilege.

used for user Profile images (300px x 300px).

Google Pay - used to denote a security program on boarding pass types (E.g.

used for custom stamped images.

used for stamp / punch card type images.

Apple Wallet strip image for other pass types with a strip image (1125px x 432px).

Used on Membership passes and Apple event tickets with a background image (>=320 x >=320 in a ratio range of 2:3-3:2).

used for custom unstamped images.

Turn on the integration.

Turn off the integration.

The status assigned by PassKit when the account or record is not satisfying the requirements to conduct integration process.

A hook event occurs after pass holder's data is created on PassKit.

A hook event occurs after pass holder's record is updated on PassKit.

A hook event occurs after pass has been installed on mobile.

A hook event occurs after pass issue.

A hook event occurs after a pass is deleted.

A hook event occurs after the pass is updated.

A hook event occurs after pass has been uninstalled from mobile.

A hook event occurs after the information on the pass is updated.

Pass holder data is processed by a third party application first then its outcome and original data are stored in PassKit.

A hook event occurs before pass holder's record is updated on PassKit.

A hook event occurs after pass holder record creation and before pass issue.

A hook event occurs before a pass is deleted.

A hook event occurs before the pass is updated.

A hook event occurs before the information on the pass is updated.

Trigger event occurs on a third party platform which triggers action (chain of events) inside the PassKit.

(Arabic) العربية.

Català (Catalan).

Čeština (Czech).

Dansk (Danish).

Deutsch (German).

Ελληνικά (Greek).

English.

English (Australia).

English (Canada).

English (British).

English (United States).

English (India).

Español (Spanish).

Español (Latin America).

Suomi (Finnish).

Français (French).

Français (Canada).

(Hebrew) עברית.

हिन्दी (Hindi).

Hrvatski (Croatian).

Magyar (Hungarian).

Bahasa Indonesia (Indonesian).

Italiano (Italian).

日本語 (Japanese).

한국어 (Korean).

Bahasa Melayu (Malay).

Malti (Maltese).

Norsk Bokmål (Norwegian).

Nederlands (Dutch).

Polski (Polish).

Português de Portugal (Portuguese).

Português (Brazilian Portuguese).

Română (Romanian).

Русский (Russian).

Slovenčina (Slovakian).

Svenska (Swedish).

ภาษาไทย (Thai).

Türkçe (Turkish).

Українська (Ukrainian).

Tiếng Việt (Vietnamese).

简体中文 (Chinese).

繁體中文 (Traditional Chinese).

香港中文 (Cantonese).

An Apple pass bundle has been created.

A Google Pay record has been created.

Pass has been installed in at least one Android wallet app.

Pass has been installed in at least one Apple device.

Pass has been installed in at least one Google Pay account.

Pass has been invalidated.

Invalidation request sent to pass.

Pass has requested personalisation.

Pass has been provided with personalised information.

Pass has been created and presented to the user to install.

Pass has been uninstalled from at least one Android wallet app.

Pass has been uninstalled from at least one Apple device.

Pass has been uninstalled from at least one Google Pay account.

A calendar event.

A link to website.

An email address.

A location address.

A phone number.

A link to website.

The member payload will be sent to destination when member record is created.

The member payload will be sent to destination when any of member field is updated.

Zero based enum, don't use 0.

Marketing 100-149.

Membership 10-49.

CRM 50-99.

Accounting 150-199.

Will use the default operator PATCH.

PATCH will ignore missing or falsey values.

PUT will replace all values provided in the request.

Join grouped filter fields with AND operator.

Join grouped filter fields with OR operator.

The Base64 encoded bytes of the Apple Wallet pass bundle.

A URL that can be used in an Android app or email.

The URL to a landing page for multiple passes containing a common identifier.

The URL to the web landing page.

The pass payload will be sent to destination when pass is installed on a mobile device.

The pass payload will be sent to destination when pass is invalidated or expired.

The pass payload will not be sent.

The pass payload will be sent to destination when pass record is created and issued.

The pass payload will be sent to destination when pass record is deleted from the PassKit database.

The pass payload will be sent to destination when pass record or contents have been updated.

The pass payload will be sent to destination when pass is uninstalled from a mobile device.

Event Ticket protocol: https://docs.passkit.io/protocols/event/.

Flights protocol: https://docs.passkit.io/protocols/boarding/.

Values 100 onwards are for PassKit generic protocols.

Reserved for raw pass protocol.

Single Use Coupon protocol: https://docs.passkit.io/protocols/coupon/.

Reserved for migrating legacy v1 passes.

Show individual data by day.

Default response will be in months.

Show individual data by year.

Zero based enum, don't use 0.

Active projects allow for creation of records (turned on by default).

A project which needs to be deleted.

Disabled projects do not allow for creation of records (i.e.

Default status for all projects.

The project is currently over quota, and new records cannot be created (set by system only; cannot be set by user).

A project is private: records can only by created by authorized users / via the portal interface.

A project can only be published if a custom Apple Developer Certificate is uploaded, if payment details have been provided, and an account email address has been validated.

Values 0-100 onwards are for PassKit events.

Set to when the object was deleted.

Set to when the object was expired.

Set to when the object was updated.

Pass has been installed in a wallet.

Pass has been invalidated.

Pass has been issued.

Pass has been uninstalled (possibly deleted) from a wallet.

Coupon 0x800 - 0x100000.

Member 0x1 - 0x400.

Generic 0x200000 - 0x40000000.

Set for users who can change the expiry date of a coupon.

Set for users who can edit details about a coupon.

Zero based enum, don't use 0.

Set for users who can redeem a coupon.

Set for users who can verify a coupons status.

Set for users who can view all details about a coupon.

Set for users who can view previous events the coupon has committed.

Set for users who can subtract points from a member.

Set for users who can change the expiry date of a member.

Set for users who can change a members tier.

Set for users who can check members in and out.

Set for users who can give points to a member.

Set for users who can edit details about a member.

Zero based enum, don't use 0.

Set for users who can set a members points to a specific value.

Set for users who can verify a members status.

Set for users who can view previous events the member has committed.

Set for users who can view all details about a member.

Pass has been installed in a wallet.

Pass has been invalidated.

Pass has been issued.

Pass has been uninstalled (possibly deleted) from a wallet.

For legacy support, a setting of do not use will default to WalletPasses.

Android PassWallet https://passwallet.net.

WalletPasses https://walletpasses.io (Default).

Used for Apple only.

Google Pay only.

Rendered on Apple Wallet.

Rendered on data collection page.

Rendered on Google Pay.

Enum value maps for ActionMethod.

Enum value maps for ActionMethod.

Enum value maps for ApplePassType.

Enum value maps for ApplePassType.

Enum value maps for BarcodeType.

Enum value maps for BarcodeType.

Certificates_ServiceDesc is the grpc.ServiceDesc for Certificates service.

Enum value maps for ConfigurationType.

Enum value maps for ConfigurationType.

Enum value maps for CouponEventId.

Enum value maps for CouponEventId.

Enum value maps for DataStyle.

Enum value maps for DataStyle.

Enum value maps for DataType.

Enum value maps for DataType.

Enum value maps for DateTimeStyle.

Enum value maps for DateTimeStyle.

Enum value maps for DefaultCouponScanAction.

Enum value maps for DefaultCouponScanAction.

Enum value maps for DefaultMembershipScanAction.

Enum value maps for DefaultMembershipScanAction.

Enum value maps for DeviceAttributes.

Enum value maps for DeviceAttributes.

Distribution_ServiceDesc is the grpc.ServiceDesc for Distribution service.

Enum value maps for DistributionChannel.

Enum value maps for DistributionChannel.

Enum value maps for EmailTemplateOptions.

Enum value maps for EmailTemplateOptions.

Enum value maps for ExpiryType.

Enum value maps for ExpiryType.

Enum value maps for FbPixelStandardEvent.

Enum value maps for FbPixelStandardEvent.

Enum value maps for FieldSection.

Enum value maps for FieldSection.

Enum value maps for FieldType.

Enum value maps for FieldType.

Enum value maps for Gender.

Enum value maps for Gender.

Enum value maps for GoogleAnalyticsCustomerInitiatedRedemptionPageEvent.

Enum value maps for GoogleAnalyticsCustomerInitiatedRedemptionPageEvent.

Enum value maps for GoogleAnalyticsDataCollectionPageEvent.

Enum value maps for GoogleAnalyticsDataCollectionPageEvent.

Enum value maps for GoogleAnalyticsPassRenderPageEvent.

Enum value maps for GoogleAnalyticsPassRenderPageEvent.

Enum value maps for GooglePayField.

Enum value maps for GooglePayField.

Enum value maps for GooglePayPassType.

Enum value maps for GooglePayPassType.

Images_ServiceDesc is the grpc.ServiceDesc for Images service.

Enum value maps for ImageUse.

Enum value maps for ImageUse.

Integrations_ServiceDesc is the grpc.ServiceDesc for Integrations service.

Enum value maps for IntegrationStatus.

Enum value maps for IntegrationStatus.

Enum value maps for IntegrationType.

Enum value maps for IntegrationType.

Enum value maps for LanguageCode.

Enum value maps for LanguageCode.

Enum value maps for LifecycleEvents.

Enum value maps for LifecycleEvents.

Enum value maps for LinkDetector.

Enum value maps for LinkDetector.

Enum value maps for LinkType.

Enum value maps for LinkType.

Enum value maps for ListPosition.

Enum value maps for ListPosition.

Enum value maps for MembershipEventId.

Enum value maps for MembershipEventId.

Messages_ServiceDesc is the grpc.ServiceDesc for Messages service.

Enum value maps for MessageStatus.

Enum value maps for MessageStatus.

Enum value maps for NumberStyle.

Enum value maps for NumberStyle.

Enum value maps for OAuth2Provider.

Enum value maps for OAuth2Provider.

Enum value maps for Operation.

Enum value maps for Operation.

Enum value maps for Operator.

Enum value maps for Operator.

Enum value maps for PassBundleFormat.

Enum value maps for PassBundleFormat.

Enum value maps for PassEventId.

Enum value maps for PassEventId.

Enum value maps for PassProtocol.

Enum value maps for PassProtocol.

Enum value maps for PasswordType.

Enum value maps for PasswordType.

Enum value maps for Period.

Enum value maps for Period.

Enum value maps for PersonalizedDataField.

Enum value maps for PersonalizedDataField.

Enum value maps for ProjectStatus.

Enum value maps for ProjectStatus.

Enum value maps for ProtocolCommonEvents.

Enum value maps for ProtocolCommonEvents.

Enum value maps for ProtocolIntgType.

Enum value maps for ProtocolIntgType.

Enum value maps for ScannerCouponPermissions.

Enum value maps for ScannerCouponPermissions.

Enum value maps for ScannerMembershipPermissions.

Enum value maps for ScannerMembershipPermissions.

Enum value maps for StandardFields.

Enum value maps for StandardFields.

Enum value maps for Status.

Enum value maps for Status.

Enum value maps for SupportedAndroidWallet.

Enum value maps for SupportedAndroidWallet.

Templates_ServiceDesc is the grpc.ServiceDesc for Templates service.

Enum value maps for TextAlignment.

Enum value maps for TextAlignment.

Enum value maps for TimeState.

Enum value maps for TimeState.

Enum value maps for Toggle.

Enum value maps for Toggle.

Enum value maps for TransitType.

Enum value maps for TransitType.

Enum value maps for UsageType.

Enum value maps for UsageType.

Users_ServiceDesc is the grpc.ServiceDesc for Users service.

Customise how data field is rendered on the front and back of the pass.

Pass settings only for Apple Wallet.

Beacons allow you to display subtle messages to your users when they are in close proximity.

Colours take a hexcode input.

Array of subscribing coupon protocol events.

This allows you to configure data so that you can save it against each customer record or render it on the pass.

Customise how data field is rendered on the data collection landing page.

This allows you to customize the contents rendered on data collection landing page.

Data Field allows you to define set of data you store against each pass holder.

DataItems are used to supply additional metadata when creating or updating passes.

A fixed date without timezone information.

DistributionSettings can be used by protocol top level elements to define the email / sms-es.

EmailTemplate contains details for sending an email to a customer.

The digital card will be expired on the expiry date.

Sets up source and destination field.

FlightAnalyticsFilter filter analytics by flight or/and flight designator.

If no parameters are provided, all messages will be returned.

response used by getUser.

Settings to render an app on the head of a pass.

Customise how data field is rendered on the front and back of the pass.

Pass settings only for Google Pay.

Locations provide a broader range using GPS to trigger a lockscreen message.

An Id is used to access an unique object or record.

Images strings can be either a base64 image or a url.

See image 'Use' enum for descriptions and sizes.

Integration object contains configuration data to integrate PassKit application with third party application.

Used to specify links put on the back of the pass.

[DEPRECATED: OR operator is not supported] Filter and list records.

Local Date are specified in ISO 8601 format date without a time.

Local Date Times are specified in ISO 8601 extended format date/time without a timezone offset.

Localized strings are optionally used to provide translated values for each of supported language.

Array of subscribing membership protocol events.

Additional data relating to the pass.

Metrics list issued, installed, uninstalled and invalidated counts.

OAuth2AuthorizationRequest contains needed values to complete an OAuth2 request.

Details of pass and pass holder.

A Pass Bundle contains a landing page URL and/or a compiled pass in multiple formats.

PassOverrides contains optional pass-object level details.

Pass Template holds design and data elements for Apple Wallet and Google Pay passes.

PasswordSettings holds the settings for the password protection page.

Payload object used for validating TOTP and encrypted barcode strings.

A person represents a single, identifiable individual.

To be used for booleans where we want users to be able to set to off / false via the API.

Sets a position of field on the pass.

To be used for setting recursive datetime.

Relevant Date in ISO8601 datetime.

ScannerConfiguration is the base configuration object for the scanning app.

Sets value and display text for drop-down item.

Controls the sharing settings for the program.

SMS contains details for a sending an sms to customers.

Repeated field of dynamically typed values (including string, bool, option, syntax).

A fixed time without timezone information.

Some point based loyalty programs will pass on transaction information (can be used for segmenting, additional reporting, and/or showing transactions on back of the pass).

UnimplementedCertificatesServer should be embedded to have forward compatible implementations.

UnimplementedDistributionServer should be embedded to have forward compatible implementations.

UnimplementedImagesServer should be embedded to have forward compatible implementations.

UnimplementedIntegrationsServer should be embedded to have forward compatible implementations.

UnimplementedMessagesServer should be embedded to have forward compatible implementations.

UnimplementedTemplatesServer should be embedded to have forward compatible implementations.

UnimplementedUsersServer should be embedded to have forward compatible implementations.

Verify request is used to validate a email address for a passkit account.

CertificatesClient is the client API for Certificates service.

CertificatesServer is the server API for Certificates service.

DistributionClient is the client API for Distribution service.

DistributionServer is the server API for Distribution service.

ImagesClient is the client API for Images service.

ImagesServer is the server API for Images service.

IntegrationsClient is the client API for Integrations service.

IntegrationsServer is the server API for Integrations service.

MessagesClient is the client API for Messages service.

MessagesServer is the server API for Messages service.

TemplatesClient is the client API for Templates service.

TemplatesServer is the server API for Templates service.

UnsafeCertificatesServer may be embedded to opt out of forward compatibility for this service.

UnsafeDistributionServer may be embedded to opt out of forward compatibility for this service.

UnsafeImagesServer may be embedded to opt out of forward compatibility for this service.

UnsafeIntegrationsServer may be embedded to opt out of forward compatibility for this service.

UnsafeMessagesServer may be embedded to opt out of forward compatibility for this service.

UnsafeTemplatesServer may be embedded to opt out of forward compatibility for this service.

UnsafeUsersServer may be embedded to opt out of forward compatibility for this service.

UsersClient is the client API for Users service.

UsersServer is the server API for Users service.

Action method is an api call method (post, put, delete) used when data get integrated with the third party application.

Apple pass types.

Barcode type sets the type of barcode for the pass.

Configuration of the third party app which can be integrated with PassKit.

Protocol specific events for the Single Use Coupon protocol.

Data style controls how value will be rendered on the pass.

Indicates the type of data.

DefaultCouponScanAction enum determines what default actions a user can apply to scanned cards.

DefaultMembershipScanAction enum determines what default actions a user can apply to scanned cards.

Options to manage the expiry date of the digital card.

Standard Facebook Pixel events that we support.

Field type categorize a type of field rendered on pass or data collection page.

Gender, as per government issued id.

Google Pay pass types.

Turn on and off the integration.

IntegrationType allows to select the timing of integration occurs and the order of data processing.

This is a list of supported languages.

Statuses of the pass.

Used to specify the type of link for link field.

List position is used to denote behavior for list items that may already have been populated bay a parent object.

Protocol specific events for the Membership protocol.

PassBundleFormat is used to specify which format(s) to provide the pass content.

Name of pass event the third part app can subscribe to.

Use to indicate what personal information to request for an Apple Wallet personalized pass.

ProtocolIntgType contains hooks for protocol methods.

ScannerCouponPermissions enum determines what membership related actions a user can perform in the scanning app.

ScannerMembershipPermissions enum determines what membership related actions a user can perform in the scanning app.

Status is the best determined status of the pass.

UsageType is used to indicate where a field or link is used / rendered.