Class: Daily::Webhook
- Inherits:
-
Object
- Object
- Daily::Webhook
- Defined in:
- lib/daily-ruby/models/webhook.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#basic_auth ⇒ Object
The basic auth credentials that will be used to POST to the webhook URL.
-
#created_at ⇒ Object
The ISO 8601 time of when this webhook was created.
-
#domain_id ⇒ Object
The domain ID this webhook is associated with.
-
#event_types ⇒ Object
The set of event types this webhook is subscribed to.
-
#failed_count ⇒ Object
The number of consecutive failures this webhook has made.
-
#hmac ⇒ Object
A secret that can be used to verify the signature of the webhook.
-
#last_moment_pushed ⇒ Object
The ISO 8601 time of the last moment an event was pushed to the webhook server.
-
#retry_type ⇒ Object
The retry configuration for this webhook endpoint to use.
-
#state ⇒ Object
The current state of the webhook.
-
#updated_at ⇒ Object
The ISO 8601 time of when this webhook was last updated.
-
#url ⇒ Object
The webhook server endpoint that was provided.
-
#uuid ⇒ Object
The unique identifier for this webhook.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Webhook
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Webhook
Initializes the object
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/daily-ruby/models/webhook.rb', line 125 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::Webhook` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Daily::Webhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'uuid') self.uuid = attributes[:'uuid'] end if attributes.key?(:'url') self.url = attributes[:'url'] end if attributes.key?(:'hmac') self.hmac = attributes[:'hmac'] end if attributes.key?(:'basic_auth') self.basic_auth = attributes[:'basic_auth'] end if attributes.key?(:'retry_type') self.retry_type = attributes[:'retry_type'] end if attributes.key?(:'event_types') if (value = attributes[:'event_types']).is_a?(Array) self.event_types = value end end if attributes.key?(:'state') self.state = attributes[:'state'] end if attributes.key?(:'failed_count') self.failed_count = attributes[:'failed_count'] end if attributes.key?(:'last_moment_pushed') self.last_moment_pushed = attributes[:'last_moment_pushed'] end if attributes.key?(:'domain_id') self.domain_id = attributes[:'domain_id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end end |
Instance Attribute Details
#basic_auth ⇒ Object
The basic auth credentials that will be used to POST to the webhook URL.
28 29 30 |
# File 'lib/daily-ruby/models/webhook.rb', line 28 def basic_auth @basic_auth end |
#created_at ⇒ Object
The ISO 8601 time of when this webhook was created.
49 50 51 |
# File 'lib/daily-ruby/models/webhook.rb', line 49 def created_at @created_at end |
#domain_id ⇒ Object
The domain ID this webhook is associated with.
46 47 48 |
# File 'lib/daily-ruby/models/webhook.rb', line 46 def domain_id @domain_id end |
#event_types ⇒ Object
The set of event types this webhook is subscribed to.
34 35 36 |
# File 'lib/daily-ruby/models/webhook.rb', line 34 def event_types @event_types end |
#failed_count ⇒ Object
The number of consecutive failures this webhook has made.
40 41 42 |
# File 'lib/daily-ruby/models/webhook.rb', line 40 def failed_count @failed_count end |
#hmac ⇒ Object
A secret that can be used to verify the signature of the webhook.
25 26 27 |
# File 'lib/daily-ruby/models/webhook.rb', line 25 def hmac @hmac end |
#last_moment_pushed ⇒ Object
The ISO 8601 time of the last moment an event was pushed to the webhook server.
43 44 45 |
# File 'lib/daily-ruby/models/webhook.rb', line 43 def last_moment_pushed @last_moment_pushed end |
#retry_type ⇒ Object
The retry configuration for this webhook endpoint to use. The default is circuit-breaker.
31 32 33 |
# File 'lib/daily-ruby/models/webhook.rb', line 31 def retry_type @retry_type end |
#state ⇒ Object
The current state of the webhook. "FAILED" | "INACTIVE"
37 38 39 |
# File 'lib/daily-ruby/models/webhook.rb', line 37 def state @state end |
#updated_at ⇒ Object
The ISO 8601 time of when this webhook was last updated.
52 53 54 |
# File 'lib/daily-ruby/models/webhook.rb', line 52 def updated_at @updated_at end |
#url ⇒ Object
The webhook server endpoint that was provided.
22 23 24 |
# File 'lib/daily-ruby/models/webhook.rb', line 22 def url @url end |
#uuid ⇒ Object
The unique identifier for this webhook.
19 20 21 |
# File 'lib/daily-ruby/models/webhook.rb', line 19 def uuid @uuid end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/daily-ruby/models/webhook.rb', line 274 def self._deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Daily.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
95 96 97 |
# File 'lib/daily-ruby/models/webhook.rb', line 95 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/daily-ruby/models/webhook.rb', line 77 def self.attribute_map { :'uuid' => :'uuid', :'url' => :'url', :'hmac' => :'hmac', :'basic_auth' => :'basicAuth', :'retry_type' => :'retryType', :'event_types' => :'eventTypes', :'state' => :'state', :'failed_count' => :'failedCount', :'last_moment_pushed' => :'lastMomentPushed', :'domain_id' => :'domainId', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/daily-ruby/models/webhook.rb', line 250 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
118 119 120 121 |
# File 'lib/daily-ruby/models/webhook.rb', line 118 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/daily-ruby/models/webhook.rb', line 100 def self.openapi_types { :'uuid' => :'String', :'url' => :'String', :'hmac' => :'String', :'basic_auth' => :'String', :'retry_type' => :'String', :'event_types' => :'Array<String>', :'state' => :'String', :'failed_count' => :'Float', :'last_moment_pushed' => :'String', :'domain_id' => :'String', :'created_at' => :'String', :'updated_at' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/daily-ruby/models/webhook.rb', line 218 def ==(o) return true if self.equal?(o) self.class == o.class && uuid == o.uuid && url == o.url && hmac == o.hmac && basic_auth == o.basic_auth && retry_type == o.retry_type && event_types == o.event_types && state == o.state && failed_count == o.failed_count && last_moment_pushed == o.last_moment_pushed && domain_id == o.domain_id && created_at == o.created_at && updated_at == o.updated_at end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/daily-ruby/models/webhook.rb', line 345 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#eql?(o) ⇒ Boolean
237 238 239 |
# File 'lib/daily-ruby/models/webhook.rb', line 237 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
243 244 245 |
# File 'lib/daily-ruby/models/webhook.rb', line 243 def hash [uuid, url, hmac, basic_auth, retry_type, event_types, state, failed_count, last_moment_pushed, domain_id, created_at, updated_at].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
191 192 193 194 195 |
# File 'lib/daily-ruby/models/webhook.rb', line 191 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
321 322 323 |
# File 'lib/daily-ruby/models/webhook.rb', line 321 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/daily-ruby/models/webhook.rb', line 327 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
315 316 317 |
# File 'lib/daily-ruby/models/webhook.rb', line 315 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
199 200 201 202 203 204 |
# File 'lib/daily-ruby/models/webhook.rb', line 199 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' retry_type_validator = EnumAttributeValidator.new('String', ["circuit-breaker", "exponential", "unknown_default_open_api"]) return false unless retry_type_validator.valid?(@retry_type) true end |