speakeasy_client_sdk_ruby 1.0.1

data/lib/sdk/models/shared/generateopenapispecdiff.rb

@@ -0,0 +1,28 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+
+module SpeakeasyClientSDK
+  module Shared
+    # OK
+    class GenerateOpenApiSpecDiff < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :current_schema, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('current_schema') } }
+
+      field :new_schema, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('new_schema') } }
+
+
+      sig { params(current_schema: String, new_schema: String).void }
+      def initialize(current_schema: nil, new_schema: nil)
+        @current_schema = current_schema
+        @new_schema = new_schema
+      end
+    end
+  end
+end

data/lib/sdk/models/shared/plugin.rb

@@ -0,0 +1,43 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+
+module SpeakeasyClientSDK
+  module Shared
+    # A plugin is a short script that is run against ingested requests
+    class Plugin < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :code, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('code') } }
+
+      field :plugin_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('plugin_id') } }
+
+      field :title, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('title') } }
+
+      field :workspace_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('workspace_id') } }
+
+      field :created_at, T.nilable(DateTime), { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(true) } }
+
+      field :eval_hash, T.nilable(String), { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('eval_hash') } }
+
+      field :updated_at, T.nilable(DateTime), { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('updated_at'), 'decoder': Utils.datetime_from_iso_format(true) } }
+
+
+      sig { params(code: String, plugin_id: String, title: String, workspace_id: String, created_at: T.nilable(DateTime), eval_hash: T.nilable(String), updated_at: T.nilable(DateTime)).void }
+      def initialize(code: nil, plugin_id: nil, title: nil, workspace_id: nil, created_at: nil, eval_hash: nil, updated_at: nil)
+        @code = code
+        @plugin_id = plugin_id
+        @title = title
+        @workspace_id = workspace_id
+        @created_at = created_at
+        @eval_hash = eval_hash
+        @updated_at = updated_at
+      end
+    end
+  end
+end

data/lib/sdk/models/shared/requestmetadata.rb

@@ -0,0 +1,28 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+
+module SpeakeasyClientSDK
+  module Shared
+    # Key-Value pairs associated with a request
+    class RequestMetadata < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :key, T.nilable(String), { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('key') } }
+
+      field :value, T.nilable(String), { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('value') } }
+
+
+      sig { params(key: T.nilable(String), value: T.nilable(String)).void }
+      def initialize(key: nil, value: nil)
+        @key = key
+        @value = value
+      end
+    end
+  end
+end

data/lib/sdk/models/shared/schema.rb

@@ -0,0 +1,40 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+
+module SpeakeasyClientSDK
+  module Shared
+    # A Schema represents an API schema for a particular Api and Version.
+    class Schema < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the Api this Schema belongs to.
+      field :api_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('api_id') } }
+      # Creation timestamp.
+      field :created_at, DateTime, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(false) } }
+      # A detailed description of the Schema.
+      field :description, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('description') } }
+      # An ID referencing this particular revision of the Schema.
+      field :revision_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('revision_id') } }
+      # The version ID of the Api this Schema belongs to.
+      field :version_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('version_id') } }
+      # The workspace ID this Schema belongs to.
+      field :workspace_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('workspace_id') } }
+
+
+      sig { params(api_id: String, created_at: DateTime, description: String, revision_id: String, version_id: String, workspace_id: String).void }
+      def initialize(api_id: nil, created_at: nil, description: nil, revision_id: nil, version_id: nil, workspace_id: nil)
+        @api_id = api_id
+        @created_at = created_at
+        @description = description
+        @revision_id = revision_id
+        @version_id = version_id
+        @workspace_id = workspace_id
+      end
+    end
+  end
+end

data/lib/sdk/models/shared/schemadiff.rb

@@ -0,0 +1,48 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+
+module SpeakeasyClientSDK
+  module Shared
+
+    class SchemaDiffValueChange < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # Represents the previous value of the element.
+      field :from, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('From') } }
+      # Represents the current value of the element.
+      field :to, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('To') } }
+
+
+      sig { params(from: String, to: String).void }
+      def initialize(from: nil, to: nil)
+        @from = from
+        @to = to
+      end
+    end
+
+    # A SchemaDiff represents a diff of two Schemas.
+    class SchemaDiff < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # Holds every addition change in the diff.
+      field :additions, T::Array[String], { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('additions') } }
+      # Holds every deletion change in the diff.
+      field :deletions, T::Array[String], { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('deletions') } }
+      # Holds every modification change in the diff.
+      field :modifications, T::Hash[Symbol, Shared::SchemaDiffValueChange], { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('modifications') } }
+
+
+      sig { params(additions: T::Array[String], deletions: T::Array[String], modifications: T::Hash[Symbol, Shared::SchemaDiffValueChange]).void }
+      def initialize(additions: nil, deletions: nil, modifications: nil)
+        @additions = additions
+        @deletions = deletions
+        @modifications = modifications
+      end
+    end
+  end
+end

data/lib/sdk/models/shared/security.rb

@@ -0,0 +1,25 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+
+module SpeakeasyClientSDK
+  module Shared
+
+    class Security < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :api_key, String, { 'security': { 'scheme': true, 'type': 'apiKey', 'sub_type': 'header', 'field_name': 'x-api-key' } }
+
+
+      sig { params(api_key: String).void }
+      def initialize(api_key: nil)
+        @api_key = api_key
+      end
+    end
+  end
+end

data/lib/sdk/models/shared/unboundedrequest.rb

@@ -0,0 +1,37 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+
+module SpeakeasyClientSDK
+  module Shared
+    # An UnboundedRequest represents the HAR content capture by Speakeasy when logging a request.
+    class UnboundedRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # Creation timestamp.
+      field :created_at, DateTime, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(false) } }
+      # The HAR content of the request.
+      field :har, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('har') } }
+      # The size of the HAR content in bytes.
+      field :har_size_bytes, Integer, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('har_size_bytes') } }
+      # The ID of this request.
+      field :request_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('request_id') } }
+      # The workspace ID this request was made to.
+      field :workspace_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('workspace_id') } }
+
+
+      sig { params(created_at: DateTime, har: String, har_size_bytes: Integer, request_id: String, workspace_id: String).void }
+      def initialize(created_at: nil, har: nil, har_size_bytes: nil, request_id: nil, workspace_id: nil)
+        @created_at = created_at
+        @har = har
+        @har_size_bytes = har_size_bytes
+        @request_id = request_id
+        @workspace_id = workspace_id
+      end
+    end
+  end
+end

data/lib/sdk/models/shared/versionmetadata.rb

@@ -0,0 +1,57 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+
+module SpeakeasyClientSDK
+  module Shared
+    # A set of keys and associated values, attached to a particular version of an Api.
+    class VersionMetadataInput < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The key for this metadata.
+      field :meta_key, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('meta_key') } }
+      # One of the values for this metadata.
+      field :meta_value, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('meta_value') } }
+
+
+      sig { params(meta_key: String, meta_value: String).void }
+      def initialize(meta_key: nil, meta_value: nil)
+        @meta_key = meta_key
+        @meta_value = meta_value
+      end
+    end
+
+    # A set of keys and associated values, attached to a particular version of an Api.
+    class VersionMetadata < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the Api this Metadata belongs to.
+      field :api_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('api_id') } }
+      # Creation timestamp.
+      field :created_at, DateTime, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(false) } }
+      # The key for this metadata.
+      field :meta_key, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('meta_key') } }
+      # One of the values for this metadata.
+      field :meta_value, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('meta_value') } }
+      # The version ID of the Api this Metadata belongs to.
+      field :version_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('version_id') } }
+      # The workspace ID this Metadata belongs to.
+      field :workspace_id, String, { 'format_json': { 'letter_case': OpenApiSDK::Utils.field_name('workspace_id') } }
+
+
+      sig { params(api_id: String, created_at: DateTime, meta_key: String, meta_value: String, version_id: String, workspace_id: String).void }
+      def initialize(api_id: nil, created_at: nil, meta_key: nil, meta_value: nil, version_id: nil, workspace_id: nil)
+        @api_id = api_id
+        @created_at = created_at
+        @meta_key = meta_key
+        @meta_value = meta_value
+        @version_id = version_id
+        @workspace_id = workspace_id
+      end
+    end
+  end
+end

data/lib/sdk/plugins.rb

@@ -0,0 +1,140 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'sorbet-runtime'
+
+module SpeakeasyClientSDK
+  extend T::Sig
+  class Plugins
+    extend T::Sig
+    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String).void }
+    def initialize(sdk, client, server_url, language, sdk_version, gen_version)
+      @sdk = sdk
+      @client = client
+      @server_url = server_url
+      @language = language
+      @sdk_version = sdk_version
+      @gen_version = gen_version
+    end
+
+    sig { returns(Utils::FieldAugmented) }
+    def get_plugins
+      # get_plugins - Get all plugins for the current workspace.
+      base_url = @server_url
+      url = "#{base_url.delete_suffix('/')}/v1/plugins"
+      headers = {}
+      headers['Accept'] = 'application/json;q=1, application/json;q=0'
+      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
+
+      r = @client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::GetPluginsResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Plugin])
+          res.plugins = out
+        end
+      else
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
+          res.error = out
+        end
+      end
+      res
+    end
+
+    sig { params(request: Operations::RunPluginRequest).returns(Utils::FieldAugmented) }
+    def run_plugin(request)
+      # run_plugin - Run a plugin
+      base_url = @server_url
+      url = Utils.generate_url(
+        Operations::RunPluginRequest,
+        base_url,
+        '/v1/plugins/{pluginID}',
+        request
+      )
+      headers = {}
+      query_params = Utils.get_query_params(Operations::RunPluginRequest, request)
+      headers['Accept'] = 'application/json;q=1, application/json;q=0'
+      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
+
+      r = @client.post(url) do |req|
+        req.headers = headers
+        req.params = query_params
+        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::RunPluginResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::BoundedRequest])
+          res.bounded_requests = out
+        end
+      else
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
+          res.error = out
+        end
+      end
+      res
+    end
+
+    sig { params(request: Shared::Plugin).returns(Utils::FieldAugmented) }
+    def upsert_plugin(request)
+      # upsert_plugin - Upsert a plugin
+      base_url = @server_url
+      url = "#{base_url.delete_suffix('/')}/v1/plugins"
+      headers = {}
+      req_content_type, data, form = Utils.serialize_request_body(request, :request, :json)
+      headers['content-type'] = req_content_type
+      raise StandardError, 'request body is required' if data.nil? && form.nil?
+      headers['Accept'] = 'application/json;q=1, application/json;q=0'
+      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
+
+      r = @client.put(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        if form
+          req.body = Utils.encode_form(form)
+        elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
+          req.body = URI.encode_www_form(data)
+        else
+          req.body = data
+        end
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::UpsertPluginResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::Plugin)
+          res.plugin = out
+        end
+      else
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
+          res.error = out
+        end
+      end
+      res
+    end
+  end
+end

data/lib/sdk/requests.rb

@@ -0,0 +1,136 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'sorbet-runtime'
+
+module SpeakeasyClientSDK
+  extend T::Sig
+  class Requests
+    extend T::Sig
+    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String).void }
+    def initialize(sdk, client, server_url, language, sdk_version, gen_version)
+      @sdk = sdk
+      @client = client
+      @server_url = server_url
+      @language = language
+      @sdk_version = sdk_version
+      @gen_version = gen_version
+    end
+
+    sig { params(request: Operations::GenerateRequestPostmanCollectionRequest).returns(Utils::FieldAugmented) }
+    def generate_request_postman_collection(request)
+      # generate_request_postman_collection - Generate a Postman collection for a particular request.
+      # Generates a Postman collection for a particular request. 
+      # Allowing it to be replayed with the same inputs that were captured by the SDK.
+      base_url = @server_url
+      url = Utils.generate_url(
+        Operations::GenerateRequestPostmanCollectionRequest,
+        base_url,
+        '/v1/eventlog/{requestID}/generate/postman',
+        request
+      )
+      headers = {}
+      headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0'
+      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
+
+      r = @client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::GenerateRequestPostmanCollectionResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        res.postman_collection = r.env.response_body if Utils.match_content_type(content_type, 'application/octet-stream')
+      else
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
+          res.error = out
+        end
+      end
+      res
+    end
+
+    sig { params(request: Operations::GetRequestFromEventLogRequest).returns(Utils::FieldAugmented) }
+    def get_request_from_event_log(request)
+      # get_request_from_event_log - Get information about a particular request.
+      base_url = @server_url
+      url = Utils.generate_url(
+        Operations::GetRequestFromEventLogRequest,
+        base_url,
+        '/v1/eventlog/{requestID}',
+        request
+      )
+      headers = {}
+      headers['Accept'] = 'application/json;q=1, application/json;q=0'
+      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
+
+      r = @client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::GetRequestFromEventLogResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::UnboundedRequest)
+          res.unbounded_request = out
+        end
+      else
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
+          res.error = out
+        end
+      end
+      res
+    end
+
+    sig { params(request: Operations::QueryEventLogRequest).returns(Utils::FieldAugmented) }
+    def query_event_log(request)
+      # query_event_log - Query the event log to retrieve a list of requests.
+      # Supports retrieving a list of request captured by the SDK for this workspace.
+      # Allows the filtering of requests on a number of criteria such as ApiID, VersionID, Path, Method, etc.
+      base_url = @server_url
+      url = "#{base_url.delete_suffix('/')}/v1/eventlog/query"
+      headers = {}
+      query_params = Utils.get_query_params(Operations::QueryEventLogRequest, request)
+      headers['Accept'] = 'application/json;q=1, application/json;q=0'
+      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
+
+      r = @client.get(url) do |req|
+        req.headers = headers
+        req.params = query_params
+        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::QueryEventLogResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::BoundedRequest])
+          res.bounded_requests = out
+        end
+      else
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
+          res.error = out
+        end
+      end
+      res
+    end
+  end
+end