ClientDefaultAddressUpdatedV1

v0.0.1

{
  "$id": "https://example.com/ClientDefaultAddressUpdatedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientDefaultAddressUpdatedV1",
  "description": "An event raised when a client updates their default address type",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when the 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., ClientDefaultAddressUpdatedV1",
          "const": "ClientDefaultAddressUpdatedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event indicating where the update was initiated (e.g., Web, Mobile App)"
        },
        "version": {
          "type": "number",
          "description": "The version of the event schema"
        },
        "sentAtUtc": {
          "type": "string",
          "description": "The date and time when the event was sent by the publisher in ISO 8601 format"
        }
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version" ]
    },
    "data": {
      "type": "object",
      "properties": {
        "clientId": {
          "type": "string",
          "description": "The GUID of the client"
        },
        "accountNumber": {
          "type": "string",
          "description": "The transactional account number of the client"
        },
        "addressId": {
          "type": "string",
          "description": "The unique identifier of the address being set as default"
        },
        "isDefaultResidential": {
          "type": "boolean",
          "description": "Indicates whether the address is set as the default residential address"
        },
        "isDefaultBilling": {
          "type": "boolean",
          "description": "Indicates whether the address is set as the default billing address"
        },
        "isDefaultShipping": {
          "type": "boolean",
          "description": "Indicates whether the address is set as the default shipping address"
        }
      },
      "required": [ "clientId", "accountNumber", "addressId", "isDefaultResidential", "isDefaultBilling", "isDefaultShipping" ]
    }
  },
  "required": [ "metadata", "data" ]
}