Class: SunshineConversationsClient::Android

Inherits:
Integration
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/android.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 = {}) ⇒ Android

Initializes the object

Parameters:

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

    Model attributes in the form of hash



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
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
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 127

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'android'
  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

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

Instance Attribute Details

#attachments_enabled ⇒ Object

Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.



45
46
47
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 45

def attachments_enabled
  @attachments_enabled
end

#can_user_create_more_conversations ⇒ Object

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



42
43
44
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 42

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`*.



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

def can_user_see_conversation_list
  @can_user_see_conversation_list
end

#client_email ⇒ Object

Your client email from your generated private key file.



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

def client_email
  @client_email
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



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

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



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

def default_responder_id
  @default_responder_id
end

#private_key ⇒ Object

Your private key from your generated private key file.



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

def private_key
  @private_key
end

#project_id ⇒ Object

Your project ID from your generated private key file.



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

def project_id
  @project_id
end

#sender_id ⇒ Object

Your sender id from the fcm console.



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

def sender_id
  @sender_id
end

#server_key ⇒ Object

Your server key from the fcm console.



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

def server_key
  @server_key
end

#type ⇒ Object

<aside class="notice"><strong>Note:</strong> Firebase Cloud Messaging has deprecated its legacy APIs for HTTP and XMPP. Legacy credentials serverKey and senderId will stop working as of June 2024 and must be replaced with OAuth 2.0 access token based credentials.</aside> To configure an android integration, first visit the [Firebase Console](console.firebase.google.com/). Generate a private key from the Service accounts tab in the settings. Copy the ‘project_id`, `client_email` and `private_key` from the generated JSON file and call the create integrations endpoint with this data.



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

def type
  @type
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



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
372
373
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 336

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.



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

def self.attribute_map
  {
    :'default_responder_id' => :'defaultResponderId',
    :'default_responder' => :'defaultResponder',
    :'type' => :'type',
    :'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',
    :'attachments_enabled' => :'attachmentsEnabled'
  }
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



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

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'DefaultResponder',
  :'DefaultResponderId',
  :'Integration'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 87

def self.openapi_types
  {
    :'default_responder_id' => :'String',
    :'default_responder' => :'DefaultResponderDefaultResponder',
    :'type' => :'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',
    :'attachments_enabled' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_responder_id == o.default_responder_id &&
      default_responder == o.default_responder &&
      type == o.type &&
      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 &&
      attachments_enabled == o.attachments_enabled && super(o)
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



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

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


298
299
300
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 304

def hash
  [default_responder_iddefault_respondertypeproject_idclient_emailprivate_keyserver_keysender_idcan_user_see_conversation_listcan_user_create_more_conversationsattachments_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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 192

def list_invalid_properties
  invalid_properties = super
  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



383
384
385
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 383

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



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

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

Returns:

  • (String) —

    String presentation of the object



377
378
379
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 377

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



219
220
221
222
223
224
225
226
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 219

def valid?
  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 && super
end