knockapi 1.1.0 → 1.3.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 (307) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +42 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/knockapi/internal/items_cursor.rb +2 -2
  6. data/lib/knockapi/internal/type/array_of.rb +8 -0
  7. data/lib/knockapi/internal/type/base_model.rb +7 -0
  8. data/lib/knockapi/internal/type/boolean.rb +8 -0
  9. data/lib/knockapi/internal/type/enum.rb +12 -0
  10. data/lib/knockapi/internal/type/file_input.rb +7 -0
  11. data/lib/knockapi/internal/type/hash_of.rb +8 -0
  12. data/lib/knockapi/internal/type/union.rb +12 -0
  13. data/lib/knockapi/internal/type/unknown.rb +8 -0
  14. data/lib/knockapi/internal/util.rb +54 -1
  15. data/lib/knockapi/internal.rb +3 -0
  16. data/lib/knockapi/models/activity.rb +4 -4
  17. data/lib/knockapi/models/audience_add_members_params.rb +5 -5
  18. data/lib/knockapi/models/audience_list_members_response.rb +4 -4
  19. data/lib/knockapi/models/audience_member.rb +4 -4
  20. data/lib/knockapi/models/audience_remove_members_params.rb +5 -5
  21. data/lib/knockapi/models/bulk_operation.rb +5 -5
  22. data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +6 -6
  23. data/lib/knockapi/models/condition.rb +3 -3
  24. data/lib/knockapi/models/identify_user_request.rb +5 -5
  25. data/lib/knockapi/models/inline_identify_user_request.rb +5 -5
  26. data/lib/knockapi/models/inline_object_request.rb +4 -4
  27. data/lib/knockapi/models/inline_tenant_request.rb +1 -5
  28. data/lib/knockapi/models/message.rb +14 -14
  29. data/lib/knockapi/models/message_delivery_log.rb +13 -21
  30. data/lib/knockapi/models/message_event.rb +7 -7
  31. data/lib/knockapi/models/message_get_content_response.rb +0 -21
  32. data/lib/knockapi/models/message_list_params.rb +11 -8
  33. data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
  34. data/lib/knockapi/models/messages/batch_get_content_response.rb +0 -21
  35. data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
  36. data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
  37. data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
  38. data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
  39. data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
  40. data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
  41. data/lib/knockapi/models/object_add_subscriptions_params.rb +2 -2
  42. data/lib/knockapi/models/object_delete_subscriptions_params.rb +2 -2
  43. data/lib/knockapi/models/object_list_messages_params.rb +11 -8
  44. data/lib/knockapi/models/object_list_params.rb +2 -2
  45. data/lib/knockapi/models/object_list_subscriptions_params.rb +8 -8
  46. data/lib/knockapi/models/object_set_params.rb +4 -4
  47. data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +6 -5
  48. data/lib/knockapi/models/objects/bulk_set_params.rb +2 -2
  49. data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -3
  50. data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -3
  51. data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -3
  52. data/lib/knockapi/models/recipient.rb +1 -5
  53. data/lib/knockapi/models/recipient_reference.rb +1 -5
  54. data/lib/knockapi/models/recipient_request.rb +1 -5
  55. data/lib/knockapi/models/recipients/channel_data.rb +7 -19
  56. data/lib/knockapi/models/recipients/channel_data_request.rb +4 -16
  57. data/lib/knockapi/models/recipients/discord_channel_data.rb +6 -15
  58. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +1 -13
  59. data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +6 -15
  60. data/lib/knockapi/models/recipients/preference_set.rb +17 -35
  61. data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +2 -2
  62. data/lib/knockapi/models/recipients/preference_set_channel_types.rb +24 -48
  63. data/lib/knockapi/models/recipients/preference_set_request.rb +17 -35
  64. data/lib/knockapi/models/recipients/slack_channel_data.rb +6 -15
  65. data/lib/knockapi/models/recipients/subscription.rb +4 -4
  66. data/lib/knockapi/models/schedule.rb +13 -10
  67. data/lib/knockapi/models/schedule_create_params.rb +14 -8
  68. data/lib/knockapi/models/schedule_repeat_rule.rb +5 -5
  69. data/lib/knockapi/models/schedule_update_params.rb +11 -8
  70. data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -13
  71. data/lib/knockapi/models/tenant.rb +10 -10
  72. data/lib/knockapi/models/tenant_request.rb +13 -13
  73. data/lib/knockapi/models/tenant_set_params.rb +12 -12
  74. data/lib/knockapi/models/tenants/bulk_set_params.rb +2 -2
  75. data/lib/knockapi/models/user.rb +2 -2
  76. data/lib/knockapi/models/user_list_messages_params.rb +11 -8
  77. data/lib/knockapi/models/user_list_params.rb +2 -2
  78. data/lib/knockapi/models/user_list_subscriptions_params.rb +2 -2
  79. data/lib/knockapi/models/users/bulk_identify_params.rb +2 -2
  80. data/lib/knockapi/models/users/bulk_set_preferences_params.rb +2 -2
  81. data/lib/knockapi/models/users/feed_list_items_params.rb +4 -4
  82. data/lib/knockapi/models/users/feed_list_items_response.rb +4 -13
  83. data/lib/knockapi/models/workflow_cancel_params.rb +2 -2
  84. data/lib/knockapi/models/workflow_trigger_params.rb +11 -8
  85. data/lib/knockapi/models.rb +30 -19
  86. data/lib/knockapi/resources/audiences.rb +2 -2
  87. data/lib/knockapi/resources/bulk_operations.rb +1 -1
  88. data/lib/knockapi/resources/channels/bulk.rb +5 -5
  89. data/lib/knockapi/resources/messages/batch.rb +14 -14
  90. data/lib/knockapi/resources/messages.rb +18 -18
  91. data/lib/knockapi/resources/objects/bulk.rb +5 -5
  92. data/lib/knockapi/resources/objects.rb +30 -30
  93. data/lib/knockapi/resources/providers/ms_teams.rb +2 -2
  94. data/lib/knockapi/resources/providers/slack.rb +1 -1
  95. data/lib/knockapi/resources/schedules/bulk.rb +2 -2
  96. data/lib/knockapi/resources/schedules.rb +15 -12
  97. data/lib/knockapi/resources/tenants/bulk.rb +3 -3
  98. data/lib/knockapi/resources/tenants.rb +6 -6
  99. data/lib/knockapi/resources/users/bulk.rb +5 -5
  100. data/lib/knockapi/resources/users/feeds.rb +2 -2
  101. data/lib/knockapi/resources/users.rb +24 -24
  102. data/lib/knockapi/resources/workflows.rb +5 -5
  103. data/lib/knockapi/version.rb +1 -1
  104. data/lib/knockapi.rb +3 -1
  105. data/rbi/knockapi/internal/type/array_of.rbi +6 -0
  106. data/rbi/knockapi/internal/type/base_model.rbi +5 -0
  107. data/rbi/knockapi/internal/type/boolean.rbi +6 -0
  108. data/rbi/knockapi/internal/type/enum.rbi +5 -0
  109. data/rbi/knockapi/internal/type/file_input.rbi +5 -0
  110. data/rbi/knockapi/internal/type/hash_of.rbi +6 -0
  111. data/rbi/knockapi/internal/type/union.rbi +5 -0
  112. data/rbi/knockapi/internal/type/unknown.rbi +6 -0
  113. data/rbi/knockapi/internal/util.rbi +34 -0
  114. data/rbi/knockapi/internal.rbi +3 -0
  115. data/rbi/knockapi/models/activity.rbi +4 -4
  116. data/rbi/knockapi/models/message.rbi +4 -20
  117. data/rbi/knockapi/models/message_delivery_log.rbi +24 -8
  118. data/rbi/knockapi/models/message_event.rbi +2 -5
  119. data/rbi/knockapi/models/message_get_content_response.rbi +4 -25
  120. data/rbi/knockapi/models/message_list_params.rbi +19 -4
  121. data/rbi/knockapi/models/messages/batch_archive_response.rbi +1 -1
  122. data/rbi/knockapi/models/messages/batch_get_content_response.rbi +4 -22
  123. data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +1 -1
  124. data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +1 -1
  125. data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +1 -1
  126. data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +1 -1
  127. data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +1 -1
  128. data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +1 -1
  129. data/rbi/knockapi/models/object_list_messages_params.rbi +19 -4
  130. data/rbi/knockapi/models/recipients/channel_data.rbi +2 -17
  131. data/rbi/knockapi/models/recipients/preference_set.rbi +4 -16
  132. data/rbi/knockapi/models/recipients/subscription.rbi +2 -2
  133. data/rbi/knockapi/models/schedule.rbi +12 -6
  134. data/rbi/knockapi/models/schedule_create_params.rbi +8 -2
  135. data/rbi/knockapi/models/schedule_update_params.rbi +8 -2
  136. data/rbi/knockapi/models/schedules/bulk_create_params.rbi +8 -2
  137. data/rbi/knockapi/models/user_list_messages_params.rbi +19 -4
  138. data/rbi/knockapi/models/users/feed_list_items_response.rbi +4 -10
  139. data/rbi/knockapi/models/workflow_trigger_params.rbi +8 -2
  140. data/rbi/knockapi/resources/messages/batch.rbi +7 -7
  141. data/rbi/knockapi/resources/messages.rbi +3 -5
  142. data/rbi/knockapi/resources/objects.rbi +1 -1
  143. data/rbi/knockapi/resources/schedules.rbi +8 -2
  144. data/rbi/knockapi/resources/users.rbi +1 -1
  145. data/rbi/knockapi/resources/workflows.rbi +4 -1
  146. data/sig/knockapi/internal/entries_cursor.rbs +2 -0
  147. data/sig/knockapi/internal/items_cursor.rbs +2 -0
  148. data/sig/knockapi/internal/type/array_of.rbs +3 -0
  149. data/sig/knockapi/internal/type/base_model.rbs +2 -0
  150. data/sig/knockapi/internal/type/boolean.rbs +3 -0
  151. data/sig/knockapi/internal/type/enum.rbs +2 -0
  152. data/sig/knockapi/internal/type/file_input.rbs +2 -0
  153. data/sig/knockapi/internal/type/hash_of.rbs +3 -0
  154. data/sig/knockapi/internal/type/union.rbs +2 -0
  155. data/sig/knockapi/internal/type/unknown.rbs +3 -0
  156. data/sig/knockapi/internal/util.rbs +12 -0
  157. data/sig/knockapi/internal.rbs +2 -0
  158. data/sig/knockapi/models/activity.rbs +10 -0
  159. data/sig/knockapi/models/audience_add_members_params.rbs +12 -0
  160. data/sig/knockapi/models/audience_list_members_params.rbs +2 -0
  161. data/sig/knockapi/models/audience_list_members_response.rbs +5 -0
  162. data/sig/knockapi/models/audience_member.rbs +8 -0
  163. data/sig/knockapi/models/audience_remove_members_params.rbs +12 -0
  164. data/sig/knockapi/models/bulk_operation.rbs +24 -4
  165. data/sig/knockapi/models/bulk_operation_get_params.rbs +2 -0
  166. data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +14 -0
  167. data/sig/knockapi/models/condition.rbs +10 -4
  168. data/sig/knockapi/models/identify_user_request.rbs +12 -0
  169. data/sig/knockapi/models/inline_identify_user_request.rbs +13 -0
  170. data/sig/knockapi/models/inline_object_request.rbs +8 -0
  171. data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +8 -0
  172. data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +2 -0
  173. data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +8 -0
  174. data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +2 -0
  175. data/sig/knockapi/models/message.rbs +44 -11
  176. data/sig/knockapi/models/message_archive_params.rbs +2 -0
  177. data/sig/knockapi/models/message_delivery_log.rbs +43 -18
  178. data/sig/knockapi/models/message_event.rbs +13 -4
  179. data/sig/knockapi/models/message_get_content_params.rbs +2 -0
  180. data/sig/knockapi/models/message_get_content_response.rbs +68 -0
  181. data/sig/knockapi/models/message_get_params.rbs +2 -0
  182. data/sig/knockapi/models/message_list_activities_params.rbs +8 -0
  183. data/sig/knockapi/models/message_list_delivery_logs_params.rbs +7 -0
  184. data/sig/knockapi/models/message_list_events_params.rbs +7 -0
  185. data/sig/knockapi/models/message_list_params.rbs +45 -15
  186. data/sig/knockapi/models/message_mark_as_interacted_params.rbs +5 -0
  187. data/sig/knockapi/models/message_mark_as_read_params.rbs +2 -0
  188. data/sig/knockapi/models/message_mark_as_seen_params.rbs +2 -0
  189. data/sig/knockapi/models/message_mark_as_unread_params.rbs +2 -0
  190. data/sig/knockapi/models/message_mark_as_unseen_params.rbs +2 -0
  191. data/sig/knockapi/models/message_unarchive_params.rbs +2 -0
  192. data/sig/knockapi/models/messages/batch_archive_params.rbs +5 -0
  193. data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
  194. data/sig/knockapi/models/messages/batch_get_content_params.rbs +5 -0
  195. data/sig/knockapi/models/messages/batch_get_content_response.rbs +72 -0
  196. data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +6 -0
  197. data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +2 -1
  198. data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +5 -0
  199. data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
  200. data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +5 -0
  201. data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
  202. data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +5 -0
  203. data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
  204. data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +5 -0
  205. data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
  206. data/sig/knockapi/models/messages/batch_unarchive_params.rbs +5 -0
  207. data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
  208. data/sig/knockapi/models/object.rbs +9 -0
  209. data/sig/knockapi/models/object_add_subscriptions_params.rbs +6 -0
  210. data/sig/knockapi/models/object_delete_params.rbs +2 -0
  211. data/sig/knockapi/models/object_delete_subscriptions_params.rbs +5 -0
  212. data/sig/knockapi/models/object_get_channel_data_params.rbs +2 -0
  213. data/sig/knockapi/models/object_get_params.rbs +2 -0
  214. data/sig/knockapi/models/object_get_preferences_params.rbs +2 -0
  215. data/sig/knockapi/models/object_list_messages_params.rbs +45 -15
  216. data/sig/knockapi/models/object_list_params.rbs +14 -6
  217. data/sig/knockapi/models/object_list_preferences_params.rbs +2 -0
  218. data/sig/knockapi/models/object_list_schedules_params.rbs +9 -0
  219. data/sig/knockapi/models/object_list_subscriptions_params.rbs +19 -6
  220. data/sig/knockapi/models/object_set_channel_data_params.rbs +2 -0
  221. data/sig/knockapi/models/object_set_params.rbs +8 -0
  222. data/sig/knockapi/models/object_set_preferences_params.rbs +2 -0
  223. data/sig/knockapi/models/object_unset_channel_data_params.rbs +2 -0
  224. data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +10 -0
  225. data/sig/knockapi/models/objects/bulk_delete_params.rbs +5 -0
  226. data/sig/knockapi/models/objects/bulk_set_params.rbs +5 -0
  227. data/sig/knockapi/models/page_info.rbs +7 -0
  228. data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +5 -0
  229. data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +6 -0
  230. data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +9 -0
  231. data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +13 -0
  232. data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +13 -0
  233. data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +6 -0
  234. data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +5 -0
  235. data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +2 -0
  236. data/sig/knockapi/models/providers/slack_check_auth_params.rbs +5 -0
  237. data/sig/knockapi/models/providers/slack_check_auth_response.rbs +6 -0
  238. data/sig/knockapi/models/providers/slack_list_channels_params.rbs +14 -0
  239. data/sig/knockapi/models/providers/slack_list_channels_response.rbs +8 -0
  240. data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +5 -0
  241. data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +2 -0
  242. data/sig/knockapi/models/recipient_reference.rbs +2 -0
  243. data/sig/knockapi/models/recipients/channel_data.rbs +17 -10
  244. data/sig/knockapi/models/recipients/channel_data_request.rbs +8 -4
  245. data/sig/knockapi/models/recipients/discord_channel_data.rbs +16 -4
  246. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +2 -2
  247. data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +22 -4
  248. data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +2 -0
  249. data/sig/knockapi/models/recipients/preference_set.rbs +25 -8
  250. data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +2 -0
  251. data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +45 -36
  252. data/sig/knockapi/models/recipients/preference_set_request.rbs +24 -8
  253. data/sig/knockapi/models/recipients/push_channel_data.rbs +2 -0
  254. data/sig/knockapi/models/recipients/slack_channel_data.rbs +19 -4
  255. data/sig/knockapi/models/recipients/subscription.rbs +9 -0
  256. data/sig/knockapi/models/schedule.rbs +15 -0
  257. data/sig/knockapi/models/schedule_create_params.rbs +11 -0
  258. data/sig/knockapi/models/schedule_delete_params.rbs +5 -0
  259. data/sig/knockapi/models/schedule_list_params.rbs +10 -0
  260. data/sig/knockapi/models/schedule_repeat_rule.rbs +18 -8
  261. data/sig/knockapi/models/schedule_update_params.rbs +11 -0
  262. data/sig/knockapi/models/schedules/bulk_create_params.rbs +16 -0
  263. data/sig/knockapi/models/tenant.rbs +19 -0
  264. data/sig/knockapi/models/tenant_delete_params.rbs +2 -0
  265. data/sig/knockapi/models/tenant_get_params.rbs +2 -0
  266. data/sig/knockapi/models/tenant_list_params.rbs +9 -0
  267. data/sig/knockapi/models/tenant_request.rbs +19 -0
  268. data/sig/knockapi/models/tenant_set_params.rbs +19 -0
  269. data/sig/knockapi/models/tenants/bulk_delete_params.rbs +5 -0
  270. data/sig/knockapi/models/tenants/bulk_set_params.rbs +5 -0
  271. data/sig/knockapi/models/user.rbs +12 -0
  272. data/sig/knockapi/models/user_delete_params.rbs +2 -0
  273. data/sig/knockapi/models/user_get_channel_data_params.rbs +2 -0
  274. data/sig/knockapi/models/user_get_params.rbs +2 -0
  275. data/sig/knockapi/models/user_get_preferences_params.rbs +5 -0
  276. data/sig/knockapi/models/user_list_messages_params.rbs +45 -15
  277. data/sig/knockapi/models/user_list_params.rbs +14 -6
  278. data/sig/knockapi/models/user_list_preferences_params.rbs +2 -0
  279. data/sig/knockapi/models/user_list_schedules_params.rbs +9 -0
  280. data/sig/knockapi/models/user_list_subscriptions_params.rbs +15 -6
  281. data/sig/knockapi/models/user_merge_params.rbs +5 -0
  282. data/sig/knockapi/models/user_set_channel_data_params.rbs +2 -0
  283. data/sig/knockapi/models/user_set_preferences_params.rbs +2 -0
  284. data/sig/knockapi/models/user_unset_channel_data_params.rbs +2 -0
  285. data/sig/knockapi/models/user_update_params.rbs +2 -0
  286. data/sig/knockapi/models/users/bulk_delete_params.rbs +5 -0
  287. data/sig/knockapi/models/users/bulk_identify_params.rbs +5 -0
  288. data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +6 -0
  289. data/sig/knockapi/models/users/feed_get_settings_params.rbs +2 -0
  290. data/sig/knockapi/models/users/feed_get_settings_response.rbs +6 -0
  291. data/sig/knockapi/models/users/feed_list_items_params.rbs +14 -0
  292. data/sig/knockapi/models/users/feed_list_items_response.rbs +43 -0
  293. data/sig/knockapi/models/users/guide_get_channel_params.rbs +7 -0
  294. data/sig/knockapi/models/users/guide_get_channel_response.rbs +14 -0
  295. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +13 -0
  296. data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +2 -0
  297. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +13 -0
  298. data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +2 -0
  299. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +13 -0
  300. data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +2 -0
  301. data/sig/knockapi/models/workflow_cancel_params.rbs +6 -0
  302. data/sig/knockapi/models/workflow_trigger_params.rbs +9 -0
  303. data/sig/knockapi/models/workflow_trigger_response.rbs +2 -0
  304. data/sig/knockapi/resources/messages.rbs +5 -5
  305. data/sig/knockapi/resources/objects.rbs +7 -7
  306. data/sig/knockapi/resources/users.rbs +7 -7
  307. metadata +2 -2
@@ -12,7 +12,7 @@ module Knockapi
12
12
  # @!attribute channel_data
13
13
  # A request to set channel data for a type of channel inline.
14
14
  #
15
- # @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
15
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
16
16
  optional :channel_data,
17
17
  -> {
18
18
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -53,7 +53,7 @@ module Knockapi
53
53
  # @!attribute preferences
54
54
  # Inline set preferences for a recipient, where the key is the preference set id.
55
55
  #
56
- # @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
56
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
57
57
  optional :preferences,
58
58
  -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
59
59
  nil?: true
@@ -69,7 +69,7 @@ module Knockapi
69
69
 
70
70
  # @!method initialize(avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
71
71
  # Some parameter documentations has been truncated, see
72
- # {Knockapi::IdentifyUserRequest} for more details.
72
+ # {Knockapi::Models::IdentifyUserRequest} for more details.
73
73
  #
74
74
  # A set of parameters to identify a user with. Does not include the user ID, as
75
75
  # that's specified elsewhere in the request. You can supply any additional
@@ -77,7 +77,7 @@ module Knockapi
77
77
  #
78
78
  # @param avatar [String, nil] URL to the user's avatar image.
79
79
  #
80
- # @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
80
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
81
81
  #
82
82
  # @param created_at [Time, nil] The creation date of the user from your system.
83
83
  #
@@ -89,7 +89,7 @@ module Knockapi
89
89
  #
90
90
  # @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
91
91
  #
92
- # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
92
+ # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
93
93
  #
94
94
  # @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
95
95
  end
@@ -18,7 +18,7 @@ module Knockapi
18
18
  # @!attribute channel_data
19
19
  # A request to set channel data for a type of channel inline.
20
20
  #
21
- # @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
21
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
22
22
  optional :channel_data,
23
23
  -> {
24
24
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -59,7 +59,7 @@ module Knockapi
59
59
  # @!attribute preferences
60
60
  # Inline set preferences for a recipient, where the key is the preference set id.
61
61
  #
62
- # @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
62
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
63
63
  optional :preferences,
64
64
  -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
65
65
  nil?: true
@@ -75,7 +75,7 @@ module Knockapi
75
75
 
76
76
  # @!method initialize(id:, avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
77
77
  # Some parameter documentations has been truncated, see
78
- # {Knockapi::InlineIdentifyUserRequest} for more details.
78
+ # {Knockapi::Models::InlineIdentifyUserRequest} for more details.
79
79
  #
80
80
  # A set of parameters to inline-identify a user with. Inline identifying the user
81
81
  # will ensure that the user is available before the request is executed in Knock.
@@ -86,7 +86,7 @@ module Knockapi
86
86
  #
87
87
  # @param avatar [String, nil] URL to the user's avatar image.
88
88
  #
89
- # @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
89
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
90
90
  #
91
91
  # @param created_at [Time, nil] The creation date of the user from your system.
92
92
  #
@@ -98,7 +98,7 @@ module Knockapi
98
98
  #
99
99
  # @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
100
100
  #
101
- # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
101
+ # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
102
102
  #
103
103
  # @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
104
104
  end
@@ -18,7 +18,7 @@ module Knockapi
18
18
  # @!attribute channel_data
19
19
  # A request to set channel data for a type of channel inline.
20
20
  #
21
- # @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
21
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
22
22
  optional :channel_data,
23
23
  -> {
24
24
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
@@ -34,7 +34,7 @@ module Knockapi
34
34
  # @!attribute preferences
35
35
  # Inline set preferences for a recipient, where the key is the preference set id.
36
36
  #
37
- # @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
37
+ # @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
38
38
  optional :preferences,
39
39
  -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
40
40
  nil?: true
@@ -46,11 +46,11 @@ module Knockapi
46
46
  #
47
47
  # @param collection [String] The collection this object belongs to.
48
48
  #
49
- # @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
49
+ # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
50
50
  #
51
51
  # @param created_at [Time, nil] Timestamp when the resource was created.
52
52
  #
53
- # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
53
+ # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
54
54
  end
55
55
  end
56
56
  end
@@ -13,11 +13,7 @@ module Knockapi
13
13
  variant -> { Knockapi::TenantRequest }
14
14
 
15
15
  # @!method self.variants
16
- # @return [Array(String, Knockapi::TenantRequest)]
17
-
18
- define_sorbet_constant!(:Variants) do
19
- T.type_alias { T.any(String, Knockapi::TenantRequest) }
20
- end
16
+ # @return [Array(String, Knockapi::Models::TenantRequest)]
21
17
  end
22
18
  end
23
19
  end
@@ -21,7 +21,7 @@ module Knockapi
21
21
  # that can contain up to 10 actors if the message is produced from a
22
22
  # [batch](/designing-workflows/batch-function).
23
23
  #
24
- # @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
24
+ # @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
25
25
  optional :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
26
26
 
27
27
  # @!attribute archived_at
@@ -55,7 +55,7 @@ module Knockapi
55
55
  # @!attribute engagement_statuses
56
56
  # A list of engagement statuses.
57
57
  #
58
- # @return [Array<Symbol, Knockapi::Message::EngagementStatus>, nil]
58
+ # @return [Array<Symbol, Knockapi::Models::Message::EngagementStatus>, nil]
59
59
  optional :engagement_statuses,
60
60
  -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] }
61
61
 
@@ -93,7 +93,7 @@ module Knockapi
93
93
  # A reference to a recipient, either a user identifier (string) or an object
94
94
  # reference (ID, collection).
95
95
  #
96
- # @return [String, Knockapi::RecipientReference::ObjectReference, nil]
96
+ # @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil]
97
97
  optional :recipient, union: -> { Knockapi::RecipientReference }
98
98
 
99
99
  # @!attribute scheduled_at
@@ -111,13 +111,13 @@ module Knockapi
111
111
  # @!attribute source
112
112
  # The workflow that triggered the message.
113
113
  #
114
- # @return [Knockapi::Message::Source, nil]
114
+ # @return [Knockapi::Models::Message::Source, nil]
115
115
  optional :source, -> { Knockapi::Message::Source }
116
116
 
117
117
  # @!attribute status
118
118
  # The message delivery status.
119
119
  #
120
- # @return [Symbol, Knockapi::Message::Status, nil]
120
+ # @return [Symbol, Knockapi::Models::Message::Status, nil]
121
121
  optional :status, enum: -> { Knockapi::Message::Status }
122
122
 
123
123
  # @!attribute tenant
@@ -142,8 +142,8 @@ module Knockapi
142
142
  optional :workflow, String, nil?: true
143
143
 
144
144
  # @!method initialize(id: nil, _typename: nil, actors: nil, archived_at: nil, channel_id: nil, clicked_at: nil, data: nil, engagement_statuses: nil, inserted_at: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, recipient: nil, scheduled_at: nil, seen_at: nil, source: nil, status: nil, tenant: nil, updated_at: nil, workflow: nil)
145
- # Some parameter documentations has been truncated, see {Knockapi::Message} for
146
- # more details.
145
+ # Some parameter documentations has been truncated, see
146
+ # {Knockapi::Models::Message} for more details.
147
147
  #
148
148
  # Represents a single message that was generated by a workflow for a given
149
149
  # channel.
@@ -152,7 +152,7 @@ module Knockapi
152
152
  #
153
153
  # @param _typename [String] The typename of the schema.
154
154
  #
155
- # @param actors [Array<String, Knockapi::RecipientReference::ObjectReference>] One or more actors that are associated with this message. Note: this is a list t
155
+ # @param actors [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] One or more actors that are associated with this message. Note: this is a list t
156
156
  #
157
157
  # @param archived_at [Time, nil] Timestamp when the message was archived.
158
158
  #
@@ -162,7 +162,7 @@ module Knockapi
162
162
  #
163
163
  # @param data [Hash{Symbol=>Object}, nil] Data associated with the message’s workflow run. Includes the workflow trigger r
164
164
  #
165
- # @param engagement_statuses [Array<Symbol, Knockapi::Message::EngagementStatus>] A list of engagement statuses.
165
+ # @param engagement_statuses [Array<Symbol, Knockapi::Models::Message::EngagementStatus>] A list of engagement statuses.
166
166
  #
167
167
  # @param inserted_at [Time] Timestamp when the resource was created.
168
168
  #
@@ -174,15 +174,15 @@ module Knockapi
174
174
  #
175
175
  # @param read_at [Time, nil] Timestamp when the message was read.
176
176
  #
177
- # @param recipient [String, Knockapi::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
177
+ # @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
178
178
  #
179
179
  # @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent.
180
180
  #
181
181
  # @param seen_at [Time, nil] Timestamp when the message was seen.
182
182
  #
183
- # @param source [Knockapi::Message::Source] The workflow that triggered the message.
183
+ # @param source [Knockapi::Models::Message::Source] The workflow that triggered the message.
184
184
  #
185
- # @param status [Symbol, Knockapi::Message::Status] The message delivery status.
185
+ # @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status.
186
186
  #
187
187
  # @param tenant [String, nil] The ID of the `tenant` associated with the message. Only present when a `tenant`
188
188
  #
@@ -205,7 +205,7 @@ module Knockapi
205
205
  # @return [Array<Symbol>]
206
206
  end
207
207
 
208
- # @see Knockapi::Message#source
208
+ # @see Knockapi::Models::Message#source
209
209
  class Source < Knockapi::Internal::Type::BaseModel
210
210
  # @!attribute _typename
211
211
  #
@@ -244,7 +244,7 @@ module Knockapi
244
244
 
245
245
  # The message delivery status.
246
246
  #
247
- # @see Knockapi::Message#status
247
+ # @see Knockapi::Models::Message#status
248
248
  module Status
249
249
  extend Knockapi::Internal::Type::Enum
250
250
 
@@ -31,13 +31,13 @@ module Knockapi
31
31
  # @!attribute request
32
32
  # A message delivery log request.
33
33
  #
34
- # @return [Knockapi::MessageDeliveryLog::Request]
34
+ # @return [Knockapi::Models::MessageDeliveryLog::Request]
35
35
  required :request, -> { Knockapi::MessageDeliveryLog::Request }
36
36
 
37
37
  # @!attribute response
38
38
  # A message delivery log response.
39
39
  #
40
- # @return [Knockapi::MessageDeliveryLog::Response]
40
+ # @return [Knockapi::Models::MessageDeliveryLog::Response]
41
41
  required :response, -> { Knockapi::MessageDeliveryLog::Response }
42
42
 
43
43
  # @!attribute service_name
@@ -58,13 +58,13 @@ module Knockapi
58
58
  #
59
59
  # @param inserted_at [String] Timestamp when the message delivery log was created.
60
60
  #
61
- # @param request [Knockapi::MessageDeliveryLog::Request] A message delivery log request.
61
+ # @param request [Knockapi::Models::MessageDeliveryLog::Request] A message delivery log request.
62
62
  #
63
- # @param response [Knockapi::MessageDeliveryLog::Response] A message delivery log response.
63
+ # @param response [Knockapi::Models::MessageDeliveryLog::Response] A message delivery log response.
64
64
  #
65
65
  # @param service_name [String] The name of the service that processed the delivery.
66
66
 
67
- # @see Knockapi::MessageDeliveryLog#request
67
+ # @see Knockapi::Models::MessageDeliveryLog#request
68
68
  class Request < Knockapi::Internal::Type::BaseModel
69
69
  # @!attribute body
70
70
  # The body content that was sent with the request.
@@ -87,7 +87,7 @@ module Knockapi
87
87
  # @!attribute method_
88
88
  # The HTTP method used for the request.
89
89
  #
90
- # @return [Symbol, Knockapi::MessageDeliveryLog::Request::Method, nil]
90
+ # @return [Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method, nil]
91
91
  optional :method_, enum: -> { Knockapi::MessageDeliveryLog::Request::Method }, api_name: :method
92
92
 
93
93
  # @!attribute path
@@ -111,7 +111,7 @@ module Knockapi
111
111
  #
112
112
  # @param host [String] The host to which the request was sent.
113
113
  #
114
- # @param method_ [Symbol, Knockapi::MessageDeliveryLog::Request::Method] The HTTP method used for the request.
114
+ # @param method_ [Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method] The HTTP method used for the request.
115
115
  #
116
116
  # @param path [String] The path of the URL that was requested.
117
117
  #
@@ -119,28 +119,24 @@ module Knockapi
119
119
 
120
120
  # The body content that was sent with the request.
121
121
  #
122
- # @see Knockapi::MessageDeliveryLog::Request#body
122
+ # @see Knockapi::Models::MessageDeliveryLog::Request#body
123
123
  module Body
124
124
  extend Knockapi::Internal::Type::Union
125
125
 
126
126
  variant String
127
127
 
128
- variant -> { Knockapi::MessageDeliveryLog::Request::Body::UnionMember1Map }
128
+ variant -> { Knockapi::Models::MessageDeliveryLog::Request::Body::UnionMember1Map }
129
129
 
130
130
  # @!method self.variants
131
131
  # @return [Array(String, Hash{Symbol=>Object})]
132
132
 
133
- define_sorbet_constant!(:Variants) do
134
- T.type_alias { T.any(String, T::Hash[Symbol, T.anything]) }
135
- end
136
-
137
133
  # @type [Knockapi::Internal::Type::Converter]
138
134
  UnionMember1Map = Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
139
135
  end
140
136
 
141
137
  # The HTTP method used for the request.
142
138
  #
143
- # @see Knockapi::MessageDeliveryLog::Request#method_
139
+ # @see Knockapi::Models::MessageDeliveryLog::Request#method_
144
140
  module Method
145
141
  extend Knockapi::Internal::Type::Enum
146
142
 
@@ -155,7 +151,7 @@ module Knockapi
155
151
  end
156
152
  end
157
153
 
158
- # @see Knockapi::MessageDeliveryLog#response
154
+ # @see Knockapi::Models::MessageDeliveryLog#response
159
155
  class Response < Knockapi::Internal::Type::BaseModel
160
156
  # @!attribute body
161
157
  # The body content that was received with the response.
@@ -186,21 +182,17 @@ module Knockapi
186
182
 
187
183
  # The body content that was received with the response.
188
184
  #
189
- # @see Knockapi::MessageDeliveryLog::Response#body
185
+ # @see Knockapi::Models::MessageDeliveryLog::Response#body
190
186
  module Body
191
187
  extend Knockapi::Internal::Type::Union
192
188
 
193
189
  variant String
194
190
 
195
- variant -> { Knockapi::MessageDeliveryLog::Response::Body::UnionMember1Map }
191
+ variant -> { Knockapi::Models::MessageDeliveryLog::Response::Body::UnionMember1Map }
196
192
 
197
193
  # @!method self.variants
198
194
  # @return [Array(String, Hash{Symbol=>Object})]
199
195
 
200
- define_sorbet_constant!(:Variants) do
201
- T.type_alias { T.any(String, T::Hash[Symbol, T.anything]) }
202
- end
203
-
204
196
  # @type [Knockapi::Internal::Type::Converter]
205
197
  UnionMember1Map = Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
206
198
  end
@@ -26,13 +26,13 @@ module Knockapi
26
26
  # A reference to a recipient, either a user identifier (string) or an object
27
27
  # reference (ID, collection).
28
28
  #
29
- # @return [String, Knockapi::RecipientReference::ObjectReference]
29
+ # @return [String, Knockapi::Models::RecipientReference::ObjectReference]
30
30
  required :recipient, union: -> { Knockapi::RecipientReference }
31
31
 
32
32
  # @!attribute type
33
33
  # The type of event that occurred.
34
34
  #
35
- # @return [Symbol, Knockapi::MessageEvent::Type]
35
+ # @return [Symbol, Knockapi::Models::MessageEvent::Type]
36
36
  required :type, enum: -> { Knockapi::MessageEvent::Type }
37
37
 
38
38
  # @!attribute data
@@ -42,8 +42,8 @@ module Knockapi
42
42
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
43
43
 
44
44
  # @!method initialize(id:, _typename:, inserted_at:, recipient:, type:, data: nil)
45
- # Some parameter documentations has been truncated, see {Knockapi::MessageEvent}
46
- # for more details.
45
+ # Some parameter documentations has been truncated, see
46
+ # {Knockapi::Models::MessageEvent} for more details.
47
47
  #
48
48
  # A message event. Occurs when a message
49
49
  # [delivery or engagement status](/send-notifications/message-statuses) changes.
@@ -54,15 +54,15 @@ module Knockapi
54
54
  #
55
55
  # @param inserted_at [Time] Timestamp when the event was created.
56
56
  #
57
- # @param recipient [String, Knockapi::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
57
+ # @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
58
58
  #
59
- # @param type [Symbol, Knockapi::MessageEvent::Type] The type of event that occurred.
59
+ # @param type [Symbol, Knockapi::Models::MessageEvent::Type] The type of event that occurred.
60
60
  #
61
61
  # @param data [Hash{Symbol=>Object}, nil] The data associated with the message event. Only present for some event types.
62
62
 
63
63
  # The type of event that occurred.
64
64
  #
65
- # @see Knockapi::MessageEvent#type
65
+ # @see Knockapi::Models::MessageEvent#type
66
66
  module Type
67
67
  extend Knockapi::Internal::Type::Enum
68
68
 
@@ -485,32 +485,11 @@ module Knockapi
485
485
 
486
486
  # @!method self.variants
487
487
  # @return [Array(Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock, Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)]
488
-
489
- define_sorbet_constant!(:Variants) do
490
- T.type_alias do
491
- T.any(
492
- Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
493
- Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
494
- )
495
- end
496
- end
497
488
  end
498
489
  end
499
490
 
500
491
  # @!method self.variants
501
492
  # @return [Array(Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent, Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent, Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent, Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent, Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent)]
502
-
503
- define_sorbet_constant!(:Variants) do
504
- T.type_alias do
505
- T.any(
506
- Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent,
507
- Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent,
508
- Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent,
509
- Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent,
510
- Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent
511
- )
512
- end
513
- end
514
493
  end
515
494
  end
516
495
  end
@@ -28,13 +28,13 @@ module Knockapi
28
28
  # @!attribute engagement_status
29
29
  # Limits the results to messages with the given engagement status.
30
30
  #
31
- # @return [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>, nil]
31
+ # @return [Array<Symbol, Knockapi::Models::MessageListParams::EngagementStatus>, nil]
32
32
  optional :engagement_status,
33
33
  -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::EngagementStatus] }
34
34
 
35
35
  # @!attribute inserted_at
36
36
  #
37
- # @return [Knockapi::MessageListParams::InsertedAt, nil]
37
+ # @return [Knockapi::Models::MessageListParams::InsertedAt, nil]
38
38
  optional :inserted_at, -> { Knockapi::MessageListParams::InsertedAt }
39
39
 
40
40
  # @!attribute message_ids
@@ -59,7 +59,7 @@ module Knockapi
59
59
  # @!attribute status
60
60
  # Limits the results to messages with the given delivery status.
61
61
  #
62
- # @return [Array<Symbol, Knockapi::MessageListParams::Status>, nil]
62
+ # @return [Array<Symbol, Knockapi::Models::MessageListParams::Status>, nil]
63
63
  optional :status, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::Status] }
64
64
 
65
65
  # @!attribute tenant
@@ -105,9 +105,9 @@ module Knockapi
105
105
  #
106
106
  # @param channel_id [String] Limits the results to items with the corresponding channel ID.
107
107
  #
108
- # @param engagement_status [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
108
+ # @param engagement_status [Array<Symbol, Knockapi::Models::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
109
109
  #
110
- # @param inserted_at [Knockapi::MessageListParams::InsertedAt]
110
+ # @param inserted_at [Knockapi::Models::MessageListParams::InsertedAt]
111
111
  #
112
112
  # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
113
113
  #
@@ -115,7 +115,7 @@ module Knockapi
115
115
  #
116
116
  # @param source [String] Limits the results to messages triggered by the given workflow key.
117
117
  #
118
- # @param status [Array<Symbol, Knockapi::MessageListParams::Status>] Limits the results to messages with the given delivery status.
118
+ # @param status [Array<Symbol, Knockapi::Models::MessageListParams::Status>] Limits the results to messages with the given delivery status.
119
119
  #
120
120
  # @param tenant [String] Limits the results to items with the corresponding tenant.
121
121
  #
@@ -133,10 +133,13 @@ module Knockapi
133
133
  extend Knockapi::Internal::Type::Enum
134
134
 
135
135
  SEEN = :seen
136
+ UNSEEN = :unseen
136
137
  READ = :read
137
- INTERACTED = :interacted
138
- LINK_CLICKED = :link_clicked
138
+ UNREAD = :unread
139
139
  ARCHIVED = :archived
140
+ UNARCHIVED = :unarchived
141
+ LINK_CLICKED = :link_clicked
142
+ INTERACTED = :interacted
140
143
 
141
144
  # @!method self.values
142
145
  # @return [Array<Symbol>]
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  module Messages
6
6
  # @type [Knockapi::Internal::Type::Converter]
7
- BatchArchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
7
+ BatchArchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
8
8
  end
9
9
  end
10
10
  end
@@ -488,32 +488,11 @@ module Knockapi
488
488
 
489
489
  # @!method self.variants
490
490
  # @return [Array(Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)]
491
-
492
- define_sorbet_constant!(:Variants) do
493
- T.type_alias do
494
- T.any(
495
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
496
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
497
- )
498
- end
499
- end
500
491
  end
501
492
  end
502
493
 
503
494
  # @!method self.variants
504
495
  # @return [Array(Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent)]
505
-
506
- define_sorbet_constant!(:Variants) do
507
- T.type_alias do
508
- T.any(
509
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent,
510
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent,
511
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent,
512
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent,
513
- Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent
514
- )
515
- end
516
- end
517
496
  end
518
497
  end
519
498
 
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  module Messages
6
6
  # @type [Knockapi::Internal::Type::Converter]
7
- BatchMarkAsInteractedResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
7
+ BatchMarkAsInteractedResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
8
8
  end
9
9
  end
10
10
  end
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  module Messages
6
6
  # @type [Knockapi::Internal::Type::Converter]
7
- BatchMarkAsReadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
7
+ BatchMarkAsReadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
8
8
  end
9
9
  end
10
10
  end
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  module Messages
6
6
  # @type [Knockapi::Internal::Type::Converter]
7
- BatchMarkAsSeenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
7
+ BatchMarkAsSeenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
8
8
  end
9
9
  end
10
10
  end
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  module Messages
6
6
  # @type [Knockapi::Internal::Type::Converter]
7
- BatchMarkAsUnreadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
7
+ BatchMarkAsUnreadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
8
8
  end
9
9
  end
10
10
  end
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  module Messages
6
6
  # @type [Knockapi::Internal::Type::Converter]
7
- BatchMarkAsUnseenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
7
+ BatchMarkAsUnseenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
8
8
  end
9
9
  end
10
10
  end
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  module Messages
6
6
  # @type [Knockapi::Internal::Type::Converter]
7
- BatchUnarchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
7
+ BatchUnarchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
8
8
  end
9
9
  end
10
10
  end
@@ -11,7 +11,7 @@ module Knockapi
11
11
  # The recipients of the subscription. You can subscribe up to 100 recipients to an
12
12
  # object at a time.
13
13
  #
14
- # @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
14
+ # @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
15
15
  required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
16
16
 
17
17
  # @!attribute properties
@@ -24,7 +24,7 @@ module Knockapi
24
24
  # Some parameter documentations has been truncated, see
25
25
  # {Knockapi::Models::ObjectAddSubscriptionsParams} for more details.
26
26
  #
27
- # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
27
+ # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
28
28
  #
29
29
  # @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
30
30
  #
@@ -11,14 +11,14 @@ module Knockapi
11
11
  # The recipients of the subscription. You can subscribe up to 100 recipients to an
12
12
  # object at a time.
13
13
  #
14
- # @return [Array<String, Knockapi::RecipientReference::ObjectReference>]
14
+ # @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>]
15
15
  required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
16
16
 
17
17
  # @!method initialize(recipients:, request_options: {})
18
18
  # Some parameter documentations has been truncated, see
19
19
  # {Knockapi::Models::ObjectDeleteSubscriptionsParams} for more details.
20
20
  #
21
- # @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
21
+ # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
22
22
  #
23
23
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
24
24
  end