edutap.wallet_google.models.generic.GenericObject#

pydantic model edutap.wallet_google.models.generic.GenericObject#

see: https://developers.google.com/wallet/generic/rest/v1/genericobject

Show JSON schema
{
   "title": "GenericObject",
   "description": "see: https://developers.google.com/wallet/generic/rest/v1/genericobject",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "classId": {
         "title": "Classid",
         "type": "string"
      },
      "genericType": {
         "allOf": [
            {
               "$ref": "#/$defs/GenericType"
            }
         ],
         "default": "GENERIC_TYPE_UNSPECIFIED"
      },
      "cardTitle": {
         "$ref": "#/$defs/LocalizedString"
      },
      "subheader": {
         "anyOf": [
            {
               "$ref": "#/$defs/LocalizedString"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "header": {
         "$ref": "#/$defs/LocalizedString"
      },
      "logo": {
         "anyOf": [
            {
               "$ref": "#/$defs/Image"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "hexBackgroundColor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Hexbackgroundcolor"
      },
      "notifications": {
         "anyOf": [
            {
               "$ref": "#/$defs/Notifications"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "barcode": {
         "anyOf": [
            {
               "$ref": "#/$defs/Barcode"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "heroImage": {
         "anyOf": [
            {
               "$ref": "#/$defs/Image"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "validTimeInterval": {
         "anyOf": [
            {
               "$ref": "#/$defs/TimeInterval"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "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
      },
      "appLinkData": {
         "anyOf": [
            {
               "$ref": "#/$defs/AppLinkData"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "groupingInfo": {
         "anyOf": [
            {
               "$ref": "#/$defs/GroupingInfo"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "smartTapRedemptionValue": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Smarttapredemptionvalue"
      },
      "rotatingBarcode": {
         "anyOf": [
            {
               "$ref": "#/$defs/RotatingBarcode"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "state": {
         "allOf": [
            {
               "$ref": "#/$defs/State"
            }
         ],
         "default": "STATE_UNSPECIFIED"
      },
      "hasUsers": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Hasusers"
      },
      "passConstraints": {
         "anyOf": [
            {
               "$ref": "#/$defs/PassConstraints"
            },
            {
               "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": {
               "allOf": [
                  {
                     "$ref": "#/$defs/BarcodeType"
                  }
               ],
               "default": "BARCODE_TYPE_UNSPECIFIED"
            },
            "renderEncoding": {
               "allOf": [
                  {
                     "$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": [
            "RENDER_ENCODING_UNSPECIFIED",
            "UTF_8"
         ],
         "title": "BarcodeRenderEncoding",
         "type": "string"
      },
      "BarcodeType": {
         "description": "see: https://developers.google.com/wallet/generic/rest/v1/BarcodeType",
         "enum": [
            "BARCODE_TYPE_UNSPECIFIED",
            "AZTEC",
            "CODE_39",
            "CODE_128",
            "CODABAR",
            "DATA_MATRIX",
            "EAN_8",
            "EAN_13",
            "ITF_14",
            "PDF_417",
            "QR_CODE",
            "UPC_A",
            "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"
      },
      "ExpiryNotification": {
         "description": "see: https://developers.google.com/wallet/generic/rest/v1/genericobject#expirynotification",
         "properties": {
            "enableNotification": {
               "default": false,
               "title": "Enablenotification",
               "type": "boolean"
            }
         },
         "title": "ExpiryNotification",
         "type": "object"
      },
      "GenericType": {
         "description": "see: https://developers.google.com/wallet/generic/rest/v1/genericobject#generictype",
         "enum": [
            "GENERIC_TYPE_UNSPECIFIED",
            "GENERIC_SEASON_PASS",
            "GENERIC_UTILITY_BILLS",
            "GENERIC_PARKING_PASS",
            "GENERIC_VOUCHER",
            "GENERIC_GYM_MEMBERSHIP",
            "GENERIC_LIBRARY_MEMBERSHIP",
            "GENERIC_RESERVATIONS",
            "GENERIC_AUTO_INSURANCE",
            "GENERIC_HOME_INSURANCE",
            "GENERIC_ENTRY_TICKET",
            "GENERIC_RECEIPT",
            "GENERIC_OTHER"
         ],
         "title": "GenericType",
         "type": "string"
      },
      "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,
               "title": "Description"
            },
            "localizedDescription": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/LocalizedString"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "required": [
            "uri"
         ],
         "title": "ImageUri",
         "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"
      },
      "NfcConstraint": {
         "description": "see:",
         "enum": [
            "NFC_CONSTRAINT_UNSPECIFIED",
            "BLOCK_PAYMENT",
            "BLOCK_CLOSED_LOOP_TRANSIT"
         ],
         "title": "NfcConstraint",
         "type": "string"
      },
      "Notifications": {
         "description": "see: https://developers.google.com/wallet/generic/rest/v1/genericobject#notifications",
         "properties": {
            "expiryNotification": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExpiryNotification"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "upcomingNotification": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/UpcomingNotification"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "Notifications",
         "type": "object"
      },
      "PassConstraints": {
         "description": "see https://developers.google.com/wallet/generic/rest/v1/PassConstraints",
         "properties": {
            "screenshotEligibility": {
               "allOf": [
                  {
                     "$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": {
               "allOf": [
                  {
                     "$ref": "#/$defs/BarcodeType"
                  }
               ],
               "default": "BARCODE_TYPE_UNSPECIFIED"
            },
            "renderEncoding": {
               "allOf": [
                  {
                     "$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"
      },
      "ScreenshotEligibility": {
         "description": "see: https://developers.google.com/wallet/generic/rest/v1/PassConstraints#screenshoteligibility",
         "enum": [
            "SCREENSHOT_ELIGIBILITY_UNSPECIFIED",
            "ELIGIBLE",
            "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": [
            "STATE_UNSPECIFIED",
            "ACTIVE",
            "COMPLETED",
            "EXPIRED",
            "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": {
            "start": {
               "$ref": "#/$defs/DateTime"
            },
            "end": {
               "$ref": "#/$defs/DateTime"
            }
         },
         "required": [
            "start",
            "end"
         ],
         "title": "TimeInterval",
         "type": "object"
      },
      "TotpAlgorithm": {
         "description": "see: https://developers.google.com/wallet/generic/rest/v1/RotatingBarcode#totpalgorithm",
         "enum": [
            "TOTP_ALGORITHM_UNSPECIFIED",
            "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": {
               "allOf": [
                  {
                     "$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"
      },
      "UpcomingNotification": {
         "description": "see: https://developers.google.com/wallet/generic/rest/v1/genericobject#upcomingnotification",
         "properties": {
            "enableNotification": {
               "default": false,
               "title": "Enablenotification",
               "type": "boolean"
            }
         },
         "title": "UpcomingNotification",
         "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"
      }
   },
   "required": [
      "id",
      "classId",
      "cardTitle",
      "header"
   ]
}

Fields:
field appLinkData: AppLinkData | None = None#
field barcode: Barcode | None = None#
field cardTitle: LocalizedString [Required]#
field genericType: GenericType = GenericType.GENERIC_TYPE_UNSPECIFIED#
field groupingInfo: GroupingInfo | None = None#
field hasUsers: bool | None = None#
field header: LocalizedString [Required]#
field heroImage: Image | None = None#
field hexBackgroundColor: str | None = None#
field imageModulesData: list[ImageModuleData] | None = None#
field linksModuleData: LinksModuleData | None = None#
field notifications: Notifications | None = None#
field passConstraints: PassConstraints | None = None#
field rotatingBarcode: RotatingBarcode | None = None#
field smartTapRedemptionValue: str | None = None#
field state: State = State.STATE_UNSPECIFIED#
field subheader: LocalizedString | None = None#
field textModulesData: list[TextModuleData] | None = None#
field validTimeInterval: TimeInterval | None = None#