class SunshineConversationsClient::AppSettings
Customizable app settings.
Attributes
A string specifying whether attachments should be stored in a publicly or privately accessible cloud storage. attachmentsAccess is set to public by default but can be modified to private. See <a href="Private“>docs.smooch.io/guide/private-attachments/">Private Attachments</a> for more information.
Number of seconds representing the expiration time of the generated media tokens for private attachments. The JWT will be valid for 2 hours by default. See See <a href="Private“>docs.smooch.io/guide/private-attachments/">Private Attachments</a> for more information.
Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See [Conversation Retention Seconds](docs.smooch.io/rest/#conversation-retention-seconds) for more information.
A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See [Echo Postbacks](docs.smooch.io/rest/#echo-postbacks) for more information.
A boolean specifying whether a non message event coming from a channel will trigger a [start conversation](docs.smooch.io/rest/#section/Webhook-Triggers) event and count as a monthly active user (MAU). <aside class="notice">Calling startConversation()
(or equivalent) from the Android
, iOS or Web
SDK will count as a MAU, regardless of the value of this setting.</aside>
A boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations.
A boolean specifying whether users are allowed to be part of several conversations. Enabling `multiConvo` is irreversible.
A boolean specifying whether animal names should be used for unnamed users. See the [user naming guide](docs.smooch.io/guide/receiving-messages/#message-author-name) for details.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/app_settings.rb, line 40 def self.attribute_map { :'conversation_retention_seconds' => :'conversationRetentionSeconds', :'mask_credit_card_numbers' => :'maskCreditCardNumbers', :'use_animal_names' => :'useAnimalNames', :'echo_postback' => :'echoPostback', :'ignore_auto_conversation_start' => :'ignoreAutoConversationStart', :'multi_convo_enabled' => :'multiConvoEnabled', :'attachments_access' => :'attachmentsAccess', :'attachments_token_expiration_seconds' => :'attachmentsTokenExpirationSeconds' } 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/app_settings.rb, line 179 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/app_settings.rb, line 75 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::AppSettings` 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::AppSettings`. 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?(:'conversation_retention_seconds') self.conversation_retention_seconds = attributes[:'conversation_retention_seconds'] end if attributes.key?(:'mask_credit_card_numbers') self.mask_credit_card_numbers = attributes[:'mask_credit_card_numbers'] end if attributes.key?(:'use_animal_names') self.use_animal_names = attributes[:'use_animal_names'] end if attributes.key?(:'echo_postback') self.echo_postback = attributes[:'echo_postback'] end if attributes.key?(:'ignore_auto_conversation_start') self.ignore_auto_conversation_start = attributes[:'ignore_auto_conversation_start'] end if attributes.key?(:'multi_convo_enabled') self.multi_convo_enabled = attributes[:'multi_convo_enabled'] end if attributes.key?(:'attachments_access') self.attachments_access = attributes[:'attachments_access'] end if attributes.key?(:'attachments_token_expiration_seconds') self.attachments_token_expiration_seconds = attributes[:'attachments_token_expiration_seconds'] end end
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/app_settings.rb, line 68 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/app_settings.rb, line 54 def self.openapi_types { :'conversation_retention_seconds' => :'Integer', :'mask_credit_card_numbers' => :'Boolean', :'use_animal_names' => :'Boolean', :'echo_postback' => :'Boolean', :'ignore_auto_conversation_start' => :'Boolean', :'multi_convo_enabled' => :'Boolean', :'attachments_access' => :'String', :'attachments_token_expiration_seconds' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/app_settings.rb, line 151 def ==(o) return true if self.equal?(o) self.class == o.class && conversation_retention_seconds == o.conversation_retention_seconds && mask_credit_card_numbers == o.mask_credit_card_numbers && use_animal_names == o.use_animal_names && echo_postback == o.echo_postback && ignore_auto_conversation_start == o.ignore_auto_conversation_start && multi_convo_enabled == o.multi_convo_enabled && attachments_access == o.attachments_access && attachments_token_expiration_seconds == o.attachments_token_expiration_seconds 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/app_settings.rb, line 207 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/app_settings.rb, line 276 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
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/app_settings.rb, line 186 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] conversation_retention_seconds
Value to be assigned
# File lib/sunshine-conversations-client/models/app_settings.rb, line 141 def conversation_retention_seconds=(conversation_retention_seconds) if !conversation_retention_seconds.nil? && conversation_retention_seconds < 0 fail ArgumentError, 'invalid value for "conversation_retention_seconds", must be greater than or equal to 0.' end @conversation_retention_seconds = conversation_retention_seconds end
@see the `==` method @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/app_settings.rb, line 166 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/app_settings.rb, line 172 def hash [conversation_retention_seconds, mask_credit_card_numbers, use_animal_names, echo_postback, ignore_auto_conversation_start, multi_convo_enabled, attachments_access, attachments_token_expiration_seconds].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/app_settings.rb, line 123 def list_invalid_properties invalid_properties = Array.new if !@conversation_retention_seconds.nil? && @conversation_retention_seconds < 0 invalid_properties.push('invalid value for "conversation_retention_seconds", must be greater than or equal to 0.') end invalid_properties 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/app_settings.rb, line 258 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/app_settings.rb, line 246 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/app_settings.rb, line 134 def valid? return false if !@conversation_retention_seconds.nil? && @conversation_retention_seconds < 0 true end