{
  "swagger": "2.0",
  "info": {
    "version": "v1",
    "title": "ZinMobi API"
  },
  "host": "test.api.zinmobi.com",
  "schemes": [
    "http"
  ],
  "paths": {
    "/BadNumber": {
      "get": {
        "tags": [
          "BadNumber"
        ],
        "operationId": "BadNumber_Get",
        "consumes": [],
        "produces": [
          "application/json",
          "text/json"
        ],
        "parameters": [
          {
            "name": "companyId",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "timeZone",
            "in": "query",
            "required": false,
            "type": "string",
            "enum": [
              "UTC-11",
              "Samoa Standard Time",
              "Hawaiian Standard Time",
              "Alaskan Standard Time",
              "Pacific Standard Time (Mexico)",
              "Pacific Standard Time",
              "US Mountain Standard Time",
              "Mountain Standard Time (Mexico)",
              "Mountain Standard Time",
              "Central America Standard Time",
              "Central Standard Time",
              "Central Standard Time (Mexico)",
              "Canada Central Standard Time",
              "SA Pacific Standard Time",
              "Eastern Standard Time",
              "US Eastern Standard Time",
              "Venezuela Standard Time",
              "Paraguay Standard Time",
              "Atlantic Standard Time",
              "Central Brazilian Standard Time",
              "SA Western Standard Time",
              "Pacific SA Standard Time",
              "Newfoundland Standard Time",
              "E. South America Standard Time",
              "Argentina Standard Time",
              "SA Eastern Standard Time",
              "Greenland Standard Time",
              "Montevideo Standard Time",
              "UTC-02",
              "Mid-Atlantic Standard Time",
              "Azores Standard Time",
              "Cape Verde Standard Time",
              "Morocco Standard Time",
              "UTC",
              "GMT Standard Time",
              "Greenwich Standard Time",
              "W. Europe Standard Time",
              "Central Europe Standard Time",
              "Romance Standard Time",
              "Central European Standard Time",
              "W. Central Africa Standard Time",
              "Namibia Standard Time",
              "Jordan Standard Time",
              "GTB Standard Time",
              "Middle East Standard Time",
              "Egypt Standard Time",
              "Syria Standard Time",
              "South Africa Standard Time",
              "FLE Standard Time",
              "Israel Standard Time",
              "E. Europe Standard Time",
              "Arabic Standard Time",
              "Arab Standard Time",
              "Russian Standard Time",
              "E. Africa Standard Time",
              "Iran Standard Time",
              "Arabian Standard Time",
              "Azerbaijan Standard Time",
              "Mauritius Standard Time",
              "Georgian Standard Time",
              "Caucasus Standard Time",
              "Afghanistan Standard Time",
              "Ekaterinburg Standard Time",
              "Pakistan Standard Time",
              "West Asia Standard Time",
              "India Standard Time",
              "Sri Lanka Standard Time",
              "Nepal Standard Time",
              "Central Asia Standard Time",
              "Bangladesh Standard Time",
              "N. Central Asia Standard Time",
              "Myanmar Standard Time",
              "SE Asia Standard Time",
              "North Asia Standard Time",
              "China Standard Time",
              "North Asia East Standard Time",
              "Singapore Standard Time",
              "W. Australia Standard Time",
              "Taipei Standard Time",
              "Ulaanbaatar Standard Time",
              "Tokyo Standard Time",
              "Korea Standard Time",
              "Yakutsk Standard Time",
              "Cen. Australia Standard Time",
              "AUS Central Standard Time",
              "E. Australia Standard Time",
              "AUS Eastern Standard Time",
              "West Pacific Standard Time",
              "Tasmania Standard Time",
              "Vladivostok Standard Time",
              "Central Pacific Standard Time",
              "New Zealand Standard Time",
              "UTC+12",
              "Fiji Standard Time",
              "Kamchatka Standard Time",
              "Tonga Standard Time"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/BNRResults"
            }
          }
        }
      }
    },
    "/Companies": {
      "get": {
        "tags": [
          "Companies"
        ],
        "operationId": "Companies_Get",
        "consumes": [],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/CompanyData"
              }
            }
          }
        }
      }
    },
    "/Contacts": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "operationId": "Contacts_Get",
        "consumes": [],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "companyId",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "subCompanyId",
            "in": "query",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "phoneNumber",
            "in": "query",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Contact"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Contacts"
        ],
        "operationId": "Contacts_Post",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json"
        ],
        "parameters": [
          {
            "name": "contactInfo",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ContactInfo"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ValidationResult"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Contacts"
        ],
        "operationId": "Contacts_Delete",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json"
        ],
        "parameters": [
          {
            "name": "query",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ContactQuery"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ValidationResult"
            }
          }
        }
      }
    },
    "/Countries": {
      "get": {
        "tags": [
          "Countries"
        ],
        "operationId": "Countries_Get",
        "consumes": [],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "/OptIns": {
      "get": {
        "tags": [
          "OptIns"
        ],
        "operationId": "OptIns_Get",
        "consumes": [],
        "produces": [
          "application/json",
          "text/json"
        ],
        "parameters": [
          {
            "name": "companyId",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "source",
            "in": "query",
            "required": false,
            "type": "string",
            "enum": [
              "SMS",
              "API",
              "WebOrFile",
              "SMSAndAPI",
              "SMSAndWebOrFile",
              "APIAndWebOrFile",
              "All"
            ]
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "timeZone",
            "in": "query",
            "required": false,
            "type": "string",
            "enum": [
              "UTC-11",
              "Samoa Standard Time",
              "Hawaiian Standard Time",
              "Alaskan Standard Time",
              "Pacific Standard Time (Mexico)",
              "Pacific Standard Time",
              "US Mountain Standard Time",
              "Mountain Standard Time (Mexico)",
              "Mountain Standard Time",
              "Central America Standard Time",
              "Central Standard Time",
              "Central Standard Time (Mexico)",
              "Canada Central Standard Time",
              "SA Pacific Standard Time",
              "Eastern Standard Time",
              "US Eastern Standard Time",
              "Venezuela Standard Time",
              "Paraguay Standard Time",
              "Atlantic Standard Time",
              "Central Brazilian Standard Time",
              "SA Western Standard Time",
              "Pacific SA Standard Time",
              "Newfoundland Standard Time",
              "E. South America Standard Time",
              "Argentina Standard Time",
              "SA Eastern Standard Time",
              "Greenland Standard Time",
              "Montevideo Standard Time",
              "UTC-02",
              "Mid-Atlantic Standard Time",
              "Azores Standard Time",
              "Cape Verde Standard Time",
              "Morocco Standard Time",
              "UTC",
              "GMT Standard Time",
              "Greenwich Standard Time",
              "W. Europe Standard Time",
              "Central Europe Standard Time",
              "Romance Standard Time",
              "Central European Standard Time",
              "W. Central Africa Standard Time",
              "Namibia Standard Time",
              "Jordan Standard Time",
              "GTB Standard Time",
              "Middle East Standard Time",
              "Egypt Standard Time",
              "Syria Standard Time",
              "South Africa Standard Time",
              "FLE Standard Time",
              "Israel Standard Time",
              "E. Europe Standard Time",
              "Arabic Standard Time",
              "Arab Standard Time",
              "Russian Standard Time",
              "E. Africa Standard Time",
              "Iran Standard Time",
              "Arabian Standard Time",
              "Azerbaijan Standard Time",
              "Mauritius Standard Time",
              "Georgian Standard Time",
              "Caucasus Standard Time",
              "Afghanistan Standard Time",
              "Ekaterinburg Standard Time",
              "Pakistan Standard Time",
              "West Asia Standard Time",
              "India Standard Time",
              "Sri Lanka Standard Time",
              "Nepal Standard Time",
              "Central Asia Standard Time",
              "Bangladesh Standard Time",
              "N. Central Asia Standard Time",
              "Myanmar Standard Time",
              "SE Asia Standard Time",
              "North Asia Standard Time",
              "China Standard Time",
              "North Asia East Standard Time",
              "Singapore Standard Time",
              "W. Australia Standard Time",
              "Taipei Standard Time",
              "Ulaanbaatar Standard Time",
              "Tokyo Standard Time",
              "Korea Standard Time",
              "Yakutsk Standard Time",
              "Cen. Australia Standard Time",
              "AUS Central Standard Time",
              "E. Australia Standard Time",
              "AUS Eastern Standard Time",
              "West Pacific Standard Time",
              "Tasmania Standard Time",
              "Vladivostok Standard Time",
              "Central Pacific Standard Time",
              "New Zealand Standard Time",
              "UTC+12",
              "Fiji Standard Time",
              "Kamchatka Standard Time",
              "Tonga Standard Time"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/OptInResults"
            }
          }
        }
      }
    },
    "/OptOuts": {
      "get": {
        "tags": [
          "OptOuts"
        ],
        "operationId": "OptOuts_Get",
        "consumes": [],
        "produces": [
          "application/json",
          "text/json"
        ],
        "parameters": [
          {
            "name": "companyId",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "source",
            "in": "query",
            "required": false,
            "type": "string",
            "enum": [
              "SMS",
              "API",
              "WebOrFile",
              "SMSAndAPI",
              "SMSAndWebOrFile",
              "APIAndWebOrFile",
              "All"
            ]
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "timeZone",
            "in": "query",
            "required": false,
            "type": "string",
            "enum": [
              "UTC-11",
              "Samoa Standard Time",
              "Hawaiian Standard Time",
              "Alaskan Standard Time",
              "Pacific Standard Time (Mexico)",
              "Pacific Standard Time",
              "US Mountain Standard Time",
              "Mountain Standard Time (Mexico)",
              "Mountain Standard Time",
              "Central America Standard Time",
              "Central Standard Time",
              "Central Standard Time (Mexico)",
              "Canada Central Standard Time",
              "SA Pacific Standard Time",
              "Eastern Standard Time",
              "US Eastern Standard Time",
              "Venezuela Standard Time",
              "Paraguay Standard Time",
              "Atlantic Standard Time",
              "Central Brazilian Standard Time",
              "SA Western Standard Time",
              "Pacific SA Standard Time",
              "Newfoundland Standard Time",
              "E. South America Standard Time",
              "Argentina Standard Time",
              "SA Eastern Standard Time",
              "Greenland Standard Time",
              "Montevideo Standard Time",
              "UTC-02",
              "Mid-Atlantic Standard Time",
              "Azores Standard Time",
              "Cape Verde Standard Time",
              "Morocco Standard Time",
              "UTC",
              "GMT Standard Time",
              "Greenwich Standard Time",
              "W. Europe Standard Time",
              "Central Europe Standard Time",
              "Romance Standard Time",
              "Central European Standard Time",
              "W. Central Africa Standard Time",
              "Namibia Standard Time",
              "Jordan Standard Time",
              "GTB Standard Time",
              "Middle East Standard Time",
              "Egypt Standard Time",
              "Syria Standard Time",
              "South Africa Standard Time",
              "FLE Standard Time",
              "Israel Standard Time",
              "E. Europe Standard Time",
              "Arabic Standard Time",
              "Arab Standard Time",
              "Russian Standard Time",
              "E. Africa Standard Time",
              "Iran Standard Time",
              "Arabian Standard Time",
              "Azerbaijan Standard Time",
              "Mauritius Standard Time",
              "Georgian Standard Time",
              "Caucasus Standard Time",
              "Afghanistan Standard Time",
              "Ekaterinburg Standard Time",
              "Pakistan Standard Time",
              "West Asia Standard Time",
              "India Standard Time",
              "Sri Lanka Standard Time",
              "Nepal Standard Time",
              "Central Asia Standard Time",
              "Bangladesh Standard Time",
              "N. Central Asia Standard Time",
              "Myanmar Standard Time",
              "SE Asia Standard Time",
              "North Asia Standard Time",
              "China Standard Time",
              "North Asia East Standard Time",
              "Singapore Standard Time",
              "W. Australia Standard Time",
              "Taipei Standard Time",
              "Ulaanbaatar Standard Time",
              "Tokyo Standard Time",
              "Korea Standard Time",
              "Yakutsk Standard Time",
              "Cen. Australia Standard Time",
              "AUS Central Standard Time",
              "E. Australia Standard Time",
              "AUS Eastern Standard Time",
              "West Pacific Standard Time",
              "Tasmania Standard Time",
              "Vladivostok Standard Time",
              "Central Pacific Standard Time",
              "New Zealand Standard Time",
              "UTC+12",
              "Fiji Standard Time",
              "Kamchatka Standard Time",
              "Tonga Standard Time"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/OptOutResults"
            }
          }
        }
      }
    },
    "/Resubscribed": {
      "get": {
        "tags": [
          "Resubscribed"
        ],
        "operationId": "Resubscribed_Get",
        "consumes": [],
        "produces": [
          "application/json",
          "text/json"
        ],
        "parameters": [
          {
            "name": "companyId",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "source",
            "in": "query",
            "required": false,
            "type": "string",
            "enum": [
              "SMS",
              "API",
              "WebOrFile",
              "SMSAndAPI",
              "SMSAndWebOrFile",
              "APIAndWebOrFile",
              "All"
            ]
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "timeZone",
            "in": "query",
            "required": false,
            "type": "string",
            "enum": [
              "UTC-11",
              "Samoa Standard Time",
              "Hawaiian Standard Time",
              "Alaskan Standard Time",
              "Pacific Standard Time (Mexico)",
              "Pacific Standard Time",
              "US Mountain Standard Time",
              "Mountain Standard Time (Mexico)",
              "Mountain Standard Time",
              "Central America Standard Time",
              "Central Standard Time",
              "Central Standard Time (Mexico)",
              "Canada Central Standard Time",
              "SA Pacific Standard Time",
              "Eastern Standard Time",
              "US Eastern Standard Time",
              "Venezuela Standard Time",
              "Paraguay Standard Time",
              "Atlantic Standard Time",
              "Central Brazilian Standard Time",
              "SA Western Standard Time",
              "Pacific SA Standard Time",
              "Newfoundland Standard Time",
              "E. South America Standard Time",
              "Argentina Standard Time",
              "SA Eastern Standard Time",
              "Greenland Standard Time",
              "Montevideo Standard Time",
              "UTC-02",
              "Mid-Atlantic Standard Time",
              "Azores Standard Time",
              "Cape Verde Standard Time",
              "Morocco Standard Time",
              "UTC",
              "GMT Standard Time",
              "Greenwich Standard Time",
              "W. Europe Standard Time",
              "Central Europe Standard Time",
              "Romance Standard Time",
              "Central European Standard Time",
              "W. Central Africa Standard Time",
              "Namibia Standard Time",
              "Jordan Standard Time",
              "GTB Standard Time",
              "Middle East Standard Time",
              "Egypt Standard Time",
              "Syria Standard Time",
              "South Africa Standard Time",
              "FLE Standard Time",
              "Israel Standard Time",
              "E. Europe Standard Time",
              "Arabic Standard Time",
              "Arab Standard Time",
              "Russian Standard Time",
              "E. Africa Standard Time",
              "Iran Standard Time",
              "Arabian Standard Time",
              "Azerbaijan Standard Time",
              "Mauritius Standard Time",
              "Georgian Standard Time",
              "Caucasus Standard Time",
              "Afghanistan Standard Time",
              "Ekaterinburg Standard Time",
              "Pakistan Standard Time",
              "West Asia Standard Time",
              "India Standard Time",
              "Sri Lanka Standard Time",
              "Nepal Standard Time",
              "Central Asia Standard Time",
              "Bangladesh Standard Time",
              "N. Central Asia Standard Time",
              "Myanmar Standard Time",
              "SE Asia Standard Time",
              "North Asia Standard Time",
              "China Standard Time",
              "North Asia East Standard Time",
              "Singapore Standard Time",
              "W. Australia Standard Time",
              "Taipei Standard Time",
              "Ulaanbaatar Standard Time",
              "Tokyo Standard Time",
              "Korea Standard Time",
              "Yakutsk Standard Time",
              "Cen. Australia Standard Time",
              "AUS Central Standard Time",
              "E. Australia Standard Time",
              "AUS Eastern Standard Time",
              "West Pacific Standard Time",
              "Tasmania Standard Time",
              "Vladivostok Standard Time",
              "Central Pacific Standard Time",
              "New Zealand Standard Time",
              "UTC+12",
              "Fiji Standard Time",
              "Kamchatka Standard Time",
              "Tonga Standard Time"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/ResubscribedResults"
            }
          }
        }
      }
    },
    "/Tags": {
      "get": {
        "tags": [
          "Tags"
        ],
        "operationId": "Tags_Get",
        "consumes": [],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TagData"
              }
            }
          }
        }
      }
    }
  },
  "definitions": {
    "BNRQuery": {
      "required": [
        "CompanyId"
      ],
      "type": "object",
      "properties": {
        "CompanyId": {
          "format": "int32",
          "type": "integer"
        },
        "From": {
          "format": "date-time",
          "type": "string"
        },
        "To": {
          "format": "date-time",
          "type": "string"
        },
        "TimeZone": {
          "enum": [
            "UTC-11",
            "Samoa Standard Time",
            "Hawaiian Standard Time",
            "Alaskan Standard Time",
            "Pacific Standard Time (Mexico)",
            "Pacific Standard Time",
            "US Mountain Standard Time",
            "Mountain Standard Time (Mexico)",
            "Mountain Standard Time",
            "Central America Standard Time",
            "Central Standard Time",
            "Central Standard Time (Mexico)",
            "Canada Central Standard Time",
            "SA Pacific Standard Time",
            "Eastern Standard Time",
            "US Eastern Standard Time",
            "Venezuela Standard Time",
            "Paraguay Standard Time",
            "Atlantic Standard Time",
            "Central Brazilian Standard Time",
            "SA Western Standard Time",
            "Pacific SA Standard Time",
            "Newfoundland Standard Time",
            "E. South America Standard Time",
            "Argentina Standard Time",
            "SA Eastern Standard Time",
            "Greenland Standard Time",
            "Montevideo Standard Time",
            "UTC-02",
            "Mid-Atlantic Standard Time",
            "Azores Standard Time",
            "Cape Verde Standard Time",
            "Morocco Standard Time",
            "UTC",
            "GMT Standard Time",
            "Greenwich Standard Time",
            "W. Europe Standard Time",
            "Central Europe Standard Time",
            "Romance Standard Time",
            "Central European Standard Time",
            "W. Central Africa Standard Time",
            "Namibia Standard Time",
            "Jordan Standard Time",
            "GTB Standard Time",
            "Middle East Standard Time",
            "Egypt Standard Time",
            "Syria Standard Time",
            "South Africa Standard Time",
            "FLE Standard Time",
            "Israel Standard Time",
            "E. Europe Standard Time",
            "Arabic Standard Time",
            "Arab Standard Time",
            "Russian Standard Time",
            "E. Africa Standard Time",
            "Iran Standard Time",
            "Arabian Standard Time",
            "Azerbaijan Standard Time",
            "Mauritius Standard Time",
            "Georgian Standard Time",
            "Caucasus Standard Time",
            "Afghanistan Standard Time",
            "Ekaterinburg Standard Time",
            "Pakistan Standard Time",
            "West Asia Standard Time",
            "India Standard Time",
            "Sri Lanka Standard Time",
            "Nepal Standard Time",
            "Central Asia Standard Time",
            "Bangladesh Standard Time",
            "N. Central Asia Standard Time",
            "Myanmar Standard Time",
            "SE Asia Standard Time",
            "North Asia Standard Time",
            "China Standard Time",
            "North Asia East Standard Time",
            "Singapore Standard Time",
            "W. Australia Standard Time",
            "Taipei Standard Time",
            "Ulaanbaatar Standard Time",
            "Tokyo Standard Time",
            "Korea Standard Time",
            "Yakutsk Standard Time",
            "Cen. Australia Standard Time",
            "AUS Central Standard Time",
            "E. Australia Standard Time",
            "AUS Eastern Standard Time",
            "West Pacific Standard Time",
            "Tasmania Standard Time",
            "Vladivostok Standard Time",
            "Central Pacific Standard Time",
            "New Zealand Standard Time",
            "UTC+12",
            "Fiji Standard Time",
            "Kamchatka Standard Time",
            "Tonga Standard Time"
          ],
          "type": "string"
        }
      }
    },
    "BNRResults": {
      "type": "object",
      "properties": {
        "ReturnObject": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/BNRModel"
          },
          "readOnly": true
        },
        "IsSuccess": {
          "type": "boolean",
          "readOnly": true
        },
        "ErrorText": {
          "type": "string",
          "readOnly": true
        },
        "ErrorType": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "BNRModel": {
      "type": "object",
      "properties": {
        "PhoneNumber": {
          "type": "string"
        },
        "BNRDate": {
          "format": "date-time",
          "type": "string"
        }
      }
    },
    "CompanyData": {
      "type": "object",
      "properties": {
        "Id": {
          "format": "int32",
          "type": "integer"
        },
        "Name": {
          "type": "string"
        },
        "SubCompanies": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/SubCompanyData"
          },
          "readOnly": true
        }
      }
    },
    "SubCompanyData": {
      "type": "object",
      "properties": {
        "Id": {
          "format": "int32",
          "type": "integer"
        },
        "Name": {
          "type": "string"
        }
      }
    },
    "ContactInfo": {
      "required": [
        "PhoneNumber",
        "CompanyId"
      ],
      "type": "object",
      "properties": {
        "PhoneNumber": {
          "type": "string"
        },
        "FirstName": {
          "type": "string"
        },
        "Surname": {
          "type": "string"
        },
        "CountryName": {
          "type": "string"
        },
        "ExplicitOptIn": {
          "type": "boolean"
        },
        "ExplicitOptOut": {
          "type": "boolean"
        },
        "CompanyId": {
          "format": "int32",
          "type": "integer"
        },
        "SubCompanyId": {
          "format": "int32",
          "type": "integer"
        },
        "Tags": {
          "type": "array",
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "readOnly": true
        }
      }
    },
    "ValidationResult": {
      "type": "object",
      "properties": {
        "IsSuccess": {
          "type": "boolean",
          "readOnly": true
        },
        "ErrorText": {
          "type": "string",
          "readOnly": true
        },
        "ErrorType": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "ContactQuery": {
      "required": [
        "CompanyId",
        "PhoneNumber"
      ],
      "type": "object",
      "properties": {
        "CompanyId": {
          "format": "int32",
          "type": "integer"
        },
        "SubCompanyId": {
          "format": "int32",
          "type": "integer"
        },
        "PhoneNumber": {
          "type": "string"
        }
      }
    },
    "Contact": {
      "type": "object",
      "properties": {
        "PhoneNumber": {
          "type": "string"
        },
        "FirstName": {
          "type": "string"
        },
        "Surname": {
          "type": "string"
        },
        "OptOutStatus": {
          "enum": [
            "OptedIn",
            "OptedOut",
            "Resubscribed",
            "BNR"
          ],
          "type": "string"
        },
        "CompanyId": {
          "format": "int32",
          "type": "integer"
        },
        "SubCompanyId": {
          "format": "int32",
          "type": "integer"
        },
        "Tags": {
          "type": "array",
          "items": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    },
    "OptInOutQuery": {
      "required": [
        "CompanyId"
      ],
      "type": "object",
      "properties": {
        "CompanyId": {
          "format": "int32",
          "type": "integer"
        },
        "Source": {
          "enum": [
            "SMS",
            "API",
            "WebOrFile",
            "SMSAndAPI",
            "SMSAndWebOrFile",
            "APIAndWebOrFile",
            "All"
          ],
          "type": "string"
        },
        "From": {
          "format": "date-time",
          "type": "string"
        },
        "To": {
          "format": "date-time",
          "type": "string"
        },
        "TimeZone": {
          "enum": [
            "UTC-11",
            "Samoa Standard Time",
            "Hawaiian Standard Time",
            "Alaskan Standard Time",
            "Pacific Standard Time (Mexico)",
            "Pacific Standard Time",
            "US Mountain Standard Time",
            "Mountain Standard Time (Mexico)",
            "Mountain Standard Time",
            "Central America Standard Time",
            "Central Standard Time",
            "Central Standard Time (Mexico)",
            "Canada Central Standard Time",
            "SA Pacific Standard Time",
            "Eastern Standard Time",
            "US Eastern Standard Time",
            "Venezuela Standard Time",
            "Paraguay Standard Time",
            "Atlantic Standard Time",
            "Central Brazilian Standard Time",
            "SA Western Standard Time",
            "Pacific SA Standard Time",
            "Newfoundland Standard Time",
            "E. South America Standard Time",
            "Argentina Standard Time",
            "SA Eastern Standard Time",
            "Greenland Standard Time",
            "Montevideo Standard Time",
            "UTC-02",
            "Mid-Atlantic Standard Time",
            "Azores Standard Time",
            "Cape Verde Standard Time",
            "Morocco Standard Time",
            "UTC",
            "GMT Standard Time",
            "Greenwich Standard Time",
            "W. Europe Standard Time",
            "Central Europe Standard Time",
            "Romance Standard Time",
            "Central European Standard Time",
            "W. Central Africa Standard Time",
            "Namibia Standard Time",
            "Jordan Standard Time",
            "GTB Standard Time",
            "Middle East Standard Time",
            "Egypt Standard Time",
            "Syria Standard Time",
            "South Africa Standard Time",
            "FLE Standard Time",
            "Israel Standard Time",
            "E. Europe Standard Time",
            "Arabic Standard Time",
            "Arab Standard Time",
            "Russian Standard Time",
            "E. Africa Standard Time",
            "Iran Standard Time",
            "Arabian Standard Time",
            "Azerbaijan Standard Time",
            "Mauritius Standard Time",
            "Georgian Standard Time",
            "Caucasus Standard Time",
            "Afghanistan Standard Time",
            "Ekaterinburg Standard Time",
            "Pakistan Standard Time",
            "West Asia Standard Time",
            "India Standard Time",
            "Sri Lanka Standard Time",
            "Nepal Standard Time",
            "Central Asia Standard Time",
            "Bangladesh Standard Time",
            "N. Central Asia Standard Time",
            "Myanmar Standard Time",
            "SE Asia Standard Time",
            "North Asia Standard Time",
            "China Standard Time",
            "North Asia East Standard Time",
            "Singapore Standard Time",
            "W. Australia Standard Time",
            "Taipei Standard Time",
            "Ulaanbaatar Standard Time",
            "Tokyo Standard Time",
            "Korea Standard Time",
            "Yakutsk Standard Time",
            "Cen. Australia Standard Time",
            "AUS Central Standard Time",
            "E. Australia Standard Time",
            "AUS Eastern Standard Time",
            "West Pacific Standard Time",
            "Tasmania Standard Time",
            "Vladivostok Standard Time",
            "Central Pacific Standard Time",
            "New Zealand Standard Time",
            "UTC+12",
            "Fiji Standard Time",
            "Kamchatka Standard Time",
            "Tonga Standard Time"
          ],
          "type": "string"
        }
      }
    },
    "OptInResults": {
      "type": "object",
      "properties": {
        "ReturnObject": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/OptInModel"
          },
          "readOnly": true
        },
        "IsSuccess": {
          "type": "boolean",
          "readOnly": true
        },
        "ErrorText": {
          "type": "string",
          "readOnly": true
        },
        "ErrorType": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "OptInModel": {
      "type": "object",
      "properties": {
        "PhoneNumber": {
          "type": "string"
        },
        "OptInDate": {
          "format": "date-time",
          "type": "string"
        }
      }
    },
    "OptOutResults": {
      "type": "object",
      "properties": {
        "ReturnObject": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/OptOutModel"
          },
          "readOnly": true
        },
        "IsSuccess": {
          "type": "boolean",
          "readOnly": true
        },
        "ErrorText": {
          "type": "string",
          "readOnly": true
        },
        "ErrorType": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "OptOutModel": {
      "type": "object",
      "properties": {
        "PhoneNumber": {
          "type": "string"
        },
        "OptOutDate": {
          "format": "date-time",
          "type": "string"
        }
      }
    },
    "ResubscribedResults": {
      "type": "object",
      "properties": {
        "ReturnObject": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ResubscribedModel"
          },
          "readOnly": true
        },
        "IsSuccess": {
          "type": "boolean",
          "readOnly": true
        },
        "ErrorText": {
          "type": "string",
          "readOnly": true
        },
        "ErrorType": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "ResubscribedModel": {
      "type": "object",
      "properties": {
        "PhoneNumber": {
          "type": "string"
        },
        "ResubscribedDate": {
          "format": "date-time",
          "type": "string"
        }
      }
    },
    "TagData": {
      "type": "object",
      "properties": {
        "Id": {
          "format": "int32",
          "type": "integer"
        },
        "Name": {
          "type": "string"
        }
      }
    }
  },
  "securityDefinitions": {
    "ApiKey": {
      "type": "apiKey",
      "description": "API Key Authentication",
      "name": "ApiKey",
      "in": "header"
    }
  }
}