ContactOrId

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aurinko/json-schema/aurinko-contact-or-id-schema.json",
  "title": "ContactOrId",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aurinko-contacts-api-openapi.yml#/components/schemas/ContactOrId",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "etag": {
      "type": "string",
      "readOnly": true
    },
    "record": {
      "$ref": "#/$defs/Contact"
    }
  },
  "$defs": {
    "Contact": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true
        },
        "etag": {
          "type": "string",
          "readOnly": true
        },
        "createdTime": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "lastModifiedTime": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "name": {
          "$ref": "#/$defs/ContactName"
        },
        "nickName": {
          "type": "string"
        },
        "fileAs": {
          "type": "string"
        },
        "company": {
          "$ref": "#/$defs/ContactCompany"
        },
        "relations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ContactRelation"
          }
        },
        "birthday": {
          "type": "string"
        },
        "keywords": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "notes": {
          "type": "string"
        },
        "emailAddresses": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ContactEmailAddress"
          }
        },
        "phoneNumbers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ContactPhoneNumber"
          }
        },
        "addresses": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ContactPostalAddress"
          }
        },
        "urls": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ContactUrl"
          }
        },
        "nativeProperties": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "hasPhoto": {
          "type": "boolean",
          "readOnly": true
        },
        "photo": {
          "$ref": "#/$defs/ContactPhoto",
          "readOnly": true
        }
      }
    },
    "ContactCompany": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "officeLocation": {
          "type": "string"
        },
        "department": {
          "type": "string"
        },
        "jobTitle": {
          "type": "string"
        },
        "yomiCompanyName": {
          "type": "string"
        }
      }
    },
    "ContactEmailAddress": {
      "type": "object",
      "properties": {
        "address": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "ContactName": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        },
        "givenName": {
          "type": "string"
        },
        "middleName": {
          "type": "string"
        },
        "familyName": {
          "type": "string"
        },
        "suffix": {
          "type": "string"
        },
        "yomiGivenName": {
          "type": "string"
        },
        "yomiFamilyName": {
          "type": "string"
        }
      }
    },
    "ContactPhoneNumber": {
      "type": "object",
      "properties": {
        "number": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "work",
            "home",
            "other",
            "mobile",
            "workMobile",
            "main",
            "companyMain",
            "assistant",
            "workFax",
            "homeFax",
            "otherFax",
            "callback",
            "pager",
            "workPager",
            "radio",
            "telex",
            "tty"
          ]
        },
        "canonicalForm": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ContactPhoto": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "mimeType": {
          "type": "string"
        },
        "content": {
          "type": "string"
        }
      }
    },
    "ContactPostalAddress": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string"
        },
        "streetLine2": {
          "type": "string"
        },
        "poBox": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "work",
            "home",
            "other"
          ]
        }
      }
    },
    "ContactRelation": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "manager",
            "assistant",
            "spouse"
          ]
        }
      }
    },
    "ContactUrl": {
      "type": "object",
      "properties": {
        "href": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "work",
            "home",
            "other",
            "blog",
            "profile",
            "homePage",
            "ftp",
            "reservations"
          ]
        }
      }
    }
  }
}