speakeasy_client_sdk_ruby 1.0.1

data/lib/sdk/models/operations/generateopenapispec.rb

@@ -0,0 +1,56 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+require_relative '../shared/generateopenapispecdiff'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GenerateOpenApiSpecRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the Api to generate an OpenAPI specification for.
+      field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
+      # The version ID of the Api to generate an OpenAPI specification for.
+      field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(api_id: String, version_id: String).void }
+      def initialize(api_id: nil, version_id: nil)
+        @api_id = api_id
+        @version_id = version_id
+      end
+    end
+
+
+    class GenerateOpenApiSpecResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+      # OK
+      field :generate_open_api_spec_diff, T.nilable(Shared::GenerateOpenApiSpecDiff)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), generate_open_api_spec_diff: T.nilable(Shared::GenerateOpenApiSpecDiff), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, error: nil, generate_open_api_spec_diff: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @error = error
+        @generate_open_api_spec_diff = generate_open_api_spec_diff
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/generateopenapispecforapiendpoint.rb

@@ -0,0 +1,59 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+require_relative '../shared/generateopenapispecdiff'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GenerateOpenApiSpecForApiEndpointRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the ApiEndpoint to generate an OpenAPI specification for.
+      field :api_endpoint_id, String, { 'path_param': { 'field_name': 'apiEndpointID', 'style': 'simple', 'explode': false } }
+      # The ID of the Api to generate an OpenAPI specification for.
+      field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
+      # The version ID of the Api to generate an OpenAPI specification for.
+      field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(api_endpoint_id: String, api_id: String, version_id: String).void }
+      def initialize(api_endpoint_id: nil, api_id: nil, version_id: nil)
+        @api_endpoint_id = api_endpoint_id
+        @api_id = api_id
+        @version_id = version_id
+      end
+    end
+
+
+    class GenerateOpenApiSpecForApiEndpointResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+      # OK
+      field :generate_open_api_spec_diff, T.nilable(Shared::GenerateOpenApiSpecDiff)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), generate_open_api_spec_diff: T.nilable(Shared::GenerateOpenApiSpecDiff), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, error: nil, generate_open_api_spec_diff: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @error = error
+        @generate_open_api_spec_diff = generate_open_api_spec_diff
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/generatepostmancollection.rb

@@ -0,0 +1,55 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GeneratePostmanCollectionRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the Api to generate a Postman collection for.
+      field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
+      # The version ID of the Api to generate a Postman collection for.
+      field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(api_id: String, version_id: String).void }
+      def initialize(api_id: nil, version_id: nil)
+        @api_id = api_id
+        @version_id = version_id
+      end
+    end
+
+
+    class GeneratePostmanCollectionResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+      # OK
+      field :postman_collection, T.nilable(String)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), postman_collection: T.nilable(String), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, error: nil, postman_collection: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @error = error
+        @postman_collection = postman_collection
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/generatepostmancollectionforapiendpoint.rb

@@ -0,0 +1,58 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GeneratePostmanCollectionForApiEndpointRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the ApiEndpoint to generate a Postman collection for.
+      field :api_endpoint_id, String, { 'path_param': { 'field_name': 'apiEndpointID', 'style': 'simple', 'explode': false } }
+      # The ID of the Api to generate a Postman collection for.
+      field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
+      # The version ID of the Api to generate a Postman collection for.
+      field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(api_endpoint_id: String, api_id: String, version_id: String).void }
+      def initialize(api_endpoint_id: nil, api_id: nil, version_id: nil)
+        @api_endpoint_id = api_endpoint_id
+        @api_id = api_id
+        @version_id = version_id
+      end
+    end
+
+
+    class GeneratePostmanCollectionForApiEndpointResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+      # OK
+      field :postman_collection, T.nilable(String)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), postman_collection: T.nilable(String), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, error: nil, postman_collection: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @error = error
+        @postman_collection = postman_collection
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/generaterequestpostmancollection.rb

@@ -0,0 +1,52 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GenerateRequestPostmanCollectionRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the request to retrieve.
+      field :request_id, String, { 'path_param': { 'field_name': 'requestID', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(request_id: String).void }
+      def initialize(request_id: nil)
+        @request_id = request_id
+      end
+    end
+
+
+    class GenerateRequestPostmanCollectionResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+      # OK
+      field :postman_collection, T.nilable(String)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), postman_collection: T.nilable(String), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, error: nil, postman_collection: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @error = error
+        @postman_collection = postman_collection
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/getallapiendpoints.rb

@@ -0,0 +1,52 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GetAllApiEndpointsRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the Api to retrieve ApiEndpoints for.
+      field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(api_id: String).void }
+      def initialize(api_id: nil)
+        @api_id = api_id
+      end
+    end
+
+
+    class GetAllApiEndpointsResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # OK
+      field :api_endpoints, T.nilable(T::Array[Shared::ApiEndpoint])
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, api_endpoints: T.nilable(T::Array[Shared::ApiEndpoint]), error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, api_endpoints: nil, error: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @api_endpoints = api_endpoints
+        @error = error
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/getallapiversions.rb

@@ -0,0 +1,72 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+    # Configuration for filter operations
+    class GetAllApiVersionsOp < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # Whether to AND or OR the filters
+      field :and_, T::Boolean, { 'query_param': { 'field_name': 'and' } }
+
+
+      sig { params(and_: T::Boolean).void }
+      def initialize(and_: nil)
+        @and_ = and_
+      end
+    end
+
+
+    class GetAllApiVersionsRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the Api to retrieve.
+      field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
+      # Metadata to filter Apis on
+      field :metadata, T.nilable(T::Hash[Symbol, T::Array[String]]), { 'query_param': { 'field_name': 'metadata', 'style': 'deepObject', 'explode': true } }
+      # Configuration for filter operations
+      field :op, T.nilable(Operations::GetAllApiVersionsOp), { 'query_param': { 'field_name': 'op', 'style': 'deepObject', 'explode': true } }
+
+
+      sig { params(api_id: String, metadata: T.nilable(T::Hash[Symbol, T::Array[String]]), op: T.nilable(Operations::GetAllApiVersionsOp)).void }
+      def initialize(api_id: nil, metadata: nil, op: nil)
+        @api_id = api_id
+        @metadata = metadata
+        @op = op
+      end
+    end
+
+
+    class GetAllApiVersionsResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # OK
+      field :apis, T.nilable(T::Array[Shared::Api])
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, apis: T.nilable(T::Array[Shared::Api]), error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, apis: nil, error: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @apis = apis
+        @error = error
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/getallforversionapiendpoints.rb

@@ -0,0 +1,55 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GetAllForVersionApiEndpointsRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the Api to retrieve ApiEndpoints for.
+      field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
+      # The version ID of the Api to retrieve ApiEndpoints for.
+      field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(api_id: String, version_id: String).void }
+      def initialize(api_id: nil, version_id: nil)
+        @api_id = api_id
+        @version_id = version_id
+      end
+    end
+
+
+    class GetAllForVersionApiEndpointsResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # OK
+      field :api_endpoints, T.nilable(T::Array[Shared::ApiEndpoint])
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, api_endpoints: T.nilable(T::Array[Shared::ApiEndpoint]), error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, api_endpoints: nil, error: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @api_endpoints = api_endpoints
+        @error = error
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/getapiendpoint.rb

@@ -0,0 +1,59 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/apiendpoint'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GetApiEndpointRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The ID of the ApiEndpoint to retrieve.
+      field :api_endpoint_id, String, { 'path_param': { 'field_name': 'apiEndpointID', 'style': 'simple', 'explode': false } }
+      # The ID of the Api the ApiEndpoint belongs to.
+      field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
+      # The version ID of the Api the ApiEndpoint belongs to.
+      field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
+
+
+      sig { params(api_endpoint_id: String, api_id: String, version_id: String).void }
+      def initialize(api_endpoint_id: nil, api_id: nil, version_id: nil)
+        @api_endpoint_id = api_endpoint_id
+        @api_id = api_id
+        @version_id = version_id
+      end
+    end
+
+
+    class GetApiEndpointResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # OK
+      field :api_endpoint, T.nilable(Shared::ApiEndpoint)
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, api_endpoint: T.nilable(Shared::ApiEndpoint), error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, api_endpoint: nil, error: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @api_endpoint = api_endpoint
+        @error = error
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/getapis.rb

@@ -0,0 +1,69 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+    # Configuration for filter operations
+    class GetApisOp < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # Whether to AND or OR the filters
+      field :and_, T::Boolean, { 'query_param': { 'field_name': 'and' } }
+
+
+      sig { params(and_: T::Boolean).void }
+      def initialize(and_: nil)
+        @and_ = and_
+      end
+    end
+
+
+    class GetApisRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # Metadata to filter Apis on
+      field :metadata, T.nilable(T::Hash[Symbol, T::Array[String]]), { 'query_param': { 'field_name': 'metadata', 'style': 'deepObject', 'explode': true } }
+      # Configuration for filter operations
+      field :op, T.nilable(Operations::GetApisOp), { 'query_param': { 'field_name': 'op', 'style': 'deepObject', 'explode': true } }
+
+
+      sig { params(metadata: T.nilable(T::Hash[Symbol, T::Array[String]]), op: T.nilable(Operations::GetApisOp)).void }
+      def initialize(metadata: nil, op: nil)
+        @metadata = metadata
+        @op = op
+      end
+    end
+
+
+    class GetApisResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # OK
+      field :apis, T.nilable(T::Array[Shared::Api])
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, apis: T.nilable(T::Array[Shared::Api]), error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, apis: nil, error: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @apis = apis
+        @error = error
+        @raw_response = raw_response
+      end
+    end
+  end
+end

data/lib/sdk/models/operations/getembedaccesstoken.rb

@@ -0,0 +1,60 @@
+# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'faraday'
+require_relative '../shared/filters'
+require_relative '../shared/embedaccesstokenresponse'
+require_relative '../shared/error'
+
+module SpeakeasyClientSDK
+  module Operations
+
+    class GetEmbedAccessTokenRequest < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+      # The description of the embed access token.
+      field :description, T.nilable(String), { 'query_param': { 'field_name': 'description', 'style': 'form', 'explode': true } }
+      # The duration (in minutes) of the embed access token.
+      field :duration, T.nilable(Integer), { 'query_param': { 'field_name': 'duration', 'style': 'form', 'explode': true } }
+      # The filter to apply to the query.
+      field :filters, T.nilable(Shared::Filters), { 'query_param': { 'field_name': 'filters', 'serialization': 'json' } }
+
+
+      sig { params(description: T.nilable(String), duration: T.nilable(Integer), filters: T.nilable(Shared::Filters)).void }
+      def initialize(description: nil, duration: nil, filters: nil)
+        @description = description
+        @duration = duration
+        @filters = filters
+      end
+    end
+
+
+    class GetEmbedAccessTokenResponse < SpeakeasyClientSDK::Utils::FieldAugmented
+      extend T::Sig
+
+
+      field :content_type, String
+
+      field :status_code, Integer
+      # OK
+      field :embed_access_token_response, T.nilable(Shared::EmbedAccessTokenResponse)
+      # Default error response
+      field :error, T.nilable(Shared::Error)
+
+      field :raw_response, T.nilable(Faraday::Response)
+
+
+      sig { params(content_type: String, status_code: Integer, embed_access_token_response: T.nilable(Shared::EmbedAccessTokenResponse), error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
+      def initialize(content_type: nil, status_code: nil, embed_access_token_response: nil, error: nil, raw_response: nil)
+        @content_type = content_type
+        @status_code = status_code
+        @embed_access_token_response = embed_access_token_response
+        @error = error
+        @raw_response = raw_response
+      end
+    end
+  end
+end