Class: SunshineConversationsClient::Twitter

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

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ Twitter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 114

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

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

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

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

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

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

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

#access_token_key ⇒ Object

The access token key obtained from your user via oauth.



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

def access_token_key
  @access_token_key
end

#access_token_secret ⇒ Object

The access token secret obtained from your user via oauth.



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

def access_token_secret
  @access_token_secret
end

#consumer_key ⇒ Object

The consumer key for your Twitter app.



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

def consumer_key
  @consumer_key
end

#consumer_secret ⇒ Object

The consumer key secret for your Twitter app.



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

def consumer_secret
  @consumer_secret
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



38
39
40
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 38

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 the <a href="developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment">Switchboard guide</a>.



36
37
38
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 36

def default_responder_id
  @default_responder_id
end

#env_name ⇒ Object

The Twitter dev environments label. Only required / used for sandbox and premium tiers.



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

def env_name
  @env_name
end

#tier ⇒ Object

Your Twitter app’s tier. Only "enterprise" is supported for new integrations.



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

def tier
  @tier
end

#type ⇒ Object

To set up a Twitter integration, please follow the steps outlined in the [Twitter Setup Guide](docs.smooch.io/guide/twitter/#setup).



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 63

def self.attribute_map
  {
    :'type' => :'type',
    :'tier' => :'tier',
    :'env_name' => :'envName',
    :'consumer_key' => :'consumerKey',
    :'consumer_secret' => :'consumerSecret',
    :'access_token_key' => :'accessTokenKey',
    :'access_token_secret' => :'accessTokenSecret',
    :'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



323
324
325
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 323

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



103
104
105
106
107
108
109
110
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 103

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
97
98
99
100
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 78

def self.openapi_types
  {
    :'type' => :'String',
    :'tier' => :'String',
    :'env_name' => :'String',
    :'consumer_key' => :'String',
    :'consumer_secret' => :'String',
    :'access_token_key' => :'String',
    :'access_token_secret' => :'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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      tier == o.tier &&
      env_name == o.env_name &&
      consumer_key == o.consumer_key &&
      consumer_secret == o.consumer_secret &&
      access_token_key == o.access_token_key &&
      access_token_secret == o.access_token_secret &&
      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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 352

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 421

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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 330

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


310
311
312
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



316
317
318
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 316

def hash
  [type, tier, env_name, consumer_key, consumer_secret, access_token_key, access_token_secret, 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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 171

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

  if !@env_name.nil? && @env_name.to_s.length < 1
    invalid_properties.push('invalid value for "env_name", the character length must be great than or equal to 1.')
  end

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

  if @consumer_key.to_s.length < 1
    invalid_properties.push('invalid value for "consumer_key", the character length must be great than or equal to 1.')
  end

  if @consumer_secret.to_s.length < 1
    invalid_properties.push('invalid value for "consumer_secret", the character length must be great than or equal to 1.')
  end

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

  if @access_token_key.to_s.length < 1
    invalid_properties.push('invalid value for "access_token_key", the character length must be great than or equal to 1.')
  end

  if @access_token_secret.to_s.length < 1
    invalid_properties.push('invalid value for "access_token_secret", 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



397
398
399
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 397

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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 403

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



391
392
393
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 391

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



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 210

def valid?
  return false if @tier.nil?
  tier_validator = EnumAttributeValidator.new('String', ["enterprise"])
  return false unless tier_validator.valid?(@tier)
  return false if !@env_name.nil? && @env_name.to_s.length < 1
  return false if @consumer_key.nil?
  return false if @consumer_key.to_s.length < 1
  return false if @consumer_secret.to_s.length < 1
  return false if @access_token_key.nil?
  return false if @access_token_key.to_s.length < 1
  return false if @access_token_secret.to_s.length < 1
  true && super
end