action neutrinoapi_phone_validate {
  label: "Phone Validate"
  description: "Parse, validate and get location information about a phone number"
  provider: neutrinoapi
  method: GET
  path: "/phone-validate"
  encoding: json
  input: {
    type: "object"
    properties: {
      "country-code": {
        type: "string"
      }
      ip: {
        type: "string"
      }
      number: {
        type: "string"
      }
    }
    required: ["number"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["country", "country-code", "country-code3", "currency-code", "international-calling-code", "international-number", "is-mobile", "local-number", "location", "prefix-network", "type", "valid"]
    properties: {
      country: {
        type: "string"
        description: "The phone number country"
      }
      "country-code": {
        type: "string"
        description: "The phone number country as an ISO 2-letter country code"
      }
      "country-code3": {
        type: "string"
        description: "The phone number country as an ISO 3-letter country code"
      }
      "currency-code": {
        type: "string"
        description: "ISO 4217 currency code associated with the country"
      }
      "international-calling-code": {
        type: "string"
        description: "The international calling code"
      }
      "international-number": {
        type: "string"
        description: "The number represented in full international format (E.164)"
      }
      "is-mobile": {
        type: "boolean"
        description: "True if this is a mobile number. If the number type is unknown this value will be false"
      }
      "local-number": {
        type: "string"
        description: "The number represented in local dialing format"
      }
      location: {
        type: "string"
        description: "The phone number location. Could be the city, region or country depending on the type of number"
      }
      "prefix-network": {
        type: "string"
        description: "The network/carrier who owns the prefix (this only works for some countries, use HLR lookup for global network detection)"
      }
      type: {
        type: "string"
        description: "The number type based on the number prefix. <br>Possible values are: <br> <ul> <li>mobile</li> <li>fixed-line</li> <li>premium-rate</li> <li>toll-free</li> <li>voip</li> <li>unknown (use HLR lookup)</li> </ul>"
      }
      valid: {
        type: "boolean"
        description: "Is this a valid phone number"
      }
    }
  }
}