zyphr 0.1.0

data/docs/AuthOAuthApi.md

@@ -0,0 +1,597 @@
+# Zyphr::AuthOAuthApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**disconnect_o_auth_provider**](AuthOAuthApi.md#disconnect_o_auth_provider) | **DELETE** /auth/oauth/{provider} | Disconnect OAuth provider |
+| [**get_o_auth_authorization_url**](AuthOAuthApi.md#get_o_auth_authorization_url) | **GET** /auth/oauth/{provider}/authorize | Get OAuth authorization URL |
+| [**get_o_auth_connection_info**](AuthOAuthApi.md#get_o_auth_connection_info) | **GET** /auth/oauth/connections/{provider} | Get OAuth connection info |
+| [**get_o_auth_tokens**](AuthOAuthApi.md#get_o_auth_tokens) | **GET** /auth/oauth/tokens/{provider} | Get OAuth provider tokens |
+| [**handle_o_auth_callback**](AuthOAuthApi.md#handle_o_auth_callback) | **POST** /auth/oauth/{provider}/callback | Handle OAuth callback |
+| [**list_o_auth_connections**](AuthOAuthApi.md#list_o_auth_connections) | **GET** /auth/oauth/connections | List OAuth connections |
+| [**list_o_auth_providers**](AuthOAuthApi.md#list_o_auth_providers) | **GET** /auth/oauth/providers | List OAuth providers |
+| [**refresh_o_auth_tokens**](AuthOAuthApi.md#refresh_o_auth_tokens) | **POST** /auth/oauth/tokens/{provider}/refresh | Refresh OAuth provider tokens |
+
+
+## disconnect_o_auth_provider
+
+> <SuccessResult> disconnect_o_auth_provider(provider)
+
+Disconnect OAuth provider
+
+Disconnect an OAuth provider from the current user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure Bearer authorization (JWT): EndUserToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthOAuthApi.new
+provider = 'provider_example' # String | OAuth provider name
+
+begin
+  # Disconnect OAuth provider
+  result = api_instance.disconnect_o_auth_provider(provider)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->disconnect_o_auth_provider: #{e}"
+end
+```
+
+#### Using the disconnect_o_auth_provider_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResult>, Integer, Hash)> disconnect_o_auth_provider_with_http_info(provider)
+
+```ruby
+begin
+  # Disconnect OAuth provider
+  data, status_code, headers = api_instance.disconnect_o_auth_provider_with_http_info(provider)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResult>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->disconnect_o_auth_provider_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | OAuth provider name |  |
+
+### Return type
+
+[**SuccessResult**](SuccessResult.md)
+
+### Authorization
+
+[EndUserToken](../README.md#EndUserToken), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_o_auth_authorization_url
+
+> <OAuthAuthorizationUrlResponse> get_o_auth_authorization_url(provider, redirect_uri)
+
+Get OAuth authorization URL
+
+Generate an OAuth authorization URL for the specified provider.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthOAuthApi.new
+provider = 'provider_example' # String | OAuth provider name
+redirect_uri = 'redirect_uri_example' # String | Redirect URI after authorization
+
+begin
+  # Get OAuth authorization URL
+  result = api_instance.get_o_auth_authorization_url(provider, redirect_uri)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->get_o_auth_authorization_url: #{e}"
+end
+```
+
+#### Using the get_o_auth_authorization_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthAuthorizationUrlResponse>, Integer, Hash)> get_o_auth_authorization_url_with_http_info(provider, redirect_uri)
+
+```ruby
+begin
+  # Get OAuth authorization URL
+  data, status_code, headers = api_instance.get_o_auth_authorization_url_with_http_info(provider, redirect_uri)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthAuthorizationUrlResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->get_o_auth_authorization_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | OAuth provider name |  |
+| **redirect_uri** | **String** | Redirect URI after authorization |  |
+
+### Return type
+
+[**OAuthAuthorizationUrlResponse**](OAuthAuthorizationUrlResponse.md)
+
+### Authorization
+
+[ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_o_auth_connection_info
+
+> <OAuthConnectionInfoResponse> get_o_auth_connection_info(provider)
+
+Get OAuth connection info
+
+Get OAuth connection info for a specific provider (without tokens). Safe for public key authentication.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure Bearer authorization (JWT): EndUserToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthOAuthApi.new
+provider = 'provider_example' # String | OAuth provider name
+
+begin
+  # Get OAuth connection info
+  result = api_instance.get_o_auth_connection_info(provider)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->get_o_auth_connection_info: #{e}"
+end
+```
+
+#### Using the get_o_auth_connection_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthConnectionInfoResponse>, Integer, Hash)> get_o_auth_connection_info_with_http_info(provider)
+
+```ruby
+begin
+  # Get OAuth connection info
+  data, status_code, headers = api_instance.get_o_auth_connection_info_with_http_info(provider)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthConnectionInfoResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->get_o_auth_connection_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | OAuth provider name |  |
+
+### Return type
+
+[**OAuthConnectionInfoResponse**](OAuthConnectionInfoResponse.md)
+
+### Authorization
+
+[EndUserToken](../README.md#EndUserToken), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_o_auth_tokens
+
+> <OAuthTokensResponse> get_o_auth_tokens(provider, user_id)
+
+Get OAuth provider tokens
+
+Get OAuth provider tokens for an end user. Requires secret key authentication (server-side only). This allows developers to access downstream APIs on behalf of their users. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthOAuthApi.new
+provider = 'provider_example' # String | OAuth provider name
+user_id = 'user_id_example' # String | End user ID
+
+begin
+  # Get OAuth provider tokens
+  result = api_instance.get_o_auth_tokens(provider, user_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->get_o_auth_tokens: #{e}"
+end
+```
+
+#### Using the get_o_auth_tokens_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthTokensResponse>, Integer, Hash)> get_o_auth_tokens_with_http_info(provider, user_id)
+
+```ruby
+begin
+  # Get OAuth provider tokens
+  data, status_code, headers = api_instance.get_o_auth_tokens_with_http_info(provider, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthTokensResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->get_o_auth_tokens_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | OAuth provider name |  |
+| **user_id** | **String** | End user ID |  |
+
+### Return type
+
+[**OAuthTokensResponse**](OAuthTokensResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## handle_o_auth_callback
+
+> <OAuthCallbackResponse> handle_o_auth_callback(provider, o_auth_callback_request)
+
+Handle OAuth callback
+
+Handle the OAuth callback by exchanging the authorization code for tokens and authenticating the user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+
+api_instance = Zyphr::AuthOAuthApi.new
+provider = 'provider_example' # String | OAuth provider name
+o_auth_callback_request = Zyphr::OAuthCallbackRequest.new({code: 'code_example', state: 'state_example'}) # OAuthCallbackRequest | 
+
+begin
+  # Handle OAuth callback
+  result = api_instance.handle_o_auth_callback(provider, o_auth_callback_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->handle_o_auth_callback: #{e}"
+end
+```
+
+#### Using the handle_o_auth_callback_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthCallbackResponse>, Integer, Hash)> handle_o_auth_callback_with_http_info(provider, o_auth_callback_request)
+
+```ruby
+begin
+  # Handle OAuth callback
+  data, status_code, headers = api_instance.handle_o_auth_callback_with_http_info(provider, o_auth_callback_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthCallbackResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->handle_o_auth_callback_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | OAuth provider name |  |
+| **o_auth_callback_request** | [**OAuthCallbackRequest**](OAuthCallbackRequest.md) |  |  |
+
+### Return type
+
+[**OAuthCallbackResponse**](OAuthCallbackResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_o_auth_connections
+
+> <OAuthConnectionsResponse> list_o_auth_connections
+
+List OAuth connections
+
+Get OAuth connections for the current user with metadata.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure Bearer authorization (JWT): EndUserToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthOAuthApi.new
+
+begin
+  # List OAuth connections
+  result = api_instance.list_o_auth_connections
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->list_o_auth_connections: #{e}"
+end
+```
+
+#### Using the list_o_auth_connections_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthConnectionsResponse>, Integer, Hash)> list_o_auth_connections_with_http_info
+
+```ruby
+begin
+  # List OAuth connections
+  data, status_code, headers = api_instance.list_o_auth_connections_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthConnectionsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->list_o_auth_connections_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**OAuthConnectionsResponse**](OAuthConnectionsResponse.md)
+
+### Authorization
+
+[EndUserToken](../README.md#EndUserToken), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_o_auth_providers
+
+> <OAuthProvidersResponse> list_o_auth_providers
+
+List OAuth providers
+
+Get list of enabled OAuth providers for the application.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthOAuthApi.new
+
+begin
+  # List OAuth providers
+  result = api_instance.list_o_auth_providers
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->list_o_auth_providers: #{e}"
+end
+```
+
+#### Using the list_o_auth_providers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthProvidersResponse>, Integer, Hash)> list_o_auth_providers_with_http_info
+
+```ruby
+begin
+  # List OAuth providers
+  data, status_code, headers = api_instance.list_o_auth_providers_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthProvidersResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->list_o_auth_providers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**OAuthProvidersResponse**](OAuthProvidersResponse.md)
+
+### Authorization
+
+[ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## refresh_o_auth_tokens
+
+> <OAuthTokensRefreshResponse> refresh_o_auth_tokens(provider, refresh_o_auth_tokens_request)
+
+Refresh OAuth provider tokens
+
+Refresh OAuth provider tokens for an end user. Requires secret key authentication (server-side only). Only supported for providers that support token refresh (e.g., Google, Microsoft). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthOAuthApi.new
+provider = 'provider_example' # String | OAuth provider name
+refresh_o_auth_tokens_request = Zyphr::RefreshOAuthTokensRequest.new({user_id: 'user_id_example'}) # RefreshOAuthTokensRequest | 
+
+begin
+  # Refresh OAuth provider tokens
+  result = api_instance.refresh_o_auth_tokens(provider, refresh_o_auth_tokens_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->refresh_o_auth_tokens: #{e}"
+end
+```
+
+#### Using the refresh_o_auth_tokens_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthTokensRefreshResponse>, Integer, Hash)> refresh_o_auth_tokens_with_http_info(provider, refresh_o_auth_tokens_request)
+
+```ruby
+begin
+  # Refresh OAuth provider tokens
+  data, status_code, headers = api_instance.refresh_o_auth_tokens_with_http_info(provider, refresh_o_auth_tokens_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthTokensRefreshResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthOAuthApi->refresh_o_auth_tokens_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | OAuth provider name |  |
+| **refresh_o_auth_tokens_request** | [**RefreshOAuthTokensRequest**](RefreshOAuthTokensRequest.md) |  |  |
+
+### Return type
+
+[**OAuthTokensRefreshResponse**](OAuthTokensRefreshResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+