Class: SunshineConversationsClient::ParticipantSubSchema

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

Direct Known Subclasses

ParticipantJoinBody

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ParticipantSubSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 57

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

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

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

Instance Attribute Details

#subscribe_sdk_client ⇒ Object

When passed as true, the SDK client of the concerned participant will be subscribed to the conversation. The user will start receiving push notifications for this conversation right away, without having to view the conversation on the SDK beforehand. An SDK client will be created for users that don’t already have one. This field is required if the conversation is of type ‘sdkGroup`.



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

def subscribe_sdk_client
  @subscribe_sdk_client
end

#user_external_id ⇒ Object

The ‘externalId` of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both.



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

def user_external_id
  @user_external_id
end

#user_id ⇒ Object

The id of the user that will be participating in the conversation. It will return ‘404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 24

def self.attribute_map
  {
    :'user_id' => :'userId',
    :'subscribe_sdk_client' => :'subscribeSDKClient',
    :'user_external_id' => :'userExternalId'
  }
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



133
134
135
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 133

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

.openapi_any_of ⇒ Object

List of class defined in anyOf (OpenAPI v3)



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

def self.openapi_any_of
  [
  :'ParticipantWithUserExternalId',
  :'ParticipantWithUserId'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 33

def self.openapi_types
  {
    :'user_id' => :'String',
    :'subscribe_sdk_client' => :'Boolean',
    :'user_external_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
116
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 110

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      subscribe_sdk_client == o.subscribe_sdk_client &&
      user_external_id == o.user_external_id
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



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
189
190
191
192
193
194
195
196
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 161

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 230

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 140

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


120
121
122
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 120

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [user_id, subscribe_sdk_client, user_external_id].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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



206
207
208
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 206

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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 212

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



200
201
202
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 200

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/sunshine-conversations-client/models/participant_sub_schema.rb', line 92

def valid?
  _any_of_found = false
  self.class.openapi_any_of.each do |_class|
    _any_of = SunshineConversationsClient.const_get(_class).build_from_hash(self.to_hash)
    if _any_of.valid?
      _any_of_found = true
    end
  end

  if !_any_of_found
    return false
  end

  true
end