petstroepack 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 105ac697134f4526a5c84c7f9e6e2468094409e47322bb7565df6a6b6d66f113
+  data.tar.gz: a4dfa7bdbc8668a5dfc4454ca1bb99666c325bf0a90ada030fc5937f528b0ecc
+SHA512:
+  metadata.gz: 0f220bbef825602fd490256ec8e713a334718cf1b468f68222d6bfcb9fc5689a8d829bb0563c0a9ff3eda26f11ce05669d09df7cdfb1a4384f1d56051d3c395f
+  data.tar.gz: '059030aee21bc5d365b556c4862154a004e7dff39df2f396c7478004ed1daa28130e639ce473c3f74f052c3114ae3fb59075e6c8500b6829b3a534959eccd5b9'

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2023 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,86 @@
+
+# Getting Started with CTD - Documentation
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install petstroepack -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'petstroepack', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the petstroepack gem](https://rubygems.org/gems/petstroepack/versions/1.0.0).
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `host` | `String` | *Default*: `'HostValue'` |
+| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| `authorization` | `String` |  |
+
+The API client can be initialized as follows:
+
+```ruby
+client = CtdDocumentation::Client.new(
+  authorization: 'Authorization',
+  environment: Environment::PRODUCTION,
+  host: 'HostValue'
+)
+```
+
+## Authorization
+
+This API uses `Custom Header Signature`.
+
+## List of APIs
+
+* [Tasks Queries](doc/controllers/tasks-queries.md)
+* [Custom Attributes Categories](doc/controllers/custom-attributes-categories.md)
+* [Login](doc/controllers/login.md)
+* [Assets](doc/controllers/assets.md)
+* [Alerts](doc/controllers/alerts.md)
+* [Tasks](doc/controllers/tasks.md)
+* [Queries](doc/controllers/queries.md)
+* [Insights](doc/controllers/insights.md)
+* [Sites](doc/controllers/sites.md)
+* [Activities](doc/controllers/activities.md)
+* [License](doc/controllers/license.md)
+* [Users](doc/controllers/users.md)
+* [Groups](doc/controllers/groups.md)
+* [Sensors](doc/controllers/sensors.md)
+* [Events](doc/controllers/events.md)
+
+## Classes Documentation
+
+* [Utility Classes](doc/utility-classes.md)
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
+

data/lib/ctd_documentation/api_helper.rb

@@ -0,0 +1,10 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/ctd_documentation/client.rb

@@ -0,0 +1,140 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  #  ctd_documentation client class.
+  class Client
+    attr_reader :config, :auth_managers
+
+    # Access to login controller.
+    # @return [LoginController] Returns the controller instance.
+    def login
+      @login ||= LoginController.new @global_configuration
+    end
+
+    # Access to assets controller.
+    # @return [AssetsController] Returns the controller instance.
+    def assets
+      @assets ||= AssetsController.new @global_configuration
+    end
+
+    # Access to alerts controller.
+    # @return [AlertsController] Returns the controller instance.
+    def alerts
+      @alerts ||= AlertsController.new @global_configuration
+    end
+
+    # Access to tasks controller.
+    # @return [TasksController] Returns the controller instance.
+    def tasks
+      @tasks ||= TasksController.new @global_configuration
+    end
+
+    # Access to tasks_queries controller.
+    # @return [TasksQueriesController] Returns the controller instance.
+    def tasks_queries
+      @tasks_queries ||= TasksQueriesController.new @global_configuration
+    end
+
+    # Access to queries controller.
+    # @return [QueriesController] Returns the controller instance.
+    def queries
+      @queries ||= QueriesController.new @global_configuration
+    end
+
+    # Access to insights controller.
+    # @return [InsightsController] Returns the controller instance.
+    def insights
+      @insights ||= InsightsController.new @global_configuration
+    end
+
+    # Access to sites controller.
+    # @return [SitesController] Returns the controller instance.
+    def sites
+      @sites ||= SitesController.new @global_configuration
+    end
+
+    # Access to activities controller.
+    # @return [ActivitiesController] Returns the controller instance.
+    def activities
+      @activities ||= ActivitiesController.new @global_configuration
+    end
+
+    # Access to license controller.
+    # @return [LicenseController] Returns the controller instance.
+    def license
+      @license ||= LicenseController.new @global_configuration
+    end
+
+    # Access to users controller.
+    # @return [UsersController] Returns the controller instance.
+    def users
+      @users ||= UsersController.new @global_configuration
+    end
+
+    # Access to groups controller.
+    # @return [GroupsController] Returns the controller instance.
+    def groups
+      @groups ||= GroupsController.new @global_configuration
+    end
+
+    # Access to sensors controller.
+    # @return [SensorsController] Returns the controller instance.
+    def sensors
+      @sensors ||= SensorsController.new @global_configuration
+    end
+
+    # Access to custom_attributes_categories controller.
+    # @return [CustomAttributesCategoriesController] Returns the controller instance.
+    def custom_attributes_categories
+      @custom_attributes_categories ||= CustomAttributesCategoriesController.new @global_configuration
+    end
+
+    # Access to events controller.
+    # @return [EventsController] Returns the controller instance.
+    def events
+      @events ||= EventsController.new @global_configuration
+    end
+
+    def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
+                   max_retries: 0, retry_interval: 1, backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put], http_callback: nil,
+                   environment: Environment::PRODUCTION, host: 'HostValue',
+                   authorization: 'TODO: Replace', config: nil)
+      @config = if config.nil?
+                  Configuration.new(connection: connection, adapter: adapter,
+                                    timeout: timeout, max_retries: max_retries,
+                                    retry_interval: retry_interval,
+                                    backoff_factor: backoff_factor,
+                                    retry_statuses: retry_statuses,
+                                    retry_methods: retry_methods,
+                                    http_callback: http_callback,
+                                    environment: environment, host: host,
+                                    authorization: authorization)
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+                                                 .sdk_module(CtdDocumentation)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      ['global'].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['global'] = CustomHeaderAuth.new(http_client_config.authorization)
+    end
+  end
+end

data/lib/ctd_documentation/configuration.rb

@@ -0,0 +1,103 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :host, :authorization
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
+                   max_retries: 0, retry_interval: 1, backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put], http_callback: nil,
+                   environment: Environment::PRODUCTION, host: 'HostValue',
+                   authorization: 'TODO: Replace')
+
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback
+
+      # Current API environment
+      @environment = String(environment)
+
+      # host value
+      @host = host
+
+      # TODO: Replace
+      @authorization = authorization
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, host: nil, authorization: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      environment ||= self.environment
+      host ||= self.host
+      authorization ||= self.authorization
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback, environment: environment,
+                        host: host, authorization: authorization)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://{Host}'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      parameters = {
+        'Host' => { 'value' => host, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+  end
+end

data/lib/ctd_documentation/controllers/activities_controller.rb

@@ -0,0 +1,69 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # ActivitiesController
+  class ActivitiesController < BaseController
+    # Get Activities
+    # @param [Integer] page Optional parameter: Example:
+    # @param [Integer] per_page Optional parameter: Example:
+    # @param [String] alert_id__exact Optional parameter: Example:
+    # @param [String] asset_reference__exact Optional parameter: Example:
+    # @param [String] baseline__exact Optional parameter: Example:
+    # @param [String] site__exact Optional parameter: Example:
+    # @param [String] asset__exact Optional parameter: Example:
+    # @param [String] message__exact Optional parameter: Example:
+    # @param [String] comment__exact Optional parameter: Example:
+    # @param [Integer] id__exact Optional parameter: Example:
+    # @param [Integer] site_id__exact Optional parameter: Example:
+    # @param [Integer] type__exact Optional parameter: Example:
+    # @param [String] timestamp__exact Optional parameter: Example:
+    # @param [Integer] user_id__exact Optional parameter: Example:
+    # @param [Sort41Enum] sort Optional parameter: Sort order: add - for
+    # descending order
+    # @return [ActivitiesResponse] response from the API call
+    def get_activities(page: nil,
+                       per_page: nil,
+                       alert_id__exact: nil,
+                       asset_reference__exact: nil,
+                       baseline__exact: nil,
+                       site__exact: nil,
+                       asset__exact: nil,
+                       message__exact: nil,
+                       comment__exact: nil,
+                       id__exact: nil,
+                       site_id__exact: nil,
+                       type__exact: nil,
+                       timestamp__exact: nil,
+                       user_id__exact: nil,
+                       sort: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/ranger/activities',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .query_param(new_parameter(alert_id__exact, key: 'alert_id__exact'))
+                   .query_param(new_parameter(asset_reference__exact, key: 'asset_reference__exact'))
+                   .query_param(new_parameter(baseline__exact, key: 'baseline__exact'))
+                   .query_param(new_parameter(site__exact, key: 'site__exact'))
+                   .query_param(new_parameter(asset__exact, key: 'asset__exact'))
+                   .query_param(new_parameter(message__exact, key: 'message__exact'))
+                   .query_param(new_parameter(comment__exact, key: 'comment__exact'))
+                   .query_param(new_parameter(id__exact, key: 'id__exact'))
+                   .query_param(new_parameter(site_id__exact, key: 'site_id__exact'))
+                   .query_param(new_parameter(type__exact, key: 'type__exact'))
+                   .query_param(new_parameter(timestamp__exact, key: 'timestamp__exact'))
+                   .query_param(new_parameter(user_id__exact, key: 'user_id__exact'))
+                   .query_param(new_parameter(sort, key: 'sort'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ActivitiesResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/ctd_documentation/controllers/alerts_controller.rb

@@ -0,0 +1,170 @@
+# ctd_documentation
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CtdDocumentation
+  # AlertsController
+  class AlertsController < BaseController
+    # Retrieves a list of Alerts in CTD, with optional filters.
+    # Note - All filters are optional.
+    # @param [Integer] page Optional parameter: Page offset
+    # @param [Integer] per_page Optional parameter: Number of Alerts to pull on
+    # each page. (The maximum is 500).
+    # @param [String] asset_id__exact Optional parameter: Resource ID of the
+    # Asset
+    # @param [String] asset__exact Optional parameter: Example:
+    # @param [String] for_asset__exact Optional parameter: Example:
+    # @param [String] q__exact Optional parameter: Example:
+    # @param [String] primary_asset__exact Optional parameter: The resource ID
+    # of the primary asset that triggered the alert
+    # @param [String] non_primary_assets__exact Optional parameter: Resource IDs
+    # of the non-primary assets involved in the alert
+    # @param [String] virtual_zone__exact Optional parameter: The resource ID of
+    # the Zone that triggered the alert
+    # @param [String] alert_id__exact Optional parameter: The resource ID of the
+    # Alert.  You can add multiple IDs.
+    # @param [String] ot_alerts__exact Optional parameter: Example:
+    # @param [String] family__exact Optional parameter: Model family of the
+    # Asset involved in the Alert, for example Policy Violation. Alert Families
+    # appear in the Advanced Options filter of Alerts.
+    # @param [String] story_severity__exact Optional parameter: Example:
+    # @param [Integer] id__exact Optional parameter: Example:
+    # @param [Integer] site_id__exact Optional parameter: ID of the Site on
+    # which the Alert occurred
+    # @param [String] data__exact Optional parameter: Example:
+    # @param [String] description__exact Optional parameter: Description of the
+    # alert
+    # @param [Integer] type__exact Optional parameter: Alert Type, such as Known
+    # Threat, New Conflict Asset, etc.
+    # @param [Integer] category__exact Optional parameter: Alert Category: 0 =
+    # Integrity, 1 = Security
+    # @param [Integer] severity__exact Optional parameter: Alert Severity: 0 =
+    # Low, 1 = Medium, 2 = High, 3 = Critical
+    # @param [String] timestamp__exact Optional parameter: Timestamp on which
+    # the Alert occured. **Format:** YYYY-MM-DD**T**HH:MM:SS (in UTC)
+    # **Example:** 2022-11-01T16:22:05
+    # @param [String] last_updated__gte Optional parameter: The timestamp when
+    # the latest change on the Alert was made in the EMC.   **Format:**
+    # YYYY-MM-DD**T**HH:MM:SS (in UTC)  **Example:** 2022-11-01T16:22:05
+    # @param [TrueClass|FalseClass] relevant__exact Optional parameter:
+    # Example:
+    # @param [TrueClass|FalseClass] resolved__exact Optional parameter: Whether
+    # or not an Alert was resolved: True = resolved, False = not resolved
+    # @param [Integer] resolution__exact Optional parameter: Type of
+    # resolution.
+    # @param [String] protocol__exact Optional parameter: Protocol used in the
+    # alert, for example: S7Comm
+    # @param [Integer] score__exact Optional parameter: Alert Score calculated
+    # for this alert, on a score of 1-100
+    # @param [TrueClass|FalseClass] is_qualified__exact Optional parameter:
+    # Example:
+    # @param [Integer] network_id__exact Optional parameter: Example:
+    # @param [Integer] resolved_id__exact Optional parameter: Example:
+    # @param [Integer] assigned_id__exact Optional parameter: ID of the User to
+    # which the Alert was assigned
+    # @param [Integer] story_id__exact Optional parameter: ID of the Alert Story
+    # to which the Alert belongs - can be viewed in the UI by selecting "Group
+    # By Story"
+    # @param [SortEnum] sort Optional parameter: By default, results are sorted
+    # in ascending order of the sort attribute. The sorting prefix "-" sorts the
+    # results in descending order of the sort attribute.
+    # @return [GetAlertsResponse] response from the API call
+    def get_alerts(page: nil,
+                   per_page: nil,
+                   asset_id__exact: nil,
+                   asset__exact: nil,
+                   for_asset__exact: nil,
+                   q__exact: nil,
+                   primary_asset__exact: nil,
+                   non_primary_assets__exact: nil,
+                   virtual_zone__exact: nil,
+                   alert_id__exact: nil,
+                   ot_alerts__exact: nil,
+                   family__exact: nil,
+                   story_severity__exact: nil,
+                   id__exact: nil,
+                   site_id__exact: nil,
+                   data__exact: nil,
+                   description__exact: nil,
+                   type__exact: nil,
+                   category__exact: nil,
+                   severity__exact: nil,
+                   timestamp__exact: nil,
+                   last_updated__gte: nil,
+                   relevant__exact: nil,
+                   resolved__exact: nil,
+                   resolution__exact: nil,
+                   protocol__exact: nil,
+                   score__exact: nil,
+                   is_qualified__exact: nil,
+                   network_id__exact: nil,
+                   resolved_id__exact: nil,
+                   assigned_id__exact: nil,
+                   story_id__exact: nil,
+                   sort: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/ranger/alerts',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .query_param(new_parameter(asset_id__exact, key: 'asset_id__exact'))
+                   .query_param(new_parameter(asset__exact, key: 'asset__exact'))
+                   .query_param(new_parameter(for_asset__exact, key: 'for_asset__exact'))
+                   .query_param(new_parameter(q__exact, key: 'q__exact'))
+                   .query_param(new_parameter(primary_asset__exact, key: 'primary_asset__exact'))
+                   .query_param(new_parameter(non_primary_assets__exact, key: 'non_primary_assets__exact'))
+                   .query_param(new_parameter(virtual_zone__exact, key: 'virtual_zone__exact'))
+                   .query_param(new_parameter(alert_id__exact, key: 'alert_id__exact'))
+                   .query_param(new_parameter(ot_alerts__exact, key: 'ot_alerts__exact'))
+                   .query_param(new_parameter(family__exact, key: 'family__exact'))
+                   .query_param(new_parameter(story_severity__exact, key: 'story_severity__exact'))
+                   .query_param(new_parameter(id__exact, key: 'id__exact'))
+                   .query_param(new_parameter(site_id__exact, key: 'site_id__exact'))
+                   .query_param(new_parameter(data__exact, key: 'data__exact'))
+                   .query_param(new_parameter(description__exact, key: 'description__exact'))
+                   .query_param(new_parameter(type__exact, key: 'type__exact'))
+                   .query_param(new_parameter(category__exact, key: 'category__exact'))
+                   .query_param(new_parameter(severity__exact, key: 'severity__exact'))
+                   .query_param(new_parameter(timestamp__exact, key: 'timestamp__exact'))
+                   .query_param(new_parameter(last_updated__gte, key: 'last_updated__gte'))
+                   .query_param(new_parameter(relevant__exact, key: 'relevant__exact'))
+                   .query_param(new_parameter(resolved__exact, key: 'resolved__exact'))
+                   .query_param(new_parameter(resolution__exact, key: 'resolution__exact'))
+                   .query_param(new_parameter(protocol__exact, key: 'protocol__exact'))
+                   .query_param(new_parameter(score__exact, key: 'score__exact'))
+                   .query_param(new_parameter(is_qualified__exact, key: 'is_qualified__exact'))
+                   .query_param(new_parameter(network_id__exact, key: 'network_id__exact'))
+                   .query_param(new_parameter(resolved_id__exact, key: 'resolved_id__exact'))
+                   .query_param(new_parameter(assigned_id__exact, key: 'assigned_id__exact'))
+                   .query_param(new_parameter(story_id__exact, key: 'story_id__exact'))
+                   .query_param(new_parameter(sort, key: 'sort'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(GetAlertsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Get a single alert.
+    # @param [String] resource_id Required parameter: Resource ID of the Alert
+    # to return
+    # @return [Alert] response from the API call
+    def find_alert_by_id(resource_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/ranger/alerts/{resource_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(resource_id, key: 'resource_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(Alert.method(:from_hash)))
+        .execute
+    end
+  end
+end