Skip to content

Commit 1ed92a9

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.44.2
1 parent 9ee08fd commit 1ed92a9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+7057
-1
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.gem
2+
Gemfile.lock
3+
.rbenv-gemsets

‎.rubocop.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
AllCops:
2+
Exclude:
3+
- Rakefile
4+
- test/*.rb
5+
TargetRubyVersion: "3.0"
6+
Metrics:
7+
Enabled: false
8+
Style/IfInsideElse:
9+
Enabled: false
10+
Style/GuardClause:
11+
Enabled: false
12+
Style/ConditionalAssignment:
13+
Enabled: false
14+
Style/Documentation:
15+
Enabled: false
16+
Style/NegatedIf:
17+
Enabled: false
18+
Style/SoleNestedConditional:
19+
Enabled: false
20+
Style/AccessorGrouping:
21+
Enabled: false
22+
Layout/EndAlignment:
23+
EnforcedStyleAlignWith: start_of_line
24+
Enabled: false
25+
Layout/LineLength:
26+
Enabled: false
27+
Lint/EmptyConditionalBody:
28+
Enabled: false
29+
Lint/MissingSuper:
30+
Enabled: false
31+
#To eventually re-enable:
32+
Layout/EmptyLines:
33+
Enabled: false
34+
Layout/EmptyLinesAroundMethodBody:
35+
Enabled: false
36+
Layout/EmptyLineBetweenDefs:
37+
Enabled: false
38+
Layout/EmptyLineAfterGuardClause:
39+
Enabled: false
40+
Layout/EmptyLinesAroundModuleBody:
41+
Enabled: false
42+
Layout/MultilineBlockLayout:
43+
Enabled: false
44+
Lint/UnusedMethodArgument:
45+
Enabled: false
46+
Layout/TrailingWhitespace:
47+
Enabled: false
48+
Style/IfUnlessModifier:
49+
Enabled: false
50+
Naming/AccessorMethodName:
51+
Enabled: false
52+
Naming/MethodParameterName:
53+
Enabled: false

‎Gemfile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# frozen_string_literal: true
2+
3+
source 'https://rubygems.org'
4+
5+
# Specify your gem's dependencies in openapi.gemspec
6+
gemspec

‎README.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<!-- Start SDK Installation -->
2+
## SDK Installation
3+
4+
```bash
5+
gem install speakeasy_client_sdk_ruby
6+
```
7+
<!-- End SDK Installation -->
8+
9+
## SDK Example Usage
10+
<!-- Start SDK Example Usage -->
11+
```ruby
12+
require_relative sdk
13+
14+
15+
s = sdk::SDK.new
16+
17+
18+
req = Operations::Operations::GetApisRequest(
19+
query_params=Operations::GetApisRequest(
20+
metadata={
21+
"provident": [
22+
"quibusdam",
23+
"unde",
24+
"nulla",
25+
],
26+
"corrupti": [
27+
"vel",
28+
"error",
29+
"deserunt",
30+
"suscipit",
31+
],
32+
"iure": [
33+
"debitis",
34+
"ipsa",
35+
],
36+
},
37+
op=Operations::GetApisOp(
38+
and_=false,
39+
),
40+
),
41+
)
42+
43+
res = s.apis::get_apis(req)
44+
45+
if ! res.apis.nil?
46+
# handle response
47+
end
48+
49+
```
50+
51+
<!-- End SDK Example Usage -->
52+
53+
<!-- Start SDK Available Operations -->
54+
## Available Resources and Operations
55+
56+
### [SDK](docs/sdk/README.md)
57+
58+
* [validate_api_key](docs/sdk/README.md#validate_api_key) - Validate the current api key.
59+
60+
### [api_endpoints](docs/apiendpoints/README.md)
61+
62+
* [delete_api_endpoint](docs/apiendpoints/README.md#delete_api_endpoint) - Delete an ApiEndpoint.
63+
* [find_api_endpoint](docs/apiendpoints/README.md#find_api_endpoint) - Find an ApiEndpoint via its displayName.
64+
* [generate_open_api_spec_for_api_endpoint](docs/apiendpoints/README.md#generate_open_api_spec_for_api_endpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
65+
* [generate_postman_collection_for_api_endpoint](docs/apiendpoints/README.md#generate_postman_collection_for_api_endpoint) - Generate a Postman collection for a particular ApiEndpoint.
66+
* [get_all_api_endpoints](docs/apiendpoints/README.md#get_all_api_endpoints) - Get all Api endpoints for a particular apiID.
67+
* [get_all_for_version_api_endpoints](docs/apiendpoints/README.md#get_all_for_version_api_endpoints) - Get all ApiEndpoints for a particular apiID and versionID.
68+
* [get_api_endpoint](docs/apiendpoints/README.md#get_api_endpoint) - Get an ApiEndpoint.
69+
* [upsert_api_endpoint](docs/apiendpoints/README.md#upsert_api_endpoint) - Upsert an ApiEndpoint.
70+
71+
### [apis](docs/apis/README.md)
72+
73+
* [delete_api](docs/apis/README.md#delete_api) - Delete an Api.
74+
* [generate_open_api_spec](docs/apis/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular Api.
75+
* [generate_postman_collection](docs/apis/README.md#generate_postman_collection) - Generate a Postman collection for a particular Api.
76+
* [get_all_api_versions](docs/apis/README.md#get_all_api_versions) - Get all Api versions for a particular ApiEndpoint.
77+
* [get_apis](docs/apis/README.md#get_apis) - Get a list of Apis for a given workspace
78+
* [upsert_api](docs/apis/README.md#upsert_api) - Upsert an Api
79+
80+
### [embeds](docs/embeds/README.md)
81+
82+
* [get_embed_access_token](docs/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
83+
* [get_valid_embed_access_tokens](docs/embeds/README.md#get_valid_embed_access_tokens) - Get all valid embed access tokens for the current workspace.
84+
* [revoke_embed_access_token](docs/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.
85+
86+
### [metadata](docs/metadata/README.md)
87+
88+
* [delete_version_metadata](docs/metadata/README.md#delete_version_metadata) - Delete metadata for a particular apiID and versionID.
89+
* [get_version_metadata](docs/metadata/README.md#get_version_metadata) - Get all metadata for a particular apiID and versionID.
90+
* [insert_version_metadata](docs/metadata/README.md#insert_version_metadata) - Insert metadata for a particular apiID and versionID.
91+
92+
### [plugins](docs/plugins/README.md)
93+
94+
* [get_plugins](docs/plugins/README.md#get_plugins) - Get all plugins for the current workspace.
95+
* [run_plugin](docs/plugins/README.md#run_plugin) - Run a plugin
96+
* [upsert_plugin](docs/plugins/README.md#upsert_plugin) - Upsert a plugin
97+
98+
### [requests](docs/requests/README.md)
99+
100+
* [generate_request_postman_collection](docs/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
101+
* [get_request_from_event_log](docs/requests/README.md#get_request_from_event_log) - Get information about a particular request.
102+
* [query_event_log](docs/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.
103+
104+
### [schemas](docs/schemas/README.md)
105+
106+
* [delete_schema](docs/schemas/README.md#delete_schema) - Delete a particular schema revision for an Api.
107+
* [download_schema](docs/schemas/README.md#download_schema) - Download the latest schema for a particular apiID.
108+
* [download_schema_revision](docs/schemas/README.md#download_schema_revision) - Download a particular schema revision for an Api.
109+
* [get_schema](docs/schemas/README.md#get_schema) - Get information about the latest schema.
110+
* [get_schema_diff](docs/schemas/README.md#get_schema_diff) - Get a diff of two schema revisions for an Api.
111+
* [get_schema_revision](docs/schemas/README.md#get_schema_revision) - Get information about a particular schema revision for an Api.
112+
* [get_schemas](docs/schemas/README.md#get_schemas) - Get information about all schemas associated with a particular apiID.
113+
* [register_schema](docs/schemas/README.md#register_schema) - Register a schema.
114+
<!-- End SDK Available Operations -->
115+
116+
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎RELEASES.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
3+
## 2023-06-06 16:50:02
4+
### Changes
5+
Based on:
6+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
7+
- Speakeasy CLI 1.44.2 (2.35.9) https://github.com/speakeasy-api/speakeasy
8+
### Releases
9+
- [Ruby Gems v1.0.1] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/1.0.1 - .

‎Rakefile‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# typed: true
2+
# frozen_string_literal: true
3+
4+
require 'bundler/gem_tasks'
5+
require 'minitest/test_task'
6+
require 'rubocop/rake_task'
7+
8+
RuboCop::RakeTask.new
9+
10+
Minitest::TestTask.create
11+
12+
# So far default is working - leaving this here for reference.
13+
14+
# Minitest::TestTask.create(:test) do |t|
15+
# t.libs << 'test'
16+
# t.libs << 'lib'
17+
# t.warning = false
18+
# t.test_globs = ['test/**/*_test.rb']
19+
# end
20+
21+
task :default => :test

‎USAGE.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!-- Start SDK Example Usage -->
2+
```ruby
3+
require_relative sdk
4+
5+
6+
s = sdk::SDK.new
7+
8+
9+
req = Operations::Operations::GetApisRequest(
10+
query_params=Operations::GetApisRequest(
11+
metadata={
12+
"provident": [
13+
"quibusdam",
14+
"unde",
15+
"nulla",
16+
],
17+
"corrupti": [
18+
"vel",
19+
"error",
20+
"deserunt",
21+
"suscipit",
22+
],
23+
"iure": [
24+
"debitis",
25+
"ipsa",
26+
],
27+
},
28+
op=Operations::GetApisOp(
29+
and_=false,
30+
),
31+
),
32+
)
33+
34+
res = s.apis::get_apis(req)
35+
36+
if ! res.apis.nil?
37+
# handle response
38+
end
39+
40+
```
41+
42+
<!-- End SDK Example Usage -->

0 commit comments

Comments
 (0)