Class: SunshineConversationsClient::Telegram

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

Instance Attribute Summary collapse

Attributes inherited from Integration

#display_name, #id, #status

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Integration

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ Telegram

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'telegram'
  end

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

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

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

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

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

Instance Attribute Details

#bot_id ⇒ Object

A human-friendly name used to identify the integration.



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

def bot_id
  @bot_id
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



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

def default_responder
  @default_responder
end

#default_responder_id ⇒ Object

The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href="docs.smooch.io/guide/switchboard/#per-channel-default-responder">Per-channel default responder</a> guide.



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

def default_responder_id
  @default_responder_id
end

#token ⇒ Object

Telegram Bot Token.



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

def token
  @token
end

#type ⇒ Object

To configure a Telegram integration, acquire the required information from the user and call the Create Integration endpoint.



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

def type
  @type
end

#username ⇒ Object

Username of the botId



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

def username
  @username
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
40
41
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 32

def self.attribute_map
  {
    :'type' => :'type',
    :'token' => :'token',
    :'username' => :'username',
    :'bot_id' => :'botId',
    :'default_responder_id' => :'defaultResponderId',
    :'default_responder' => :'defaultResponder'
  }
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



182
183
184
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 182

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



63
64
65
66
67
68
69
70
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 63

def self.openapi_all_of
  [
  :'DefaultResponder',
  :'DefaultResponderId',
  :'Integration',
  :'TelegramAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
59
60
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 56

def self.openapi_nullable
  Set.new([
    :'default_responder_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 44

def self.openapi_types
  {
    :'type' => :'String',
    :'token' => :'String',
    :'username' => :'String',
    :'bot_id' => :'String',
    :'default_responder_id' => :'String',
    :'default_responder' => :'DefaultResponderDefaultResponder'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 156

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      token == o.token &&
      username == o.username &&
      bot_id == o.bot_id &&
      default_responder_id == o.default_responder_id &&
      default_responder == o.default_responder && super(o)
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 211

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
    SunshineConversationsClient.const_get(type).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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 280

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 189

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  self.class.openapi_types.each_pair do |key, type|
    if 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[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


169
170
171
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 175

def hash
  [type, token, username, bot_id, default_responder_id, default_responder].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



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

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

  if @token.to_s.length < 1
    invalid_properties.push('invalid value for "token", the character length must be great than or equal to 1.')
  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



256
257
258
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 256

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 262

def to_hash
  hash = super
  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



250
251
252
 
# File 'lib/sunshine-conversations-client/models/telegram.rb', line 250

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



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

def valid?
  return false if @token.nil?
  return false if @token.to_s.length < 1
  true && super
end