Class: SunshineConversationsClient::ConversationCreateEventAllOfPayload

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

Overview

The payload of the event. The contents of this object depend on the type of event.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationCreateEventAllOfPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb', line 84

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

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

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

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

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

Instance Attribute Details

#conversation ⇒ Object

The conversation that was created.



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

def conversation
  @conversation
end

#creation_reason ⇒ Object

The reason why the conversation was created, if applicable. * ‘linkRequest` - The conversation was created in order to generate a link request to transfer the user to a different channel. * `message` - The conversation was created because a message was sent. * `none` - The conversation was not created for a specific purpose. Used primarily when a conversation is created via the Create Conversation API. * `notification` - The conversation was created by a call to the Notification API. * `prechatCapture` - The conversation was created because the user completed a prechat capture form in the Web Messenger. * `startConversation` - The conversation was created because of a call to the startConversation API on one of the SDK integrations, or a start conversation event was triggered from a messaging channel. * `proactiveMessaging` - The conversation was created because the user interacted with a campaign.



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

def creation_reason
  @creation_reason
end

#referral ⇒ Object

Referral information, if applicable.



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

def referral
  @referral
end

#source ⇒ Object

The source of the creation.



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

def source
  @source
end

#user ⇒ Object

The user associated with the conversation. Only present if the created conversation was of type personal. For sdkGroup conversations, the list of participants can be fetched using the List Participants API, if required.



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

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'conversation' => :'conversation',
    :'creation_reason' => :'creationReason',
    :'source' => :'source',
    :'user' => :'user',
    :'referral' => :'referral'
  }
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



170
171
172
 
# File 'lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb', line 170

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
79
80
 
# File 'lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb', line 75

def self.openapi_nullable
  Set.new([
    :'user',
    :'referral'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
 
# File 'lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb', line 64

def self.openapi_types
  {
    :'conversation' => :'ConversationTruncated',
    :'creation_reason' => :'String',
    :'source' => :'SourceWithCampaignWebhook',
    :'user' => :'User',
    :'referral' => :'Referral'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      conversation == o.conversation &&
      creation_reason == o.creation_reason &&
      source == o.source &&
      user == o.user &&
      referral == o.referral
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



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
233
 
# File 'lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb', line 198

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



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

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



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

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


157
158
159
 
# File 'lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb', line 163

def hash
  [conversation, creation_reason, source, user, referral].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



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

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



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

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



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

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



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

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



127
128
129
130
131
 
# File 'lib/sunshine-conversations-client/models/conversation_create_event_all_of_payload.rb', line 127

def valid?
  creation_reason_validator = EnumAttributeValidator.new('String', ["linkRequest", "message", "none", "notification", "prechatCapture", "startConversation", "proactiveMessaging"])
  return false unless creation_reason_validator.valid?(@creation_reason)
  true
end