zyphr 0.1.44 → 0.1.46
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/ApplicationSelf.md +3 -1
- data/docs/AuthApplicationApi.md +77 -0
- data/docs/AuthUserProfileApi.md +75 -0
- data/docs/ChangePasswordRequest.md +20 -0
- data/docs/SetSelfApplicationTestRecipientsRequest.md +18 -0
- data/docs/WebhookDelivery.md +1 -1
- data/docs/WebhookDeliveryDetail.md +1 -1
- data/docs/WebhookEventType.md +15 -0
- data/docs/WebhookEventTypesResponseData.md +1 -1
- data/docs/WebhookTestEventResponseData.md +1 -1
- data/lib/zyphr/api/auth_application_api.rb +68 -0
- data/lib/zyphr/api/auth_user_profile_api.rb +68 -0
- data/lib/zyphr/models/application_self.rb +33 -4
- data/lib/zyphr/models/change_password_request.rb +265 -0
- data/lib/zyphr/models/set_self_application_test_recipients_request.rb +240 -0
- data/lib/zyphr/models/webhook_delivery.rb +1 -1
- data/lib/zyphr/models/webhook_delivery_detail.rb +1 -1
- data/lib/zyphr/models/webhook_event_type.rb +67 -0
- data/lib/zyphr/models/webhook_event_types_response_data.rb +1 -1
- data/lib/zyphr/models/webhook_test_event_response_data.rb +23 -1
- data/lib/zyphr.rb +3 -0
- data/spec/api/auth_application_api_spec.rb +12 -0
- data/spec/api/auth_user_profile_api_spec.rb +12 -0
- data/spec/models/application_self_spec.rb +6 -0
- data/spec/models/change_password_request_spec.rb +42 -0
- data/spec/models/set_self_application_test_recipients_request_spec.rb +36 -0
- data/spec/models/webhook_event_type_spec.rb +30 -0
- data/zyphr.gemspec +1 -1
- metadata +13 -1
|
@@ -32,6 +32,18 @@ describe 'AuthUserProfileApi' do
|
|
|
32
32
|
end
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
+
# unit tests for change_end_user_password
|
|
36
|
+
# Change password (authenticated session)
|
|
37
|
+
# 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.
|
|
38
|
+
# @param change_password_request
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [RefreshTokenResponse]
|
|
41
|
+
describe 'change_end_user_password test' do
|
|
42
|
+
it 'should work' do
|
|
43
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
35
47
|
# unit tests for delete_end_user
|
|
36
48
|
# Delete current end user account
|
|
37
49
|
# 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.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#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\" } } ```
|
|
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::ChangePasswordRequest
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::ChangePasswordRequest do
|
|
21
|
+
let(:instance) { Zyphr::ChangePasswordRequest.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of ChangePasswordRequest' do
|
|
24
|
+
it 'should create an instance of ChangePasswordRequest' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::ChangePasswordRequest)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "current_password"' 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 "new_password"' 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
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#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\" } } ```
|
|
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::SetSelfApplicationTestRecipientsRequest
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::SetSelfApplicationTestRecipientsRequest do
|
|
21
|
+
let(:instance) { Zyphr::SetSelfApplicationTestRecipientsRequest.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of SetSelfApplicationTestRecipientsRequest' do
|
|
24
|
+
it 'should create an instance of SetSelfApplicationTestRecipientsRequest' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::SetSelfApplicationTestRecipientsRequest)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "test_recipients"' 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
|
+
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zyphr API
|
|
3
|
+
|
|
4
|
+
#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\" } } ```
|
|
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::WebhookEventType
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::WebhookEventType do
|
|
21
|
+
let(:instance) { Zyphr::WebhookEventType.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of WebhookEventType' do
|
|
24
|
+
it 'should create an instance of WebhookEventType' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::WebhookEventType)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
end
|
data/zyphr.gemspec
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
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.46
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Zyphr
|
|
@@ -152,6 +152,7 @@ files:
|
|
|
152
152
|
- docs/Category.md
|
|
153
153
|
- docs/CategoryListResponse.md
|
|
154
154
|
- docs/CategoryResponse.md
|
|
155
|
+
- docs/ChangePasswordRequest.md
|
|
155
156
|
- docs/CloseWaaSEndpointCircuit200Response.md
|
|
156
157
|
- docs/CloseWaaSEndpointCircuit200ResponseData.md
|
|
157
158
|
- docs/ConfirmEmailVerificationRequest.md
|
|
@@ -439,6 +440,7 @@ files:
|
|
|
439
440
|
- docs/SetEndUserClaimsRequest.md
|
|
440
441
|
- docs/SetPreferencesRequest.md
|
|
441
442
|
- docs/SetPreferencesRequestPreferencesInner.md
|
|
443
|
+
- docs/SetSelfApplicationTestRecipientsRequest.md
|
|
442
444
|
- docs/SignInAnonymouslyRequest.md
|
|
443
445
|
- docs/SignInWithGameCenterRequest.md
|
|
444
446
|
- docs/SignInWithGooglePlayGamesRequest.md
|
|
@@ -587,6 +589,7 @@ files:
|
|
|
587
589
|
- docs/WebhookDeliveryResponse.md
|
|
588
590
|
- docs/WebhookDeliveryRetryResponse.md
|
|
589
591
|
- docs/WebhookDeliveryRetryResponseData.md
|
|
592
|
+
- docs/WebhookEventType.md
|
|
590
593
|
- docs/WebhookEventTypesResponse.md
|
|
591
594
|
- docs/WebhookEventTypesResponseData.md
|
|
592
595
|
- docs/WebhookIpsResponse.md
|
|
@@ -709,6 +712,7 @@ files:
|
|
|
709
712
|
- lib/zyphr/models/category.rb
|
|
710
713
|
- lib/zyphr/models/category_list_response.rb
|
|
711
714
|
- lib/zyphr/models/category_response.rb
|
|
715
|
+
- lib/zyphr/models/change_password_request.rb
|
|
712
716
|
- lib/zyphr/models/close_waa_s_endpoint_circuit200_response.rb
|
|
713
717
|
- lib/zyphr/models/close_waa_s_endpoint_circuit200_response_data.rb
|
|
714
718
|
- lib/zyphr/models/confirm_email_verification_request.rb
|
|
@@ -988,6 +992,7 @@ files:
|
|
|
988
992
|
- lib/zyphr/models/set_end_user_claims_request.rb
|
|
989
993
|
- lib/zyphr/models/set_preferences_request.rb
|
|
990
994
|
- lib/zyphr/models/set_preferences_request_preferences_inner.rb
|
|
995
|
+
- lib/zyphr/models/set_self_application_test_recipients_request.rb
|
|
991
996
|
- lib/zyphr/models/sign_in_anonymously_request.rb
|
|
992
997
|
- lib/zyphr/models/sign_in_with_game_center_request.rb
|
|
993
998
|
- lib/zyphr/models/sign_in_with_google_play_games_request.rb
|
|
@@ -1125,6 +1130,7 @@ files:
|
|
|
1125
1130
|
- lib/zyphr/models/webhook_delivery_response.rb
|
|
1126
1131
|
- lib/zyphr/models/webhook_delivery_retry_response.rb
|
|
1127
1132
|
- lib/zyphr/models/webhook_delivery_retry_response_data.rb
|
|
1133
|
+
- lib/zyphr/models/webhook_event_type.rb
|
|
1128
1134
|
- lib/zyphr/models/webhook_event_types_response.rb
|
|
1129
1135
|
- lib/zyphr/models/webhook_event_types_response_data.rb
|
|
1130
1136
|
- lib/zyphr/models/webhook_ips_response.rb
|
|
@@ -1241,6 +1247,7 @@ files:
|
|
|
1241
1247
|
- spec/models/category_list_response_spec.rb
|
|
1242
1248
|
- spec/models/category_response_spec.rb
|
|
1243
1249
|
- spec/models/category_spec.rb
|
|
1250
|
+
- spec/models/change_password_request_spec.rb
|
|
1244
1251
|
- spec/models/close_waa_s_endpoint_circuit200_response_data_spec.rb
|
|
1245
1252
|
- spec/models/close_waa_s_endpoint_circuit200_response_spec.rb
|
|
1246
1253
|
- spec/models/confirm_email_verification_request_spec.rb
|
|
@@ -1520,6 +1527,7 @@ files:
|
|
|
1520
1527
|
- spec/models/set_end_user_claims_request_spec.rb
|
|
1521
1528
|
- spec/models/set_preferences_request_preferences_inner_spec.rb
|
|
1522
1529
|
- spec/models/set_preferences_request_spec.rb
|
|
1530
|
+
- spec/models/set_self_application_test_recipients_request_spec.rb
|
|
1523
1531
|
- spec/models/sign_in_anonymously_request_spec.rb
|
|
1524
1532
|
- spec/models/sign_in_with_game_center_request_spec.rb
|
|
1525
1533
|
- spec/models/sign_in_with_google_play_games_request_spec.rb
|
|
@@ -1656,6 +1664,7 @@ files:
|
|
|
1656
1664
|
- spec/models/webhook_delivery_retry_response_data_spec.rb
|
|
1657
1665
|
- spec/models/webhook_delivery_retry_response_spec.rb
|
|
1658
1666
|
- spec/models/webhook_delivery_spec.rb
|
|
1667
|
+
- spec/models/webhook_event_type_spec.rb
|
|
1659
1668
|
- spec/models/webhook_event_types_response_data_spec.rb
|
|
1660
1669
|
- spec/models/webhook_event_types_response_spec.rb
|
|
1661
1670
|
- spec/models/webhook_ips_response_data_spec.rb
|
|
@@ -1861,6 +1870,7 @@ test_files:
|
|
|
1861
1870
|
- spec/models/unsubscribe_spec.rb
|
|
1862
1871
|
- spec/models/send_push_response_data_spec.rb
|
|
1863
1872
|
- spec/models/execution_retry_response_data_spec.rb
|
|
1873
|
+
- spec/models/set_self_application_test_recipients_request_spec.rb
|
|
1864
1874
|
- spec/models/waa_s_batch_publish_request_spec.rb
|
|
1865
1875
|
- spec/models/trigger_workflow202_response_data_spec.rb
|
|
1866
1876
|
- spec/models/auth_email_template_spec.rb
|
|
@@ -1881,6 +1891,7 @@ test_files:
|
|
|
1881
1891
|
- spec/models/mfa_verify_request_spec.rb
|
|
1882
1892
|
- spec/models/organization_membership_response_spec.rb
|
|
1883
1893
|
- spec/models/webhook_job_response_spec.rb
|
|
1894
|
+
- spec/models/webhook_event_type_spec.rb
|
|
1884
1895
|
- spec/models/update_waa_s_event_type_request_spec.rb
|
|
1885
1896
|
- spec/models/set_preferences_request_preferences_inner_spec.rb
|
|
1886
1897
|
- spec/models/update_workflow_request_spec.rb
|
|
@@ -2239,6 +2250,7 @@ test_files:
|
|
|
2239
2250
|
- spec/models/update_organization_request_spec.rb
|
|
2240
2251
|
- spec/models/send_email_otp_registration_request_spec.rb
|
|
2241
2252
|
- spec/models/reorder_workflow_steps_request_spec.rb
|
|
2253
|
+
- spec/models/change_password_request_spec.rb
|
|
2242
2254
|
- spec/models/web_authn_credential_list_response_data_spec.rb
|
|
2243
2255
|
- spec/models/send_email_request_spec.rb
|
|
2244
2256
|
- spec/models/list_end_users200_response_spec.rb
|