class SunshineConversationsClient::TwitterAllOf
Attributes
The access token key obtained from your user via oauth.
The access token secret obtained from your user via oauth.
The consumer key for your Twitter
app.
The consumer key secret for your Twitter
app.
The Twitter
dev environments label (required for sandbox and premium tiers).
Your Twitter
app’s tier, sandbox, premium or enterprise.
To set up a Twitter
integration, please follow the steps outlined in the [Twitter Setup Guide](docs.smooch.io/guide/twitter/#setup).
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/twitter_all_of.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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 296 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 91 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::TwitterAllOf` 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::TwitterAllOf`. 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 = '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
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 84 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/twitter_all_of.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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 269 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 end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 324 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 393 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
Custom
attribute writer method with validation @param [Object] access_token_key
Value to be assigned
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 245 def access_token_key=(access_token_key) if !access_token_key.nil? && access_token_key.to_s.length < 1 fail ArgumentError, 'invalid value for "access_token_key", the character length must be great than or equal to 1.' end @access_token_key = access_token_key end
Custom
attribute writer method with validation @param [Object] access_token_secret
Value to be assigned
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 255 def access_token_secret=(access_token_secret) if access_token_secret.nil? fail ArgumentError, 'access_token_secret cannot be nil' end if access_token_secret.to_s.length < 1 fail ArgumentError, 'invalid value for "access_token_secret", the character length must be great than or equal to 1.' end @access_token_secret = access_token_secret end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 303 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) 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
Custom
attribute writer method with validation @param [Object] consumer_key
Value to be assigned
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 217 def consumer_key=(consumer_key) if consumer_key.nil? fail ArgumentError, 'consumer_key cannot be nil' end if consumer_key.to_s.length < 1 fail ArgumentError, 'invalid value for "consumer_key", the character length must be great than or equal to 1.' end @consumer_key = consumer_key end
Custom
attribute writer method with validation @param [Object] consumer_secret
Value to be assigned
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 231 def consumer_secret=(consumer_secret) if consumer_secret.nil? fail ArgumentError, 'consumer_secret cannot be nil' end if consumer_secret.to_s.length < 1 fail ArgumentError, 'invalid value for "consumer_secret", the character length must be great than or equal to 1.' end @consumer_secret = consumer_secret end
Custom
attribute writer method with validation @param [Object] env_name
Value to be assigned
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 207 def env_name=(env_name) if !env_name.nil? && env_name.to_s.length < 1 fail ArgumentError, 'invalid value for "env_name", the character length must be great than or equal to 1.' end @env_name = env_name end
@see the `==` method @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 283 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 289 def hash [type, tier, env_name, consumer_key, consumer_secret, access_token_key, access_token_secret].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 137 def list_invalid_properties invalid_properties = Array.new 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
Custom
attribute writer method checking allowed values (enum). @param [Object] tier Object to be assigned
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 197 def tier=(tier) validator = EnumAttributeValidator.new('String', ["sandbox", "premium", "enterprise"]) unless validator.valid?(tier) fail ArgumentError, "invalid value for \"tier\", must be one of #{validator.allowable_values}." end @tier = tier end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 375 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 363 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/sunshine-conversations-client/models/twitter_all_of.rb, line 180 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 end