speakeasy_client_sdk_ruby 1.14.0 → 1.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0bad8575d972ac91e883d81ea26ca53b3600980235334d2c0305d83c9e171b2
-  data.tar.gz: 7c6827f59565718a0f48adf1bc4b8b533560ba03ad9e38e2914648cc7519be89
+  metadata.gz: fa180e6ab1d595a096ae6e65f3a5b4690c1751a37167d8a80a4c5af6427d33b0
+  data.tar.gz: 48f97699c4ab8cc7aaad233a8e5685f30445362e7b8fa7b23d21ee04f3eea405
 SHA512:
-  metadata.gz: accd6dc3bd6284c5dd81834753e2643818fc32cad334e2ce7ec5bdc6b68503a17075513473babfff8105b5a6f0e90de2c1d394d42928906cc46faff86ed1daf9
-  data.tar.gz: 9ca3d7c08a1f6c596513288445c2801f704cce7398138d895ef7b74749c0133abb1aac2dd058c1abc6c66a05441ff4414e61a075af783cb12ce6c0a89ee26fc9
+  metadata.gz: 5f737e85b8dac4d413fe3674c68b771daae5d2623bfea907eb95c45b401686cb8f88390af43b7355b55d1d48d42efe98f3d314ab559822c413d562f4f96dd2ef
+  data.tar.gz: 0cd9d71e4531774fd9e60b13e424f1e4a34976b78227f6e23a53d14001ce1539fb33d35f2d65e0b50fc8fbc4812247d67bd4f3aeacdad2b985a2d945fdf3ef54

data/lib/sdk/apiendpoints.rb

@@ -10,23 +10,19 @@ require 'sorbet-runtime'
 module SpeakeasyClientSDK
   extend T::Sig
   class ApiEndpoints
+    # REST APIs for managing ApiEndpoint entities
     extend T::Sig
-    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String, openapi_doc_version: String).void }
-    def initialize(sdk, client, server_url, language, sdk_version, gen_version, openapi_doc_version)
-      @sdk = sdk
-      @client = client
-      @server_url = server_url
-      @language = language
-      @sdk_version = sdk_version
-      @gen_version = gen_version
-      @openapi_doc_version = openapi_doc_version
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
     end
 
     sig { params(request: Operations::DeleteApiEndpointRequest).returns(Utils::FieldAugmented) }
     def delete_api_endpoint(request)
       # delete_api_endpoint - Delete an ApiEndpoint.
       # Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::DeleteApiEndpointRequest,
         base_url,
@@ -35,11 +31,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.delete(url) do |req|
+      r = @sdk_configuration.client.delete(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -62,7 +58,8 @@ module SpeakeasyClientSDK
       # find_api_endpoint - Find an ApiEndpoint via its displayName.
       # Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema).
       # This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::FindApiEndpointRequest,
         base_url,
@@ -71,11 +68,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -102,7 +99,8 @@ module SpeakeasyClientSDK
       # generate_open_api_spec_for_api_endpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
       # This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document.
       # Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GenerateOpenApiSpecForApiEndpointRequest,
         base_url,
@@ -111,11 +109,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -141,7 +139,8 @@ module SpeakeasyClientSDK
     def generate_postman_collection_for_api_endpoint(request)
       # generate_postman_collection_for_api_endpoint - Generate a Postman collection for a particular ApiEndpoint.
       # Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GeneratePostmanCollectionForApiEndpointRequest,
         base_url,
@@ -150,11 +149,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -176,7 +175,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::GetAllApiEndpointsRequest).returns(Utils::FieldAugmented) }
     def get_all_api_endpoints(request)
       # get_all_api_endpoints - Get all Api endpoints for a particular apiID.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetAllApiEndpointsRequest,
         base_url,
@@ -185,11 +185,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -214,7 +214,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::GetAllForVersionApiEndpointsRequest).returns(Utils::FieldAugmented) }
     def get_all_for_version_api_endpoints(request)
       # get_all_for_version_api_endpoints - Get all ApiEndpoints for a particular apiID and versionID.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetAllForVersionApiEndpointsRequest,
         base_url,
@@ -223,11 +224,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -252,7 +253,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::GetApiEndpointRequest).returns(Utils::FieldAugmented) }
     def get_api_endpoint(request)
       # get_api_endpoint - Get an ApiEndpoint.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetApiEndpointRequest,
         base_url,
@@ -261,11 +263,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -291,7 +293,8 @@ module SpeakeasyClientSDK
     def upsert_api_endpoint(request)
       # upsert_api_endpoint - Upsert an ApiEndpoint.
       # Upsert an ApiEndpoint. If the ApiEndpoint does not exist it will be created, otherwise it will be updated.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::UpsertApiEndpointRequest,
         base_url,
@@ -303,11 +306,11 @@ module SpeakeasyClientSDK
       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} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.put(url) do |req|
+      r = @sdk_configuration.client.put(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
         if form
           req.body = Utils.encode_form(form)
         elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')

data/lib/sdk/apis.rb

@@ -10,23 +10,19 @@ require 'sorbet-runtime'
 module SpeakeasyClientSDK
   extend T::Sig
   class Apis
+    # REST APIs for managing Api entities
     extend T::Sig
-    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String, openapi_doc_version: String).void }
-    def initialize(sdk, client, server_url, language, sdk_version, gen_version, openapi_doc_version)
-      @sdk = sdk
-      @client = client
-      @server_url = server_url
-      @language = language
-      @sdk_version = sdk_version
-      @gen_version = gen_version
-      @openapi_doc_version = openapi_doc_version
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
     end
 
     sig { params(request: Operations::DeleteApiRequest).returns(Utils::FieldAugmented) }
     def delete_api(request)
       # delete_api - Delete an Api.
       # Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore).
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::DeleteApiRequest,
         base_url,
@@ -35,11 +31,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.delete(url) do |req|
+      r = @sdk_configuration.client.delete(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -62,7 +58,8 @@ module SpeakeasyClientSDK
       # generate_open_api_spec - Generate an OpenAPI specification for a particular Api.
       # This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document.
       # Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GenerateOpenApiSpecRequest,
         base_url,
@@ -71,11 +68,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -101,7 +98,8 @@ module SpeakeasyClientSDK
     def generate_postman_collection(request)
       # generate_postman_collection - Generate a Postman collection for a particular Api.
       # Generates a postman collection containing all endpoints for a particular API. Includes variables produced for any path/query/header parameters included in the OpenAPI document.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GeneratePostmanCollectionRequest,
         base_url,
@@ -110,11 +108,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -138,7 +136,8 @@ module SpeakeasyClientSDK
       # get_all_api_versions - Get all Api versions for a particular ApiEndpoint.
       # Get all Api versions for a particular ApiEndpoint.
       # Supports filtering the versions based on metadata attributes.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetAllApiVersionsRequest,
         base_url,
@@ -148,12 +147,12 @@ module SpeakeasyClientSDK
       headers = {}
       query_params = Utils.get_query_params(Operations::GetAllApiVersionsRequest, request)
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.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?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -180,17 +179,18 @@ module SpeakeasyClientSDK
       # get_apis - Get a list of Apis for a given workspace
       # Get a list of all Apis and their versions for a given workspace.
       # Supports filtering the APIs based on metadata attributes.
-      base_url = @server_url
-      url = "#{base_url.delete_suffix('/')}/v1/apis"
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/v1/apis"
       headers = {}
       query_params = Utils.get_query_params(Operations::GetApisRequest, request)
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.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?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -217,7 +217,8 @@ module SpeakeasyClientSDK
       # upsert_api - Upsert an Api
       # Upsert an Api. If the Api does not exist, it will be created.
       # If the Api exists, it will be updated.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::UpsertApiRequest,
         base_url,
@@ -229,11 +230,11 @@ module SpeakeasyClientSDK
       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} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.put(url) do |req|
+      r = @sdk_configuration.client.put(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
         if form
           req.body = Utils.encode_form(form)
         elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')

data/lib/sdk/embeds.rb

@@ -10,16 +10,11 @@ require 'sorbet-runtime'
 module SpeakeasyClientSDK
   extend T::Sig
   class Embeds
+    # REST APIs for managing embeds
     extend T::Sig
-    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String, openapi_doc_version: String).void }
-    def initialize(sdk, client, server_url, language, sdk_version, gen_version, openapi_doc_version)
-      @sdk = sdk
-      @client = client
-      @server_url = server_url
-      @language = language
-      @sdk_version = sdk_version
-      @gen_version = gen_version
-      @openapi_doc_version = openapi_doc_version
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
     end
 
     sig { params(request: Operations::GetEmbedAccessTokenRequest).returns(Utils::FieldAugmented) }
@@ -27,17 +22,18 @@ module SpeakeasyClientSDK
       # get_embed_access_token - Get an embed access token for the current workspace.
       # Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content.
       # Filters can be applied allowing views to be filtered to things like particular customerIds.
-      base_url = @server_url
-      url = "#{base_url.delete_suffix('/')}/v1/workspace/embed-access-token"
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/v1/workspace/embed-access-token"
       headers = {}
       query_params = Utils.get_query_params(Operations::GetEmbedAccessTokenRequest, request)
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.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?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -62,15 +58,16 @@ module SpeakeasyClientSDK
     sig { returns(Utils::FieldAugmented) }
     def get_valid_embed_access_tokens
       # get_valid_embed_access_tokens - Get all valid embed access tokens for the current workspace.
-      base_url = @server_url
-      url = "#{base_url.delete_suffix('/')}/v1/workspace/embed-access-tokens/valid"
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/v1/workspace/embed-access-tokens/valid"
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -95,7 +92,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::RevokeEmbedAccessTokenRequest).returns(Utils::FieldAugmented) }
     def revoke_embed_access_token(request)
       # revoke_embed_access_token - Revoke an embed access EmbedToken.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::RevokeEmbedAccessTokenRequest,
         base_url,
@@ -104,11 +102,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.delete(url) do |req|
+      r = @sdk_configuration.client.delete(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

data/lib/sdk/metadata.rb

@@ -10,22 +10,18 @@ require 'sorbet-runtime'
 module SpeakeasyClientSDK
   extend T::Sig
   class Metadata
+    # REST APIs for managing Version Metadata entities
     extend T::Sig
-    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String, openapi_doc_version: String).void }
-    def initialize(sdk, client, server_url, language, sdk_version, gen_version, openapi_doc_version)
-      @sdk = sdk
-      @client = client
-      @server_url = server_url
-      @language = language
-      @sdk_version = sdk_version
-      @gen_version = gen_version
-      @openapi_doc_version = openapi_doc_version
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
     end
 
     sig { params(request: Operations::DeleteVersionMetadataRequest).returns(Utils::FieldAugmented) }
     def delete_version_metadata(request)
       # delete_version_metadata - Delete metadata for a particular apiID and versionID.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::DeleteVersionMetadataRequest,
         base_url,
@@ -34,11 +30,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.delete(url) do |req|
+      r = @sdk_configuration.client.delete(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -59,7 +55,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::GetVersionMetadataRequest).returns(Utils::FieldAugmented) }
     def get_version_metadata(request)
       # get_version_metadata - Get all metadata for a particular apiID and versionID.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetVersionMetadataRequest,
         base_url,
@@ -68,11 +65,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -97,7 +94,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::InsertVersionMetadataRequest).returns(Utils::FieldAugmented) }
     def insert_version_metadata(request)
       # insert_version_metadata - Insert metadata for a particular apiID and versionID.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::InsertVersionMetadataRequest,
         base_url,
@@ -109,11 +107,11 @@ module SpeakeasyClientSDK
       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} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.post(url) do |req|
+      r = @sdk_configuration.client.post(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
         if form
           req.body = Utils.encode_form(form)
         elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')

data/lib/sdk/plugins.rb

@@ -10,30 +10,26 @@ require 'sorbet-runtime'
 module SpeakeasyClientSDK
   extend T::Sig
   class Plugins
+    # REST APIs for managing and running plugins
     extend T::Sig
-    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String, openapi_doc_version: String).void }
-    def initialize(sdk, client, server_url, language, sdk_version, gen_version, openapi_doc_version)
-      @sdk = sdk
-      @client = client
-      @server_url = server_url
-      @language = language
-      @sdk_version = sdk_version
-      @gen_version = gen_version
-      @openapi_doc_version = openapi_doc_version
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
     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"
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/v1/plugins"
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -58,7 +54,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::RunPluginRequest).returns(Utils::FieldAugmented) }
     def run_plugin(request)
       # run_plugin - Run a plugin
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::RunPluginRequest,
         base_url,
@@ -68,12 +65,12 @@ module SpeakeasyClientSDK
       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} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.post(url) do |req|
+      r = @sdk_configuration.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?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -98,18 +95,19 @@ module SpeakeasyClientSDK
     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"
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/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} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.put(url) do |req|
+      r = @sdk_configuration.client.put(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
         if form
           req.body = Utils.encode_form(form)
         elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')

data/lib/sdk/requests.rb

@@ -10,16 +10,11 @@ require 'sorbet-runtime'
 module SpeakeasyClientSDK
   extend T::Sig
   class Requests
+    # REST APIs for retrieving request information
     extend T::Sig
-    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String, openapi_doc_version: String).void }
-    def initialize(sdk, client, server_url, language, sdk_version, gen_version, openapi_doc_version)
-      @sdk = sdk
-      @client = client
-      @server_url = server_url
-      @language = language
-      @sdk_version = sdk_version
-      @gen_version = gen_version
-      @openapi_doc_version = openapi_doc_version
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
     end
 
     sig { params(request: Operations::GenerateRequestPostmanCollectionRequest).returns(Utils::FieldAugmented) }
@@ -27,7 +22,8 @@ module SpeakeasyClientSDK
       # 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, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GenerateRequestPostmanCollectionRequest,
         base_url,
@@ -36,11 +32,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -62,7 +58,8 @@ module SpeakeasyClientSDK
     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, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetRequestFromEventLogRequest,
         base_url,
@@ -71,11 +68,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -102,17 +99,18 @@ module SpeakeasyClientSDK
       # 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"
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/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} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.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?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

data/lib/sdk/schemas.rb

@@ -10,22 +10,18 @@ require 'sorbet-runtime'
 module SpeakeasyClientSDK
   extend T::Sig
   class Schemas
+    # REST APIs for managing Schema entities
     extend T::Sig
-    sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String, openapi_doc_version: String).void }
-    def initialize(sdk, client, server_url, language, sdk_version, gen_version, openapi_doc_version)
-      @sdk = sdk
-      @client = client
-      @server_url = server_url
-      @language = language
-      @sdk_version = sdk_version
-      @gen_version = gen_version
-      @openapi_doc_version = openapi_doc_version
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
     end
 
     sig { params(request: Operations::DeleteSchemaRequest).returns(Utils::FieldAugmented) }
     def delete_schema(request)
       # delete_schema - Delete a particular schema revision for an Api.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::DeleteSchemaRequest,
         base_url,
@@ -34,11 +30,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.delete(url) do |req|
+      r = @sdk_configuration.client.delete(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -59,7 +55,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::DownloadSchemaRequest).returns(Utils::FieldAugmented) }
     def download_schema(request)
       # download_schema - Download the latest schema for a particular apiID.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::DownloadSchemaRequest,
         base_url,
@@ -68,11 +65,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0.7, application/x-yaml;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -95,7 +92,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::DownloadSchemaRevisionRequest).returns(Utils::FieldAugmented) }
     def download_schema_revision(request)
       # download_schema_revision - Download a particular schema revision for an Api.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::DownloadSchemaRevisionRequest,
         base_url,
@@ -104,11 +102,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0.7, application/x-yaml;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -133,7 +131,8 @@ module SpeakeasyClientSDK
       # get_schema - Get information about the latest schema.
       # Returns information about the last uploaded schema for a particular API version. 
       # This won't include the schema itself, that can be retrieved via the downloadSchema operation.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetSchemaRequest,
         base_url,
@@ -142,11 +141,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -171,7 +170,8 @@ module SpeakeasyClientSDK
     sig { params(request: Operations::GetSchemaDiffRequest).returns(Utils::FieldAugmented) }
     def get_schema_diff(request)
       # get_schema_diff - Get a diff of two schema revisions for an Api.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetSchemaDiffRequest,
         base_url,
@@ -180,11 +180,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -211,7 +211,8 @@ module SpeakeasyClientSDK
       # get_schema_revision - Get information about a particular schema revision for an Api.
       # Returns information about the last uploaded schema for a particular schema revision. 
       # This won't include the schema itself, that can be retrieved via the downloadSchema operation.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetSchemaRevisionRequest,
         base_url,
@@ -220,11 +221,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -251,7 +252,8 @@ module SpeakeasyClientSDK
       # get_schemas - Get information about all schemas associated with a particular apiID.
       # Returns information the schemas associated with a particular apiID. 
       # This won't include the schemas themselves, they can be retrieved via the downloadSchema operation.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::GetSchemasRequest,
         base_url,
@@ -260,11 +262,11 @@ module SpeakeasyClientSDK
       )
       headers = {}
       headers['Accept'] = 'application/json;q=1, application/json;q=0'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
@@ -291,7 +293,8 @@ module SpeakeasyClientSDK
       # register_schema - Register a schema.
       # Allows uploading a schema for a particular API version.
       # This will be used to populate ApiEndpoints and used as a base for any schema generation if present.
-      base_url = @server_url
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
         Operations::RegisterSchemaRequest,
         base_url,
@@ -303,11 +306,11 @@ module SpeakeasyClientSDK
       headers['content-type'] = req_content_type
       raise StandardError, 'request body is required' if data.nil? && form.nil?
       headers['Accept'] = 'application/json'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.post(url) do |req|
+      r = @sdk_configuration.client.post(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
         if form
           req.body = Utils.encode_form(form)
         elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')

data/lib/sdk/sdk.rb

@@ -8,10 +8,7 @@ require 'faraday/multipart'
 require 'sorbet-runtime'
 module SpeakeasyClientSDK
   extend T::Sig
-  SERVER_PROD = 'prod'
-  SERVERS = {
-    SERVER_PROD: 'https://api.prod.speakeasyapi.dev'
-  }.freeze
+
   class SDK
     extend T::Sig
 
@@ -20,7 +17,7 @@ module SpeakeasyClientSDK
     attr_accessor :security, :language, :sdk_version, :gen_version
 
     sig do
-      params(security: Shared::Security,
+      params(security: T.nilable(Shared::Security),
              server: String,
              server_url: String,
              url_params: T::Hash[Symbol, String],
@@ -39,128 +36,75 @@ module SpeakeasyClientSDK
       # @param [Hash<Symbol, String>] url_params Parameters to optionally template the server URL with
       # @param [Faraday::Request] client The faraday HTTP client to use for all operations
 
-      @client = Faraday.new(request: {
-                              params_encoder: Faraday::FlatParamsEncoder
-                            }) do |f|
-        f.request :multipart, {}
-        # f.response :logger
+      if client.nil?
+        client = Faraday.new(request: {
+                          params_encoder: Faraday::FlatParamsEncoder
+                        }) do |f|
+          f.request :multipart, {}
+          # f.response :logger
+        end
       end
 
-      
+      if !server_url.nil?
+        if !url_params.nil?
+          server_url = Utils.template_url(server_url, url_params)
+        end
+      end
+      server = SERVER_PROD if server.nil?
 
+      
 
-      @security = nil
-      @server_url = SERVERS[SERVER_PROD]
-      @language = 'ruby'
-      @sdk_version = '1.14.0'
-      @gen_version = '2.65.0'
-      @openapi_doc_version = '0.3.0'
+      @sdk_configuration = SDKConfiguration.new(client, security, server_url, server)
       init_sdks
     end
 
-    sig { params(server_url: String, params: T.nilable(T::Hash[Symbol, String])).void }
-    def config_server_url(server_url, params)
-      if params.nil?
-        @server_url = server_url
-      else
-        @server_url = Utils.template_url(server_url, params)
+    sig { params(params: T.nilable(T::Hash[Symbol, String])).void }
+    def config_server_url(params)
+      if !params.nil?
+        @server_url = Utils.template_url(@server_url, params)
       end
       init_sdks
     end
 
     sig { params(server: String, params: T.nilable(T::Hash[Symbol, String])).void }
-    def config_server(server, params)
+    def config_server(params)
       raise StandardError, 'Invalid server' if !SERVERS.include? server
 
-      config_server_url(SERVERS[server], params)
+      config_server_url(params)
       init_sdks
     end
 
     sig { params(security: Shared::Security).void }
     def config_security(security)
       @security = security
+      @sdk_configuration.security = security
     end
 
     sig { void }
     def init_sdks
-      @api_endpoints = ApiEndpoints.new(
-        self,
-        @client,
-        @server_url,
-        @language,
-        @sdk_version,
-        @gen_version,
-        @openapi_doc_version
-      )
-      @apis = Apis.new(
-        self,
-        @client,
-        @server_url,
-        @language,
-        @sdk_version,
-        @gen_version,
-        @openapi_doc_version
-      )
-      @embeds = Embeds.new(
-        self,
-        @client,
-        @server_url,
-        @language,
-        @sdk_version,
-        @gen_version,
-        @openapi_doc_version
-      )
-      @metadata = Metadata.new(
-        self,
-        @client,
-        @server_url,
-        @language,
-        @sdk_version,
-        @gen_version,
-        @openapi_doc_version
-      )
-      @plugins = Plugins.new(
-        self,
-        @client,
-        @server_url,
-        @language,
-        @sdk_version,
-        @gen_version,
-        @openapi_doc_version
-      )
-      @requests = Requests.new(
-        self,
-        @client,
-        @server_url,
-        @language,
-        @sdk_version,
-        @gen_version,
-        @openapi_doc_version
-      )
-      @schemas = Schemas.new(
-        self,
-        @client,
-        @server_url,
-        @language,
-        @sdk_version,
-        @gen_version,
-        @openapi_doc_version
-      )
+      @api_endpoints = ApiEndpoints.new(@sdk_configuration)
+      @apis = Apis.new(@sdk_configuration)
+      @embeds = Embeds.new(@sdk_configuration)
+      @metadata = Metadata.new(@sdk_configuration)
+      @plugins = Plugins.new(@sdk_configuration)
+      @requests = Requests.new(@sdk_configuration)
+      @schemas = Schemas.new(@sdk_configuration)
     end
 
     
     sig { returns(Utils::FieldAugmented) }
     def validate_api_key
       # validate_api_key - Validate the current api key.
-      base_url = @server_url
-      url = "#{base_url.delete_suffix('/')}/v1/auth/validate"
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/v1/auth/validate"
       headers = {}
       headers['Accept'] = 'application/json'
-      headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version} #{@openapi_doc_version}"
+      headers['user-agent'] = "speakeasy-sdk/#{@sdk_configuration.language} #{@sdk_configuration.sdk_version} #{@sdk_configuration.gen_version} #{@sdk_configuration.openapi_doc_version}"
 
-      r = @client.get(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

data/lib/sdk/sdkconfiguration.rb

@@ -0,0 +1,53 @@
+# 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 OpenApiSDK
+  extend T::Sig
+
+
+  SERVER_PROD = 'prod'
+  SERVERS = {
+    SERVER_PROD: 'https://api.prod.speakeasyapi.dev',
+  }.freeze
+  # Contains the list of servers available to the SDK
+
+
+  class SDKConfiguration < OpenApiSDK::Utils::FieldAugmented
+    extend T::Sig
+
+    field :client, T.nilable(Faraday::Connection)
+    field :security, Shared::Security
+    field :server_url, T.nilable(String)
+    field :server, T.nilable(String)
+    field :server_defaults, Hash[Symbol, Hash[Symbol, String]], { 'default_factory': Hash}
+    field :language, String
+    field :openapi_doc_version, String
+    field :sdk_version, String
+    field :gen_version, String
+  
+    
+    sig { params(client: Faraday::Connection, security: T.nilable(Shared::Security), server_url: T.nilable(String), server_idx: T.nilable(Integer), server_defaults: T::Hash[Symbol, String], globals: T::Hash[Symbol, T::Hash[Symbol, T::Hash[Symbol, Object]]]).void }
+    def initialize(client, security, server_url, server_idx, server_defaults, globals)
+      @client = client
+      @server = server_url.nil? ? '' : server_url
+      @language = 'ruby'
+      @openapi_doc_version = '0.3.0'
+      @sdk_version = '1.15.1'
+      @gen_version = '2.73.1'
+    end
+
+    sig { returns([String, T::Hash[Symbol, String]]) }
+    def get_server_details
+      return [@server_url.delete_suffix('/'), {}] if !@server_url.nil?
+      @server = SERVER_PROD if @server.nil?
+
+      [SERVERS[@server], {}]
+    end
+  end
+end

data/lib/sdk/utils/utils.rb

@@ -707,7 +707,12 @@ module SpeakeasyClientSDK
     sig { params(url_with_params: String, params: T::Hash[Symbol, String]).returns(String) }
     def self.template_url(url_with_params, params)
       params.each do |key, value|
-        url_with_params = url_with_params.gsub("{#{key}}", value)
+        if value.respond_to? :serialize
+          val_str = value.serialize
+        else
+          val_str = value
+        end
+        url_with_params = url_with_params.gsub("{#{key}}", val_str)
       end
 
       url_with_params

data/lib/speakeasy_client_sdk_ruby.rb

@@ -58,6 +58,7 @@ require_relative 'sdk/models/operations/upsertapi'
 require_relative 'sdk/models/operations/upsertapiendpoint'
 require_relative 'sdk/models/operations/upsertplugin'
 require_relative 'sdk/models/operations/validateapikey'
+require_relative 'sdk/sdkconfiguration'
 require_relative 'sdk/apiendpoints'
 require_relative 'sdk/apis'
 require_relative 'sdk/embeds'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speakeasy_client_sdk_ruby
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.1
 platform: ruby
 authors:
 - Speakeasy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -173,6 +173,7 @@ files:
 - lib/sdk/requests.rb
 - lib/sdk/schemas.rb
 - lib/sdk/sdk.rb
+- lib/sdk/sdkconfiguration.rb
 - lib/sdk/utils/metadata_fields.rb
 - lib/sdk/utils/retries.rb
 - lib/sdk/utils/utils.rb