sz-apimatic-sdk 0.0.1

data/lib/seltz_api/apis/monitors_api.rb

@@ -0,0 +1,161 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # MonitorsApi
+  class MonitorsApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] name Optional parameter: Matches a monitor whose name is
+    # exactly this.
+    # @param [String] status Optional parameter: One of `active`, `paused`,
+    # `disabled`. `deleted` is not a filter: a deleted monitor is invisible.
+    # @param [String] since Optional parameter: Exclusive lower bound: the
+    # `monitor_id` of a monitor to start after.
+    # @param [String] before Optional parameter: Exclusive upper bound. The list
+    # is newest first, so page forward with the `monitor_id` of the last monitor
+    # on the previous page.
+    # @param [Integer] limit Optional parameter: Defaults to 100, at most 1,000.
+    # A short page is normal: a page ends at `limit` or at the byte budget,
+    # whichever binds first.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_monitors(name: nil,
+                      status: nil,
+                      since: nil,
+                      before: nil,
+                      limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/monitors',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(name, key: 'name'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(since, key: 'since'))
+                   .query_param(new_parameter(before, key: 'before'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListMonitorsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [CreateMonitorRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_monitor(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/monitors',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CreateMonitorResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Missing or malformed fields.',
+                                 ErrorEnvelopeException)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException)
+                    .local_error('409',
+                                 'That name is already taken in this org.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] monitor_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_monitor(monitor_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/monitors/{monitor_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(monitor_id, key: 'monitor_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetMonitorResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No such monitor in this org.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] monitor_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_monitor(monitor_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v1/monitors/{monitor_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(monitor_id, key: 'monitor_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No such monitor in this org.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] monitor_id Required parameter: TODO: type description
+    # here
+    # @param [UpdateMonitorRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_monitor(monitor_id,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/v1/monitors/{monitor_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(monitor_id, key: 'monitor_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UpdateMonitorResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No such monitor in this org.',
+                                 ErrorEnvelopeException)
+                    .local_error('409',
+                                 'That name is already taken in this org.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+  end
+end

data/lib/seltz_api/apis/records_api.rb

@@ -0,0 +1,97 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # RecordsApi
+  class RecordsApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] monitor_id Required parameter: TODO: type description
+    # here
+    # @param [String] since Optional parameter: Exclusive lower bound on
+    # `record_id`.
+    # @param [String] before Optional parameter: Exclusive upper bound on
+    # `record_id`.
+    # @param [Integer] limit Optional parameter: Defaults to 100, at most 1,000.
+    # A short page is normal: a page ends at `limit` or at the byte budget,
+    # whichever binds first.
+    # @param [TrueClass | FalseClass] include_content Optional parameter:
+    # Include each record's document content. Defaults to true.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_records(monitor_id,
+                     since: nil,
+                     before: nil,
+                     limit: nil,
+                     include_content: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/monitors/{monitor_id}/records',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(monitor_id, key: 'monitor_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(since, key: 'since'))
+                   .query_param(new_parameter(before, key: 'before'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(include_content, key: 'include_content'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListRecordsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No such monitor in this org.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # Exists so that no consumer does arithmetic on a record id: a webhook
+    # carries a run's record range as a bound, not a dense sequence.
+    # @param [String] monitor_id Required parameter: TODO: type description
+    # here
+    # @param [String] run_id Required parameter: TODO: type description here
+    # @param [String] since Optional parameter: Exclusive lower bound on
+    # `record_id`.
+    # @param [String] before Optional parameter: Exclusive upper bound on
+    # `record_id`.
+    # @param [Integer] limit Optional parameter: Defaults to 100, at most 1,000.
+    # A short page is normal: a page ends at `limit` or at the byte budget,
+    # whichever binds first.
+    # @param [TrueClass | FalseClass] include_content Optional parameter:
+    # Include each record's document content. Defaults to true.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_run_records(monitor_id,
+                         run_id,
+                         since: nil,
+                         before: nil,
+                         limit: nil,
+                         include_content: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/monitors/{monitor_id}/runs/{run_id}/records',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(monitor_id, key: 'monitor_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(run_id, key: 'run_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(since, key: 'since'))
+                   .query_param(new_parameter(before, key: 'before'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(include_content, key: 'include_content'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListRunRecordsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No such run on this monitor.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+  end
+end

data/lib/seltz_api/apis/runs_api.rb

@@ -0,0 +1,109 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # RunsApi
+  class RunsApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] monitor_id Required parameter: TODO: type description
+    # here
+    # @param [String] since Optional parameter: Exclusive lower bound on
+    # `run_id`.
+    # @param [String] before Optional parameter: Exclusive upper bound on
+    # `run_id`.
+    # @param [Integer] limit Optional parameter: Defaults to 100, at most
+    # 1,000.
+    # @param [String] sort Optional parameter: `desc` (the default, newest
+    # first) or `asc`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_runs(monitor_id,
+                  since: nil,
+                  before: nil,
+                  limit: nil,
+                  sort: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/monitors/{monitor_id}/runs',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(monitor_id, key: 'monitor_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(since, key: 'since'))
+                   .query_param(new_parameter(before, key: 'before'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(sort, key: 'sort'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListRunsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No such monitor in this org.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] monitor_id Required parameter: TODO: type description
+    # here
+    # @param [String] run_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_run(monitor_id,
+                run_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/monitors/{monitor_id}/runs/{run_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(monitor_id, key: 'monitor_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(run_id, key: 'run_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetRunResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No such run on this monitor.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # The only place a customer can tell *this query failed* from *there was
+    # genuinely nothing new*: records are a stream of positives, and absence
+    # cannot be inferred from presences.
+    # @param [String] monitor_id Required parameter: TODO: type description
+    # here
+    # @param [String] run_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_run_requests(monitor_id,
+                          run_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/monitors/{monitor_id}/runs/{run_id}/requests',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(monitor_id, key: 'monitor_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(run_id, key: 'run_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListRunRequestsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 'No such run on this monitor.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+  end
+end

data/lib/seltz_api/apis/search_api.rb

@@ -0,0 +1,55 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # SearchApi
+  class SearchApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [SearchRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Missing or malformed request fields.',
+                                 ErrorEnvelopeException)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException)
+                    .local_error('402',
+                                 'Insufficient credits.',
+                                 ErrorEnvelopeException)
+                    .local_error('404',
+                                 'Endpoint not found, or a scope that matches nothing.',
+                                 ErrorEnvelopeException)
+                    .local_error('405',
+                                 'Wrong method for this endpoint.',
+                                 ErrorEnvelopeException)
+                    .local_error('413',
+                                 'Request body is too large.',
+                                 ErrorEnvelopeException)
+                    .local_error('429',
+                                 'Rate limit exceeded. Wait before retrying.',
+                                 ErrorEnvelopeException)
+                    .local_error('500',
+                                 'Unexpected server error.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+  end
+end

data/lib/seltz_api/client.rb

@@ -0,0 +1,111 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  #  seltz_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to search controller.
+    # @return [SearchApi] Returns the controller instance.
+    def search
+      @search ||= SearchApi.new @global_configuration
+    end
+
+    # Access to answer controller.
+    # @return [AnswerApi] Returns the controller instance.
+    def answer
+      @answer ||= AnswerApi.new @global_configuration
+    end
+
+    # Access to monitors controller.
+    # @return [MonitorsApi] Returns the controller instance.
+    def monitors
+      @monitors ||= MonitorsApi.new @global_configuration
+    end
+
+    # Access to records controller.
+    # @return [RecordsApi] Returns the controller instance.
+    def records
+      @records ||= RecordsApi.new @global_configuration
+    end
+
+    # Access to runs controller.
+    # @return [RunsApi] Returns the controller instance.
+    def runs
+      @runs ||= RunsApi.new @global_configuration
+    end
+
+    # Access to agent controller.
+    # @return [AgentApi] Returns the controller instance.
+    def agent
+      @agent ||= AgentApi.new @global_configuration
+    end
+
+    # Access to fetch controller.
+    # @return [FetchApi] Returns the controller instance.
+    def fetch
+      @fetch ||= FetchApi.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      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, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      custom_header_authentication_credentials: nil, 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,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    custom_header_authentication_credentials: custom_header_authentication_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      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
+      %w[ApiKeyAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['ApiKeyAuth'] = CustomHeaderAuthentication.new(
+        http_client_config.custom_header_authentication_credentials
+      )
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end