zyphr 0.1.43 → 0.1.45

data/docs/WebhookTestEventResponseData.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **delivery_id** | **String** |  | [optional] |
-| **event_type** | **String** |  | [optional] |
+| **event_type** | [**WebhookEventType**](WebhookEventType.md) |  | [optional] |
 | **payload** | **Object** |  | [optional] |
 | **status** | **String** |  | [optional] |
 

data/lib/zyphr/api/auth_application_api.rb

@@ -0,0 +1,147 @@
+=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  ## Account Sending Status  Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## 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 AuthApplicationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get the authenticating application
+    # Return non-sensitive metadata about the application whose credentials authenticated this request. Lets an integrator read their own application_id (the sole tenant discriminator embedded in every end-user token) directly from the API, rather than only from the dashboard UI or by decoding a token. Returns only id, name, the calling environment's mode, and the JWT signing algorithm — never secrets, signing keys, or account-internal fields. 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicationSelfResponse]
+    def get_self_application(opts = {})
+      data, _status_code, _headers = get_self_application_with_http_info(opts)
+      data
+    end
+
+    # Get the authenticating application
+    # Return non-sensitive metadata about the application whose credentials authenticated this request. Lets an integrator read their own application_id (the sole tenant discriminator embedded in every end-user token) directly from the API, rather than only from the dashboard UI or by decoding a token. Returns only id, name, the calling environment's mode, and the JWT signing algorithm — never secrets, signing keys, or account-internal fields. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicationSelfResponse, Integer, Hash)>] ApplicationSelfResponse data, response status code and response headers
+    def get_self_application_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApplicationApi.get_self_application ...'
+      end
+      # resource path
+      local_var_path = '/auth/application'
+
+      # 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] || 'ApplicationSelfResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthApplicationApi.get_self_application",
+        :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: AuthApplicationApi#get_self_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Set the authenticating application's auth-email test allowlist
+    # Set `test_recipients` — the per-application auth-email allowlist — on the application whose credentials authenticated this request. When non-empty, this allowlist gates ALL auth emails (only listed addresses receive them); an EMPTY array clears it and disables the gate. Lets an integrator manage the allowlist from their own infrastructure config instead of the dashboard.  Application-SECRET scoped (server-side write): requires X-Application-Key AND X-Application-Secret. Mutates ONLY the authenticating application — it never takes an application id from the request, so there is no cross-tenant write path. The response mirrors GET /auth/application exactly (never returns secrets). 
+    # @param set_self_application_test_recipients_request [SetSelfApplicationTestRecipientsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ApplicationSelfResponse]
+    def set_self_application_test_recipients(set_self_application_test_recipients_request, opts = {})
+      data, _status_code, _headers = set_self_application_test_recipients_with_http_info(set_self_application_test_recipients_request, opts)
+      data
+    end
+
+    # Set the authenticating application&#39;s auth-email test allowlist
+    # Set &#x60;test_recipients&#x60; — the per-application auth-email allowlist — on the application whose credentials authenticated this request. When non-empty, this allowlist gates ALL auth emails (only listed addresses receive them); an EMPTY array clears it and disables the gate. Lets an integrator manage the allowlist from their own infrastructure config instead of the dashboard.  Application-SECRET scoped (server-side write): requires X-Application-Key AND X-Application-Secret. Mutates ONLY the authenticating application — it never takes an application id from the request, so there is no cross-tenant write path. The response mirrors GET /auth/application exactly (never returns secrets). 
+    # @param set_self_application_test_recipients_request [SetSelfApplicationTestRecipientsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApplicationSelfResponse, Integer, Hash)>] ApplicationSelfResponse data, response status code and response headers
+    def set_self_application_test_recipients_with_http_info(set_self_application_test_recipients_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApplicationApi.set_self_application_test_recipients ...'
+      end
+      # verify the required parameter 'set_self_application_test_recipients_request' is set
+      if @api_client.config.client_side_validation && set_self_application_test_recipients_request.nil?
+        fail ArgumentError, "Missing the required parameter 'set_self_application_test_recipients_request' when calling AuthApplicationApi.set_self_application_test_recipients"
+      end
+      # resource path
+      local_var_path = '/auth/application'
+
+      # 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(set_self_application_test_recipients_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApplicationSelfResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthApplicationApi.set_self_application_test_recipients",
+        :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: AuthApplicationApi#set_self_application_test_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/zyphr/api/auth_email_templates_api.rb

@@ -538,7 +538,7 @@ module Zyphr
     end
 
     # Send a test render of a template
-    # Renders the template (override or default) using sample/provided variables and sends to the recipient. The recipient must be in the application `test_recipients` allowlist. Rate-limited. 
+    # Renders the template (override or default) using sample/provided variables and sends to the recipient. The recipient must be in the application `test_recipients` allowlist. Rate-limited.  When non-empty, `test_recipients` gates ALL auth emails this application sends (magic link, password reset, email verification, and email OTP) — not just these test renders. Only listed recipients receive auth email; any other recipient is silently blocked. Use it to make a non-production application safe from mass sends. An empty allowlist (the default) imposes no restriction and every recipient receives auth email normally. 
     # @param type [AuthEmailType] 
     # @param auth_email_template_test_request [AuthEmailTemplateTestRequest] 
     # @param [Hash] opts the optional parameters
@@ -549,7 +549,7 @@ module Zyphr
     end
 
     # Send a test render of a template
-    # Renders the template (override or default) using sample/provided variables and sends to the recipient. The recipient must be in the application `test_recipients` allowlist. Rate-limited. 
+    # Renders the template (override or default) using sample/provided variables and sends to the recipient. The recipient must be in the application `test_recipients` allowlist. Rate-limited.  When non-empty, `test_recipients` gates ALL auth emails this application sends (magic link, password reset, email verification, and email OTP) — not just these test renders. Only listed recipients receive auth email; any other recipient is silently blocked. Use it to make a non-production application safe from mass sends. An empty allowlist (the default) imposes no restriction and every recipient receives auth email normally. 
     # @param type [AuthEmailType] 
     # @param auth_email_template_test_request [AuthEmailTemplateTestRequest] 
     # @param [Hash] opts the optional parameters

data/lib/zyphr/api/auth_user_directory_api.rb

@@ -80,6 +80,69 @@ module Zyphr
       return data, status_code, headers
     end
 
+    # Get an end user's sign-in methods (server-side admin)
+    # Secret-key-scoped, aggregate view of the sign-in methods configured for a single end user within the authenticating application. Reports whether the user has a password, which OAuth providers are linked, whether MFA is enabled, whether email/phone are verified, and how many passkeys are registered — everything a customer admin needs to build a \"sign-in methods\" screen. Scoped to the application — a caller can never read a user belonging to another application. 
+    # @param user_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetEndUserAuthMethods200Response]
+    def get_end_user_auth_methods(user_id, opts = {})
+      data, _status_code, _headers = get_end_user_auth_methods_with_http_info(user_id, opts)
+      data
+    end
+
+    # Get an end user's sign-in methods (server-side admin)
+    # Secret-key-scoped, aggregate view of the sign-in methods configured for a single end user within the authenticating application. Reports whether the user has a password, which OAuth providers are linked, whether MFA is enabled, whether email/phone are verified, and how many passkeys are registered — everything a customer admin needs to build a \"sign-in methods\" screen. Scoped to the application — a caller can never read a user belonging to another application. 
+    # @param user_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetEndUserAuthMethods200Response, Integer, Hash)>] GetEndUserAuthMethods200Response data, response status code and response headers
+    def get_end_user_auth_methods_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthUserDirectoryApi.get_end_user_auth_methods ...'
+      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 AuthUserDirectoryApi.get_end_user_auth_methods"
+      end
+      # resource path
+      local_var_path = '/auth/users/{user_id}/auth-methods'.sub('{' + 'user_id' + '}', CGI.escape(user_id.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] || 'GetEndUserAuthMethods200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthUserDirectoryApi.get_end_user_auth_methods",
+        :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: AuthUserDirectoryApi#get_end_user_auth_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Look up an end user by email (server-side admin)
     # Secret-key-scoped lookup of a single end user by email address within the authenticating application. Scoped to the application — never resolves a user from another application. Does not return the password hash. 
     # @param email [String] 

data/lib/zyphr/api/auth_user_profile_api.rb

@@ -19,6 +19,74 @@ module Zyphr
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Change password (authenticated session)
+    # Change the currently authenticated end user's password from a logged-in session. The caller must prove possession of the CURRENT password (`current_password`); the user is identified from the end-user token, not the request body, so a user can only change their own password.  On success, all existing sessions are revoked and a fresh token pair is returned so the current session stays authenticated. Emits the `user.password_changed` webhook.
+    # @param change_password_request [ChangePasswordRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [RefreshTokenResponse]
+    def change_end_user_password(change_password_request, opts = {})
+      data, _status_code, _headers = change_end_user_password_with_http_info(change_password_request, opts)
+      data
+    end
+
+    # Change password (authenticated session)
+    # Change the currently authenticated end user's password from a logged-in session. The caller must prove possession of the CURRENT password (`current_password`); the user is identified from the end-user token, not the request body, so a user can only change their own password.  On success, all existing sessions are revoked and a fresh token pair is returned so the current session stays authenticated. Emits the `user.password_changed` webhook.
+    # @param change_password_request [ChangePasswordRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RefreshTokenResponse, Integer, Hash)>] RefreshTokenResponse data, response status code and response headers
+    def change_end_user_password_with_http_info(change_password_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthUserProfileApi.change_end_user_password ...'
+      end
+      # verify the required parameter 'change_password_request' is set
+      if @api_client.config.client_side_validation && change_password_request.nil?
+        fail ArgumentError, "Missing the required parameter 'change_password_request' when calling AuthUserProfileApi.change_end_user_password"
+      end
+      # resource path
+      local_var_path = '/auth/users/change-password'
+
+      # 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(change_password_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RefreshTokenResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthUserProfileApi.change_end_user_password",
+        :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: AuthUserProfileApi#change_end_user_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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