sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/update_monitor_request.rb

@@ -0,0 +1,153 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # UpdateMonitorRequest Model.
+  class UpdateMonitorRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cadence
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :api_key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :monitor_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # Replaces the list wholesale when set. An empty list is read as "not set"
+    # and keeps the current requests. A request keeps its id and its health when
+    # every field of its body is unchanged.
+    # @return [Array[SearchRequest]]
+    attr_accessor :search_requests
+
+    # Replaces the list wholesale when set. An empty list is read as "not set"
+    # and keeps the current requests. A request keeps its id and its health when
+    # every field of its body is unchanged.
+    # @return [MonitorStatus]
+    attr_accessor :status
+
+    # Replaces the list wholesale when set. An empty list is read as "not set"
+    # and keeps the current requests. A request keeps its id and its health when
+    # every field of its body is unchanged.
+    # @return [Webhook1]
+    attr_accessor :webhook
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cadence'] = 'cadence'
+      @_hash['api_key'] = 'api_key'
+      @_hash['monitor_id'] = 'monitor_id'
+      @_hash['name'] = 'name'
+      @_hash['search_requests'] = 'search_requests'
+      @_hash['status'] = 'status'
+      @_hash['webhook'] = 'webhook'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        api_key
+        monitor_id
+        name
+        search_requests
+        status
+        webhook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_key
+        name
+        webhook
+      ]
+    end
+
+    def initialize(cadence:, api_key: SKIP, monitor_id: SKIP, name: SKIP,
+                   search_requests: SKIP, status: SKIP, webhook: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cadence = cadence
+      @api_key = api_key unless api_key == SKIP
+      @monitor_id = monitor_id unless monitor_id == SKIP
+      @name = name unless name == SKIP
+      @search_requests = search_requests unless search_requests == SKIP
+      @status = status unless status == SKIP
+      @webhook = webhook unless webhook == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      cadence = hash.key?('cadence') ? hash['cadence'] : nil
+      api_key = hash.key?('api_key') ? hash['api_key'] : SKIP
+      monitor_id = hash.key?('monitor_id') ? hash['monitor_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      search_requests = nil
+      unless hash['search_requests'].nil?
+        search_requests = []
+        hash['search_requests'].each do |structure|
+          search_requests << (SearchRequest.from_hash(structure) if structure)
+        end
+      end
+
+      search_requests = SKIP unless hash.key?('search_requests')
+      status = hash.key?('status') ? hash['status'] : SKIP
+      webhook = Webhook1.from_hash(hash['webhook']) if hash['webhook']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      UpdateMonitorRequest.new(cadence: cadence,
+                               api_key: api_key,
+                               monitor_id: monitor_id,
+                               name: name,
+                               search_requests: search_requests,
+                               status: status,
+                               webhook: webhook,
+                               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cadence: #{@cadence}, api_key: #{@api_key}, monitor_id: #{@monitor_id},"\
+      " name: #{@name}, search_requests: #{@search_requests}, status: #{@status}, webhook:"\
+      " #{@webhook}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cadence: #{@cadence.inspect}, api_key: #{@api_key.inspect}, monitor_id:"\
+      " #{@monitor_id.inspect}, name: #{@name.inspect}, search_requests:"\
+      " #{@search_requests.inspect}, status: #{@status.inspect}, webhook: #{@webhook.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/update_monitor_response.rb

@@ -0,0 +1,77 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # UpdateMonitorResponse Model.
+  class UpdateMonitorResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Monitor]
+    attr_accessor :monitor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['monitor'] = 'monitor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        monitor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        monitor
+      ]
+    end
+
+    def initialize(monitor: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @monitor = monitor unless monitor == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      monitor = Monitor.from_hash(hash['monitor']) if hash['monitor']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      UpdateMonitorResponse.new(monitor: monitor,
+                                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} monitor: #{@monitor}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} monitor: #{@monitor.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/webhook.rb

@@ -0,0 +1,113 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Webhook Model.
+  class Webhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exactly two strings are legal: "run.completed" and "run.failed". An empty
+    # list is rejected.
+    # "run.completed" means the run finished. Read the run's `record_count` to
+    # see whether it produced records and its `status` to see whether every
+    # request succeeded. "run.failed" means no request succeeded. Neither fires
+    # for a skipped run.
+    # @return [Array[String]]
+    attr_accessor :events
+
+    # Always reported on a monitor. Send ACTIVE to turn delivery back on once a
+    # failing endpoint is repaired, or DISABLED to stop it yourself.
+    # A disabled webhook stops the POST only. The monitor still runs and its
+    # records are still readable through the records cursor, so nothing is lost
+    # while it is off.
+    # On the way in it is the one field of this message that may be omitted: an
+    # absent status keeps whatever the monitor already has, so re-sending a
+    # webhook body does not by itself restart delivery to a dead endpoint.
+    # @return [String]
+    attr_accessor :status
+
+    # Always reported on a monitor. Send ACTIVE to turn delivery back on once a
+    # failing endpoint is repaired, or DISABLED to stop it yourself.
+    # A disabled webhook stops the POST only. The monitor still runs and its
+    # records are still readable through the records cursor, so nothing is lost
+    # while it is off.
+    # On the way in it is the one field of this message that may be omitted: an
+    # absent status keeps whatever the monitor already has, so re-sending a
+    # webhook body does not by itself restart delivery to a dead endpoint.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['events'] = 'events'
+      @_hash['status'] = 'status'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        events
+        status
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(events:, status: SKIP, url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @events = events unless events == SKIP
+      @status = status unless status == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      events = hash['events'] ||= 
+      status = hash.key?('status') ? hash['status'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Webhook.new(events: events,
+                  status: status,
+                  url: url,
+                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} events: #{@events}, status: #{@status}, url: #{@url},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} events: #{@events.inspect}, status: #{@status.inspect}, url:"\
+      " #{@url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/webhook1.rb

@@ -0,0 +1,114 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # JSON `null` clears the webhook; an absent field keeps it. Set
+  # `webhook.status` to turn delivery on or off.
+  class Webhook1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exactly two strings are legal: "run.completed" and "run.failed". An empty
+    # list is rejected.
+    # "run.completed" means the run finished. Read the run's `record_count` to
+    # see whether it produced records and its `status` to see whether every
+    # request succeeded. "run.failed" means no request succeeded. Neither fires
+    # for a skipped run.
+    # @return [Array[String]]
+    attr_accessor :events
+
+    # Always reported on a monitor. Send ACTIVE to turn delivery back on once a
+    # failing endpoint is repaired, or DISABLED to stop it yourself.
+    # A disabled webhook stops the POST only. The monitor still runs and its
+    # records are still readable through the records cursor, so nothing is lost
+    # while it is off.
+    # On the way in it is the one field of this message that may be omitted: an
+    # absent status keeps whatever the monitor already has, so re-sending a
+    # webhook body does not by itself restart delivery to a dead endpoint.
+    # @return [String]
+    attr_accessor :status
+
+    # Always reported on a monitor. Send ACTIVE to turn delivery back on once a
+    # failing endpoint is repaired, or DISABLED to stop it yourself.
+    # A disabled webhook stops the POST only. The monitor still runs and its
+    # records are still readable through the records cursor, so nothing is lost
+    # while it is off.
+    # On the way in it is the one field of this message that may be omitted: an
+    # absent status keeps whatever the monitor already has, so re-sending a
+    # webhook body does not by itself restart delivery to a dead endpoint.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['events'] = 'events'
+      @_hash['status'] = 'status'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        events
+        status
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(events:, status: SKIP, url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @events = events unless events == SKIP
+      @status = status unless status == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      events = hash['events'] ||= 
+      status = hash.key?('status') ? hash['status'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Webhook1.new(events: events,
+                   status: status,
+                   url: url,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} events: #{@events}, status: #{@status}, url: #{@url},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} events: #{@events.inspect}, status: #{@status.inspect}, url:"\
+      " #{@url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module SeltzApi
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/seltz_api/utilities/file_wrapper.rb

@@ -0,0 +1,28 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end

data/lib/seltz_api/utilities/union_type_lookup.rb

@@ -0,0 +1,62 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # The `UnionTypeLookUp` class serves as a utility class for
+  # storing and managing type combinator templates. It acts as a container for the templates
+  # used in handling various oneof/anyof instances within the sdk.
+  class UnionTypeLookUp
+    include CoreLibrary
+    # rubocop:disable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+    def self.union_types
+      {
+        :FieldsContent => OneOf.new(
+          [
+            AnyOf.new([LeafType.new(TrueClass), LeafType.new(FalseClass)]),
+            LeafType.new(ContentOptions)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :FieldsSnippets => OneOf.new(
+          [
+            AnyOf.new([LeafType.new(TrueClass), LeafType.new(FalseClass)]),
+            LeafType.new(SnippetOptions)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :Fields2Content => OneOf.new(
+          [
+            AnyOf.new([LeafType.new(TrueClass), LeafType.new(FalseClass)]),
+            LeafType.new(ContentOptions)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :Fields2Snippets => OneOf.new(
+          [
+            AnyOf.new([LeafType.new(TrueClass), LeafType.new(FalseClass)]),
+            LeafType.new(SnippetOptions)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        )
+      }
+    end
+    # rubocop:enable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+
+    def self.get(name)
+      UnionTypeLookUp.union_types[name]
+    end
+  end
+end

data/lib/seltz_api.rb

@@ -0,0 +1,115 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require 'json'
+
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'seltz_api/api_helper'
+require_relative 'seltz_api/client'
+
+# Utilities
+require_relative 'seltz_api/utilities/file_wrapper'
+require_relative 'seltz_api/utilities/date_time_helper'
+require_relative 'seltz_api/utilities/union_type_lookup'
+
+# Http
+require_relative 'seltz_api/http/api_response'
+require_relative 'seltz_api/http/http_call_back'
+require_relative 'seltz_api/http/http_method_enum'
+require_relative 'seltz_api/http/http_request'
+require_relative 'seltz_api/http/http_response'
+require_relative 'seltz_api/http/proxy_settings'
+
+
+# Logger
+require_relative 'seltz_api/logging/configuration/api_logging_configuration'
+require_relative 'seltz_api/logging/sdk_logger'
+require_relative 'seltz_api/http/auth/custom_header_authentication'
+
+# Models
+require_relative 'seltz_api/models/base_model'
+require_relative 'seltz_api/models/agent_run'
+require_relative 'seltz_api/models/agent_run_citation'
+require_relative 'seltz_api/models/agent_run_grounding'
+require_relative 'seltz_api/models/agent_run_output'
+require_relative 'seltz_api/models/agent_run_request'
+require_relative 'seltz_api/models/agent_run_source'
+require_relative 'seltz_api/models/answer_http_request'
+require_relative 'seltz_api/models/answer_http_response'
+require_relative 'seltz_api/models/content_options'
+require_relative 'seltz_api/models/create_agent_run_request'
+require_relative 'seltz_api/models/create_monitor_request'
+require_relative 'seltz_api/models/create_monitor_response'
+require_relative 'seltz_api/models/document'
+require_relative 'seltz_api/models/envelope_error'
+require_relative 'seltz_api/models/fetch_error'
+require_relative 'seltz_api/models/fetch_request'
+require_relative 'seltz_api/models/fetch_response'
+require_relative 'seltz_api/models/fetch_result'
+require_relative 'seltz_api/models/fields'
+require_relative 'seltz_api/models/get_monitor_response'
+require_relative 'seltz_api/models/get_run_response'
+require_relative 'seltz_api/models/http_citation'
+require_relative 'seltz_api/models/list_agent_runs_response'
+require_relative 'seltz_api/models/list_monitors_response'
+require_relative 'seltz_api/models/list_records_response'
+require_relative 'seltz_api/models/list_run_records_response'
+require_relative 'seltz_api/models/list_run_requests_response'
+require_relative 'seltz_api/models/list_runs_response'
+require_relative 'seltz_api/models/monitor'
+require_relative 'seltz_api/models/monitor_search_request'
+require_relative 'seltz_api/models/record'
+require_relative 'seltz_api/models/run'
+require_relative 'seltz_api/models/run_request'
+require_relative 'seltz_api/models/search_record'
+require_relative 'seltz_api/models/search_request'
+require_relative 'seltz_api/models/search_request_ref'
+require_relative 'seltz_api/models/search_response'
+require_relative 'seltz_api/models/snippet'
+require_relative 'seltz_api/models/snippet_options'
+require_relative 'seltz_api/models/update_monitor_request'
+require_relative 'seltz_api/models/update_monitor_response'
+require_relative 'seltz_api/models/webhook'
+require_relative 'seltz_api/models/agent_run_output2'
+require_relative 'seltz_api/models/agent_run_request2'
+require_relative 'seltz_api/models/envelope_error1'
+require_relative 'seltz_api/models/fetch_error1'
+require_relative 'seltz_api/models/fields2'
+require_relative 'seltz_api/models/payload'
+require_relative 'seltz_api/models/schedule'
+require_relative 'seltz_api/models/webhook1'
+require_relative 'seltz_api/models/agent_run_status'
+require_relative 'seltz_api/models/agent_run_stop_reason'
+require_relative 'seltz_api/models/fetch_status'
+require_relative 'seltz_api/models/monitor_status'
+require_relative 'seltz_api/models/record_type'
+require_relative 'seltz_api/models/request_status'
+require_relative 'seltz_api/models/run_state'
+require_relative 'seltz_api/models/run_status'
+require_relative 'seltz_api/models/agent_run_status2'
+require_relative 'seltz_api/models/agent_run_stop_reason2'
+require_relative 'seltz_api/models/fetch_status2'
+require_relative 'seltz_api/models/monitor_status2'
+require_relative 'seltz_api/models/run_state2'
+
+# Exceptions
+require_relative 'seltz_api/exceptions/api_exception'
+require_relative 'seltz_api/exceptions/error_envelope_exception'
+
+require_relative 'seltz_api/configuration'
+
+# Controllers
+require_relative 'seltz_api/apis/base_api'
+require_relative 'seltz_api/apis/search_api'
+require_relative 'seltz_api/apis/answer_api'
+require_relative 'seltz_api/apis/monitors_api'
+require_relative 'seltz_api/apis/records_api'
+require_relative 'seltz_api/apis/runs_api'
+require_relative 'seltz_api/apis/agent_api'
+require_relative 'seltz_api/apis/fetch_api'