zyphr 0.1.0

data/lib/zyphr/api/auth_o_auth_api.rb

@@ -0,0 +1,550 @@
+=begin
+#Zyphr API
+
+#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zyphr.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'cgi'
+
+module Zyphr
+  class AuthOAuthApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Disconnect OAuth provider
+    # Disconnect an OAuth provider from the current user.
+    # @param provider [String] OAuth provider name
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResult]
+    def disconnect_o_auth_provider(provider, opts = {})
+      data, _status_code, _headers = disconnect_o_auth_provider_with_http_info(provider, opts)
+      data
+    end
+
+    # Disconnect OAuth provider
+    # Disconnect an OAuth provider from the current user.
+    # @param provider [String] OAuth provider name
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers
+    def disconnect_o_auth_provider_with_http_info(provider, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthOAuthApi.disconnect_o_auth_provider ...'
+      end
+      # verify the required parameter 'provider' is set
+      if @api_client.config.client_side_validation && provider.nil?
+        fail ArgumentError, "Missing the required parameter 'provider' when calling AuthOAuthApi.disconnect_o_auth_provider"
+      end
+      # resource path
+      local_var_path = '/auth/oauth/{provider}'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthOAuthApi.disconnect_o_auth_provider",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthOAuthApi#disconnect_o_auth_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get OAuth authorization URL
+    # Generate an OAuth authorization URL for the specified provider.
+    # @param provider [String] OAuth provider name
+    # @param redirect_uri [String] Redirect URI after authorization
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthAuthorizationUrlResponse]
+    def get_o_auth_authorization_url(provider, redirect_uri, opts = {})
+      data, _status_code, _headers = get_o_auth_authorization_url_with_http_info(provider, redirect_uri, opts)
+      data
+    end
+
+    # Get OAuth authorization URL
+    # Generate an OAuth authorization URL for the specified provider.
+    # @param provider [String] OAuth provider name
+    # @param redirect_uri [String] Redirect URI after authorization
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthAuthorizationUrlResponse, Integer, Hash)>] OAuthAuthorizationUrlResponse data, response status code and response headers
+    def get_o_auth_authorization_url_with_http_info(provider, redirect_uri, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthOAuthApi.get_o_auth_authorization_url ...'
+      end
+      # verify the required parameter 'provider' is set
+      if @api_client.config.client_side_validation && provider.nil?
+        fail ArgumentError, "Missing the required parameter 'provider' when calling AuthOAuthApi.get_o_auth_authorization_url"
+      end
+      # verify the required parameter 'redirect_uri' is set
+      if @api_client.config.client_side_validation && redirect_uri.nil?
+        fail ArgumentError, "Missing the required parameter 'redirect_uri' when calling AuthOAuthApi.get_o_auth_authorization_url"
+      end
+      # resource path
+      local_var_path = '/auth/oauth/{provider}/authorize'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'redirect_uri'] = redirect_uri
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthAuthorizationUrlResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthOAuthApi.get_o_auth_authorization_url",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthOAuthApi#get_o_auth_authorization_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get OAuth connection info
+    # Get OAuth connection info for a specific provider (without tokens). Safe for public key authentication.
+    # @param provider [String] OAuth provider name
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthConnectionInfoResponse]
+    def get_o_auth_connection_info(provider, opts = {})
+      data, _status_code, _headers = get_o_auth_connection_info_with_http_info(provider, opts)
+      data
+    end
+
+    # Get OAuth connection info
+    # Get OAuth connection info for a specific provider (without tokens). Safe for public key authentication.
+    # @param provider [String] OAuth provider name
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthConnectionInfoResponse, Integer, Hash)>] OAuthConnectionInfoResponse data, response status code and response headers
+    def get_o_auth_connection_info_with_http_info(provider, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthOAuthApi.get_o_auth_connection_info ...'
+      end
+      # verify the required parameter 'provider' is set
+      if @api_client.config.client_side_validation && provider.nil?
+        fail ArgumentError, "Missing the required parameter 'provider' when calling AuthOAuthApi.get_o_auth_connection_info"
+      end
+      # resource path
+      local_var_path = '/auth/oauth/connections/{provider}'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthConnectionInfoResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthOAuthApi.get_o_auth_connection_info",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthOAuthApi#get_o_auth_connection_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. 
+    # @param provider [String] OAuth provider name
+    # @param user_id [String] End user ID
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthTokensResponse]
+    def get_o_auth_tokens(provider, user_id, opts = {})
+      data, _status_code, _headers = get_o_auth_tokens_with_http_info(provider, user_id, opts)
+      data
+    end
+
+    # 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. 
+    # @param provider [String] OAuth provider name
+    # @param user_id [String] End user ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthTokensResponse, Integer, Hash)>] OAuthTokensResponse data, response status code and response headers
+    def get_o_auth_tokens_with_http_info(provider, user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthOAuthApi.get_o_auth_tokens ...'
+      end
+      # verify the required parameter 'provider' is set
+      if @api_client.config.client_side_validation && provider.nil?
+        fail ArgumentError, "Missing the required parameter 'provider' when calling AuthOAuthApi.get_o_auth_tokens"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthOAuthApi.get_o_auth_tokens"
+      end
+      # resource path
+      local_var_path = '/auth/oauth/tokens/{provider}'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'user_id'] = user_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthTokensResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthOAuthApi.get_o_auth_tokens",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthOAuthApi#get_o_auth_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Handle OAuth callback
+    # Handle the OAuth callback by exchanging the authorization code for tokens and authenticating the user.
+    # @param provider [String] OAuth provider name
+    # @param o_auth_callback_request [OAuthCallbackRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthCallbackResponse]
+    def handle_o_auth_callback(provider, o_auth_callback_request, opts = {})
+      data, _status_code, _headers = handle_o_auth_callback_with_http_info(provider, o_auth_callback_request, opts)
+      data
+    end
+
+    # Handle OAuth callback
+    # Handle the OAuth callback by exchanging the authorization code for tokens and authenticating the user.
+    # @param provider [String] OAuth provider name
+    # @param o_auth_callback_request [OAuthCallbackRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthCallbackResponse, Integer, Hash)>] OAuthCallbackResponse data, response status code and response headers
+    def handle_o_auth_callback_with_http_info(provider, o_auth_callback_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthOAuthApi.handle_o_auth_callback ...'
+      end
+      # verify the required parameter 'provider' is set
+      if @api_client.config.client_side_validation && provider.nil?
+        fail ArgumentError, "Missing the required parameter 'provider' when calling AuthOAuthApi.handle_o_auth_callback"
+      end
+      # verify the required parameter 'o_auth_callback_request' is set
+      if @api_client.config.client_side_validation && o_auth_callback_request.nil?
+        fail ArgumentError, "Missing the required parameter 'o_auth_callback_request' when calling AuthOAuthApi.handle_o_auth_callback"
+      end
+      # resource path
+      local_var_path = '/auth/oauth/{provider}/callback'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_callback_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthCallbackResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AuthOAuthApi.handle_o_auth_callback",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthOAuthApi#handle_o_auth_callback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List OAuth connections
+    # Get OAuth connections for the current user with metadata.
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthConnectionsResponse]
+    def list_o_auth_connections(opts = {})
+      data, _status_code, _headers = list_o_auth_connections_with_http_info(opts)
+      data
+    end
+
+    # List OAuth connections
+    # Get OAuth connections for the current user with metadata.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthConnectionsResponse, Integer, Hash)>] OAuthConnectionsResponse data, response status code and response headers
+    def list_o_auth_connections_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthOAuthApi.list_o_auth_connections ...'
+      end
+      # resource path
+      local_var_path = '/auth/oauth/connections'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthConnectionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthOAuthApi.list_o_auth_connections",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthOAuthApi#list_o_auth_connections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List OAuth providers
+    # Get list of enabled OAuth providers for the application.
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthProvidersResponse]
+    def list_o_auth_providers(opts = {})
+      data, _status_code, _headers = list_o_auth_providers_with_http_info(opts)
+      data
+    end
+
+    # List OAuth providers
+    # Get list of enabled OAuth providers for the application.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthProvidersResponse, Integer, Hash)>] OAuthProvidersResponse data, response status code and response headers
+    def list_o_auth_providers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthOAuthApi.list_o_auth_providers ...'
+      end
+      # resource path
+      local_var_path = '/auth/oauth/providers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthProvidersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthOAuthApi.list_o_auth_providers",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthOAuthApi#list_o_auth_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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). 
+    # @param provider [String] OAuth provider name
+    # @param refresh_o_auth_tokens_request [RefreshOAuthTokensRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthTokensRefreshResponse]
+    def refresh_o_auth_tokens(provider, refresh_o_auth_tokens_request, opts = {})
+      data, _status_code, _headers = refresh_o_auth_tokens_with_http_info(provider, refresh_o_auth_tokens_request, opts)
+      data
+    end
+
+    # 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). 
+    # @param provider [String] OAuth provider name
+    # @param refresh_o_auth_tokens_request [RefreshOAuthTokensRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthTokensRefreshResponse, Integer, Hash)>] OAuthTokensRefreshResponse data, response status code and response headers
+    def refresh_o_auth_tokens_with_http_info(provider, refresh_o_auth_tokens_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthOAuthApi.refresh_o_auth_tokens ...'
+      end
+      # verify the required parameter 'provider' is set
+      if @api_client.config.client_side_validation && provider.nil?
+        fail ArgumentError, "Missing the required parameter 'provider' when calling AuthOAuthApi.refresh_o_auth_tokens"
+      end
+      # verify the required parameter 'refresh_o_auth_tokens_request' is set
+      if @api_client.config.client_side_validation && refresh_o_auth_tokens_request.nil?
+        fail ArgumentError, "Missing the required parameter 'refresh_o_auth_tokens_request' when calling AuthOAuthApi.refresh_o_auth_tokens"
+      end
+      # resource path
+      local_var_path = '/auth/oauth/tokens/{provider}/refresh'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(refresh_o_auth_tokens_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthTokensRefreshResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthOAuthApi.refresh_o_auth_tokens",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthOAuthApi#refresh_o_auth_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end