zyphr 0.1.67 → 0.1.69
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.
- checksums.yaml +4 -4
- data/README.md +5 -0
- data/docs/AuthEmailVerificationApi.md +1 -1
- data/docs/AuthMagicLinksApi.md +5 -5
- data/docs/AuthPasswordResetApi.md +5 -5
- data/docs/AuthUserDirectoryApi.md +1 -1
- data/docs/ForgotPasswordRequest.md +3 -1
- data/docs/ForgotPasswordResult.md +20 -0
- data/docs/ForgotPasswordResultData.md +22 -0
- data/docs/InviteEndUser200ResponseData.md +2 -0
- data/docs/InviteEndUserRequest.md +3 -1
- data/docs/MagicLinkSendRequest.md +3 -1
- data/docs/MagicLinkSendResult.md +20 -0
- data/docs/MagicLinkSendResultData.md +20 -0
- data/docs/ResendEmailVerificationRequest.md +1 -1
- data/docs/ReturnedAuthLink.md +22 -0
- data/docs/SendEmailVerificationRequest.md +1 -1
- data/lib/zyphr/api/auth_email_verification_api.rb +2 -2
- data/lib/zyphr/api/auth_magic_links_api.rb +5 -5
- data/lib/zyphr/api/auth_password_reset_api.rb +5 -5
- data/lib/zyphr/api/auth_user_directory_api.rb +2 -2
- data/lib/zyphr/models/forgot_password_request.rb +16 -4
- data/lib/zyphr/models/forgot_password_result.rb +229 -0
- data/lib/zyphr/models/forgot_password_result_data.rb +275 -0
- data/lib/zyphr/models/invite_end_user200_response_data.rb +10 -1
- data/lib/zyphr/models/invite_end_user_request.rb +16 -4
- data/lib/zyphr/models/magic_link_send_request.rb +16 -4
- data/lib/zyphr/models/magic_link_send_result.rb +229 -0
- data/lib/zyphr/models/magic_link_send_result_data.rb +229 -0
- data/lib/zyphr/models/resend_email_verification_request.rb +1 -1
- data/lib/zyphr/models/returned_auth_link.rb +292 -0
- data/lib/zyphr/models/send_email_verification_request.rb +1 -1
- data/lib/zyphr.rb +5 -0
- data/spec/api/auth_email_verification_api_spec.rb +1 -1
- data/spec/api/auth_magic_links_api_spec.rb +2 -2
- data/spec/api/auth_password_reset_api_spec.rb +2 -2
- data/spec/api/auth_user_directory_api_spec.rb +1 -1
- data/spec/models/forgot_password_request_spec.rb +6 -0
- data/spec/models/forgot_password_result_data_spec.rb +52 -0
- data/spec/models/forgot_password_result_spec.rb +42 -0
- data/spec/models/invite_end_user200_response_data_spec.rb +6 -0
- data/spec/models/invite_end_user_request_spec.rb +6 -0
- data/spec/models/magic_link_send_request_spec.rb +6 -0
- data/spec/models/magic_link_send_result_data_spec.rb +42 -0
- data/spec/models/magic_link_send_result_spec.rb +42 -0
- data/spec/models/returned_auth_link_spec.rb +48 -0
- data/zyphr.gemspec +1 -1
- metadata +22 -2
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#Zyphr is a developer platform for user authentication and transactional messaging. One API covers auth (passkeys, social sign-in, passwordless, MFA, sessions, organizations) plus email, push notifications, SMS, in-app messages, and webhooks. ## 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. > **Test keys are being retired.** `zy_test_*` keys are no longer issued, and existing ones stop working on **21 October 2026**. They never delivered mail — sends were mocked and marked sent without reaching a provider, so they could not verify domain authentication, rendering, or deliverability. To test your integration, use a `zy_live_*` key against a verified domain and send to an address you control. ## 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\" } } ```
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
Contact: support@zyphr.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.12.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'date'
|
|
16
|
+
|
|
17
|
+
# Unit tests for Zyphr::ReturnedAuthLink
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::ReturnedAuthLink do
|
|
21
|
+
let(:instance) { Zyphr::ReturnedAuthLink.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of ReturnedAuthLink' do
|
|
24
|
+
it 'should create an instance of ReturnedAuthLink' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::ReturnedAuthLink)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "url"' do
|
|
31
|
+
it 'should work' do
|
|
32
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
describe 'test attribute "token"' do
|
|
37
|
+
it 'should work' do
|
|
38
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
describe 'test attribute "expires_at"' do
|
|
43
|
+
it 'should work' do
|
|
44
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
end
|
data/zyphr.gemspec
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: zyphr
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.69
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Zyphr
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-11-06 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|
|
@@ -230,6 +230,8 @@ files:
|
|
|
230
230
|
- docs/ExecutionRetryResponseData.md
|
|
231
231
|
- docs/ExecutionsApi.md
|
|
232
232
|
- docs/ForgotPasswordRequest.md
|
|
233
|
+
- docs/ForgotPasswordResult.md
|
|
234
|
+
- docs/ForgotPasswordResultData.md
|
|
233
235
|
- docs/GenerateSubscriberToken200Response.md
|
|
234
236
|
- docs/GenerateSubscriberToken200ResponseData.md
|
|
235
237
|
- docs/GenerateSubscriberTokenRequest.md
|
|
@@ -285,6 +287,8 @@ files:
|
|
|
285
287
|
- docs/ListWorkflows200ResponseMeta.md
|
|
286
288
|
- docs/LoginRequest.md
|
|
287
289
|
- docs/MagicLinkSendRequest.md
|
|
290
|
+
- docs/MagicLinkSendResult.md
|
|
291
|
+
- docs/MagicLinkSendResultData.md
|
|
288
292
|
- docs/MagicLinkVerifyRequest.md
|
|
289
293
|
- docs/MagicLinkVerifyResponse.md
|
|
290
294
|
- docs/MagicLinkVerifyResponseData.md
|
|
@@ -394,6 +398,7 @@ files:
|
|
|
394
398
|
- docs/ResetPasswordResponse.md
|
|
395
399
|
- docs/ResubscribeRequest.md
|
|
396
400
|
- docs/ResubscribeResponse.md
|
|
401
|
+
- docs/ReturnedAuthLink.md
|
|
397
402
|
- docs/RevokeAllSessionsResponse.md
|
|
398
403
|
- docs/RevokeAllSessionsResponseData.md
|
|
399
404
|
- docs/RevokeSessionRequest.md
|
|
@@ -792,6 +797,8 @@ files:
|
|
|
792
797
|
- lib/zyphr/models/execution_retry_response.rb
|
|
793
798
|
- lib/zyphr/models/execution_retry_response_data.rb
|
|
794
799
|
- lib/zyphr/models/forgot_password_request.rb
|
|
800
|
+
- lib/zyphr/models/forgot_password_result.rb
|
|
801
|
+
- lib/zyphr/models/forgot_password_result_data.rb
|
|
795
802
|
- lib/zyphr/models/generate_subscriber_token200_response.rb
|
|
796
803
|
- lib/zyphr/models/generate_subscriber_token200_response_data.rb
|
|
797
804
|
- lib/zyphr/models/generate_subscriber_token_request.rb
|
|
@@ -845,6 +852,8 @@ files:
|
|
|
845
852
|
- lib/zyphr/models/list_workflows200_response_meta.rb
|
|
846
853
|
- lib/zyphr/models/login_request.rb
|
|
847
854
|
- lib/zyphr/models/magic_link_send_request.rb
|
|
855
|
+
- lib/zyphr/models/magic_link_send_result.rb
|
|
856
|
+
- lib/zyphr/models/magic_link_send_result_data.rb
|
|
848
857
|
- lib/zyphr/models/magic_link_verify_request.rb
|
|
849
858
|
- lib/zyphr/models/magic_link_verify_response.rb
|
|
850
859
|
- lib/zyphr/models/magic_link_verify_response_data.rb
|
|
@@ -953,6 +962,7 @@ files:
|
|
|
953
962
|
- lib/zyphr/models/reset_password_response.rb
|
|
954
963
|
- lib/zyphr/models/resubscribe_request.rb
|
|
955
964
|
- lib/zyphr/models/resubscribe_response.rb
|
|
965
|
+
- lib/zyphr/models/returned_auth_link.rb
|
|
956
966
|
- lib/zyphr/models/revoke_all_sessions_response.rb
|
|
957
967
|
- lib/zyphr/models/revoke_all_sessions_response_data.rb
|
|
958
968
|
- lib/zyphr/models/revoke_session_request.rb
|
|
@@ -1333,6 +1343,8 @@ files:
|
|
|
1333
1343
|
- spec/models/execution_retry_response_data_spec.rb
|
|
1334
1344
|
- spec/models/execution_retry_response_spec.rb
|
|
1335
1345
|
- spec/models/forgot_password_request_spec.rb
|
|
1346
|
+
- spec/models/forgot_password_result_data_spec.rb
|
|
1347
|
+
- spec/models/forgot_password_result_spec.rb
|
|
1336
1348
|
- spec/models/generate_subscriber_token200_response_data_spec.rb
|
|
1337
1349
|
- spec/models/generate_subscriber_token200_response_spec.rb
|
|
1338
1350
|
- spec/models/generate_subscriber_token_request_spec.rb
|
|
@@ -1386,6 +1398,8 @@ files:
|
|
|
1386
1398
|
- spec/models/list_workflows200_response_spec.rb
|
|
1387
1399
|
- spec/models/login_request_spec.rb
|
|
1388
1400
|
- spec/models/magic_link_send_request_spec.rb
|
|
1401
|
+
- spec/models/magic_link_send_result_data_spec.rb
|
|
1402
|
+
- spec/models/magic_link_send_result_spec.rb
|
|
1389
1403
|
- spec/models/magic_link_verify_request_spec.rb
|
|
1390
1404
|
- spec/models/magic_link_verify_response_data_spec.rb
|
|
1391
1405
|
- spec/models/magic_link_verify_response_spec.rb
|
|
@@ -1494,6 +1508,7 @@ files:
|
|
|
1494
1508
|
- spec/models/reset_password_response_spec.rb
|
|
1495
1509
|
- spec/models/resubscribe_request_spec.rb
|
|
1496
1510
|
- spec/models/resubscribe_response_spec.rb
|
|
1511
|
+
- spec/models/returned_auth_link_spec.rb
|
|
1497
1512
|
- spec/models/revoke_all_sessions_response_data_spec.rb
|
|
1498
1513
|
- spec/models/revoke_all_sessions_response_spec.rb
|
|
1499
1514
|
- spec/models/revoke_session_request_spec.rb
|
|
@@ -1863,6 +1878,7 @@ test_files:
|
|
|
1863
1878
|
- spec/models/get_subscriber_notification200_response_spec.rb
|
|
1864
1879
|
- spec/models/get_end_user_claims200_response_data_spec.rb
|
|
1865
1880
|
- spec/models/unsubscribe_request_spec.rb
|
|
1881
|
+
- spec/models/forgot_password_result_spec.rb
|
|
1866
1882
|
- spec/models/password_strength_request_spec.rb
|
|
1867
1883
|
- spec/models/add_workflow_step_request_spec.rb
|
|
1868
1884
|
- spec/models/email_response_spec.rb
|
|
@@ -2000,6 +2016,7 @@ test_files:
|
|
|
2000
2016
|
- spec/models/mfa_verify_request_spec.rb
|
|
2001
2017
|
- spec/models/send_batch_in_app_request_spec.rb
|
|
2002
2018
|
- spec/models/device_stats_response_spec.rb
|
|
2019
|
+
- spec/models/magic_link_send_result_spec.rb
|
|
2003
2020
|
- spec/models/o_auth_authorization_url_response_data_spec.rb
|
|
2004
2021
|
- spec/models/consent_record_response_spec.rb
|
|
2005
2022
|
- spec/models/generate_subscriber_token200_response_data_spec.rb
|
|
@@ -2175,6 +2192,7 @@ test_files:
|
|
|
2175
2192
|
- spec/models/verification_status_response_spec.rb
|
|
2176
2193
|
- spec/models/validate_reset_token_response_spec.rb
|
|
2177
2194
|
- spec/models/verify_domain_response_spec.rb
|
|
2195
|
+
- spec/models/returned_auth_link_spec.rb
|
|
2178
2196
|
- spec/models/mfa_verify_enrollment_response_spec.rb
|
|
2179
2197
|
- spec/models/verify_sms_config_response_spec.rb
|
|
2180
2198
|
- spec/models/web_authn_start_auth_request_spec.rb
|
|
@@ -2255,6 +2273,7 @@ test_files:
|
|
|
2255
2273
|
- spec/models/webhook_delivery_list_response_spec.rb
|
|
2256
2274
|
- spec/models/send_template_test_email202_response_spec.rb
|
|
2257
2275
|
- spec/models/send_email_response_meta_spec.rb
|
|
2276
|
+
- spec/models/forgot_password_result_data_spec.rb
|
|
2258
2277
|
- spec/models/create_waa_s_endpoint_response_spec.rb
|
|
2259
2278
|
- spec/models/mfa_enrollment_response_data_spec.rb
|
|
2260
2279
|
- spec/models/create_waa_s_event_type_request_spec.rb
|
|
@@ -2273,6 +2292,7 @@ test_files:
|
|
|
2273
2292
|
- spec/models/inbound_attachment_url_response_spec.rb
|
|
2274
2293
|
- spec/models/waa_s_endpoint_spec.rb
|
|
2275
2294
|
- spec/models/send_push_to_topic_data_spec.rb
|
|
2295
|
+
- spec/models/magic_link_send_result_data_spec.rb
|
|
2276
2296
|
- spec/models/update_category_request_spec.rb
|
|
2277
2297
|
- spec/models/organization_members_list_response_spec.rb
|
|
2278
2298
|
- spec/models/webhook_bulk_retry_response_spec.rb
|