zyphr 0.1.48 → 0.1.49
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 -1
- data/docs/PasswordPolicy.md +30 -0
- data/docs/PasswordRequirementsResponseData.md +3 -1
- data/docs/PasswordStrength.md +24 -0
- data/docs/PasswordStrengthRequest.md +20 -0
- data/docs/PasswordStrengthResponse.md +20 -0
- data/docs/UtilityApi.md +73 -1
- data/lib/zyphr/api/utility_api.rb +70 -2
- data/lib/zyphr/models/password_policy.rb +401 -0
- data/lib/zyphr/models/password_requirements_response_data.rb +49 -3
- data/lib/zyphr/models/password_strength.rb +363 -0
- data/lib/zyphr/models/{password_requirements.rb → password_strength_request.rb} +36 -52
- data/lib/zyphr/models/password_strength_response.rb +229 -0
- data/lib/zyphr.rb +4 -1
- data/spec/api/utility_api_spec.rb +13 -1
- data/spec/models/{password_requirements_spec.rb → password_policy_spec.rb} +12 -6
- data/spec/models/password_requirements_response_data_spec.rb +6 -0
- data/spec/models/password_strength_request_spec.rb +42 -0
- data/spec/models/password_strength_response_spec.rb +42 -0
- data/spec/models/password_strength_spec.rb +58 -0
- data/zyphr.gemspec +1 -1
- metadata +18 -6
- data/docs/PasswordRequirements.md +0 -28
|
@@ -0,0 +1,229 @@
|
|
|
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 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module Zyphr
|
|
17
|
+
class PasswordStrengthResponse
|
|
18
|
+
attr_accessor :data
|
|
19
|
+
|
|
20
|
+
attr_accessor :meta
|
|
21
|
+
|
|
22
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
23
|
+
def self.attribute_map
|
|
24
|
+
{
|
|
25
|
+
:'data' => :'data',
|
|
26
|
+
:'meta' => :'meta'
|
|
27
|
+
}
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# Returns attribute mapping this model knows about
|
|
31
|
+
def self.acceptable_attribute_map
|
|
32
|
+
attribute_map
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Returns all the JSON keys this model knows about
|
|
36
|
+
def self.acceptable_attributes
|
|
37
|
+
acceptable_attribute_map.values
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Attribute type mapping.
|
|
41
|
+
def self.openapi_types
|
|
42
|
+
{
|
|
43
|
+
:'data' => :'PasswordStrength',
|
|
44
|
+
:'meta' => :'RequestMeta'
|
|
45
|
+
}
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# List of attributes with nullable: true
|
|
49
|
+
def self.openapi_nullable
|
|
50
|
+
Set.new([
|
|
51
|
+
])
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
# Initializes the object
|
|
55
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
56
|
+
def initialize(attributes = {})
|
|
57
|
+
if (!attributes.is_a?(Hash))
|
|
58
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::PasswordStrengthResponse` initialize method"
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
62
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
63
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
64
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
65
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::PasswordStrengthResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
66
|
+
end
|
|
67
|
+
h[k.to_sym] = v
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
if attributes.key?(:'data')
|
|
71
|
+
self.data = attributes[:'data']
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
if attributes.key?(:'meta')
|
|
75
|
+
self.meta = attributes[:'meta']
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
80
|
+
# @return Array for valid properties with the reasons
|
|
81
|
+
def list_invalid_properties
|
|
82
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
83
|
+
invalid_properties = Array.new
|
|
84
|
+
invalid_properties
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Check to see if the all the properties in the model are valid
|
|
88
|
+
# @return true if the model is valid
|
|
89
|
+
def valid?
|
|
90
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
91
|
+
true
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Checks equality by comparing each attribute.
|
|
95
|
+
# @param [Object] Object to be compared
|
|
96
|
+
def ==(o)
|
|
97
|
+
return true if self.equal?(o)
|
|
98
|
+
self.class == o.class &&
|
|
99
|
+
data == o.data &&
|
|
100
|
+
meta == o.meta
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# @see the `==` method
|
|
104
|
+
# @param [Object] Object to be compared
|
|
105
|
+
def eql?(o)
|
|
106
|
+
self == o
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Calculates hash code according to all attributes.
|
|
110
|
+
# @return [Integer] Hash code
|
|
111
|
+
def hash
|
|
112
|
+
[data, meta].hash
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# Builds the object from hash
|
|
116
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
117
|
+
# @return [Object] Returns the model itself
|
|
118
|
+
def self.build_from_hash(attributes)
|
|
119
|
+
return nil unless attributes.is_a?(Hash)
|
|
120
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
121
|
+
transformed_hash = {}
|
|
122
|
+
openapi_types.each_pair do |key, type|
|
|
123
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
124
|
+
transformed_hash["#{key}"] = nil
|
|
125
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
126
|
+
# check to ensure the input is an array given that the attribute
|
|
127
|
+
# is documented as an array but the input is not
|
|
128
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
129
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
130
|
+
end
|
|
131
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
132
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
133
|
+
end
|
|
134
|
+
end
|
|
135
|
+
new(transformed_hash)
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# Deserializes the data based on type
|
|
139
|
+
# @param string type Data type
|
|
140
|
+
# @param string value Value to be deserialized
|
|
141
|
+
# @return [Object] Deserialized data
|
|
142
|
+
def self._deserialize(type, value)
|
|
143
|
+
case type.to_sym
|
|
144
|
+
when :Time
|
|
145
|
+
Time.parse(value)
|
|
146
|
+
when :Date
|
|
147
|
+
Date.parse(value)
|
|
148
|
+
when :String
|
|
149
|
+
value.to_s
|
|
150
|
+
when :Integer
|
|
151
|
+
value.to_i
|
|
152
|
+
when :Float
|
|
153
|
+
value.to_f
|
|
154
|
+
when :Boolean
|
|
155
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
156
|
+
true
|
|
157
|
+
else
|
|
158
|
+
false
|
|
159
|
+
end
|
|
160
|
+
when :Object
|
|
161
|
+
# generic object (usually a Hash), return directly
|
|
162
|
+
value
|
|
163
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
164
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
165
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
166
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
167
|
+
k_type = Regexp.last_match[:k_type]
|
|
168
|
+
v_type = Regexp.last_match[:v_type]
|
|
169
|
+
{}.tap do |hash|
|
|
170
|
+
value.each do |k, v|
|
|
171
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
else # model
|
|
175
|
+
# models (e.g. Pet) or oneOf
|
|
176
|
+
klass = Zyphr.const_get(type)
|
|
177
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
178
|
+
end
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# Returns the string representation of the object
|
|
182
|
+
# @return [String] String presentation of the object
|
|
183
|
+
def to_s
|
|
184
|
+
to_hash.to_s
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
188
|
+
# @return [Hash] Returns the object in the form of hash
|
|
189
|
+
def to_body
|
|
190
|
+
to_hash
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# Returns the object in the form of hash
|
|
194
|
+
# @return [Hash] Returns the object in the form of hash
|
|
195
|
+
def to_hash
|
|
196
|
+
hash = {}
|
|
197
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
198
|
+
value = self.send(attr)
|
|
199
|
+
if value.nil?
|
|
200
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
201
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
hash[param] = _to_hash(value)
|
|
205
|
+
end
|
|
206
|
+
hash
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# Outputs non-array value in the form of hash
|
|
210
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
211
|
+
# @param [Object] value Any valid value
|
|
212
|
+
# @return [Hash] Returns the value in the form of hash
|
|
213
|
+
def _to_hash(value)
|
|
214
|
+
if value.is_a?(Array)
|
|
215
|
+
value.compact.map { |v| _to_hash(v) }
|
|
216
|
+
elsif value.is_a?(Hash)
|
|
217
|
+
{}.tap do |hash|
|
|
218
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
219
|
+
end
|
|
220
|
+
elsif value.respond_to? :to_hash
|
|
221
|
+
value.to_hash
|
|
222
|
+
else
|
|
223
|
+
value
|
|
224
|
+
end
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
end
|
data/lib/zyphr.rb
CHANGED
|
@@ -246,9 +246,12 @@ require 'zyphr/models/organization_membership_response'
|
|
|
246
246
|
require 'zyphr/models/organization_membership_with_user'
|
|
247
247
|
require 'zyphr/models/organization_response'
|
|
248
248
|
require 'zyphr/models/pagination_meta'
|
|
249
|
-
require 'zyphr/models/
|
|
249
|
+
require 'zyphr/models/password_policy'
|
|
250
250
|
require 'zyphr/models/password_requirements_response'
|
|
251
251
|
require 'zyphr/models/password_requirements_response_data'
|
|
252
|
+
require 'zyphr/models/password_strength'
|
|
253
|
+
require 'zyphr/models/password_strength_request'
|
|
254
|
+
require 'zyphr/models/password_strength_response'
|
|
252
255
|
require 'zyphr/models/payload_too_large_error'
|
|
253
256
|
require 'zyphr/models/payload_too_large_error_error'
|
|
254
257
|
require 'zyphr/models/payload_too_large_error_error_details'
|
|
@@ -32,9 +32,21 @@ describe 'UtilityApi' do
|
|
|
32
32
|
end
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
+
# unit tests for check_password_strength
|
|
36
|
+
# Check password strength
|
|
37
|
+
# Pre-submit password check for a live registration/reset experience. Returns whether the password would be accepted by the server (`valid`), a strength `score` (0-100) and `label`, and actionable `feedback`. When an `email` is supplied, a password that resembles the email's local-part is flagged and marked invalid. The password is never logged or persisted.
|
|
38
|
+
# @param password_strength_request
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [PasswordStrengthResponse]
|
|
41
|
+
describe 'check_password_strength 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 get_password_requirements
|
|
36
48
|
# Get password requirements
|
|
37
|
-
# Get password requirements for the application. Useful for client-side validation before registration.
|
|
49
|
+
# Get password requirements for the application. Returns both a structured `policy` object (for driving a live requirements checklist) and human-readable `requirements` display strings. Useful for client-side validation before registration.
|
|
38
50
|
# @param [Hash] opts the optional parameters
|
|
39
51
|
# @return [PasswordRequirementsResponse]
|
|
40
52
|
describe 'get_password_requirements test' do
|
|
@@ -14,16 +14,16 @@ require 'spec_helper'
|
|
|
14
14
|
require 'json'
|
|
15
15
|
require 'date'
|
|
16
16
|
|
|
17
|
-
# Unit tests for Zyphr::
|
|
17
|
+
# Unit tests for Zyphr::PasswordPolicy
|
|
18
18
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
19
|
# Please update as you see appropriate
|
|
20
|
-
describe Zyphr::
|
|
21
|
-
let(:instance) { Zyphr::
|
|
20
|
+
describe Zyphr::PasswordPolicy do
|
|
21
|
+
let(:instance) { Zyphr::PasswordPolicy.new }
|
|
22
22
|
|
|
23
|
-
describe 'test an instance of
|
|
24
|
-
it 'should create an instance of
|
|
23
|
+
describe 'test an instance of PasswordPolicy' do
|
|
24
|
+
it 'should create an instance of PasswordPolicy' do
|
|
25
25
|
# uncomment below to test the instance creation
|
|
26
|
-
#expect(instance).to be_instance_of(Zyphr::
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::PasswordPolicy)
|
|
27
27
|
end
|
|
28
28
|
end
|
|
29
29
|
|
|
@@ -63,4 +63,10 @@ describe Zyphr::PasswordRequirements do
|
|
|
63
63
|
end
|
|
64
64
|
end
|
|
65
65
|
|
|
66
|
+
describe 'test attribute "disallow_common"' do
|
|
67
|
+
it 'should work' do
|
|
68
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
|
|
66
72
|
end
|
|
@@ -27,6 +27,12 @@ describe Zyphr::PasswordRequirementsResponseData do
|
|
|
27
27
|
end
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
+
describe 'test attribute "policy"' 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
|
+
|
|
30
36
|
describe 'test attribute "requirements"' do
|
|
31
37
|
it 'should work' do
|
|
32
38
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -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::PasswordStrengthRequest
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::PasswordStrengthRequest do
|
|
21
|
+
let(:instance) { Zyphr::PasswordStrengthRequest.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of PasswordStrengthRequest' do
|
|
24
|
+
it 'should create an instance of PasswordStrengthRequest' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::PasswordStrengthRequest)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "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 "email"' 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,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::PasswordStrengthResponse
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::PasswordStrengthResponse do
|
|
21
|
+
let(:instance) { Zyphr::PasswordStrengthResponse.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of PasswordStrengthResponse' do
|
|
24
|
+
it 'should create an instance of PasswordStrengthResponse' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::PasswordStrengthResponse)
|
|
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,58 @@
|
|
|
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::PasswordStrength
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zyphr::PasswordStrength do
|
|
21
|
+
let(:instance) { Zyphr::PasswordStrength.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of PasswordStrength' do
|
|
24
|
+
it 'should create an instance of PasswordStrength' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zyphr::PasswordStrength)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "valid"' 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 "score"' 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 "label"' 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', ["weak", "fair", "good", "strong"])
|
|
46
|
+
# validator.allowable_values.each do |value|
|
|
47
|
+
# expect { instance.label = value }.not_to raise_error
|
|
48
|
+
# end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
describe 'test attribute "feedback"' do
|
|
53
|
+
it 'should work' do
|
|
54
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
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.49
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Zyphr
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-08-
|
|
11
|
+
date: 2026-08-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|
|
@@ -339,9 +339,12 @@ files:
|
|
|
339
339
|
- docs/OrganizationMembershipWithUser.md
|
|
340
340
|
- docs/OrganizationResponse.md
|
|
341
341
|
- docs/PaginationMeta.md
|
|
342
|
-
- docs/
|
|
342
|
+
- docs/PasswordPolicy.md
|
|
343
343
|
- docs/PasswordRequirementsResponse.md
|
|
344
344
|
- docs/PasswordRequirementsResponseData.md
|
|
345
|
+
- docs/PasswordStrength.md
|
|
346
|
+
- docs/PasswordStrengthRequest.md
|
|
347
|
+
- docs/PasswordStrengthResponse.md
|
|
345
348
|
- docs/PayloadTooLargeError.md
|
|
346
349
|
- docs/PayloadTooLargeErrorError.md
|
|
347
350
|
- docs/PayloadTooLargeErrorErrorDetails.md
|
|
@@ -893,9 +896,12 @@ files:
|
|
|
893
896
|
- lib/zyphr/models/organization_membership_with_user.rb
|
|
894
897
|
- lib/zyphr/models/organization_response.rb
|
|
895
898
|
- lib/zyphr/models/pagination_meta.rb
|
|
896
|
-
- lib/zyphr/models/
|
|
899
|
+
- lib/zyphr/models/password_policy.rb
|
|
897
900
|
- lib/zyphr/models/password_requirements_response.rb
|
|
898
901
|
- lib/zyphr/models/password_requirements_response_data.rb
|
|
902
|
+
- lib/zyphr/models/password_strength.rb
|
|
903
|
+
- lib/zyphr/models/password_strength_request.rb
|
|
904
|
+
- lib/zyphr/models/password_strength_response.rb
|
|
899
905
|
- lib/zyphr/models/payload_too_large_error.rb
|
|
900
906
|
- lib/zyphr/models/payload_too_large_error_error.rb
|
|
901
907
|
- lib/zyphr/models/payload_too_large_error_error_details.rb
|
|
@@ -1428,9 +1434,12 @@ files:
|
|
|
1428
1434
|
- spec/models/organization_response_spec.rb
|
|
1429
1435
|
- spec/models/organization_spec.rb
|
|
1430
1436
|
- spec/models/pagination_meta_spec.rb
|
|
1437
|
+
- spec/models/password_policy_spec.rb
|
|
1431
1438
|
- spec/models/password_requirements_response_data_spec.rb
|
|
1432
1439
|
- spec/models/password_requirements_response_spec.rb
|
|
1433
|
-
- spec/models/
|
|
1440
|
+
- spec/models/password_strength_request_spec.rb
|
|
1441
|
+
- spec/models/password_strength_response_spec.rb
|
|
1442
|
+
- spec/models/password_strength_spec.rb
|
|
1434
1443
|
- spec/models/payload_too_large_error_error_details_spec.rb
|
|
1435
1444
|
- spec/models/payload_too_large_error_error_spec.rb
|
|
1436
1445
|
- spec/models/payload_too_large_error_spec.rb
|
|
@@ -2061,6 +2070,7 @@ test_files:
|
|
|
2061
2070
|
- spec/models/webhook_circuit_state_response_spec.rb
|
|
2062
2071
|
- spec/models/switch_organization_request_spec.rb
|
|
2063
2072
|
- spec/models/mfa_enrollment_response_spec.rb
|
|
2073
|
+
- spec/models/password_strength_request_spec.rb
|
|
2064
2074
|
- spec/models/forgot_password_request_spec.rb
|
|
2065
2075
|
- spec/models/update_subscriber_preferences200_response_data_preferences_inner_spec.rb
|
|
2066
2076
|
- spec/models/invite_end_user200_response_spec.rb
|
|
@@ -2084,6 +2094,7 @@ test_files:
|
|
|
2084
2094
|
- spec/models/get_end_user_claims200_response_spec.rb
|
|
2085
2095
|
- spec/models/send_batch_in_app_meta_spec.rb
|
|
2086
2096
|
- spec/models/auth_email_template_versions_response_spec.rb
|
|
2097
|
+
- spec/models/password_strength_response_spec.rb
|
|
2087
2098
|
- spec/models/create_workflow_request_spec.rb
|
|
2088
2099
|
- spec/models/send_sms_data_spec.rb
|
|
2089
2100
|
- spec/models/waa_s_batch_publish_response_spec.rb
|
|
@@ -2092,6 +2103,7 @@ test_files:
|
|
|
2092
2103
|
- spec/models/auth_email_template_test_result_spec.rb
|
|
2093
2104
|
- spec/models/get_waa_s_delivery200_response_spec.rb
|
|
2094
2105
|
- spec/models/webhook_secret_rotate_response_data_spec.rb
|
|
2106
|
+
- spec/models/password_policy_spec.rb
|
|
2095
2107
|
- spec/models/delete_workflow_step200_response_data_spec.rb
|
|
2096
2108
|
- spec/models/list_workflow_executions200_response_spec.rb
|
|
2097
2109
|
- spec/models/create_waa_s_application_request_spec.rb
|
|
@@ -2132,7 +2144,6 @@ test_files:
|
|
|
2132
2144
|
- spec/models/webhook_region_spec.rb
|
|
2133
2145
|
- spec/models/set_preferences_request_spec.rb
|
|
2134
2146
|
- spec/models/create_organization_request_spec.rb
|
|
2135
|
-
- spec/models/password_requirements_spec.rb
|
|
2136
2147
|
- spec/models/o_auth_provider_name_spec.rb
|
|
2137
2148
|
- spec/models/webhook_secret_rotate_response_spec.rb
|
|
2138
2149
|
- spec/models/get_subscriber_inbox_preferences200_response_data_global_spec.rb
|
|
@@ -2231,6 +2242,7 @@ test_files:
|
|
|
2231
2242
|
- spec/models/send_slack_message_response_spec.rb
|
|
2232
2243
|
- spec/models/consent_record_response_spec.rb
|
|
2233
2244
|
- spec/models/send_push_request_action_buttons_inner_spec.rb
|
|
2245
|
+
- spec/models/password_strength_spec.rb
|
|
2234
2246
|
- spec/models/send_template_test_email202_response_spec.rb
|
|
2235
2247
|
- spec/models/template_response_spec.rb
|
|
2236
2248
|
- spec/models/inbound_email_response_spec.rb
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# Zyphr::PasswordRequirements
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **min_length** | **Integer** | | [optional] |
|
|
8
|
-
| **max_length** | **Integer** | | [optional] |
|
|
9
|
-
| **require_uppercase** | **Boolean** | | [optional] |
|
|
10
|
-
| **require_lowercase** | **Boolean** | | [optional] |
|
|
11
|
-
| **require_numbers** | **Boolean** | | [optional] |
|
|
12
|
-
| **require_special** | **Boolean** | | [optional] |
|
|
13
|
-
|
|
14
|
-
## Example
|
|
15
|
-
|
|
16
|
-
```ruby
|
|
17
|
-
require 'zyphr'
|
|
18
|
-
|
|
19
|
-
instance = Zyphr::PasswordRequirements.new(
|
|
20
|
-
min_length: null,
|
|
21
|
-
max_length: null,
|
|
22
|
-
require_uppercase: null,
|
|
23
|
-
require_lowercase: null,
|
|
24
|
-
require_numbers: null,
|
|
25
|
-
require_special: null
|
|
26
|
-
)
|
|
27
|
-
```
|
|
28
|
-
|