build: add config to rename codegen models (#161)

passageidentity · Jan 3, 2025 · 3aec47c · 3aec47c
1 parent 445279b
commit 3aec47c
Show file tree

Hide file tree

Showing 51 changed files with 58 additions and 1,495 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -2,9 +2,6 @@ AllCops:
   Exclude:
     - 'lib/openapi_client/**/*'
     - 'lib/openapi_client.rb'
-    - 'lib/models/update_magic_link_auth_method.rb'
-    - 'lib/models/update_otp_auth_method.rb'
-    - 'lib/models/update_passkeys_auth_method.rb'
     - 'docs/generated/*'
 
 Metrics/ClassLength:

diff --git a/docs/generated/AppleUserSocialConnection.md → docs/AppleUserSocialConnection.md b/docs/generated/AppleUserSocialConnection.md → docs/AppleUserSocialConnection.md
diff --git a/docs/generated/CreateMagicLinkRequest.md → docs/CreateMagicLinkRequest.md b/docs/generated/CreateMagicLinkRequest.md → docs/CreateMagicLinkRequest.md
diff --git a/docs/generated/CreateUserRequest.md → docs/CreateUserArgs.md b/docs/generated/CreateUserRequest.md → docs/CreateUserArgs.md
@@ -1,4 +1,4 @@
-# OpenapiClient::CreateUserRequest
+# OpenapiClient::CreateUserArgs
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CreateUserRequest.new(
+instance = OpenapiClient::CreateUserArgs.new(
   email: null,
   phone: null,
   user_metadata: null

diff --git a/docs/generated/GithubUserSocialConnection.md → docs/GithubUserSocialConnection.md b/docs/generated/GithubUserSocialConnection.md → docs/GithubUserSocialConnection.md
diff --git a/docs/generated/GoogleUserSocialConnection.md → docs/GoogleUserSocialConnection.md b/docs/generated/GoogleUserSocialConnection.md → docs/GoogleUserSocialConnection.md
diff --git a/docs/generated/Link.md → docs/Link.md b/docs/generated/Link.md → docs/Link.md
diff --git a/docs/generated/ListDevicesResponse.md → docs/ListDevicesResponse.md b/docs/generated/ListDevicesResponse.md → docs/ListDevicesResponse.md
diff --git a/docs/generated/ListPaginatedUsersItem.md → docs/ListPaginatedUsersItem.md b/docs/generated/ListPaginatedUsersItem.md → docs/ListPaginatedUsersItem.md
diff --git a/docs/generated/ListPaginatedUsersResponse.md → docs/ListPaginatedUsersResponse.md b/docs/generated/ListPaginatedUsersResponse.md → docs/ListPaginatedUsersResponse.md
diff --git a/docs/generated/MagicLink.md → docs/MagicLink.md b/docs/generated/MagicLink.md → docs/MagicLink.md
diff --git a/docs/generated/MagicLinkChannel.md → docs/MagicLinkChannel.md b/docs/generated/MagicLinkChannel.md → docs/MagicLinkChannel.md
diff --git a/docs/generated/MagicLinkResponse.md → docs/MagicLinkResponse.md b/docs/generated/MagicLinkResponse.md → docs/MagicLinkResponse.md
diff --git a/docs/generated/MagicLinkType.md → docs/MagicLinkType.md b/docs/generated/MagicLinkType.md → docs/MagicLinkType.md
diff --git a/docs/generated/MagicLinksApi.md → docs/MagicLinksApi.md b/docs/generated/MagicLinksApi.md → docs/MagicLinksApi.md
diff --git a/docs/generated/Model400Error.md → docs/Model400Error.md b/docs/generated/Model400Error.md → docs/Model400Error.md
diff --git a/docs/generated/Model401Error.md → docs/Model401Error.md b/docs/generated/Model401Error.md → docs/Model401Error.md
diff --git a/docs/generated/Model403Error.md → docs/Model403Error.md b/docs/generated/Model403Error.md → docs/Model403Error.md
diff --git a/docs/generated/Model404Error.md → docs/Model404Error.md b/docs/generated/Model404Error.md → docs/Model404Error.md
diff --git a/docs/generated/Model500Error.md → docs/Model500Error.md b/docs/generated/Model500Error.md → docs/Model500Error.md
diff --git a/docs/generated/Nonce.md → docs/Nonce.md b/docs/generated/Nonce.md → docs/Nonce.md
diff --git a/docs/generated/PaginatedLinks.md → docs/PaginatedLinks.md b/docs/generated/PaginatedLinks.md → docs/PaginatedLinks.md
diff --git a/docs/generated/UserInfo.md → docs/PassageUser.md b/docs/generated/UserInfo.md → docs/PassageUser.md
@@ -1,4 +1,4 @@
-# OpenapiClient::UserInfo
+# OpenapiClient::PassageUser
 
 ## Properties
 
@@ -27,7 +27,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::UserInfo.new(
+instance = OpenapiClient::PassageUser.new(
   created_at: null,
   email: null,
   email_verified: null,

diff --git a/docs/generated/README.md → docs/README.md b/docs/generated/README.md → docs/README.md
@@ -105,7 +105,7 @@ Class | Method | HTTP request | Description
 
  - [OpenapiClient::AppleUserSocialConnection](docs/AppleUserSocialConnection.md)
  - [OpenapiClient::CreateMagicLinkRequest](docs/CreateMagicLinkRequest.md)
- - [OpenapiClient::CreateUserRequest](docs/CreateUserRequest.md)
+ - [OpenapiClient::CreateUserArgs](docs/CreateUserArgs.md)
  - [OpenapiClient::GithubUserSocialConnection](docs/GithubUserSocialConnection.md)
  - [OpenapiClient::GoogleUserSocialConnection](docs/GoogleUserSocialConnection.md)
  - [OpenapiClient::Link](docs/Link.md)
@@ -123,11 +123,11 @@ Class | Method | HTTP request | Description
  - [OpenapiClient::Model500Error](docs/Model500Error.md)
  - [OpenapiClient::Nonce](docs/Nonce.md)
  - [OpenapiClient::PaginatedLinks](docs/PaginatedLinks.md)
+ - [OpenapiClient::PassageUser](docs/PassageUser.md)
  - [OpenapiClient::SocialConnectionType](docs/SocialConnectionType.md)
- - [OpenapiClient::UpdateUserRequest](docs/UpdateUserRequest.md)
+ - [OpenapiClient::UpdateUserArgs](docs/UpdateUserArgs.md)
  - [OpenapiClient::UserEventAction](docs/UserEventAction.md)
  - [OpenapiClient::UserEventStatus](docs/UserEventStatus.md)
- - [OpenapiClient::UserInfo](docs/UserInfo.md)
  - [OpenapiClient::UserRecentEvent](docs/UserRecentEvent.md)
  - [OpenapiClient::UserResponse](docs/UserResponse.md)
  - [OpenapiClient::UserSocialConnections](docs/UserSocialConnections.md)

diff --git a/docs/generated/SocialConnectionType.md → docs/SocialConnectionType.md b/docs/generated/SocialConnectionType.md → docs/SocialConnectionType.md
diff --git a/docs/generated/TokensApi.md → docs/TokensApi.md b/docs/generated/TokensApi.md → docs/TokensApi.md
diff --git a/docs/generated/UpdateUserRequest.md → docs/UpdateUserArgs.md b/docs/generated/UpdateUserRequest.md → docs/UpdateUserArgs.md
@@ -1,4 +1,4 @@
-# OpenapiClient::UpdateUserRequest
+# OpenapiClient::UpdateUserArgs
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::UpdateUserRequest.new(
+instance = OpenapiClient::UpdateUserArgs.new(
   email: null,
   phone: null,
   user_metadata: null

diff --git a/docs/generated/UserDevicesApi.md → docs/UserDevicesApi.md b/docs/generated/UserDevicesApi.md → docs/UserDevicesApi.md
diff --git a/docs/generated/UserEventAction.md → docs/UserEventAction.md b/docs/generated/UserEventAction.md → docs/UserEventAction.md
diff --git a/docs/generated/UserEventStatus.md → docs/UserEventStatus.md b/docs/generated/UserEventStatus.md → docs/UserEventStatus.md
diff --git a/docs/generated/UserRecentEvent.md → docs/UserRecentEvent.md b/docs/generated/UserRecentEvent.md → docs/UserRecentEvent.md
diff --git a/docs/generated/UserResponse.md → docs/UserResponse.md b/docs/generated/UserResponse.md → docs/UserResponse.md
@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user** | [**UserInfo**](UserInfo.md) |  |  |
+| **user** | [**PassageUser**](PassageUser.md) |  |  |
 
 ## Example
 

diff --git a/docs/generated/UserSocialConnections.md → docs/UserSocialConnections.md b/docs/generated/UserSocialConnections.md → docs/UserSocialConnections.md
diff --git a/docs/generated/UserStatus.md → docs/UserStatus.md b/docs/generated/UserStatus.md → docs/UserStatus.md
diff --git a/docs/generated/UsersApi.md → docs/UsersApi.md b/docs/generated/UsersApi.md → docs/UsersApi.md
@@ -86,7 +86,7 @@ end
 
 ## create_user
 
-> <UserResponse> create_user(app_id, create_user_request)
+> <UserResponse> create_user(app_id, create_user_args)
 
 Create User
 
@@ -105,11 +105,11 @@ end
 
 api_instance = OpenapiClient::UsersApi.new
 app_id = 'app_id_example' # String | App ID
-create_user_request = OpenapiClient::CreateUserRequest.new # CreateUserRequest | email, phone, user_metadata
+create_user_args = OpenapiClient::CreateUserArgs.new # CreateUserArgs | email, phone, user_metadata
 
 begin
   # Create User
-  result = api_instance.create_user(app_id, create_user_request)
+  result = api_instance.create_user(app_id, create_user_args)
   p result
 rescue OpenapiClient::ApiError => e
   puts "Error when calling UsersApi->create_user: #{e}"
@@ -120,12 +120,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UserResponse>, Integer, Hash)> create_user_with_http_info(app_id, create_user_request)
+> <Array(<UserResponse>, Integer, Hash)> create_user_with_http_info(app_id, create_user_args)
 
 ```ruby
 begin
   # Create User
-  data, status_code, headers = api_instance.create_user_with_http_info(app_id, create_user_request)
+  data, status_code, headers = api_instance.create_user_with_http_info(app_id, create_user_args)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <UserResponse>
@@ -139,7 +139,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **app_id** | **String** | App ID |  |
-| **create_user_request** | [**CreateUserRequest**](CreateUserRequest.md) | email, phone, user_metadata |  |
+| **create_user_args** | [**CreateUserArgs**](CreateUserArgs.md) | email, phone, user_metadata |  |
 
 ### Return type
 
@@ -462,7 +462,7 @@ end
 
 ## update_user
 
-> <UserResponse> update_user(app_id, user_id, update_user_request)
+> <UserResponse> update_user(app_id, user_id, update_user_args)
 
 Update User
 
@@ -482,11 +482,11 @@ end
 api_instance = OpenapiClient::UsersApi.new
 app_id = 'app_id_example' # String | App ID
 user_id = 'user_id_example' # String | User ID
-update_user_request = OpenapiClient::UpdateUserRequest.new # UpdateUserRequest | user settings
+update_user_args = OpenapiClient::UpdateUserArgs.new # UpdateUserArgs | user settings
 
 begin
   # Update User
-  result = api_instance.update_user(app_id, user_id, update_user_request)
+  result = api_instance.update_user(app_id, user_id, update_user_args)
   p result
 rescue OpenapiClient::ApiError => e
   puts "Error when calling UsersApi->update_user: #{e}"
@@ -497,12 +497,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UserResponse>, Integer, Hash)> update_user_with_http_info(app_id, user_id, update_user_request)
+> <Array(<UserResponse>, Integer, Hash)> update_user_with_http_info(app_id, user_id, update_user_args)
 
 ```ruby
 begin
   # Update User
-  data, status_code, headers = api_instance.update_user_with_http_info(app_id, user_id, update_user_request)
+  data, status_code, headers = api_instance.update_user_with_http_info(app_id, user_id, update_user_args)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <UserResponse>
@@ -517,7 +517,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **app_id** | **String** | App ID |  |
 | **user_id** | **String** | User ID |  |
-| **update_user_request** | [**UpdateUserRequest**](UpdateUserRequest.md) | user settings |  |
+| **update_user_args** | [**UpdateUserArgs**](UpdateUserArgs.md) | user settings |  |
 
 ### Return type
 

diff --git a/docs/generated/WebAuthnDevices.md → docs/WebAuthnDevices.md b/docs/generated/WebAuthnDevices.md → docs/WebAuthnDevices.md
diff --git a/docs/generated/WebAuthnIcons.md → docs/WebAuthnIcons.md b/docs/generated/WebAuthnIcons.md → docs/WebAuthnIcons.md
diff --git a/docs/generated/WebAuthnType.md → docs/WebAuthnType.md b/docs/generated/WebAuthnType.md → docs/WebAuthnType.md
diff --git a/docs/custom/AuthApi.md b/docs/custom/AuthApi.md