knockapi 1.38.0 → 1.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +48 -0
  3. data/README.md +1 -1
  4. data/lib/knockapi/models/audience_add_members_params.rb +3 -30
  5. data/lib/knockapi/models/audience_member_request.rb +32 -0
  6. data/lib/knockapi/models/audience_remove_members_params.rb +3 -30
  7. data/lib/knockapi/models/list_messages_response.rb +26 -0
  8. data/lib/knockapi/models/list_schedules_response.rb +26 -0
  9. data/lib/knockapi/models/list_subscriptions_response.rb +26 -0
  10. data/lib/knockapi/models/message.rb +37 -11
  11. data/lib/knockapi/models/{message_get_content_response.rb → message_contents.rb} +30 -156
  12. data/lib/knockapi/models/message_event.rb +3 -3
  13. data/lib/knockapi/models/message_in_app_feed_button_set_block.rb +76 -0
  14. data/lib/knockapi/models/message_in_app_feed_content_block.rb +55 -0
  15. data/lib/knockapi/models/messages/batch_archive_params.rb +2 -10
  16. data/lib/knockapi/models/messages/batch_get_content_response.rb +1 -495
  17. data/lib/knockapi/models/messages/batch_mark_as_read_params.rb +2 -10
  18. data/lib/knockapi/models/messages/batch_mark_as_seen_params.rb +2 -10
  19. data/lib/knockapi/models/messages/batch_mark_as_unread_params.rb +2 -10
  20. data/lib/knockapi/models/messages/batch_mark_as_unseen_params.rb +2 -10
  21. data/lib/knockapi/models/messages/batch_messages_status_request.rb +20 -0
  22. data/lib/knockapi/models/messages/batch_unarchive_params.rb +2 -10
  23. data/lib/knockapi/models/preference_set_commercial_subscribed_setting.rb +19 -0
  24. data/lib/knockapi/models/recipients/preference_set.rb +26 -4
  25. data/lib/knockapi/models/recipients/preference_set_request.rb +26 -4
  26. data/lib/knockapi/models/recipients/slack_channel_data.rb +9 -1
  27. data/lib/knockapi/models/users/bulk_set_preferences_params.rb +26 -4
  28. data/lib/knockapi/models/users/feed_list_items_response.rb +5 -128
  29. data/lib/knockapi/models/users/{guide_mark_message_as_archived_response.rb → guide_action_response.rb} +1 -1
  30. data/lib/knockapi/models/users/guide_archived_request.rb +72 -0
  31. data/lib/knockapi/models/users/guide_interacted_request.rb +60 -0
  32. data/lib/knockapi/models/users/guide_mark_message_as_archived_params.rb +2 -82
  33. data/lib/knockapi/models/users/guide_mark_message_as_interacted_params.rb +2 -82
  34. data/lib/knockapi/models/users/guide_mark_message_as_seen_params.rb +2 -82
  35. data/lib/knockapi/models/users/guide_reset_guide_engagements_params.rb +39 -0
  36. data/lib/knockapi/models/users/guide_seen_request.rb +68 -0
  37. data/lib/knockapi/models/users/guide_unarchive_guide_message_params.rb +39 -0
  38. data/lib/knockapi/models/users/preference_center_branding_config.rb +50 -0
  39. data/lib/knockapi/models/users/preference_center_generate_signed_url_params.rb +22 -0
  40. data/lib/knockapi/models/users/preference_center_generate_signed_url_response.rb +34 -0
  41. data/lib/knockapi/models/users/preference_center_get_config_params.rb +22 -0
  42. data/lib/knockapi/models/users/preference_center_get_config_response.rb +221 -0
  43. data/lib/knockapi/models.rb +16 -0
  44. data/lib/knockapi/resources/audiences.rb +2 -2
  45. data/lib/knockapi/resources/messages/batch.rb +2 -2
  46. data/lib/knockapi/resources/messages.rb +2 -2
  47. data/lib/knockapi/resources/objects.rb +1 -1
  48. data/lib/knockapi/resources/users/guides.rb +79 -42
  49. data/lib/knockapi/resources/users/preference_center.rb +60 -0
  50. data/lib/knockapi/resources/users.rb +7 -1
  51. data/lib/knockapi/version.rb +1 -1
  52. data/lib/knockapi.rb +21 -4
  53. data/rbi/knockapi/models/audience_add_members_params.rbi +3 -56
  54. data/rbi/knockapi/models/audience_member_request.rbi +55 -0
  55. data/rbi/knockapi/models/audience_remove_members_params.rbi +3 -57
  56. data/rbi/knockapi/models/list_messages_response.rbi +46 -0
  57. data/rbi/knockapi/models/list_schedules_response.rbi +49 -0
  58. data/rbi/knockapi/models/list_subscriptions_response.rbi +52 -0
  59. data/rbi/knockapi/models/message.rbi +50 -18
  60. data/rbi/knockapi/models/{message_get_content_response.rbi → message_contents.rbi} +43 -299
  61. data/rbi/knockapi/models/message_event.rbi +9 -9
  62. data/rbi/knockapi/models/message_in_app_feed_button_set_block.rbi +133 -0
  63. data/rbi/knockapi/models/message_in_app_feed_content_block.rbi +97 -0
  64. data/rbi/knockapi/models/messages/batch_archive_params.rbi +6 -22
  65. data/rbi/knockapi/models/messages/batch_get_content_response.rbi +1 -879
  66. data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +6 -22
  67. data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +6 -22
  68. data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +6 -22
  69. data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +6 -22
  70. data/rbi/knockapi/models/messages/batch_messages_status_request.rbi +33 -0
  71. data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +6 -22
  72. data/rbi/knockapi/models/preference_set_commercial_subscribed_setting.rbi +36 -0
  73. data/rbi/knockapi/models/recipients/preference_set.rbi +50 -5
  74. data/rbi/knockapi/models/recipients/preference_set_request.rbi +56 -5
  75. data/rbi/knockapi/models/recipients/slack_channel_data.rbi +8 -0
  76. data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +56 -5
  77. data/rbi/knockapi/models/users/feed_list_items_response.rbi +4 -251
  78. data/rbi/knockapi/models/users/{guide_mark_message_as_seen_response.rbi → guide_action_response.rbi} +2 -2
  79. data/rbi/knockapi/models/users/guide_archived_request.rbi +102 -0
  80. data/rbi/knockapi/models/users/guide_interacted_request.rbi +89 -0
  81. data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +3 -99
  82. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +3 -99
  83. data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +3 -99
  84. data/rbi/knockapi/models/users/guide_reset_guide_engagements_params.rbi +65 -0
  85. data/rbi/knockapi/models/users/guide_seen_request.rbi +97 -0
  86. data/rbi/knockapi/models/users/guide_unarchive_guide_message_params.rbi +65 -0
  87. data/rbi/knockapi/models/users/preference_center_branding_config.rbi +72 -0
  88. data/rbi/knockapi/models/users/preference_center_generate_signed_url_params.rbi +40 -0
  89. data/rbi/knockapi/models/users/preference_center_generate_signed_url_response.rbi +41 -0
  90. data/rbi/knockapi/models/users/preference_center_get_config_params.rbi +40 -0
  91. data/rbi/knockapi/models/users/preference_center_get_config_response.rbi +476 -0
  92. data/rbi/knockapi/models.rbi +18 -0
  93. data/rbi/knockapi/resources/audiences.rbi +2 -3
  94. data/rbi/knockapi/resources/messages/batch.rbi +1 -3
  95. data/rbi/knockapi/resources/messages.rbi +1 -1
  96. data/rbi/knockapi/resources/objects.rbi +10 -2
  97. data/rbi/knockapi/resources/users/guides.rbi +56 -42
  98. data/rbi/knockapi/resources/users/preference_center.rbi +48 -0
  99. data/rbi/knockapi/resources/users.rbi +15 -2
  100. data/sig/knockapi/models/audience_add_members_params.rbs +4 -23
  101. data/sig/knockapi/models/audience_member_request.rbs +22 -0
  102. data/sig/knockapi/models/audience_remove_members_params.rbs +4 -26
  103. data/sig/knockapi/models/list_messages_response.rbs +22 -0
  104. data/sig/knockapi/models/list_schedules_response.rbs +22 -0
  105. data/sig/knockapi/models/list_subscriptions_response.rbs +25 -0
  106. data/sig/knockapi/models/message.rbs +28 -5
  107. data/sig/knockapi/models/message_contents.rbs +286 -0
  108. data/sig/knockapi/models/message_event.rbs +6 -6
  109. data/sig/knockapi/models/message_in_app_feed_button_set_block.rbs +54 -0
  110. data/sig/knockapi/models/message_in_app_feed_content_block.rbs +46 -0
  111. data/sig/knockapi/models/messages/batch_archive_params.rbs +4 -13
  112. data/sig/knockapi/models/messages/batch_get_content_response.rbs +1 -391
  113. data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +4 -13
  114. data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +4 -13
  115. data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +4 -13
  116. data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +4 -13
  117. data/sig/knockapi/models/messages/batch_messages_status_request.rbs +15 -0
  118. data/sig/knockapi/models/messages/batch_unarchive_params.rbs +4 -13
  119. data/sig/knockapi/models/preference_set_commercial_subscribed_setting.rbs +14 -0
  120. data/sig/knockapi/models/recipients/preference_set.rbs +13 -4
  121. data/sig/knockapi/models/recipients/preference_set_request.rbs +13 -4
  122. data/sig/knockapi/models/recipients/slack_channel_data.rbs +10 -1
  123. data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +13 -4
  124. data/sig/knockapi/models/users/feed_list_items_response.rbs +2 -100
  125. data/sig/knockapi/models/users/{guide_mark_message_as_seen_response.rbs → guide_action_response.rbs} +2 -2
  126. data/sig/knockapi/models/users/guide_archived_request.rbs +58 -0
  127. data/sig/knockapi/models/users/guide_interacted_request.rbs +51 -0
  128. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +4 -63
  129. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +4 -63
  130. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +4 -63
  131. data/sig/knockapi/models/users/guide_reset_guide_engagements_params.rbs +36 -0
  132. data/sig/knockapi/models/users/guide_seen_request.rbs +56 -0
  133. data/sig/knockapi/models/users/guide_unarchive_guide_message_params.rbs +36 -0
  134. data/sig/knockapi/models/users/preference_center_branding_config.rbs +37 -0
  135. data/sig/knockapi/models/users/preference_center_generate_signed_url_params.rbs +25 -0
  136. data/sig/knockapi/models/users/preference_center_generate_signed_url_response.rbs +18 -0
  137. data/sig/knockapi/models/users/preference_center_get_config_params.rbs +25 -0
  138. data/sig/knockapi/models/users/preference_center_get_config_response.rbs +189 -0
  139. data/sig/knockapi/models.rbs +16 -0
  140. data/sig/knockapi/resources/audiences.rbs +2 -2
  141. data/sig/knockapi/resources/messages.rbs +1 -1
  142. data/sig/knockapi/resources/objects.rbs +1 -1
  143. data/sig/knockapi/resources/users/guides.rbs +22 -18
  144. data/sig/knockapi/resources/users/preference_center.rbs +19 -0
  145. data/sig/knockapi/resources/users.rbs +3 -1
  146. metadata +65 -14
  147. data/lib/knockapi/models/users/guide_mark_message_as_interacted_response.rb +0 -21
  148. data/lib/knockapi/models/users/guide_mark_message_as_seen_response.rb +0 -21
  149. data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +0 -33
  150. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +0 -33
  151. data/sig/knockapi/models/message_get_content_response.rbs +0 -384
  152. data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -15
  153. data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -15
@@ -3,887 +3,9 @@
3
3
  module Knockapi
4
4
  module Models
5
5
  module Messages
6
- class BatchGetContentResponseItem < Knockapi::Internal::Type::BaseModel
7
- OrHash =
8
- T.type_alias do
9
- T.any(
10
- Knockapi::Models::Messages::BatchGetContentResponseItem,
11
- Knockapi::Internal::AnyHash
12
- )
13
- end
14
-
15
- # The typename of the schema.
16
- sig { returns(String) }
17
- attr_accessor :_typename
18
-
19
- # Content data specific to the channel type.
20
- sig do
21
- returns(
22
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::Variants
23
- )
24
- end
25
- attr_accessor :data
26
-
27
- # Timestamp when the message content was created.
28
- sig { returns(Time) }
29
- attr_accessor :inserted_at
30
-
31
- # The unique identifier for the message content.
32
- sig { returns(String) }
33
- attr_accessor :message_id
34
-
35
- # The content of a message.
36
- sig do
37
- params(
38
- _typename: String,
39
- data:
40
- T.any(
41
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent::OrHash,
42
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent::OrHash,
43
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent::OrHash,
44
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::OrHash,
45
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::OrHash
46
- ),
47
- inserted_at: Time,
48
- message_id: String
49
- ).returns(T.attached_class)
50
- end
51
- def self.new(
52
- # The typename of the schema.
53
- _typename:,
54
- # Content data specific to the channel type.
55
- data:,
56
- # Timestamp when the message content was created.
57
- inserted_at:,
58
- # The unique identifier for the message content.
59
- message_id:
60
- )
61
- end
62
-
63
- sig do
64
- override.returns(
65
- {
66
- _typename: String,
67
- data:
68
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::Variants,
69
- inserted_at: Time,
70
- message_id: String
71
- }
72
- )
73
- end
74
- def to_hash
75
- end
76
-
77
- # Content data specific to the channel type.
78
- module Data
79
- extend Knockapi::Internal::Type::Union
80
-
81
- Variants =
82
- T.type_alias do
83
- T.any(
84
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent,
85
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent,
86
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent,
87
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent,
88
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent
89
- )
90
- end
91
-
92
- class MessageEmailContent < Knockapi::Internal::Type::BaseModel
93
- OrHash =
94
- T.type_alias do
95
- T.any(
96
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent,
97
- Knockapi::Internal::AnyHash
98
- )
99
- end
100
-
101
- # The typename of the schema.
102
- sig { returns(String) }
103
- attr_accessor :_typename
104
-
105
- # The sender's email address.
106
- sig { returns(String) }
107
- attr_accessor :from
108
-
109
- # The HTML body of the email message.
110
- sig { returns(String) }
111
- attr_accessor :html_body
112
-
113
- # The subject line of the email message.
114
- sig { returns(String) }
115
- attr_accessor :subject_line
116
-
117
- # The text body of the email message.
118
- sig { returns(String) }
119
- attr_accessor :text_body
120
-
121
- # The recipient's email address.
122
- sig { returns(String) }
123
- attr_accessor :to
124
-
125
- # The BCC email addresses.
126
- sig { returns(T.nilable(String)) }
127
- attr_accessor :bcc
128
-
129
- # The CC email addresses.
130
- sig { returns(T.nilable(String)) }
131
- attr_accessor :cc
132
-
133
- # The reply-to email address.
134
- sig { returns(T.nilable(String)) }
135
- attr_accessor :reply_to
136
-
137
- # The content of an email message.
138
- sig do
139
- params(
140
- _typename: String,
141
- from: String,
142
- html_body: String,
143
- subject_line: String,
144
- text_body: String,
145
- to: String,
146
- bcc: T.nilable(String),
147
- cc: T.nilable(String),
148
- reply_to: T.nilable(String)
149
- ).returns(T.attached_class)
150
- end
151
- def self.new(
152
- # The typename of the schema.
153
- _typename:,
154
- # The sender's email address.
155
- from:,
156
- # The HTML body of the email message.
157
- html_body:,
158
- # The subject line of the email message.
159
- subject_line:,
160
- # The text body of the email message.
161
- text_body:,
162
- # The recipient's email address.
163
- to:,
164
- # The BCC email addresses.
165
- bcc: nil,
166
- # The CC email addresses.
167
- cc: nil,
168
- # The reply-to email address.
169
- reply_to: nil
170
- )
171
- end
172
-
173
- sig do
174
- override.returns(
175
- {
176
- _typename: String,
177
- from: String,
178
- html_body: String,
179
- subject_line: String,
180
- text_body: String,
181
- to: String,
182
- bcc: T.nilable(String),
183
- cc: T.nilable(String),
184
- reply_to: T.nilable(String)
185
- }
186
- )
187
- end
188
- def to_hash
189
- end
190
- end
191
-
192
- class MessageSMSContent < Knockapi::Internal::Type::BaseModel
193
- OrHash =
194
- T.type_alias do
195
- T.any(
196
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent,
197
- Knockapi::Internal::AnyHash
198
- )
199
- end
200
-
201
- # The typename of the schema.
202
- sig { returns(String) }
203
- attr_accessor :_typename
204
-
205
- # The content body of the SMS message.
206
- sig { returns(String) }
207
- attr_accessor :body
208
-
209
- # The phone number the SMS was sent to.
210
- sig { returns(String) }
211
- attr_accessor :to
212
-
213
- # The content of an SMS message.
214
- sig do
215
- params(_typename: String, body: String, to: String).returns(
216
- T.attached_class
217
- )
218
- end
219
- def self.new(
220
- # The typename of the schema.
221
- _typename:,
222
- # The content body of the SMS message.
223
- body:,
224
- # The phone number the SMS was sent to.
225
- to:
226
- )
227
- end
228
-
229
- sig do
230
- override.returns({ _typename: String, body: String, to: String })
231
- end
232
- def to_hash
233
- end
234
- end
235
-
236
- class MessagePushContent < Knockapi::Internal::Type::BaseModel
237
- OrHash =
238
- T.type_alias do
239
- T.any(
240
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent,
241
- Knockapi::Internal::AnyHash
242
- )
243
- end
244
-
245
- # The device token to send the push notification to.
246
- sig { returns(String) }
247
- attr_accessor :token
248
-
249
- # The typename of the schema.
250
- sig { returns(String) }
251
- attr_accessor :_typename
252
-
253
- # The content body of the push notification.
254
- sig { returns(String) }
255
- attr_accessor :body
256
-
257
- # The title of the push notification.
258
- sig { returns(String) }
259
- attr_accessor :title
260
-
261
- # Additional data payload for the push notification.
262
- sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
263
- attr_accessor :data
264
-
265
- # Push channel data.
266
- sig do
267
- params(
268
- token: String,
269
- _typename: String,
270
- body: String,
271
- title: String,
272
- data: T.nilable(T::Hash[Symbol, T.anything])
273
- ).returns(T.attached_class)
274
- end
275
- def self.new(
276
- # The device token to send the push notification to.
277
- token:,
278
- # The typename of the schema.
279
- _typename:,
280
- # The content body of the push notification.
281
- body:,
282
- # The title of the push notification.
283
- title:,
284
- # Additional data payload for the push notification.
285
- data: nil
286
- )
287
- end
288
-
289
- sig do
290
- override.returns(
291
- {
292
- token: String,
293
- _typename: String,
294
- body: String,
295
- title: String,
296
- data: T.nilable(T::Hash[Symbol, T.anything])
297
- }
298
- )
299
- end
300
- def to_hash
301
- end
302
- end
303
-
304
- class MessageChatContent < Knockapi::Internal::Type::BaseModel
305
- OrHash =
306
- T.type_alias do
307
- T.any(
308
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent,
309
- Knockapi::Internal::AnyHash
310
- )
311
- end
312
-
313
- # The typename of the schema.
314
- sig { returns(String) }
315
- attr_accessor :_typename
316
-
317
- # The channel data connection from the recipient to the underlying provider.
318
- sig { returns(T::Hash[Symbol, T.anything]) }
319
- attr_accessor :connection
320
-
321
- # The template structure for the chat message.
322
- sig do
323
- returns(
324
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template
325
- )
326
- end
327
- attr_reader :template
328
-
329
- sig do
330
- params(
331
- template:
332
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::OrHash
333
- ).void
334
- end
335
- attr_writer :template
336
-
337
- # Additional metadata associated with the chat message.
338
- sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
339
- attr_accessor :metadata
340
-
341
- # The content of a chat message.
342
- sig do
343
- params(
344
- _typename: String,
345
- connection: T::Hash[Symbol, T.anything],
346
- template:
347
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::OrHash,
348
- metadata: T.nilable(T::Hash[Symbol, T.anything])
349
- ).returns(T.attached_class)
350
- end
351
- def self.new(
352
- # The typename of the schema.
353
- _typename:,
354
- # The channel data connection from the recipient to the underlying provider.
355
- connection:,
356
- # The template structure for the chat message.
357
- template:,
358
- # Additional metadata associated with the chat message.
359
- metadata: nil
360
- )
361
- end
362
-
363
- sig do
364
- override.returns(
365
- {
366
- _typename: String,
367
- connection: T::Hash[Symbol, T.anything],
368
- template:
369
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template,
370
- metadata: T.nilable(T::Hash[Symbol, T.anything])
371
- }
372
- )
373
- end
374
- def to_hash
375
- end
376
-
377
- class Template < Knockapi::Internal::Type::BaseModel
378
- OrHash =
379
- T.type_alias do
380
- T.any(
381
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template,
382
- Knockapi::Internal::AnyHash
383
- )
384
- end
385
-
386
- # The blocks of the message in a chat.
387
- sig do
388
- returns(
389
- T.nilable(
390
- T::Array[
391
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block
392
- ]
393
- )
394
- )
395
- end
396
- attr_accessor :blocks
397
-
398
- # The JSON content of the message.
399
- sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
400
- attr_accessor :json_content
401
-
402
- # The summary of the chat message.
403
- sig { returns(T.nilable(String)) }
404
- attr_accessor :summary
405
-
406
- # The template structure for the chat message.
407
- sig do
408
- params(
409
- blocks:
410
- T.nilable(
411
- T::Array[
412
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::OrHash
413
- ]
414
- ),
415
- json_content: T.nilable(T::Hash[Symbol, T.anything]),
416
- summary: T.nilable(String)
417
- ).returns(T.attached_class)
418
- end
419
- def self.new(
420
- # The blocks of the message in a chat.
421
- blocks: nil,
422
- # The JSON content of the message.
423
- json_content: nil,
424
- # The summary of the chat message.
425
- summary: nil
426
- )
427
- end
428
-
429
- sig do
430
- override.returns(
431
- {
432
- blocks:
433
- T.nilable(
434
- T::Array[
435
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block
436
- ]
437
- ),
438
- json_content: T.nilable(T::Hash[Symbol, T.anything]),
439
- summary: T.nilable(String)
440
- }
441
- )
442
- end
443
- def to_hash
444
- end
445
-
446
- class Block < Knockapi::Internal::Type::BaseModel
447
- OrHash =
448
- T.type_alias do
449
- T.any(
450
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block,
451
- Knockapi::Internal::AnyHash
452
- )
453
- end
454
-
455
- # The actual content of the block.
456
- sig { returns(String) }
457
- attr_accessor :content
458
-
459
- # The name of the block for identification.
460
- sig { returns(String) }
461
- attr_accessor :name
462
-
463
- # The type of block in a message in a chat (text or markdown).
464
- sig do
465
- returns(
466
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
467
- )
468
- end
469
- attr_accessor :type
470
-
471
- # A block in a message in a chat.
472
- sig do
473
- params(
474
- content: String,
475
- name: String,
476
- type:
477
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type::OrSymbol
478
- ).returns(T.attached_class)
479
- end
480
- def self.new(
481
- # The actual content of the block.
482
- content:,
483
- # The name of the block for identification.
484
- name:,
485
- # The type of block in a message in a chat (text or markdown).
486
- type:
487
- )
488
- end
489
-
490
- sig do
491
- override.returns(
492
- {
493
- content: String,
494
- name: String,
495
- type:
496
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
497
- }
498
- )
499
- end
500
- def to_hash
501
- end
502
-
503
- # The type of block in a message in a chat (text or markdown).
504
- module Type
505
- extend Knockapi::Internal::Type::Enum
506
-
507
- TaggedSymbol =
508
- T.type_alias do
509
- T.all(
510
- Symbol,
511
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type
512
- )
513
- end
514
- OrSymbol = T.type_alias { T.any(Symbol, String) }
515
-
516
- TEXT =
517
- T.let(
518
- :text,
519
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
520
- )
521
- MARKDOWN =
522
- T.let(
523
- :markdown,
524
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
525
- )
526
-
527
- sig do
528
- override.returns(
529
- T::Array[
530
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type::TaggedSymbol
531
- ]
532
- )
533
- end
534
- def self.values
535
- end
536
- end
537
- end
538
- end
539
- end
540
-
541
- class MessageInAppFeedContent < Knockapi::Internal::Type::BaseModel
542
- OrHash =
543
- T.type_alias do
544
- T.any(
545
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent,
546
- Knockapi::Internal::AnyHash
547
- )
548
- end
549
-
550
- # The typename of the schema.
551
- sig { returns(String) }
552
- attr_accessor :_typename
553
-
554
- # The blocks of the message in an app feed.
555
- sig do
556
- returns(
557
- T::Array[
558
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::Variants
559
- ]
560
- )
561
- end
562
- attr_accessor :blocks
563
-
564
- # The content of an in-app feed message.
565
- sig do
566
- params(
567
- _typename: String,
568
- blocks:
569
- T::Array[
570
- T.any(
571
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::OrHash,
572
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::OrHash
573
- )
574
- ]
575
- ).returns(T.attached_class)
576
- end
577
- def self.new(
578
- # The typename of the schema.
579
- _typename:,
580
- # The blocks of the message in an app feed.
581
- blocks:
582
- )
583
- end
584
-
585
- sig do
586
- override.returns(
587
- {
588
- _typename: String,
589
- blocks:
590
- T::Array[
591
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::Variants
592
- ]
593
- }
594
- )
595
- end
596
- def to_hash
597
- end
598
-
599
- # A block in a message in an app feed.
600
- module Block
601
- extend Knockapi::Internal::Type::Union
602
-
603
- Variants =
604
- T.type_alias do
605
- T.any(
606
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
607
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
608
- )
609
- end
610
-
611
- class MessageInAppFeedContentBlock < Knockapi::Internal::Type::BaseModel
612
- OrHash =
613
- T.type_alias do
614
- T.any(
615
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
616
- Knockapi::Internal::AnyHash
617
- )
618
- end
619
-
620
- # The content of the block in a message in an app feed.
621
- sig { returns(String) }
622
- attr_accessor :content
623
-
624
- # The name of the block in a message in an app feed.
625
- sig { returns(String) }
626
- attr_accessor :name
627
-
628
- # The rendered HTML version of the content.
629
- sig { returns(String) }
630
- attr_accessor :rendered
631
-
632
- # The type of block in a message in an app feed.
633
- sig do
634
- returns(
635
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
636
- )
637
- end
638
- attr_accessor :type
639
-
640
- # A block in a message in an app feed.
641
- sig do
642
- params(
643
- content: String,
644
- name: String,
645
- rendered: String,
646
- type:
647
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::OrSymbol
648
- ).returns(T.attached_class)
649
- end
650
- def self.new(
651
- # The content of the block in a message in an app feed.
652
- content:,
653
- # The name of the block in a message in an app feed.
654
- name:,
655
- # The rendered HTML version of the content.
656
- rendered:,
657
- # The type of block in a message in an app feed.
658
- type:
659
- )
660
- end
661
-
662
- sig do
663
- override.returns(
664
- {
665
- content: String,
666
- name: String,
667
- rendered: String,
668
- type:
669
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
670
- }
671
- )
672
- end
673
- def to_hash
674
- end
675
-
676
- # The type of block in a message in an app feed.
677
- module Type
678
- extend Knockapi::Internal::Type::Enum
679
-
680
- TaggedSymbol =
681
- T.type_alias do
682
- T.all(
683
- Symbol,
684
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type
685
- )
686
- end
687
- OrSymbol = T.type_alias { T.any(Symbol, String) }
688
-
689
- MARKDOWN =
690
- T.let(
691
- :markdown,
692
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
693
- )
694
- TEXT =
695
- T.let(
696
- :text,
697
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
698
- )
699
-
700
- sig do
701
- override.returns(
702
- T::Array[
703
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type::TaggedSymbol
704
- ]
705
- )
706
- end
707
- def self.values
708
- end
709
- end
710
- end
711
-
712
- class MessageInAppFeedButtonSetBlock < Knockapi::Internal::Type::BaseModel
713
- OrHash =
714
- T.type_alias do
715
- T.any(
716
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock,
717
- Knockapi::Internal::AnyHash
718
- )
719
- end
720
-
721
- # A list of buttons in an in app feed message.
722
- sig do
723
- returns(
724
- T::Array[
725
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button
726
- ]
727
- )
728
- end
729
- attr_accessor :buttons
730
-
731
- # The name of the button set in a message in an app feed.
732
- sig { returns(String) }
733
- attr_accessor :name
734
-
735
- # The type of block in a message in an app feed.
736
- sig do
737
- returns(
738
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
739
- )
740
- end
741
- attr_accessor :type
742
-
743
- # A button set block in a message in an app feed.
744
- sig do
745
- params(
746
- buttons:
747
- T::Array[
748
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button::OrHash
749
- ],
750
- name: String,
751
- type:
752
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::OrSymbol
753
- ).returns(T.attached_class)
754
- end
755
- def self.new(
756
- # A list of buttons in an in app feed message.
757
- buttons:,
758
- # The name of the button set in a message in an app feed.
759
- name:,
760
- # The type of block in a message in an app feed.
761
- type:
762
- )
763
- end
764
-
765
- sig do
766
- override.returns(
767
- {
768
- buttons:
769
- T::Array[
770
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button
771
- ],
772
- name: String,
773
- type:
774
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
775
- }
776
- )
777
- end
778
- def to_hash
779
- end
780
-
781
- class Button < Knockapi::Internal::Type::BaseModel
782
- OrHash =
783
- T.type_alias do
784
- T.any(
785
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button,
786
- Knockapi::Internal::AnyHash
787
- )
788
- end
789
-
790
- # The action to take when the button is clicked.
791
- sig { returns(String) }
792
- attr_accessor :action
793
-
794
- # The label of the button.
795
- sig { returns(String) }
796
- attr_accessor :label
797
-
798
- # The name of the button.
799
- sig { returns(String) }
800
- attr_accessor :name
801
-
802
- # A button in an in app feed message.
803
- sig do
804
- params(action: String, label: String, name: String).returns(
805
- T.attached_class
806
- )
807
- end
808
- def self.new(
809
- # The action to take when the button is clicked.
810
- action:,
811
- # The label of the button.
812
- label:,
813
- # The name of the button.
814
- name:
815
- )
816
- end
817
-
818
- sig do
819
- override.returns(
820
- { action: String, label: String, name: String }
821
- )
822
- end
823
- def to_hash
824
- end
825
- end
826
-
827
- # The type of block in a message in an app feed.
828
- module Type
829
- extend Knockapi::Internal::Type::Enum
830
-
831
- TaggedSymbol =
832
- T.type_alias do
833
- T.all(
834
- Symbol,
835
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type
836
- )
837
- end
838
- OrSymbol = T.type_alias { T.any(Symbol, String) }
839
-
840
- BUTTON_SET =
841
- T.let(
842
- :button_set,
843
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
844
- )
845
-
846
- sig do
847
- override.returns(
848
- T::Array[
849
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type::TaggedSymbol
850
- ]
851
- )
852
- end
853
- def self.values
854
- end
855
- end
856
- end
857
-
858
- sig do
859
- override.returns(
860
- T::Array[
861
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::Variants
862
- ]
863
- )
864
- end
865
- def self.variants
866
- end
867
- end
868
- end
869
-
870
- sig do
871
- override.returns(
872
- T::Array[
873
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::Variants
874
- ]
875
- )
876
- end
877
- def self.variants
878
- end
879
- end
880
- end
881
-
882
6
  BatchGetContentResponse =
883
7
  T.let(
884
- Knockapi::Internal::Type::ArrayOf[
885
- Knockapi::Models::Messages::BatchGetContentResponseItem
886
- ],
8
+ Knockapi::Internal::Type::ArrayOf[Knockapi::MessageContents],
887
9
  Knockapi::Internal::Type::Converter
888
10
  )
889
11
  end