Class: SunshineConversationsClient::TextMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/text_message.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TextMessage

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
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 70

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

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

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

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

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

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

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

Instance Attribute Details

#actions ⇒ Object

Array of message actions.



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

def actions
  @actions
end

#block_chat_input ⇒ Object

When set to true, the chat input will be disabled on supported client implementations when the message is the most recent one in the history. Can be used for guided flows or to temporarily disable the user’s ability to send messages in the conversation.



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

def block_chat_input
  @block_chat_input
end

#html_text ⇒ Object

HTML text content of the message. Can be provided in place of ‘text`. Cannot be used with `markdownText`. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#rich-text) documentation for more information.



22
23
24
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 22

def html_text
  @html_text
end

#markdown_text ⇒ Object

Markdown text content of the message. Can be provided in place of ‘text`. Cannot be used with `htmlText`. Will be converted to `htmlText` upon reception. If converted `htmlText` exceeds 4096 characters, the message will be rejected. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#rich-text) documentation for more information.



28
29
30
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 28

def markdown_text
  @markdown_text
end

#payload ⇒ Object

The payload of a [reply button](developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/structured-messages/#reply-buttons) response message.



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

def payload
  @payload
end

#text ⇒ Object

The text content of the message. Required unless ‘actions`, `htmlText` or `markdownText` is provided.



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

def text
  @text
end

#type ⇒ Object

The type of message.



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

def type
  @type
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 232

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/text_message.rb', line 37

def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'html_text' => :'htmlText',
    :'block_chat_input' => :'blockChatInput',
    :'markdown_text' => :'markdownText',
    :'actions' => :'actions',
    :'payload' => :'payload'
  }
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 208

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/text_message.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/text_message.rb', line 50

def self.openapi_types
  {
    :'type' => :'String',
    :'text' => :'String',
    :'html_text' => :'String',
    :'block_chat_input' => :'Boolean',
    :'markdown_text' => :'String',
    :'actions' => :'Array<Action>',
    :'payload' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      text == o.text &&
      html_text == o.html_text &&
      block_chat_input == o.block_chat_input &&
      markdown_text == o.markdown_text &&
      actions == o.actions &&
      payload == o.payload
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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 303

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


195
196
197
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



201
202
203
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 201

def hash
  [typetexthtml_textblock_chat_inputmarkdown_textactionspayload].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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 118

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

  if !@text.nil? && @text.to_s.length > 4096
    invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 4096.')
  end

  if !@html_text.nil? && @html_text.to_s.length > 4096
    invalid_properties.push('invalid value for "html_text", the character length must be smaller than or equal to 4096.')
  end

  if !@markdown_text.nil? && @markdown_text.to_s.length > 4096
    invalid_properties.push('invalid value for "markdown_text", the character length must be smaller than or equal to 4096.')
  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



279
280
281
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 285

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



273
274
275
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 273

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



141
142
143
144
145
146
147
 
# File 'lib/sunshine-conversations-client/models/text_message.rb', line 141

def valid?
  return false if @type.nil?
  return false if !@text.nil? && @text.to_s.length > 4096
  return false if !@html_text.nil? && @html_text.to_s.length > 4096
  return false if !@markdown_text.nil? && @markdown_text.to_s.length > 4096
  true
end