Class: SmoochApi::WebhookCreate
- Inherits:
-
Object
- Object
- SmoochApi::WebhookCreate
- Defined in:
- lib/smooch-api/models/webhook_create.rb
Instance Attribute Summary collapse
-
#includeClient ⇒ Object
Specifies whether webhook payloads should include the client information associated with a conversation in webhook events.
-
#includeFullAppUser ⇒ Object
Specifies whether webhook payloads should include the complete appUser schema for appUser events.
-
#target ⇒ Object
URL to be called when the webhook is triggered.
-
#triggers ⇒ Object
An array of triggers you wish to have the webhook listen to.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ WebhookCreate
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 = {}) ⇒ WebhookCreate
Initializes the object
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/smooch-api/models/webhook_create.rb', line 53 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'target') self.target = attributes[:'target'] end if attributes.has_key?(:'triggers') if (value = attributes[:'triggers']).is_a?(Array) self.triggers = value end end if attributes.has_key?(:'includeClient') self.includeClient = attributes[:'includeClient'] end if attributes.has_key?(:'includeFullAppUser') self.includeFullAppUser = attributes[:'includeFullAppUser'] end end |
Instance Attribute Details
#includeClient ⇒ Object
Specifies whether webhook payloads should include the client information associated with a conversation in webhook events.
25 26 27 |
# File 'lib/smooch-api/models/webhook_create.rb', line 25 def includeClient @includeClient end |
#includeFullAppUser ⇒ Object
Specifies whether webhook payloads should include the complete appUser schema for appUser events.
28 29 30 |
# File 'lib/smooch-api/models/webhook_create.rb', line 28 def includeFullAppUser @includeFullAppUser end |
#target ⇒ Object
URL to be called when the webhook is triggered.
19 20 21 |
# File 'lib/smooch-api/models/webhook_create.rb', line 19 def target @target end |
#triggers ⇒ Object
An array of triggers you wish to have the webhook listen to. See [WebhookTriggersEnum](Enums.md#WebhookTriggersEnum) for available values.
22 23 24 |
# File 'lib/smooch-api/models/webhook_create.rb', line 22 def triggers @triggers end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
32 33 34 35 36 37 38 39 |
# File 'lib/smooch-api/models/webhook_create.rb', line 32 def self.attribute_map { :'target' => :'target', :'triggers' => :'triggers', :'includeClient' => :'includeClient', :'includeFullAppUser' => :'includeFullAppUser' } end |
.swagger_types ⇒ Object
Attribute type mapping.
42 43 44 45 46 47 48 49 |
# File 'lib/smooch-api/models/webhook_create.rb', line 42 def self.swagger_types { :'target' => :'String', :'triggers' => :'Array<String>', :'includeClient' => :'BOOLEAN', :'includeFullAppUser' => :'BOOLEAN' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
99 100 101 102 103 104 105 106 |
# File 'lib/smooch-api/models/webhook_create.rb', line 99 def ==(o) return true if self.equal?(o) self.class == o.class && target == o.target && triggers == o.triggers && includeClient == o.includeClient && includeFullAppUser == o.includeFullAppUser end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/smooch-api/models/webhook_create.rb', line 144 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = SmoochApi.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/smooch-api/models/webhook_create.rb', line 210 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/smooch-api/models/webhook_create.rb', line 123 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
110 111 112 |
# File 'lib/smooch-api/models/webhook_create.rb', line 110 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
116 117 118 |
# File 'lib/smooch-api/models/webhook_create.rb', line 116 def hash [target, triggers, includeClient, includeFullAppUser].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
81 82 83 84 85 86 87 88 |
# File 'lib/smooch-api/models/webhook_create.rb', line 81 def list_invalid_properties invalid_properties = Array.new if @target.nil? invalid_properties.push("invalid value for 'target', target cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
190 191 192 |
# File 'lib/smooch-api/models/webhook_create.rb', line 190 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
196 197 198 199 200 201 202 203 204 |
# File 'lib/smooch-api/models/webhook_create.rb', line 196 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
184 185 186 |
# File 'lib/smooch-api/models/webhook_create.rb', line 184 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
92 93 94 95 |
# File 'lib/smooch-api/models/webhook_create.rb', line 92 def valid? return false if @target.nil? return true end |