Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
**/.speakeasy/temp/
**/.speakeasy/logs/
bin/
sorbet/
.env
.env.local
.DS_Store
*.gem
Gemfile.lock
Expand Down
6 changes: 5 additions & 1 deletion .rubocop.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
plugins:
- rubocop-minitest

AllCops:
Exclude:
- Rakefile
TargetRubyVersion: "3.0"
- bin/**/*
TargetRubyVersion: "3.2"
Metrics:
Enabled: false
Style/IfInsideElse:
Expand Down
1,431 changes: 751 additions & 680 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

21 changes: 20 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,35 @@ generation:
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
sdkInitStyle: constructor
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
nameResolutionFeb2025: false
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
securityFeb2025: false
sharedErrorComponentsApr2025: false
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
hoistGlobalSecurity: true
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
ruby:
version: 4.2.24
version: 4.3.0
additionalDependencies:
development: {}
runtime: {}
author: Speakeasy
baseErrorName: SpeakeasyClientSDKError
clientServerStatusCodesAsErrors: true
constFieldsAlwaysOptional: false
defaultErrorName: APIError
description: Ruby Client SDK Generated by Speakeasy
flattenGlobalSecurity: false
imports:
option: openapi
paths:
Expand All @@ -28,3 +46,4 @@ ruby:
module: OpenApiSdk
outputModelSuffix: output
packageName: speakeasy_client_sdk_ruby
typingStrategy: sorbet
8 changes: 7 additions & 1 deletion .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
speakeasyVersion: 1.405.8
speakeasyVersion: 1.635.1
sources: {}
targets:
speakeasy-client-sdk:
Expand All @@ -21,3 +21,9 @@ workflow:
publish:
rubygems:
token: $rubygems_auth_token
codeSamples:
registry:
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/-oas-ruby-code-samples
labelOverride:
fixedValue: Ruby (SDK)
blocking: false
6 changes: 6 additions & 0 deletions .speakeasy/workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,9 @@ targets:
publish:
rubygems:
token: $rubygems_auth_token
codeSamples:
registry:
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/-oas-ruby-code-samples
labelOverride:
fixedValue: Ruby (SDK)
blocking: false
359 changes: 276 additions & 83 deletions README.md

Large diffs are not rendered by default.

12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,14 @@ Based on:
### Generated
- [ruby v4.2.24] .
### Releases
- [Ruby Gems v4.2.24] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.24 - .
- [Ruby Gems v4.2.24] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.24 - .

## 2025-10-07 00:30:06
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.635.1 (2.722.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v4.3.0] .
### Releases
- [Ruby Gems v4.3.0] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.3.0 - .
23 changes: 14 additions & 9 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,20 @@ require 'rubocop/rake_task'

RuboCop::RakeTask.new

Minitest::TestTask.create
Minitest::TestTask.create do |t|
# workaround to avoid throwing warnings from Janeway library circular require...
t.warning = false
end

# So far default is working - leaving this here for reference.
task :default => :test

# Minitest::TestTask.create(:test) do |t|
# t.libs << 'test'
# t.libs << 'lib'
# t.warning = false
# t.test_globs = ['test/**/*_test.rb']
# end

task :default => :test
# Developers can run all tests with:
#
# $ rake test
#
# Developers can run individual test files with:
#
# $ rake test test/parameter_test
#
# and run individual tests by adding `focus` to the line before the test definition.
24 changes: 8 additions & 16 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,16 @@
```ruby
require 'speakeasy_client_sdk_ruby'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::SpeakeasyClientSDK.new(
security: Models::Shared::Security.new(
api_key: '<YOUR_API_KEY_HERE>',
),
)

s = ::OpenApiSDK::SpeakeasyClientSDK.new
s.config_security(
::OpenApiSDK::Shared::Security.new(
api_key: "<YOUR_API_KEY_HERE>",
)
)
res = s.auth.validate_api_key()


res = s.apis.get_all(op=::OpenApiSDK::Operations::Op.new(
and_: false,
), metadata={
"key": [
"<value>",
],
})

if ! res.apis.nil?
unless res.api_key_details.nil?
# handle response
end

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ActivateSubscriptionNamespaceRequest


## Fields

| Field | Type | Required | Description |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `subscription_id` | *::String* | :heavy_check_mark: | The existing subscription ID |
| `namespace_name` | *::String* | :heavy_check_mark: | The namespace name |
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DeleteApiResponse
# ActivateSubscriptionNamespaceResponse


## Fields
Expand All @@ -7,5 +7,4 @@
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
9 changes: 9 additions & 0 deletions docs/models/operations/archivenamespacerequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ArchiveNamespaceRequest


## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `namespace_name` | *::String* | :heavy_check_mark: | N/A |
| `request_body` | [T.nilable(Models::Operations::ArchiveNamespaceRequestBody)](../../models/operations/archivenamespacerequestbody.md) | :heavy_minus_sign: | Archived status |
10 changes: 10 additions & 0 deletions docs/models/operations/archivenamespacerequestbody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ArchiveNamespaceRequestBody

Archived status


## Fields

| Field | Type | Required | Description |
| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
| `archived` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A |
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RegisterSchemaResponse
# ArchiveNamespaceResponse


## Fields
Expand All @@ -7,5 +7,4 @@
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
3 changes: 1 addition & 2 deletions docs/models/operations/checkgithubaccessresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11 changes: 11 additions & 0 deletions docs/models/operations/createbillingaddonsresponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CreateBillingAddOnsResponse


## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `organization_billing_add_on_response` | [T.nilable(Models::Shared::OrganizationBillingAddOnResponse)](../../models/shared/organizationbillingaddonresponse.md) | :heavy_minus_sign: | Success |
3 changes: 1 addition & 2 deletions docs/models/operations/createfreetrialresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
Loading