Skip to content

Commit 497d2ac

Browse files
srqaisrqai
authored
Merge pull request #4 from authlete/speakeasy-sdk-regen-1766147604
chore: 🐝 Update SDK - Generate 0.0.2-beta.1
2 parents 42a5a84 + 659fe9b commit 497d2ac

9 files changed

Lines changed: 131 additions & 37 deletions

File tree

‎.speakeasy/gen.lock‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
lockVersion: 2.0.0
22
id: 0a8a4187-e84f-4270-962c-75ec55a6d5eb
33
management:
4-
docChecksum: 6e584e7594de41d3295df6fcd4fe05e6
4+
docChecksum: 584884e27951d47c44546924f5550e6c
55
docVersion: 3.0.16
6-
speakeasyVersion: 1.680.1
6+
speakeasyVersion: 1.680.3
77
generationVersion: 2.788.5
8-
releaseVersion: 0.0.2-beta
9-
configChecksum: 6702311f0aabcc1622d77aababe4b4b0
8+
releaseVersion: 0.0.2-beta.1
9+
configChecksum: 9a8db6fada9f483033102b98fffdb702
1010
repoURL: https://github.com/authlete/authlete-ruby-sdk.git
1111
installationURL: https://github.com/authlete/authlete-ruby-sdk
1212
published: true
1313
persistentEdits:
14-
generation_id: fdc39490-c662-46fb-90a3-08a78f1fdc99
15-
pristine_commit_hash: e050d84a88142d5576cd8cfb7ce33efc71323c62
16-
pristine_tree_hash: 1867f809ca0b9f30c148620d37d5e5da4ca4ead9
14+
generation_id: 72ba1eb3-58d1-4957-a414-bdec0c1dafa3
15+
pristine_commit_hash: 1f99532928cc0e29d884838992cbfc97a45a5c09
16+
pristine_tree_hash: 85c5eb4b15481238f1d45816abb22960bcbd84b9
1717
features:
1818
ruby:
1919
core: 3.11.7
@@ -41,8 +41,8 @@ trackedFiles:
4141
pristine_git_object: b0ea40558f3ca80dcf7d30b159d34a1e5ab33440
4242
Gemfile.lock:
4343
id: 21fb5836b499
44-
last_write_checksum: sha1:eaf454e929677c8c386b517da5e28e060677b5ef
45-
pristine_git_object: 4bc21f6380725dee5b12fee987a4e3e2d0bd8f3e
44+
last_write_checksum: sha1:551ddf5d3c58c7c432b6749e5eb77d7e93ef51ac
45+
pristine_git_object: dd58ba26f4867a386400e725167a86480b06e6c2
4646
Rakefile:
4747
id: 44b7fa1ba503
4848
last_write_checksum: sha1:bb15946e7c34d00098a6ee8fef994bbd57960092
@@ -53,8 +53,8 @@ trackedFiles:
5353
pristine_git_object: dddca85b94f4450de02eb37241fb9d4ff187f4aa
5454
authlete_ruby_test.gemspec:
5555
id: 2466cacca632
56-
last_write_checksum: sha1:bcb0bef5a97c1242ffe90eced1d48a9c74b9c01c
57-
pristine_git_object: 53bad725424df5b0df3aa4c5701ea5ce7efcae8a
56+
last_write_checksum: sha1:d76139e1c979eca7741fd2327c9ecefdb4ba7f4c
57+
pristine_git_object: 45d22bd7a62cc385d832ad0694bc03fd76c019db
5858
docs/models/components/accesstoken.md:
5959
id: 94ff2e4425e9
6060
last_write_checksum: sha1:a5016925cce7e46d50ebfd351c53fb906209283f
@@ -4637,8 +4637,8 @@ trackedFiles:
46374637
pristine_git_object: 0e06c94e406f3b3b22e278c475d9b8f03b6a15ab
46384638
lib/authlete/sdkconfiguration.rb:
46394639
id: 6b998183b660
4640-
last_write_checksum: sha1:03448713a733cf593d972c19d937fcd408e89467
4641-
pristine_git_object: 1b6d891fec6f42c597e2db3ff0ab66831ec32ee0
4640+
last_write_checksum: sha1:db842d5eaa6268724b569d296e96a8c048832928
4641+
pristine_git_object: ce2d58e3d3451fcfe794e5942aa6a3b5f15b5421
46424642
lib/authlete/sdkconfiguration.rbi:
46434643
id: edf621a1c9a3
46444644
last_write_checksum: sha1:7c016cee27ecfe884f5b58cfc220c4fe29b31f34

‎.speakeasy/gen.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ generation:
3030
generateNewTests: true
3131
skipResponseBodyAssertions: false
3232
ruby:
33-
version: 0.0.2-beta
33+
version: 0.0.2-beta.1
3434
additionalDependencies:
3535
development: {}
3636
runtime: {}

‎.speakeasy/out.openapi.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.3
22
info:
33
title: Authlete API
4-
description: "Official Ruby SDK for Authlete API v3+"
4+
description: "Welcome to the **Authlete API documentation**. Authlete is an **API-first service** where every aspect of the \nplatform is configurable via API. This documentation will help you authenticate and integrate with Authlete to \nbuild powerful OAuth 2.0 and OpenID Connect servers. \U0001F680\n\nAt a high level, the Authlete API is grouped into two categories:\n\n- **Management APIs**: Enable you to manage services and clients. \U0001F527\n- **Runtime APIs**: Allow you to build your own Authorization Servers or Verifiable Credential (VC) issuers. \U0001F510\n\n## \U0001F310 API Servers\n\nAuthlete is a global service with clusters available in multiple regions across the world:\n\n- \U0001F1FA\U0001F1F8 **US**: `https://us.authlete.com`\n- \U0001F1EF\U0001F1F5 **Japan**: `https://jp.authlete.com`\n- \U0001F1EA\U0001F1FA **Europe**: `https://eu.authlete.com`\n- \U0001F1E7\U0001F1F7 **Brazil**: `https://br.authlete.com`\n\nOur customers can host their data in the region that best meets their requirements.\n\n## \U0001F511 Authentication\n\nAll API endpoints are secured using **Bearer token authentication**. You must include an access token in every request:\n\n```\nAuthorization: Bearer YOUR_ACCESS_TOKEN\n```\n\n### Getting Your Access Token\n\nAuthlete supports two types of access tokens:\n\n**Service Access Token** - Scoped to a single service (authorization server instance)\n\n1. Log in to [Authlete Console](https://console.authlete.com)\n2. Navigate to your service → **Settings** → **Access Tokens**\n3. Click **Create Token** and select permissions (e.g., `service.read`, `client.write`)\n4. Copy the generated token\n\n**Organization Token** - Scoped to your entire organization\n\n1. Log in to [Authlete Console](https://console.authlete.com)\n2. Navigate to **Organization Settings** → **Access Tokens**\n3. Click **Create Token** and select org-level permissions\n4. Copy the generated token\n\n> ⚠️ **Important Note**: Tokens inherit the permissions of the account that creates them. Service tokens can only \n> access their specific service, while organization tokens can access all services within your org.\n\n### Token Security Best Practices\n\n- **Never commit tokens to version control** - Store in environment variables or secure secret managers\n- **Rotate regularly** - Generate new tokens periodically and revoke old ones\n- **Scope appropriately** - Request only the permissions your application needs\n- **Revoke unused tokens** - Delete tokens you're no longer using from the console\n\n### Quick Test\n\nVerify your token works with a simple API call:\n\n```bash\ncurl -X GET https://us.authlete.com/api/service/get/list \\\n -H \"Authorization: Bearer YOUR_ACCESS_TOKEN\"\n```\n\n## \U0001F393 Tutorials\n\nIf you're new to Authlete or want to see sample implementations, these resources will help you get started:\n\n- [\U0001F680 Getting Started with Authlete](https://www.authlete.com/developers/getting_started/)\n- [\U0001F511 From Sign-Up to the First API Request](https://www.authlete.com/developers/tutorial/signup/)\n\n## \U0001F6E0 Contact Us\n\nIf you have any questions or need assistance, our team is here to help:\n\n- [Contact Page](https://www.authlete.com/contact/)\n"
55
version: 3.0.16
66
license:
77
name: Apache 2.0

‎.speakeasy/workflow.lock‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.680.1
1+
speakeasyVersion: 1.680.3
22
sources:
33
authlete-OAS:
44
sourceNamespace: authlete-oas
5-
sourceRevisionDigest: sha256:6d1949056e06ecadf5fd3eb2ff557e4b56bc020e179edfd90344280be9e6a16e
6-
sourceBlobDigest: sha256:6c79bab75ce23d8b04b9797e333d42cf86a25be756dad9f363ce292c48f0d753
5+
sourceRevisionDigest: sha256:28c1a2eb450c9ea160a4ec51fc927228e8b9c8d1bcee7325b2d725377338828c
6+
sourceBlobDigest: sha256:e2d1e4a8d2ca8c50365a1acf706c3696bcd2d224b494c0457999286372eb0185
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1766125589
9+
- speakeasy-sdk-regen-1766147604
1010
- 3.0.16
1111
targets:
1212
authlete:
1313
source: authlete-OAS
1414
sourceNamespace: authlete-oas
15-
sourceRevisionDigest: sha256:6d1949056e06ecadf5fd3eb2ff557e4b56bc020e179edfd90344280be9e6a16e
16-
sourceBlobDigest: sha256:6c79bab75ce23d8b04b9797e333d42cf86a25be756dad9f363ce292c48f0d753
15+
sourceRevisionDigest: sha256:28c1a2eb450c9ea160a4ec51fc927228e8b9c8d1bcee7325b2d725377338828c
16+
sourceBlobDigest: sha256:e2d1e4a8d2ca8c50365a1acf706c3696bcd2d224b494c0457999286372eb0185
1717
codeSamplesNamespace: authlete-oas-ruby-code-samples
18-
codeSamplesRevisionDigest: sha256:456483f65f6146d03efd232167871c1b7f980d13782968bcce42e34d18209253
18+
codeSamplesRevisionDigest: sha256:72e35b1cb9a9a303886a4a4bd579c42504025f4a1d473ff2015c693a72d9e58b
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

‎Gemfile.lock‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
authlete_ruby_test (0.0.2.pre.beta)
4+
authlete_ruby_test (0.0.2.pre.beta.1)
55
base64 (>= 0.2.0, < 1.0)
66
faraday
77
faraday-multipart

‎README.md‎

Lines changed: 94 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,97 @@ Developer-friendly & type-safe Ruby SDK specifically catered to leverage *authle
1717
<!-- Start Summary [summary] -->
1818
## Summary
1919

20-
Authlete API: Official Ruby SDK for Authlete API v3+
20+
Authlete API: Welcome to the **Authlete API documentation**. Authlete is an **API-first service** where every aspect of the
21+
platform is configurable via API. This documentation will help you authenticate and integrate with Authlete to
22+
build powerful OAuth 2.0 and OpenID Connect servers. 🚀
23+
24+
At a high level, the Authlete API is grouped into two categories:
25+
26+
- **Management APIs**: Enable you to manage services and clients. 🔧
27+
- **Runtime APIs**: Allow you to build your own Authorization Servers or Verifiable Credential (VC) issuers. 🔐
28+
29+
## 🌐 API Servers
30+
31+
Authlete is a global service with clusters available in multiple regions across the world:
32+
33+
- 🇺🇸 **US**: `https://us.authlete.com`
34+
- 🇯🇵 **Japan**: `https://jp.authlete.com`
35+
- 🇪🇺 **Europe**: `https://eu.authlete.com`
36+
- 🇧🇷 **Brazil**: `https://br.authlete.com`
37+
38+
Our customers can host their data in the region that best meets their requirements.
39+
40+
## 🔑 Authentication
41+
42+
All API endpoints are secured using **Bearer token authentication**. You must include an access token in every request:
43+
44+
```
45+
Authorization: Bearer YOUR_ACCESS_TOKEN
46+
```
47+
48+
### Getting Your Access Token
49+
50+
Authlete supports two types of access tokens:
51+
52+
**Service Access Token** - Scoped to a single service (authorization server instance)
53+
54+
1. Log in to [Authlete Console](https://console.authlete.com)
55+
2. Navigate to your service → **Settings** → **Access Tokens**
56+
3. Click **Create Token** and select permissions (e.g., `service.read`, `client.write`)
57+
4. Copy the generated token
58+
59+
**Organization Token** - Scoped to your entire organization
60+
61+
1. Log in to [Authlete Console](https://console.authlete.com)
62+
2. Navigate to **Organization Settings** → **Access Tokens**
63+
3. Click **Create Token** and select org-level permissions
64+
4. Copy the generated token
65+
66+
> ⚠️ **Important Note**: Tokens inherit the permissions of the account that creates them. Service tokens can only
67+
> access their specific service, while organization tokens can access all services within your org.
68+
69+
### Token Security Best Practices
70+
71+
- **Never commit tokens to version control** - Store in environment variables or secure secret managers
72+
- **Rotate regularly** - Generate new tokens periodically and revoke old ones
73+
- **Scope appropriately** - Request only the permissions your application needs
74+
- **Revoke unused tokens** - Delete tokens you're no longer using from the console
75+
76+
### Quick Test
77+
78+
Verify your token works with a simple API call:
79+
80+
```bash
81+
curl -X GET https://us.authlete.com/api/service/get/list \
82+
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
83+
```
84+
85+
## 🎓 Tutorials
86+
87+
If you're new to Authlete or want to see sample implementations, these resources will help you get started:
88+
89+
- [🚀 Getting Started with Authlete](https://www.authlete.com/developers/getting_started/)
90+
- [🔑 From Sign-Up to the First API Request](https://www.authlete.com/developers/tutorial/signup/)
91+
92+
## 🛠 Contact Us
93+
94+
If you have any questions or need assistance, our team is here to help:
95+
96+
- [Contact Page](https://www.authlete.com/contact/)
2197
<!-- End Summary [summary] -->
2298

2399
<!-- Start Table of Contents [toc] -->
24100
## Table of Contents
25101
<!-- $toc-max-depth=2 -->
26102
* [authlete](#authlete)
103+
* [🌐 API Servers](#api-servers)
104+
* [🔑 Authentication](#authentication)
105+
* [🎓 Tutorials](#tutorials)
106+
* [🛠 Contact Us](#contact-us)
27107
* [SDK Installation](#sdk-installation)
28108
* [Quick Start](#quick-start)
29109
* [SDK Example Usage](#sdk-example-usage)
30-
* [Authentication](#authentication)
110+
* [Authentication](#authentication-1)
31111
* [Available Resources and Operations](#available-resources-and-operations)
32112
* [Error Handling](#error-handling)
33113
* [Server Selection](#server-selection)
@@ -316,11 +396,14 @@ begin
316396
unless res.service.nil?
317397
# handle response
318398
end
319-
rescue Authlete::Models::Errors::ResultError => e
320-
# Handle Authlete-specific errors
399+
rescue Models::Errors::ResultError => e
400+
# handle e.container data
321401
raise e
322-
rescue Authlete::Models::Errors::APIError => e
323-
# Handle general API errors
402+
rescue Models::Errors::ResultError => e
403+
# handle e.container data
404+
raise e
405+
rescue Errors::APIError => e
406+
# handle default exception
324407
raise e
325408
end
326409

@@ -346,10 +429,11 @@ You can override the default server globally by passing a server index to the `s
346429
```ruby
347430
require 'authlete_ruby_test'
348431

349-
# Initialize the Authlete API client
350-
client = Authlete::Client.new(
351-
bearer: '<YOUR_BEARER_TOKEN_HERE>'
352-
)
432+
Models = ::Authlete::Models
433+
s = ::Authlete::Client.new(
434+
server_idx: 0,
435+
bearer: '<YOUR_BEARER_TOKEN_HERE>',
436+
)
353437

354438
res = s.services.retrieve(service_id: '<id>')
355439

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,14 @@ Based on:
2626
### Generated
2727
- [ruby v0.0.2-beta] .
2828
### Releases
29-
- [Ruby Gems v0.0.2-beta] https://rubygems.org/gems/authlete_ruby_test/versions/0.0.2-beta - .
29+
- [Ruby Gems v0.0.2-beta] https://rubygems.org/gems/authlete_ruby_test/versions/0.0.2-beta - .
30+
31+
## 2025-12-19 12:33:06
32+
### Changes
33+
Based on:
34+
- OpenAPI Doc
35+
- Speakeasy CLI 1.680.3 (2.788.5) https://github.com/speakeasy-api/speakeasy
36+
### Generated
37+
- [ruby v0.0.2-beta.1] .
38+
### Releases
39+
- [Ruby Gems v0.0.2-beta.1] https://rubygems.org/gems/authlete_ruby_test/versions/0.0.2-beta.1 - .

‎authlete_ruby_test.gemspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
44

55
Gem::Specification.new do |s|
66
s.name = 'authlete_ruby_test'
7-
s.version = '0.0.2-beta'
7+
s.version = '0.0.2-beta.1'
88
s.platform = Gem::Platform::RUBY
99
s.licenses = ['Apache-2.0']
1010
s.summary = ''

‎lib/authlete/sdkconfiguration.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ def initialize(client, hooks, retry_config, timeout_ms, bearer, security_source,
9292
end
9393
@language = 'ruby'
9494
@openapi_doc_version = '3.0.16'
95-
@sdk_version = '0.0.2-beta'
95+
@sdk_version = '0.0.2-beta.1'
9696
@gen_version = '2.788.5'
97-
@user_agent = 'speakeasy-sdk/ruby 0.0.2-beta 2.788.5 3.0.16 authlete_ruby_test'
97+
@user_agent = 'speakeasy-sdk/ruby 0.0.2-beta.1 2.788.5 3.0.16 authlete_ruby_test'
9898
end
9999

100100
sig { returns([String, T::Hash[Symbol, String]]) }

0 commit comments

Comments
 (0)