Class: SmoochApi::Webhook

Inherits:
Object
  • Object
show all
Defined in:
lib/smooch-api/models/webhook.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Webhook

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/smooch-api/models/webhook.rb', line 68

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?(:'_id')
    self.id = attributes[:'_id']
  end

  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?(:'secret')
    self.secret = attributes[:'secret']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  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

#id ⇒ Object

The webhook ID, generated automatically.



19
20
21
 
# File 'lib/smooch-api/models/webhook.rb', line 19

def id
  @id
end

#includeClient ⇒ Object

Specifies whether webhook payloads should include the client information associated with a conversation in webhook events.



34
35
36
 
# File 'lib/smooch-api/models/webhook.rb', line 34

def includeClient
  @includeClient
end

#includeFullAppUser ⇒ Object

Specifies whether webhook payloads should include the complete appUser schema for appUser events.



37
38
39
 
# File 'lib/smooch-api/models/webhook.rb', line 37

def includeFullAppUser
  @includeFullAppUser
end

#secret ⇒ Object

Secret which will be transmitted with each webhook invocation and can be used to verify the authenticity of the caller.



28
29
30
 
# File 'lib/smooch-api/models/webhook.rb', line 28

def secret
  @secret
end

#target ⇒ Object

URL to be called when the webhook is triggered.



22
23
24
 
# File 'lib/smooch-api/models/webhook.rb', line 22

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.



25
26
27
 
# File 'lib/smooch-api/models/webhook.rb', line 25

def triggers
  @triggers
end

#version ⇒ Object

The payload version of the webhook.



31
32
33
 
# File 'lib/smooch-api/models/webhook.rb', line 31

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/smooch-api/models/webhook.rb', line 41

def self.attribute_map
  {
    :'id' => :'_id',
    :'target' => :'target',
    :'triggers' => :'triggers',
    :'secret' => :'secret',
    :'version' => :'version',
    :'includeClient' => :'includeClient',
    :'includeFullAppUser' => :'includeFullAppUser'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/smooch-api/models/webhook.rb', line 54

def self.swagger_types
  {
    :'id' => :'String',
    :'target' => :'String',
    :'triggers' => :'Array<String>',
    :'secret' => :'String',
    :'version' => :'String',
    :'includeClient' => :'BOOLEAN',
    :'includeFullAppUser' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/smooch-api/models/webhook.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      target == o.target &&
      triggers == o.triggers &&
      secret == o.secret &&
      version == o.version &&
      includeClient == o.includeClient &&
      includeFullAppUser == o.includeFullAppUser
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/smooch-api/models/webhook.rb', line 189

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/smooch-api/models/webhook.rb', line 255

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/smooch-api/models/webhook.rb', line 168

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/smooch-api/models/webhook.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/smooch-api/models/webhook.rb', line 161

def hash
  [id, target, triggers, secret, version, includeClient, includeFullAppUser].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/smooch-api/models/webhook.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

  if @target.nil?
    invalid_properties.push("invalid value for 'target', target cannot be nil.")
  end

  if @triggers.nil?
    invalid_properties.push("invalid value for 'triggers', triggers cannot be nil.")
  end

  if @secret.nil?
    invalid_properties.push("invalid value for 'secret', secret cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



235
236
237
 
# File 'lib/smooch-api/models/webhook.rb', line 235

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
 
# File 'lib/smooch-api/models/webhook.rb', line 241

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

Returns:

  • (String) —

    String presentation of the object



229
230
231
 
# File 'lib/smooch-api/models/webhook.rb', line 229

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



131
132
133
134
135
136
137
 
# File 'lib/smooch-api/models/webhook.rb', line 131

def valid?
  return false if @id.nil?
  return false if @target.nil?
  return false if @triggers.nil?
  return false if @secret.nil?
  return true
end