zyphr 0.1.0

data/docs/WithdrawSubscriberConsentRequest.md

@@ -0,0 +1,18 @@
+# Zyphr::WithdrawSubscriberConsentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WithdrawSubscriberConsentRequest.new(
+  reason: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/zyphr/api/auth_email_verification_api.rb

@@ -0,0 +1,218 @@
+=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 AuthEmailVerificationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Confirm email verification
+    # Verify the user's email using the token from the verification email.
+    # @param confirm_email_verification_request [ConfirmEmailVerificationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConfirmEmailVerificationResponse]
+    def confirm_email_verification(confirm_email_verification_request, opts = {})
+      data, _status_code, _headers = confirm_email_verification_with_http_info(confirm_email_verification_request, opts)
+      data
+    end
+
+    # Confirm email verification
+    # Verify the user's email using the token from the verification email.
+    # @param confirm_email_verification_request [ConfirmEmailVerificationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConfirmEmailVerificationResponse, Integer, Hash)>] ConfirmEmailVerificationResponse data, response status code and response headers
+    def confirm_email_verification_with_http_info(confirm_email_verification_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthEmailVerificationApi.confirm_email_verification ...'
+      end
+      # verify the required parameter 'confirm_email_verification_request' is set
+      if @api_client.config.client_side_validation && confirm_email_verification_request.nil?
+        fail ArgumentError, "Missing the required parameter 'confirm_email_verification_request' when calling AuthEmailVerificationApi.confirm_email_verification"
+      end
+      # resource path
+      local_var_path = '/auth/verify-email/confirm'
+
+      # 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(confirm_email_verification_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConfirmEmailVerificationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthEmailVerificationApi.confirm_email_verification",
+        :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: AuthEmailVerificationApi#confirm_email_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Resend email verification
+    # Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
+    # @param [Hash] opts the optional parameters
+    # @option opts [SendEmailVerificationRequest] :send_email_verification_request 
+    # @return [SuccessResult]
+    def resend_email_verification(opts = {})
+      data, _status_code, _headers = resend_email_verification_with_http_info(opts)
+      data
+    end
+
+    # Resend email verification
+    # Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
+    # @param [Hash] opts the optional parameters
+    # @option opts [SendEmailVerificationRequest] :send_email_verification_request 
+    # @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers
+    def resend_email_verification_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthEmailVerificationApi.resend_email_verification ...'
+      end
+      # resource path
+      local_var_path = '/auth/verify-email/resend'
+
+      # 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(opts[:'send_email_verification_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthEmailVerificationApi.resend_email_verification",
+        :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: AuthEmailVerificationApi#resend_email_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send email verification
+    # Send an email verification link to the authenticated user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [SendEmailVerificationRequest] :send_email_verification_request 
+    # @return [SuccessResult]
+    def send_email_verification(opts = {})
+      data, _status_code, _headers = send_email_verification_with_http_info(opts)
+      data
+    end
+
+    # Send email verification
+    # Send an email verification link to the authenticated user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [SendEmailVerificationRequest] :send_email_verification_request 
+    # @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers
+    def send_email_verification_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthEmailVerificationApi.send_email_verification ...'
+      end
+      # resource path
+      local_var_path = '/auth/verify-email/send'
+
+      # 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(opts[:'send_email_verification_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthEmailVerificationApi.send_email_verification",
+        :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: AuthEmailVerificationApi#send_email_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/zyphr/api/auth_login_api.rb

@@ -0,0 +1,90 @@
+=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 AuthLoginApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Login end user
+    # Login end user with email and password. Accepts optional custom_claims to embed in JWT (max 4KB). If MFA is enabled for the user, returns mfa_required: true with a challenge token. The user must then call POST /v1/auth/mfa/verify with the challenge token and TOTP code. 
+    # @param login_request [LoginRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AuthLoginResponse]
+    def login_end_user(login_request, opts = {})
+      data, _status_code, _headers = login_end_user_with_http_info(login_request, opts)
+      data
+    end
+
+    # Login end user
+    # Login end user with email and password. Accepts optional custom_claims to embed in JWT (max 4KB). If MFA is enabled for the user, returns mfa_required: true with a challenge token. The user must then call POST /v1/auth/mfa/verify with the challenge token and TOTP code. 
+    # @param login_request [LoginRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthLoginResponse, Integer, Hash)>] AuthLoginResponse data, response status code and response headers
+    def login_end_user_with_http_info(login_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthLoginApi.login_end_user ...'
+      end
+      # verify the required parameter 'login_request' is set
+      if @api_client.config.client_side_validation && login_request.nil?
+        fail ArgumentError, "Missing the required parameter 'login_request' when calling AuthLoginApi.login_end_user"
+      end
+      # resource path
+      local_var_path = '/auth/users/login'
+
+      # 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(login_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthLoginResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthLoginApi.login_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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthLoginApi#login_end_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/zyphr/api/auth_magic_links_api.rb

@@ -0,0 +1,158 @@
+=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 AuthMagicLinksApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Send a magic link
+    # Send a magic link email for passwordless authentication.
+    # @param magic_link_send_request [MagicLinkSendRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResult]
+    def send_magic_link(magic_link_send_request, opts = {})
+      data, _status_code, _headers = send_magic_link_with_http_info(magic_link_send_request, opts)
+      data
+    end
+
+    # Send a magic link
+    # Send a magic link email for passwordless authentication.
+    # @param magic_link_send_request [MagicLinkSendRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers
+    def send_magic_link_with_http_info(magic_link_send_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMagicLinksApi.send_magic_link ...'
+      end
+      # verify the required parameter 'magic_link_send_request' is set
+      if @api_client.config.client_side_validation && magic_link_send_request.nil?
+        fail ArgumentError, "Missing the required parameter 'magic_link_send_request' when calling AuthMagicLinksApi.send_magic_link"
+      end
+      # resource path
+      local_var_path = '/auth/magic-link/send'
+
+      # 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(magic_link_send_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 => :"AuthMagicLinksApi.send_magic_link",
+        :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: AuthMagicLinksApi#send_magic_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify a magic link
+    # Verify a magic link token and authenticate the user. Returns auth result with is_new_user flag.
+    # @param magic_link_verify_request [MagicLinkVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [MagicLinkVerifyResponse]
+    def verify_magic_link(magic_link_verify_request, opts = {})
+      data, _status_code, _headers = verify_magic_link_with_http_info(magic_link_verify_request, opts)
+      data
+    end
+
+    # Verify a magic link
+    # Verify a magic link token and authenticate the user. Returns auth result with is_new_user flag.
+    # @param magic_link_verify_request [MagicLinkVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MagicLinkVerifyResponse, Integer, Hash)>] MagicLinkVerifyResponse data, response status code and response headers
+    def verify_magic_link_with_http_info(magic_link_verify_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMagicLinksApi.verify_magic_link ...'
+      end
+      # verify the required parameter 'magic_link_verify_request' is set
+      if @api_client.config.client_side_validation && magic_link_verify_request.nil?
+        fail ArgumentError, "Missing the required parameter 'magic_link_verify_request' when calling AuthMagicLinksApi.verify_magic_link"
+      end
+      # resource path
+      local_var_path = '/auth/magic-link/verify'
+
+      # 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(magic_link_verify_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MagicLinkVerifyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthMagicLinksApi.verify_magic_link",
+        :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: AuthMagicLinksApi#verify_magic_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end