zaproxy/src/search.js

ZAP API Client for Node.js

/* Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2023 the ZAP development team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict'

/**
 * This file was automatically generated.
 */
function Search (clientApi) {
  this.api = clientApi
}

/**
 * Returns the URLs of the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which URLs should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.urlsByUrlRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/urlsByUrlRegex/', params)
}

/**
 * Returns the URLs of the HTTP messages that match the given regular expression in their history Tags optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which URLs should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.urlsByTagRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/urlsByTagRegex/', params)
}

/**
 * Returns the URLs of the HTTP messages that match the given regular expression in their note optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which URLs should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.urlsByNoteRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/urlsByNoteRegex/', params)
}

/**
 * Returns the URLs of the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which URLs should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.urlsByRequestRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/urlsByRequestRegex/', params)
}

/**
 * Returns the URLs of the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which URLs should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.urlsByResponseRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/urlsByResponseRegex/', params)
}

/**
 * Returns the URLs of the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which URLs should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.urlsByHeaderRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/urlsByHeaderRegex/', params)
}

/**
 * Returns the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which messages should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.messagesByUrlRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/messagesByUrlRegex/', params)
}

/**
 * Returns the HTTP messages that match the given regular expression in their history Tags optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which messages should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.messagesByTagRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/messagesByTagRegex/', params)
}

/**
 * Returns the HTTP messages that match the given regular expression in their note optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which messages should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.messagesByNoteRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/messagesByNoteRegex/', params)
}

/**
 * Returns the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which messages should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.messagesByRequestRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/messagesByRequestRegex/', params)
}

/**
 * Returns the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which messages should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.messagesByResponseRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/messagesByResponseRegex/', params)
}

/**
 * Returns the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which messages should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.messagesByHeaderRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/view/messagesByHeaderRegex/', params)
}

/**
 * Returns the HTTP messages, in HAR format, that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.harByUrlRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/other/harByUrlRegex/', params, 'other')
}

/**
 * Returns the HTTP messages, in HAR format, that match the given regular expression in their history Tags optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which URLs should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.harByTagRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/other/harByTagRegex/', params, 'other')
}

/**
 * Returns the HTTP messages, in HAR format, that match the given regular expression in their note optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl - The highest URL in the Sites tree under which URLs should be included.
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.harByNoteRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/other/harByNoteRegex/', params, 'other')
}

/**
 * Returns the HTTP messages, in HAR format, that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.harByRequestRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/other/harByRequestRegex/', params, 'other')
}

/**
 * Returns the HTTP messages, in HAR format, that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.harByResponseRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/other/harByResponseRegex/', params, 'other')
}

/**
 * Returns the HTTP messages, in HAR format, that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
 * @param {string} regex
 * @param {string} baseurl
 * @param {string} start
 * @param {string} count
 **/
Search.prototype.harByHeaderRegex = function (args) {
  const params = { regex: args.regex }
  if (args.baseurl && args.baseurl !== null) {
    params.baseurl = args.baseurl
  }
  if (args.start && args.start !== null) {
    params.start = args.start
  }
  if (args.count && args.count !== null) {
    params.count = args.count
  }
  return this.api.request('/search/other/harByHeaderRegex/', params, 'other')
}

module.exports = Search