Class: SunshineConversationsClient::AppSettings

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

Overview

Customizable app settings.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
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
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 71

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?(:'app_localization_enabled')
    self.app_localization_enabled = attributes[:'app_localization_enabled']
  end
end

Instance Attribute Details

#app_localization_enabled ⇒ Object

A boolean specifying whether the messages authored by the Sunshine Conversations platform should be localized.



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

def app_localization_enabled
  @app_localization_enabled
end

#conversation_retention_seconds ⇒ Object

Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See [Conversation Retention Seconds](docs.smooch.io/guide/creating-and-managing-apps/#conversation-retention-seconds) for more information.



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

def conversation_retention_seconds
  @conversation_retention_seconds
end

#echo_postback ⇒ Object

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/guide/creating-and-managing-apps/#echo-postbacks) for more information.



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

def echo_postback
  @echo_postback
end

#ignore_auto_conversation_start ⇒ Object

A boolean specifying whether a non message event coming from a channel will trigger a [start conversation](developer.zendesk.com/api-reference/conversations/#section/Webhook-Triggers) event and count as a monthly active user (MAU). <aside class="notice"><strong>Note:</strong> Calling startConversation() (or equivalent) from the Android, iOS or Web SDK will count as a MAU, regardless of the value of this setting.</aside>



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

def ignore_auto_conversation_start
  @ignore_auto_conversation_start
end

#mask_credit_card_numbers ⇒ Object

A boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations.



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

def mask_credit_card_numbers
  @mask_credit_card_numbers
end

#multi_convo_enabled ⇒ Object

A boolean specifying whether users are allowed to be part of several conversations. Enabling ‘multiConvo` is irreversible.



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

def multi_convo_enabled
  @multi_convo_enabled
end

#use_animal_names ⇒ Object

A boolean specifying whether animal names should be used for unnamed users. See the [user naming guide](developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/receiving-messages/#message-author-name) for details.



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

def use_animal_names
  @use_animal_names
end

Class Method Details

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 194

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = SunshineConversationsClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 38

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',
    :'app_localization_enabled' => :'appLocalizationEnabled'
  }
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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 170

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 51

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',
    :'app_localization_enabled' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 143

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 &&
      app_localization_enabled == o.app_localization_enabled
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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 265

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 163

def hash
  [conversation_retention_secondsmask_credit_card_numbersuse_animal_namesecho_postbackignore_auto_conversation_startmulti_convo_enabledapp_localization_enabled].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



115
116
117
118
119
120
121
122
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 115

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 241

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 247

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



235
236
237
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 235

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



126
127
128
129
 
# File 'lib/sunshine-conversations-client/models/app_settings.rb', line 126

def valid?
  return false if !@conversation_retention_seconds.nil? && @conversation_retention_seconds < 0
  true
end