Class: SunshineConversationsClient::Android

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

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



64
65
66
67
68
69
70
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
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 64

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



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

def can_user_create_more_conversations
  @can_user_create_more_conversations
end

#sender_id ⇒ Object

Your sender id from the fcm console.



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

def sender_id
  @sender_id
end

#server_key ⇒ Object

Your server key from the fcm console.



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

def server_key
  @server_key
end

#type ⇒ Object

To configure an android integration, first visit the [Firebase Console](console.firebase.google.com/). Copy the ‘serverKey` and `senderId` from the Cloud Messaging tab in the settings of your project and call the create integrations endpoint with this data. If you would like to continue using your legacy GCM `serverKey` you can also obtain it from the [Google Developer Console](console.developers.google.com/).



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 27

def self.attribute_map
  {
    :'type' => :'type',
    :'server_key' => :'serverKey',
    :'sender_id' => :'senderId',
    :'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



168
169
170
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 168

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



55
56
57
58
59
60
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 55

def self.openapi_all_of
  [
  :'AndroidAllOf',
  :'Integration'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



47
48
49
50
51
52
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 47

def self.openapi_nullable
  Set.new([
    :'server_key',
    :'sender_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 37

def self.openapi_types
  {
    :'type' => :'String',
    :'server_key' => :'String',
    :'sender_id' => :'String',
    :'can_user_create_more_conversations' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



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

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



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

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 175

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


155
156
157
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



161
162
163
 
# File 'lib/sunshine-conversations-client/models/android.rb', line 161

def hash
  [type, server_key, sender_id, 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



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

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



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

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



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

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



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

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



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

def valid?
  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