Class: Qismo::WebhookRequests::OnNewSessionInitiated

Inherits:
Object
  • Object
show all
Defined in:
lib/qismo/webhook_requests/on_new_session_initiated.rb

Overview

New session webhook object

Defined Under Namespace

Classes: AdditionalExtras, Extras, From, Message, Participant, Payload, Room, RoomLog, UserProperty

Constant Summary

Constants included from Types

Types::Bool, Types::Hash, Types::Int, Types::String

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

from_array

Instance Attribute Details

#is_new_session ⇒ TrueClass, FalseClass (readonly)

Returns:

  • (TrueClass, FalseClass) 


11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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/qismo/webhook_requests/on_new_session_initiated.rb', line 11

class OnNewSessionInitiated < Qismo::Object
  # New session webhook from object
  #
  # @!attribute [r] avatar_url
  #   @return [String]
  # @!attribute [r] email
  #   @return [String]
  # @!attribute [r] id
  #   @return [Integer]
  # @!attribute [r] name
  #   @return [String]
  class From < Qismo::Object
    attribute? :avatar_url, Types::String.optional
    attribute? :email, Types::String.optional
    attribute? :id, Types::Int.optional
    attribute? :name, Types::String.optional
  end

  # New session webhook message object
  #
  # @!attribute [r] comment_before_id
  #   @return [Integer]
  # @!attribute [r] created_at
  #   @return [String]
  # @!attribute [r] id
  #   @return [Integer]
  # @!attribute [r] payload
  #   @return [Hash]
  # @!attribute [r] text
  #   @return [String]
  # @!attribute [r] timestamp
  #   @return [String]
  # @!attribute [r] type
  #   @return [String]
  # @!attribute [r] unique_temp_id
  #   @return [String]
  # @!attribute [r] unix_nano_timestamp
  #   @return [String]
  # @!attribute [r] unix_timestamp
  #   @return [String]
  class Message < Qismo::Object
    attribute? :comment_before_id, Types::Int.optional
    attribute? :created_at, Types::String.optional
    attribute? :id, Types::Int.optional
    attribute? :payload, Types::Hash.optional
    attribute? :text, Types::String.optional
    attribute? :timestamp, Types::String.optional
    attribute? :type, Types::String.optional
    attribute? :unique_temp_id, Types::String.optional
    attribute? :unix_nano_timestamp, Types::String.optional
    attribute? :unix_timestamp, Types::String.optional
  end

  # New session webhook participant object
  #
  # @!attribute [r] email
  #   @return [String]
  class Participant < Qismo::Object
    attribute? :email, Types::String.optional
  end

  # New session webhook room object
  #
  # @!attribute [r] id
  #   @return [String]
  # @!attribute [r] name
  #   @return [String]
  # @!attribute [r] options
  #   @return [String]
  # @!attribute [r] participants
  #   @return [Array<Participant>]
  # @!attribute [r] room_avatar
  #   @return [String]
  class Room < Qismo::Object
    attribute? :id, Types::String.optional
    attribute? :name, Types::String.optional
    attribute? :options, Types::String.optional
    attribute? :participants, Types.Array(Participant.optional).optional
    attribute? :room_avatar, Types::String.optional
  end

  # New session webhook message payload object
  #
  # @!attribute [r] from
  #   @return [From]
  # @!attribute [r] message
  #   @return [Message]
  # @!attribute [r] room
  #   @return [Room]
  # @!attribute [r] type
  #   @return [String]
  class Payload < Qismo::Object
    attribute? :from, From.optional
    attribute? :message, Message.optional
    attribute? :room, Room.optional
  end

  # New session webhook user property object
  #
  # @!attribute [r] key
  #   @return [String]
  # @!attribute [r] value
  #   @return [String,Integer,TrueClass,FalseClass]
  class UserProperty < Qismo::Object
    attribute? :key, Types::String.optional
    attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
  end

  # New session webhook additional extras object
  #
  # @!attribute [r] timezone_offset
  #   @return [String]
  class AdditionalExtras < Qismo::Object
    attribute? :timezone_offset, Types::String
  end

  # New session webhook extras object
  #
  # @!attribute [r] additional_extras
  #   @return [AdditionalExtras]
  # @!attribute [r] notes
  #   @return [String]
  # @!attribute [r] timezone_offset
  #   @return [String]
  # @!attribute [r] user_properties
  #   @return [Array<UserProperty>]
  class Extras < Qismo::Object
    attribute? :additional_extras, AdditionalExtras.optional
    attribute? :notes, Types::String
    attribute? :timezone_offset, Types::String
    attribute? :user_properties, Types.Array(UserProperty.optional).optional
  end

  # New session webhook room log object
  #
  # @!attribute [r] channel_id
  #   @return [Integer]
  # @!attribute [r] created_at
  #   @return [String]
  # @!attribute [r] extras
  #   @return [String]
  # @!attribute [r] has_no_message
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] is_waiting
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] name
  #   @return [String]
  # @!attribute [r] resolved
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] room_badge
  #   @return [String]
  # @!attribute [r] room_id
  #   @return [String]
  # @!attribute [r] source
  #   @return [String]
  # @!attribute [r] user_avatar_url
  #   @return [String]
  # @!attribute [r] user_id
  #   @return [String]
  class RoomLog < Qismo::Object
    attribute? :channel_id, Types::Int
    attribute? :created_at, Types::String
    attribute? :extras, Extras
    attribute? :has_no_message, Types::Bool.optional
    attribute? :is_waiting, Types::Nil
    attribute? :name, Types::String
    attribute? :resolved, Types::Bool.optional
    attribute? :room_badge, Types::String
    attribute? :room_id, Types::String
    attribute? :source, Types::String
    attribute? :user_avatar_url, Types::String
    attribute? :user_id, Types::String
  end

  attribute? :is_new_session, Types::Bool.optional
  attribute? :payload, Payload
  attribute? :room_log, RoomLog
end

#payload ⇒ Payload (readonly)

Returns:



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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/qismo/webhook_requests/on_new_session_initiated.rb', line 11

class OnNewSessionInitiated < Qismo::Object
  # New session webhook from object
  #
  # @!attribute [r] avatar_url
  #   @return [String]
  # @!attribute [r] email
  #   @return [String]
  # @!attribute [r] id
  #   @return [Integer]
  # @!attribute [r] name
  #   @return [String]
  class From < Qismo::Object
    attribute? :avatar_url, Types::String.optional
    attribute? :email, Types::String.optional
    attribute? :id, Types::Int.optional
    attribute? :name, Types::String.optional
  end

  # New session webhook message object
  #
  # @!attribute [r] comment_before_id
  #   @return [Integer]
  # @!attribute [r] created_at
  #   @return [String]
  # @!attribute [r] id
  #   @return [Integer]
  # @!attribute [r] payload
  #   @return [Hash]
  # @!attribute [r] text
  #   @return [String]
  # @!attribute [r] timestamp
  #   @return [String]
  # @!attribute [r] type
  #   @return [String]
  # @!attribute [r] unique_temp_id
  #   @return [String]
  # @!attribute [r] unix_nano_timestamp
  #   @return [String]
  # @!attribute [r] unix_timestamp
  #   @return [String]
  class Message < Qismo::Object
    attribute? :comment_before_id, Types::Int.optional
    attribute? :created_at, Types::String.optional
    attribute? :id, Types::Int.optional
    attribute? :payload, Types::Hash.optional
    attribute? :text, Types::String.optional
    attribute? :timestamp, Types::String.optional
    attribute? :type, Types::String.optional
    attribute? :unique_temp_id, Types::String.optional
    attribute? :unix_nano_timestamp, Types::String.optional
    attribute? :unix_timestamp, Types::String.optional
  end

  # New session webhook participant object
  #
  # @!attribute [r] email
  #   @return [String]
  class Participant < Qismo::Object
    attribute? :email, Types::String.optional
  end

  # New session webhook room object
  #
  # @!attribute [r] id
  #   @return [String]
  # @!attribute [r] name
  #   @return [String]
  # @!attribute [r] options
  #   @return [String]
  # @!attribute [r] participants
  #   @return [Array<Participant>]
  # @!attribute [r] room_avatar
  #   @return [String]
  class Room < Qismo::Object
    attribute? :id, Types::String.optional
    attribute? :name, Types::String.optional
    attribute? :options, Types::String.optional
    attribute? :participants, Types.Array(Participant.optional).optional
    attribute? :room_avatar, Types::String.optional
  end

  # New session webhook message payload object
  #
  # @!attribute [r] from
  #   @return [From]
  # @!attribute [r] message
  #   @return [Message]
  # @!attribute [r] room
  #   @return [Room]
  # @!attribute [r] type
  #   @return [String]
  class Payload < Qismo::Object
    attribute? :from, From.optional
    attribute? :message, Message.optional
    attribute? :room, Room.optional
  end

  # New session webhook user property object
  #
  # @!attribute [r] key
  #   @return [String]
  # @!attribute [r] value
  #   @return [String,Integer,TrueClass,FalseClass]
  class UserProperty < Qismo::Object
    attribute? :key, Types::String.optional
    attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
  end

  # New session webhook additional extras object
  #
  # @!attribute [r] timezone_offset
  #   @return [String]
  class AdditionalExtras < Qismo::Object
    attribute? :timezone_offset, Types::String
  end

  # New session webhook extras object
  #
  # @!attribute [r] additional_extras
  #   @return [AdditionalExtras]
  # @!attribute [r] notes
  #   @return [String]
  # @!attribute [r] timezone_offset
  #   @return [String]
  # @!attribute [r] user_properties
  #   @return [Array<UserProperty>]
  class Extras < Qismo::Object
    attribute? :additional_extras, AdditionalExtras.optional
    attribute? :notes, Types::String
    attribute? :timezone_offset, Types::String
    attribute? :user_properties, Types.Array(UserProperty.optional).optional
  end

  # New session webhook room log object
  #
  # @!attribute [r] channel_id
  #   @return [Integer]
  # @!attribute [r] created_at
  #   @return [String]
  # @!attribute [r] extras
  #   @return [String]
  # @!attribute [r] has_no_message
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] is_waiting
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] name
  #   @return [String]
  # @!attribute [r] resolved
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] room_badge
  #   @return [String]
  # @!attribute [r] room_id
  #   @return [String]
  # @!attribute [r] source
  #   @return [String]
  # @!attribute [r] user_avatar_url
  #   @return [String]
  # @!attribute [r] user_id
  #   @return [String]
  class RoomLog < Qismo::Object
    attribute? :channel_id, Types::Int
    attribute? :created_at, Types::String
    attribute? :extras, Extras
    attribute? :has_no_message, Types::Bool.optional
    attribute? :is_waiting, Types::Nil
    attribute? :name, Types::String
    attribute? :resolved, Types::Bool.optional
    attribute? :room_badge, Types::String
    attribute? :room_id, Types::String
    attribute? :source, Types::String
    attribute? :user_avatar_url, Types::String
    attribute? :user_id, Types::String
  end

  attribute? :is_new_session, Types::Bool.optional
  attribute? :payload, Payload
  attribute? :room_log, RoomLog
end

#room_log ⇒ RoomLog (readonly)

Returns:



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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/qismo/webhook_requests/on_new_session_initiated.rb', line 11

class OnNewSessionInitiated < Qismo::Object
  # New session webhook from object
  #
  # @!attribute [r] avatar_url
  #   @return [String]
  # @!attribute [r] email
  #   @return [String]
  # @!attribute [r] id
  #   @return [Integer]
  # @!attribute [r] name
  #   @return [String]
  class From < Qismo::Object
    attribute? :avatar_url, Types::String.optional
    attribute? :email, Types::String.optional
    attribute? :id, Types::Int.optional
    attribute? :name, Types::String.optional
  end

  # New session webhook message object
  #
  # @!attribute [r] comment_before_id
  #   @return [Integer]
  # @!attribute [r] created_at
  #   @return [String]
  # @!attribute [r] id
  #   @return [Integer]
  # @!attribute [r] payload
  #   @return [Hash]
  # @!attribute [r] text
  #   @return [String]
  # @!attribute [r] timestamp
  #   @return [String]
  # @!attribute [r] type
  #   @return [String]
  # @!attribute [r] unique_temp_id
  #   @return [String]
  # @!attribute [r] unix_nano_timestamp
  #   @return [String]
  # @!attribute [r] unix_timestamp
  #   @return [String]
  class Message < Qismo::Object
    attribute? :comment_before_id, Types::Int.optional
    attribute? :created_at, Types::String.optional
    attribute? :id, Types::Int.optional
    attribute? :payload, Types::Hash.optional
    attribute? :text, Types::String.optional
    attribute? :timestamp, Types::String.optional
    attribute? :type, Types::String.optional
    attribute? :unique_temp_id, Types::String.optional
    attribute? :unix_nano_timestamp, Types::String.optional
    attribute? :unix_timestamp, Types::String.optional
  end

  # New session webhook participant object
  #
  # @!attribute [r] email
  #   @return [String]
  class Participant < Qismo::Object
    attribute? :email, Types::String.optional
  end

  # New session webhook room object
  #
  # @!attribute [r] id
  #   @return [String]
  # @!attribute [r] name
  #   @return [String]
  # @!attribute [r] options
  #   @return [String]
  # @!attribute [r] participants
  #   @return [Array<Participant>]
  # @!attribute [r] room_avatar
  #   @return [String]
  class Room < Qismo::Object
    attribute? :id, Types::String.optional
    attribute? :name, Types::String.optional
    attribute? :options, Types::String.optional
    attribute? :participants, Types.Array(Participant.optional).optional
    attribute? :room_avatar, Types::String.optional
  end

  # New session webhook message payload object
  #
  # @!attribute [r] from
  #   @return [From]
  # @!attribute [r] message
  #   @return [Message]
  # @!attribute [r] room
  #   @return [Room]
  # @!attribute [r] type
  #   @return [String]
  class Payload < Qismo::Object
    attribute? :from, From.optional
    attribute? :message, Message.optional
    attribute? :room, Room.optional
  end

  # New session webhook user property object
  #
  # @!attribute [r] key
  #   @return [String]
  # @!attribute [r] value
  #   @return [String,Integer,TrueClass,FalseClass]
  class UserProperty < Qismo::Object
    attribute? :key, Types::String.optional
    attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
  end

  # New session webhook additional extras object
  #
  # @!attribute [r] timezone_offset
  #   @return [String]
  class AdditionalExtras < Qismo::Object
    attribute? :timezone_offset, Types::String
  end

  # New session webhook extras object
  #
  # @!attribute [r] additional_extras
  #   @return [AdditionalExtras]
  # @!attribute [r] notes
  #   @return [String]
  # @!attribute [r] timezone_offset
  #   @return [String]
  # @!attribute [r] user_properties
  #   @return [Array<UserProperty>]
  class Extras < Qismo::Object
    attribute? :additional_extras, AdditionalExtras.optional
    attribute? :notes, Types::String
    attribute? :timezone_offset, Types::String
    attribute? :user_properties, Types.Array(UserProperty.optional).optional
  end

  # New session webhook room log object
  #
  # @!attribute [r] channel_id
  #   @return [Integer]
  # @!attribute [r] created_at
  #   @return [String]
  # @!attribute [r] extras
  #   @return [String]
  # @!attribute [r] has_no_message
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] is_waiting
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] name
  #   @return [String]
  # @!attribute [r] resolved
  #   @return [TrueClass,FalseClass]
  # @!attribute [r] room_badge
  #   @return [String]
  # @!attribute [r] room_id
  #   @return [String]
  # @!attribute [r] source
  #   @return [String]
  # @!attribute [r] user_avatar_url
  #   @return [String]
  # @!attribute [r] user_id
  #   @return [String]
  class RoomLog < Qismo::Object
    attribute? :channel_id, Types::Int
    attribute? :created_at, Types::String
    attribute? :extras, Extras
    attribute? :has_no_message, Types::Bool.optional
    attribute? :is_waiting, Types::Nil
    attribute? :name, Types::String
    attribute? :resolved, Types::Bool.optional
    attribute? :room_badge, Types::String
    attribute? :room_id, Types::String
    attribute? :source, Types::String
    attribute? :user_avatar_url, Types::String
    attribute? :user_id, Types::String
  end

  attribute? :is_new_session, Types::Bool.optional
  attribute? :payload, Payload
  attribute? :room_log, RoomLog
end