speakeasy_client_sdk_ruby 4.2.22 → 4.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8a5731c0420f94cc24b19628d709a5a5e5507d386b7c168ff06d30c60f3ec95
-  data.tar.gz: ab04beeffa7a6d6ce7423ebb698df763e81b4c2a8051bb0ddefecc49b5ed6e49
+  metadata.gz: 4f5927380a6ad793886453e7f778b41fdab43d1322527e0f2541756806eab40b
+  data.tar.gz: ae1497fd7a37c39d3224a0521c3b0630933922815ede71c53ec885e9aa83d90f
 SHA512:
-  metadata.gz: 69f18cfa731720a8ee19f26997b307efde02a3d8680fc2ff6ee31fb94849e4b9537d08ad17291efed89a01d335ad7775093d00c620662607165510d5dc39a7fe
-  data.tar.gz: 5f79f2cb7290f3696ab0385eecbd701979093291fa2c8d99a77dfbc5277313500a948a7d6f2b9c2d6755a71eb49592bdbf5a7b1d88c0a14d9fff819b8629c503
+  metadata.gz: 90d2e7573e03a33dde35027213bd26aa34f3b4cbf49949a7a7aaf7b3337d4fb3577b33327db0de16441b7a04b361889a6871891e0e20761336f4731a3402ec1f
+  data.tar.gz: 6bc07d991c90867e104ba33a61242f1c80d3ecfab7c57cee5621371f3aca8225e21cd262e23dcb13854403dd8a96ac2282f61943e4db6a0f77e3d353571d420c

data/lib/open_api_sdk/apiendpoints.rb

@@ -0,0 +1,66 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'sorbet-runtime'
+
+module OpenApiSDK
+  extend T::Sig
+  class Apiendpoints
+    extend T::Sig
+
+
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
+    end
+
+
+    sig { params(api_id: ::String).returns(::OpenApiSDK::Operations::GetAllApiEndpointsResponse) }
+    def list(api_id)
+      # list - Get all Api endpoints for a particular apiID.
+      request = ::OpenApiSDK::Operations::GetAllApiEndpointsRequest.new(
+        
+        api_id: api_id
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        ::OpenApiSDK::Operations::GetAllApiEndpointsRequest,
+        base_url,
+        '/v1/apis/{apiID}/api_endpoints',
+        request,
+        @sdk_configuration.globals
+      )
+      headers = {}
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        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')
+
+      res = ::OpenApiSDK::Operations::GetAllApiEndpointsResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status >= 200 && r.status < 300
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[::OpenApiSDK::Shared::ApiEndpoint])
+          res.api_endpoints = out
+        end
+      elsif r.status >= 400 && r.status < 500
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error)
+          res.error = out
+        end
+      end
+      res
+    end
+  end
+end

data/lib/{speakeasy_client_sdk → open_api_sdk}/apis.rb

@@ -7,7 +7,7 @@ require 'faraday'
 require 'faraday/multipart'
 require 'sorbet-runtime'
 
-module SpeakeasyClientSDK
+module OpenApiSDK
   extend T::Sig
   class Apis
     extend T::Sig
@@ -19,38 +19,43 @@ module SpeakeasyClientSDK
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::DeleteApiRequest)).returns(::SpeakeasyClientSDK::Operations::DeleteApiResponse) }
-    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).
+    sig { params(op: T.nilable(::OpenApiSDK::Operations::Op), metadata: T.nilable(T::Hash[Symbol, T::Array[::String]])).returns(::OpenApiSDK::Operations::GetApisResponse) }
+    def get_all(op = nil, metadata = nil)
+      # get_all - 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.
+      request = ::OpenApiSDK::Operations::GetApisRequest.new(
+        
+        op: op,
+        metadata: metadata
+      )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
-      url = Utils.generate_url(
-        ::SpeakeasyClientSDK::Operations::DeleteApiRequest,
-        base_url,
-        '/v1/apis/{apiID}/version/{versionID}',
-        request,
-        @sdk_configuration.globals
-      )
+      url = "#{base_url}/v1/apis"
       headers = {}
+      query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetApisRequest, request, @sdk_configuration.globals)
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.delete(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
+        req.params = query_params
         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')
 
-      res = ::SpeakeasyClientSDK::Operations::DeleteApiResponse.new(
+      res = ::OpenApiSDK::Operations::GetApisResponse.new(
         status_code: r.status, content_type: content_type, raw_response: r
       )
-      if r.status == 200
-      else
-                
+      if r.status >= 200 && r.status < 300
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[::OpenApiSDK::Shared::Api])
+          res.apis = out
+        end
+      elsif r.status >= 400 && r.status < 500
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, ::SpeakeasyClientSDK::Shared::Error)
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error)
           res.error = out
         end
       end
@@ -58,43 +63,50 @@ module SpeakeasyClientSDK
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecRequest)).returns(::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecResponse) }
-    def generate_open_api_spec(request)
-      # 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.
+    sig { params(api_id: ::String, op: T.nilable(::OpenApiSDK::Operations::QueryParamOp), metadata: T.nilable(T::Hash[Symbol, T::Array[::String]])).returns(::OpenApiSDK::Operations::GetAllApiVersionsResponse) }
+    def get_all_versions(api_id, op = nil, metadata = nil)
+      # get_all_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.
+      request = ::OpenApiSDK::Operations::GetAllApiVersionsRequest.new(
+        
+        api_id: api_id,
+        op: op,
+        metadata: metadata
+      )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
-        ::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecRequest,
+        ::OpenApiSDK::Operations::GetAllApiVersionsRequest,
         base_url,
-        '/v1/apis/{apiID}/version/{versionID}/generate/openapi',
+        '/v1/apis/{apiID}',
         request,
         @sdk_configuration.globals
       )
       headers = {}
+      query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetAllApiVersionsRequest, request, @sdk_configuration.globals)
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
       r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
+        req.params = query_params
         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')
 
-      res = ::SpeakeasyClientSDK::Operations::GenerateOpenApiSpecResponse.new(
+      res = ::OpenApiSDK::Operations::GetAllApiVersionsResponse.new(
         status_code: r.status, content_type: content_type, raw_response: r
       )
-      if r.status == 200
+      if r.status >= 200 && r.status < 300
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, ::SpeakeasyClientSDK::Shared::GenerateOpenApiSpecDiff)
-          res.generate_open_api_spec_diff = out
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[::OpenApiSDK::Shared::Api])
+          res.apis = out
         end
-      else
-                
+      elsif r.status >= 400 && r.status < 500
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, ::SpeakeasyClientSDK::Shared::Error)
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error)
           res.error = out
         end
       end
@@ -102,40 +114,57 @@ module SpeakeasyClientSDK
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionRequest)).returns(::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionResponse) }
-    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.
+    sig { params(api_id: ::String, api: ::OpenApiSDK::Shared::ApiInput).returns(::OpenApiSDK::Operations::UpsertApiResponse) }
+    def upsert(api_id, api)
+      # upsert - Upsert an Api
+      # Upsert an Api. If the Api does not exist, it will be created.
+      # If the Api exists, it will be updated.
+      request = ::OpenApiSDK::Operations::UpsertApiRequest.new(
+        
+        api_id: api_id,
+        api: api
+      )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
-        ::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionRequest,
+        ::OpenApiSDK::Operations::UpsertApiRequest,
         base_url,
-        '/v1/apis/{apiID}/version/{versionID}/generate/postman',
+        '/v1/apis/{apiID}',
         request,
         @sdk_configuration.globals
       )
       headers = {}
-      headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0'
+      req_content_type, data, form = Utils.serialize_request_body(request, :api, :json)
+      headers['content-type'] = req_content_type
+      raise StandardError, 'request body is required' if data.nil? && form.nil?
+      headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.get(url) do |req|
+      r = @sdk_configuration.client.put(url) do |req|
         req.headers = headers
         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')
+          req.body = URI.encode_www_form(data)
+        else
+          req.body = data
+        end
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
 
-      res = ::SpeakeasyClientSDK::Operations::GeneratePostmanCollectionResponse.new(
+      res = ::OpenApiSDK::Operations::UpsertApiResponse.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 r.status >= 200 && r.status < 300
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Api)
+          res.api = out
+        end
+      elsif r.status >= 400 && r.status < 500
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, ::SpeakeasyClientSDK::Shared::Error)
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error)
           res.error = out
         end
       end
@@ -143,45 +172,42 @@ module SpeakeasyClientSDK
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetAllApiVersionsRequest)).returns(::SpeakeasyClientSDK::Operations::GetAllApiVersionsResponse) }
-    def get_all_api_versions(request)
-      # 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.
+    sig { params(api_id: ::String, version_id: ::String).returns(::OpenApiSDK::Operations::DeleteApiResponse) }
+    def delete(api_id, version_id)
+      # delete - 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).
+      request = ::OpenApiSDK::Operations::DeleteApiRequest.new(
+        
+        api_id: api_id,
+        version_id: version_id
+      )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
-        ::SpeakeasyClientSDK::Operations::GetAllApiVersionsRequest,
+        ::OpenApiSDK::Operations::DeleteApiRequest,
         base_url,
-        '/v1/apis/{apiID}',
+        '/v1/apis/{apiID}/version/{versionID}',
         request,
         @sdk_configuration.globals
       )
       headers = {}
-      query_params = Utils.get_query_params(::SpeakeasyClientSDK::Operations::GetAllApiVersionsRequest, request, @sdk_configuration.globals)
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.get(url) do |req|
+      r = @sdk_configuration.client.delete(url) do |req|
         req.headers = headers
-        req.params = query_params
         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')
 
-      res = ::SpeakeasyClientSDK::Operations::GetAllApiVersionsResponse.new(
+      res = ::OpenApiSDK::Operations::DeleteApiResponse.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[::SpeakeasyClientSDK::Shared::Api])
-          res.apis = out
-        end
-      else
-                
+      if r.status >= 200 && r.status < 300
+      elsif r.status >= 400 && r.status < 500
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, ::SpeakeasyClientSDK::Shared::Error)
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error)
           res.error = out
         end
       end
@@ -189,39 +215,47 @@ module SpeakeasyClientSDK
     end
 
 
-    sig { params(request: T.nilable(::SpeakeasyClientSDK::Operations::GetApisRequest)).returns(::SpeakeasyClientSDK::Operations::GetApisResponse) }
-    def get_apis(request)
-      # 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.
+    sig { params(api_id: ::String, version_id: ::String).returns(::OpenApiSDK::Operations::GenerateOpenApiSpecResponse) }
+    def generate_open_api(api_id, version_id)
+      # generate_open_api - 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.
+      request = ::OpenApiSDK::Operations::GenerateOpenApiSpecRequest.new(
+        
+        api_id: api_id,
+        version_id: version_id
+      )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
-      url = "#{base_url}/v1/apis"
+      url = Utils.generate_url(
+        ::OpenApiSDK::Operations::GenerateOpenApiSpecRequest,
+        base_url,
+        '/v1/apis/{apiID}/version/{versionID}/generate/openapi',
+        request,
+        @sdk_configuration.globals
+      )
       headers = {}
-      query_params = Utils.get_query_params(::SpeakeasyClientSDK::Operations::GetApisRequest, request, @sdk_configuration.globals)
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
       r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
-        req.params = query_params
         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')
 
-      res = ::SpeakeasyClientSDK::Operations::GetApisResponse.new(
+      res = ::OpenApiSDK::Operations::GenerateOpenApiSpecResponse.new(
         status_code: r.status, content_type: content_type, raw_response: r
       )
-      if r.status == 200
+      if r.status >= 200 && r.status < 300
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, T::Array[::SpeakeasyClientSDK::Shared::Api])
-          res.apis = out
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::GenerateOpenApiSpecDiff)
+          res.generate_open_api_spec_diff = out
         end
-      else
-                
+      elsif r.status >= 400 && r.status < 500
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, ::SpeakeasyClientSDK::Shared::Error)
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error)
           res.error = out
         end
       end
@@ -229,53 +263,44 @@ module SpeakeasyClientSDK
     end
 
 
-    sig { params(request: ::SpeakeasyClientSDK::Operations::UpsertApiRequest).returns(::SpeakeasyClientSDK::Operations::UpsertApiResponse) }
-    def upsert_api(request)
-      # 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.
+    sig { params(api_id: ::String, version_id: ::String).returns(::OpenApiSDK::Operations::GeneratePostmanCollectionResponse) }
+    def generate_postman(api_id, version_id)
+      # generate_postman - 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.
+      request = ::OpenApiSDK::Operations::GeneratePostmanCollectionRequest.new(
+        
+        api_id: api_id,
+        version_id: version_id
+      )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = Utils.generate_url(
-        ::SpeakeasyClientSDK::Operations::UpsertApiRequest,
+        ::OpenApiSDK::Operations::GeneratePostmanCollectionRequest,
         base_url,
-        '/v1/apis/{apiID}',
+        '/v1/apis/{apiID}/version/{versionID}/generate/postman',
         request,
         @sdk_configuration.globals
       )
       headers = {}
-      req_content_type, data, form = Utils.serialize_request_body(request, :api, :json)
-      headers['content-type'] = req_content_type
-      raise StandardError, 'request body is required' if data.nil? && form.nil?
-      headers['Accept'] = 'application/json'
+      headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.put(url) do |req|
+      r = @sdk_configuration.client.get(url) do |req|
         req.headers = headers
         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')
-          req.body = URI.encode_www_form(data)
-        else
-          req.body = data
-        end
       end
 
       content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
 
-      res = ::SpeakeasyClientSDK::Operations::UpsertApiResponse.new(
+      res = ::OpenApiSDK::Operations::GeneratePostmanCollectionResponse.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, ::SpeakeasyClientSDK::Shared::Api)
-          res.api = out
-        end
-      else
-                
+      if r.status >= 200 && r.status < 300
+        res.postman_collection = r.env.response_body if Utils.match_content_type(content_type, 'application/octet-stream')
+      
+      elsif r.status >= 400 && r.status < 500
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, ::SpeakeasyClientSDK::Shared::Error)
+          out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error)
           res.error = out
         end
       end