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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 99

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

#env_name ⇒ Object

The Twitter dev environments label (required 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, sandbox, premium or enterprise.



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.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 58

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'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



307
308
309
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 307

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



90
91
92
93
94
95
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 90

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 71

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

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 && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 336

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



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

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 314

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

See Also:

  • `==` method


294
295
296
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



300
301
302
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 300

def hash
  [type, tier, env_name, consumer_key, consumer_secret, access_token_key, access_token_secret].hash
end

#list_invalid_properties ⇒ Object

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 148

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.nil?
    invalid_properties.push('invalid value for "consumer_secret", consumer_secret cannot be nil.')
  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? && @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.nil?
    invalid_properties.push('invalid value for "access_token_secret", access_token_secret cannot be nil.')
  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)



381
382
383
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 381

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 387

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



375
376
377
 
# File 'lib/sunshine-conversations-client/models/twitter.rb', line 375

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



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

def valid?
  return false if @tier.nil?
  tier_validator = EnumAttributeValidator.new('String', ["sandbox", "premium", "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.nil?
  return false if @consumer_secret.to_s.length < 1
  return false if !@access_token_key.nil? && @access_token_key.to_s.length < 1
  return false if @access_token_secret.nil?
  return false if @access_token_secret.to_s.length < 1
  true && super
end