edutap.wallet_google.models.passes.bases.ObjectModel#
- pydantic model edutap.wallet_google.models.passes.bases.ObjectModel#
Base model for all Google Wallet Object models.
Opposed to the ClassModel, this class does not represent the GenericObject. So, it does not act as a base model for all other wallet object types. It is just a base model with all attributes all Google Wallet Objects models have in common.
Show JSON schema
{ "title": "ObjectModel", "description": "Base model for all Google Wallet Object models.\n\nOpposed to the ClassModel, this class does not represent the GenericObject.\nSo, it does not act as a base model for all other wallet object types.\nIt is just a base model with all attributes all Google Wallet Objects models have in common.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "classId": { "title": "Classid", "type": "string" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "deprecated", "title": "Version" }, "imageModulesData": { "anyOf": [ { "items": { "$ref": "#/$defs/ImageModuleData" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Imagemodulesdata" }, "textModulesData": { "anyOf": [ { "items": { "$ref": "#/$defs/TextModuleData" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Textmodulesdata" }, "linksModuleData": { "anyOf": [ { "$ref": "#/$defs/LinksModuleData" }, { "type": "null" } ], "default": null }, "infoModuleData": { "anyOf": [ { "$ref": "#/$defs/InfoModuleData" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "deprecated" }, "passConstraints": { "anyOf": [ { "$ref": "#/$defs/PassConstraints" }, { "type": "null" } ], "default": null }, "smartTapRedemptionValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Smarttapredemptionvalue" }, "barcode": { "anyOf": [ { "$ref": "#/$defs/Barcode" }, { "type": "null" } ], "default": null }, "rotatingBarcode": { "anyOf": [ { "$ref": "#/$defs/RotatingBarcode" }, { "type": "null" } ], "default": null }, "groupingInfo": { "anyOf": [ { "$ref": "#/$defs/GroupingInfo" }, { "type": "null" } ], "default": null }, "saveRestrictions": { "anyOf": [ { "$ref": "#/$defs/SaveRestrictions" }, { "type": "null" } ], "default": null }, "linkedObjectIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Linkedobjectids" }, "valueAddedModuleData": { "anyOf": [ { "$ref": "#/$defs/ValueAddedModuleData" }, { "type": "null" } ], "default": null }, "messages": { "anyOf": [ { "items": { "$ref": "#/$defs/Message" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Messages" }, "appLinkData": { "anyOf": [ { "$ref": "#/$defs/AppLinkData" }, { "type": "null" } ], "default": null }, "state": { "$ref": "#/$defs/State", "default": "STATE_UNSPECIFIED" }, "hasUsers": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Hasusers" }, "validTimeInterval": { "anyOf": [ { "$ref": "#/$defs/TimeInterval" }, { "type": "null" } ], "default": null } }, "$defs": { "AppLinkData": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/AppLinkData", "properties": { "androidAppLinkInfo": { "anyOf": [ { "$ref": "#/$defs/AppLinkInfo" }, { "type": "null" } ], "default": null }, "iosAppLinkInfo": { "anyOf": [ { "$ref": "#/$defs/AppLinkInfo" }, { "type": "null" } ], "default": null }, "webAppLinkInfo": { "anyOf": [ { "$ref": "#/$defs/AppLinkInfo" }, { "type": "null" } ], "default": null } }, "title": "AppLinkData", "type": "object" }, "AppLinkInfo": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/AppLinkData#applinkinfo", "properties": { "appLogoImage": { "anyOf": [ { "$ref": "#/$defs/Image" }, { "type": "null" } ], "default": null }, "title": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "description": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "appTarget": { "anyOf": [ { "$ref": "#/$defs/AppTarget" }, { "type": "null" } ], "default": null } }, "title": "AppLinkInfo", "type": "object" }, "AppTarget": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/AppLinkData#apptargets", "properties": { "targetUri": { "anyOf": [ { "$ref": "#/$defs/Uri" }, { "type": "null" } ], "default": null } }, "title": "AppTarget", "type": "object" }, "Barcode": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/Barcode", "properties": { "type": { "$ref": "#/$defs/BarcodeType", "default": "BARCODE_TYPE_UNSPECIFIED" }, "renderEncoding": { "$ref": "#/$defs/BarcodeRenderEncoding", "default": "RENDER_ENCODING_UNSPECIFIED" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Value" }, "alternateText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Alternatetext" }, "showCodeText": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null } }, "title": "Barcode", "type": "object" }, "BarcodeRenderEncoding": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/BarcodeRenderEncoding", "enum": [ "renderEncodingUnspecified", "RENDER_ENCODING_UNSPECIFIED", "utf8", "UTF_8" ], "title": "BarcodeRenderEncoding", "type": "string" }, "BarcodeType": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/BarcodeType", "enum": [ "barcodeTypeUnspecified", "BARCODE_TYPE_UNSPECIFIED", "aztec", "AZTEC", "code39", "CODE_39", "code128", "CODE_128", "codabar", "CODABAR", "dataMatrix", "DATA_MATRIX", "ean8", "EAN_8", "ean13", "EAN_13", "itf14", "ITF_14", "pdf417", "PDF_417", "qrCode", "QR_CODE", "upcA", "UPC_A", "textOnly", "TEXT_ONLY" ], "title": "BarcodeType", "type": "string" }, "DateTime": { "description": "see: https://developers.google.com/wallet/tickets/events/rest/v1/DateTime", "properties": { "date": { "format": "date-time", "title": "Date", "type": "string" } }, "required": [ "date" ], "title": "DateTime", "type": "object" }, "GroupingInfo": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/GroupingInfo", "properties": { "sortIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Sortindex" }, "groupingId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Groupingid" } }, "title": "GroupingInfo", "type": "object" }, "Image": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/Image", "properties": { "sourceUri": { "$ref": "#/$defs/ImageUri" }, "contentDescription": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null } }, "required": [ "sourceUri" ], "title": "Image", "type": "object" }, "ImageModuleData": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/ImageModuleData", "properties": { "mainImage": { "anyOf": [ { "$ref": "#/$defs/Image" }, { "type": "null" } ], "default": null }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" } }, "title": "ImageModuleData", "type": "object" }, "ImageUri": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/Image#imageuri", "properties": { "uri": { "format": "uri", "minLength": 1, "title": "Uri", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "title": "Description" }, "localizedDescription": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null, "deprecated": true } }, "required": [ "uri" ], "title": "ImageUri", "type": "object" }, "InfoModuleData": { "description": "see: https://developers.google.com/wallet/retail/loyalty-cards/rest/v1/InfoModuleData", "properties": { "labelValueRows": { "items": { "$ref": "#/$defs/LabelValueRow" }, "title": "Labelvaluerows", "type": "array" }, "showLastUpdatedTime": { "default": false, "description": "deprecated", "title": "Showlastupdatedtime", "type": "boolean" } }, "required": [ "labelValueRows" ], "title": "InfoModuleData", "type": "object" }, "LabelValue": { "description": "see: https://developers.google.com/wallet/retail/loyalty-cards/rest/v1/InfoModuleData#labelvalue", "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Label" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Value" }, "localizedLabel": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "localizedValue": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null } }, "title": "LabelValue", "type": "object" }, "LabelValueRow": { "description": "see: https://developers.google.com/wallet/retail/loyalty-cards/rest/v1/InfoModuleData#labelvaluerow", "properties": { "columns": { "anyOf": [ { "items": { "$ref": "#/$defs/LabelValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Columns" } }, "title": "LabelValueRow", "type": "object" }, "LinksModuleData": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/LinksModuleData", "properties": { "uris": { "anyOf": [ { "items": { "$ref": "#/$defs/Uri" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Uris" } }, "title": "LinksModuleData", "type": "object" }, "LocalizedString": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/LocalizedString", "properties": { "defaultValue": { "$ref": "#/$defs/TranslatedString" }, "translatedValues": { "default": [], "items": { "$ref": "#/$defs/TranslatedString" }, "title": "Translatedvalues", "type": "array" } }, "required": [ "defaultValue" ], "title": "LocalizedString", "type": "object" }, "Message": { "description": "see: https://developers.google.com/wallet/tickets/events/rest/v1/Message", "properties": { "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "walletobjects#walletObjectMessage", "deprecated": true, "description": "deprecated", "title": "Kind" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "messageType": { "$ref": "#/$defs/MessageType", "default": "MESSAGE_TYPE_UNSPECIFIED" }, "displayInterval": { "anyOf": [ { "$ref": "#/$defs/TimeInterval" }, { "type": "null" } ], "default": null }, "header": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Header" }, "localizedHeader": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Body" }, "localizedBody": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null } }, "title": "Message", "type": "object" }, "MessageType": { "description": "see: https://developers.google.com/wallet/tickets/events/rest/v1/Message#messagetype", "enum": [ "messageTypeUnspecified", "MESSAGE_TYPE_UNSPECIFIED", "text", "TEXT", "textAndNotify", "TEXT_AND_NOTIFY", "expirationNotification", "EXPIRATION_NOTIFICATION" ], "title": "MessageType", "type": "string" }, "ModuleViewConstraints": { "description": "see: https://developers.google.com/wallet/reference/rest/v1/ValueAddedModuleData", "properties": { "displayInterval": { "anyOf": [ { "$ref": "#/$defs/TimeInterval" }, { "type": "null" } ], "default": null } }, "title": "ModuleViewConstraints", "type": "object" }, "NfcConstraint": { "description": "see: https://developers.google.com/wallet/reference/rest/v1/PassConstraints#NfcConstraint", "enum": [ "nfcConstraintUnspecified", "NFC_CONSTRAINT_UNSPECIFIED", "blockPayment", "BLOCK_PAYMENT", "blockClosedLoopTransit", "BLOCK_CLOSED_LOOP_TRANSIT" ], "title": "NfcConstraint", "type": "string" }, "PassConstraints": { "description": "see https://developers.google.com/wallet/generic/rest/v1/PassConstraints", "properties": { "screenshotEligibility": { "$ref": "#/$defs/ScreenshotEligibility", "default": "SCREENSHOT_ELIGIBILITY_UNSPECIFIED" }, "nfcConstraint": { "anyOf": [ { "items": { "$ref": "#/$defs/NfcConstraint" }, "type": "array" }, { "type": "null" } ], "title": "Nfcconstraint" } }, "title": "PassConstraints", "type": "object" }, "RotatingBarcode": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/RotatingBarcode", "properties": { "type": { "$ref": "#/$defs/BarcodeType", "default": "BARCODE_TYPE_UNSPECIFIED" }, "renderEncoding": { "$ref": "#/$defs/BarcodeRenderEncoding", "default": "RENDER_ENCODING_UNSPECIFIED" }, "valuePattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Valuepattern" }, "totpDetails": { "anyOf": [ { "$ref": "#/$defs/TotpDetails" }, { "type": "null" } ], "default": null }, "alternateText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Alternatetext" }, "showCodeText": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null } }, "title": "RotatingBarcode", "type": "object" }, "SaveRestrictions": { "description": "see: https://developers.google.com/wallet/reference/rest/v1/SaveRestrictions", "properties": { "restrictToEmailSha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Restricttoemailsha256" } }, "title": "SaveRestrictions", "type": "object" }, "ScreenshotEligibility": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/PassConstraints#screenshoteligibility", "enum": [ "screenshotEligibilityUnspecified", "SCREENSHOT_ELIGIBILITY_UNSPECIFIED", "eligible", "ELIGIBLE", "ineligible", "INELIGIBLE" ], "title": "ScreenshotEligibility", "type": "string" }, "State": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/State\n https://developers.google.com/wallet/retail/loyalty-cards/rest/v1/State", "enum": [ "stateUnspecified", "STATE_UNSPECIFIED", "active", "ACTIVE", "completed", "COMPLETED", "expired", "EXPIRED", "inactive", "INACTIVE" ], "title": "State", "type": "string" }, "TextModuleData": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/TextModuleData", "properties": { "header": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Header" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Body" }, "localizedHeader": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "localizedBody": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" } }, "title": "TextModuleData", "type": "object" }, "TimeInterval": { "description": "see: https://developers.google.com/wallet/tickets/events/rest/v1/TimeInterval", "properties": { "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "walletobjects#timeInterval", "deprecated": true, "description": "deprecated", "title": "Kind" }, "start": { "anyOf": [ { "$ref": "#/$defs/DateTime" }, { "type": "null" } ], "default": null }, "end": { "anyOf": [ { "$ref": "#/$defs/DateTime" }, { "type": "null" } ], "default": null } }, "title": "TimeInterval", "type": "object" }, "TotpAlgorithm": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/RotatingBarcode#totpalgorithm", "enum": [ "totpAlgorithmUnspecified", "TOTP_ALGORITHM_UNSPECIFIED", "totpSha1", "TOTP_SHA1" ], "title": "TotpAlgorithm", "type": "string" }, "TotpDetails": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/RotatingBarcode#totpdetails", "properties": { "periodMillis": { "title": "Periodmillis", "type": "string" }, "algorithm": { "$ref": "#/$defs/TotpAlgorithm", "default": "TOTP_ALGORITHM_UNSPECIFIED" }, "parameters": { "items": { "$ref": "#/$defs/TotpParameters" }, "title": "Parameters", "type": "array" } }, "required": [ "periodMillis", "parameters" ], "title": "TotpDetails", "type": "object" }, "TotpParameters": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/RotatingBarcode#totpparameters", "properties": { "key": { "title": "Key", "type": "string" }, "valueLength": { "title": "Valuelength", "type": "integer" } }, "required": [ "key", "valueLength" ], "title": "TotpParameters", "type": "object" }, "TranslatedString": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/LocalizedString#translatedstring", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Value" } }, "title": "TranslatedString", "type": "object" }, "Uri": { "description": "see: https://developers.google.com/wallet/generic/rest/v1/Uri", "properties": { "uri": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uri" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "localizedDescription": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" } }, "title": "Uri", "type": "object" }, "ValueAddedModuleData": { "description": "see: https://developers.google.com/wallet/reference/rest/v1/ValueAddedModuleData", "properties": { "header": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "body": { "anyOf": [ { "$ref": "#/$defs/LocalizedString" }, { "type": "null" } ], "default": null }, "image": { "anyOf": [ { "$ref": "#/$defs/Image" }, { "type": "null" } ], "default": null }, "uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uri" }, "viewConstraints": { "anyOf": [ { "$ref": "#/$defs/ModuleViewConstraints" }, { "type": "null" } ], "default": null }, "sortIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Sortindex" } }, "title": "ValueAddedModuleData", "type": "object" } }, "additionalProperties": false, "required": [ "id", "classId" ] }
- Config:
extra: str = forbid
- Fields:
appLinkData (edutap.wallet_google.models.datatypes.data.AppLinkData | None)barcode (edutap.wallet_google.models.datatypes.barcode.Barcode | None)groupingInfo (edutap.wallet_google.models.datatypes.general.GroupingInfo | None)imageModulesData (list[edutap.wallet_google.models.datatypes.data.ImageModuleData] | None)infoModuleData (edutap.wallet_google.models.datatypes.data.InfoModuleData | None)linksModuleData (edutap.wallet_google.models.datatypes.data.LinksModuleData | None)messages (list[edutap.wallet_google.models.datatypes.message.Message] | None)passConstraints (edutap.wallet_google.models.datatypes.general.PassConstraints | None)rotatingBarcode (edutap.wallet_google.models.datatypes.barcode.RotatingBarcode | None)saveRestrictions (edutap.wallet_google.models.datatypes.general.SaveRestrictions | None)textModulesData (list[edutap.wallet_google.models.datatypes.data.TextModuleData] | None)validTimeInterval (edutap.wallet_google.models.datatypes.datetime.TimeInterval | None)valueAddedModuleData (edutap.wallet_google.models.datatypes.moduledata.ValueAddedModuleData | None)
- field appLinkData: AppLinkData | None = None#
- field classId: str [Required]#
- field groupingInfo: GroupingInfo | None = None#
- field hasUsers: bool | None = None#
- field imageModulesData: list[ImageModuleData] | None = None#
- field linkedObjectIds: list[str] | None = None#
- field linksModuleData: LinksModuleData | None = None#
- field passConstraints: PassConstraints | None = None#
- field rotatingBarcode: RotatingBarcode | None = None#
- field saveRestrictions: SaveRestrictions | None = None#
- field smartTapRedemptionValue: str | None = None#
- field textModulesData: list[TextModuleData] | None = None#
- field validTimeInterval: TimeInterval | None = None#
- field valueAddedModuleData: ValueAddedModuleData | None = None#
- infoModuleData: InfoModuleData | None#
Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.
- Attributes:
msg: The deprecation message to be emitted. wrapped_property: The property instance if the deprecated field is a computed field, or None. field_name: The name of the field being deprecated.
- version: str | None#
Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.
- Attributes:
msg: The deprecation message to be emitted. wrapped_property: The property instance if the deprecated field is a computed field, or None. field_name: The name of the field being deprecated.