dub 0.2.2.pre.alpha.77 → 0.2.2.pre.alpha.79

data/lib/open_api_sdk/sdk_hooks/hooks.rb

@@ -0,0 +1,103 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require_relative './registration'
+require_relative './types'
+
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  module SDKHooks
+    class Hooks
+      extend T::Sig
+
+      sig { void }
+      def initialize
+        @sdk_init_hooks = T.let([], T::Array[AbstractSDKInitHook])
+        @before_request_hooks = T.let([], T::Array[AbstractBeforeRequestHook])
+        @after_success_hooks = T.let([], T::Array[AbstractAfterSuccessHook])
+        @after_error_hooks = T.let([], T::Array[AbstractAfterErrorHook])
+        Registration.init_hooks self
+      end
+
+      sig { params(hook: AbstractSDKInitHook).void }
+      def register_sdk_init_hook(hook)
+        @sdk_init_hooks << hook
+      end
+
+      sig { params(hook: AbstractBeforeRequestHook).void }
+      def register_before_request_hook(hook)
+        @before_request_hooks << hook
+      end
+
+      sig { params(hook: AbstractAfterSuccessHook).void }
+      def register_after_success_hook(hook)
+        @after_success_hooks << hook
+      end
+
+      sig { params(hook: AbstractAfterErrorHook).void }
+      def register_after_error_hook(hook)
+        @after_error_hooks << hook
+      end
+
+      sig do
+        params(
+          base_url: String,
+          client: Faraday::Connection
+        ).returns([String, Faraday::Connection])
+      end
+      def sdk_init(base_url:, client:)
+        @sdk_init_hooks.each do |hook|
+          base_url, client = hook.sdk_init(base_url: base_url, client: client)
+        end
+
+        return base_url, client
+      end
+
+      sig do
+        params(
+          hook_ctx: BeforeRequestHookContext,
+          request: Faraday::Request
+        ).returns(Faraday::Request)
+      end
+      def before_request(hook_ctx:, request:)
+        @before_request_hooks.each do |hook|
+          request = hook.before_request(hook_ctx: hook_ctx, request: request)
+        end
+
+        request
+      end
+
+      sig do
+        params(
+          hook_ctx: AfterSuccessHookContext,
+          response: Faraday::Response
+        ).returns(Faraday::Response)
+      end
+      def after_success(hook_ctx:, response:)
+        @after_success_hooks.each do |hook|
+          response = hook.after_success(hook_ctx: hook_ctx, response: response)
+        end
+
+        response
+      end
+
+      sig do
+        params(
+          error: T.nilable(StandardError),
+          hook_ctx: AfterErrorHookContext,
+          response: T.nilable(Faraday::Response)
+        ).returns(T.nilable(Faraday::Response))
+      end
+      def after_error(error:, hook_ctx:, response:)
+        @after_error_hooks.each do |hook|
+          response = hook.after_error(error: error, hook_ctx: hook_ctx, response: response)
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/open_api_sdk/sdk_hooks/registration.rb

@@ -0,0 +1,35 @@
+# typed: true
+# frozen_string_literal: true
+
+#
+# This file is only ever generated once on the first generation and then is free to be modified.
+# Any hooks you wish to add should be registered in the init_hooks method.
+#
+# Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance.
+#
+
+require_relative './types'
+
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  module SDKHooks
+    class Registration
+      extend T::Sig
+
+      sig do
+        params(
+          hooks: Hooks
+        ).void
+      end
+      def self.init_hooks(hooks)
+        # example_hook = ExampleHook.new
+
+        # hooks.register_sdk_init_hook example_hook
+        # hooks.register_before_request_hook example_hook
+        # hooks.register_after_error_hook example_hook
+        # hooks.register_after_success_hook example_hook
+      end
+    end
+  end
+end

data/lib/open_api_sdk/sdk_hooks/types.rb

@@ -0,0 +1,152 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  module SDKHooks
+    class HookContext
+      extend T::Sig
+
+      sig { returns(String) }
+      attr_accessor :base_url
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :oauth2_scopes
+
+      sig { returns(String) }
+      attr_accessor :operation_id
+
+      sig { returns(T.nilable(T.proc.returns(T.untyped))) }
+      attr_accessor :security_source
+
+      sig do
+        params(
+          base_url: String,
+          oauth2_scopes: T.nilable(T::Array[String]),
+          operation_id: String,
+          security_source: T.nilable(T.proc.returns(T.untyped))
+        ).void
+      end
+      def initialize(base_url:, oauth2_scopes:, operation_id:, security_source:)
+        @base_url = T.let(base_url, String)
+        @oauth2_scopes = T.let(oauth2_scopes, T.nilable(T::Array[String]))
+        @operation_id = T.let(operation_id, String)
+        @security_source = T.let(security_source, T.nilable(T.proc.returns(T.untyped)))
+      end
+    end
+
+    class BeforeRequestHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        ).void
+      end
+      def initialize(hook_ctx:)
+        super(
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    class AfterSuccessHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        ).void
+      end
+      def initialize(hook_ctx:)
+        super(
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    class AfterErrorHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        ).void
+      end
+      def initialize(hook_ctx:)
+        super(
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    module AbstractSDKInitHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        abstract.params(
+          base_url: String,
+          client: Faraday::Connection
+        ).returns([String, Faraday::Connection])
+      end
+      def sdk_init(base_url:, client:); end
+    end
+
+    module AbstractBeforeRequestHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        abstract.params(
+          hook_ctx: BeforeRequestHookContext,
+          request: Faraday::Request
+        ).returns(Faraday::Request)
+      end
+      def before_request(hook_ctx:, request:); end
+    end
+
+    module AbstractAfterSuccessHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        abstract.params(
+          hook_ctx: AfterSuccessHookContext,
+          response: Faraday::Response
+        ).returns(Faraday::Response)
+      end
+      def after_success(hook_ctx:, response:); end
+    end
+
+    module AbstractAfterErrorHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        abstract.params(
+          error: T.nilable(StandardError),
+          hook_ctx: AfterErrorHookContext,
+          response: T.nilable(Faraday::Response)
+        ).returns(T.nilable(Faraday::Response))
+      end
+      def after_error(error:, hook_ctx:, response:); end
+    end
+  end
+end

data/lib/open_api_sdk/sdkconfiguration.rb

@@ -7,6 +7,7 @@ require 'faraday'
 require 'faraday/multipart'
 require 'faraday/retry'
 require 'sorbet-runtime'
+require_relative 'sdk_hooks/hooks'
 require_relative 'utils/retries'
 
 module OpenApiSDK
@@ -21,7 +22,9 @@ module OpenApiSDK
     extend T::Sig
 
     field :client, T.nilable(Faraday::Connection)
+    field :hooks, ::OpenApiSDK::SDKHooks::Hooks
     field :retry_config, T.nilable(::OpenApiSDK::Utils::RetryConfig)
+    field :timeout, T.nilable(Float)
     field :security_source, T.nilable(T.proc.returns(T.nilable(::OpenApiSDK::Shared::Security)))
     field :server_url, T.nilable(String)
     field :server_idx, T.nilable(Integer)
@@ -34,17 +37,21 @@ module OpenApiSDK
     sig do
       params(
         client: T.nilable(Faraday::Connection),
+        hooks: ::OpenApiSDK::SDKHooks::Hooks,
         retry_config: T.nilable(::OpenApiSDK::Utils::RetryConfig),
+        timeout_ms: T.nilable(Integer),
         security: T.nilable(::OpenApiSDK::Shared::Security),
         security_source: T.nilable(T.proc.returns(::OpenApiSDK::Shared::Security)),
         server_url: T.nilable(String),
         server_idx: T.nilable(Integer)
       ).void
     end
-    def initialize(client, retry_config, security, security_source, server_url, server_idx)
+    def initialize(client, hooks, retry_config, timeout_ms, security, security_source, server_url, server_idx)
       @client = client
+      @hooks = hooks
       @retry_config = retry_config
       @server_url = server_url
+      @timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
       @server_idx = server_idx.nil? ? 0 : server_idx
       raise StandardError, "Invalid server index #{server_idx}" if @server_idx.negative? || @server_idx >= SERVERS.length
       if !security_source.nil?
@@ -54,9 +61,9 @@ module OpenApiSDK
       end
       @language = 'ruby'
       @openapi_doc_version = '0.0.1'
-      @sdk_version = '0.2.2-alpha.77'
-      @gen_version = '2.548.6'
-      @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.77 2.548.6 0.0.1 dub'
+      @sdk_version = '0.2.2-alpha.79'
+      @gen_version = '2.559.0'
+      @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.79 2.559.0 0.0.1 dub'
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

data/lib/open_api_sdk/tags.rb

@@ -7,6 +7,7 @@ require 'faraday'
 require 'faraday/multipart'
 require 'faraday/retry'
 require 'sorbet-runtime'
+require_relative 'sdk_hooks/hooks'
 require_relative 'utils/retries'
 
 module OpenApiSDK
@@ -21,8 +22,8 @@ module OpenApiSDK
     end
 
 
-    sig { params(request: T.nilable(::OpenApiSDK::Operations::CreateTagRequestBody)).returns(::OpenApiSDK::Operations::CreateTagResponse) }
-    def create(request)
+    sig { params(request: T.nilable(::OpenApiSDK::Operations::CreateTagRequestBody), timeout_ms: T.nilable(Integer)).returns(::OpenApiSDK::Operations::CreateTagResponse) }
+    def create(request, timeout_ms = nil)
       # create - Create a new tag
       # Create a new tag for the authenticated workspace.
       url, params = @sdk_configuration.get_server_details
@@ -31,21 +32,71 @@ module OpenApiSDK
       headers = {}
       req_content_type, data, form = Utils.serialize_request_body(request, :request, :json)
       headers['content-type'] = req_content_type
+
+      if form
+        body = Utils.encode_form(form)
+      elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
+        body = URI.encode_www_form(data)
+      else
+        body = data
+      end
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
+      security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
       connection = @sdk_configuration.client
 
-      r = connection.post(url) do |req|
-        req.headers = headers
-        security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
-        Utils.configure_request_security(req, security) if !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)
+      hook_ctx = SDKHooks::HookContext.new(
+        base_url: base_url,
+        oauth2_scopes: [],
+        operation_id: 'createTag',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      r = T.let(nil, T.nilable(Faraday::Response))
+      
+      begin
+        r = connection.post(url) do |req|
+          req.body = body
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if r.nil? || Utils.error_status?(r.status)
+          r = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
         else
-          req.body = data
+          r = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        end
+        
+        if r.nil?
+          raise error if !error.nil?
+          raise 'no response'
         end
       end
 
@@ -110,8 +161,8 @@ module OpenApiSDK
     end
 
 
-    sig { params(request: T.nilable(::OpenApiSDK::Operations::GetTagsRequest)).returns(::OpenApiSDK::Operations::GetTagsResponse) }
-    def list(request)
+    sig { params(request: T.nilable(::OpenApiSDK::Operations::GetTagsRequest), timeout_ms: T.nilable(Integer)).returns(::OpenApiSDK::Operations::GetTagsResponse) }
+    def list(request, timeout_ms = nil)
       # list - Retrieve a list of tags
       # Retrieve a list of tags for the authenticated workspace.
       url, params = @sdk_configuration.get_server_details
@@ -122,13 +173,61 @@ module OpenApiSDK
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
+      security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
       connection = @sdk_configuration.client
 
-      r = connection.get(url) do |req|
-        req.headers = headers
-        req.params = query_params
-        security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
-        Utils.configure_request_security(req, security) if !security.nil?
+      hook_ctx = SDKHooks::HookContext.new(
+        base_url: base_url,
+        oauth2_scopes: [],
+        operation_id: 'getTags',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      r = T.let(nil, T.nilable(Faraday::Response))
+      
+      begin
+        r = connection.get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          req.params = query_params
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if r.nil? || Utils.error_status?(r.status)
+          r = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        else
+          r = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        end
+        
+        if r.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -192,8 +291,8 @@ module OpenApiSDK
     end
 
 
-    sig { params(request: T.nilable(::OpenApiSDK::Operations::UpdateTagRequest)).returns(::OpenApiSDK::Operations::UpdateTagResponse) }
-    def update(request)
+    sig { params(request: T.nilable(::OpenApiSDK::Operations::UpdateTagRequest), timeout_ms: T.nilable(Integer)).returns(::OpenApiSDK::Operations::UpdateTagResponse) }
+    def update(request, timeout_ms = nil)
       # update - Update a tag
       # Update a tag in the workspace.
       url, params = @sdk_configuration.get_server_details
@@ -207,21 +306,71 @@ module OpenApiSDK
       headers = {}
       req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
       headers['content-type'] = req_content_type
+
+      if form
+        body = Utils.encode_form(form)
+      elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
+        body = URI.encode_www_form(data)
+      else
+        body = data
+      end
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
+      security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
       connection = @sdk_configuration.client
 
-      r = connection.patch(url) do |req|
-        req.headers = headers
-        security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
-        Utils.configure_request_security(req, security) if !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)
+      hook_ctx = SDKHooks::HookContext.new(
+        base_url: base_url,
+        oauth2_scopes: [],
+        operation_id: 'updateTag',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      r = T.let(nil, T.nilable(Faraday::Response))
+      
+      begin
+        r = connection.patch(url) do |req|
+          req.body = body
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if r.nil? || Utils.error_status?(r.status)
+          r = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
         else
-          req.body = data
+          r = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        end
+        
+        if r.nil?
+          raise error if !error.nil?
+          raise 'no response'
         end
       end
 
@@ -286,8 +435,8 @@ module OpenApiSDK
     end
 
 
-    sig { params(request: T.nilable(::OpenApiSDK::Operations::DeleteTagRequest)).returns(::OpenApiSDK::Operations::DeleteTagResponse) }
-    def delete(request)
+    sig { params(request: T.nilable(::OpenApiSDK::Operations::DeleteTagRequest), timeout_ms: T.nilable(Integer)).returns(::OpenApiSDK::Operations::DeleteTagResponse) }
+    def delete(request, timeout_ms = nil)
       # delete - Delete a tag
       # Delete a tag from the workspace. All existing links will still work, but they will no longer be associated with this tag.
       url, params = @sdk_configuration.get_server_details
@@ -302,12 +451,60 @@ module OpenApiSDK
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
+      security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
       connection = @sdk_configuration.client
 
-      r = connection.delete(url) do |req|
-        req.headers = headers
-        security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
-        Utils.configure_request_security(req, security) if !security.nil?
+      hook_ctx = SDKHooks::HookContext.new(
+        base_url: base_url,
+        oauth2_scopes: [],
+        operation_id: 'deleteTag',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      r = T.let(nil, T.nilable(Faraday::Response))
+      
+      begin
+        r = connection.delete(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if r.nil? || Utils.error_status?(r.status)
+          r = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        else
+          r = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        end
+        
+        if r.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')