Skip to content

Latest commit

 

History

History
executable file
·
33 lines (30 loc) · 3.75 KB

Template.md

File metadata and controls

executable file
·
33 lines (30 loc) · 3.75 KB

Template

Properties

Name Type Description Notes
id string System ID. Read only. [optional]
external_id string The custom/external ID you want to use. Cannot be changed after creation. [optional]
certificate_id string Certificate used to sign Apple passes. [optional]
colors \WalletPassJP\Model\Colors [optional]
images string[] Array of Asset IDs [optional]
links \WalletPassJP\Model\Link[] [optional]
beacons \WalletPassJP\Model\Beacon[] [optional]
locations \WalletPassJP\Model\Location[] An array of valid coordinates. latitude and longitude must contain valid values. relevant_text is the push notification that is shown on lockscreen. You can also specify an altitude and the max_distance which defines the number of meters around the coordinate where the notification will be shown. [optional]
grouping_identifier string For event tickets and boarding passes used to group related passes; otherwise not allowed. Identifier. If a grouping identifier is specified, passes with the same type, pass identifier and grouping identifier are displayed in a group. Otherwise, passes are grouped by type and pass identifier. [optional]
logo_text string [optional]
pass_type string [optional] [default to 'generic']
name string Used to identify a Template [optional]
description string Brief description of the template. [optional]
relevant_date \DateTime Recommended for event tickets and boarding passes; otherwise optional. Date and time when the pass becomes relevant. For example, the start time of a movie. The value must be a complete date with hours and minutes, and may optionally include seconds. [optional]
organization_name string This is the name of the company or organisation issuing the pass. [optional]
sharing_status string Determines whether a pass supports sharing across users, devices or both. iOS interprets this as a boolean setting: `oneUserOneDevice` prohibits sharing; all other values allow sharing. [optional] [default to 'multipleHolders']
barcode \WalletPassJP\Model\BarcodeSettings [optional]
expiry_settings \WalletPassJP\Model\TemplateExpirySettings [optional]
associated_store_identifier string iTunes Store item identifier for the associated app. If the app is not installed, the link opens the App Store and shows the app. If the app is already installed, the link launches the app. [optional]
fields \WalletPassJP\Model\PassField[] This allows you to configure individual data field that is rendered on the customer UI (data collection page and the pass). [optional]
google_pay_apps \WalletPassJP\Model\TemplateGooglePayApps[] Settings to render an app on the head of a pass. Apps can be Android, iOS or Web [optional]
ios_logo_layout string Apple pass logo settings. - `none` - will omit logo from a pass - `separate` - will use separate Asset `apple_logo` - `unset` - use default logo Asset [optional] [default to 'unset']
created_at \DateTime [optional]
updated_at \DateTime [optional]
tags string[] List of attached tags [optional]

[Back to Model list] [Back to API list] [Back to README]