Class: ZoomUs::Models::Body39

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/models/body_39.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Body39

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
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
 
# File 'lib/zoom_us/models/body_39.rb', line 67

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

  if attributes.has_key?(:'to_jid')
    self.to_jid = attributes[:'to_jid']
  end

  if attributes.has_key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.has_key?(:'content')
    self.content = attributes[:'content']
  end

  if attributes.has_key?(:'visible_to_user')
    self.visible_to_user = attributes[:'visible_to_user']
  end

  if attributes.has_key?(:'user_jid')
    self.user_jid = attributes[:'user_jid']
  end

  if attributes.has_key?(:'is_markdown_support')
    self.is_markdown_support = attributes[:'is_markdown_support']
  end
end

Instance Attribute Details

#account_id ⇒ Object

Account ID of the authorized account.



25
26
27
 
# File 'lib/zoom_us/models/body_39.rb', line 25

def 
  @account_id
end

#content ⇒ Object

JSON template describing how the message should be displayed for the user. For more information please see our ["Send Message" templates](marketplace.zoom.us/docs/guides/chatbots/sending-messages#example-request).



28
29
30
 
# File 'lib/zoom_us/models/body_39.rb', line 28

def content
  @content
end

#is_markdown_support ⇒ Object

Optional
Applies the markdown parser to your chatbot message if the value of this field is set to ‘true`.
To learn more, refer to the Chatbot message [markdown reference](marketplace.zoom.us/docs/guides/chatbots/customizing-messages/message-with-markdown).



37
38
39
 
# File 'lib/zoom_us/models/body_39.rb', line 37

def is_markdown_support
  @is_markdown_support
end

#robot_jid ⇒ Object

Robot JID created when enabling chatbot features on your marketplace app.



19
20
21
 
# File 'lib/zoom_us/models/body_39.rb', line 19

def robot_jid
  @robot_jid
end

#to_jid ⇒ Object

Unique JID of reciever. Can be a group or user.



22
23
24
 
# File 'lib/zoom_us/models/body_39.rb', line 22

def to_jid
  @to_jid
end

#user_jid ⇒ Object

Optional
The UserJID of the user on whose behalf the message is being sent. Use this field to prevent members of a channel from getting notifications that were set up by a user who has left the channel.



34
35
36
 
# File 'lib/zoom_us/models/body_39.rb', line 34

def user_jid
  @user_jid
end

#visible_to_user ⇒ Object

Optional
Allow a Chatbot to send a message to a group channel, but have only one designated person in that group channel see the message by providing the person’s UserID in this field.



31
32
33
 
# File 'lib/zoom_us/models/body_39.rb', line 31

def visible_to_user
  @visible_to_user
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/zoom_us/models/body_39.rb', line 40

def self.attribute_map
  {
    :'robot_jid' => :'robot_jid',
    :'to_jid' => :'to_jid',
    :'account_id' => :'account_id',
    :'content' => :'content',
    :'visible_to_user' => :'visible_to_user',
    :'user_jid' => :'user_jid',
    :'is_markdown_support' => :'is_markdown_support'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/zoom_us/models/body_39.rb', line 53

def self.swagger_types
  {
    :'robot_jid' => :'String',
    :'to_jid' => :'String',
    :'account_id' => :'String',
    :'content' => :'Object',
    :'visible_to_user' => :'String',
    :'user_jid' => :'String',
    :'is_markdown_support' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/zoom_us/models/body_39.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    robot_jid == o.robot_jid &&
    to_jid == o.to_jid &&
     == o. &&
    content == o.content &&
    visible_to_user == o.visible_to_user &&
    user_jid == o.user_jid &&
    is_markdown_support == o.is_markdown_support
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



185
186
187
188
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
 
# File 'lib/zoom_us/models/body_39.rb', line 185

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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/zoom_us/models/body_39.rb', line 251

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/zoom_us/models/body_39.rb', line 164

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


151
152
153
 
# File 'lib/zoom_us/models/body_39.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/zoom_us/models/body_39.rb', line 157

def hash
  [robot_jid, to_jid, , content, visible_to_user, user_jid, is_markdown_support].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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/zoom_us/models/body_39.rb', line 104

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

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

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

  if @content.nil?
    invalid_properties.push('invalid value for "content", content 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



231
232
233
 
# File 'lib/zoom_us/models/body_39.rb', line 231

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



237
238
239
240
241
242
243
244
245
 
# File 'lib/zoom_us/models/body_39.rb', line 237

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



225
226
227
 
# File 'lib/zoom_us/models/body_39.rb', line 225

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



127
128
129
130
131
132
133
 
# File 'lib/zoom_us/models/body_39.rb', line 127

def valid?
  return false if @robot_jid.nil?
  return false if @to_jid.nil?
  return false if @account_id.nil?
  return false if @content.nil?
  true
end