Class: SunshineConversationsClient::AndroidUpdate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AndroidUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
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
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 94

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#can_user_create_more_conversations ⇒ Object

Allows users to create more than one conversation on the android integration.



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

def can_user_create_more_conversations
  @can_user_create_more_conversations
end

#can_user_see_conversation_list ⇒ Object

Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where ‘settings.multiConvoEnabled` is set to `true`*.



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

def can_user_see_conversation_list
  @can_user_see_conversation_list
end

#client_email ⇒ Object

Your client email from your generated private key file.



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

def client_email
  @client_email
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>.



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

def default_responder_id
  @default_responder_id
end

#display_name ⇒ Object

A human-friendly name used to identify the integration. ‘displayName` can be unset by changing it to `null`.



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

def display_name
  @display_name
end

#private_key ⇒ Object

Your private key from your generated private key file.



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

def private_key
  @private_key
end

#project_id ⇒ Object

Your project ID from your generated private key file.



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

def project_id
  @project_id
end

#sender_id ⇒ Object

Your sender id from the fcm console.



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

def sender_id
  @sender_id
end

#server_key ⇒ Object

Your server key from the fcm console.



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

def server_key
  @server_key
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 42

def self.attribute_map
  {
    :'display_name' => :'displayName',
    :'default_responder_id' => :'defaultResponderId',
    :'project_id' => :'projectId',
    :'client_email' => :'clientEmail',
    :'private_key' => :'privateKey',
    :'server_key' => :'serverKey',
    :'sender_id' => :'senderId',
    :'can_user_see_conversation_list' => :'canUserSeeConversationList',
    :'can_user_create_more_conversations' => :'canUserCreateMoreConversations'
  }
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



287
288
289
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 287

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



85
86
87
88
89
90
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 85

def self.openapi_all_of
  [
  :'AndroidUpdateAllOf',
  :'IntegrationUpdateBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'display_name',
    :'default_responder_id',
    :'project_id',
    :'client_email',
    :'private_key',
    :'server_key',
    :'sender_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'display_name' => :'String',
    :'default_responder_id' => :'String',
    :'project_id' => :'String',
    :'client_email' => :'String',
    :'private_key' => :'String',
    :'server_key' => :'String',
    :'sender_id' => :'String',
    :'can_user_see_conversation_list' => :'Boolean',
    :'can_user_create_more_conversations' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display_name == o.display_name &&
      default_responder_id == o.default_responder_id &&
      project_id == o.project_id &&
      client_email == o.client_email &&
      private_key == o.private_key &&
      server_key == o.server_key &&
      sender_id == o.sender_id &&
      can_user_see_conversation_list == o.can_user_see_conversation_list &&
      can_user_create_more_conversations == o.can_user_create_more_conversations
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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 315

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 384

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



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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


274
275
276
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 274

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



280
281
282
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 280

def hash
  [display_name, default_responder_id, project_id, client_email, private_key, server_key, sender_id, can_user_see_conversation_list, can_user_create_more_conversations].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



146
147
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
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 146

def list_invalid_properties
  invalid_properties = Array.new
  if !@display_name.nil? && @display_name.to_s.length > 100
    invalid_properties.push('invalid value for "display_name", the character length must be smaller than or equal to 100.')
  end

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

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

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

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

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

  if !@sender_id.nil? && @sender_id.to_s.length < 1
    invalid_properties.push('invalid value for "sender_id", 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



360
361
362
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 360

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 366

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



354
355
356
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 354

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



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/sunshine-conversations-client/models/android_update.rb', line 181

def valid?
  return false if !@display_name.nil? && @display_name.to_s.length > 100
  return false if !@display_name.nil? && @display_name.to_s.length < 1
  return false if !@project_id.nil? && @project_id.to_s.length < 1
  return false if !@client_email.nil? && @client_email.to_s.length < 1
  return false if !@private_key.nil? && @private_key.to_s.length < 1
  return false if !@server_key.nil? && @server_key.to_s.length < 1
  return false if !@sender_id.nil? && @sender_id.to_s.length < 1
  true
end