RubyGems - zyphr - Versions diffs - 0.1.36 → 0.1.38 - Mend

zyphr 0.1.36 → 0.1.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (960) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0067ad17150f659eb4ef54057a18ad5f7a92e1d764548ab45fbe31dd782928a
-  data.tar.gz: 7b22a003289b965f16f30d233a346ae5ae5aaf3a6f1367dc828cd6a5f0bf8eb5
+  metadata.gz: 3e2ae10652d7fff4bb616e0c98878a12ae47ca169e92741c96f04843b3025fb7
+  data.tar.gz: 56d78709528a4cdd327d00a45abebf5323880b1d954a75034c60032b423677e5
 SHA512:
-  metadata.gz: 84c95f09224c4d7de78be1df8cd3225dbb44e04275fd83089a17e0c44c52325895d39b8747e15c574c007907c59a969c8fce250e5817c39c09aeae5c21e29786
-  data.tar.gz: 3445f3a9cfbbe02b737e73c287265ee893ead08f168d54d62ac54833bc8e3e46614507c38667ba8db63956139f5d57390d5274ff52bee88eac6afd33a3c9ad3e
+  metadata.gz: 8e014981ef77cb0084fee9465ad338fe3fa89009062fb83b7ee2fae91444b261ca5c432d837c78e20a3f43a341ca84909e46dd13dc27a9e5372dcdcb7944a2bb
+  data.tar.gz: a6b7a27531f5d750432cd33b364db234fd4687518b62683a09e553b323687ddb6d6aaedf4bbdd784c91826e86902e4274badb43d6888a78a8a8e53ab058a0562

data/README.md CHANGED Viewed

@@ -22,6 +22,15 @@ The API implements rate limiting to ensure fair usage. Rate limit information is
 - `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:
@@ -179,12 +188,20 @@ Class | Method | HTTP request | Description
 *Zyphr::AuthRegistrationApi* | [**convert_anonymous_user**](docs/AuthRegistrationApi.md#convert_anonymous_user) | **POST** /auth/users/convert | Convert anonymous account to a full account
 *Zyphr::AuthRegistrationApi* | [**register_end_user**](docs/AuthRegistrationApi.md#register_end_user) | **POST** /auth/users/register | Register a new end user
 *Zyphr::AuthRegistrationApi* | [**sign_in_anonymously**](docs/AuthRegistrationApi.md#sign_in_anonymously) | **POST** /auth/users/anonymous | Sign in anonymously
+*Zyphr::AuthRegistrationApi* | [**sign_in_with_game_center**](docs/AuthRegistrationApi.md#sign_in_with_game_center) | **POST** /auth/game-center | Sign in with Apple Game Center
 *Zyphr::AuthSessionsApi* | [**list_end_user_sessions**](docs/AuthSessionsApi.md#list_end_user_sessions) | **GET** /auth/sessions | List active sessions
 *Zyphr::AuthSessionsApi* | [**refresh_end_user_token**](docs/AuthSessionsApi.md#refresh_end_user_token) | **POST** /auth/sessions/refresh | Refresh access token
 *Zyphr::AuthSessionsApi* | [**revoke_all_end_user_sessions**](docs/AuthSessionsApi.md#revoke_all_end_user_sessions) | **POST** /auth/sessions/revoke-all | Revoke all sessions
 *Zyphr::AuthSessionsApi* | [**revoke_end_user_session**](docs/AuthSessionsApi.md#revoke_end_user_session) | **POST** /auth/sessions/revoke | Revoke a session
+*Zyphr::AuthUserDirectoryApi* | [**delete_end_user_by_application**](docs/AuthUserDirectoryApi.md#delete_end_user_by_application) | **DELETE** /auth/users/{user_id} | Delete an end user (server-side admin)
+*Zyphr::AuthUserDirectoryApi* | [**get_end_user_by_email**](docs/AuthUserDirectoryApi.md#get_end_user_by_email) | **GET** /auth/users/by-email | Look up an end user by email (server-side admin)
+*Zyphr::AuthUserDirectoryApi* | [**get_end_user_by_id**](docs/AuthUserDirectoryApi.md#get_end_user_by_id) | **GET** /auth/users/{user_id} | Get an end user by id (server-side admin)
+*Zyphr::AuthUserDirectoryApi* | [**get_end_user_claims**](docs/AuthUserDirectoryApi.md#get_end_user_claims) | **GET** /auth/users/{user_id}/claims | Get an end user's stored custom claims (server-side admin)
+*Zyphr::AuthUserDirectoryApi* | [**invite_end_user**](docs/AuthUserDirectoryApi.md#invite_end_user) | **POST** /auth/users/invite | Pre-provision (invite) an end user (server-side admin)
+*Zyphr::AuthUserDirectoryApi* | [**list_end_users**](docs/AuthUserDirectoryApi.md#list_end_users) | **GET** /auth/users | List / search end users (server-side admin)
+*Zyphr::AuthUserDirectoryApi* | [**set_end_user_claims**](docs/AuthUserDirectoryApi.md#set_end_user_claims) | **PUT** /auth/users/{user_id}/claims | Set an end user's stored custom claims (server-side admin)
+*Zyphr::AuthUserDirectoryApi* | [**update_end_user_by_application**](docs/AuthUserDirectoryApi.md#update_end_user_by_application) | **PATCH** /auth/users/{user_id} | Update an end user (server-side admin)
 *Zyphr::AuthUserProfileApi* | [**delete_end_user**](docs/AuthUserProfileApi.md#delete_end_user) | **DELETE** /auth/users/me | Delete current end user account
-*Zyphr::AuthUserProfileApi* | [**delete_end_user_by_application**](docs/AuthUserProfileApi.md#delete_end_user_by_application) | **DELETE** /auth/users/{user_id} | Delete an end user (test environment only)
 *Zyphr::AuthUserProfileApi* | [**get_end_user**](docs/AuthUserProfileApi.md#get_end_user) | **GET** /auth/users/me | Get current end user profile
 *Zyphr::AuthUserProfileApi* | [**update_end_user**](docs/AuthUserProfileApi.md#update_end_user) | **PATCH** /auth/users/me | Update current end user profile
 *Zyphr::AuthWebAuthnApi* | [**delete_web_authn_credential**](docs/AuthWebAuthnApi.md#delete_web_authn_credential) | **DELETE** /auth/webauthn/credentials/{id} | Delete a WebAuthn credential
@@ -297,6 +314,7 @@ Class | Method | HTTP request | Description
 *Zyphr::TemplatesApi* | [**get_template**](docs/TemplatesApi.md#get_template) | **GET** /templates/{id} | Get template
 *Zyphr::TemplatesApi* | [**list_templates**](docs/TemplatesApi.md#list_templates) | **GET** /templates | List templates
 *Zyphr::TemplatesApi* | [**render_template**](docs/TemplatesApi.md#render_template) | **POST** /templates/{id}/render | Render template
+*Zyphr::TemplatesApi* | [**send_template_test_email**](docs/TemplatesApi.md#send_template_test_email) | **POST** /templates/{id}/test | Send a test email using a template
 *Zyphr::TemplatesApi* | [**update_template**](docs/TemplatesApi.md#update_template) | **PUT** /templates/{id} | Update template
 *Zyphr::TopicsApi* | [**add_topic_subscribers**](docs/TopicsApi.md#add_topic_subscribers) | **POST** /topics/{key}/subscribers | Add subscribers to a topic
 *Zyphr::TopicsApi* | [**create_topic**](docs/TopicsApi.md#create_topic) | **POST** /topics | Create a new topic
@@ -490,6 +508,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::InboxListMeta](docs/InboxListMeta.md)
  - [Zyphr::InboxListResponse](docs/InboxListResponse.md)
  - [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
+ - [Zyphr::InviteEndUserRequest](docs/InviteEndUserRequest.md)
  - [Zyphr::ListWaaSApplications200Response](docs/ListWaaSApplications200Response.md)
  - [Zyphr::ListWaaSEndpointDeliveries200Response](docs/ListWaaSEndpointDeliveries200Response.md)
  - [Zyphr::ListWaaSEndpoints200Response](docs/ListWaaSEndpoints200Response.md)
@@ -534,6 +553,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::OAuthConnectionsResponseData](docs/OAuthConnectionsResponseData.md)
  - [Zyphr::OAuthProvider](docs/OAuthProvider.md)
  - [Zyphr::OAuthProviderInfo](docs/OAuthProviderInfo.md)
+ - [Zyphr::OAuthProviderName](docs/OAuthProviderName.md)
  - [Zyphr::OAuthProvidersResponse](docs/OAuthProvidersResponse.md)
  - [Zyphr::OAuthProvidersResponseData](docs/OAuthProvidersResponseData.md)
  - [Zyphr::OAuthTokensRefreshResponse](docs/OAuthTokensRefreshResponse.md)
@@ -628,6 +648,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::SendSmsData](docs/SendSmsData.md)
  - [Zyphr::SendSmsRequest](docs/SendSmsRequest.md)
  - [Zyphr::SendSmsResponse](docs/SendSmsResponse.md)
+ - [Zyphr::SendTemplateTestEmailRequest](docs/SendTemplateTestEmailRequest.md)
  - [Zyphr::SendTestSmsData](docs/SendTestSmsData.md)
  - [Zyphr::SendTestSmsRequest](docs/SendTestSmsRequest.md)
  - [Zyphr::SendTestSmsResponse](docs/SendTestSmsResponse.md)
@@ -636,9 +657,11 @@ Class | Method | HTTP request | Description
  - [Zyphr::SessionListResponseData](docs/SessionListResponseData.md)
  - [Zyphr::SessionListResponseDataSessionInfo](docs/SessionListResponseDataSessionInfo.md)
  - [Zyphr::SetDomainInboundRequest](docs/SetDomainInboundRequest.md)
+ - [Zyphr::SetEndUserClaimsRequest](docs/SetEndUserClaimsRequest.md)
  - [Zyphr::SetPreferencesRequest](docs/SetPreferencesRequest.md)
  - [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)
  - [Zyphr::SignInAnonymouslyRequest](docs/SignInAnonymouslyRequest.md)
+ - [Zyphr::SignInWithGameCenterRequest](docs/SignInWithGameCenterRequest.md)
  - [Zyphr::SlackMessage](docs/SlackMessage.md)
  - [Zyphr::SlackMessageListResponse](docs/SlackMessageListResponse.md)
  - [Zyphr::SlackMessageListResponseMeta](docs/SlackMessageListResponseMeta.md)
@@ -694,6 +717,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::UnsubscribeRequest](docs/UnsubscribeRequest.md)
  - [Zyphr::UnsubscribeResponse](docs/UnsubscribeResponse.md)
  - [Zyphr::UpdateCategoryRequest](docs/UpdateCategoryRequest.md)
+ - [Zyphr::UpdateEndUserByApplicationRequest](docs/UpdateEndUserByApplicationRequest.md)
  - [Zyphr::UpdateEndUserRequest](docs/UpdateEndUserRequest.md)
  - [Zyphr::UpdateOrganizationMemberRoleRequest](docs/UpdateOrganizationMemberRoleRequest.md)
  - [Zyphr::UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)

data/docs/AuthOAuthApi.md CHANGED Viewed

@@ -39,7 +39,7 @@ Zyphr.configure do |config|
 end
 api_instance = Zyphr::AuthOAuthApi.new
-provider = 'provider_example' # String | OAuth provider name
+provider = Zyphr::OAuthProviderName::GOOGLE # OAuthProviderName | OAuth provider name
 begin
   # Disconnect OAuth provider
@@ -72,7 +72,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **provider** | **String** | OAuth provider name |  |
+| **provider** | [**OAuthProviderName**](.md) | OAuth provider name |  |
 ### Return type
@@ -110,7 +110,7 @@ Zyphr.configure do |config|
 end
 api_instance = Zyphr::AuthOAuthApi.new
-provider = 'provider_example' # String | OAuth provider name
+provider = Zyphr::OAuthProviderName::GOOGLE # OAuthProviderName | OAuth provider name
 redirect_uri = 'redirect_uri_example' # String | Redirect URI after authorization
 begin
@@ -144,7 +144,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **provider** | **String** | OAuth provider name |  |
+| **provider** | [**OAuthProviderName**](.md) | OAuth provider name |  |
 | **redirect_uri** | **String** | Redirect URI after authorization |  |
 ### Return type
@@ -186,7 +186,7 @@ Zyphr.configure do |config|
 end
 api_instance = Zyphr::AuthOAuthApi.new
-provider = 'provider_example' # String | OAuth provider name
+provider = Zyphr::OAuthProviderName::GOOGLE # OAuthProviderName | OAuth provider name
 begin
   # Get OAuth connection info
@@ -219,7 +219,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **provider** | **String** | OAuth provider name |  |
+| **provider** | [**OAuthProviderName**](.md) | OAuth provider name |  |
 ### Return type
@@ -262,7 +262,7 @@ Zyphr.configure do |config|
 end
 api_instance = Zyphr::AuthOAuthApi.new
-provider = 'provider_example' # String | OAuth provider name
+provider = Zyphr::OAuthProviderName::GOOGLE # OAuthProviderName | OAuth provider name
 user_id = 'user_id_example' # String | End user ID
 begin
@@ -296,7 +296,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **provider** | **String** | OAuth provider name |  |
+| **provider** | [**OAuthProviderName**](.md) | OAuth provider name |  |
 | **user_id** | **String** | End user ID |  |
 ### Return type
@@ -328,7 +328,7 @@ require 'time'
 require 'zyphr'
 api_instance = Zyphr::AuthOAuthApi.new
-provider = 'provider_example' # String | OAuth provider name
+provider = Zyphr::OAuthProviderName::GOOGLE # OAuthProviderName | OAuth provider name
 o_auth_callback_request = Zyphr::OAuthCallbackRequest.new({code: 'code_example', state: 'state_example'}) # OAuthCallbackRequest |
 begin
@@ -362,7 +362,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **provider** | **String** | OAuth provider name |  |
+| **provider** | [**OAuthProviderName**](.md) | OAuth provider name |  |
 | **o_auth_callback_request** | [**OAuthCallbackRequest**](OAuthCallbackRequest.md) |  |  |
 ### Return type
@@ -545,7 +545,7 @@ Zyphr.configure do |config|
 end
 api_instance = Zyphr::AuthOAuthApi.new
-provider = 'provider_example' # String | OAuth provider name
+provider = Zyphr::OAuthProviderName::GOOGLE # OAuthProviderName | OAuth provider name
 refresh_o_auth_tokens_request = Zyphr::RefreshOAuthTokensRequest.new({user_id: 'user_id_example'}) # RefreshOAuthTokensRequest |
 begin
@@ -579,7 +579,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **provider** | **String** | OAuth provider name |  |
+| **provider** | [**OAuthProviderName**](.md) | OAuth provider name |  |
 | **refresh_o_auth_tokens_request** | [**RefreshOAuthTokensRequest**](RefreshOAuthTokensRequest.md) |  |  |
 ### Return type

data/docs/AuthRegistrationApi.md CHANGED Viewed

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 | [**convert_anonymous_user**](AuthRegistrationApi.md#convert_anonymous_user) | **POST** /auth/users/convert | Convert anonymous account to a full account |
 | [**register_end_user**](AuthRegistrationApi.md#register_end_user) | **POST** /auth/users/register | Register a new end user |
 | [**sign_in_anonymously**](AuthRegistrationApi.md#sign_in_anonymously) | **POST** /auth/users/anonymous | Sign in anonymously |
+| [**sign_in_with_game_center**](AuthRegistrationApi.md#sign_in_with_game_center) | **POST** /auth/game-center | Sign in with Apple Game Center |
 ## convert_anonymous_user
@@ -155,7 +156,7 @@ end
 Sign in anonymously
-Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry.  Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh).  Convert an anonymous user to a full account via POST /v1/auth/users/convert.
+Issue an end-user identity to a device without email, password, OAuth, or any other credential. Idempotent per (application, environment, device_id): repeated calls with the same device_id return the same user but a fresh token pair. Prior sessions for the user remain valid until natural expiry.  Anonymous users do not count toward MAU quota until their first authenticated request after sign-in (excluding /v1/auth/refresh).  Convert an anonymous user to a full account via POST /v1/auth/users/convert.  Pass an optional `organization_id` to create the anonymous user directly in an organization; the returned access token then carries `org_id` (and `orgs`), matching the org-scoped register/login flow.
 ### Examples
@@ -219,3 +220,74 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
+## sign_in_with_game_center
+> <AuthResultResponse> sign_in_with_game_center(sign_in_with_game_center_request)
+Sign in with Apple Game Center
+Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the modern scoped `playerId` (gamePlayerID).  ## Producing the assertion (Integration)  The assertion is produced **on-device by the iOS app** — there is no server-side way to mint it. The app calls GameKit's `GKLocalPlayer.fetchItems(forIdentityVerificationSignature:)`, which returns `publicKeyURL`, `signature`, `salt`, and `timestamp`; combine those with the local player's `gamePlayerID` and the app's bundle identifier and submit them here.  Two integration shapes are supported:   - **client-direct** — the iOS app holds the Zyphr application public     key and calls this endpoint itself.   - **backend-relayed** — the app forwards the fetched assertion fields     to the customer's own backend, which relays them to this endpoint;     the app never holds Zyphr keys. (This is the common shape for games.)  On any verification failure the response is a single opaque `401` `invalid_assertion` — the specific control that failed is never disclosed.
+### Examples
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+api_instance = Zyphr::AuthRegistrationApi.new
+sign_in_with_game_center_request = Zyphr::SignInWithGameCenterRequest.new({player_id: 'player_id_example', public_key_url: 'public_key_url_example', signature: 'signature_example', salt: 'salt_example', timestamp: 3.56, bundle_id: 'bundle_id_example'}) # SignInWithGameCenterRequest |
+begin
+  # Sign in with Apple Game Center
+  result = api_instance.sign_in_with_game_center(sign_in_with_game_center_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthRegistrationApi->sign_in_with_game_center: #{e}"
+end
+```
+#### Using the sign_in_with_game_center_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<AuthResultResponse>, Integer, Hash)> sign_in_with_game_center_with_http_info(sign_in_with_game_center_request)
+```ruby
+begin
+  # Sign in with Apple Game Center
+  data, status_code, headers = api_instance.sign_in_with_game_center_with_http_info(sign_in_with_game_center_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResultResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthRegistrationApi->sign_in_with_game_center_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sign_in_with_game_center_request** | [**SignInWithGameCenterRequest**](SignInWithGameCenterRequest.md) |  |  |
+### Return type
+[**AuthResultResponse**](AuthResultResponse.md)
+### Authorization
+[ApplicationPublicKey](../README.md#ApplicationPublicKey)
+### HTTP request headers
+- **Content-Type**: application/json
+- **Accept**: application/json