edutap.wallet_apple.models.passes.Pass#
- pydantic model edutap.wallet_apple.models.passes.Pass#
Show JSON schema
{ "title": "Pass", "type": "object", "properties": { "teamIdentifier": { "title": "Teamidentifier", "type": "string" }, "passTypeIdentifier": { "title": "Passtypeidentifier", "type": "string" }, "organizationName": { "title": "Organizationname", "type": "string" }, "serialNumber": { "title": "Serialnumber", "type": "string" }, "description": { "title": "Description", "type": "string" }, "formatVersion": { "default": 1, "title": "Formatversion", "type": "integer" }, "backgroundColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Backgroundcolor" }, "foregroundColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Foregroundcolor" }, "labelColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Labelcolor" }, "logoText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Logotext" }, "barcodes": { "anyOf": [ { "items": { "$ref": "#/$defs/Barcode" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Barcodes" }, "suppressStripShine": { "default": false, "title": "Suppressstripshine", "type": "boolean" }, "webServiceURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Webserviceurl" }, "authenticationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Authenticationtoken" }, "locations": { "anyOf": [ { "items": { "$ref": "#/$defs/Location" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Locations" }, "ibeacons": { "anyOf": [ { "items": { "$ref": "#/$defs/IBeacon" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Ibeacons" }, "relevantDate": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/DateField" }, { "type": "null" } ], "default": null, "title": "Relevantdate" }, "associatedStoreIdentifiers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Associatedstoreidentifiers" }, "appLaunchURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Applaunchurl" }, "userInfo": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "default": null, "title": "Userinfo" }, "expirationDate": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/DateField" }, { "type": "null" } ], "default": null, "title": "Expirationdate" }, "voided": { "default": false, "title": "Voided", "type": "boolean" }, "nfc": { "anyOf": [ { "$ref": "#/$defs/NFC" }, { "type": "null" } ], "default": null }, "boardingPass": { "$ref": "#/$defs/BoardingPass", "default": null }, "coupon": { "$ref": "#/$defs/Coupon", "default": null }, "eventTicket": { "$ref": "#/$defs/EventTicket", "default": null }, "generic": { "$ref": "#/$defs/Generic", "default": null }, "storeCard": { "$ref": "#/$defs/StoreCard", "default": null } }, "$defs": { "Alignment": { "enum": [ "PKTextAlignmentLeft", "PKTextAlignmentCenter", "PKTextAlignmentRight", "PKTextAlignmentJustified", "PKTextAlignmentNatural" ], "title": "Alignment", "type": "string" }, "Barcode": { "properties": { "format": { "$ref": "#/$defs/BarcodeFormat", "default": "PKBarcodeFormatPDF417" }, "message": { "title": "Message", "type": "string" }, "messageEncoding": { "default": "iso-8859-1", "title": "Messageencoding", "type": "string" }, "altText": { "default": "", "title": "Alttext", "type": "string" } }, "required": [ "message" ], "title": "Barcode", "type": "object" }, "BarcodeFormat": { "enum": [ "PKBarcodeFormatPDF417", "PKBarcodeFormatQR", "PKBarcodeFormatAztec", "PKBarcodeFormatCode128" ], "title": "BarcodeFormat", "type": "string" }, "BoardingPass": { "description": "see https://developer.apple.com/documentation/walletpasses/pass/boardingpass-data.dictionary", "properties": { "headerFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Headerfields", "type": "array" }, "primaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Primaryfields", "type": "array" }, "secondaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Secondaryfields", "type": "array" }, "backFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Backfields", "type": "array" }, "auxiliaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Auxiliaryfields", "type": "array" }, "transitType": { "$ref": "#/$defs/TransitType", "default": "PKTransitTypeAir" } }, "title": "BoardingPass", "type": "object" }, "Coupon": { "description": "see https://developer.apple.com/documentation/walletpasses/pass/coupon-data.dictionary", "properties": { "headerFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Headerfields", "type": "array" }, "primaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Primaryfields", "type": "array" }, "secondaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Secondaryfields", "type": "array" }, "backFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Backfields", "type": "array" }, "auxiliaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Auxiliaryfields", "type": "array" } }, "title": "Coupon", "type": "object" }, "DateField": { "properties": { "key": { "title": "Key", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "title": "Value" }, "label": { "default": "", "title": "Label", "type": "string" }, "changeMessage": { "default": "", "title": "Changemessage", "type": "string" }, "textAlignment": { "anyOf": [ { "$ref": "#/$defs/Alignment" }, { "type": "null" } ], "default": null }, "dateStyle": { "$ref": "#/$defs/DateStyle", "default": "PKDateStyleShort" }, "timeStyle": { "$ref": "#/$defs/DateStyle", "default": "PKDateStyleShort" }, "isRelative": { "default": false, "title": "Isrelative", "type": "boolean" }, "ignoresTimeZone": { "default": false, "title": "Ignorestimezone", "type": "boolean" } }, "required": [ "key", "value" ], "title": "DateField", "type": "object" }, "DateStyle": { "enum": [ "PKDateStyleNone", "PKDateStyleShort", "PKDateStyleMedium", "PKDateStyleLong", "PKDateStyleFull" ], "title": "DateStyle", "type": "string" }, "EventTicket": { "description": "see https://developer.apple.com/documentation/walletpasses/pass/eventticket-data.dictionary", "properties": { "headerFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Headerfields", "type": "array" }, "primaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Primaryfields", "type": "array" }, "secondaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Secondaryfields", "type": "array" }, "backFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Backfields", "type": "array" }, "auxiliaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Auxiliaryfields", "type": "array" } }, "title": "EventTicket", "type": "object" }, "Field": { "properties": { "key": { "title": "Key", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "title": "Value" }, "label": { "default": "", "title": "Label", "type": "string" }, "changeMessage": { "default": "", "title": "Changemessage", "type": "string" }, "textAlignment": { "anyOf": [ { "$ref": "#/$defs/Alignment" }, { "type": "null" } ], "default": null } }, "required": [ "key", "value" ], "title": "Field", "type": "object" }, "Generic": { "description": "see https://developer.apple.com/documentation/walletpasses/pass/generic-data.dictionary", "properties": { "headerFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Headerfields", "type": "array" }, "primaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Primaryfields", "type": "array" }, "secondaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Secondaryfields", "type": "array" }, "backFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Backfields", "type": "array" }, "auxiliaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Auxiliaryfields", "type": "array" } }, "title": "Generic", "type": "object" }, "IBeacon": { "properties": { "proximityUUID": { "title": "Proximityuuid", "type": "string" }, "major": { "title": "Major", "type": "integer" }, "minor": { "title": "Minor", "type": "integer" }, "relevantText": { "default": "", "title": "Relevanttext", "type": "string" } }, "required": [ "proximityUUID", "major", "minor" ], "title": "IBeacon", "type": "object" }, "Location": { "properties": { "latitude": { "default": 0.0, "title": "Latitude", "type": "number" }, "longitude": { "default": 0.0, "title": "Longitude", "type": "number" }, "altitude": { "default": 0, "title": "Altitude", "type": "number" }, "distance": { "default": 0, "title": "Distance", "type": "number" }, "relevantText": { "default": "", "title": "Relevanttext", "type": "string" } }, "title": "Location", "type": "object" }, "NFC": { "properties": { "message": { "title": "Message", "type": "string" }, "encryptionPublicKey": { "title": "Encryptionpublickey", "type": "string" }, "requiresAuthentication": { "default": false, "title": "Requiresauthentication", "type": "boolean" } }, "required": [ "message", "encryptionPublicKey" ], "title": "NFC", "type": "object" }, "StoreCard": { "description": "see https://developer.apple.com/documentation/walletpasses/pass/storecard", "properties": { "headerFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Headerfields", "type": "array" }, "primaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Primaryfields", "type": "array" }, "secondaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Secondaryfields", "type": "array" }, "backFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Backfields", "type": "array" }, "auxiliaryFields": { "items": { "$ref": "#/$defs/Field" }, "title": "Auxiliaryfields", "type": "array" } }, "title": "StoreCard", "type": "object" }, "TransitType": { "enum": [ "PKTransitTypeAir", "PKTransitTypeTrain", "PKTransitTypeBus", "PKTransitTypeBoat", "PKTransitTypeGeneric" ], "title": "TransitType", "type": "string" } }, "required": [ "teamIdentifier", "passTypeIdentifier", "organizationName", "serialNumber", "description" ] }
- Fields:
barcodes (list[edutap.wallet_apple.models.passes.Barcode] | None)expirationDate (str | edutap.wallet_apple.models.passes.DateField | None)ibeacons (list[edutap.wallet_apple.models.passes.IBeacon] | None)locations (list[edutap.wallet_apple.models.passes.Location] | None)relevantDate (str | edutap.wallet_apple.models.passes.DateField | None)
- field appLaunchURL: str | None = None#
Optional. A URL to be passed to the associated app when launching it.
- field associatedStoreIdentifiers: list[str] | None = None#
Optional. Identifies which merchants’ locations accept the pass.
- field authenticationToken: str | None = None#
Optional. The authentication token to use with the web service. Minimum 16 chars Must not be changed after creation.
- field backgroundColor: str | None = None#
Optional. Background color of the pass, specified as an CSS-style RGB triple. For example, rgb(23, 187, 82).
- field barcodes: list[Barcode] | None = None#
Optional. Information specific to the pass’s barcode. The system uses the first valid
- field description: str [Required]#
Required. Brief description of the pass, used by the iOS accessibility technologies.
- field expirationDate: str | DateField | None = None#
Optional. Date and time when the pass expires.
- field foregroundColor: str | None = None#
Optional. Foreground color of the pass, specified as a CSS-style RGB triple. For example, rgb(100, 10, 110).
- field formatVersion: int = 1#
Required. Version of the file format. The value must be 1.
- field ibeacons: list[IBeacon] | None = None#
Optional. IBeacons data
- field labelColor: str | None = None#
Optional. Color of the label text, specified as a CSS-style RGB triple. For example, rgb(255, 255, 255).
- field locations: list[Location] | None = None#
Optional. Locations where the pass is relevant. For example, the location of your store.
- field logoText: str | None = None#
Optional. Text displayed next to the logo on the pass.
- field nfc: NFC | None = None#
Optional. Information used for Value Added Service Protocol transactions.
- field organizationName: str [Required]#
Required. Display name of the organization that originated and signed the pass.
- field passTypeIdentifier: str [Required]#
Required. Pass type identifier, as issued by Apple. The value must correspond with your signing certificate. used for grouping.
- field relevantDate: str | DateField | None = None#
Optional. Date and time when the pass becomes relevant.
- field serialNumber: str [Required]#
Required. Serial number that uniquely identifies the pass. Must not be changed after creation
- field suppressStripShine: bool = False#
Optional. If true, the strip image is displayed.
- field teamIdentifier: str [Required]#
Required. Team identifier of the organization that originated and signed the pass, as issued by Apple.
- field userInfo: dict | None = None#
Optional. Custom information for the pass.
- field voided: bool = False#
- field webServiceURL: str | None = None#
Optional. The URL of a web service that conforms to the API described in PassKit Web Service Reference. Must not be changed after creation
- classmethod from_json(json_str: str | bytes) Pass#
validates a pass json string and returns a Pass object
- property barcode: Barcode | None#
deprecated, use barcodes instead. this field is implemented for backwards compatibility and returns the first barcode in the barcodes list. the setter overwrites the barcodes field
- property passInformation#
Returns the pass information object by checking all passmodel entries using all()