knockapi 1.0.0 → 1.1.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 (549) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +41 -0
  3. data/README.md +101 -49
  4. data/lib/knockapi/client.rb +4 -4
  5. data/lib/knockapi/errors.rb +1 -1
  6. data/lib/knockapi/file_part.rb +2 -2
  7. data/lib/knockapi/internal/entries_cursor.rb +3 -3
  8. data/lib/knockapi/internal/items_cursor.rb +3 -3
  9. data/lib/knockapi/internal/ms_teams_pagination.rb +3 -3
  10. data/lib/knockapi/internal/slack_channels_cursor.rb +3 -3
  11. data/lib/knockapi/internal/transport/base_client.rb +79 -7
  12. data/lib/knockapi/internal/transport/pooled_net_requester.rb +17 -1
  13. data/lib/knockapi/internal/type/array_of.rb +1 -1
  14. data/lib/knockapi/internal/type/base_model.rb +71 -39
  15. data/lib/knockapi/internal/type/converter.rb +18 -0
  16. data/lib/knockapi/internal/type/enum.rb +1 -0
  17. data/lib/knockapi/internal/type/hash_of.rb +1 -1
  18. data/lib/knockapi/internal/type/request_parameters.rb +6 -12
  19. data/lib/knockapi/internal/type/union.rb +4 -3
  20. data/lib/knockapi/internal/util.rb +74 -2
  21. data/lib/knockapi/internal.rb +6 -0
  22. data/lib/knockapi/models/activity.rb +6 -6
  23. data/lib/knockapi/models/audience_add_members_params.rb +10 -8
  24. data/lib/knockapi/models/audience_add_members_response.rb +7 -0
  25. data/lib/knockapi/models/audience_list_members_response.rb +6 -6
  26. data/lib/knockapi/models/audience_member.rb +5 -6
  27. data/lib/knockapi/models/audience_remove_members_params.rb +12 -7
  28. data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
  29. data/lib/knockapi/models/bulk_operation.rb +7 -8
  30. data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +11 -10
  31. data/lib/knockapi/models/condition.rb +4 -4
  32. data/lib/knockapi/models/identify_user_request.rb +16 -17
  33. data/lib/knockapi/models/inline_identify_user_request.rb +64 -7
  34. data/lib/knockapi/models/inline_object_request.rb +8 -6
  35. data/lib/knockapi/models/inline_tenant_request.rb +6 -2
  36. data/lib/knockapi/models/message.rb +19 -23
  37. data/lib/knockapi/models/message_delivery_log.rb +26 -18
  38. data/lib/knockapi/models/message_event.rb +9 -10
  39. data/lib/knockapi/models/message_get_content_response.rb +21 -0
  40. data/lib/knockapi/models/message_list_params.rb +9 -13
  41. data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
  42. data/lib/knockapi/models/messages/batch_get_content_response.rb +21 -0
  43. data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
  44. data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
  45. data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
  46. data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
  47. data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
  48. data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
  49. data/lib/knockapi/models/object.rb +9 -1
  50. data/lib/knockapi/models/object_add_subscriptions_params.rb +3 -4
  51. data/lib/knockapi/models/object_add_subscriptions_response.rb +1 -1
  52. data/lib/knockapi/models/object_delete_response.rb +7 -0
  53. data/lib/knockapi/models/object_delete_subscriptions_params.rb +3 -5
  54. data/lib/knockapi/models/object_delete_subscriptions_response.rb +1 -1
  55. data/lib/knockapi/models/object_list_messages_params.rb +11 -12
  56. data/lib/knockapi/models/object_list_params.rb +3 -4
  57. data/lib/knockapi/models/object_list_preferences_response.rb +1 -1
  58. data/lib/knockapi/models/object_list_subscriptions_params.rb +14 -14
  59. data/lib/knockapi/models/object_set_params.rb +15 -13
  60. data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
  61. data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +9 -9
  62. data/lib/knockapi/models/objects/bulk_set_params.rb +3 -3
  63. data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -7
  64. data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -9
  65. data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -7
  66. data/lib/knockapi/models/recipient.rb +7 -3
  67. data/lib/knockapi/models/recipient_reference.rb +6 -2
  68. data/lib/knockapi/models/recipient_request.rb +7 -3
  69. data/lib/knockapi/models/recipients/channel_data.rb +26 -14
  70. data/lib/knockapi/models/recipients/channel_data_request.rb +22 -10
  71. data/lib/knockapi/models/recipients/discord_channel_data.rb +25 -10
  72. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +36 -1
  73. data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
  74. data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +25 -10
  75. data/lib/knockapi/models/recipients/preference_set.rb +52 -28
  76. data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
  77. data/lib/knockapi/models/recipients/preference_set_channel_types.rb +60 -36
  78. data/lib/knockapi/models/recipients/preference_set_request.rb +52 -28
  79. data/lib/knockapi/models/recipients/slack_channel_data.rb +21 -10
  80. data/lib/knockapi/models/recipients/subscription.rb +6 -6
  81. data/lib/knockapi/models/schedule.rb +11 -12
  82. data/lib/knockapi/models/schedule_create_params.rb +10 -15
  83. data/lib/knockapi/models/schedule_create_response.rb +1 -1
  84. data/lib/knockapi/models/schedule_delete_response.rb +1 -1
  85. data/lib/knockapi/models/schedule_repeat_rule.rb +7 -7
  86. data/lib/knockapi/models/schedule_update_params.rb +9 -10
  87. data/lib/knockapi/models/schedule_update_response.rb +1 -1
  88. data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -18
  89. data/lib/knockapi/models/tenant.rb +13 -16
  90. data/lib/knockapi/models/tenant_delete_response.rb +7 -0
  91. data/lib/knockapi/models/tenant_request.rb +20 -20
  92. data/lib/knockapi/models/tenant_set_params.rb +19 -19
  93. data/lib/knockapi/models/tenants/bulk_set_params.rb +3 -3
  94. data/lib/knockapi/models/user.rb +9 -11
  95. data/lib/knockapi/models/user_delete_response.rb +7 -0
  96. data/lib/knockapi/models/user_list_messages_params.rb +13 -12
  97. data/lib/knockapi/models/user_list_params.rb +3 -4
  98. data/lib/knockapi/models/user_list_preferences_response.rb +1 -1
  99. data/lib/knockapi/models/user_list_subscriptions_params.rb +3 -3
  100. data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
  101. data/lib/knockapi/models/users/bulk_identify_params.rb +3 -3
  102. data/lib/knockapi/models/users/bulk_set_preferences_params.rb +3 -3
  103. data/lib/knockapi/models/users/feed_list_items_params.rb +6 -6
  104. data/lib/knockapi/models/users/feed_list_items_response.rb +15 -6
  105. data/lib/knockapi/models/workflow_cancel_params.rb +3 -5
  106. data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
  107. data/lib/knockapi/models/workflow_trigger_params.rb +9 -12
  108. data/lib/knockapi/models/workflow_trigger_response.rb +0 -1
  109. data/lib/knockapi/models.rb +202 -0
  110. data/lib/knockapi/request_options.rb +4 -0
  111. data/lib/knockapi/resources/audiences.rb +4 -4
  112. data/lib/knockapi/resources/bulk_operations.rb +2 -2
  113. data/lib/knockapi/resources/channels/bulk.rb +7 -8
  114. data/lib/knockapi/resources/integrations/census.rb +1 -1
  115. data/lib/knockapi/resources/integrations/hightouch.rb +1 -1
  116. data/lib/knockapi/resources/messages/batch.rb +22 -22
  117. data/lib/knockapi/resources/messages.rb +32 -39
  118. data/lib/knockapi/resources/objects/bulk.rb +11 -11
  119. data/lib/knockapi/resources/objects.rb +52 -62
  120. data/lib/knockapi/resources/providers/ms_teams.rb +6 -6
  121. data/lib/knockapi/resources/providers/slack.rb +4 -4
  122. data/lib/knockapi/resources/schedules/bulk.rb +4 -4
  123. data/lib/knockapi/resources/schedules.rb +18 -23
  124. data/lib/knockapi/resources/tenants/bulk.rb +7 -7
  125. data/lib/knockapi/resources/tenants.rb +11 -11
  126. data/lib/knockapi/resources/users/bulk.rb +11 -11
  127. data/lib/knockapi/resources/users/feeds.rb +3 -3
  128. data/lib/knockapi/resources/users/guides.rb +4 -4
  129. data/lib/knockapi/resources/users.rb +46 -54
  130. data/lib/knockapi/resources/workflows.rb +6 -11
  131. data/lib/knockapi/version.rb +1 -1
  132. data/lib/knockapi.rb +11 -2
  133. data/rbi/knockapi/client.rbi +5 -4
  134. data/rbi/knockapi/errors.rbi +35 -16
  135. data/rbi/knockapi/file_part.rbi +9 -6
  136. data/rbi/knockapi/internal/entries_cursor.rbi +9 -4
  137. data/rbi/knockapi/internal/items_cursor.rbi +9 -4
  138. data/rbi/knockapi/internal/ms_teams_pagination.rbi +2 -1
  139. data/rbi/knockapi/internal/slack_channels_cursor.rbi +2 -1
  140. data/rbi/knockapi/internal/transport/base_client.rbi +158 -78
  141. data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +32 -13
  142. data/rbi/knockapi/internal/type/array_of.rbi +34 -24
  143. data/rbi/knockapi/internal/type/base_model.rbi +151 -73
  144. data/rbi/knockapi/internal/type/base_page.rbi +12 -8
  145. data/rbi/knockapi/internal/type/boolean.rbi +16 -14
  146. data/rbi/knockapi/internal/type/converter.rbi +70 -28
  147. data/rbi/knockapi/internal/type/enum.rbi +28 -15
  148. data/rbi/knockapi/internal/type/file_input.rbi +8 -4
  149. data/rbi/knockapi/internal/type/hash_of.rbi +34 -24
  150. data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
  151. data/rbi/knockapi/internal/type/union.rbi +55 -19
  152. data/rbi/knockapi/internal/type/unknown.rbi +16 -6
  153. data/rbi/knockapi/internal/util.rbi +239 -87
  154. data/rbi/knockapi/internal.rbi +2 -0
  155. data/rbi/knockapi/models/activity.rbi +28 -22
  156. data/rbi/knockapi/models/audience_add_members_params.rbi +62 -27
  157. data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
  158. data/rbi/knockapi/models/audience_list_members_params.rbi +16 -5
  159. data/rbi/knockapi/models/audience_list_members_response.rbi +25 -11
  160. data/rbi/knockapi/models/audience_member.rbi +23 -11
  161. data/rbi/knockapi/models/audience_remove_members_params.rbi +65 -28
  162. data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
  163. data/rbi/knockapi/models/bulk_operation.rbi +70 -42
  164. data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
  165. data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +224 -79
  166. data/rbi/knockapi/models/condition.rbi +78 -31
  167. data/rbi/knockapi/models/identify_user_request.rbi +90 -36
  168. data/rbi/knockapi/models/inline_identify_user_request.rbi +135 -22
  169. data/rbi/knockapi/models/inline_object_request.rbi +76 -22
  170. data/rbi/knockapi/models/inline_tenant_request.rbi +7 -2
  171. data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +24 -15
  172. data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +21 -4
  173. data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +24 -15
  174. data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +21 -4
  175. data/rbi/knockapi/models/message.rbi +156 -72
  176. data/rbi/knockapi/models/message_archive_params.rbi +13 -5
  177. data/rbi/knockapi/models/message_delivery_log.rbi +153 -66
  178. data/rbi/knockapi/models/message_event.rbi +86 -37
  179. data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
  180. data/rbi/knockapi/models/message_get_content_response.rbi +364 -203
  181. data/rbi/knockapi/models/message_get_params.rbi +13 -5
  182. data/rbi/knockapi/models/message_list_activities_params.rbi +24 -15
  183. data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +23 -12
  184. data/rbi/knockapi/models/message_list_events_params.rbi +20 -12
  185. data/rbi/knockapi/models/message_list_params.rbi +147 -58
  186. data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +21 -6
  187. data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
  188. data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
  189. data/rbi/knockapi/models/message_mark_as_unread_params.rbi +16 -5
  190. data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +16 -5
  191. data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
  192. data/rbi/knockapi/models/messages/batch_archive_params.rbi +23 -6
  193. data/rbi/knockapi/models/messages/batch_archive_response.rbi +4 -1
  194. data/rbi/knockapi/models/messages/batch_get_content_params.rbi +23 -6
  195. data/rbi/knockapi/models/messages/batch_get_content_response.rbi +367 -206
  196. data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +22 -13
  197. data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +4 -1
  198. data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +23 -6
  199. data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +4 -1
  200. data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +23 -6
  201. data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +4 -1
  202. data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +23 -6
  203. data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +4 -1
  204. data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +23 -6
  205. data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +4 -1
  206. data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +23 -6
  207. data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +4 -1
  208. data/rbi/knockapi/models/object.rbi +31 -10
  209. data/rbi/knockapi/models/object_add_subscriptions_params.rbi +44 -22
  210. data/rbi/knockapi/models/object_add_subscriptions_response.rbi +1 -1
  211. data/rbi/knockapi/models/object_delete_params.rbi +13 -5
  212. data/rbi/knockapi/models/object_delete_response.rbi +7 -0
  213. data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +36 -14
  214. data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +1 -1
  215. data/rbi/knockapi/models/object_get_channel_data_params.rbi +16 -5
  216. data/rbi/knockapi/models/object_get_params.rbi +13 -5
  217. data/rbi/knockapi/models/object_get_preferences_params.rbi +16 -5
  218. data/rbi/knockapi/models/object_list_messages_params.rbi +169 -60
  219. data/rbi/knockapi/models/object_list_params.rbi +43 -22
  220. data/rbi/knockapi/models/object_list_preferences_params.rbi +16 -5
  221. data/rbi/knockapi/models/object_list_preferences_response.rbi +1 -1
  222. data/rbi/knockapi/models/object_list_schedules_params.rbi +25 -16
  223. data/rbi/knockapi/models/object_list_subscriptions_params.rbi +150 -46
  224. data/rbi/knockapi/models/object_set_channel_data_params.rbi +16 -5
  225. data/rbi/knockapi/models/object_set_params.rbi +89 -33
  226. data/rbi/knockapi/models/object_set_preferences_params.rbi +16 -5
  227. data/rbi/knockapi/models/object_unset_channel_data_params.rbi +16 -5
  228. data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
  229. data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +77 -34
  230. data/rbi/knockapi/models/objects/bulk_delete_params.rbi +23 -6
  231. data/rbi/knockapi/models/objects/bulk_set_params.rbi +20 -11
  232. data/rbi/knockapi/models/page_info.rbi +22 -11
  233. data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +23 -6
  234. data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +53 -14
  235. data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +53 -23
  236. data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +57 -30
  237. data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +62 -22
  238. data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +23 -4
  239. data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +23 -6
  240. data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +14 -3
  241. data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +23 -6
  242. data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +53 -14
  243. data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +58 -30
  244. data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +29 -12
  245. data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +23 -6
  246. data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +14 -3
  247. data/rbi/knockapi/models/recipient.rbi +5 -2
  248. data/rbi/knockapi/models/recipient_reference.rbi +22 -5
  249. data/rbi/knockapi/models/recipient_request.rbi +11 -4
  250. data/rbi/knockapi/models/recipients/channel_data.rbi +123 -50
  251. data/rbi/knockapi/models/recipients/channel_data_request.rbi +54 -33
  252. data/rbi/knockapi/models/recipients/discord_channel_data.rbi +100 -53
  253. data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +29 -1
  254. data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +3 -1
  255. data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +109 -64
  256. data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +14 -3
  257. data/rbi/knockapi/models/recipients/preference_set.rbi +159 -88
  258. data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +18 -6
  259. data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +276 -105
  260. data/rbi/knockapi/models/recipients/preference_set_request.rbi +162 -87
  261. data/rbi/knockapi/models/recipients/push_channel_data.rbi +14 -3
  262. data/rbi/knockapi/models/recipients/slack_channel_data.rbi +107 -49
  263. data/rbi/knockapi/models/recipients/subscription.rbi +29 -20
  264. data/rbi/knockapi/models/schedule.rbi +32 -27
  265. data/rbi/knockapi/models/schedule_create_params.rbi +52 -35
  266. data/rbi/knockapi/models/schedule_create_response.rbi +4 -1
  267. data/rbi/knockapi/models/schedule_delete_params.rbi +20 -6
  268. data/rbi/knockapi/models/schedule_delete_response.rbi +4 -1
  269. data/rbi/knockapi/models/schedule_list_params.rbi +23 -17
  270. data/rbi/knockapi/models/schedule_repeat_rule.rbi +69 -39
  271. data/rbi/knockapi/models/schedule_update_params.rbi +48 -27
  272. data/rbi/knockapi/models/schedule_update_response.rbi +4 -1
  273. data/rbi/knockapi/models/schedules/bulk_create_params.rbi +102 -61
  274. data/rbi/knockapi/models/tenant.rbi +71 -45
  275. data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
  276. data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
  277. data/rbi/knockapi/models/tenant_get_params.rbi +13 -5
  278. data/rbi/knockapi/models/tenant_list_params.rbi +22 -16
  279. data/rbi/knockapi/models/tenant_request.rbi +132 -57
  280. data/rbi/knockapi/models/tenant_set_params.rbi +134 -59
  281. data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +23 -6
  282. data/rbi/knockapi/models/tenants/bulk_set_params.rbi +20 -11
  283. data/rbi/knockapi/models/user.rbi +32 -28
  284. data/rbi/knockapi/models/user_delete_params.rbi +13 -5
  285. data/rbi/knockapi/models/user_delete_response.rbi +7 -0
  286. data/rbi/knockapi/models/user_get_channel_data_params.rbi +13 -5
  287. data/rbi/knockapi/models/user_get_params.rbi +13 -5
  288. data/rbi/knockapi/models/user_get_preferences_params.rbi +19 -5
  289. data/rbi/knockapi/models/user_list_messages_params.rbi +168 -59
  290. data/rbi/knockapi/models/user_list_params.rbi +43 -22
  291. data/rbi/knockapi/models/user_list_preferences_params.rbi +16 -5
  292. data/rbi/knockapi/models/user_list_preferences_response.rbi +1 -1
  293. data/rbi/knockapi/models/user_list_schedules_params.rbi +22 -16
  294. data/rbi/knockapi/models/user_list_subscriptions_params.rbi +61 -23
  295. data/rbi/knockapi/models/user_merge_params.rbi +17 -6
  296. data/rbi/knockapi/models/user_set_channel_data_params.rbi +13 -5
  297. data/rbi/knockapi/models/user_set_preferences_params.rbi +13 -5
  298. data/rbi/knockapi/models/user_unset_channel_data_params.rbi +16 -5
  299. data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
  300. data/rbi/knockapi/models/user_update_params.rbi +13 -5
  301. data/rbi/knockapi/models/users/bulk_delete_params.rbi +23 -6
  302. data/rbi/knockapi/models/users/bulk_identify_params.rbi +23 -11
  303. data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +26 -18
  304. data/rbi/knockapi/models/users/feed_get_settings_params.rbi +16 -5
  305. data/rbi/knockapi/models/users/feed_get_settings_response.rbi +47 -14
  306. data/rbi/knockapi/models/users/feed_list_items_params.rbi +119 -41
  307. data/rbi/knockapi/models/users/feed_list_items_response.rbi +197 -100
  308. data/rbi/knockapi/models/users/guide_get_channel_params.rbi +15 -5
  309. data/rbi/knockapi/models/users/guide_get_channel_response.rbi +84 -25
  310. data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +29 -20
  311. data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +14 -3
  312. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +29 -20
  313. data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +14 -3
  314. data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +29 -20
  315. data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +14 -3
  316. data/rbi/knockapi/models/workflow_cancel_params.rbi +42 -17
  317. data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
  318. data/rbi/knockapi/models/workflow_trigger_params.rbi +65 -37
  319. data/rbi/knockapi/models/workflow_trigger_response.rbi +14 -3
  320. data/rbi/knockapi/models.rbi +179 -0
  321. data/rbi/knockapi/request_options.rbi +18 -7
  322. data/rbi/knockapi/resources/audiences.rbi +22 -14
  323. data/rbi/knockapi/resources/bulk_operations.rbi +11 -3
  324. data/rbi/knockapi/resources/channels/bulk.rbi +15 -9
  325. data/rbi/knockapi/resources/channels.rbi +2 -1
  326. data/rbi/knockapi/resources/integrations/census.rbi +8 -4
  327. data/rbi/knockapi/resources/integrations/hightouch.rbi +8 -4
  328. data/rbi/knockapi/resources/integrations.rbi +2 -1
  329. data/rbi/knockapi/resources/messages/batch.rbi +58 -26
  330. data/rbi/knockapi/resources/messages.rbi +102 -43
  331. data/rbi/knockapi/resources/objects/bulk.rbi +25 -14
  332. data/rbi/knockapi/resources/objects.rbi +177 -107
  333. data/rbi/knockapi/resources/providers/ms_teams.rbi +35 -16
  334. data/rbi/knockapi/resources/providers/slack.rbi +28 -11
  335. data/rbi/knockapi/resources/providers.rbi +2 -1
  336. data/rbi/knockapi/resources/recipients/channel_data.rbi +2 -1
  337. data/rbi/knockapi/resources/recipients/preferences.rbi +2 -1
  338. data/rbi/knockapi/resources/recipients/subscriptions.rbi +2 -1
  339. data/rbi/knockapi/resources/recipients.rbi +2 -1
  340. data/rbi/knockapi/resources/schedules/bulk.rbi +9 -6
  341. data/rbi/knockapi/resources/schedules.rbi +44 -33
  342. data/rbi/knockapi/resources/shared.rbi +2 -1
  343. data/rbi/knockapi/resources/tenants/bulk.rbi +15 -9
  344. data/rbi/knockapi/resources/tenants.rbi +51 -20
  345. data/rbi/knockapi/resources/users/bulk.rbi +21 -14
  346. data/rbi/knockapi/resources/users/feeds.rbi +20 -9
  347. data/rbi/knockapi/resources/users/guides.rbi +23 -16
  348. data/rbi/knockapi/resources/users.rbi +160 -91
  349. data/rbi/knockapi/resources/workflows.rbi +38 -29
  350. data/sig/knockapi/internal/entries_cursor.rbs +0 -2
  351. data/sig/knockapi/internal/items_cursor.rbs +0 -2
  352. data/sig/knockapi/internal/transport/base_client.rbs +16 -1
  353. data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -0
  354. data/sig/knockapi/internal/type/base_model.rbs +11 -5
  355. data/sig/knockapi/internal/type/base_page.rbs +1 -1
  356. data/sig/knockapi/internal/type/converter.rbs +2 -0
  357. data/sig/knockapi/internal/type/enum.rbs +1 -0
  358. data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
  359. data/sig/knockapi/internal/type/union.rbs +1 -0
  360. data/sig/knockapi/internal/util.rbs +15 -0
  361. data/sig/knockapi/internal.rbs +2 -0
  362. data/sig/knockapi/models/activity.rbs +0 -2
  363. data/sig/knockapi/models/audience_add_members_params.rbs +6 -12
  364. data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
  365. data/sig/knockapi/models/audience_list_members_params.rbs +0 -2
  366. data/sig/knockapi/models/audience_list_members_response.rbs +6 -8
  367. data/sig/knockapi/models/audience_member.rbs +3 -5
  368. data/sig/knockapi/models/audience_remove_members_params.rbs +6 -14
  369. data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
  370. data/sig/knockapi/models/bulk_operation.rbs +9 -13
  371. data/sig/knockapi/models/bulk_operation_get_params.rbs +0 -2
  372. data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +0 -2
  373. data/sig/knockapi/models/condition.rbs +4 -6
  374. data/sig/knockapi/models/identify_user_request.rbs +0 -2
  375. data/sig/knockapi/models/inline_identify_user_request.rbs +26 -4
  376. data/sig/knockapi/models/inline_object_request.rbs +0 -2
  377. data/sig/knockapi/models/inline_tenant_request.rbs +2 -2
  378. data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +0 -2
  379. data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +0 -2
  380. data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +0 -2
  381. data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +0 -2
  382. data/sig/knockapi/models/message.rbs +15 -23
  383. data/sig/knockapi/models/message_archive_params.rbs +0 -2
  384. data/sig/knockapi/models/message_delivery_log.rbs +24 -30
  385. data/sig/knockapi/models/message_event.rbs +4 -6
  386. data/sig/knockapi/models/message_get_content_params.rbs +0 -2
  387. data/sig/knockapi/models/message_get_content_response.rbs +2 -24
  388. data/sig/knockapi/models/message_get_params.rbs +0 -2
  389. data/sig/knockapi/models/message_list_activities_params.rbs +0 -2
  390. data/sig/knockapi/models/message_list_delivery_logs_params.rbs +0 -2
  391. data/sig/knockapi/models/message_list_events_params.rbs +0 -2
  392. data/sig/knockapi/models/message_list_params.rbs +17 -21
  393. data/sig/knockapi/models/message_mark_as_interacted_params.rbs +0 -2
  394. data/sig/knockapi/models/message_mark_as_read_params.rbs +0 -2
  395. data/sig/knockapi/models/message_mark_as_seen_params.rbs +0 -2
  396. data/sig/knockapi/models/message_mark_as_unread_params.rbs +0 -2
  397. data/sig/knockapi/models/message_mark_as_unseen_params.rbs +0 -2
  398. data/sig/knockapi/models/message_unarchive_params.rbs +0 -2
  399. data/sig/knockapi/models/messages/batch_archive_params.rbs +0 -2
  400. data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
  401. data/sig/knockapi/models/messages/batch_get_content_params.rbs +0 -2
  402. data/sig/knockapi/models/messages/batch_get_content_response.rbs +2 -24
  403. data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +0 -2
  404. data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +1 -2
  405. data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +0 -2
  406. data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
  407. data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +0 -2
  408. data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
  409. data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +0 -2
  410. data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
  411. data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +0 -2
  412. data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
  413. data/sig/knockapi/models/messages/batch_unarchive_params.rbs +0 -2
  414. data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
  415. data/sig/knockapi/models/object.rbs +8 -4
  416. data/sig/knockapi/models/object_add_subscriptions_params.rbs +0 -2
  417. data/sig/knockapi/models/object_add_subscriptions_response.rbs +1 -1
  418. data/sig/knockapi/models/object_delete_params.rbs +0 -2
  419. data/sig/knockapi/models/object_delete_response.rbs +5 -0
  420. data/sig/knockapi/models/object_delete_subscriptions_params.rbs +0 -2
  421. data/sig/knockapi/models/object_delete_subscriptions_response.rbs +1 -1
  422. data/sig/knockapi/models/object_get_channel_data_params.rbs +0 -2
  423. data/sig/knockapi/models/object_get_params.rbs +0 -2
  424. data/sig/knockapi/models/object_get_preferences_params.rbs +0 -2
  425. data/sig/knockapi/models/object_list_messages_params.rbs +17 -21
  426. data/sig/knockapi/models/object_list_params.rbs +6 -8
  427. data/sig/knockapi/models/object_list_preferences_params.rbs +0 -2
  428. data/sig/knockapi/models/object_list_preferences_response.rbs +1 -1
  429. data/sig/knockapi/models/object_list_schedules_params.rbs +0 -2
  430. data/sig/knockapi/models/object_list_subscriptions_params.rbs +11 -15
  431. data/sig/knockapi/models/object_set_channel_data_params.rbs +0 -2
  432. data/sig/knockapi/models/object_set_params.rbs +0 -2
  433. data/sig/knockapi/models/object_set_preferences_params.rbs +0 -2
  434. data/sig/knockapi/models/object_unset_channel_data_params.rbs +0 -2
  435. data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
  436. data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +3 -7
  437. data/sig/knockapi/models/objects/bulk_delete_params.rbs +0 -2
  438. data/sig/knockapi/models/objects/bulk_set_params.rbs +3 -5
  439. data/sig/knockapi/models/page_info.rbs +0 -2
  440. data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +0 -2
  441. data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +0 -4
  442. data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -9
  443. data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +0 -4
  444. data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -9
  445. data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +0 -2
  446. data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +0 -2
  447. data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +0 -2
  448. data/sig/knockapi/models/providers/slack_check_auth_params.rbs +0 -2
  449. data/sig/knockapi/models/providers/slack_check_auth_response.rbs +0 -4
  450. data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -9
  451. data/sig/knockapi/models/providers/slack_list_channels_response.rbs +0 -2
  452. data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +0 -2
  453. data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +0 -2
  454. data/sig/knockapi/models/recipient.rbs +2 -2
  455. data/sig/knockapi/models/recipient_reference.rbs +2 -4
  456. data/sig/knockapi/models/recipient_request.rbs +3 -3
  457. data/sig/knockapi/models/recipients/channel_data.rbs +15 -17
  458. data/sig/knockapi/models/recipients/channel_data_request.rbs +9 -11
  459. data/sig/knockapi/models/recipients/discord_channel_data.rbs +9 -17
  460. data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +14 -1
  461. data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +1 -1
  462. data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +9 -17
  463. data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +0 -2
  464. data/sig/knockapi/models/recipients/preference_set.rbs +25 -31
  465. data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +3 -7
  466. data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +42 -48
  467. data/sig/knockapi/models/recipients/preference_set_request.rbs +25 -31
  468. data/sig/knockapi/models/recipients/push_channel_data.rbs +0 -2
  469. data/sig/knockapi/models/recipients/slack_channel_data.rbs +9 -17
  470. data/sig/knockapi/models/recipients/subscription.rbs +3 -5
  471. data/sig/knockapi/models/schedule.rbs +3 -5
  472. data/sig/knockapi/models/schedule_create_params.rbs +3 -5
  473. data/sig/knockapi/models/schedule_create_response.rbs +1 -1
  474. data/sig/knockapi/models/schedule_delete_params.rbs +0 -2
  475. data/sig/knockapi/models/schedule_delete_response.rbs +1 -1
  476. data/sig/knockapi/models/schedule_list_params.rbs +0 -2
  477. data/sig/knockapi/models/schedule_repeat_rule.rbs +8 -10
  478. data/sig/knockapi/models/schedule_update_params.rbs +5 -7
  479. data/sig/knockapi/models/schedule_update_response.rbs +1 -1
  480. data/sig/knockapi/models/schedules/bulk_create_params.rbs +8 -14
  481. data/sig/knockapi/models/tenant.rbs +9 -15
  482. data/sig/knockapi/models/tenant_delete_params.rbs +0 -2
  483. data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
  484. data/sig/knockapi/models/tenant_get_params.rbs +0 -2
  485. data/sig/knockapi/models/tenant_list_params.rbs +0 -2
  486. data/sig/knockapi/models/tenant_request.rbs +13 -19
  487. data/sig/knockapi/models/tenant_set_params.rbs +13 -19
  488. data/sig/knockapi/models/tenants/bulk_delete_params.rbs +0 -2
  489. data/sig/knockapi/models/tenants/bulk_set_params.rbs +0 -2
  490. data/sig/knockapi/models/user.rbs +0 -2
  491. data/sig/knockapi/models/user_delete_params.rbs +0 -2
  492. data/sig/knockapi/models/user_delete_response.rbs +5 -0
  493. data/sig/knockapi/models/user_get_channel_data_params.rbs +0 -2
  494. data/sig/knockapi/models/user_get_params.rbs +0 -2
  495. data/sig/knockapi/models/user_get_preferences_params.rbs +0 -2
  496. data/sig/knockapi/models/user_list_messages_params.rbs +17 -21
  497. data/sig/knockapi/models/user_list_params.rbs +6 -8
  498. data/sig/knockapi/models/user_list_preferences_params.rbs +0 -2
  499. data/sig/knockapi/models/user_list_preferences_response.rbs +1 -1
  500. data/sig/knockapi/models/user_list_schedules_params.rbs +0 -2
  501. data/sig/knockapi/models/user_list_subscriptions_params.rbs +6 -8
  502. data/sig/knockapi/models/user_merge_params.rbs +0 -2
  503. data/sig/knockapi/models/user_set_channel_data_params.rbs +0 -2
  504. data/sig/knockapi/models/user_set_preferences_params.rbs +0 -2
  505. data/sig/knockapi/models/user_unset_channel_data_params.rbs +0 -2
  506. data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
  507. data/sig/knockapi/models/user_update_params.rbs +0 -2
  508. data/sig/knockapi/models/users/bulk_delete_params.rbs +0 -2
  509. data/sig/knockapi/models/users/bulk_identify_params.rbs +3 -5
  510. data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +3 -5
  511. data/sig/knockapi/models/users/feed_get_settings_params.rbs +0 -2
  512. data/sig/knockapi/models/users/feed_get_settings_response.rbs +0 -4
  513. data/sig/knockapi/models/users/feed_list_items_params.rbs +0 -2
  514. data/sig/knockapi/models/users/feed_list_items_response.rbs +4 -14
  515. data/sig/knockapi/models/users/guide_get_channel_params.rbs +0 -2
  516. data/sig/knockapi/models/users/guide_get_channel_response.rbs +0 -6
  517. data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +0 -2
  518. data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -2
  519. data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +0 -2
  520. data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -2
  521. data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +0 -2
  522. data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +0 -2
  523. data/sig/knockapi/models/workflow_cancel_params.rbs +0 -2
  524. data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
  525. data/sig/knockapi/models/workflow_trigger_params.rbs +0 -2
  526. data/sig/knockapi/models/workflow_trigger_response.rbs +0 -2
  527. data/sig/knockapi/models.rbs +173 -0
  528. data/sig/knockapi/request_options.rbs +1 -1
  529. data/sig/knockapi/resources/audiences.rbs +2 -2
  530. data/sig/knockapi/resources/bulk_operations.rbs +1 -1
  531. data/sig/knockapi/resources/channels/bulk.rbs +1 -1
  532. data/sig/knockapi/resources/messages.rbs +15 -17
  533. data/sig/knockapi/resources/objects/bulk.rbs +5 -5
  534. data/sig/knockapi/resources/objects.rbs +19 -19
  535. data/sig/knockapi/resources/providers/ms_teams.rbs +2 -2
  536. data/sig/knockapi/resources/providers/slack.rbs +1 -1
  537. data/sig/knockapi/resources/schedules/bulk.rbs +2 -2
  538. data/sig/knockapi/resources/schedules.rbs +3 -3
  539. data/sig/knockapi/resources/tenants/bulk.rbs +2 -2
  540. data/sig/knockapi/resources/tenants.rbs +4 -4
  541. data/sig/knockapi/resources/users/bulk.rbs +5 -5
  542. data/sig/knockapi/resources/users.rbs +19 -19
  543. metadata +29 -8
  544. data/lib/knockapi/models/messages/activity_list_params.rb +0 -48
  545. data/lib/knockapi/resources/messages/activities.rb +0 -47
  546. data/rbi/knockapi/models/messages/activity_list_params.rbi +0 -75
  547. data/rbi/knockapi/resources/messages/activities.rbi +0 -38
  548. data/sig/knockapi/models/messages/activity_list_params.rbs +0 -45
  549. data/sig/knockapi/resources/messages/activities.rbs +0 -18
@@ -11,22 +11,24 @@ module Knockapi
11
11
  # @!attribute archived
12
12
  # Limits the results to messages with the given archived status.
13
13
  #
14
- # @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived, nil]
15
- optional :archived, enum: -> { Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived }
14
+ # @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived, nil]
15
+ optional :archived, enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::Archived }
16
16
 
17
17
  # @!attribute delivery_status
18
18
  # Limits the results to messages with the given delivery status.
19
19
  #
20
- # @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil]
20
+ # @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil]
21
21
  optional :delivery_status,
22
- enum: -> { Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus }
22
+ enum: -> {
23
+ Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus
24
+ }
23
25
 
24
26
  # @!attribute engagement_status
25
27
  # Limits the results to messages with the given engagement status.
26
28
  #
27
- # @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil]
29
+ # @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil]
28
30
  optional :engagement_status,
29
- enum: -> { Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus }
31
+ enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus }
30
32
 
31
33
  # @!attribute has_tenant
32
34
  # Limits the results to messages that have a tenant or not.
@@ -76,11 +78,11 @@ module Knockapi
76
78
  # Some parameter documentations has been truncated, see
77
79
  # {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
78
80
  #
79
- # @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
81
+ # @param archived [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
80
82
  #
81
- # @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
83
+ # @param delivery_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
82
84
  #
83
- # @param engagement_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
85
+ # @param engagement_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
84
86
  #
85
87
  # @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
86
88
  #
@@ -93,7 +95,6 @@ module Knockapi
93
95
  # @param tenants [Array<String>] Limits the results to messages with the given tenant IDs.
94
96
  #
95
97
  # @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
96
- # ...
97
98
  #
98
99
  # @param workflows [Array<String>] Limits the results to messages with the given workflow keys.
99
100
  #
@@ -12,8 +12,8 @@ module Knockapi
12
12
  # @!attribute operator
13
13
  # The operator to use in the condition evaluation.
14
14
  #
15
- # @return [Symbol, Knockapi::Models::Condition::Operator]
16
- required :operator, enum: -> { Knockapi::Models::Condition::Operator }
15
+ # @return [Symbol, Knockapi::Condition::Operator]
16
+ required :operator, enum: -> { Knockapi::Condition::Operator }
17
17
 
18
18
  # @!attribute variable
19
19
  # The variable to be evaluated in the condition.
@@ -26,13 +26,13 @@ module Knockapi
26
26
  #
27
27
  # @param argument [String, nil] The argument value to compare against in the condition.
28
28
  #
29
- # @param operator [Symbol, Knockapi::Models::Condition::Operator] The operator to use in the condition evaluation.
29
+ # @param operator [Symbol, Knockapi::Condition::Operator] The operator to use in the condition evaluation.
30
30
  #
31
31
  # @param variable [String] The variable to be evaluated in the condition.
32
32
 
33
33
  # The operator to use in the condition evaluation.
34
34
  #
35
- # @see Knockapi::Models::Condition#operator
35
+ # @see Knockapi::Condition#operator
36
36
  module Operator
37
37
  extend Knockapi::Internal::Type::Enum
38
38
 
@@ -12,9 +12,11 @@ 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::Models::Recipients::ChannelDataRequest}, nil]
15
+ # @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
16
16
  optional :channel_data,
17
- -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::ChannelDataRequest] },
17
+ -> {
18
+ Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
19
+ },
18
20
  nil?: true
19
21
 
20
22
  # @!attribute created_at
@@ -42,7 +44,7 @@ module Knockapi
42
44
  optional :name, String, nil?: true
43
45
 
44
46
  # @!attribute phone_number
45
- # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
47
+ # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
46
48
  # user (required for SMS channels).
47
49
  #
48
50
  # @return [String, nil]
@@ -51,23 +53,23 @@ module Knockapi
51
53
  # @!attribute preferences
52
54
  # Inline set preferences for a recipient, where the key is the preference set id.
53
55
  #
54
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
56
+ # @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
55
57
  optional :preferences,
56
- -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::PreferenceSetRequest] },
58
+ -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
57
59
  nil?: true
58
60
 
59
61
  # @!attribute timezone
60
- # The timezone of the user. Must be a valid
61
- # [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
62
- # Used for
63
- # [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
62
+ # The timezone of the user. Must be a
63
+ # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
64
+ # Used
65
+ # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
64
66
  #
65
67
  # @return [String, nil]
66
68
  optional :timezone, String, nil?: true
67
69
 
68
70
  # @!method initialize(avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
69
71
  # Some parameter documentations has been truncated, see
70
- # {Knockapi::Models::IdentifyUserRequest} for more details.
72
+ # {Knockapi::IdentifyUserRequest} for more details.
71
73
  #
72
74
  # A set of parameters to identify a user with. Does not include the user ID, as
73
75
  # that's specified elsewhere in the request. You can supply any additional
@@ -75,24 +77,21 @@ module Knockapi
75
77
  #
76
78
  # @param avatar [String, nil] URL to the user's avatar image.
77
79
  #
78
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
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.
79
81
  #
80
82
  # @param created_at [Time, nil] The creation date of the user from your system.
81
83
  #
82
84
  # @param email [String, nil] The primary email address for the user.
83
85
  #
84
86
  # @param locale [String, nil] The locale of the user. Used for [message localization](/concepts/translations).
85
- # ...
86
87
  #
87
88
  # @param name [String, nil] Display name of the user.
88
89
  #
89
- # @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
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::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
92
+ # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
93
93
  #
94
- # @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
95
- # ...
94
+ # @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
96
95
  end
97
96
  end
98
97
  end
@@ -9,12 +9,20 @@ module Knockapi
9
9
  # @return [String]
10
10
  required :id, String
11
11
 
12
+ # @!attribute avatar
13
+ # URL to the user's avatar image.
14
+ #
15
+ # @return [String, nil]
16
+ optional :avatar, String, nil?: true
17
+
12
18
  # @!attribute channel_data
13
19
  # A request to set channel data for a type of channel inline.
14
20
  #
15
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil]
21
+ # @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
16
22
  optional :channel_data,
17
- -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::ChannelDataRequest] },
23
+ -> {
24
+ Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
25
+ },
18
26
  nil?: true
19
27
 
20
28
  # @!attribute created_at
@@ -23,15 +31,52 @@ module Knockapi
23
31
  # @return [Time, nil]
24
32
  optional :created_at, Time, nil?: true
25
33
 
34
+ # @!attribute email
35
+ # The primary email address for the user.
36
+ #
37
+ # @return [String, nil]
38
+ optional :email, String, nil?: true
39
+
40
+ # @!attribute locale
41
+ # The locale of the user. Used for [message localization](/concepts/translations).
42
+ #
43
+ # @return [String, nil]
44
+ optional :locale, String, nil?: true
45
+
46
+ # @!attribute name
47
+ # Display name of the user.
48
+ #
49
+ # @return [String, nil]
50
+ optional :name, String, nil?: true
51
+
52
+ # @!attribute phone_number
53
+ # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
54
+ # user (required for SMS channels).
55
+ #
56
+ # @return [String, nil]
57
+ optional :phone_number, String, nil?: true
58
+
26
59
  # @!attribute preferences
27
60
  # Inline set preferences for a recipient, where the key is the preference set id.
28
61
  #
29
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
62
+ # @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
30
63
  optional :preferences,
31
- -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::PreferenceSetRequest] },
64
+ -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
32
65
  nil?: true
33
66
 
34
- # @!method initialize(id:, channel_data: nil, created_at: nil, preferences: nil)
67
+ # @!attribute timezone
68
+ # The timezone of the user. Must be a
69
+ # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
70
+ # Used
71
+ # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
72
+ #
73
+ # @return [String, nil]
74
+ optional :timezone, String, nil?: true
75
+
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
+ # Some parameter documentations has been truncated, see
78
+ # {Knockapi::InlineIdentifyUserRequest} for more details.
79
+ #
35
80
  # A set of parameters to inline-identify a user with. Inline identifying the user
36
81
  # will ensure that the user is available before the request is executed in Knock.
37
82
  # It will perform an upsert for the user you're supplying, replacing any
@@ -39,11 +84,23 @@ module Knockapi
39
84
  #
40
85
  # @param id [String] The ID for the user that you set when identifying them in Knock.
41
86
  #
42
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
87
+ # @param avatar [String, nil] URL to the user's avatar image.
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.
43
90
  #
44
91
  # @param created_at [Time, nil] The creation date of the user from your system.
45
92
  #
46
- # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
93
+ # @param email [String, nil] The primary email address for the user.
94
+ #
95
+ # @param locale [String, nil] The locale of the user. Used for [message localization](/concepts/translations).
96
+ #
97
+ # @param name [String, nil] Display name of the user.
98
+ #
99
+ # @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
100
+ #
101
+ # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
102
+ #
103
+ # @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
47
104
  end
48
105
  end
49
106
  end
@@ -18,9 +18,11 @@ 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::Models::Recipients::ChannelDataRequest}, nil]
21
+ # @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
22
22
  optional :channel_data,
23
- -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::ChannelDataRequest] },
23
+ -> {
24
+ Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
25
+ },
24
26
  nil?: true
25
27
 
26
28
  # @!attribute created_at
@@ -32,9 +34,9 @@ module Knockapi
32
34
  # @!attribute preferences
33
35
  # Inline set preferences for a recipient, where the key is the preference set id.
34
36
  #
35
- # @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
37
+ # @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
36
38
  optional :preferences,
37
- -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::PreferenceSetRequest] },
39
+ -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
38
40
  nil?: true
39
41
 
40
42
  # @!method initialize(id:, collection:, channel_data: nil, created_at: nil, preferences: nil)
@@ -44,11 +46,11 @@ module Knockapi
44
46
  #
45
47
  # @param collection [String] The collection this object belongs to.
46
48
  #
47
- # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
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.
48
50
  #
49
51
  # @param created_at [Time, nil] Timestamp when the resource was created.
50
52
  #
51
- # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
53
+ # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
52
54
  end
53
55
  end
54
56
  end
@@ -10,10 +10,14 @@ module Knockapi
10
10
  variant String
11
11
 
12
12
  # A tenant to be set in the system. You can supply any additional properties on the tenant object.
13
- variant -> { Knockapi::Models::TenantRequest }
13
+ variant -> { Knockapi::TenantRequest }
14
14
 
15
15
  # @!method self.variants
16
- # @return [Array(String, Knockapi::Models::TenantRequest)]
16
+ # @return [Array(String, Knockapi::TenantRequest)]
17
+
18
+ define_sorbet_constant!(:Variants) do
19
+ T.type_alias { T.any(String, Knockapi::TenantRequest) }
20
+ end
17
21
  end
18
22
  end
19
23
  end
@@ -21,8 +21,8 @@ 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::Models::RecipientReference::ObjectReference>, nil]
25
- optional :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::RecipientReference] }
24
+ # @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
25
+ optional :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
26
26
 
27
27
  # @!attribute archived_at
28
28
  # Timestamp when the message was archived.
@@ -55,9 +55,9 @@ module Knockapi
55
55
  # @!attribute engagement_statuses
56
56
  # A list of engagement statuses.
57
57
  #
58
- # @return [Array<Symbol, Knockapi::Models::Message::EngagementStatus>, nil]
58
+ # @return [Array<Symbol, Knockapi::Message::EngagementStatus>, nil]
59
59
  optional :engagement_statuses,
60
- -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::Message::EngagementStatus] }
60
+ -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] }
61
61
 
62
62
  # @!attribute inserted_at
63
63
  # Timestamp when the resource was created.
@@ -93,8 +93,8 @@ 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::Models::RecipientReference::ObjectReference, nil]
97
- optional :recipient, union: -> { Knockapi::Models::RecipientReference }
96
+ # @return [String, Knockapi::RecipientReference::ObjectReference, nil]
97
+ optional :recipient, union: -> { Knockapi::RecipientReference }
98
98
 
99
99
  # @!attribute scheduled_at
100
100
  # Timestamp when the message was scheduled to be sent.
@@ -111,14 +111,14 @@ module Knockapi
111
111
  # @!attribute source
112
112
  # The workflow that triggered the message.
113
113
  #
114
- # @return [Knockapi::Models::Message::Source, nil]
115
- optional :source, -> { Knockapi::Models::Message::Source }
114
+ # @return [Knockapi::Message::Source, nil]
115
+ optional :source, -> { Knockapi::Message::Source }
116
116
 
117
117
  # @!attribute status
118
118
  # The message delivery status.
119
119
  #
120
- # @return [Symbol, Knockapi::Models::Message::Status, nil]
121
- optional :status, enum: -> { Knockapi::Models::Message::Status }
120
+ # @return [Symbol, Knockapi::Message::Status, nil]
121
+ optional :status, enum: -> { Knockapi::Message::Status }
122
122
 
123
123
  # @!attribute tenant
124
124
  # The ID of the `tenant` associated with the message. Only present when a `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
146
- # {Knockapi::Models::Message} for more details.
145
+ # Some parameter documentations has been truncated, see {Knockapi::Message} for
146
+ # more details.
147
147
  #
148
148
  # Represents a single message that was generated by a workflow for a given
149
149
  # channel.
@@ -152,8 +152,7 @@ module Knockapi
152
152
  #
153
153
  # @param _typename [String] The typename of the schema.
154
154
  #
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
- # ...
155
+ # @param actors [Array<String, Knockapi::RecipientReference::ObjectReference>] One or more actors that are associated with this message. Note: this is a list t
157
156
  #
158
157
  # @param archived_at [Time, nil] Timestamp when the message was archived.
159
158
  #
@@ -162,9 +161,8 @@ module Knockapi
162
161
  # @param clicked_at [Time, nil] Timestamp when the message was clicked.
163
162
  #
164
163
  # @param data [Hash{Symbol=>Object}, nil] Data associated with the message’s workflow run. Includes the workflow trigger r
165
- # ...
166
164
  #
167
- # @param engagement_statuses [Array<Symbol, Knockapi::Models::Message::EngagementStatus>] A list of engagement statuses.
165
+ # @param engagement_statuses [Array<Symbol, Knockapi::Message::EngagementStatus>] A list of engagement statuses.
168
166
  #
169
167
  # @param inserted_at [Time] Timestamp when the resource was created.
170
168
  #
@@ -176,19 +174,17 @@ module Knockapi
176
174
  #
177
175
  # @param read_at [Time, nil] Timestamp when the message was read.
178
176
  #
179
- # @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
180
- # ...
177
+ # @param recipient [String, Knockapi::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
181
178
  #
182
179
  # @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent.
183
180
  #
184
181
  # @param seen_at [Time, nil] Timestamp when the message was seen.
185
182
  #
186
- # @param source [Knockapi::Models::Message::Source] The workflow that triggered the message.
183
+ # @param source [Knockapi::Message::Source] The workflow that triggered the message.
187
184
  #
188
- # @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status.
185
+ # @param status [Symbol, Knockapi::Message::Status] The message delivery status.
189
186
  #
190
187
  # @param tenant [String, nil] The ID of the `tenant` associated with the message. Only present when a `tenant`
191
- # ...
192
188
  #
193
189
  # @param updated_at [Time] The timestamp when the resource was last updated.
194
190
  #
@@ -209,7 +205,7 @@ module Knockapi
209
205
  # @return [Array<Symbol>]
210
206
  end
211
207
 
212
- # @see Knockapi::Models::Message#source
208
+ # @see Knockapi::Message#source
213
209
  class Source < Knockapi::Internal::Type::BaseModel
214
210
  # @!attribute _typename
215
211
  #
@@ -248,7 +244,7 @@ module Knockapi
248
244
 
249
245
  # The message delivery status.
250
246
  #
251
- # @see Knockapi::Models::Message#status
247
+ # @see Knockapi::Message#status
252
248
  module Status
253
249
  extend Knockapi::Internal::Type::Enum
254
250
 
@@ -31,14 +31,14 @@ module Knockapi
31
31
  # @!attribute request
32
32
  # A message delivery log request.
33
33
  #
34
- # @return [Knockapi::Models::MessageDeliveryLog::Request]
35
- required :request, -> { Knockapi::Models::MessageDeliveryLog::Request }
34
+ # @return [Knockapi::MessageDeliveryLog::Request]
35
+ required :request, -> { Knockapi::MessageDeliveryLog::Request }
36
36
 
37
37
  # @!attribute response
38
38
  # A message delivery log response.
39
39
  #
40
- # @return [Knockapi::Models::MessageDeliveryLog::Response]
41
- required :response, -> { Knockapi::Models::MessageDeliveryLog::Response }
40
+ # @return [Knockapi::MessageDeliveryLog::Response]
41
+ required :response, -> { Knockapi::MessageDeliveryLog::Response }
42
42
 
43
43
  # @!attribute service_name
44
44
  # The name of the service that processed the delivery.
@@ -58,19 +58,19 @@ module Knockapi
58
58
  #
59
59
  # @param inserted_at [String] Timestamp when the message delivery log was created.
60
60
  #
61
- # @param request [Knockapi::Models::MessageDeliveryLog::Request] A message delivery log request.
61
+ # @param request [Knockapi::MessageDeliveryLog::Request] A message delivery log request.
62
62
  #
63
- # @param response [Knockapi::Models::MessageDeliveryLog::Response] A message delivery log response.
63
+ # @param response [Knockapi::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::Models::MessageDeliveryLog#request
67
+ # @see Knockapi::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.
71
71
  #
72
72
  # @return [String, Hash{Symbol=>Object}, nil]
73
- optional :body, union: -> { Knockapi::Models::MessageDeliveryLog::Request::Body }
73
+ optional :body, union: -> { Knockapi::MessageDeliveryLog::Request::Body }
74
74
 
75
75
  # @!attribute headers
76
76
  # The headers that were sent with the request.
@@ -87,8 +87,8 @@ module Knockapi
87
87
  # @!attribute method_
88
88
  # The HTTP method used for the request.
89
89
  #
90
- # @return [Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method, nil]
91
- optional :method_, enum: -> { Knockapi::Models::MessageDeliveryLog::Request::Method }, api_name: :method
90
+ # @return [Symbol, Knockapi::MessageDeliveryLog::Request::Method, nil]
91
+ optional :method_, enum: -> { Knockapi::MessageDeliveryLog::Request::Method }, api_name: :method
92
92
 
93
93
  # @!attribute path
94
94
  # The path of the URL that was requested.
@@ -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::Models::MessageDeliveryLog::Request::Method] The HTTP method used for the request.
114
+ # @param method_ [Symbol, Knockapi::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,24 +119,28 @@ module Knockapi
119
119
 
120
120
  # The body content that was sent with the request.
121
121
  #
122
- # @see Knockapi::Models::MessageDeliveryLog::Request#body
122
+ # @see Knockapi::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::Models::MessageDeliveryLog::Request::Body::UnionMember1Map }
128
+ variant -> { Knockapi::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
+
133
137
  # @type [Knockapi::Internal::Type::Converter]
134
138
  UnionMember1Map = Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
135
139
  end
136
140
 
137
141
  # The HTTP method used for the request.
138
142
  #
139
- # @see Knockapi::Models::MessageDeliveryLog::Request#method_
143
+ # @see Knockapi::MessageDeliveryLog::Request#method_
140
144
  module Method
141
145
  extend Knockapi::Internal::Type::Enum
142
146
 
@@ -151,13 +155,13 @@ module Knockapi
151
155
  end
152
156
  end
153
157
 
154
- # @see Knockapi::Models::MessageDeliveryLog#response
158
+ # @see Knockapi::MessageDeliveryLog#response
155
159
  class Response < Knockapi::Internal::Type::BaseModel
156
160
  # @!attribute body
157
161
  # The body content that was received with the response.
158
162
  #
159
163
  # @return [String, Hash{Symbol=>Object}, nil]
160
- optional :body, union: -> { Knockapi::Models::MessageDeliveryLog::Response::Body }
164
+ optional :body, union: -> { Knockapi::MessageDeliveryLog::Response::Body }
161
165
 
162
166
  # @!attribute headers
163
167
  # The headers that were received with the response.
@@ -182,17 +186,21 @@ module Knockapi
182
186
 
183
187
  # The body content that was received with the response.
184
188
  #
185
- # @see Knockapi::Models::MessageDeliveryLog::Response#body
189
+ # @see Knockapi::MessageDeliveryLog::Response#body
186
190
  module Body
187
191
  extend Knockapi::Internal::Type::Union
188
192
 
189
193
  variant String
190
194
 
191
- variant -> { Knockapi::Models::MessageDeliveryLog::Response::Body::UnionMember1Map }
195
+ variant -> { Knockapi::MessageDeliveryLog::Response::Body::UnionMember1Map }
192
196
 
193
197
  # @!method self.variants
194
198
  # @return [Array(String, Hash{Symbol=>Object})]
195
199
 
200
+ define_sorbet_constant!(:Variants) do
201
+ T.type_alias { T.any(String, T::Hash[Symbol, T.anything]) }
202
+ end
203
+
196
204
  # @type [Knockapi::Internal::Type::Converter]
197
205
  UnionMember1Map = Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
198
206
  end
@@ -26,14 +26,14 @@ 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::Models::RecipientReference::ObjectReference]
30
- required :recipient, union: -> { Knockapi::Models::RecipientReference }
29
+ # @return [String, Knockapi::RecipientReference::ObjectReference]
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::Models::MessageEvent::Type]
36
- required :type, enum: -> { Knockapi::Models::MessageEvent::Type }
35
+ # @return [Symbol, Knockapi::MessageEvent::Type]
36
+ required :type, enum: -> { Knockapi::MessageEvent::Type }
37
37
 
38
38
  # @!attribute data
39
39
  # The data associated with the message event. Only present for some event types.
@@ -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
46
- # {Knockapi::Models::MessageEvent} for more details.
45
+ # Some parameter documentations has been truncated, see {Knockapi::MessageEvent}
46
+ # 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,16 +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::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
58
- # ...
57
+ # @param recipient [String, Knockapi::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
59
58
  #
60
- # @param type [Symbol, Knockapi::Models::MessageEvent::Type] The type of event that occurred.
59
+ # @param type [Symbol, Knockapi::MessageEvent::Type] The type of event that occurred.
61
60
  #
62
61
  # @param data [Hash{Symbol=>Object}, nil] The data associated with the message event. Only present for some event types.
63
62
 
64
63
  # The type of event that occurred.
65
64
  #
66
- # @see Knockapi::Models::MessageEvent#type
65
+ # @see Knockapi::MessageEvent#type
67
66
  module Type
68
67
  extend Knockapi::Internal::Type::Enum
69
68