ClientTelephoneNumberRemovedV1

v0.0.1

{
  "$id": "https://example.com/ClientTelephoneNumberRemovedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientTelephoneNumberRemovedV1",
  "description": "An event raised when a client removes a telephone number from their account",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when the telephone removal event occurred in UTC (ISO 8601 format e.g., 2023-09-08T12:00:00Z)"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g., ClientTelephoneNumberRemovedV1",
          "const": "ClientTelephoneNumberRemovedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event indicating where the removal was initiated (e.g., Internet, 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"
        },
        "clientNumber": {
          "type": "number",
          "description": "The COS number of the client"
        },
        "accountNumber": {
          "type": "string",
          "description": "The transactional account number of the client"
        },
        "telephoneTypeRemoved": {
          "type": "string",
          "description": "The type of telephone being removed (e.g., Mobile, Home, Work)"
        },
        "telephoneRemoved": {
          "type": "object",
          "properties": {
            "telephoneId": {
              "type": "integer",
              "description": "The ID of the telephone number that was removed"
            },
            "telephoneNumber": {
              "type": "string",
              "description": "The telephone number that was removed"
            },
            "countryCode": {
              "type": "string",
              "description": "The country code associated with the telephone number (e.g., +1 for US)"
            }
          },
          "required": [ "telephoneId", "telephoneNumber", "countryCode" ]
        },
        "removedBySource": {
          "type": "string",
          "description": "Indicates the source that performed the deletion (e.g., My Christies)"
        },
        "removalReason": {
          "type": "string",
          "description": "The reason for the removal (e.g., requested by user, telephone change)"
        },
        "removedAtUtc": {
          "type": "string",
          "description": "The date and time when the telephone was marked for removal (ISO 8601 format)"
        }
      },
      "required": [ "clientId", "accountNumber", "telephoneRemoved", "removedBySource", "removedAtUtc" ]
    }
  },
  "required": [ "metadata", "data" ]
}