speakeasy_client_sdk_ruby 1.23.2 → 1.23.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/sdk/apiendpoints.rb +7 -7
- data/lib/sdk/apis.rb +5 -5
- data/lib/sdk/embeds.rb +2 -2
- data/lib/sdk/metadata.rb +2 -2
- data/lib/sdk/plugins.rb +1 -1
- data/lib/sdk/requests.rb +3 -3
- data/lib/sdk/schemas.rb +7 -7
- data/lib/sdk/sdkconfiguration.rb +2 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ff95aa15dc8d8ed798cd8501041e5ee9ec7659166adf1bfa4401b79bcf5ec83c
|
4
|
+
data.tar.gz: 0b7148f8e78cd2453548399ecdce4ed1617b89ee469c0c5dcf20f6de48634752
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ebb644fd3aef6a2d7158cd61859a7f673118fea4a0f6c3fdb4fa011bb0db5c81d549390968d66dd674b5f3106bb88239e5478fb5dabbe7ab5ee8032134c98d02
|
7
|
+
data.tar.gz: ac1bed5f1d8d9d6c6411496c9508b0446f29c20cd60615e12af7635fe89ecabc06b35a82d1645fbba5cf185a88625dd9a5c0eafa658eb25fef84fe5749808bf0
|
data/lib/sdk/apiendpoints.rb
CHANGED
@@ -17,7 +17,7 @@ module SpeakeasyClientSDK
|
|
17
17
|
@sdk_configuration = sdk_config
|
18
18
|
end
|
19
19
|
|
20
|
-
sig { params(request: Operations::DeleteApiEndpointRequest).returns(Utils::FieldAugmented) }
|
20
|
+
sig { params(request: T.nilable(Operations::DeleteApiEndpointRequest)).returns(Utils::FieldAugmented) }
|
21
21
|
def delete_api_endpoint(request)
|
22
22
|
# delete_api_endpoint - Delete an ApiEndpoint.
|
23
23
|
# Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).
|
@@ -53,7 +53,7 @@ module SpeakeasyClientSDK
|
|
53
53
|
res
|
54
54
|
end
|
55
55
|
|
56
|
-
sig { params(request: Operations::FindApiEndpointRequest).returns(Utils::FieldAugmented) }
|
56
|
+
sig { params(request: T.nilable(Operations::FindApiEndpointRequest)).returns(Utils::FieldAugmented) }
|
57
57
|
def find_api_endpoint(request)
|
58
58
|
# find_api_endpoint - Find an ApiEndpoint via its displayName.
|
59
59
|
# Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema).
|
@@ -94,7 +94,7 @@ module SpeakeasyClientSDK
|
|
94
94
|
res
|
95
95
|
end
|
96
96
|
|
97
|
-
sig { params(request: Operations::GenerateOpenApiSpecForApiEndpointRequest).returns(Utils::FieldAugmented) }
|
97
|
+
sig { params(request: T.nilable(Operations::GenerateOpenApiSpecForApiEndpointRequest)).returns(Utils::FieldAugmented) }
|
98
98
|
def generate_open_api_spec_for_api_endpoint(request)
|
99
99
|
# generate_open_api_spec_for_api_endpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
|
100
100
|
# This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document.
|
@@ -135,7 +135,7 @@ module SpeakeasyClientSDK
|
|
135
135
|
res
|
136
136
|
end
|
137
137
|
|
138
|
-
sig { params(request: Operations::GeneratePostmanCollectionForApiEndpointRequest).returns(Utils::FieldAugmented) }
|
138
|
+
sig { params(request: T.nilable(Operations::GeneratePostmanCollectionForApiEndpointRequest)).returns(Utils::FieldAugmented) }
|
139
139
|
def generate_postman_collection_for_api_endpoint(request)
|
140
140
|
# generate_postman_collection_for_api_endpoint - Generate a Postman collection for a particular ApiEndpoint.
|
141
141
|
# 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.
|
@@ -172,7 +172,7 @@ module SpeakeasyClientSDK
|
|
172
172
|
res
|
173
173
|
end
|
174
174
|
|
175
|
-
sig { params(request: Operations::GetAllApiEndpointsRequest).returns(Utils::FieldAugmented) }
|
175
|
+
sig { params(request: T.nilable(Operations::GetAllApiEndpointsRequest)).returns(Utils::FieldAugmented) }
|
176
176
|
def get_all_api_endpoints(request)
|
177
177
|
# get_all_api_endpoints - Get all Api endpoints for a particular apiID.
|
178
178
|
url, params = @sdk_configuration.get_server_details
|
@@ -211,7 +211,7 @@ module SpeakeasyClientSDK
|
|
211
211
|
res
|
212
212
|
end
|
213
213
|
|
214
|
-
sig { params(request: Operations::GetAllForVersionApiEndpointsRequest).returns(Utils::FieldAugmented) }
|
214
|
+
sig { params(request: T.nilable(Operations::GetAllForVersionApiEndpointsRequest)).returns(Utils::FieldAugmented) }
|
215
215
|
def get_all_for_version_api_endpoints(request)
|
216
216
|
# get_all_for_version_api_endpoints - Get all ApiEndpoints for a particular apiID and versionID.
|
217
217
|
url, params = @sdk_configuration.get_server_details
|
@@ -250,7 +250,7 @@ module SpeakeasyClientSDK
|
|
250
250
|
res
|
251
251
|
end
|
252
252
|
|
253
|
-
sig { params(request: Operations::GetApiEndpointRequest).returns(Utils::FieldAugmented) }
|
253
|
+
sig { params(request: T.nilable(Operations::GetApiEndpointRequest)).returns(Utils::FieldAugmented) }
|
254
254
|
def get_api_endpoint(request)
|
255
255
|
# get_api_endpoint - Get an ApiEndpoint.
|
256
256
|
url, params = @sdk_configuration.get_server_details
|
data/lib/sdk/apis.rb
CHANGED
@@ -17,7 +17,7 @@ module SpeakeasyClientSDK
|
|
17
17
|
@sdk_configuration = sdk_config
|
18
18
|
end
|
19
19
|
|
20
|
-
sig { params(request: Operations::DeleteApiRequest).returns(Utils::FieldAugmented) }
|
20
|
+
sig { params(request: T.nilable(Operations::DeleteApiRequest)).returns(Utils::FieldAugmented) }
|
21
21
|
def delete_api(request)
|
22
22
|
# delete_api - Delete an Api.
|
23
23
|
# Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore).
|
@@ -53,7 +53,7 @@ module SpeakeasyClientSDK
|
|
53
53
|
res
|
54
54
|
end
|
55
55
|
|
56
|
-
sig { params(request: Operations::GenerateOpenApiSpecRequest).returns(Utils::FieldAugmented) }
|
56
|
+
sig { params(request: T.nilable(Operations::GenerateOpenApiSpecRequest)).returns(Utils::FieldAugmented) }
|
57
57
|
def generate_open_api_spec(request)
|
58
58
|
# generate_open_api_spec - Generate an OpenAPI specification for a particular Api.
|
59
59
|
# This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document.
|
@@ -94,7 +94,7 @@ module SpeakeasyClientSDK
|
|
94
94
|
res
|
95
95
|
end
|
96
96
|
|
97
|
-
sig { params(request: Operations::GeneratePostmanCollectionRequest).returns(Utils::FieldAugmented) }
|
97
|
+
sig { params(request: T.nilable(Operations::GeneratePostmanCollectionRequest)).returns(Utils::FieldAugmented) }
|
98
98
|
def generate_postman_collection(request)
|
99
99
|
# generate_postman_collection - Generate a Postman collection for a particular Api.
|
100
100
|
# 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.
|
@@ -131,7 +131,7 @@ module SpeakeasyClientSDK
|
|
131
131
|
res
|
132
132
|
end
|
133
133
|
|
134
|
-
sig { params(request: Operations::GetAllApiVersionsRequest).returns(Utils::FieldAugmented) }
|
134
|
+
sig { params(request: T.nilable(Operations::GetAllApiVersionsRequest)).returns(Utils::FieldAugmented) }
|
135
135
|
def get_all_api_versions(request)
|
136
136
|
# get_all_api_versions - Get all Api versions for a particular ApiEndpoint.
|
137
137
|
# Get all Api versions for a particular ApiEndpoint.
|
@@ -174,7 +174,7 @@ module SpeakeasyClientSDK
|
|
174
174
|
res
|
175
175
|
end
|
176
176
|
|
177
|
-
sig { params(request: Operations::GetApisRequest).returns(Utils::FieldAugmented) }
|
177
|
+
sig { params(request: T.nilable(Operations::GetApisRequest)).returns(Utils::FieldAugmented) }
|
178
178
|
def get_apis(request)
|
179
179
|
# get_apis - Get a list of Apis for a given workspace
|
180
180
|
# Get a list of all Apis and their versions for a given workspace.
|
data/lib/sdk/embeds.rb
CHANGED
@@ -17,7 +17,7 @@ module SpeakeasyClientSDK
|
|
17
17
|
@sdk_configuration = sdk_config
|
18
18
|
end
|
19
19
|
|
20
|
-
sig { params(request: Operations::GetEmbedAccessTokenRequest).returns(Utils::FieldAugmented) }
|
20
|
+
sig { params(request: T.nilable(Operations::GetEmbedAccessTokenRequest)).returns(Utils::FieldAugmented) }
|
21
21
|
def get_embed_access_token(request)
|
22
22
|
# get_embed_access_token - Get an embed access token for the current workspace.
|
23
23
|
# Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content.
|
@@ -89,7 +89,7 @@ module SpeakeasyClientSDK
|
|
89
89
|
res
|
90
90
|
end
|
91
91
|
|
92
|
-
sig { params(request: Operations::RevokeEmbedAccessTokenRequest).returns(Utils::FieldAugmented) }
|
92
|
+
sig { params(request: T.nilable(Operations::RevokeEmbedAccessTokenRequest)).returns(Utils::FieldAugmented) }
|
93
93
|
def revoke_embed_access_token(request)
|
94
94
|
# revoke_embed_access_token - Revoke an embed access EmbedToken.
|
95
95
|
url, params = @sdk_configuration.get_server_details
|
data/lib/sdk/metadata.rb
CHANGED
@@ -17,7 +17,7 @@ module SpeakeasyClientSDK
|
|
17
17
|
@sdk_configuration = sdk_config
|
18
18
|
end
|
19
19
|
|
20
|
-
sig { params(request: Operations::DeleteVersionMetadataRequest).returns(Utils::FieldAugmented) }
|
20
|
+
sig { params(request: T.nilable(Operations::DeleteVersionMetadataRequest)).returns(Utils::FieldAugmented) }
|
21
21
|
def delete_version_metadata(request)
|
22
22
|
# delete_version_metadata - Delete metadata for a particular apiID and versionID.
|
23
23
|
url, params = @sdk_configuration.get_server_details
|
@@ -52,7 +52,7 @@ module SpeakeasyClientSDK
|
|
52
52
|
res
|
53
53
|
end
|
54
54
|
|
55
|
-
sig { params(request: Operations::GetVersionMetadataRequest).returns(Utils::FieldAugmented) }
|
55
|
+
sig { params(request: T.nilable(Operations::GetVersionMetadataRequest)).returns(Utils::FieldAugmented) }
|
56
56
|
def get_version_metadata(request)
|
57
57
|
# get_version_metadata - Get all metadata for a particular apiID and versionID.
|
58
58
|
url, params = @sdk_configuration.get_server_details
|
data/lib/sdk/plugins.rb
CHANGED
@@ -51,7 +51,7 @@ module SpeakeasyClientSDK
|
|
51
51
|
res
|
52
52
|
end
|
53
53
|
|
54
|
-
sig { params(request: Operations::RunPluginRequest).returns(Utils::FieldAugmented) }
|
54
|
+
sig { params(request: T.nilable(Operations::RunPluginRequest)).returns(Utils::FieldAugmented) }
|
55
55
|
def run_plugin(request)
|
56
56
|
# run_plugin - Run a plugin
|
57
57
|
url, params = @sdk_configuration.get_server_details
|
data/lib/sdk/requests.rb
CHANGED
@@ -17,7 +17,7 @@ module SpeakeasyClientSDK
|
|
17
17
|
@sdk_configuration = sdk_config
|
18
18
|
end
|
19
19
|
|
20
|
-
sig { params(request: Operations::GenerateRequestPostmanCollectionRequest).returns(Utils::FieldAugmented) }
|
20
|
+
sig { params(request: T.nilable(Operations::GenerateRequestPostmanCollectionRequest)).returns(Utils::FieldAugmented) }
|
21
21
|
def generate_request_postman_collection(request)
|
22
22
|
# generate_request_postman_collection - Generate a Postman collection for a particular request.
|
23
23
|
# Generates a Postman collection for a particular request.
|
@@ -55,7 +55,7 @@ module SpeakeasyClientSDK
|
|
55
55
|
res
|
56
56
|
end
|
57
57
|
|
58
|
-
sig { params(request: Operations::GetRequestFromEventLogRequest).returns(Utils::FieldAugmented) }
|
58
|
+
sig { params(request: T.nilable(Operations::GetRequestFromEventLogRequest)).returns(Utils::FieldAugmented) }
|
59
59
|
def get_request_from_event_log(request)
|
60
60
|
# get_request_from_event_log - Get information about a particular request.
|
61
61
|
url, params = @sdk_configuration.get_server_details
|
@@ -94,7 +94,7 @@ module SpeakeasyClientSDK
|
|
94
94
|
res
|
95
95
|
end
|
96
96
|
|
97
|
-
sig { params(request: Operations::QueryEventLogRequest).returns(Utils::FieldAugmented) }
|
97
|
+
sig { params(request: T.nilable(Operations::QueryEventLogRequest)).returns(Utils::FieldAugmented) }
|
98
98
|
def query_event_log(request)
|
99
99
|
# query_event_log - Query the event log to retrieve a list of requests.
|
100
100
|
# Supports retrieving a list of request captured by the SDK for this workspace.
|
data/lib/sdk/schemas.rb
CHANGED
@@ -17,7 +17,7 @@ module SpeakeasyClientSDK
|
|
17
17
|
@sdk_configuration = sdk_config
|
18
18
|
end
|
19
19
|
|
20
|
-
sig { params(request: Operations::DeleteSchemaRequest).returns(Utils::FieldAugmented) }
|
20
|
+
sig { params(request: T.nilable(Operations::DeleteSchemaRequest)).returns(Utils::FieldAugmented) }
|
21
21
|
def delete_schema(request)
|
22
22
|
# delete_schema - Delete a particular schema revision for an Api.
|
23
23
|
url, params = @sdk_configuration.get_server_details
|
@@ -52,7 +52,7 @@ module SpeakeasyClientSDK
|
|
52
52
|
res
|
53
53
|
end
|
54
54
|
|
55
|
-
sig { params(request: Operations::DownloadSchemaRequest).returns(Utils::FieldAugmented) }
|
55
|
+
sig { params(request: T.nilable(Operations::DownloadSchemaRequest)).returns(Utils::FieldAugmented) }
|
56
56
|
def download_schema(request)
|
57
57
|
# download_schema - Download the latest schema for a particular apiID.
|
58
58
|
url, params = @sdk_configuration.get_server_details
|
@@ -89,7 +89,7 @@ module SpeakeasyClientSDK
|
|
89
89
|
res
|
90
90
|
end
|
91
91
|
|
92
|
-
sig { params(request: Operations::DownloadSchemaRevisionRequest).returns(Utils::FieldAugmented) }
|
92
|
+
sig { params(request: T.nilable(Operations::DownloadSchemaRevisionRequest)).returns(Utils::FieldAugmented) }
|
93
93
|
def download_schema_revision(request)
|
94
94
|
# download_schema_revision - Download a particular schema revision for an Api.
|
95
95
|
url, params = @sdk_configuration.get_server_details
|
@@ -126,7 +126,7 @@ module SpeakeasyClientSDK
|
|
126
126
|
res
|
127
127
|
end
|
128
128
|
|
129
|
-
sig { params(request: Operations::GetSchemaRequest).returns(Utils::FieldAugmented) }
|
129
|
+
sig { params(request: T.nilable(Operations::GetSchemaRequest)).returns(Utils::FieldAugmented) }
|
130
130
|
def get_schema(request)
|
131
131
|
# get_schema - Get information about the latest schema.
|
132
132
|
# Returns information about the last uploaded schema for a particular API version.
|
@@ -167,7 +167,7 @@ module SpeakeasyClientSDK
|
|
167
167
|
res
|
168
168
|
end
|
169
169
|
|
170
|
-
sig { params(request: Operations::GetSchemaDiffRequest).returns(Utils::FieldAugmented) }
|
170
|
+
sig { params(request: T.nilable(Operations::GetSchemaDiffRequest)).returns(Utils::FieldAugmented) }
|
171
171
|
def get_schema_diff(request)
|
172
172
|
# get_schema_diff - Get a diff of two schema revisions for an Api.
|
173
173
|
url, params = @sdk_configuration.get_server_details
|
@@ -206,7 +206,7 @@ module SpeakeasyClientSDK
|
|
206
206
|
res
|
207
207
|
end
|
208
208
|
|
209
|
-
sig { params(request: Operations::GetSchemaRevisionRequest).returns(Utils::FieldAugmented) }
|
209
|
+
sig { params(request: T.nilable(Operations::GetSchemaRevisionRequest)).returns(Utils::FieldAugmented) }
|
210
210
|
def get_schema_revision(request)
|
211
211
|
# get_schema_revision - Get information about a particular schema revision for an Api.
|
212
212
|
# Returns information about the last uploaded schema for a particular schema revision.
|
@@ -247,7 +247,7 @@ module SpeakeasyClientSDK
|
|
247
247
|
res
|
248
248
|
end
|
249
249
|
|
250
|
-
sig { params(request: Operations::GetSchemasRequest).returns(Utils::FieldAugmented) }
|
250
|
+
sig { params(request: T.nilable(Operations::GetSchemasRequest)).returns(Utils::FieldAugmented) }
|
251
251
|
def get_schemas(request)
|
252
252
|
# get_schemas - Get information about all schemas associated with a particular apiID.
|
253
253
|
# Returns information the schemas associated with a particular apiID.
|
data/lib/sdk/sdkconfiguration.rb
CHANGED
@@ -38,8 +38,8 @@ module OpenApiSDK
|
|
38
38
|
@server = server_url.nil? ? '' : server_url
|
39
39
|
@language = 'ruby'
|
40
40
|
@openapi_doc_version = '0.3.0'
|
41
|
-
@sdk_version = '1.23.
|
42
|
-
@gen_version = '2.
|
41
|
+
@sdk_version = '1.23.3'
|
42
|
+
@gen_version = '2.101.0'
|
43
43
|
end
|
44
44
|
|
45
45
|
sig { returns([String, T::Hash[Symbol, String]]) }
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: speakeasy_client_sdk_ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.23.
|
4
|
+
version: 1.23.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Speakeasy
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-09-
|
11
|
+
date: 2023-09-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|