zyphr 0.1.0

data/lib/zyphr/api/auth_sessions_api.rb

@@ -0,0 +1,272 @@
+=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 AuthSessionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List active sessions
+    # Get all active sessions for the currently authenticated end user.
+    # @param [Hash] opts the optional parameters
+    # @return [SessionListResponse]
+    def list_end_user_sessions(opts = {})
+      data, _status_code, _headers = list_end_user_sessions_with_http_info(opts)
+      data
+    end
+
+    # List active sessions
+    # Get all active sessions for the currently authenticated end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SessionListResponse, Integer, Hash)>] SessionListResponse data, response status code and response headers
+    def list_end_user_sessions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthSessionsApi.list_end_user_sessions ...'
+      end
+      # resource path
+      local_var_path = '/auth/sessions'
+
+      # 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] || 'SessionListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthSessionsApi.list_end_user_sessions",
+        :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: AuthSessionsApi#list_end_user_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Refresh access token
+    # Refresh access token using a refresh token. Accepts optional custom_claims to update JWT claims (if not provided, preserves existing claims).
+    # @param refresh_session_request [RefreshSessionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [RefreshTokenResponse]
+    def refresh_end_user_token(refresh_session_request, opts = {})
+      data, _status_code, _headers = refresh_end_user_token_with_http_info(refresh_session_request, opts)
+      data
+    end
+
+    # Refresh access token
+    # Refresh access token using a refresh token. Accepts optional custom_claims to update JWT claims (if not provided, preserves existing claims).
+    # @param refresh_session_request [RefreshSessionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RefreshTokenResponse, Integer, Hash)>] RefreshTokenResponse data, response status code and response headers
+    def refresh_end_user_token_with_http_info(refresh_session_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthSessionsApi.refresh_end_user_token ...'
+      end
+      # verify the required parameter 'refresh_session_request' is set
+      if @api_client.config.client_side_validation && refresh_session_request.nil?
+        fail ArgumentError, "Missing the required parameter 'refresh_session_request' when calling AuthSessionsApi.refresh_end_user_token"
+      end
+      # resource path
+      local_var_path = '/auth/sessions/refresh'
+
+      # 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_session_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RefreshTokenResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthSessionsApi.refresh_end_user_token",
+        :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: AuthSessionsApi#refresh_end_user_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke all sessions
+    # Revoke all sessions for the authenticated end user.
+    # @param [Hash] opts the optional parameters
+    # @return [RevokeAllSessionsResponse]
+    def revoke_all_end_user_sessions(opts = {})
+      data, _status_code, _headers = revoke_all_end_user_sessions_with_http_info(opts)
+      data
+    end
+
+    # Revoke all sessions
+    # Revoke all sessions for the authenticated end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RevokeAllSessionsResponse, Integer, Hash)>] RevokeAllSessionsResponse data, response status code and response headers
+    def revoke_all_end_user_sessions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthSessionsApi.revoke_all_end_user_sessions ...'
+      end
+      # resource path
+      local_var_path = '/auth/sessions/revoke-all'
+
+      # 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] || 'RevokeAllSessionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthSessionsApi.revoke_all_end_user_sessions",
+        :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: AuthSessionsApi#revoke_all_end_user_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke a session
+    # Revoke a session (logout) using a refresh token.
+    # @param revoke_session_request [RevokeSessionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResult]
+    def revoke_end_user_session(revoke_session_request, opts = {})
+      data, _status_code, _headers = revoke_end_user_session_with_http_info(revoke_session_request, opts)
+      data
+    end
+
+    # Revoke a session
+    # Revoke a session (logout) using a refresh token.
+    # @param revoke_session_request [RevokeSessionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers
+    def revoke_end_user_session_with_http_info(revoke_session_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthSessionsApi.revoke_end_user_session ...'
+      end
+      # verify the required parameter 'revoke_session_request' is set
+      if @api_client.config.client_side_validation && revoke_session_request.nil?
+        fail ArgumentError, "Missing the required parameter 'revoke_session_request' when calling AuthSessionsApi.revoke_end_user_session"
+      end
+      # resource path
+      local_var_path = '/auth/sessions/revoke'
+
+      # 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(revoke_session_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthSessionsApi.revoke_end_user_session",
+        :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: AuthSessionsApi#revoke_end_user_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/zyphr/api/auth_user_profile_api.rb

@@ -0,0 +1,204 @@
+=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 AuthUserProfileApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete current end user account
+    # Delete the current end user account (GDPR right to erasure). This is a soft delete — the account is marked as deleted but data is retained for a period to allow for recovery or legal requirements. 
+    # @param [Hash] opts the optional parameters
+    # @return [EndUserDeleteResponse]
+    def delete_end_user(opts = {})
+      data, _status_code, _headers = delete_end_user_with_http_info(opts)
+      data
+    end
+
+    # Delete current end user account
+    # Delete the current end user account (GDPR right to erasure). This is a soft delete — the account is marked as deleted but data is retained for a period to allow for recovery or legal requirements. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EndUserDeleteResponse, Integer, Hash)>] EndUserDeleteResponse data, response status code and response headers
+    def delete_end_user_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthUserProfileApi.delete_end_user ...'
+      end
+      # resource path
+      local_var_path = '/auth/users/me'
+
+      # 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] || 'EndUserDeleteResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthUserProfileApi.delete_end_user",
+        :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: AuthUserProfileApi#delete_end_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get current end user profile
+    # Retrieve the profile of the currently authenticated end user.
+    # @param [Hash] opts the optional parameters
+    # @return [AuthUserResponse]
+    def get_end_user(opts = {})
+      data, _status_code, _headers = get_end_user_with_http_info(opts)
+      data
+    end
+
+    # Get current end user profile
+    # Retrieve the profile of the currently authenticated end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthUserResponse, Integer, Hash)>] AuthUserResponse data, response status code and response headers
+    def get_end_user_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthUserProfileApi.get_end_user ...'
+      end
+      # resource path
+      local_var_path = '/auth/users/me'
+
+      # 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] || 'AuthUserResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthUserProfileApi.get_end_user",
+        :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: AuthUserProfileApi#get_end_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update current end user profile
+    # Update the profile of the currently authenticated end user.
+    # @param update_end_user_request [UpdateEndUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AuthUserResponse]
+    def update_end_user(update_end_user_request, opts = {})
+      data, _status_code, _headers = update_end_user_with_http_info(update_end_user_request, opts)
+      data
+    end
+
+    # Update current end user profile
+    # Update the profile of the currently authenticated end user.
+    # @param update_end_user_request [UpdateEndUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthUserResponse, Integer, Hash)>] AuthUserResponse data, response status code and response headers
+    def update_end_user_with_http_info(update_end_user_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthUserProfileApi.update_end_user ...'
+      end
+      # verify the required parameter 'update_end_user_request' is set
+      if @api_client.config.client_side_validation && update_end_user_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_end_user_request' when calling AuthUserProfileApi.update_end_user"
+      end
+      # resource path
+      local_var_path = '/auth/users/me'
+
+      # 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(update_end_user_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthUserResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthUserProfileApi.update_end_user",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthUserProfileApi#update_end_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end