Class: SunshineConversationsClient::Webhook

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/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



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
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 70

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::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 `SunshineConversationsClient::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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  end

  if attributes.key?(:'target')
    self.target = attributes[:'target']
  end

  if attributes.key?(:'triggers')
    if (value = attributes[:'triggers']).is_a?(Array)
      self.triggers = value
    end
  end

  if attributes.key?(:'secret')
    self.secret = attributes[:'secret']
  end

  if attributes.key?(:'include_full_user')
    self.include_full_user = attributes[:'include_full_user']
  else
    self.include_full_user = false
  end

  if attributes.key?(:'include_full_source')
    self.include_full_source = attributes[:'include_full_source']
  else
    self.include_full_source = false
  end
end

Instance Attribute Details

#id ⇒ Object

A unique identifier for the webhook.



16
17
18
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 16

def id
  @id
end

#include_full_source ⇒ Object

A boolean specifying whether webhook payloads should include the client and device object (when applicable).



34
35
36
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 34

def include_full_source
  @include_full_source
end

#include_full_user ⇒ Object

A boolean specifying whether webhook payloads should include the complete user schema for events involving a specific user.



31
32
33
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 31

def include_full_user
  @include_full_user
end

#secret ⇒ Object

Webhook secret, used to verify the origin of incoming requests.



28
29
30
 
# File 'lib/sunshine-conversations-client/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/sunshine-conversations-client/models/webhook.rb', line 22

def target
  @target
end

#triggers ⇒ Object

An array of triggers the integration is subscribed to. This property is case sensitive. [More details](developer.zendesk.com/api-reference/conversations/#section/Webhook-Triggers).



25
26
27
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 25

def triggers
  @triggers
end

#version ⇒ Object

Schema version of the payload delivered to this webhook. Can be ‘v1`, `v1.1` or `v2`.



19
20
21
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 19

def version
  @version
end

Class Method Details

._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



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
226
227
228
229
230
231
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 194

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 = SunshineConversationsClient.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

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 37

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'target' => :'target',
    :'triggers' => :'triggers',
    :'secret' => :'secret',
    :'include_full_user' => :'includeFullUser',
    :'include_full_source' => :'includeFullSource'
  }
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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 170

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



63
64
65
66
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 63

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 50

def self.openapi_types
  {
    :'id' => :'String',
    :'version' => :'String',
    :'target' => :'String',
    :'triggers' => :'Array<String>',
    :'secret' => :'String',
    :'include_full_user' => :'Boolean',
    :'include_full_source' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      target == o.target &&
      triggers == o.triggers &&
      secret == o.secret &&
      include_full_user == o.include_full_user &&
      include_full_source == o.include_full_source
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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 265

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 163

def hash
  [idversiontargettriggerssecretinclude_full_userinclude_full_source].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  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

  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



241
242
243
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 241

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 247

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

Returns:

  • (String) —

    String presentation of the object



235
236
237
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 235

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



135
136
137
138
139
 
# File 'lib/sunshine-conversations-client/models/webhook.rb', line 135

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