zyphr 0.1.37 → 0.1.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a8af3ccb76b2fc2b8a060f4bcbe89c657ffe808337851954f18d69b5fbed59f
-  data.tar.gz: b937cbad16d57dacab5c7bf7181f6caf54ab7f1809aad982b616a9d6dc00ef2c
+  metadata.gz: af0784e6badcf3428abffcf5a6a88d0deb768baf45206e8edc15c811835eb7f7
+  data.tar.gz: 349dd9342bd68316b908ec87ef9464edccc460a5eafb240f0481a612ade70b83
 SHA512:
-  metadata.gz: 5f91a3a85d3e759df5da2e9e061e46fd36160c5583350affdcfcfed524f77ba0f4016d0e50c3a8da9a50cda81a643ac931526ffb09e26617481f31f6181e1000
-  data.tar.gz: 4481a5fa76675d2e3931faf8f6aef919f6d3be1139f40075e1a3199d6f6de4a458fa10cc6812c45de04c5c8ca7b7f26ce0ac31362ff830c1d01d8c57046eb5eb
+  metadata.gz: a5a4366857accac4b75f1d6a5de65304f3ef9bcc99302317f3f752ab3469a6ab30324427c9b64895cfe1d43ff80f1a5dd91027ed4e793785e0d0c18c0c6ce17e
+  data.tar.gz: 814bbbfb0880eb3dc482e83ac0c08cbd24ba73b9577d74b190569c0dd966ad0520ec68060e36566ef8c19d14f9c80ca0b477f1f1c886e15741d4f35e2c05ff56

data/README.md

@@ -188,12 +188,21 @@ 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::AuthRegistrationApi* | [**sign_in_with_google_play_games**](docs/AuthRegistrationApi.md#sign_in_with_google_play_games) | **POST** /auth/google-play-games | Sign in with Google Play Games Services
 *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
@@ -500,6 +509,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)
@@ -544,6 +554,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)
@@ -647,9 +658,12 @@ 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::SignInWithGooglePlayGamesRequest](docs/SignInWithGooglePlayGamesRequest.md)
  - [Zyphr::SlackMessage](docs/SlackMessage.md)
  - [Zyphr::SlackMessageListResponse](docs/SlackMessageListResponse.md)
  - [Zyphr::SlackMessageListResponseMeta](docs/SlackMessageListResponseMeta.md)
@@ -705,6 +719,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

@@ -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

@@ -7,6 +7,8 @@ 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 |
+| [**sign_in_with_google_play_games**](AuthRegistrationApi.md#sign_in_with_google_play_games) | **POST** /auth/google-play-games | Sign in with Google Play Games Services |
 
 
 ## convert_anonymous_user
@@ -155,7 +157,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 +221,145 @@ 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
+
+
+## sign_in_with_google_play_games
+
+> <AuthResultResponse> sign_in_with_google_play_games(sign_in_with_google_play_games_request)
+
+Sign in with Google Play Games Services
+
+Exchange a Google Play Games Services (GPGS) **server auth code** for a Zyphr end-user session. Unlike Game Center (which submits an Apple-signed assertion), GPGS is verified by Google: Zyphr exchanges the single-use server auth code at Google's OAuth2 token endpoint, then calls the Play Games REST API (`players/me`) server-side to obtain the trusted, tamper-proof `playerId`. The user is provisioned-or-looked-up on that server-fetched `playerId` and tokens are minted.  ## Producing the server auth code (Integration)  The server auth code is obtained **on-device by the Android app** — there is no server-side way to mint it. The app calls `GamesSignInClient.requestServerSideAccess(serverClientId, …)` using the Google Cloud **web (server) client id** configured for the game, which returns a single-use auth code string. Submit that string here as `serverAuthCode`.  The **backend-relayed** shape is the common one: the app forwards the auth code to the customer's own backend, which relays it to this endpoint; the app never holds Zyphr keys.  ## Security  The `playerId` is derived **only** from Zyphr's own server-side call to Google after the token exchange — a client-supplied player id is never accepted or trusted. On any verification failure the response is a single opaque `401` `invalid_auth_code`; 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_google_play_games_request = Zyphr::SignInWithGooglePlayGamesRequest.new({server_auth_code: 'server_auth_code_example'}) # SignInWithGooglePlayGamesRequest | 
+
+begin
+  # Sign in with Google Play Games Services
+  result = api_instance.sign_in_with_google_play_games(sign_in_with_google_play_games_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthRegistrationApi->sign_in_with_google_play_games: #{e}"
+end
+```
+
+#### Using the sign_in_with_google_play_games_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResultResponse>, Integer, Hash)> sign_in_with_google_play_games_with_http_info(sign_in_with_google_play_games_request)
+
+```ruby
+begin
+  # Sign in with Google Play Games Services
+  data, status_code, headers = api_instance.sign_in_with_google_play_games_with_http_info(sign_in_with_google_play_games_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResultResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthRegistrationApi->sign_in_with_google_play_games_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sign_in_with_google_play_games_request** | [**SignInWithGooglePlayGamesRequest**](SignInWithGooglePlayGamesRequest.md) |  |  |
+
+### Return type
+
+[**AuthResultResponse**](AuthResultResponse.md)
+
+### Authorization
+
+[ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+