zyphr 0.1.43 → 0.1.44

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.
@@ -44,6 +44,18 @@ describe 'AuthUserDirectoryApi' do
44
44
  end
45
45
  end
46
46
 
47
+ # unit tests for get_end_user_auth_methods
48
+ # Get an end user's sign-in methods (server-side admin)
49
+ # 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.
50
+ # @param user_id
51
+ # @param [Hash] opts the optional parameters
52
+ # @return [GetEndUserAuthMethods200Response]
53
+ describe 'get_end_user_auth_methods test' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
56
+ end
57
+ end
58
+
47
59
  # unit tests for get_end_user_by_email
48
60
  # Look up an end user by email (server-side admin)
49
61
  # 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.
@@ -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::ApplicationSelfResponse
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Zyphr::ApplicationSelfResponse do
21
+ let(:instance) { Zyphr::ApplicationSelfResponse.new }
22
+
23
+ describe 'test an instance of ApplicationSelfResponse' do
24
+ it 'should create an instance of ApplicationSelfResponse' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Zyphr::ApplicationSelfResponse)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "data"' 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 "meta"' 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,62 @@
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::ApplicationSelf
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Zyphr::ApplicationSelf do
21
+ let(:instance) { Zyphr::ApplicationSelf.new }
22
+
23
+ describe 'test an instance of ApplicationSelf' do
24
+ it 'should create an instance of ApplicationSelf' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Zyphr::ApplicationSelf)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "id"' 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 "name"' 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 "environment"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["test", "live"])
46
+ # validator.allowable_values.each do |value|
47
+ # expect { instance.environment = value }.not_to raise_error
48
+ # end
49
+ end
50
+ end
51
+
52
+ describe 'test attribute "signing_algorithm"' do
53
+ it 'should work' do
54
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
55
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["HS256", "RS256", "ES256"])
56
+ # validator.allowable_values.each do |value|
57
+ # expect { instance.signing_algorithm = value }.not_to raise_error
58
+ # end
59
+ end
60
+ end
61
+
62
+ end
@@ -0,0 +1,66 @@
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::AuthMethods
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Zyphr::AuthMethods do
21
+ let(:instance) { Zyphr::AuthMethods.new }
22
+
23
+ describe 'test an instance of AuthMethods' do
24
+ it 'should create an instance of AuthMethods' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Zyphr::AuthMethods)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "has_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 "oauth_providers"' 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 "mfa_enabled"' 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
+ describe 'test attribute "email_verified"' do
49
+ it 'should work' do
50
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
+ end
52
+ end
53
+
54
+ describe 'test attribute "phone_verified"' do
55
+ it 'should work' do
56
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
+ end
58
+ end
59
+
60
+ describe 'test attribute "passkeys"' do
61
+ it 'should work' do
62
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
63
+ end
64
+ end
65
+
66
+ end
@@ -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::GetEndUserAuthMethods200Response
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Zyphr::GetEndUserAuthMethods200Response do
21
+ let(:instance) { Zyphr::GetEndUserAuthMethods200Response.new }
22
+
23
+ describe 'test an instance of GetEndUserAuthMethods200Response' do
24
+ it 'should create an instance of GetEndUserAuthMethods200Response' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Zyphr::GetEndUserAuthMethods200Response)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "data"' 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 "meta"' 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
data/zyphr.gemspec CHANGED
@@ -17,7 +17,7 @@ require "zyphr/version"
17
17
 
18
18
  Gem::Specification.new do |s|
19
19
  s.name = "zyphr"
20
- s.version = '0.1.43'
20
+ s.version = '0.1.44'
21
21
  s.platform = Gem::Platform::RUBY
22
22
  s.authors = ["Zyphr"]
23
23
  s.email = ["support@zyphr.dev"]
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.43
4
+ version: 0.1.44
5
5
  platform: ruby
6
6
  authors:
7
7
  - Zyphr
@@ -98,6 +98,9 @@ files:
98
98
  - docs/ApiError.md
99
99
  - docs/ApiErrorError.md
100
100
  - docs/ApiErrorMeta.md
101
+ - docs/ApplicationSelf.md
102
+ - docs/ApplicationSelfResponse.md
103
+ - docs/AuthApplicationApi.md
101
104
  - docs/AuthEmailOTPApi.md
102
105
  - docs/AuthEmailTemplate.md
103
106
  - docs/AuthEmailTemplateDefault.md
@@ -124,6 +127,7 @@ files:
124
127
  - docs/AuthLoginResultMfaChallenge.md
125
128
  - docs/AuthMFAApi.md
126
129
  - docs/AuthMagicLinksApi.md
130
+ - docs/AuthMethods.md
127
131
  - docs/AuthOAuthApi.md
128
132
  - docs/AuthOrganizationsApi.md
129
133
  - docs/AuthPasswordResetApi.md
@@ -230,6 +234,7 @@ files:
230
234
  - docs/GenerateWaaSPortalToken201Response.md
231
235
  - docs/GetDomain200Response.md
232
236
  - docs/GetDomain200ResponseMeta.md
237
+ - docs/GetEndUserAuthMethods200Response.md
233
238
  - docs/GetEndUserById200Response.md
234
239
  - docs/GetEndUserClaims200Response.md
235
240
  - docs/GetEndUserClaims200ResponseData.md
@@ -616,6 +621,7 @@ files:
616
621
  - docs/WorkflowsApi.md
617
622
  - git_push.sh
618
623
  - lib/zyphr.rb
624
+ - lib/zyphr/api/auth_application_api.rb
619
625
  - lib/zyphr/api/auth_email_otp_api.rb
620
626
  - lib/zyphr/api/auth_email_templates_api.rb
621
627
  - lib/zyphr/api/auth_email_verification_api.rb
@@ -665,6 +671,8 @@ files:
665
671
  - lib/zyphr/models/api_error.rb
666
672
  - lib/zyphr/models/api_error_error.rb
667
673
  - lib/zyphr/models/api_error_meta.rb
674
+ - lib/zyphr/models/application_self.rb
675
+ - lib/zyphr/models/application_self_response.rb
668
676
  - lib/zyphr/models/auth_email_template.rb
669
677
  - lib/zyphr/models/auth_email_template_default.rb
670
678
  - lib/zyphr/models/auth_email_template_default_response.rb
@@ -685,6 +693,7 @@ files:
685
693
  - lib/zyphr/models/auth_login_response.rb
686
694
  - lib/zyphr/models/auth_login_result.rb
687
695
  - lib/zyphr/models/auth_login_result_mfa_challenge.rb
696
+ - lib/zyphr/models/auth_methods.rb
688
697
  - lib/zyphr/models/auth_result.rb
689
698
  - lib/zyphr/models/auth_result_response.rb
690
699
  - lib/zyphr/models/auth_session.rb
@@ -778,6 +787,7 @@ files:
778
787
  - lib/zyphr/models/generate_waa_s_portal_token201_response.rb
779
788
  - lib/zyphr/models/get_domain200_response.rb
780
789
  - lib/zyphr/models/get_domain200_response_meta.rb
790
+ - lib/zyphr/models/get_end_user_auth_methods200_response.rb
781
791
  - lib/zyphr/models/get_end_user_by_id200_response.rb
782
792
  - lib/zyphr/models/get_end_user_claims200_response.rb
783
793
  - lib/zyphr/models/get_end_user_claims200_response_data.rb
@@ -1146,6 +1156,7 @@ files:
1146
1156
  - lib/zyphr/models/workflow_step_execution_status.rb
1147
1157
  - lib/zyphr/models/workflow_step_type.rb
1148
1158
  - lib/zyphr/version.rb
1159
+ - spec/api/auth_application_api_spec.rb
1149
1160
  - spec/api/auth_email_otp_api_spec.rb
1150
1161
  - spec/api/auth_email_templates_api_spec.rb
1151
1162
  - spec/api/auth_email_verification_api_spec.rb
@@ -1192,6 +1203,8 @@ files:
1192
1203
  - spec/models/api_error_error_spec.rb
1193
1204
  - spec/models/api_error_meta_spec.rb
1194
1205
  - spec/models/api_error_spec.rb
1206
+ - spec/models/application_self_response_spec.rb
1207
+ - spec/models/application_self_spec.rb
1195
1208
  - spec/models/auth_email_template_default_response_spec.rb
1196
1209
  - spec/models/auth_email_template_default_spec.rb
1197
1210
  - spec/models/auth_email_template_delete_response_data_spec.rb
@@ -1212,6 +1225,7 @@ files:
1212
1225
  - spec/models/auth_login_response_spec.rb
1213
1226
  - spec/models/auth_login_result_mfa_challenge_spec.rb
1214
1227
  - spec/models/auth_login_result_spec.rb
1228
+ - spec/models/auth_methods_spec.rb
1215
1229
  - spec/models/auth_result_response_spec.rb
1216
1230
  - spec/models/auth_result_spec.rb
1217
1231
  - spec/models/auth_session_spec.rb
@@ -1305,6 +1319,7 @@ files:
1305
1319
  - spec/models/generate_waa_s_portal_token201_response_spec.rb
1306
1320
  - spec/models/get_domain200_response_meta_spec.rb
1307
1321
  - spec/models/get_domain200_response_spec.rb
1322
+ - spec/models/get_end_user_auth_methods200_response_spec.rb
1308
1323
  - spec/models/get_end_user_by_id200_response_spec.rb
1309
1324
  - spec/models/get_end_user_claims200_response_data_spec.rb
1310
1325
  - spec/models/get_end_user_claims200_response_spec.rb
@@ -1721,6 +1736,7 @@ test_files:
1721
1736
  - spec/api/auth_mfa_api_spec.rb
1722
1737
  - spec/api/push_api_spec.rb
1723
1738
  - spec/api/auth_email_templates_api_spec.rb
1739
+ - spec/api/auth_application_api_spec.rb
1724
1740
  - spec/api/waa_s_portal_api_spec.rb
1725
1741
  - spec/api/auth_organizations_api_spec.rb
1726
1742
  - spec/api/sms_api_spec.rb
@@ -1834,6 +1850,7 @@ test_files:
1834
1850
  - spec/models/sms_detail_response_spec.rb
1835
1851
  - spec/models/withdraw_subscriber_consent_request_spec.rb
1836
1852
  - spec/models/invite_end_user200_response_data_spec.rb
1853
+ - spec/models/get_end_user_auth_methods200_response_spec.rb
1837
1854
  - spec/models/get_waa_s_endpoint_circuit200_response_spec.rb
1838
1855
  - spec/models/verify_email_otp_registration_request_spec.rb
1839
1856
  - spec/models/send_email_response_data_spec.rb
@@ -2081,6 +2098,7 @@ test_files:
2081
2098
  - spec/models/inbound_email_list_response_meta_spec.rb
2082
2099
  - spec/models/create_topic_request_spec.rb
2083
2100
  - spec/models/webhook_delivery_retry_response_spec.rb
2101
+ - spec/models/application_self_response_spec.rb
2084
2102
  - spec/models/sms_list_response_spec.rb
2085
2103
  - spec/models/update_end_user_by_application_request_spec.rb
2086
2104
  - spec/models/auth_login_result_spec.rb
@@ -2098,6 +2116,7 @@ test_files:
2098
2116
  - spec/models/o_auth_tokens_refresh_response_spec.rb
2099
2117
  - spec/models/delete_result_spec.rb
2100
2118
  - spec/models/sms_batch_result_summary_spec.rb
2119
+ - spec/models/application_self_spec.rb
2101
2120
  - spec/models/reset_password_request_spec.rb
2102
2121
  - spec/models/webhook_region_spec.rb
2103
2122
  - spec/models/set_preferences_request_spec.rb
@@ -2211,6 +2230,7 @@ test_files:
2211
2230
  - spec/models/batch_publish_waa_s_events201_response_spec.rb
2212
2231
  - spec/models/push_topic_subscribe_data_spec.rb
2213
2232
  - spec/models/auth_result_response_spec.rb
2233
+ - spec/models/auth_methods_spec.rb
2214
2234
  - spec/models/auth_email_template_response_spec.rb
2215
2235
  - spec/models/waa_s_portal_token_request_theme_spec.rb
2216
2236
  - spec/models/send_template_test_email202_response_data_spec.rb