Class: SunshineConversationsClient::Source

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

Overview

The source of the message.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Source

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
98
99
100
101
102
103
104
105
106
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 70

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

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

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

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

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

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

Instance Attribute Details

#client ⇒ Object

The client from which the user authored the message or activity, if applicable. This field is not applicable in API responses, it is used only in webhook payloads if the ‘includeFullSource` option is enabled.



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

def client
  @client
end

#device ⇒ Object

The device from which the user authored the message or activity, if applicable. This field is not applicable in API responses, it is used only in webhook payloads if the ‘includeFullSource` option is enabled.



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

def device
  @device
end

#integration_id ⇒ Object

Identifier indicating which integration the message was sent from. For user messages only.



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

def integration_id
  @integration_id
end

#original_message_id ⇒ Object

Message identifier assigned by the originating channel.



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

def original_message_id
  @original_message_id
end

#original_message_timestamp ⇒ Object

A datetime string with the format ‘YYYY-MM-DDThh:mm:ss.SSSZ` representing when the third party channel received the message.



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

def original_message_timestamp
  @original_message_timestamp
end

#type ⇒ Object

An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 34

def self.attribute_map
  {
    :'type' => :'type',
    :'integration_id' => :'integrationId',
    :'original_message_id' => :'originalMessageId',
    :'original_message_timestamp' => :'originalMessageTimestamp',
    :'client' => :'client',
    :'device' => :'device'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



58
59
60
61
62
63
64
65
66
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 58

def self.openapi_nullable
  Set.new([
    :'integration_id',
    :'original_message_id',
    :'original_message_timestamp',
    :'client',
    :'device'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 46

def self.openapi_types
  {
    :'type' => :'String',
    :'integration_id' => :'String',
    :'original_message_id' => :'String',
    :'original_message_timestamp' => :'String',
    :'client' => :'Client',
    :'device' => :'Device'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      integration_id == o.integration_id &&
      original_message_id == o.original_message_id &&
      original_message_timestamp == o.original_message_timestamp &&
      client == o.client &&
      device == o.device
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 182

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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 251

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 161

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


141
142
143
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



147
148
149
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 147

def hash
  [type, integration_id, original_message_id, original_message_timestamp, client, device].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  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



227
228
229
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 227

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 233

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



221
222
223
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 221

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



121
122
123
124
 
# File 'lib/sunshine-conversations-client/models/source.rb', line 121

def valid?
  return false if @type.nil?
  true
end