ClientAddressUpdatedV1

v0.0.1

{
  "$id": "https://example.com/ClientAddressUpdatedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientAddressUpdatedV1",
  "description": "An event raised when a client updates his address",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g ClientAddressUpdatedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event like was it genereated by Client using Web or WeChat"
        },
       "version": {
          "type": "number",
          "description": "The version of the event schema"
        },
        "sentAtUtc": {
          "type": "string",
          "description": "When event was send by the publishers in ISO 8601 "
        }
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version" ]
    },
    "data": {
      "type": "object",
      "properties": {
        "clientId": {
          "type": "string",
          "description": "The GUID of client"
        },
        "clientNumber": {
          "type": "number",
          "description": "The COS number of the client"
        },
        "accountNumber": {
          "type": "string",
          "description": "The transactional account number of the client"
        },
        "addressTypeUpdated": {
          "type": "string",
          "description": "Address type being updated e.g Billing, Home"
        },
        "addressUpdated": {
          "type": "object",
          "properties": {
            "addressId": {
              "type": "string",
              "description": "Address Id"
            },
            "firstLineOfAddress": {
              "type": "number",
              "description": "The COS number of the client"
            },
            "city": {
              "type": "string",
              "description": "The city of the address"
            },
            "postalCode": {
              "type": "string",
              "description": "The postal code of the address"
            },
            "countryCode": {
              "type": "string",
              "description": "The country code associated with the address (e.g., US for United States)"
            }
          }
        }
      }
    }
  }
}