speakeasy_client_sdk_ruby 1.0.1
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 +7 -0
- data/lib/sdk/apiendpoints.rb +338 -0
- data/lib/sdk/apis.rb +264 -0
- data/lib/sdk/embeds.rb +128 -0
- data/lib/sdk/metadata.rb +144 -0
- data/lib/sdk/models/operations/deleteapi.rb +52 -0
- data/lib/sdk/models/operations/deleteapiendpoint.rb +55 -0
- data/lib/sdk/models/operations/deleteschema.rb +55 -0
- data/lib/sdk/models/operations/deleteversionmetadata.rb +58 -0
- data/lib/sdk/models/operations/downloadschema.rb +55 -0
- data/lib/sdk/models/operations/downloadschemarevision.rb +58 -0
- data/lib/sdk/models/operations/findapiendpoint.rb +59 -0
- data/lib/sdk/models/operations/generateopenapispec.rb +56 -0
- data/lib/sdk/models/operations/generateopenapispecforapiendpoint.rb +59 -0
- data/lib/sdk/models/operations/generatepostmancollection.rb +55 -0
- data/lib/sdk/models/operations/generatepostmancollectionforapiendpoint.rb +58 -0
- data/lib/sdk/models/operations/generaterequestpostmancollection.rb +52 -0
- data/lib/sdk/models/operations/getallapiendpoints.rb +52 -0
- data/lib/sdk/models/operations/getallapiversions.rb +72 -0
- data/lib/sdk/models/operations/getallforversionapiendpoints.rb +55 -0
- data/lib/sdk/models/operations/getapiendpoint.rb +59 -0
- data/lib/sdk/models/operations/getapis.rb +69 -0
- data/lib/sdk/models/operations/getembedaccesstoken.rb +60 -0
- data/lib/sdk/models/operations/getplugins.rb +38 -0
- data/lib/sdk/models/operations/getrequestfromeventlog.rb +53 -0
- data/lib/sdk/models/operations/getschema.rb +56 -0
- data/lib/sdk/models/operations/getschemadiff.rb +62 -0
- data/lib/sdk/models/operations/getschemarevision.rb +59 -0
- data/lib/sdk/models/operations/getschemas.rb +55 -0
- data/lib/sdk/models/operations/getvalidembedaccesstokens.rb +38 -0
- data/lib/sdk/models/operations/getversionmetadata.rb +55 -0
- data/lib/sdk/models/operations/insertversionmetadata.rb +60 -0
- data/lib/sdk/models/operations/queryeventlog.rb +53 -0
- data/lib/sdk/models/operations/registerschema.rb +86 -0
- data/lib/sdk/models/operations/revokeembedaccesstoken.rb +49 -0
- data/lib/sdk/models/operations/runplugin.rb +56 -0
- data/lib/sdk/models/operations/upsertapi.rb +57 -0
- data/lib/sdk/models/operations/upsertapiendpoint.rb +63 -0
- data/lib/sdk/models/operations/upsertplugin.rb +39 -0
- data/lib/sdk/models/operations/validateapikey.rb +35 -0
- data/lib/sdk/models/shared/api.rb +69 -0
- data/lib/sdk/models/shared/apiendpoint.rb +84 -0
- data/lib/sdk/models/shared/boundedrequest.rb +64 -0
- data/lib/sdk/models/shared/embedaccesstokenresponse.rb +25 -0
- data/lib/sdk/models/shared/embedtoken.rb +52 -0
- data/lib/sdk/models/shared/error.rb +28 -0
- data/lib/sdk/models/shared/filter.rb +31 -0
- data/lib/sdk/models/shared/filters.rb +34 -0
- data/lib/sdk/models/shared/generateopenapispecdiff.rb +28 -0
- data/lib/sdk/models/shared/plugin.rb +43 -0
- data/lib/sdk/models/shared/requestmetadata.rb +28 -0
- data/lib/sdk/models/shared/schema.rb +40 -0
- data/lib/sdk/models/shared/schemadiff.rb +48 -0
- data/lib/sdk/models/shared/security.rb +25 -0
- data/lib/sdk/models/shared/unboundedrequest.rb +37 -0
- data/lib/sdk/models/shared/versionmetadata.rb +57 -0
- data/lib/sdk/plugins.rb +140 -0
- data/lib/sdk/requests.rb +136 -0
- data/lib/sdk/schemas.rb +334 -0
- data/lib/sdk/sdk.rb +173 -0
- data/lib/sdk/utils/metadata_fields.rb +154 -0
- data/lib/sdk/utils/retries.rb +130 -0
- data/lib/sdk/utils/utils.rb +769 -0
- data/lib/speakeasy_client_sdk_ruby.rb +70 -0
- metadata +206 -0
data/lib/sdk/embeds.rb
ADDED
@@ -0,0 +1,128 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'faraday'
|
7
|
+
require 'faraday/multipart'
|
8
|
+
require 'sorbet-runtime'
|
9
|
+
|
10
|
+
module SpeakeasyClientSDK
|
11
|
+
extend T::Sig
|
12
|
+
class Embeds
|
13
|
+
extend T::Sig
|
14
|
+
sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String).void }
|
15
|
+
def initialize(sdk, client, server_url, language, sdk_version, gen_version)
|
16
|
+
@sdk = sdk
|
17
|
+
@client = client
|
18
|
+
@server_url = server_url
|
19
|
+
@language = language
|
20
|
+
@sdk_version = sdk_version
|
21
|
+
@gen_version = gen_version
|
22
|
+
end
|
23
|
+
|
24
|
+
sig { params(request: Operations::GetEmbedAccessTokenRequest).returns(Utils::FieldAugmented) }
|
25
|
+
def get_embed_access_token(request)
|
26
|
+
# get_embed_access_token - Get an embed access token for the current workspace.
|
27
|
+
# Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content.
|
28
|
+
# Filters can be applied allowing views to be filtered to things like particular customerIds.
|
29
|
+
base_url = @server_url
|
30
|
+
url = "#{base_url.delete_suffix('/')}/v1/workspace/embed-access-token"
|
31
|
+
headers = {}
|
32
|
+
query_params = Utils.get_query_params(Operations::GetEmbedAccessTokenRequest, request)
|
33
|
+
headers['Accept'] = 'application/json;q=1, application/json;q=0'
|
34
|
+
headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
|
35
|
+
|
36
|
+
r = @client.get(url) do |req|
|
37
|
+
req.headers = headers
|
38
|
+
req.params = query_params
|
39
|
+
Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
|
40
|
+
end
|
41
|
+
|
42
|
+
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
43
|
+
|
44
|
+
res = Operations::GetEmbedAccessTokenResponse.new(
|
45
|
+
status_code: r.status, content_type: content_type, raw_response: r
|
46
|
+
)
|
47
|
+
if r.status == 200
|
48
|
+
if Utils.match_content_type(content_type, 'application/json')
|
49
|
+
out = Utils.unmarshal_complex(r.env.response_body, Shared::EmbedAccessTokenResponse)
|
50
|
+
res.embed_access_token_response = out
|
51
|
+
end
|
52
|
+
else
|
53
|
+
if Utils.match_content_type(content_type, 'application/json')
|
54
|
+
out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
|
55
|
+
res.error = out
|
56
|
+
end
|
57
|
+
end
|
58
|
+
res
|
59
|
+
end
|
60
|
+
|
61
|
+
sig { returns(Utils::FieldAugmented) }
|
62
|
+
def get_valid_embed_access_tokens
|
63
|
+
# get_valid_embed_access_tokens - Get all valid embed access tokens for the current workspace.
|
64
|
+
base_url = @server_url
|
65
|
+
url = "#{base_url.delete_suffix('/')}/v1/workspace/embed-access-tokens/valid"
|
66
|
+
headers = {}
|
67
|
+
headers['Accept'] = 'application/json;q=1, application/json;q=0'
|
68
|
+
headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
|
69
|
+
|
70
|
+
r = @client.get(url) do |req|
|
71
|
+
req.headers = headers
|
72
|
+
Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
|
73
|
+
end
|
74
|
+
|
75
|
+
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
76
|
+
|
77
|
+
res = Operations::GetValidEmbedAccessTokensResponse.new(
|
78
|
+
status_code: r.status, content_type: content_type, raw_response: r
|
79
|
+
)
|
80
|
+
if r.status == 200
|
81
|
+
if Utils.match_content_type(content_type, 'application/json')
|
82
|
+
out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::EmbedToken])
|
83
|
+
res.embed_tokens = out
|
84
|
+
end
|
85
|
+
else
|
86
|
+
if Utils.match_content_type(content_type, 'application/json')
|
87
|
+
out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
|
88
|
+
res.error = out
|
89
|
+
end
|
90
|
+
end
|
91
|
+
res
|
92
|
+
end
|
93
|
+
|
94
|
+
sig { params(request: Operations::RevokeEmbedAccessTokenRequest).returns(Utils::FieldAugmented) }
|
95
|
+
def revoke_embed_access_token(request)
|
96
|
+
# revoke_embed_access_token - Revoke an embed access EmbedToken.
|
97
|
+
base_url = @server_url
|
98
|
+
url = Utils.generate_url(
|
99
|
+
Operations::RevokeEmbedAccessTokenRequest,
|
100
|
+
base_url,
|
101
|
+
'/v1/workspace/embed-access-tokens/{tokenID}',
|
102
|
+
request
|
103
|
+
)
|
104
|
+
headers = {}
|
105
|
+
headers['Accept'] = 'application/json'
|
106
|
+
headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
|
107
|
+
|
108
|
+
r = @client.delete(url) do |req|
|
109
|
+
req.headers = headers
|
110
|
+
Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
|
111
|
+
end
|
112
|
+
|
113
|
+
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
114
|
+
|
115
|
+
res = Operations::RevokeEmbedAccessTokenResponse.new(
|
116
|
+
status_code: r.status, content_type: content_type, raw_response: r
|
117
|
+
)
|
118
|
+
if r.status == 200
|
119
|
+
else
|
120
|
+
if Utils.match_content_type(content_type, 'application/json')
|
121
|
+
out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
|
122
|
+
res.error = out
|
123
|
+
end
|
124
|
+
end
|
125
|
+
res
|
126
|
+
end
|
127
|
+
end
|
128
|
+
end
|
data/lib/sdk/metadata.rb
ADDED
@@ -0,0 +1,144 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'faraday'
|
7
|
+
require 'faraday/multipart'
|
8
|
+
require 'sorbet-runtime'
|
9
|
+
|
10
|
+
module SpeakeasyClientSDK
|
11
|
+
extend T::Sig
|
12
|
+
class Metadata
|
13
|
+
extend T::Sig
|
14
|
+
sig { params(sdk: SpeakeasyClientSDK::SDK, client: Faraday::Connection, server_url: String, language: String, sdk_version: String, gen_version: String).void }
|
15
|
+
def initialize(sdk, client, server_url, language, sdk_version, gen_version)
|
16
|
+
@sdk = sdk
|
17
|
+
@client = client
|
18
|
+
@server_url = server_url
|
19
|
+
@language = language
|
20
|
+
@sdk_version = sdk_version
|
21
|
+
@gen_version = gen_version
|
22
|
+
end
|
23
|
+
|
24
|
+
sig { params(request: Operations::DeleteVersionMetadataRequest).returns(Utils::FieldAugmented) }
|
25
|
+
def delete_version_metadata(request)
|
26
|
+
# delete_version_metadata - Delete metadata for a particular apiID and versionID.
|
27
|
+
base_url = @server_url
|
28
|
+
url = Utils.generate_url(
|
29
|
+
Operations::DeleteVersionMetadataRequest,
|
30
|
+
base_url,
|
31
|
+
'/v1/apis/{apiID}/version/{versionID}/metadata/{metaKey}/{metaValue}',
|
32
|
+
request
|
33
|
+
)
|
34
|
+
headers = {}
|
35
|
+
headers['Accept'] = 'application/json'
|
36
|
+
headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
|
37
|
+
|
38
|
+
r = @client.delete(url) do |req|
|
39
|
+
req.headers = headers
|
40
|
+
Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
|
41
|
+
end
|
42
|
+
|
43
|
+
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
44
|
+
|
45
|
+
res = Operations::DeleteVersionMetadataResponse.new(
|
46
|
+
status_code: r.status, content_type: content_type, raw_response: r
|
47
|
+
)
|
48
|
+
if r.status == 200
|
49
|
+
else
|
50
|
+
if Utils.match_content_type(content_type, 'application/json')
|
51
|
+
out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
|
52
|
+
res.error = out
|
53
|
+
end
|
54
|
+
end
|
55
|
+
res
|
56
|
+
end
|
57
|
+
|
58
|
+
sig { params(request: Operations::GetVersionMetadataRequest).returns(Utils::FieldAugmented) }
|
59
|
+
def get_version_metadata(request)
|
60
|
+
# get_version_metadata - Get all metadata for a particular apiID and versionID.
|
61
|
+
base_url = @server_url
|
62
|
+
url = Utils.generate_url(
|
63
|
+
Operations::GetVersionMetadataRequest,
|
64
|
+
base_url,
|
65
|
+
'/v1/apis/{apiID}/version/{versionID}/metadata',
|
66
|
+
request
|
67
|
+
)
|
68
|
+
headers = {}
|
69
|
+
headers['Accept'] = 'application/json;q=1, application/json;q=0'
|
70
|
+
headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
|
71
|
+
|
72
|
+
r = @client.get(url) do |req|
|
73
|
+
req.headers = headers
|
74
|
+
Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
|
75
|
+
end
|
76
|
+
|
77
|
+
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
78
|
+
|
79
|
+
res = Operations::GetVersionMetadataResponse.new(
|
80
|
+
status_code: r.status, content_type: content_type, raw_response: r
|
81
|
+
)
|
82
|
+
if r.status == 200
|
83
|
+
if Utils.match_content_type(content_type, 'application/json')
|
84
|
+
out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::VersionMetadata])
|
85
|
+
res.version_metadata = out
|
86
|
+
end
|
87
|
+
else
|
88
|
+
if Utils.match_content_type(content_type, 'application/json')
|
89
|
+
out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
|
90
|
+
res.error = out
|
91
|
+
end
|
92
|
+
end
|
93
|
+
res
|
94
|
+
end
|
95
|
+
|
96
|
+
sig { params(request: Operations::InsertVersionMetadataRequest).returns(Utils::FieldAugmented) }
|
97
|
+
def insert_version_metadata(request)
|
98
|
+
# insert_version_metadata - Insert metadata for a particular apiID and versionID.
|
99
|
+
base_url = @server_url
|
100
|
+
url = Utils.generate_url(
|
101
|
+
Operations::InsertVersionMetadataRequest,
|
102
|
+
base_url,
|
103
|
+
'/v1/apis/{apiID}/version/{versionID}/metadata',
|
104
|
+
request
|
105
|
+
)
|
106
|
+
headers = {}
|
107
|
+
req_content_type, data, form = Utils.serialize_request_body(request, :version_metadata_input, :json)
|
108
|
+
headers['content-type'] = req_content_type
|
109
|
+
raise StandardError, 'request body is required' if data.nil? && form.nil?
|
110
|
+
headers['Accept'] = 'application/json;q=1, application/json;q=0'
|
111
|
+
headers['user-agent'] = "speakeasy-sdk/#{@language} #{@sdk_version} #{@gen_version}"
|
112
|
+
|
113
|
+
r = @client.post(url) do |req|
|
114
|
+
req.headers = headers
|
115
|
+
Utils.configure_request_security(req, @sdk.security) if !@sdk.nil? && !@sdk.security.nil?
|
116
|
+
if form
|
117
|
+
req.body = Utils.encode_form(form)
|
118
|
+
elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
|
119
|
+
req.body = URI.encode_www_form(data)
|
120
|
+
else
|
121
|
+
req.body = data
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
125
|
+
content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
|
126
|
+
|
127
|
+
res = Operations::InsertVersionMetadataResponse.new(
|
128
|
+
status_code: r.status, content_type: content_type, raw_response: r
|
129
|
+
)
|
130
|
+
if r.status == 200
|
131
|
+
if Utils.match_content_type(content_type, 'application/json')
|
132
|
+
out = Utils.unmarshal_complex(r.env.response_body, Shared::VersionMetadata)
|
133
|
+
res.version_metadata = out
|
134
|
+
end
|
135
|
+
else
|
136
|
+
if Utils.match_content_type(content_type, 'application/json')
|
137
|
+
out = Utils.unmarshal_complex(r.env.response_body, Shared::Error)
|
138
|
+
res.error = out
|
139
|
+
end
|
140
|
+
end
|
141
|
+
res
|
142
|
+
end
|
143
|
+
end
|
144
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'sorbet-runtime'
|
7
|
+
require 'faraday'
|
8
|
+
require_relative '../shared/error'
|
9
|
+
|
10
|
+
module SpeakeasyClientSDK
|
11
|
+
module Operations
|
12
|
+
|
13
|
+
class DeleteApiRequest < SpeakeasyClientSDK::Utils::FieldAugmented
|
14
|
+
extend T::Sig
|
15
|
+
|
16
|
+
# The ID of the Api to delete.
|
17
|
+
field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
|
18
|
+
# The version ID of the Api to delete.
|
19
|
+
field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
|
20
|
+
|
21
|
+
|
22
|
+
sig { params(api_id: String, version_id: String).void }
|
23
|
+
def initialize(api_id: nil, version_id: nil)
|
24
|
+
@api_id = api_id
|
25
|
+
@version_id = version_id
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
|
30
|
+
class DeleteApiResponse < SpeakeasyClientSDK::Utils::FieldAugmented
|
31
|
+
extend T::Sig
|
32
|
+
|
33
|
+
|
34
|
+
field :content_type, String
|
35
|
+
|
36
|
+
field :status_code, Integer
|
37
|
+
# Default error response
|
38
|
+
field :error, T.nilable(Shared::Error)
|
39
|
+
|
40
|
+
field :raw_response, T.nilable(Faraday::Response)
|
41
|
+
|
42
|
+
|
43
|
+
sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
|
44
|
+
def initialize(content_type: nil, status_code: nil, error: nil, raw_response: nil)
|
45
|
+
@content_type = content_type
|
46
|
+
@status_code = status_code
|
47
|
+
@error = error
|
48
|
+
@raw_response = raw_response
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'sorbet-runtime'
|
7
|
+
require 'faraday'
|
8
|
+
require_relative '../shared/error'
|
9
|
+
|
10
|
+
module SpeakeasyClientSDK
|
11
|
+
module Operations
|
12
|
+
|
13
|
+
class DeleteApiEndpointRequest < SpeakeasyClientSDK::Utils::FieldAugmented
|
14
|
+
extend T::Sig
|
15
|
+
|
16
|
+
# The ID of the ApiEndpoint to delete.
|
17
|
+
field :api_endpoint_id, String, { 'path_param': { 'field_name': 'apiEndpointID', 'style': 'simple', 'explode': false } }
|
18
|
+
# The ID of the Api the ApiEndpoint belongs to.
|
19
|
+
field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
|
20
|
+
# The version ID of the Api the ApiEndpoint belongs to.
|
21
|
+
field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
|
22
|
+
|
23
|
+
|
24
|
+
sig { params(api_endpoint_id: String, api_id: String, version_id: String).void }
|
25
|
+
def initialize(api_endpoint_id: nil, api_id: nil, version_id: nil)
|
26
|
+
@api_endpoint_id = api_endpoint_id
|
27
|
+
@api_id = api_id
|
28
|
+
@version_id = version_id
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
|
33
|
+
class DeleteApiEndpointResponse < SpeakeasyClientSDK::Utils::FieldAugmented
|
34
|
+
extend T::Sig
|
35
|
+
|
36
|
+
|
37
|
+
field :content_type, String
|
38
|
+
|
39
|
+
field :status_code, Integer
|
40
|
+
# Default error response
|
41
|
+
field :error, T.nilable(Shared::Error)
|
42
|
+
|
43
|
+
field :raw_response, T.nilable(Faraday::Response)
|
44
|
+
|
45
|
+
|
46
|
+
sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
|
47
|
+
def initialize(content_type: nil, status_code: nil, error: nil, raw_response: nil)
|
48
|
+
@content_type = content_type
|
49
|
+
@status_code = status_code
|
50
|
+
@error = error
|
51
|
+
@raw_response = raw_response
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'sorbet-runtime'
|
7
|
+
require 'faraday'
|
8
|
+
require_relative '../shared/error'
|
9
|
+
|
10
|
+
module SpeakeasyClientSDK
|
11
|
+
module Operations
|
12
|
+
|
13
|
+
class DeleteSchemaRequest < SpeakeasyClientSDK::Utils::FieldAugmented
|
14
|
+
extend T::Sig
|
15
|
+
|
16
|
+
# The ID of the Api to delete schemas for.
|
17
|
+
field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
|
18
|
+
# The revision ID of the schema to delete.
|
19
|
+
field :revision_id, String, { 'path_param': { 'field_name': 'revisionID', 'style': 'simple', 'explode': false } }
|
20
|
+
# The version ID of the Api to delete metadata for.
|
21
|
+
field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
|
22
|
+
|
23
|
+
|
24
|
+
sig { params(api_id: String, revision_id: String, version_id: String).void }
|
25
|
+
def initialize(api_id: nil, revision_id: nil, version_id: nil)
|
26
|
+
@api_id = api_id
|
27
|
+
@revision_id = revision_id
|
28
|
+
@version_id = version_id
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
|
33
|
+
class DeleteSchemaResponse < SpeakeasyClientSDK::Utils::FieldAugmented
|
34
|
+
extend T::Sig
|
35
|
+
|
36
|
+
|
37
|
+
field :content_type, String
|
38
|
+
|
39
|
+
field :status_code, Integer
|
40
|
+
# Default error response
|
41
|
+
field :error, T.nilable(Shared::Error)
|
42
|
+
|
43
|
+
field :raw_response, T.nilable(Faraday::Response)
|
44
|
+
|
45
|
+
|
46
|
+
sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
|
47
|
+
def initialize(content_type: nil, status_code: nil, error: nil, raw_response: nil)
|
48
|
+
@content_type = content_type
|
49
|
+
@status_code = status_code
|
50
|
+
@error = error
|
51
|
+
@raw_response = raw_response
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'sorbet-runtime'
|
7
|
+
require 'faraday'
|
8
|
+
require_relative '../shared/error'
|
9
|
+
|
10
|
+
module SpeakeasyClientSDK
|
11
|
+
module Operations
|
12
|
+
|
13
|
+
class DeleteVersionMetadataRequest < SpeakeasyClientSDK::Utils::FieldAugmented
|
14
|
+
extend T::Sig
|
15
|
+
|
16
|
+
# The ID of the Api to delete metadata for.
|
17
|
+
field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
|
18
|
+
# The key of the metadata to delete.
|
19
|
+
field :meta_key, String, { 'path_param': { 'field_name': 'metaKey', 'style': 'simple', 'explode': false } }
|
20
|
+
# The value of the metadata to delete.
|
21
|
+
field :meta_value, String, { 'path_param': { 'field_name': 'metaValue', 'style': 'simple', 'explode': false } }
|
22
|
+
# The version ID of the Api to delete metadata for.
|
23
|
+
field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
|
24
|
+
|
25
|
+
|
26
|
+
sig { params(api_id: String, meta_key: String, meta_value: String, version_id: String).void }
|
27
|
+
def initialize(api_id: nil, meta_key: nil, meta_value: nil, version_id: nil)
|
28
|
+
@api_id = api_id
|
29
|
+
@meta_key = meta_key
|
30
|
+
@meta_value = meta_value
|
31
|
+
@version_id = version_id
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
|
36
|
+
class DeleteVersionMetadataResponse < SpeakeasyClientSDK::Utils::FieldAugmented
|
37
|
+
extend T::Sig
|
38
|
+
|
39
|
+
|
40
|
+
field :content_type, String
|
41
|
+
|
42
|
+
field :status_code, Integer
|
43
|
+
# Default error response
|
44
|
+
field :error, T.nilable(Shared::Error)
|
45
|
+
|
46
|
+
field :raw_response, T.nilable(Faraday::Response)
|
47
|
+
|
48
|
+
|
49
|
+
sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response)).void }
|
50
|
+
def initialize(content_type: nil, status_code: nil, error: nil, raw_response: nil)
|
51
|
+
@content_type = content_type
|
52
|
+
@status_code = status_code
|
53
|
+
@error = error
|
54
|
+
@raw_response = raw_response
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'sorbet-runtime'
|
7
|
+
require 'faraday'
|
8
|
+
require_relative '../shared/error'
|
9
|
+
|
10
|
+
module SpeakeasyClientSDK
|
11
|
+
module Operations
|
12
|
+
|
13
|
+
class DownloadSchemaRequest < SpeakeasyClientSDK::Utils::FieldAugmented
|
14
|
+
extend T::Sig
|
15
|
+
|
16
|
+
# The ID of the Api to download the schema for.
|
17
|
+
field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
|
18
|
+
# The version ID of the Api to delete metadata for.
|
19
|
+
field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
|
20
|
+
|
21
|
+
|
22
|
+
sig { params(api_id: String, version_id: String).void }
|
23
|
+
def initialize(api_id: nil, version_id: nil)
|
24
|
+
@api_id = api_id
|
25
|
+
@version_id = version_id
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
|
30
|
+
class DownloadSchemaResponse < SpeakeasyClientSDK::Utils::FieldAugmented
|
31
|
+
extend T::Sig
|
32
|
+
|
33
|
+
|
34
|
+
field :content_type, String
|
35
|
+
|
36
|
+
field :status_code, Integer
|
37
|
+
# Default error response
|
38
|
+
field :error, T.nilable(Shared::Error)
|
39
|
+
|
40
|
+
field :raw_response, T.nilable(Faraday::Response)
|
41
|
+
# OK
|
42
|
+
field :schema, T.nilable(String)
|
43
|
+
|
44
|
+
|
45
|
+
sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response), schema: T.nilable(String)).void }
|
46
|
+
def initialize(content_type: nil, status_code: nil, error: nil, raw_response: nil, schema: nil)
|
47
|
+
@content_type = content_type
|
48
|
+
@status_code = status_code
|
49
|
+
@error = error
|
50
|
+
@raw_response = raw_response
|
51
|
+
@schema = schema
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'sorbet-runtime'
|
7
|
+
require 'faraday'
|
8
|
+
require_relative '../shared/error'
|
9
|
+
|
10
|
+
module SpeakeasyClientSDK
|
11
|
+
module Operations
|
12
|
+
|
13
|
+
class DownloadSchemaRevisionRequest < SpeakeasyClientSDK::Utils::FieldAugmented
|
14
|
+
extend T::Sig
|
15
|
+
|
16
|
+
# The ID of the Api to retrieve schemas for.
|
17
|
+
field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
|
18
|
+
# The revision ID of the schema to retrieve.
|
19
|
+
field :revision_id, String, { 'path_param': { 'field_name': 'revisionID', 'style': 'simple', 'explode': false } }
|
20
|
+
# The version ID of the Api to delete metadata for.
|
21
|
+
field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
|
22
|
+
|
23
|
+
|
24
|
+
sig { params(api_id: String, revision_id: String, version_id: String).void }
|
25
|
+
def initialize(api_id: nil, revision_id: nil, version_id: nil)
|
26
|
+
@api_id = api_id
|
27
|
+
@revision_id = revision_id
|
28
|
+
@version_id = version_id
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
|
33
|
+
class DownloadSchemaRevisionResponse < SpeakeasyClientSDK::Utils::FieldAugmented
|
34
|
+
extend T::Sig
|
35
|
+
|
36
|
+
|
37
|
+
field :content_type, String
|
38
|
+
|
39
|
+
field :status_code, Integer
|
40
|
+
# Default error response
|
41
|
+
field :error, T.nilable(Shared::Error)
|
42
|
+
|
43
|
+
field :raw_response, T.nilable(Faraday::Response)
|
44
|
+
# OK
|
45
|
+
field :schema, T.nilable(String)
|
46
|
+
|
47
|
+
|
48
|
+
sig { params(content_type: String, status_code: Integer, error: T.nilable(Shared::Error), raw_response: T.nilable(Faraday::Response), schema: T.nilable(String)).void }
|
49
|
+
def initialize(content_type: nil, status_code: nil, error: nil, raw_response: nil, schema: nil)
|
50
|
+
@content_type = content_type
|
51
|
+
@status_code = status_code
|
52
|
+
@error = error
|
53
|
+
@raw_response = raw_response
|
54
|
+
@schema = schema
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
require 'sorbet-runtime'
|
7
|
+
require 'faraday'
|
8
|
+
require_relative '../shared/apiendpoint'
|
9
|
+
require_relative '../shared/error'
|
10
|
+
|
11
|
+
module SpeakeasyClientSDK
|
12
|
+
module Operations
|
13
|
+
|
14
|
+
class FindApiEndpointRequest < SpeakeasyClientSDK::Utils::FieldAugmented
|
15
|
+
extend T::Sig
|
16
|
+
|
17
|
+
# The ID of the Api the ApiEndpoint belongs to.
|
18
|
+
field :api_id, String, { 'path_param': { 'field_name': 'apiID', 'style': 'simple', 'explode': false } }
|
19
|
+
# The displayName of the ApiEndpoint to find (set by operationId from OpenAPI schema).
|
20
|
+
field :display_name, String, { 'path_param': { 'field_name': 'displayName', 'style': 'simple', 'explode': false } }
|
21
|
+
# The version ID of the Api the ApiEndpoint belongs to.
|
22
|
+
field :version_id, String, { 'path_param': { 'field_name': 'versionID', 'style': 'simple', 'explode': false } }
|
23
|
+
|
24
|
+
|
25
|
+
sig { params(api_id: String, display_name: String, version_id: String).void }
|
26
|
+
def initialize(api_id: nil, display_name: nil, version_id: nil)
|
27
|
+
@api_id = api_id
|
28
|
+
@display_name = display_name
|
29
|
+
@version_id = version_id
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
|
34
|
+
class FindApiEndpointResponse < SpeakeasyClientSDK::Utils::FieldAugmented
|
35
|
+
extend T::Sig
|
36
|
+
|
37
|
+
|
38
|
+
field :content_type, String
|
39
|
+
|
40
|
+
field :status_code, Integer
|
41
|
+
# OK
|
42
|
+
field :api_endpoint, T.nilable(Shared::ApiEndpoint)
|
43
|
+
# Default error response
|
44
|
+
field :error, T.nilable(Shared::Error)
|
45
|
+
|
46
|
+
field :raw_response, T.nilable(Faraday::Response)
|
47
|
+
|
48
|
+
|
49
|
+
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 }
|
50
|
+
def initialize(content_type: nil, status_code: nil, api_endpoint: nil, error: nil, raw_response: nil)
|
51
|
+
@content_type = content_type
|
52
|
+
@status_code = status_code
|
53
|
+
@api_endpoint = api_endpoint
|
54
|
+
@error = error
|
55
|
+
@raw_response = raw_response
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|